# @procore/js-sdk-endpoints

> generates endpoint functions for node-procore sdk

Latest version **1.9.2** (published 2020-10-09) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @procore/js-sdk-endpoints
pnpm add @procore/js-sdk-endpoints
yarn add @procore/js-sdk-endpoints
bun add @procore/js-sdk-endpoints
```

Provides the command `node-procore-endpoints`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.9.2 |
| Published | 2020-10-09 |
| First published | 2017-03-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 16.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Procore |
| Maintainers | bionikspoon, evan.freymiller, juliana.hernandez, hyogman, kimhin267, lukenispel, mariah_delaney, cagmz, arthurzhuk, chriszhang, jgee67, eyvettesou, gregburger, mcclayton, dancingshell, justinmwatts, robbiegprocore, jadamsss, dallashall-procore, bates550, timdoherty, chrisarevir, espi, truthysystems, dev-account-admin, dannyphillips, farismmk |

## Links

- npm: https://www.npmjs.com/package/@procore/js-sdk-endpoints
- npm.io page: https://npm.io/package/@procore/js-sdk-endpoints

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [ramda](https://npm.io/package/ramda.md) ^0.23.0
- [string](https://npm.io/package/string.md) ^3.3.3
- [progress](https://npm.io/package/progress.md) ^2.0.0
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.0.6
- [to-pascal-case](https://npm.io/package/to-pascal-case.md) ^1.0.0
- [isomorphic-fetch](https://npm.io/package/isomorphic-fetch.md) ^2.2.1

## Recent versions

- 1.9.2 (latest) — 2020-10-09
- 1.9.2-alpha.0 (alpha) — 2020-10-08
- 1.9.1 — 2020-03-31
- 1.9.0 — 2017-06-29
- 1.8.1 — 2017-04-06
- 1.7.2 — 2017-03-28
- 1.7.1 — 2017-03-28
- 1.7.0 — 2017-03-28
- 1.6.0 — 2017-03-28

## README

# Procore JS SDK Endpoints

Generates TypeScript wrapper functions and interface definitions for the Procore API.

## Install

```shell
yarn add -D @procore/js-sdk-endpoints
```

## Usage

```shell
node-procore-endpoints lib -i index.ts -d endpoints
```

## Example

```typescript
interface DirectCosts {
  action: string;
  qs?: any;
  id?: number;
  project_id: number;
}

function directCosts({ action, qs, id, project_id  }: DirectCosts): any {
  return {
    base: '/vapid/projects/{project_id}/direct_costs',
    action,
    params: { id, project_id  },
    qs
  }
}

export default directCosts
```

## File Structure

```
lib/endpoints
├── accident-logs.ts
├── authentication.ts
├── bids.ts
├── budget-line-items.ts
├── budget-modifications.ts
├── calendar-events.ts
├── call-logs.ts
├── change-events.ts
├── change-order-change-reasons.ts
├── change-order-packages.ts
├── change-order-requests.ts
├── change-orders.ts
├── change-types.ts
├── checklists.ts
├── communications.ts
├── companies.ts
├── company-folders-and-files.ts
├── company-insurances.ts
├── company-offices.ts
├── company-users.ts
├── company-vendor-insurances.ts
├── company-vendors.ts
├── contract-payments.ts
├── cost-codes.ts
├── daily-construction-report-logs.ts
├── dashboards.ts
├── delivery-logs.ts
├── departments.ts
├── direct-costs.ts
├── draw-requests.ts
├── drawings.ts
├── dumpster-logs.ts
├── equipment-logs.ts
├── equipment.ts
├── image-categories.ts
├── images.ts
├── inspection-logs.ts
├── line-item-types.ts
├── locations.ts
├── manpower-logs.ts
├── markup-attachments.ts
├── markup-layer-elements.ts
├── markup-layers.ts
├── me.ts
├── meetings.ts
├── notes-logs.ts
├── observations.ts
├── permission-templates.ts
├── permissions.ts
├── plan-revision-logs.ts
├── potential-change-orders.ts
├── prime-contracts.ts
├── productivity-logs.ts
├── programs.ts
├── project-configuration.ts
├── project-dates.ts
├── project-folders-and-files.ts
├── project-insurances.ts
├── project-roles.ts
├── project-stages.ts
├── project-templates.ts
├── project-tools.ts
├── project-types.ts
├── project-users.ts
├── project-vendor-insurances.ts
├── project-vendors.ts
├── projects.ts
├── punch-item-assignments.ts
├── punch-item-types.ts
├── punch-items.ts
├── punch-list-assignee-options.ts
├── purchase-order-contracts.ts
├── quantity-logs.ts
├── reports.ts
├── requested-changes.ts
├── resources.ts
├── rfi-replies.ts
├── rfis.ts
├── rfqs.ts
├── safety-violation-logs.ts
├── schedule-integration.ts
├── schedule-type.ts
├── specification-section-divisions.ts
├── specification-section-revisions.ts
├── specification-sections.ts
├── specification-sets.ts
├── specification-uploads.ts
├── sticky-filters.ts
├── sub-jobs.ts
├── submittals.ts
├── tasks.ts
├── timecard-entries.ts
├── timecards.ts
├── todos.ts
├── toolfavorites.ts
├── trades.ts
├── transmittals.ts
├── user-access-level.ts
├── waste-logs.ts
├── weather-logs.ts
├── work-logs.ts
└── work-order-contracts.ts
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/procore/js-sdk-endpoints. This project is
intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
[Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The package is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

## About Procore

<img
  src="https://www.procore.com/images/procore_logo.png"
  alt="Procore Logo"
  width="250px"
/>

Manage Version is maintained by Procore Technologies.

Procore - building the software that builds the world.

Learn more about the #1 most widely used construction management software at [procore.com](https://www.procore.com/)

---
_Source: https://npm.io/package/@procore/js-sdk-endpoints · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._