{"id":18375822,"url":"https://github.com/apideck-libraries/node-sdk","last_synced_at":"2025-04-06T20:31:16.042Z","repository":{"id":36994862,"uuid":"394955688","full_name":"apideck-libraries/node-sdk","owner":"apideck-libraries","description":"Apideck Node + Typescript SDK","archived":false,"fork":false,"pushed_at":"2024-10-29T08:18:05.000Z","size":14996,"stargazers_count":11,"open_issues_count":7,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-29T09:37:44.798Z","etag":null,"topics":["accounting","api","ats","cloud-storage","crm","file-storage","hris","javascript","messaging","nodejs","quickbooks","sdk","sms","typescript","unified-api","xero"],"latest_commit_sha":null,"homepage":"https://developers.apideck.com/sdks","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apideck-libraries.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-11T10:49:52.000Z","updated_at":"2024-10-22T18:01:34.000Z","dependencies_parsed_at":"2023-10-02T08:46:53.960Z","dependency_job_id":"ad617d63-0b98-4ea3-99ca-02b985c92de2","html_url":"https://github.com/apideck-libraries/node-sdk","commit_stats":{"total_commits":251,"total_committers":4,"mean_commits":62.75,"dds":"0.13545816733067728","last_synced_commit":"4c3e4f40fcaf8177ed62adc0c00be48a42bc2409"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apideck-libraries%2Fnode-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apideck-libraries%2Fnode-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apideck-libraries%2Fnode-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apideck-libraries%2Fnode-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apideck-libraries","download_url":"https://codeload.github.com/apideck-libraries/node-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247547329,"owners_count":20956537,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accounting","api","ats","cloud-storage","crm","file-storage","hris","javascript","messaging","nodejs","quickbooks","sdk","sms","typescript","unified-api","xero"],"created_at":"2024-11-06T00:20:34.534Z","updated_at":"2025-04-06T20:31:16.035Z","avatar_url":"https://github.com/apideck-libraries.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Apideck Node.js SDK\n\n\u003e ⚠️ **DEPRECATION NOTICE**: This SDK is deprecated and will be archived on May 31, 2025. Please transition to the [new SDK](https://github.com/apideck-libraries/sdk-typescript) before this date. After May 31, 2025, this repository will be archived and will no longer receive any updates. To support you during this transition please refer to our [migration guide](https://developers.apideck.com/guides/sdk-migration).\n\n\n## Table of Contents\n\n- [Table of Contents](#table-of-contents)\n- [Installation](#installation)\n- [Getting started](#getting-started)\n- [Example](#example)\n- [Support](#support)\n- [License](#license)\n\n## Installation\n\nInstall the latest SDK using npm:\n\n```console\n$ npm install @apideck/node\n```\n\nor Yarn\n\n```console\n$ yarn add @apideck/node\n```\n\n## Getting started\n\nThe module supports all Apideck API endpoints. For complete information about the API, head\nto the [docs][2].\n\n\n### Configuration\n\nA new Apideck instance is initialized by passing in required settings to the configuration.\n\n```typescript\nimport Apideck from '@apideck/node';\n\nconst apideck = new Apideck({\n  apiKey: '\u003cinsert-api-key-here\u003e',\n  appId: '\u003cinsert-application-id-here\u003e',\n  consumerId: '\u003cinsert-consumer-id-here\u003e'\n})\n\nconst { crm } = apideck\n\n```\n\nTop level parameters (except for apiKey) can be overriden in specific resource calls.\n\n```typescript\n// Declare Unify Api to use\nconst { crm } = apideck\n\n// Override consumerId serviceId as declared in initial configuration for this operation.\nconst response = await crm.contactsAll({\n  // serviceId: 'salesforce', // optional\n  limit: '10'\n})\n```\n\n## Example\n\nRetrieving a list of all contacts and updating the first record with a new address.\n\n```typescript\n\nimport Apideck, { PhoneNumberType } from '@apideck/node';\n\nconst apideck = new Apideck({\n  apiKey: '\u003cinsert-api-key-here\u003e',\n  appId: '\u003cinsert-application-id-here\u003e',\n  consumerId: '\u003cinsert-consumer-id-here\u003e'\n})\n\nconst { crm } = apideck\n\nconst { data } = await crm.contactsAll({\n  limit: 10\n})\n\nconst result = await crm.contactsUpdate({\n  id: data[0].id!,\n  contact: {\n    name: \"John Doe\",\n    first_name: \"John\",\n    last_name: \"Doe\",\n    addresses: [{\n      city: \"Hoboken\",\n      line1: \"Streetname 19\",\n      state: \"NY\"\n    }],\n    phone_numbers: [{\n      number: '0486565656',\n      phoneType: PhoneNumberType.Home\n    }]\n  }\n})\n\nconsole.info(result)\n```\n\n\u003ca name=\"documentation-for-api-endpoints\"\u003e\u003c/a\u003e\n## Apideck Unified Apis\n\nThe following Apis are currently available:\n\n### AccountingApi\n\nRead the full documentation of the AccountingApi [here](./src/gen/docs/apis/AccountingApi.md).\n\n### AtsApi\n\nRead the full documentation of the AtsApi [here](./src/gen/docs/apis/AtsApi.md).\n\n### ConnectorApi\n\nRead the full documentation of the ConnectorApi [here](./src/gen/docs/apis/ConnectorApi.md).\n\n### CrmApi\n\nRead the full documentation of the CrmApi [here](./src/gen/docs/apis/CrmApi.md).\n\n### EcommerceApi\n\nRead the full documentation of the EcommerceApi [here](./src/gen/docs/apis/EcommerceApi.md).\n\n### FileStorageApi\n\nRead the full documentation of the FileStorageApi [here](./src/gen/docs/apis/FileStorageApi.md).\n\n### HrisApi\n\nRead the full documentation of the HrisApi [here](./src/gen/docs/apis/HrisApi.md).\n\n### IssueTrackingApi\n\nRead the full documentation of the IssueTrackingApi [here](./src/gen/docs/apis/IssueTrackingApi.md).\n\n### LeadApi\n\nRead the full documentation of the LeadApi [here](./src/gen/docs/apis/LeadApi.md).\n\n### PosApi\n\nRead the full documentation of the PosApi [here](./src/gen/docs/apis/PosApi.md).\n\n### SmsApi\n\nRead the full documentation of the SmsApi [here](./src/gen/docs/apis/SmsApi.md).\n\n### VaultApi\n\nRead the full documentation of the VaultApi [here](./src/gen/docs/apis/VaultApi.md).\n\n### WebhookApi\n\nRead the full documentation of the WebhookApi [here](./src/gen/docs/apis/WebhookApi.md).\n\n\n### Utils\n\n#### uploadFile\n\nA utility for uploading files using the File Storage API. `uploadFile` will automatically use upload sessions for files larger than 4MB. Smaller files will be uploaded with a simple upload call.\n\n**Example Usage**\n\n```ts\nconst apideck = new Apideck({\n  apiKey: '\u003cinsert-api-key-here\u003e',\n  appId: '\u003cinsert-application-id-here\u003e',\n  consumerId: '\u003cinsert-consumer-id-here\u003e'\n});\n\n\nconst file = await apideck.utils.uploadFile({\n  serviceId: 'dropbox',\n  file: buffer, // Buffer | string\n  name: \"test.jpg\",\n  size: fileSize, // file size in bytes\n  contentType: \"image/jpg\", // optional\n});\n```\n\n## Support\n\nOpen an [issue][3]!\n\n## License\n\n[Apache-2.0][4]\n\n[1]: https://apideck.com\n[2]: https://developers.apideck.com/\n[3]: https://github.com/apideck-libraries/node-sdk/issues/new\n[4]: https://github.com/apideck-libraries/node-sdk/blob/main/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapideck-libraries%2Fnode-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapideck-libraries%2Fnode-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapideck-libraries%2Fnode-sdk/lists"}