@apideck/unify 0.13.6 → 0.14.0

package/docs/sdks/leads/README.md

@@ -28,9 +28,10 @@ const apideck = new Apideck({
 
 async function run() {
   const result = await apideck.crm.leads.list({
+    raw: false,
     serviceId: "salesforce",
+    limit: 20,
     filter: {
-      name: "Elon Musk",
       firstName: "Elon",
       lastName: "Musk",
       email: "elon@tesla.com",
@@ -73,9 +74,10 @@ const apideck = new ApideckCore({
 
 async function run() {
   const res = await crmLeadsList(apideck, {
+    raw: false,
     serviceId: "salesforce",
+    limit: 20,
     filter: {
-      name: "Elon Musk",
       firstName: "Elon",
       lastName: "Musk",
       email: "elon@tesla.com",
@@ -147,6 +149,7 @@ const apideck = new Apideck({
 
 async function run() {
   const result = await apideck.crm.leads.create({
+    raw: false,
     serviceId: "salesforce",
     lead: {
       name: "Elon Musk",
@@ -172,6 +175,11 @@ async function run() {
           url: "http://example.com",
           type: "primary",
         },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
       ],
       addresses: [
         {
@@ -248,14 +256,6 @@ async function run() {
           extension: "105",
           type: "primary",
         },
-        {
-          id: "12345",
-          countryCode: "1",
-          areaCode: "323",
-          number: "111-111-1111",
-          extension: "105",
-          type: "primary",
-        },
       ],
       emails: [
         {
@@ -263,23 +263,25 @@ async function run() {
           email: "elon@musk.com",
           type: "primary",
         },
+      ],
+      customFields: [
         {
-          id: "123",
-          email: "elon@musk.com",
-          type: "primary",
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: {},
         },
         {
-          id: "123",
-          email: "elon@musk.com",
-          type: "primary",
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: 10,
         },
-      ],
-      customFields: [
         {
           id: "2389328923893298",
           name: "employee_level",
           description: "Employee Level",
-          value: true,
+          value: "Uses Salesforce and Marketo",
         },
       ],
       tags: [
@@ -315,6 +317,56 @@ 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",
+                },
+              },
+            },
+          ],
+        },
+        {
+          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",
+                },
+              },
+            },
+          ],
+        },
       ],
     },
   });
@@ -344,6 +396,7 @@ const apideck = new ApideckCore({
 
 async function run() {
   const res = await crmLeadsCreate(apideck, {
+    raw: false,
     serviceId: "salesforce",
     lead: {
       name: "Elon Musk",
@@ -369,6 +422,11 @@ async function run() {
           url: "http://example.com",
           type: "primary",
         },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
       ],
       addresses: [
         {
@@ -445,14 +503,6 @@ async function run() {
           extension: "105",
           type: "primary",
         },
-        {
-          id: "12345",
-          countryCode: "1",
-          areaCode: "323",
-          number: "111-111-1111",
-          extension: "105",
-          type: "primary",
-        },
       ],
       emails: [
         {
@@ -460,23 +510,25 @@ async function run() {
           email: "elon@musk.com",
           type: "primary",
         },
+      ],
+      customFields: [
         {
-          id: "123",
-          email: "elon@musk.com",
-          type: "primary",
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: {},
         },
         {
-          id: "123",
-          email: "elon@musk.com",
-          type: "primary",
+          id: "2389328923893298",
+          name: "employee_level",
+          description: "Employee Level",
+          value: 10,
         },
-      ],
-      customFields: [
         {
           id: "2389328923893298",
           name: "employee_level",
           description: "Employee Level",
-          value: true,
+          value: "Uses Salesforce and Marketo",
         },
       ],
       tags: [
@@ -512,6 +564,56 @@ 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",
+                },
+              },
+            },
+          ],
+        },
+        {
+          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",
+                },
+              },
+            },
+          ],
+        },
       ],
     },
   });
@@ -572,6 +674,7 @@ async function run() {
   const result = await apideck.crm.leads.get({
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     fields: "id,updated_at",
   });
 
@@ -602,6 +705,7 @@ async function run() {
   const res = await crmLeadsGet(apideck, {
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     fields: "id,updated_at",
   });
 
@@ -661,6 +765,7 @@ async function run() {
   const result = await apideck.crm.leads.update({
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     lead: {
       name: "Elon Musk",
       companyName: "Spacex",
@@ -690,6 +795,11 @@ async function run() {
           url: "http://example.com",
           type: "primary",
         },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
       ],
       addresses: [
         {
@@ -718,13 +828,34 @@ async function run() {
           notes: "Address notes or delivery instructions.",
           rowVersion: "1-12345",
         },
-      ],
-      socialLinks: [
         {
-          id: "12345",
-          url: "https://www.twitter.com/apideck",
-          type: "twitter",
+          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: [
         {
           id: "12345",
           url: "https://www.twitter.com/apideck",
@@ -768,27 +899,25 @@ async function run() {
           email: "elon@musk.com",
           type: "primary",
         },
-      ],
-      customFields: [
         {
-          id: "2389328923893298",
-          name: "employee_level",
-          description: "Employee Level",
-          value: "Uses Salesforce and Marketo",
+          id: "123",
+          email: "elon@musk.com",
+          type: "primary",
         },
+      ],
+      customFields: [
         {
           id: "2389328923893298",
           name: "employee_level",
           description: "Employee Level",
-          value: 10,
+          value: {},
         },
         {
           id: "2389328923893298",
           name: "employee_level",
           description: "Employee Level",
           value: [
-            "<value>",
-            "<value>",
+            {},
           ],
         },
       ],
@@ -796,27 +925,6 @@ async function run() {
         "New",
       ],
       passThrough: [
-        {
-          serviceId: "<id>",
-          extendPaths: [
-            {
-              path: "$.nested.property",
-              value: {
-                "TaxClassificationRef": {
-                  "value": "EUC-99990201-V1-00020000",
-                },
-              },
-            },
-            {
-              path: "$.nested.property",
-              value: {
-                "TaxClassificationRef": {
-                  "value": "EUC-99990201-V1-00020000",
-                },
-              },
-            },
-          ],
-        },
         {
           serviceId: "<id>",
           extendPaths: [
@@ -861,6 +969,7 @@ async function run() {
   const res = await crmLeadsUpdate(apideck, {
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
     lead: {
       name: "Elon Musk",
       companyName: "Spacex",
@@ -890,6 +999,11 @@ async function run() {
           url: "http://example.com",
           type: "primary",
         },
+        {
+          id: "12345",
+          url: "http://example.com",
+          type: "primary",
+        },
       ],
       addresses: [
         {
@@ -918,13 +1032,34 @@ async function run() {
           notes: "Address notes or delivery instructions.",
           rowVersion: "1-12345",
         },
-      ],
-      socialLinks: [
         {
-          id: "12345",
-          url: "https://www.twitter.com/apideck",
-          type: "twitter",
+          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: [
         {
           id: "12345",
           url: "https://www.twitter.com/apideck",
@@ -968,27 +1103,25 @@ async function run() {
           email: "elon@musk.com",
           type: "primary",
         },
-      ],
-      customFields: [
         {
-          id: "2389328923893298",
-          name: "employee_level",
-          description: "Employee Level",
-          value: "Uses Salesforce and Marketo",
+          id: "123",
+          email: "elon@musk.com",
+          type: "primary",
         },
+      ],
+      customFields: [
         {
           id: "2389328923893298",
           name: "employee_level",
           description: "Employee Level",
-          value: 10,
+          value: {},
         },
         {
           id: "2389328923893298",
           name: "employee_level",
           description: "Employee Level",
           value: [
-            "<value>",
-            "<value>",
+            {},
           ],
         },
       ],
@@ -996,27 +1129,6 @@ async function run() {
         "New",
       ],
       passThrough: [
-        {
-          serviceId: "<id>",
-          extendPaths: [
-            {
-              path: "$.nested.property",
-              value: {
-                "TaxClassificationRef": {
-                  "value": "EUC-99990201-V1-00020000",
-                },
-              },
-            },
-            {
-              path: "$.nested.property",
-              value: {
-                "TaxClassificationRef": {
-                  "value": "EUC-99990201-V1-00020000",
-                },
-              },
-            },
-          ],
-        },
         {
           serviceId: "<id>",
           extendPaths: [
@@ -1090,6 +1202,7 @@ async function run() {
   const result = await apideck.crm.leads.delete({
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
   });
 
   // Handle the result
@@ -1119,6 +1232,7 @@ async function run() {
   const res = await crmLeadsDelete(apideck, {
     id: "<id>",
     serviceId: "salesforce",
+    raw: false,
   });
 
   if (!res.ok) {