@pipedream/salesforce_rest_api 1.2.0 → 1.3.0

package/actions/find-records/find-records.mjs

@@ -1,52 +1,67 @@
-import salesForceRestApi from "../../salesforce_rest_api.app.mjs";
+import salesforce from "../../salesforce_rest_api.app.mjs";
 
 export default {
   key: "salesforce_rest_api-find-records",
-  name: "Get Object Records",
+  name: "Find Records",
   description:
-    "Retrieves all records in an object or a record in an object by the given ID or criteria. [API Doc](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_get_field_values.htm)",
-  version: "0.1.5",
+    "Retrieves selected fields for some or all records of a selected object. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_get_field_values.htm)",
+  version: "0.2.0",
   type: "action",
   props: {
-    salesForceRestApi,
+    salesforce,
     sobjectType: {
       propDefinition: [
-        salesForceRestApi,
+        salesforce,
         "objectType",
       ],
+      description: "The type of object to obtain records of.",
     },
-    ids: {
+    fieldsToObtain: {
       propDefinition: [
-        salesForceRestApi,
-        "sobjectId",
+        salesforce,
+        "fieldsToObtain",
         (c) => ({
-          objectType: c.sobjectType,
+          objType: c.sobjectType,
         }),
       ],
-      type: "string[]",
     },
-    fields: {
+    recordIds: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        (c) => ({
+          objType: c.sobjectType,
+        }),
+      ],
+      label: "Record ID(s)",
       type: "string[]",
-      label: "Fields to get values from",
+      optional: true,
       description:
-        "list of the Salesforce standard object's fields to get values from.",
+        "The record(s) to retrieve. If not specified, all records will be retrieved.",
     },
   },
   async run({ $ }) {
-    const {
+    let {
       sobjectType,
-      fields,
-      ids,
+      recordIds,
+      fieldsToObtain,
     } = this;
-    const response = await this.salesForceRestApi.getRecords(
-      sobjectType, {
-        fields: Array.isArray(fields) && fields.join(",") || fields,
-        ids: Array.isArray(ids) && ids.join(",") || ids,
-      },
-    );
-    if (response) {
-      $.export("$summary", "Record found successfully");
+
+    if (typeof recordIds === "string") recordIds = recordIds.split(",");
+    if (typeof fieldsToObtain === "string") fieldsToObtain = fieldsToObtain.split(",");
+
+    let query = `SELECT ${fieldsToObtain.join(", ")} FROM ${sobjectType}`;
+
+    if (recordIds?.length) {
+      query += ` WHERE Id IN ('${recordIds.join("','")}')`;
     }
-    return response;
+
+    const { records } = await this.salesforce.query({
+      $,
+      query,
+    });
+
+    $.export("$summary", `Sucessfully retrieved ${records.length} records`);
+    return records;
   },
 };

package/actions/insert-blob-data/insert-blob-data.mjs

@@ -1,14 +1,10 @@
 import salesforce from "../../salesforce_rest_api.app.mjs";
-import { toSingleLineString } from "../../common/utils.mjs";
 
 export default {
   key: "salesforce_rest_api-insert-blob-data",
   name: "Insert Blob Data",
-  description: toSingleLineString(`
-    Inserts blob data in Salesforce standard objects.
-    See [docs](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_sobject_insert_update_blob.htm)
-  `),
-  version: "0.2.7",
+  description: "Inserts blob data in Salesforce standard objects. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_sobject_insert_update_blob.htm)",
+  version: "0.2.8",
   type: "action",
   props: {
     salesforce,
@@ -71,7 +67,7 @@ export default {
       headers,
       data,
     });
-    $.export("$summary", `Inserted Blob data to ${this.sobjectName}`);
+    $.export("$summary", `Successfully inserted blob data in ${this.sobjectName}`);
     return response;
   },
 };

package/actions/post-feed-to-chatter/post-feed-to-chatter.mjs

@@ -1,39 +1,64 @@
-import salesForceRestApi from "../../salesforce_rest_api.app.mjs";
-import { toSingleLineString } from "../../common/utils.mjs";
+import salesforce from "../../salesforce_rest_api.app.mjs";
 
 export default {
   key: "salesforce_rest_api-post-feed-to-chatter",
   name: "Post a Message to Chatter Feed",
-  description: toSingleLineString(`
-    Posts a message to the Chatter Feed.
-    [See doc](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/quickreference_post_feed_item.htm)
-  `),
-  version: "0.0.6",
+  description:
+    "Post a feed item in Chatter. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/quickreference_post_feed_item.htm)",
+  version: "0.1.0",
   type: "action",
   props: {
-    salesForceRestApi,
-    text: {
-      label: "Text body",
-      description: "Text body.",
-      type: "string",
+    salesforce,
+    sobjectType: {
+      propDefinition: [
+        salesforce,
+        "objectType",
+      ],
+      description: "The type of object to select a record from.",
     },
     subjectId: {
-      label: "Subject ID",
-      description: "Specify the user, group, or record that will parent the feed item.",
-      type: "string",
+      propDefinition: [
+        salesforce,
+        "recordId",
+        (c) => ({
+          objType: c.sobjectType,
+        }),
+      ],
+      description: "The record that will parent the feed item.",
+    },
+    messageSegments: {
+      label: "Message segments",
+      description:
+        "Each message segment can be a text string, which will be treated as a segment of `type: Text`, or a [message segment object](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_requests_message_body_input.htm) such as `{ \"type\": \"Mention\", \"username\": \"john\" }`",
+      type: "string[]",
     },
   },
   async run({ $ }) {
-    const params = {
-      text: this.text,
+    const data = {
       subjectId: this.subjectId,
       feedElementType: "FeedItem",
+      body: {
+        messageSegments: this.messageSegments.map((segment) => {
+          if (typeof segment === "string") {
+            try {
+              return JSON.parse(segment);
+            } catch (err) {
+              return {
+                type: "Text",
+                text: segment,
+              };
+            }
+          }
+
+          return segment;
+        }),
+      },
     };
-    const response = await this.salesForceRestApi.postFeed({
+    const response = await this.salesforce.postFeed({
       $,
-      params,
+      data,
     });
-    response && $.export("$summary", "Successfully added message to chatter feed");
+    response && $.export("$summary", "Successfully posted feed item");
     return response;
   },
 };

package/actions/search-string/search-string.mjs

@@ -1,19 +1,25 @@
-import salesForceRestApi from "../../salesforce_rest_api.app.mjs";
+import salesforce from "../../salesforce_rest_api.app.mjs";
 
 export default {
   key: "salesforce_rest_api-search-string",
   name: "Search Object Records",
   description:
-    "Searches for records in an object using a parameterized search. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_parameterized.htm)",
-  version: "0.0.1",
+    "Searches for records in an object using a parameterized search. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_parameterized_get.htm)",
+  version: "0.0.2",
   type: "action",
   props: {
-    salesForceRestApi,
+    salesforce,
+    infoBox: {
+      type: "alert",
+      alertType: "info",
+      content: "If you need a more flexible search, consider using the **SOQL Search** or **SOSL Search** actions instead.",
+    },
     sobjectType: {
       propDefinition: [
-        salesForceRestApi,
+        salesforce,
         "objectType",
       ],
+      description: "The type of object to search for records.",
     },
     searchTerm: {
       type: "string",
@@ -22,9 +28,9 @@ export default {
     },
     fields: {
       type: "string[]",
-      label: "Fields to get values from",
+      label: "Fields",
       description:
-        "List of the Salesforce object's fields to get values from.",
+        "List of the Salesforce object's fields to get values from, such as `Id` or `Name`.",
     },
   },
   async run({ $ }) {
@@ -33,21 +39,17 @@ export default {
       searchTerm,
       fields,
     } = this;
-    try {
-      const response = await this.salesForceRestApi.parameterizedSearch({
+
+    const response = await this.salesforce.parameterizedSearch({
+      $,
+      params: {
         q: searchTerm,
         sobject: sobjectType,
         fields: fields.join(","),
-      });
-      const resultsFound = response.searchRecords.length;
-      $.export("$summary", "Search completed successfully");
-      $.export("results_found", resultsFound);
-      return response;
-    } catch (error) {
-      console.error(error);
-      $.export("$summary", "Search failed");
-      $.export("results_found", 0);
-      throw new Error(`Search failed: ${error.message}`);
-    }
+      },
+    });
+    const resultsFound = response.searchRecords.length;
+    $.export("$summary", `Sucessfully found ${resultsFound} results`);
+    return response;
   },
 };

package/actions/soql-search/soql-search.mjs

@@ -1,21 +1,26 @@
-import { toSingleLineString } from "../../common/utils.mjs";
 import salesforce from "../../salesforce_rest_api.app.mjs";
+import { docsInfo } from "../sosl-search/sosl-search.mjs";
+
+const docsLink = "https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_select_examples.htm";
 
 export default {
   key: "salesforce_rest_api-soql-search",
-  name: "SOQL Search",
-  description: toSingleLineString(`
-    Executes a SOQL query.
-    See [docs](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm)
-  `),
-  version: "0.2.8",
+  name: "SOQL Query (Object Query)",
+  description: `Executes a [Salesforce Object Query Language (SOQL)](${docsLink}) query-based, SQL-like search.`,
+  version: "0.2.9",
   type: "action",
   props: {
     salesforce,
+    docsInfo,
+    exampleInfo: {
+      type: "alert",
+      alertType: "info",
+      content: "Example query: `SELECT Id, Name, BillingCity FROM Account`",
+    },
     query: {
       type: "string",
       label: "SOQL Query",
-      description: "A SOQL search query",
+      description: `A SOQL search query. [See the documentation](${docsLink}) for examples and more information.`,
     },
   },
   async run({ $ }) {

package/actions/sosl-search/sosl-search.mjs

@@ -1,21 +1,31 @@
 import salesforce from "../../salesforce_rest_api.app.mjs";
-import { toSingleLineString } from "../../common/utils.mjs";
+
+const docsLink = "https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_sosl_examples.htm";
+
+export const docsInfo = {
+  type: "alert",
+  alertType: "info",
+  content: "You can find helpful information on SOQL and SOSL in [the Salesforce documentation](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql_sosl_intro.htm).",
+};
 
 export default {
   key: "salesforce_rest_api-sosl-search",
-  name: "SOSL Search",
-  description: toSingleLineString(`
-    Executes the specified SOSL search.
-    See [docs](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_sosl.htm)
-  `),
-  version: "0.2.7",
+  name: "SOSL Search (Object Search)",
+  description: `Executes a [Salesforce Object Search Language (SOSL)](${docsLink}) text-based search query.`,
+  version: "0.2.8",
   type: "action",
   props: {
     salesforce,
+    docsInfo,
+    exampleInfo: {
+      type: "alert",
+      alertType: "info",
+      content: "Example search: `FIND {Joe Smith} IN Name Fields RETURNING lead(name, phone)`",
+    },
     search: {
       type: "string",
       label: "SOSL Query",
-      description: "A SOSL search query",
+      description: `A SOSL search query. [See the documentation](${docsLink}) for examples and more information.`,
     },
   },
   async run({ $ }) {
@@ -23,7 +33,7 @@ export default {
       $,
       search: this.search,
     });
-    $.export("$summary", "Successfully returned ${response.length} results for SOSL search");
+    $.export("$summary", `Successfully returned ${response.searchRecords?.length} results for SOSL search`);
     return response;
   },
 };

package/actions/update-account/update-account.mjs

@@ -1,62 +1,75 @@
-import common from "../common/base.mjs";
+import common, { getProps } from "../common/base-create-update.mjs";
 import account from "../../common/sobjects/account.mjs";
-import {
-  pickBy, pick,
-} from "lodash-es";
-import { toSingleLineString } from "../../common/utils.mjs";
+import { docsLink } from "../create-account/create-account.mjs";
 
-const { salesforce } = common.props;
+const {
+  salesforce, ...props
+} = getProps({
+  createOrUpdate: "update",
+  objType: account,
+  docsLink,
+});
 
 export default {
   ...common,
   key: "salesforce_rest_api-update-account",
   name: "Update Account",
-  description: toSingleLineString(`
-    Updates a Salesforce account, representing an individual account,
-    which is an organization or person involved with your business (such as customers, competitors, and partners).
-    See [Account SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_account.htm)
-    and [Update Record](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_update_fields.htm)
-  `),
-  version: "0.2.7",
+  description: `Updates a Salesforce account. [See the documentation](${docsLink})`,
+  version: "0.3.0",
   type: "action",
-  props: {
-    salesforce,
-    AccountId: {
-      type: "string",
-      label: "Account ID",
-      description: "ID of the Account to modify.",
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "Account";
     },
-    Name: {
-      type: "string",
-      label: "Name",
-      description: "Name of the account. Maximum size is 255 characters. If the account has a record type of Person Account:\nThis value is the concatenation of the FirstName, MiddleName, LastName, and Suffix of the associated person contact.",
-      optional: true,
+    getAdvancedProps() {
+      return account.extraProps;
     },
-    selector: {
+  },
+  props: {
+    salesforce,
+    accountId: {
       propDefinition: [
         salesforce,
-        "fieldSelector",
+        "recordId",
+        () => ({
+          objType: "Account",
+          nameField: "Name",
+        }),
       ],
-      description: `${salesforce.propDefinitions.fieldSelector.description} Account`,
-      options: () => Object.keys(account),
-      reloadProps: true,
+      label: "Account ID",
+      description: "The Account to update.",
     },
-  },
-  additionalProps() {
-    return this.additionalProps(this.selector, account);
+    ...props,
   },
   async run({ $ }) {
-    const data = pickBy(pick(this, [
-      "AccountId",
-      "Name",
-      ...this.selector,
-    ]));
-    const response = await this.salesforce.updateAccount({
+    /* eslint-disable no-unused-vars */
+    const {
+      salesforce,
+      getAdvancedProps,
+      getObjectType,
+      getAdditionalFields,
+      formatDateTimeProps,
+      accountId,
+      useAdvancedProps,
+      docsInfo,
+      dateInfo,
+      additionalFields,
+      ...data
+    } = this;
+    /* eslint-enable no-unused-vars */
+    const response = await salesforce.updateRecord("Account", {
       $,
-      id: this.AccountId,
-      data,
+      id: accountId,
+      data: {
+        ...data,
+        ...getAdditionalFields(),
+      },
     });
-    $.export("$summary", `Successfully updated account ${this.AccountId}`);
+    $.export(
+      "$summary",
+      `Successfully updated account (ID: ${this.accountId})`,
+    );
     return response;
   },
 };

package/actions/update-contact/update-contact.mjs

@@ -1,61 +1,80 @@
-import common from "../common/base.mjs";
+import common, { getProps } from "../common/base-create-update.mjs";
 import contact from "../../common/sobjects/contact.mjs";
-import {
-  pickBy, pick,
-} from "lodash-es";
-import { toSingleLineString } from "../../common/utils.mjs";
+import { docsLink } from "../create-contact/create-contact.mjs";
 
-const { salesforce } = common.props;
+const {
+  salesforce, ...props
+} = getProps({
+  createOrUpdate: "update",
+  objType: contact,
+  docsLink,
+  showDateInfo: true,
+});
 
 export default {
   ...common,
   key: "salesforce_rest_api-update-contact",
   name: "Update Contact",
-  description: toSingleLineString(`
-    Updates a Contact, which is a person associated with an account.
-    See [Contact SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_contact.htm)
-    and [Update Record](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_update_fields.htm)
-  `),
-  version: "0.2.7",
+  description: `Updates a contact. [See the documentation](${docsLink})`,
+  version: "0.3.0",
   type: "action",
-  props: {
-    salesforce,
-    ContactId: {
-      type: "string",
-      label: "Contact ID",
-      description: "ID of the Contact to update.",
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "Contact";
     },
-    LastName: {
-      type: "string",
-      label: "Last Name",
-      description: "Last name of the contact up to 80 characters.",
-      optional: true,
+    getAdvancedProps() {
+      return contact.extraProps;
     },
-    selector: {
+  },
+  props: {
+    salesforce,
+    contactId: {
       propDefinition: [
         salesforce,
-        "fieldSelector",
+        "recordId",
+        () => ({
+          objType: "Contact",
+          nameField: "Name",
+        }),
       ],
-      description: `${salesforce.propDefinitions.fieldSelector.description} Contact`,
-      options: () => Object.keys(contact),
-      reloadProps: true,
+      label: "Contact ID",
+      description: "The Contact to update.",
     },
-  },
-  additionalProps() {
-    return this.additionalProps(this.selector, contact);
+    ...props,
   },
   async run({ $ }) {
-    const data = pickBy(pick(this, [
-      "ContactId",
-      "LastName",
-      ...this.selector,
-    ]));
-    const response = await this.salesforce.updateContact({
+    /* eslint-disable no-unused-vars */
+    const {
+      salesforce,
+      getAdvancedProps,
+      getObjectType,
+      getAdditionalFields,
+      formatDateTimeProps,
+      contactId,
+      useAdvancedProps,
+      docsInfo,
+      dateInfo,
+      additionalFields,
+      Birthdate,
+      ...data
+    } = this;
+    /* eslint-enable no-unused-vars */
+    const response = await salesforce.updateRecord("Contact", {
       $,
-      id: this.ContactId,
-      data,
+      id: contactId,
+      data: {
+        ...data,
+        ...formatDateTimeProps({
+          Birthdate,
+        }),
+        ...getAdditionalFields(),
+      },
     });
-    $.export("$summary", `Successfully updated contact for ${this.ContactId}`);
+    $.export(
+      "$summary",
+      `Successfully updated contact (ID: ${this.contactId})`,
+    );
     return response;
   },
 };