@apideck/unify 0.23.2 → 0.23.4

package/docs/sdks/journalentries/README.md

@@ -163,66 +163,6 @@ async function run() {
               id: "123456",
               name: "New York",
             },
-          ],
-          ledgerAccount: {
-            id: "123456",
-            nominalCode: "N091",
-            code: "453",
-          },
-          customer: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            email: "boring@boring.com",
-          },
-          supplier: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            address: {
-              id: "123",
-              type: "primary",
-              string: "25 Spring Street, Blackburn, VIC 3130",
-              name: "HQ US",
-              line1: "Main street",
-              line2: "apt #",
-              line3: "Suite #",
-              line4: "delivery instructions",
-              streetNumber: "25",
-              city: "San Francisco",
-              state: "CA",
-              postalCode: "94104",
-              country: "US",
-              latitude: "40.759211",
-              longitude: "-73.984638",
-              county: "Santa Clara",
-              contactName: "Elon Musk",
-              salutation: "Mr",
-              phoneNumber: "111-111-1111",
-              fax: "122-111-1111",
-              email: "elon@musk.com",
-              website: "https://elonmusk.com",
-              notes: "Address notes or delivery instructions.",
-              rowVersion: "1-12345",
-            },
-          },
-          departmentId: "12345",
-          locationId: "12345",
-          lineNumber: 1,
-        },
-        {
-          description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
-          taxAmount: 27500,
-          subTotal: 27500,
-          totalAmount: 27500,
-          type: "debit",
-          taxRate: {
-            id: "123456",
-            rate: 10,
-          },
-          trackingCategories: [
-            {
-              id: "123456",
-              name: "New York",
-            },
             {
               id: "123456",
               name: "New York",
@@ -279,12 +219,7 @@ async function run() {
       taxType: "sales",
       taxCode: "1234",
       number: "OIT00546",
-      trackingCategories: [
-        {
-          id: "123456",
-          name: "New York",
-        },
-      ],
+      trackingCategories: null,
       accountingPeriod: "01-24",
       rowVersion: "1-12345",
       customFields: [
@@ -292,11 +227,7 @@ async function run() {
           id: "2389328923893298",
           name: "employee_level",
           description: "Employee Level",
-          value: [
-            "<value>",
-            "<value>",
-            "<value>",
-          ],
+          value: "Uses Salesforce and Marketo",
         },
       ],
       passThrough: [
@@ -311,6 +242,80 @@ async function run() {
                 },
               },
             },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
           ],
         },
       ],
@@ -368,66 +373,6 @@ async function run() {
               id: "123456",
               name: "New York",
             },
-          ],
-          ledgerAccount: {
-            id: "123456",
-            nominalCode: "N091",
-            code: "453",
-          },
-          customer: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            email: "boring@boring.com",
-          },
-          supplier: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            address: {
-              id: "123",
-              type: "primary",
-              string: "25 Spring Street, Blackburn, VIC 3130",
-              name: "HQ US",
-              line1: "Main street",
-              line2: "apt #",
-              line3: "Suite #",
-              line4: "delivery instructions",
-              streetNumber: "25",
-              city: "San Francisco",
-              state: "CA",
-              postalCode: "94104",
-              country: "US",
-              latitude: "40.759211",
-              longitude: "-73.984638",
-              county: "Santa Clara",
-              contactName: "Elon Musk",
-              salutation: "Mr",
-              phoneNumber: "111-111-1111",
-              fax: "122-111-1111",
-              email: "elon@musk.com",
-              website: "https://elonmusk.com",
-              notes: "Address notes or delivery instructions.",
-              rowVersion: "1-12345",
-            },
-          },
-          departmentId: "12345",
-          locationId: "12345",
-          lineNumber: 1,
-        },
-        {
-          description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
-          taxAmount: 27500,
-          subTotal: 27500,
-          totalAmount: 27500,
-          type: "debit",
-          taxRate: {
-            id: "123456",
-            rate: 10,
-          },
-          trackingCategories: [
-            {
-              id: "123456",
-              name: "New York",
-            },
             {
               id: "123456",
               name: "New York",
@@ -484,12 +429,7 @@ async function run() {
       taxType: "sales",
       taxCode: "1234",
       number: "OIT00546",
-      trackingCategories: [
-        {
-          id: "123456",
-          name: "New York",
-        },
-      ],
+      trackingCategories: null,
       accountingPeriod: "01-24",
       rowVersion: "1-12345",
       customFields: [
@@ -497,11 +437,7 @@ async function run() {
           id: "2389328923893298",
           name: "employee_level",
           description: "Employee Level",
-          value: [
-            "<value>",
-            "<value>",
-            "<value>",
-          ],
+          value: "Uses Salesforce and Marketo",
         },
       ],
       passThrough: [
@@ -516,6 +452,80 @@ async function run() {
                 },
               },
             },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
           ],
         },
       ],
@@ -611,196 +621,68 @@ async function run() {
     fields: "id,updated_at",
   });
 
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.AccountingJournalEntriesOneRequest](../../models/operations/accountingjournalentriesonerequest.md)                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.AccountingJournalEntriesOneResponse](../../models/operations/accountingjournalentriesoneresponse.md)\>**
-
-### Errors
-
-| Error Type                     | Status Code                    | Content Type                   |
-| ------------------------------ | ------------------------------ | ------------------------------ |
-| errors.BadRequestResponse      | 400                            | application/json               |
-| errors.UnauthorizedResponse    | 401                            | application/json               |
-| errors.PaymentRequiredResponse | 402                            | application/json               |
-| errors.NotFoundResponse        | 404                            | application/json               |
-| errors.UnprocessableResponse   | 422                            | application/json               |
-| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
-
-## update
-
-Update Journal Entry
-
-### Example Usage
-
-```typescript
-import { Apideck } from "@apideck/unify";
-
-const apideck = new Apideck({
-  apiKey: process.env["APIDECK_API_KEY"] ?? "",
-  consumerId: "test-consumer",
-  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
-});
-
-async function run() {
-  const result = await apideck.accounting.journalEntries.update({
-    id: "<id>",
-    serviceId: "salesforce",
-    journalEntry: {
-      title: "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry",
-      currencyRate: 0.69,
-      currency: "USD",
-      companyId: "12345",
-      lineItems: [
-        {
-          description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
-          taxAmount: 27500,
-          subTotal: 27500,
-          totalAmount: 27500,
-          type: "debit",
-          taxRate: {
-            id: "123456",
-            rate: 10,
-          },
-          trackingCategories: [
-            {
-              id: "123456",
-              name: "New York",
-            },
-            {
-              id: "123456",
-              name: "New York",
-            },
-          ],
-          ledgerAccount: {
-            id: "123456",
-            nominalCode: "N091",
-            code: "453",
-          },
-          customer: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            email: "boring@boring.com",
-          },
-          supplier: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            address: {
-              id: "123",
-              type: "primary",
-              string: "25 Spring Street, Blackburn, VIC 3130",
-              name: "HQ US",
-              line1: "Main street",
-              line2: "apt #",
-              line3: "Suite #",
-              line4: "delivery instructions",
-              streetNumber: "25",
-              city: "San Francisco",
-              state: "CA",
-              postalCode: "94104",
-              country: "US",
-              latitude: "40.759211",
-              longitude: "-73.984638",
-              county: "Santa Clara",
-              contactName: "Elon Musk",
-              salutation: "Mr",
-              phoneNumber: "111-111-1111",
-              fax: "122-111-1111",
-              email: "elon@musk.com",
-              website: "https://elonmusk.com",
-              notes: "Address notes or delivery instructions.",
-              rowVersion: "1-12345",
-            },
-          },
-          departmentId: "12345",
-          locationId: "12345",
-          lineNumber: 1,
-        },
-        {
-          description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
-          taxAmount: 27500,
-          subTotal: 27500,
-          totalAmount: 27500,
-          type: "debit",
-          taxRate: {
-            id: "123456",
-            rate: 10,
-          },
-          trackingCategories: [
-            {
-              id: "123456",
-              name: "New York",
-            },
-            {
-              id: "123456",
-              name: "New York",
-            },
-          ],
-          ledgerAccount: {
-            id: "123456",
-            nominalCode: "N091",
-            code: "453",
-          },
-          customer: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            email: "boring@boring.com",
-          },
-          supplier: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            address: {
-              id: "123",
-              type: "primary",
-              string: "25 Spring Street, Blackburn, VIC 3130",
-              name: "HQ US",
-              line1: "Main street",
-              line2: "apt #",
-              line3: "Suite #",
-              line4: "delivery instructions",
-              streetNumber: "25",
-              city: "San Francisco",
-              state: "CA",
-              postalCode: "94104",
-              country: "US",
-              latitude: "40.759211",
-              longitude: "-73.984638",
-              county: "Santa Clara",
-              contactName: "Elon Musk",
-              salutation: "Mr",
-              phoneNumber: "111-111-1111",
-              fax: "122-111-1111",
-              email: "elon@musk.com",
-              website: "https://elonmusk.com",
-              notes: "Address notes or delivery instructions.",
-              rowVersion: "1-12345",
-            },
-          },
-          departmentId: "12345",
-          locationId: "12345",
-          lineNumber: 1,
-        },
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AccountingJournalEntriesOneRequest](../../models/operations/accountingjournalentriesonerequest.md)                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.AccountingJournalEntriesOneResponse](../../models/operations/accountingjournalentriesoneresponse.md)\>**
+
+### Errors
+
+| Error Type                     | Status Code                    | Content Type                   |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| errors.BadRequestResponse      | 400                            | application/json               |
+| errors.UnauthorizedResponse    | 401                            | application/json               |
+| errors.PaymentRequiredResponse | 402                            | application/json               |
+| errors.NotFoundResponse        | 404                            | application/json               |
+| errors.UnprocessableResponse   | 422                            | application/json               |
+| errors.APIError                | 4XX, 5XX                       | \*/\*                          |
+
+## update
+
+Update Journal Entry
+
+### Example Usage
+
+```typescript
+import { Apideck } from "@apideck/unify";
+
+const apideck = new Apideck({
+  apiKey: process.env["APIDECK_API_KEY"] ?? "",
+  consumerId: "test-consumer",
+  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+});
+
+async function run() {
+  const result = await apideck.accounting.journalEntries.update({
+    id: "<id>",
+    serviceId: "salesforce",
+    journalEntry: {
+      title: "Purchase Invoice-Inventory (USD): 2019/02/01 Batch Summary Entry",
+      currencyRate: 0.69,
+      currency: "USD",
+      companyId: "12345",
+      lineItems: [
         {
           description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
           taxAmount: 27500,
@@ -893,18 +775,31 @@ async function run() {
           id: "2389328923893298",
           name: "employee_level",
           description: "Employee Level",
-          value: {},
+          value: "Uses Salesforce and Marketo",
         },
+      ],
+      passThrough: [
         {
-          id: "2389328923893298",
-          name: "employee_level",
-          description: "Employee Level",
-          value: [
-            {},
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
           ],
         },
-      ],
-      passThrough: [
         {
           serviceId: "<id>",
           extendPaths: [
@@ -916,6 +811,14 @@ async function run() {
                 },
               },
             },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
           ],
         },
       ],
@@ -955,134 +858,6 @@ async function run() {
       currency: "USD",
       companyId: "12345",
       lineItems: [
-        {
-          description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
-          taxAmount: 27500,
-          subTotal: 27500,
-          totalAmount: 27500,
-          type: "debit",
-          taxRate: {
-            id: "123456",
-            rate: 10,
-          },
-          trackingCategories: [
-            {
-              id: "123456",
-              name: "New York",
-            },
-            {
-              id: "123456",
-              name: "New York",
-            },
-          ],
-          ledgerAccount: {
-            id: "123456",
-            nominalCode: "N091",
-            code: "453",
-          },
-          customer: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            email: "boring@boring.com",
-          },
-          supplier: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            address: {
-              id: "123",
-              type: "primary",
-              string: "25 Spring Street, Blackburn, VIC 3130",
-              name: "HQ US",
-              line1: "Main street",
-              line2: "apt #",
-              line3: "Suite #",
-              line4: "delivery instructions",
-              streetNumber: "25",
-              city: "San Francisco",
-              state: "CA",
-              postalCode: "94104",
-              country: "US",
-              latitude: "40.759211",
-              longitude: "-73.984638",
-              county: "Santa Clara",
-              contactName: "Elon Musk",
-              salutation: "Mr",
-              phoneNumber: "111-111-1111",
-              fax: "122-111-1111",
-              email: "elon@musk.com",
-              website: "https://elonmusk.com",
-              notes: "Address notes or delivery instructions.",
-              rowVersion: "1-12345",
-            },
-          },
-          departmentId: "12345",
-          locationId: "12345",
-          lineNumber: 1,
-        },
-        {
-          description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
-          taxAmount: 27500,
-          subTotal: 27500,
-          totalAmount: 27500,
-          type: "debit",
-          taxRate: {
-            id: "123456",
-            rate: 10,
-          },
-          trackingCategories: [
-            {
-              id: "123456",
-              name: "New York",
-            },
-            {
-              id: "123456",
-              name: "New York",
-            },
-          ],
-          ledgerAccount: {
-            id: "123456",
-            nominalCode: "N091",
-            code: "453",
-          },
-          customer: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            email: "boring@boring.com",
-          },
-          supplier: {
-            id: "12345",
-            displayName: "Windsurf Shop",
-            address: {
-              id: "123",
-              type: "primary",
-              string: "25 Spring Street, Blackburn, VIC 3130",
-              name: "HQ US",
-              line1: "Main street",
-              line2: "apt #",
-              line3: "Suite #",
-              line4: "delivery instructions",
-              streetNumber: "25",
-              city: "San Francisco",
-              state: "CA",
-              postalCode: "94104",
-              country: "US",
-              latitude: "40.759211",
-              longitude: "-73.984638",
-              county: "Santa Clara",
-              contactName: "Elon Musk",
-              salutation: "Mr",
-              phoneNumber: "111-111-1111",
-              fax: "122-111-1111",
-              email: "elon@musk.com",
-              website: "https://elonmusk.com",
-              notes: "Address notes or delivery instructions.",
-              rowVersion: "1-12345",
-            },
-          },
-          departmentId: "12345",
-          locationId: "12345",
-          lineNumber: 1,
-        },
         {
           description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
           taxAmount: 27500,
@@ -1175,18 +950,31 @@ async function run() {
           id: "2389328923893298",
           name: "employee_level",
           description: "Employee Level",
-          value: {},
+          value: "Uses Salesforce and Marketo",
         },
+      ],
+      passThrough: [
         {
-          id: "2389328923893298",
-          name: "employee_level",
-          description: "Employee Level",
-          value: [
-            {},
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
           ],
         },
-      ],
-      passThrough: [
         {
           serviceId: "<id>",
           extendPaths: [
@@ -1198,6 +986,14 @@ async function run() {
                 },
               },
             },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
           ],
         },
       ],