@apideck/unify 0.13.6 → 0.14.0

package/docs/sdks/customers/README.md

@@ -28,7 +28,9 @@ const apideck = new Apideck({
 
 async function run() {
   const result = await apideck.accounting.customers.list({
+    raw: false,
     serviceId: "salesforce",
+    limit: 20,
     filter: {
       companyName: "SpaceX",
       displayName: "Elon Musk",
@@ -75,7 +77,9 @@ const apideck = new ApideckCore({
 
 async function run() {
   const res = await accountingCustomersList(apideck, {
+    raw: false,
     serviceId: "salesforce",
+    limit: 20,
     filter: {
       companyName: "SpaceX",
       displayName: "Elon Musk",
@@ -151,6 +155,7 @@ const apideck = new Apideck({
 
 async function run() {
   const result = await apideck.accounting.customers.create({
+    raw: false,
     serviceId: "salesforce",
     customer: {
       displayId: "EMP00101",
@@ -191,16 +196,34 @@ async function run() {
           notes: "Address notes or delivery instructions.",
           rowVersion: "1-12345",
         },
-      ],
-      phoneNumbers: [
         {
-          id: "12345",
-          countryCode: "1",
-          areaCode: "323",
-          number: "111-111-1111",
-          extension: "105",
+          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",
         },
+      ],
+      phoneNumbers: [
         {
           id: "12345",
           countryCode: "1",
@@ -236,16 +259,6 @@ async function run() {
           url: "http://example.com",
           type: "primary",
         },
-        {
-          id: "12345",
-          url: "http://example.com",
-          type: "primary",
-        },
-        {
-          id: "12345",
-          url: "http://example.com",
-          type: "primary",
-        },
       ],
       bankAccounts: [
         {
@@ -261,19 +274,6 @@ async function run() {
           bankCode: "BNH",
           currency: "USD",
         },
-        {
-          bankName: "Monzo",
-          accountNumber: "123465",
-          accountName: "SPACEX LLC",
-          accountType: "credit_card",
-          iban: "CH2989144532982975332",
-          bic: "AUDSCHGGXXX",
-          routingNumber: "012345678",
-          bsbNumber: "062-001",
-          branchIdentifier: "001",
-          bankCode: "BNH",
-          currency: "USD",
-        },
       ],
       notes: "Some notes about this customer",
       taxRate: {
@@ -294,6 +294,26 @@ async function run() {
       status: "active",
       paymentMethod: "cash",
       channel: "email",
+      customFields: [
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: {},
+        },
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: 10,
+        },
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: "Uses Salesforce and Marketo",
+        },
+      ],
       rowVersion: "1-12345",
       passThrough: [
         {
@@ -307,6 +327,22 @@ async function run() {
                 },
               },
             },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
           ],
         },
         {
@@ -320,6 +356,43 @@ async function run() {
                 },
               },
             },
+            {
+              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",
+                },
+              },
+            },
           ],
         },
       ],
@@ -351,6 +424,7 @@ const apideck = new ApideckCore({
 
 async function run() {
   const res = await accountingCustomersCreate(apideck, {
+    raw: false,
     serviceId: "salesforce",
     customer: {
       displayId: "EMP00101",
@@ -391,16 +465,34 @@ async function run() {
           notes: "Address notes or delivery instructions.",
           rowVersion: "1-12345",
         },
-      ],
-      phoneNumbers: [
         {
-          id: "12345",
-          countryCode: "1",
-          areaCode: "323",
-          number: "111-111-1111",
-          extension: "105",
+          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",
         },
+      ],
+      phoneNumbers: [
         {
           id: "12345",
           countryCode: "1",
@@ -436,16 +528,6 @@ async function run() {
           url: "http://example.com",
           type: "primary",
         },
-        {
-          id: "12345",
-          url: "http://example.com",
-          type: "primary",
-        },
-        {
-          id: "12345",
-          url: "http://example.com",
-          type: "primary",
-        },
       ],
       bankAccounts: [
         {
@@ -461,19 +543,6 @@ async function run() {
           bankCode: "BNH",
           currency: "USD",
         },
-        {
-          bankName: "Monzo",
-          accountNumber: "123465",
-          accountName: "SPACEX LLC",
-          accountType: "credit_card",
-          iban: "CH2989144532982975332",
-          bic: "AUDSCHGGXXX",
-          routingNumber: "012345678",
-          bsbNumber: "062-001",
-          branchIdentifier: "001",
-          bankCode: "BNH",
-          currency: "USD",
-        },
       ],
       notes: "Some notes about this customer",
       taxRate: {
@@ -494,6 +563,26 @@ async function run() {
       status: "active",
       paymentMethod: "cash",
       channel: "email",
+      customFields: [
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: {},
+        },
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: 10,
+        },
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: "Uses Salesforce and Marketo",
+        },
+      ],
       rowVersion: "1-12345",
       passThrough: [
         {
@@ -507,6 +596,43 @@ 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",
+                },
+              },
+            },
           ],
         },
         {
@@ -520,6 +646,22 @@ async function run() {
                 },
               },
             },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
           ],
         },
       ],
@@ -582,6 +724,7 @@ async function run() {
   const result = await apideck.accounting.customers.get({
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     fields: "id,updated_at",
   });
 
@@ -612,6 +755,7 @@ async function run() {
   const res = await accountingCustomersGet(apideck, {
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     fields: "id,updated_at",
   });
 
@@ -671,6 +815,7 @@ async function run() {
   const result = await apideck.accounting.customers.update({
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     customer: {
       displayId: "EMP00101",
       displayName: "Windsurf Shop",
@@ -710,6 +855,58 @@ async function run() {
           notes: "Address notes or delivery instructions.",
           rowVersion: "1-12345",
         },
+        {
+          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",
+        },
+        {
+          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",
+        },
       ],
       phoneNumbers: [
         {
@@ -720,6 +917,14 @@ async function run() {
           extension: "105",
           type: "primary",
         },
+        {
+          id: "12345",
+          countryCode: "1",
+          areaCode: "323",
+          number: "111-111-1111",
+          extension: "105",
+          type: "primary",
+        },
       ],
       emails: [
         {
@@ -727,6 +932,11 @@ async function run() {
           email: "elon@musk.com",
           type: "primary",
         },
+        {
+          id: "123",
+          email: "elon@musk.com",
+          type: "primary",
+        },
       ],
       websites: [
         {
@@ -734,6 +944,16 @@ async function run() {
           url: "http://example.com",
           type: "primary",
         },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
       ],
       bankAccounts: [
         {
@@ -782,21 +1002,24 @@ async function run() {
       status: "active",
       paymentMethod: "cash",
       channel: "email",
-      rowVersion: "1-12345",
-      passThrough: [
+      customFields: [
         {
-          serviceId: "<id>",
-          extendPaths: [
-            {
-              path: "$.nested.property",
-              value: {
-                "TaxClassificationRef": {
-                  "value": "EUC-99990201-V1-00020000",
-                },
-              },
-            },
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: {},
+        },
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: [
+            {},
           ],
         },
+      ],
+      rowVersion: "1-12345",
+      passThrough: [
         {
           serviceId: "<id>",
           extendPaths: [
@@ -841,6 +1064,7 @@ async function run() {
   const res = await accountingCustomersUpdate(apideck, {
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     customer: {
       displayId: "EMP00101",
       displayName: "Windsurf Shop",
@@ -880,6 +1104,58 @@ async function run() {
           notes: "Address notes or delivery instructions.",
           rowVersion: "1-12345",
         },
+        {
+          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",
+        },
+        {
+          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",
+        },
       ],
       phoneNumbers: [
         {
@@ -890,6 +1166,14 @@ async function run() {
           extension: "105",
           type: "primary",
         },
+        {
+          id: "12345",
+          countryCode: "1",
+          areaCode: "323",
+          number: "111-111-1111",
+          extension: "105",
+          type: "primary",
+        },
       ],
       emails: [
         {
@@ -897,6 +1181,11 @@ async function run() {
           email: "elon@musk.com",
           type: "primary",
         },
+        {
+          id: "123",
+          email: "elon@musk.com",
+          type: "primary",
+        },
       ],
       websites: [
         {
@@ -904,6 +1193,16 @@ async function run() {
           url: "http://example.com",
           type: "primary",
         },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
       ],
       bankAccounts: [
         {
@@ -952,21 +1251,24 @@ async function run() {
       status: "active",
       paymentMethod: "cash",
       channel: "email",
-      rowVersion: "1-12345",
-      passThrough: [
+      customFields: [
         {
-          serviceId: "<id>",
-          extendPaths: [
-            {
-              path: "$.nested.property",
-              value: {
-                "TaxClassificationRef": {
-                  "value": "EUC-99990201-V1-00020000",
-                },
-              },
-            },
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: {},
+        },
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: [
+            {},
           ],
         },
+      ],
+      rowVersion: "1-12345",
+      passThrough: [
         {
           serviceId: "<id>",
           extendPaths: [
@@ -1040,6 +1342,7 @@ async function run() {
   const result = await apideck.accounting.customers.delete({
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
   });
 
   // Handle the result
@@ -1069,6 +1372,7 @@ async function run() {
   const res = await accountingCustomersDelete(apideck, {
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
   });
 
   if (!res.ok) {