build docs

OpenFn · Jan 10, 2025 · 10b146e · 10b146e
1 parent 0f471b8
commit 10b146e
Showing 1 changed file with 27 additions and 7 deletions.
diff --git a/packages/salesforce/ast.json b/packages/salesforce/ast.json
@@ -9,7 +9,7 @@
         "options"
       ],
       "docs": {
-        "description": "Create and execute a bulk job.\nThis function uses {@link https://sforce.co/4fDLJnk Bulk API},\nwhich is subject to {@link https://sforce.co/4b6kn6z rate limits}.",
+        "description": "Create and execute a bulk job. Nested relationships will be flattened to dot notation automatically.\nThis function uses {@link https://sforce.co/4fDLJnk Bulk API},\nwhich is subject to {@link https://sforce.co/4b6kn6z rate limits}.",
         "tags": [
           {
             "title": "public",
@@ -26,6 +26,11 @@
             "description": "bulk(\n  \"vera__Beneficiary__c\",\n  \"upsert\",\n  [\n    {\n      vera__Reporting_Period__c: 2023,\n      vera__Geographic_Area__c: \"Uganda\",\n      \"vera__Indicator__r.vera__ExtId__c\": 1001,\n      vera__Result_UID__c: \"1001_2023_Uganda\",\n    },\n  ],\n  { extIdField: \"vera__Result_UID__c\" }\n);",
             "caption": "Bulk upsert"
           },
+          {
+            "title": "example",
+            "description": "bulk(\n  \"vera__Beneficiary__c\",\n  \"upsert\",\n  [\n    {\n      vera__Reporting_Period__c: 2023,\n      \"vera_Project\": {\n        \"Metrics_ID__c\": \"jfh5LAnxu1i4na\"\n      }\n    },\n  ],\n  { extIdField: \"vera__Result_UID__c\" }\n);",
+            "caption": "Bulk upsert with a nested relationship"
+          },
           {
             "title": "example",
             "description": "fn((state) => {\n  state.accounts = state.data.map((a) => ({ Id: a.id, Name: a.name }));\n  return state;\n});\nbulk(\"Account\", \"update\", $.accounts, { failOnError: true });",
@@ -158,7 +163,7 @@
         "records"
       ],
       "docs": {
-        "description": "Create one or more new sObject records.",
+        "description": "Create one or more new sObject records. Relationships in the record should be nested and not use dot-notation syntax",
         "tags": [
           {
             "title": "public",
@@ -180,6 +185,11 @@
             "description": "create(\"Account\",\n  $.data.map((account) => ({\n    Name: account.label\n  })\n));",
             "caption": "Create records from data on state"
           },
+          {
+            "title": "example",
+            "description": "create(\"Account\", {\n  Name: \"My Account #1\" ,\n  \"Project__r\": {\n    \"Metrics_ID__c\": \"jfh5LAnxu1i4na\"\n  }\n});",
+            "caption": "Update a record with a relationship"
+          },
           {
             "title": "function",
             "description": null,
@@ -704,7 +714,7 @@
         "records"
       ],
       "docs": {
-        "description": "Create a new sObject record, or updates it if it already exists.",
+        "description": "Create a new sObject record, or updates it if it already exists. Relationships in the record should be nested and not use dot-notation syntax",
         "tags": [
           {
             "title": "public",
@@ -721,6 +731,11 @@
             "description": "upsert(\"UpsertTable__c\", \"ExtId__c\", [\n  { Name: \"Record #1\", ExtId__c : 'ID-0000001' },\n  { Name: \"Record #2\", ExtId__c : 'ID-0000002' },\n]);",
             "caption": "Multiple record upsert"
           },
+          {
+            "title": "example",
+            "description": "upsert(\"UpsertTable__c\", {\n  Name: \"Record #1\",\n  \"Project__r\": {\n    \"Metrics_ID__c\": \"jfh5LAnxu1i4na\"\n  }\n});",
+            "caption": "Update a record with a relationship"
+          },
           {
             "title": "function",
             "description": null,
@@ -806,13 +821,18 @@
         "records"
       ],
       "docs": {
-        "description": "Update an sObject record or records.",
+        "description": "Update an sObject record or records. Relationships in the record should be nested and not use dot-notation syntax",
         "tags": [
           {
             "title": "public",
             "description": null,
             "type": null
           },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
           {
             "title": "example",
             "description": "update(\"Account\", {\n  Id: \"0010500000fxbcuAAA\",\n  Name: \"Updated Account #1\",\n});",
@@ -824,9 +844,9 @@
             "caption": "Multiple records update"
           },
           {
-            "title": "function",
-            "description": null,
-            "name": null
+            "title": "example",
+            "description": "update(\"Account\", {\n  Id: \"0010500000fxbcuAAA\",\n  \"Project__r\": {\n    \"Metrics_ID__c\": \"jfh5LAnxu1i4na\"\n  }\n});",
+            "caption": "Update a record with a relationship"
           },
           {
             "title": "param",