@pipedream/salesforce_rest_api 0.3.3 → 0.4.0

package/actions/delete-opportunity/delete-opportunity.mjs

@@ -0,0 +1,30 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-delete-opportunity",
+  name: "Delete Opportunity",
+  description: toSingleLineString(`
+    Deletes an opportunity.
+    See [Opportunity SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm)
+    and [Delete Record](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_delete_record.htm)
+  `),
+  version: "0.2.2",
+  type: "action",
+  props: {
+    salesforce,
+    OpportunityId: {
+      type: "string",
+      label: "Opportunity ID",
+      description: "ID of the Opportunity to delete",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.salesforce.deleteOpportunity({
+      $,
+      id: this.OpportunityId,
+    });
+    $.export("$summary", "Successfully deleted opportunity");
+    return response;
+  },
+};

package/actions/delete-record/delete-record.mjs

@@ -0,0 +1,37 @@
+import salesForceRestApi from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-delete-record",
+  name: "Delete a Record in an Object",
+  description:
+    "Deletes an existing record in an object. [API Doc](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_query.htm)",
+  version: "0.1.0",
+  type: "action",
+  props: {
+    salesForceRestApi,
+    sobjectType: {
+      type: "string",
+      label: "Object type",
+      description:
+        "Salesforce standard object type of the record to get field values from. [Object types](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_list.htm)",
+    },
+    sobjectId: {
+      type: "string",
+      label: "Object id",
+      description:
+        "ID of the Salesforce standard object to get field values from.",
+    },
+  },
+  async run({ $ }) {
+    const {
+      sobjectType,
+      sobjectId,
+    } = this;
+    const response = await this.salesForceRestApi.deleteObject(
+      sobjectType,
+      sobjectId,
+    );
+    response && $.export("$summary", `Successfully deleted record with ID ${sobjectId}`);
+    return response;
+  },
+};

package/actions/find-create-record/find-create-record.mjs

@@ -0,0 +1,84 @@
+import { ConfigurationError } from "@pipedream/platform";
+import salesForceRestApi from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-find-create-record",
+  name: "Get Field Values from Object Record and optionally create one is none is found. ",
+  description:
+    "Finds a specified Salesforce record by a field. Optionally, create one if none is found. [API Docs](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_get_field_values.htm)",
+  version: "0.1.0",
+  type: "action",
+  props: {
+    salesForceRestApi,
+    sobjectType: {
+      type: "string",
+      label: "Object type",
+      description:
+        "Salesforce standard object type of the record to get field values from. [Object types](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_list.htm)",
+    },
+    sobjectId: {
+      type: "string",
+      label: "Object ID",
+      description:
+        "ID of the Salesforce standard object to get field values from.",
+    },
+    sobjectFields: {
+      type: "string[]",
+      label: "Fields to get values from",
+      description:
+        "list of the Salesforce standard object's fields to get values from.",
+    },
+    createIfNotFound: {
+      type: "boolean",
+      label: "Create new object",
+      description: "Create a new object if none is found",
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return {
+      sobject: {
+        type: "object",
+        label: "Salesforce standard object",
+        description: `Data of the Salesforce standard object record to create.
+          Salesforce standard objects are described in [Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_list.htm) section of the [SOAP API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_quickstart_intro.htm).`,
+      },
+    };
+  },
+  async run({ $ }) {
+    const {
+      sobjectType,
+      sobjectId,
+      sobjectFields,
+      sobject,
+      createIfNotFound,
+    } = this;
+    let data;
+    try {
+      data = await this.salesForceRestApi.getSObject(
+        sobjectType,
+        sobjectId,
+        sobjectFields && {
+          fields: sobjectFields.join(","),
+        },
+      );
+    } catch (error) {
+      if (!createIfNotFound) throw new ConfigurationError("Record not found");
+    }
+
+    if (createIfNotFound && !data) {
+      const response = await this.salesForceRestApi.createObject(
+        sobjectType,
+        sobject,
+      );
+      response && $.export(
+        "$summary", "Record successfully created",
+      );
+      return response;
+    }
+    if (data) {
+      $.export("$summary", "Record found!");
+    }
+    return data;
+  },
+};

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

@@ -0,0 +1,48 @@
+import salesForceRestApi from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-find-records",
+  name: "Get Object 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.0",
+  type: "action",
+  props: {
+    salesForceRestApi,
+    sobjectType: {
+      type: "string",
+      label: "Object type",
+      description:
+       "Salesforce standard object type of the record to get field values from. [Object types](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_list.htm)",
+    },
+    ids: {
+      type: "string[]",
+      label: "Record IDs to be returned",
+      description:
+        "Record IDs to be returned",
+    },
+    fields: {
+      type: "string[]",
+      label: "Fields to get values from",
+      description:
+        "list of the Salesforce standard object's fields to get values from.",
+    },
+  },
+  async run({ $ }) {
+    const {
+      sobjectType,
+      fields,
+      ids,
+    } = this;
+    const response =  await this.salesForceRestApi.getRecords(
+      sobjectType, {
+        fields: fields.join(","),
+        ids: ids.join(","),
+      },
+    );
+    if (response) {
+      $.export("$summary", "Record found successfully" );
+    }
+    return response;
+  },
+};

package/actions/get-sobject-fields-values/get-sobject-fields-values.mjs

@@ -0,0 +1,57 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-get-sobject-fields-values",
+  name: "Get Field Values from a Standard Object Record",
+  description: toSingleLineString(`
+    Retrieve field values from a record. You can specify the fields you want to retrieve.
+    See [docs](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_get_field_values.htm)
+  `),
+  version: "0.2.2",
+  type: "action",
+  props: {
+    salesforce,
+    objectType: {
+      propDefinition: [
+        salesforce,
+        "objectType",
+      ],
+    },
+    sobjectId: {
+      propDefinition: [
+        salesforce,
+        "sobjectId",
+        (c) => ({
+          objectType: c.objectType,
+        }),
+      ],
+    },
+    fields: {
+      type: "string[]",
+      label: "SObject Fields",
+      description: "List of fields of the Standard object to get values from",
+      propDefinition: [
+        salesforce,
+        "field",
+        (c) => ({
+          objectType: c.objectType,
+        }),
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const params = {};
+    if (this.fields?.length > 0) {
+      params.fields = this.fields.join(",");
+    }
+    const response = await this.salesforce.getRecordFieldValues(this.objectType, {
+      $,
+      id: this.sobjectId,
+      params,
+    });
+    $.export("$summary", `Retrieved ${this.objectType} field values`);
+    return response;
+  },
+};

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

@@ -0,0 +1,77 @@
+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.2",
+  type: "action",
+  props: {
+    salesforce,
+    entiyName: {
+      type: "string",
+      label: "Entity Name",
+      description: "Name of the entity to insert as part of the form-data sent along the Salesforce API as a request with multipart/form-data content type. I.e. entityDocument for Documents.",
+    },
+    entityDocument: {
+      type: "string",
+      label: "Entity Document",
+      description: "Salesforce object entity to insert.",
+    },
+    formContentName: {
+      type: "string",
+      label: "Form Content Name",
+      description: "Name of the binary content to insert as part of  the form-data sent along the Salesforce API as a request with multipart/form-data content type.",
+    },
+    filename: {
+      type: "string",
+      label: "Filename",
+      description: "Filename of the blob data to insert.",
+    },
+    contentType: {
+      type: "string",
+      label: "Content Type",
+      description: "Mime type of the content to insert.",
+    },
+    attachmentBinarycontent: {
+      type: "string",
+      label: "Attachment Binary Content",
+      description: "Binary content of the blob data to insert.",
+    },
+    sobjectName: {
+      type: "string",
+      label: "SObject Type",
+      description: "Salesforce standard object type to insert.",
+    },
+  },
+  async run({ $ }) {
+    const payloadPart1 = `----------------------------932677621329676389151855
+    \r\nContent-Disposition: form-data; name="${this.entiyName}""
+    \r\nContent-Type: application/json
+    \r\n\r\n${this.entityDocument}\r\n\r\n
+    \r\n\r\n----------------------------932677621329676389151855
+    \r\nContent-Disposition: form-data; name="${this.formContentName}"; filename="${this.filename}"
+    \r\nContent-Type: ${this.contentType}
+    \r\n\r\n`;
+
+    const payloadPart2 = "\r\n\r\n----------------------------932677621329676389151855--";
+
+    const data = `${payloadPart1}${this.attachmentBinarycontent}${payloadPart2}`;
+
+    const headers = {
+      "Content-Type": "multipart/form-data; boundary=--------------------------932677621329676389151855",
+    };
+
+    const response = await this.salesforce.insertBlobData(this.sobjectName, {
+      $,
+      headers,
+      data,
+    });
+    $.export("$summary", `Inserted Blob data to ${this.sobjectName}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,29 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+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.2",
+  type: "action",
+  props: {
+    salesforce,
+    query: {
+      type: "string",
+      label: "SOQL Query",
+      description: "A SOQL search query",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.salesforce.query({
+      $,
+      query: this.query,
+    });
+    $.export("$summary", "Successfully returned ${response.length} results for SOQL query");
+    return response;
+  },
+};

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

@@ -0,0 +1,29 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+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.2",
+  type: "action",
+  props: {
+    salesforce,
+    search: {
+      type: "string",
+      label: "SOSL Query",
+      description: "A SOSL search query",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.salesforce.search({
+      $,
+      search: this.search,
+    });
+    $.export("$summary", "Successfully returned ${response.length} results for SOSL search");
+    return response;
+  },
+};

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

@@ -0,0 +1,59 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import account from "../../common/sobjects/account.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  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.2",
+  type: "action",
+  props: {
+    salesforce,
+    AccountId: {
+      type: "string",
+      label: "Account ID",
+      description: "ID of the Account to modify.",
+    },
+    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,
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Account`,
+      options: () => Object.keys(account),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, account);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "AccountId",
+      "Name",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.updateAccount({
+      $,
+      id: this.AccountId,
+      data,
+    });
+    $.export("$summary", `Successfully updated account ${this.AccountId}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,58 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import contact from "../../common/sobjects/contact.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  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.2",
+  type: "action",
+  props: {
+    salesforce,
+    ContactId: {
+      type: "string",
+      label: "Contact ID",
+      description: "ID of the Contact to update.",
+    },
+    LastName: {
+      type: "string",
+      label: "Last Name",
+      description: "Last name of the contact up to 80 characters.",
+      optional: true,
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Contact`,
+      options: () => Object.keys(contact),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, contact);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "ContactId",
+      "LastName",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.updateContact({
+      $,
+      id: this.ContactId,
+      data,
+    });
+    $.export("$summary", `Successfully updated contact for ${this.ContactId}`);
+    return response;
+  },
+};

package/actions/update-opportunity/update-opportunity.mjs

@@ -0,0 +1,72 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import opportunity from "../../common/sobjects/opportunity.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-update-opportunity",
+  name: "Update Opportunity",
+  description: toSingleLineString(`
+    Updates an opportunity, which represents an opportunity, which is a sale or pending deal.
+    See [Opportunity SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_opportunity.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    OpportunityId: {
+      type: "string",
+      label: "Opportunity ID",
+      description: "ID of the Opportunity to update.",
+    },
+    CloseDate: {
+      type: "string",
+      label: "CloseDate",
+      description: "Date when the opportunity is expected to close.",
+      optional: true,
+    },
+    Name: {
+      type: "string",
+      label: "Name",
+      description: "A name for this opportunity. Limit: 120 characters.",
+      optional: true,
+    },
+    StageName: {
+      type: "string",
+      label: "StageName",
+      description: "Current stage of this record. The StageName field controls several other fields on an opportunity. Each of the fields can be directly set or implied by changing the StageName field. In addition, the StageName field is a picklist, so it has additional members in the returned describeSObjectResult to indicate how it affects the other fields. To obtain the stage name values in the picklist, query the OpportunityStage object. If the StageName is updated, then the ForecastCategoryName, IsClosed, IsWon, and Probability are automatically updated based on the stage-category mapping.",
+      optional: true,
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Opportunity`,
+      options: () => Object.keys(opportunity),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, opportunity);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "OpportunityId",
+      "CloseDate",
+      "Name",
+      "StageName",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.updateOpportunity({
+      $,
+      id: this.OpportunityId,
+      data,
+    });
+    $.export("$summary", `Successfully updated opportunity ${this.OpportunityId}`);
+    return response;
+  },
+};

package/actions/update-record/update-record.mjs

@@ -0,0 +1,46 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-update-record",
+  name: "Update Record",
+  description: toSingleLineString(`
+    Updates a record of a given resource.
+    [See docs here](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_update_fields.htm)
+  `),
+  version: "0.2.2",
+  type: "action",
+  props: {
+    salesforce,
+    objectType: {
+      propDefinition: [
+        salesforce,
+        "objectType",
+      ],
+      description: "SObject Type of record to be updated",
+    },
+    sobjectId: {
+      propDefinition: [
+        salesforce,
+        "sobjectId",
+        (c) => ({
+          objectType: c.objectType,
+        }),
+      ],
+      description: "ID of the SObject record to be updated",
+    },
+    sobject: {
+      type: "object",
+      label: "SObject fields and values",
+      description: "SObject record data to patch",
+    },
+  },
+  async run({ $ }) {
+    await this.salesforce.updateRecord(this.objectType, {
+      $,
+      id: this.sobjectId,
+      data: this.sobject,
+    });
+    $.export("$summary", `Updated record ${this.objectType}`);
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,30 @@
+export default {
+  CLEAN_STATUS: [
+    "Matched",
+    "Different",
+    "Acknowledged",
+    "NotFound",
+    "Inactive",
+    "Pending",
+    "SelectMatch",
+    "Skipped",
+  ],
+  CALL_TYPES: [
+    "Inbound",
+    "Internal",
+    "Outbound",
+  ],
+  RECURRENCE_REGENERATED_TYPE: [
+    "None",
+    "After due date",
+    "After the task is closed",
+    "(Task closed)",
+  ],
+  TASK_SUB_TYPES: [
+    "Task",
+    "Email",
+    "List Email",
+    "Cadence",
+    "Call",
+  ],
+};