@pipedream/salesforce_rest_api 1.6.1 → 1.8.0

package/actions/add-contact-to-campaign/add-contact-to-campaign.mjs

@@ -5,7 +5,7 @@ export default {
   key: "salesforce_rest_api-add-contact-to-campaign",
   name: "Add Contact to Campaign",
   description: "Adds an existing contact to an existing campaign. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_campaignmember.htm)",
-  version: "0.1.0",
+  version: "0.1.1",
   type: "action",
   props: {
     salesforce,

package/actions/add-lead-to-campaign/add-lead-to-campaign.mjs

@@ -5,7 +5,7 @@ export default {
   key: "salesforce_rest_api-add-lead-to-campaign",
   name: "Add Lead to Campaign",
   description: "Adds an existing lead to an existing campaign. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_campaignmember.htm)",
-  version: "0.1.0",
+  version: "0.1.1",
   type: "action",
   props: {
     salesforce,

package/actions/common/batch-operation.mjs

@@ -0,0 +1,86 @@
+import {
+  ConfigurationError,
+  getFileStream,
+} from "@pipedream/platform";
+import app from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  props: {
+    app,
+    csvFilePath: {
+      type: "string",
+      label: "CSV File Path Or URL",
+      description: "The path to the CSV file to process. Provide a path to a file in the `/tmp` directory (for example, `/tmp/data.csv`). If a URL is provided, the file will be downloaded to the `/tmp` directory. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_prepare_data.htm)",
+    },
+    syncDir: {
+      type: "dir",
+      accessMode: "read",
+      sync: true,
+    },
+  },
+  methods: {
+    getObject() {
+      throw new ConfigurationError("getObject method not implemented");
+    },
+    getOperation() {
+      throw new ConfigurationError("getOperation method not implemented");
+    },
+    getSummary() {
+      throw new ConfigurationError("getSummary method not implemented");
+    },
+    async processBulkOperation({
+      object, operation, csvData, externalIdFieldName, ...args
+    } = {}) {
+      const { app } = this;
+      const job = await app.createBulkJob({
+        ...args,
+        data: {
+          object,
+          operation,
+          externalIdFieldName,
+        },
+      });
+
+      await app.uploadBulkJobData({
+        ...args,
+        jobId: job.id,
+        data: csvData,
+      });
+
+      await app.patchBulkJob({
+        ...args,
+        jobId: job.id,
+        data: {
+          state: "UploadComplete",
+        },
+      });
+
+      return app.getBulkJobInfo({
+        ...args,
+        jobId: job.id,
+      });
+    },
+  },
+  async run({ $ }) {
+    const {
+      processBulkOperation,
+      getObject,
+      getOperation,
+      getSummary,
+      csvFilePath,
+    } = this;
+
+    const csvData = await getFileStream(csvFilePath);
+
+    const result = await processBulkOperation({
+      $,
+      object: getObject(),
+      operation: getOperation(),
+      csvData,
+    });
+
+    $.export("$summary", getSummary());
+
+    return result;
+  },
+};

package/actions/convert-soap-xml-to-json/convert-soap-xml-to-json.mjs

@@ -5,7 +5,7 @@ export default {
   key: "salesforce_rest_api-convert-soap-xml-to-json",
   name: "Convert SOAP XML Object to JSON",
   description: "Converts a SOAP XML Object received from Salesforce to JSON",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     salesforce_rest_api,

package/actions/create-account/create-account.mjs

@@ -8,7 +8,7 @@ export default {
   key: "salesforce_rest_api-create-account",
   name: "Create Account",
   description: `Creates a Salesforce account. [See the documentation](${docsLink})`,
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   methods: {
     ...common.methods,

package/actions/create-accounts-batch/create-accounts-batch.mjs

@@ -0,0 +1,22 @@
+import common from "../common/batch-operation.mjs";
+
+export default {
+  ...common,
+  key: "salesforce_rest_api-create-accounts-batch",
+  name: "Create Accounts (Batch)",
+  description: "Create multiple Accounts in Salesforce using Bulk API 2.0. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_understanding_bulk2_ingest.htm)",
+  version: "0.0.1",
+  type: "action",
+  methods: {
+    ...common.methods,
+    getObject() {
+      return "Account";
+    },
+    getOperation() {
+      return "insert";
+    },
+    getSummary() {
+      return "Successfully created Accounts";
+    },
+  },
+};

package/actions/create-attachment/create-attachment.mjs

@@ -18,7 +18,7 @@ export default {
   key: "salesforce_rest_api-create-attachment",
   name: "Create Attachment",
   description: `Creates an Attachment on a parent object. [See the documentation](${docsLink})`,
-  version: "0.5.1",
+  version: "0.5.2",
   type: "action",
   props,
   async run({ $ }) {

package/actions/create-campaign/create-campaign.mjs

@@ -8,7 +8,7 @@ export default {
   key: "salesforce_rest_api-create-campaign",
   name: "Create Campaign",
   description: `Creates a marketing campaign. [See the documentation](${docsLink})`,
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   methods: {
     ...common.methods,

package/actions/create-case/create-case.mjs

@@ -8,7 +8,7 @@ export default {
   key: "salesforce_rest_api-create-case",
   name: "Create Case",
   description: `Creates a Case, which represents a customer issue or problem. [See the documentation](${docsLink})`,
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   methods: {
     ...common.methods,

package/actions/create-casecomment/create-casecomment.mjs

@@ -17,7 +17,7 @@ export default {
   key: "salesforce_rest_api-create-casecomment",
   name: "Create Case Comment",
   description: `Creates a Case Comment on a selected Case. [See the documentation](${docsLink})`,
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   props,
   async run({ $ }) {

package/actions/create-contact/create-contact.mjs

@@ -8,7 +8,7 @@ export default {
   key: "salesforce_rest_api-create-contact",
   name: "Create Contact",
   description: `Creates a contact. [See the documentation](${docsLink})`,
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   methods: {
     ...common.methods,

package/actions/create-content-note/create-content-note.mjs

@@ -27,7 +27,7 @@ export default {
   key: "salesforce_rest_api-create-content-note",
   name: "Create Content Note",
   description: `Creates a content note. [See the documentation](${docsLink}) and [Set Up Notes](https://help.salesforce.com/s/articleView?id=sales.notes_admin_setup.htm&type=5).`,
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     ...contentNoteProps,

package/actions/create-event/create-event.mjs

@@ -9,7 +9,7 @@ export default {
   key: "salesforce_rest_api-create-event",
   name: "Create Event",
   description: `Creates an event. [See the documentation](${docsLink})`,
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   methods: {
     ...common.methods,

package/actions/create-lead/create-lead.mjs

@@ -8,7 +8,7 @@ export default {
   key: "salesforce_rest_api-create-lead",
   name: "Create Lead",
   description: `Creates a lead. [See the documentation](${docsLink})`,
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   methods: {
     ...common.methods,

package/actions/create-note/create-note.mjs

@@ -17,7 +17,7 @@ export default {
   key: "salesforce_rest_api-create-note",
   name: "Create Note",
   description: `Creates a note. [See the documentation](${docsLink})`,
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   props,
   async run({ $ }) {

package/actions/create-opportunities-batch/create-opportunities-batch.mjs

@@ -0,0 +1,22 @@
+import common from "../common/batch-operation.mjs";
+
+export default {
+  ...common,
+  key: "salesforce_rest_api-create-opportunities-batch",
+  name: "Create Opportunities (Batch)",
+  description: "Create multiple Opportunities in Salesforce using Bulk API 2.0. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_understanding_bulk2_ingest.htm)",
+  version: "0.0.1",
+  type: "action",
+  methods: {
+    ...common.methods,
+    getObject() {
+      return "Opportunity";
+    },
+    getOperation() {
+      return "insert";
+    },
+    getSummary() {
+      return "Successfully created Opportunities";
+    },
+  },
+};

package/actions/create-opportunity/create-opportunity.mjs

@@ -8,7 +8,7 @@ export default {
   key: "salesforce_rest_api-create-opportunity",
   name: "Create Opportunity",
   description: `Creates an opportunity. [See the documentation](${docsLink})`,
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   methods: {
     ...common.methods,

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

@@ -8,7 +8,7 @@ export default {
   key: "salesforce_rest_api-create-record",
   name: "Create Record",
   description: "Create a record of a given object. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_sobject_create.htm)",
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   props: {
     salesforce,

package/actions/create-task/create-task.mjs

@@ -9,7 +9,7 @@ export default {
   key: "salesforce_rest_api-create-task",
   name: "Create Task",
   description: `Creates a task. [See the documentation](${docsLink})`,
-  version: "0.4.1",
+  version: "0.4.2",
   type: "action",
   methods: {
     ...common.methods,

package/actions/create-user/create-user.mjs

@@ -9,7 +9,7 @@ export default {
   key: "salesforce_rest_api-create-user",
   name: "Create User",
   description: `Creates a Salesforce user. [See the documentation](${docsLink})`,
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   methods: {
     ...common.methods,

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

@@ -4,7 +4,7 @@ export default {
   key: "salesforce_rest_api-delete-opportunity",
   name: "Delete Opportunity",
   description: "Deletes an opportunity. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_delete_record.htm)",
-  version: "0.3.0",
+  version: "0.3.1",
   type: "action",
   props: {
     salesforce,

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

@@ -5,7 +5,7 @@ export default {
   name: "Delete Record",
   description:
     "Deletes an existing record in an object. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_retrieve_delete.htm)",
-  version: "0.2.0",
+  version: "0.2.1",
   type: "action",
   props: {
     salesforce,

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

@@ -5,7 +5,7 @@ export default {
   name: "Find Records",
   description:
     "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",
+  version: "0.2.1",
   type: "action",
   props: {
     salesforce,

package/actions/get-case/get-case.mjs

@@ -0,0 +1,36 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-get-case",
+  name: "Get Case",
+  description: "Retrieves a case by its ID. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_get_field_values.htm)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    salesforce,
+    caseId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "Case",
+        }),
+      ],
+      label: "Case ID",
+      description: "The case ID to retrieve",
+    },
+  },
+  async run({ $ }) {
+    const fields = (await this.salesforce.getFieldsForObjectType("Case")).map(({ name }) => name);
+
+    let query = `SELECT ${fields.join(", ")} FROM Case WHERE Id = '${this.caseId}'`;
+
+    const { records } = await this.salesforce.query({
+      $,
+      query,
+    });
+
+    $.export("$summary", `Successfully retrieved case with ID ${this.caseId}`);
+    return records[0];
+  },
+};

package/actions/get-user/get-user.mjs

@@ -0,0 +1,34 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-get-user",
+  name: "Get User",
+  description: "Retrieves a user by their ID. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_get_field_values.htm)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    salesforce,
+    userId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "User",
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const fields = (await this.salesforce.getFieldsForObjectType("User")).map(({ name }) => name);
+
+    let query = `SELECT ${fields.join(", ")} FROM User WHERE Id = '${this.userId}'`;
+
+    const { records } = await this.salesforce.query({
+      $,
+      query,
+    });
+
+    $.export("$summary", `Sucessfully retrieved user with ID ${this.userId}`);
+    return records[0];
+  },
+};

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

@@ -4,7 +4,7 @@ export default {
   key: "salesforce_rest_api-insert-blob-data",
   name: "Insert Blob Data",
   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",
+  version: "0.2.9",
   type: "action",
   props: {
     salesforce,

package/actions/list-case-comments/list-case-comments.mjs

@@ -0,0 +1,32 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-list-case-comments",
+  name: "List Case Comments",
+  description: "Lists all comments for a case. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_get_field_values.htm)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    salesforce,
+    caseId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "Case",
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const fields = (await this.salesforce.getFieldsForObjectType("CaseComment")).map(({ name }) => name);
+    let query = `SELECT ${fields.join(", ")} FROM CaseComment WHERE ParentId = '${this.caseId}'`;
+
+    const { records } = await this.salesforce.query({
+      $,
+      query,
+    });
+    $.export("$summary", `Sucessfully retrieved ${records.length} comments for case with ID ${this.caseId}`);
+    return records;
+  },
+};

package/actions/list-email-messages/list-email-messages.mjs

@@ -0,0 +1,38 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-list-email-messages",
+  name: "List Email Messages",
+  description: "Lists all email messages for a case. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_get_field_values.htm)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    salesforce,
+    caseId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "Case",
+        }),
+      ],
+      label: "Case ID",
+      description: "The ID of the case to retrieve email messages for",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const fields = (await this.salesforce.getFieldsForObjectType("EmailMessage")).map(({ name }) => name);
+    let query = `SELECT ${fields.join(", ")} FROM EmailMessage`;
+    if (this.caseId) {
+      query += ` WHERE RelatedToId = '${this.caseId}'`;
+    }
+
+    const { records } = await this.salesforce.query({
+      $,
+      query,
+    });
+    $.export("$summary", `Sucessfully retrieved ${records.length} email messages for case with ID ${this.caseId}`);
+    return records;
+  },
+};

package/actions/list-email-templates/list-email-templates.mjs

@@ -0,0 +1,23 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-list-email-templates",
+  name: "List Email Templates",
+  description: "Lists all email templates. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailtemplate.htm)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    salesforce,
+  },
+  async run({ $ }) {
+    const fields = (await this.salesforce.getFieldsForObjectType("EmailTemplate")).map(({ name }) => name);
+    const query = `SELECT ${fields.join(", ")} FROM EmailTemplate`;
+
+    const { records } = await this.salesforce.query({
+      $,
+      query,
+    });
+    $.export("$summary", `Sucessfully retrieved ${records.length} email templates`);
+    return records;
+  },
+};

package/actions/list-knowledge-articles/list-knowledge-articles.mjs

@@ -0,0 +1,23 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-list-knowledge-articles",
+  name: "List Knowledge Articles",
+  description: "Lists all knowledge articles. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_knowledgearticle.htm)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    salesforce,
+  },
+  async run({ $ }) {
+    const fields = (await this.salesforce.getFieldsForObjectType("KnowledgeArticle")).map(({ name }) => name);
+    const query = `SELECT ${fields.join(", ")} FROM KnowledgeArticle`;
+
+    const { records } = await this.salesforce.query({
+      $,
+      query,
+    });
+    $.export("$summary", `Sucessfully retrieved ${records.length} knowledge articles`);
+    return records;
+  },
+};

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

@@ -5,7 +5,7 @@ export default {
   name: "Post a Message to Chatter Feed",
   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",
+  version: "0.1.1",
   type: "action",
   props: {
     salesforce,

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

@@ -5,7 +5,7 @@ export default {
   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_get.htm)",
-  version: "0.0.2",
+  version: "0.0.3",
   type: "action",
   props: {
     salesforce,

package/actions/send-email/send-email.mjs

@@ -0,0 +1,60 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
+export default {
+  key: "salesforce_rest_api-send-email",
+  name: "Send Email",
+  description: "Sends an email. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_action.meta/api_action/actions_obj_email_simple.htm)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    salesforce,
+    emailAddress: {
+      type: "string",
+      label: "Email Address",
+      description: "The email address to send the email to",
+    },
+    emailSubject: {
+      type: "string",
+      label: "Subject",
+      description: "The subject of the email",
+    },
+    emailBody: {
+      type: "string",
+      label: "Body",
+      description: "The body of the email",
+    },
+    logEmailOnSend: {
+      type: "boolean",
+      label: "Log Email on Send",
+      description: "Indicates whether to log the email on the specified records’ activity time lines",
+      optional: true,
+    },
+  },
+  methods: {
+    sendEmail(opts = {}) {
+      return this.salesforce._makeRequest({
+        url: `${this.salesforce._baseApiVersionUrl()}/actions/standard/emailSimple`,
+        method: "POST",
+        ...opts,
+      });
+    },
+  },
+  async run({ $ }) {
+    const response = await this.sendEmail({
+      $,
+      data: {
+        inputs: [
+          {
+            emailAddresses: this.emailAddress,
+            emailSubject: this.emailSubject,
+            emailBody: this.emailBody,
+            senderType: "CurrentUser",
+            logEmailOnSend: this.logEmailOnSend,
+          },
+        ],
+      },
+    });
+    $.export("$summary", `Email sent to ${this.emailAddress}`);
+    return response;
+  },
+};

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

@@ -7,7 +7,7 @@ export default {
   key: "salesforce_rest_api-soql-search",
   name: "SOQL Query (Object Query)",
   description: `Executes a [Salesforce Object Query Language (SOQL)](${docsLink}) query-based, SQL-like search.`,
-  version: "0.2.9",
+  version: "0.2.10",
   type: "action",
   props: {
     salesforce,

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

@@ -12,7 +12,7 @@ export default {
   key: "salesforce_rest_api-sosl-search",
   name: "SOSL Search (Object Search)",
   description: `Executes a [Salesforce Object Search Language (SOSL)](${docsLink}) text-based search query.`,
-  version: "0.2.8",
+  version: "0.2.9",
   type: "action",
   props: {
     salesforce,

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

@@ -15,7 +15,7 @@ export default {
   key: "salesforce_rest_api-update-account",
   name: "Update Account",
   description: `Updates a Salesforce account. [See the documentation](${docsLink})`,
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   methods: {
     ...common.methods,