@apideck/unify 0.27.0 → 0.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/docs/sdks/companies/README.md +4 -4
- package/examples/README.md +26 -0
- package/examples/accountingTaxRatesList.example.ts +41 -0
- package/examples/package-lock.json +613 -0
- package/examples/package.json +18 -0
- package/funcs/crmCompaniesCreate.js +1 -1
- package/funcs/crmCompaniesCreate.js.map +1 -1
- package/funcs/crmCompaniesUpdate.js +1 -1
- package/funcs/crmCompaniesUpdate.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.js +4 -4
- package/models/components/bankaccount.d.ts +5 -0
- package/models/components/bankaccount.d.ts.map +1 -1
- package/models/components/bankaccount.js +2 -0
- package/models/components/bankaccount.js.map +1 -1
- package/models/components/bankaccount1.d.ts +123 -0
- package/models/components/bankaccount1.d.ts.map +1 -0
- package/models/components/bankaccount1.js +128 -0
- package/models/components/bankaccount1.js.map +1 -0
- package/models/components/{company.d.ts → company1.d.ts} +32 -32
- package/models/components/company1.d.ts.map +1 -0
- package/models/components/{company.js → company1.js} +37 -37
- package/models/components/company1.js.map +1 -0
- package/models/components/companyinfo.d.ts +5 -0
- package/models/components/companyinfo.d.ts.map +1 -1
- package/models/components/companyinfo.js +4 -0
- package/models/components/companyinfo.js.map +1 -1
- package/models/components/getcompaniesresponse.d.ts +3 -3
- package/models/components/getcompaniesresponse.d.ts.map +1 -1
- package/models/components/getcompaniesresponse.js +3 -3
- package/models/components/getcompaniesresponse.js.map +1 -1
- package/models/components/getcompanyresponse.d.ts +3 -3
- package/models/components/getcompanyresponse.d.ts.map +1 -1
- package/models/components/getcompanyresponse.js +3 -3
- package/models/components/getcompanyresponse.js.map +1 -1
- package/models/components/index.d.ts +2 -1
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +2 -1
- package/models/components/index.js.map +1 -1
- package/models/components/supplier.d.ts +10 -0
- package/models/components/supplier.d.ts.map +1 -1
- package/models/components/supplier.js +4 -0
- package/models/components/supplier.js.map +1 -1
- package/models/errors/apierror.d.ts.map +1 -1
- package/models/errors/apierror.js +8 -2
- package/models/errors/apierror.js.map +1 -1
- package/models/errors/badrequestresponse.js +1 -1
- package/models/errors/badrequestresponse.js.map +1 -1
- package/models/errors/notfoundresponse.js +1 -1
- package/models/errors/notfoundresponse.js.map +1 -1
- package/models/errors/paymentrequiredresponse.js +1 -1
- package/models/errors/paymentrequiredresponse.js.map +1 -1
- package/models/errors/unauthorizedresponse.js +1 -1
- package/models/errors/unauthorizedresponse.js.map +1 -1
- package/models/errors/unprocessableresponse.js +1 -1
- package/models/errors/unprocessableresponse.js.map +1 -1
- package/models/operations/crmcompaniesadd.d.ts +2 -2
- package/models/operations/crmcompaniesadd.d.ts.map +1 -1
- package/models/operations/crmcompaniesadd.js +4 -4
- package/models/operations/crmcompaniesadd.js.map +1 -1
- package/models/operations/crmcompaniesupdate.d.ts +2 -2
- package/models/operations/crmcompaniesupdate.d.ts.map +1 -1
- package/models/operations/crmcompaniesupdate.js +4 -4
- package/models/operations/crmcompaniesupdate.js.map +1 -1
- package/package.json +1 -1
- package/src/__tests__/activities.test.ts +360 -9
- package/src/__tests__/apideckcompanies.test.ts +373 -9
- package/src/__tests__/apideckdepartments.test.ts +181 -9
- package/src/__tests__/applicants.test.ts +473 -9
- package/src/__tests__/applications.test.ts +189 -9
- package/src/__tests__/billpayments.test.ts +367 -9
- package/src/__tests__/bills.test.ts +500 -9
- package/src/__tests__/collectionticketcomments.test.ts +183 -7
- package/src/__tests__/collectiontickets.test.ts +191 -7
- package/src/__tests__/companies.test.ts +538 -9
- package/src/__tests__/connections.test.ts +409 -5
- package/src/__tests__/connectionsettings.test.ts +410 -5
- package/src/__tests__/contacts.test.ts +466 -9
- package/src/__tests__/creditnotes.test.ts +758 -87
- package/src/__tests__/customers.test.ts +513 -9
- package/src/__tests__/customobjects.test.ts +150 -9
- package/src/__tests__/customobjectschemas.test.ts +321 -9
- package/src/__tests__/departments.test.ts +173 -9
- package/src/__tests__/drivegroups.test.ts +181 -9
- package/src/__tests__/drives.test.ts +179 -9
- package/src/__tests__/employees.test.ts +829 -94
- package/src/__tests__/expenses.test.ts +332 -9
- package/src/__tests__/files.test.ts +106 -5
- package/src/__tests__/folders.test.ts +296 -13
- package/src/__tests__/invoiceitems.test.ts +272 -9
- package/src/__tests__/invoices.test.ts +673 -67
- package/src/__tests__/journalentries.test.ts +490 -8
- package/src/__tests__/leads.test.ts +446 -9
- package/src/__tests__/ledgeraccounts.test.ts +237 -8
- package/src/__tests__/locations.test.ts +298 -9
- package/src/__tests__/messages.test.ts +195 -9
- package/src/__tests__/notes.test.ts +191 -9
- package/src/__tests__/opportunities.test.ts +218 -9
- package/src/__tests__/payments.test.ts +312 -9
- package/src/__tests__/pipelines.test.ts +194 -9
- package/src/__tests__/purchaseorders.test.ts +773 -104
- package/src/__tests__/sharedlinks.test.ts +183 -9
- package/src/__tests__/subsidiaries.test.ts +183 -9
- package/src/__tests__/suppliers.test.ts +505 -9
- package/src/__tests__/taxrates.test.ts +232 -9
- package/src/__tests__/timeoffrequests.test.ts +210 -9
- package/src/__tests__/trackingcategories.test.ts +187 -7
- package/src/__tests__/uploadsessions.test.ts +78 -5
- package/src/__tests__/users.test.ts +356 -9
- package/src/funcs/crmCompaniesCreate.ts +1 -1
- package/src/funcs/crmCompaniesUpdate.ts +1 -1
- package/src/lib/config.ts +4 -4
- package/src/models/components/bankaccount.ts +7 -0
- package/src/models/components/bankaccount1.ts +207 -0
- package/src/models/components/{company.ts → company1.ts} +131 -128
- package/src/models/components/companyinfo.ts +9 -0
- package/src/models/components/getcompaniesresponse.ts +9 -9
- package/src/models/components/getcompanyresponse.ts +9 -9
- package/src/models/components/index.ts +2 -1
- package/src/models/components/supplier.ts +14 -0
- package/src/models/errors/apierror.ts +8 -2
- package/src/models/errors/badrequestresponse.ts +1 -1
- package/src/models/errors/notfoundresponse.ts +1 -1
- package/src/models/errors/paymentrequiredresponse.ts +1 -1
- package/src/models/errors/unauthorizedresponse.ts +1 -1
- package/src/models/errors/unprocessableresponse.ts +1 -1
- package/src/models/operations/crmcompaniesadd.ts +6 -6
- package/src/models/operations/crmcompaniesupdate.ts +6 -6
- package/models/components/company.d.ts.map +0 -1
- package/models/components/company.js.map +0 -1
package/README.md
CHANGED
|
@@ -1257,11 +1257,11 @@ run();
|
|
|
1257
1257
|
### Error Classes
|
|
1258
1258
|
**Primary errors:**
|
|
1259
1259
|
* [`ApideckError`](./src/models/errors/apideckerror.ts): The base class for HTTP error responses.
|
|
1260
|
-
* [`UnauthorizedResponse`](
|
|
1261
|
-
* [`PaymentRequiredResponse`](
|
|
1262
|
-
* [`NotFoundResponse`](
|
|
1263
|
-
* [`BadRequestResponse`](
|
|
1264
|
-
* [`UnprocessableResponse`](
|
|
1260
|
+
* [`UnauthorizedResponse`](./src/models/errors/unauthorizedresponse.ts): Unauthorized. Status code `401`.
|
|
1261
|
+
* [`PaymentRequiredResponse`](./src/models/errors/paymentrequiredresponse.ts): Payment Required. Status code `402`.
|
|
1262
|
+
* [`NotFoundResponse`](./src/models/errors/notfoundresponse.ts): The specified resource was not found. Status code `404`. *
|
|
1263
|
+
* [`BadRequestResponse`](./src/models/errors/badrequestresponse.ts): Bad Request. Status code `400`. *
|
|
1264
|
+
* [`UnprocessableResponse`](./src/models/errors/unprocessableresponse.ts): Unprocessable. Status code `422`. *
|
|
1265
1265
|
|
|
1266
1266
|
<details><summary>Less common errors (6)</summary>
|
|
1267
1267
|
|
|
@@ -137,7 +137,7 @@ const apideck = new Apideck({
|
|
|
137
137
|
async function run() {
|
|
138
138
|
const result = await apideck.crm.companies.create({
|
|
139
139
|
serviceId: "salesforce",
|
|
140
|
-
|
|
140
|
+
company1: {
|
|
141
141
|
name: "SpaceX",
|
|
142
142
|
ownerId: "12345",
|
|
143
143
|
image: "https://www.spacex.com/static/images/share.jpg",
|
|
@@ -357,7 +357,7 @@ const apideck = new ApideckCore({
|
|
|
357
357
|
async function run() {
|
|
358
358
|
const res = await crmCompaniesCreate(apideck, {
|
|
359
359
|
serviceId: "salesforce",
|
|
360
|
-
|
|
360
|
+
company1: {
|
|
361
361
|
name: "SpaceX",
|
|
362
362
|
ownerId: "12345",
|
|
363
363
|
image: "https://www.spacex.com/static/images/share.jpg",
|
|
@@ -690,7 +690,7 @@ async function run() {
|
|
|
690
690
|
const result = await apideck.crm.companies.update({
|
|
691
691
|
id: "<id>",
|
|
692
692
|
serviceId: "salesforce",
|
|
693
|
-
|
|
693
|
+
company1: {
|
|
694
694
|
name: "SpaceX",
|
|
695
695
|
ownerId: "12345",
|
|
696
696
|
image: "https://www.spacex.com/static/images/share.jpg",
|
|
@@ -949,7 +949,7 @@ async function run() {
|
|
|
949
949
|
const res = await crmCompaniesUpdate(apideck, {
|
|
950
950
|
id: "<id>",
|
|
951
951
|
serviceId: "salesforce",
|
|
952
|
-
|
|
952
|
+
company1: {
|
|
953
953
|
name: "SpaceX",
|
|
954
954
|
ownerId: "12345",
|
|
955
955
|
image: "https://www.spacex.com/static/images/share.jpg",
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# @apideck/unify Examples
|
|
2
|
+
|
|
3
|
+
This directory contains example scripts demonstrating how to use the @apideck/unify SDK.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
- Node.js (v18 or higher)
|
|
8
|
+
- npm
|
|
9
|
+
|
|
10
|
+
## Setup
|
|
11
|
+
|
|
12
|
+
1. Copy `.env.template` to `.env`:
|
|
13
|
+
```bash
|
|
14
|
+
cp .env.template .env
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
|
|
18
|
+
|
|
19
|
+
## Running the Examples
|
|
20
|
+
|
|
21
|
+
To run an example file from the examples directory:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npm run build && npx tsx example.ts
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Example usage of the @apideck/unify SDK
|
|
7
|
+
*
|
|
8
|
+
* To run this example from the examples directory:
|
|
9
|
+
* npm run build && npx tsx accountingTaxRatesList.ts
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
import { Apideck } from "@apideck/unify";
|
|
13
|
+
|
|
14
|
+
const apideck = new Apideck({
|
|
15
|
+
consumerId: "test-consumer",
|
|
16
|
+
appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
|
|
17
|
+
apiKey: process.env["APIDECK_API_KEY"] ?? "",
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
async function main() {
|
|
21
|
+
const result = await apideck.list({
|
|
22
|
+
serviceId: "salesforce",
|
|
23
|
+
filter: {
|
|
24
|
+
assets: true,
|
|
25
|
+
equity: true,
|
|
26
|
+
expenses: true,
|
|
27
|
+
liabilities: true,
|
|
28
|
+
revenue: true,
|
|
29
|
+
},
|
|
30
|
+
passThrough: {
|
|
31
|
+
"search": "San Francisco",
|
|
32
|
+
},
|
|
33
|
+
fields: "id,updated_at",
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
for await (const page of result) {
|
|
37
|
+
console.log(page);
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
main().catch(console.error);
|