@apideck/unify 0.13.7 → 0.14.0

package/docs/sdks/contacts/README.md

@@ -28,13 +28,13 @@ const apideck = new Apideck({
 
 async function run() {
   const result = await apideck.crm.contacts.list({
+    raw: false,
     serviceId: "salesforce",
+    limit: 20,
     filter: {
-      name: "Elon Musk",
       firstName: "Elon",
       lastName: "Musk",
       email: "elon@tesla.com",
-      phoneNumber: "111-111-1111",
       companyId: "12345",
       ownerId: "12345",
     },
@@ -75,13 +75,13 @@ const apideck = new ApideckCore({
 
 async function run() {
   const res = await crmContactsList(apideck, {
+    raw: false,
     serviceId: "salesforce",
+    limit: 20,
     filter: {
-      name: "Elon Musk",
       firstName: "Elon",
       lastName: "Musk",
       email: "elon@tesla.com",
-      phoneNumber: "111-111-1111",
       companyId: "12345",
       ownerId: "12345",
     },
@@ -151,6 +151,7 @@ const apideck = new Apideck({
 
 async function run() {
   const result = await apideck.crm.contacts.create({
+    raw: false,
     serviceId: "salesforce",
     contact: {
       name: "Elon Musk",
@@ -187,11 +188,6 @@ async function run() {
           url: "http://example.com",
           type: "primary",
         },
-        {
-          id: "12345",
-          url: "http://example.com",
-          type: "primary",
-        },
       ],
       addresses: [
         {
@@ -246,32 +242,6 @@ 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",
-        },
       ],
       socialLinks: [
         {
@@ -279,16 +249,49 @@ async function run() {
           url: "https://www.twitter.com/apideck",
           type: "twitter",
         },
+        {
+          id: "12345",
+          url: "https://www.twitter.com/apideck",
+          type: "twitter",
+        },
       ],
       phoneNumbers: [
-
+        {
+          id: "12345",
+          countryCode: "1",
+          areaCode: "323",
+          number: "111-111-1111",
+          extension: "105",
+          type: "primary",
+        },
       ],
       emails: [
-
+        {
+          id: "123",
+          email: "elon@musk.com",
+          type: "primary",
+        },
       ],
       emailDomain: "gmail.com",
       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",
+        },
       ],
       tags: [
         "New",
@@ -300,13 +303,51 @@ async function run() {
         {
           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",
+                },
+              },
+            },
           ],
         },
         {
@@ -328,6 +369,14 @@ async function run() {
                 },
               },
             },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
           ],
         },
       ],
@@ -359,6 +408,7 @@ const apideck = new ApideckCore({
 
 async function run() {
   const res = await crmContactsCreate(apideck, {
+    raw: false,
     serviceId: "salesforce",
     contact: {
       name: "Elon Musk",
@@ -395,11 +445,6 @@ async function run() {
           url: "http://example.com",
           type: "primary",
         },
-        {
-          id: "12345",
-          url: "http://example.com",
-          type: "primary",
-        },
       ],
       addresses: [
         {
@@ -454,32 +499,6 @@ 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",
-        },
       ],
       socialLinks: [
         {
@@ -487,16 +506,49 @@ async function run() {
           url: "https://www.twitter.com/apideck",
           type: "twitter",
         },
+        {
+          id: "12345",
+          url: "https://www.twitter.com/apideck",
+          type: "twitter",
+        },
       ],
       phoneNumbers: [
-  
+        {
+          id: "12345",
+          countryCode: "1",
+          areaCode: "323",
+          number: "111-111-1111",
+          extension: "105",
+          type: "primary",
+        },
       ],
       emails: [
-  
+        {
+          id: "123",
+          email: "elon@musk.com",
+          type: "primary",
+        },
       ],
       emailDomain: "gmail.com",
       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",
+        },
       ],
       tags: [
         "New",
@@ -508,13 +560,51 @@ async function run() {
         {
           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",
+                },
+              },
+            },
           ],
         },
         {
@@ -536,6 +626,14 @@ async function run() {
                 },
               },
             },
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
           ],
         },
       ],
@@ -598,13 +696,12 @@ async function run() {
   const result = await apideck.crm.contacts.get({
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     fields: "id,updated_at",
     filter: {
-      name: "Elon Musk",
       firstName: "Elon",
       lastName: "Musk",
       email: "elon@tesla.com",
-      phoneNumber: "111-111-1111",
       companyId: "12345",
       ownerId: "12345",
     },
@@ -637,13 +734,12 @@ async function run() {
   const res = await crmContactsGet(apideck, {
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     fields: "id,updated_at",
     filter: {
-      name: "Elon Musk",
       firstName: "Elon",
       lastName: "Musk",
       email: "elon@tesla.com",
-      phoneNumber: "111-111-1111",
       companyId: "12345",
       ownerId: "12345",
     },
@@ -705,6 +801,7 @@ async function run() {
   const result = await apideck.crm.contacts.update({
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     contact: {
       name: "Elon Musk",
       ownerId: "54321",
@@ -730,7 +827,21 @@ async function run() {
       status: "open",
       active: true,
       websites: [
-
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
       ],
       addresses: [
         {
@@ -759,6 +870,32 @@ 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",
+        },
       ],
       socialLinks: [
         {
@@ -766,6 +903,11 @@ async function run() {
           url: "https://www.twitter.com/apideck",
           type: "twitter",
         },
+        {
+          id: "12345",
+          url: "https://www.twitter.com/apideck",
+          type: "twitter",
+        },
       ],
       phoneNumbers: [
         {
@@ -776,13 +918,24 @@ async function run() {
           extension: "105",
           type: "primary",
         },
-      ],
-      emails: [
         {
-          id: "123",
-          email: "elon@musk.com",
+          id: "12345",
+          countryCode: "1",
+          areaCode: "323",
+          number: "111-111-1111",
+          extension: "105",
+          type: "primary",
+        },
+        {
+          id: "12345",
+          countryCode: "1",
+          areaCode: "323",
+          number: "111-111-1111",
+          extension: "105",
           type: "primary",
         },
+      ],
+      emails: [
         {
           id: "123",
           email: "elon@musk.com",
@@ -796,7 +949,20 @@ async function run() {
       ],
       emailDomain: "gmail.com",
       customFields: [
-
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: {},
+        },
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: [
+            {},
+          ],
+        },
       ],
       tags: [
         "New",
@@ -805,7 +971,19 @@ async function run() {
         "12345",
       ],
       passThrough: [
-
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
       ],
     },
   });
@@ -837,6 +1015,7 @@ async function run() {
   const res = await crmContactsUpdate(apideck, {
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     contact: {
       name: "Elon Musk",
       ownerId: "54321",
@@ -862,7 +1041,21 @@ async function run() {
       status: "open",
       active: true,
       websites: [
-  
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
       ],
       addresses: [
         {
@@ -891,6 +1084,32 @@ 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",
+        },
       ],
       socialLinks: [
         {
@@ -898,6 +1117,11 @@ async function run() {
           url: "https://www.twitter.com/apideck",
           type: "twitter",
         },
+        {
+          id: "12345",
+          url: "https://www.twitter.com/apideck",
+          type: "twitter",
+        },
       ],
       phoneNumbers: [
         {
@@ -908,13 +1132,24 @@ async function run() {
           extension: "105",
           type: "primary",
         },
-      ],
-      emails: [
         {
-          id: "123",
-          email: "elon@musk.com",
+          id: "12345",
+          countryCode: "1",
+          areaCode: "323",
+          number: "111-111-1111",
+          extension: "105",
+          type: "primary",
+        },
+        {
+          id: "12345",
+          countryCode: "1",
+          areaCode: "323",
+          number: "111-111-1111",
+          extension: "105",
           type: "primary",
         },
+      ],
+      emails: [
         {
           id: "123",
           email: "elon@musk.com",
@@ -928,7 +1163,20 @@ async function run() {
       ],
       emailDomain: "gmail.com",
       customFields: [
-  
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: {},
+        },
+        {
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: [
+            {},
+          ],
+        },
       ],
       tags: [
         "New",
@@ -937,7 +1185,19 @@ async function run() {
         "12345",
       ],
       passThrough: [
-  
+        {
+          serviceId: "<id>",
+          extendPaths: [
+            {
+              path: "$.nested.property",
+              value: {
+                "TaxClassificationRef": {
+                  "value": "EUC-99990201-V1-00020000",
+                },
+              },
+            },
+          ],
+        },
       ],
     },
   });
@@ -998,6 +1258,7 @@ async function run() {
   const result = await apideck.crm.contacts.delete({
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
   });
 
   // Handle the result
@@ -1027,6 +1288,7 @@ async function run() {
   const res = await crmContactsDelete(apideck, {
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
   });
 
   if (!res.ok) {