@pipedream/salesforce_rest_api 1.6.1 → 1.8.0

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

@@ -0,0 +1,22 @@
+import common from "../common/batch-operation.mjs";
+
+export default {
+  ...common,
+  key: "salesforce_rest_api-update-accounts-batch",
+  name: "Update Accounts (Batch)",
+  description: "Update 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 "update";
+    },
+    getSummary() {
+      return "Successfully updated Accounts";
+    },
+  },
+};

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

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

package/actions/update-email-template/update-email-template.mjs

@@ -0,0 +1,81 @@
+import {
+  convertFieldsToProps, getAdditionalFields,
+} from "../../common/props-utils.mjs";
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import { additionalFields } from "../common/base-create-update.mjs";
+
+export default {
+  key: "salesforce_rest_api-update-email-template",
+  name: "Update Email Template",
+  description: "Updates an email template. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_update_fields.htm)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    salesforce,
+    recordId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "EmailTemplate",
+        }),
+      ],
+      description: "The email template to update.",
+    },
+    fieldsToUpdate: {
+      propDefinition: [
+        salesforce,
+        "fieldsToUpdate",
+        () => ({
+          objType: "EmailTemplate",
+        }),
+      ],
+      reloadProps: true,
+    },
+  },
+  methods: {
+    getAdditionalFields,
+    convertFieldsToProps,
+  },
+  async additionalProps() {
+    const { fieldsToUpdate } = this;
+    const fields = await this.salesforce.getFieldsForObjectType("EmailTemplate");
+
+    const selectedFields = fields.filter(({ name }) => fieldsToUpdate.includes(name));
+    const selectedFieldProps = this.convertFieldsToProps(selectedFields);
+
+    return {
+      docsInfo: {
+        type: "alert",
+        alertType: "info",
+        content: "[See the documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_emailtemplate.htm) for information on all available fields.",
+      },
+      ...selectedFieldProps,
+      additionalFields,
+    };
+  },
+  async run({ $ }) {
+    /* eslint-disable no-unused-vars */
+    const {
+      salesforce,
+      recordId,
+      fieldsToUpdate,
+      getAdditionalFields: getData,
+      convertFieldsToProps,
+      docsInfo,
+      additionalFields,
+      ...data
+    } = this;
+    /* eslint-enable no-unused-vars */
+    const response = await this.salesforce.updateRecord("EmailTemplate", {
+      $,
+      id: recordId,
+      data: {
+        ...data,
+        ...getData(),
+      },
+    });
+    $.export("$summary", `Successfully updated Email Template record (ID: ${recordId})`);
+    return response;
+  },
+};

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

@@ -0,0 +1,22 @@
+import common from "../common/batch-operation.mjs";
+
+export default {
+  ...common,
+  key: "salesforce_rest_api-update-opportunities-batch",
+  name: "Update Opportunities (Batch)",
+  description: "Update 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 "update";
+    },
+    getSummary() {
+      return "Successfully updated Opportunities";
+    },
+  },
+};

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

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

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

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

package/actions/upsert-record/upsert-record.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/salesforce_rest_api",
-  "version": "1.6.1",
+  "version": "1.8.0",
   "description": "Pipedream Salesforce (REST API) Components",
   "main": "salesforce_rest_api.app.mjs",
   "keywords": [

package/salesforce_rest_api.app.mjs

@@ -366,5 +366,48 @@ export default {
         ...args,
       });
     },
+    createBulkJob(args = {}) {
+      return this._makeRequest({
+        ...args,
+        method: "POST",
+        url: `${this._baseApiVersionUrl()}/jobs/ingest`,
+        data: {
+          contentType: "CSV",
+          columnDelimiter: "COMMA",
+          lineEnding: "LF",
+          ...args?.data,
+        },
+      });
+    },
+    uploadBulkJobData({
+      jobId, ...args
+    } = {}) {
+      return this._makeRequest({
+        ...args,
+        method: "PUT",
+        url: `${this._baseApiVersionUrl()}/jobs/ingest/${jobId}/batches`,
+        headers: {
+          ...this._makeRequestHeaders(),
+          "Content-Type": "text/csv",
+        },
+      });
+    },
+    patchBulkJob({
+      jobId, ...args
+    } = {}) {
+      return this._makeRequest({
+        ...args,
+        method: "PATCH",
+        url: `${this._baseApiVersionUrl()}/jobs/ingest/${jobId}`,
+      });
+    },
+    getBulkJobInfo({
+      jobId, ...args
+    } = {}) {
+      return this._makeRequest({
+        ...args,
+        url: `${this._baseApiVersionUrl()}/jobs/ingest/${jobId}`,
+      });
+    },
   },
 };

package/sources/case-updated-instant/case-updated-instant.mjs

@@ -0,0 +1,43 @@
+import common from "../common/common-updated-record.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  ...common,
+  type: "source",
+  name: "Case Updated (Instant, of Selectable Type)",
+  key: "salesforce_rest_api-case-updated-instant",
+  description: "Emit new event when a case is updated. [See the documentation](https://sforce.co/3yPSJZy)",
+  version: "0.0.2",
+  props: {
+    salesforce: common.props.salesforce,
+    db: "$.service.db",
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    timer: {
+      type: "$.interface.timer",
+      description: "The timer is only used as a fallback if instant event delivery (webhook) is not available.",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    fieldsToObtain: {
+      propDefinition: [
+        common.props.salesforce,
+        "fieldsToObtain",
+        () => ({
+          objType: "Case",
+        }),
+      ],
+      optional: true,
+      description: "Select the field(s) to be retrieved for the records. Only applicable if the source is running on a timer. If running on a webhook, or if not specified, all fields will be retrieved.",
+    },
+  },
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "Case";
+    },
+  },
+};

package/sources/common/common-new-record.mjs

@@ -0,0 +1,157 @@
+import startCase from "lodash/startCase.js";
+import { v4 as uuidv4 } from "uuid";
+import common from "../common/common.mjs";
+
+export default {
+  ...common,
+  hooks: {
+    ...common.hooks,
+    async deploy() {
+      const objectType = this.getObjectType();
+      const nameField = await this.salesforce.getNameFieldForObjectType(objectType);
+      this.setNameField(nameField);
+
+      // emit historical events
+      const { recentItems } = await this.salesforce.listSObjectTypeIds(objectType);
+      const ids = recentItems.map((item) => item.Id);
+      for (const id of ids.slice(-25)) {
+        const object = await this.salesforce.getSObject(objectType, id);
+        const event = {
+          body: {
+            "New": object,
+            "UserId": id,
+          },
+        };
+        this.processWebhookEvent(event);
+      }
+    },
+    async activate() {
+      // Attempt to create the webhook
+      const secretToken = uuidv4();
+      let webhookData;
+      const objectType = this.getObjectType();
+      try {
+        webhookData = await this.createWebhook({
+          endpointUrl: this.http.endpoint,
+          sObjectType: objectType,
+          event: this.getEventType(),
+          secretToken,
+          fieldsToCheck: this.getFieldsToCheck(),
+          fieldsToCheckMode: this.getFieldsToCheckMode(),
+          skipValidation: true, // neccessary for custom objects
+        });
+        console.log("Webhook created successfully");
+      } catch (err) {
+        console.log("Error creating webhook:", err);
+        console.log("The source will operate on the polling schedule instead.");
+
+        const latestDateCovered = this.getLatestDateCovered();
+        if (!latestDateCovered) {
+          const now = new Date().toISOString();
+          this.setLatestDateCovered(now);
+        }
+
+        await this.timerActivateHook?.();
+      }
+      this._setSecretToken(secretToken);
+      this._setWebhookData(webhookData);
+
+      const nameField = await this.salesforce.getNameFieldForObjectType(objectType);
+      this.setNameField(nameField);
+    },
+  },
+  methods: {
+    ...common.methods,
+    generateTimerMeta(item, fieldName) {
+      const { objectType } = this;
+      const {
+        CreatedDate: createdDate,
+        [fieldName]: name,
+        Id: id,
+      } = item;
+      const entityType = startCase(objectType);
+      const summary = `New ${entityType} created: ${name ?? id}`;
+      const ts = Date.parse(createdDate);
+      return {
+        id,
+        summary,
+        ts,
+      };
+    },
+    generateWebhookMeta(data) {
+      const nameField = this.getNameField();
+      const { New: newObject } = data.body;
+      const {
+        CreatedDate: createdDate,
+        Id: id,
+        [nameField]: name,
+      } = newObject;
+      const summary = `New ${this.getObjectType()} created: ${name ?? id}`;
+      const ts = Date.parse(createdDate);
+      return {
+        id,
+        summary,
+        ts,
+      };
+    },
+    getEventType() {
+      return "new";
+    },
+    async processTimerEvent(eventData) {
+      const {
+        paginate,
+        setLatestDateCovered,
+        getObjectTypeColumns,
+        getNameField,
+        generateTimerMeta,
+        $emit: emit,
+      } = this;
+
+      const {
+        startTimestamp,
+        endTimestamp,
+      } = eventData;
+
+      const fieldName = getNameField();
+      const columns = getObjectTypeColumns();
+
+      const events = await paginate({
+        objectType: this.getObjectType(),
+        startTimestamp,
+        endTimestamp,
+        columns,
+      });
+
+      const [
+        latestEvent,
+      ] = events;
+
+      if (latestEvent?.CreatedDate) {
+        const latestDateCovered = new Date(latestEvent.CreatedDate);
+        latestDateCovered.setSeconds(0);
+        setLatestDateCovered(latestDateCovered.toISOString());
+      }
+
+      Array.from(events)
+        .reverse()
+        .forEach((item) => {
+          const meta = generateTimerMeta(item, fieldName);
+          emit(item, meta);
+        });
+    },
+    async timerActivateHook() {
+      const {
+        getObjectTypeDescription,
+        setObjectTypeColumns,
+      } = this;
+
+      let columns = this.fieldsToObtain;
+      if (!columns?.length) {
+        const { fields } = await getObjectTypeDescription(this.getObjectType());
+        columns = fields.map(({ name }) => name);
+      }
+
+      setObjectTypeColumns(columns);
+    },
+  },
+};

package/sources/common/common-updated-record.mjs

@@ -0,0 +1,198 @@
+import startCase from "lodash/startCase.js";
+import common from "../common/common.mjs";
+import constants from "../../common/constants.mjs";
+import { v4 as uuidv4 } from "uuid";
+
+export default {
+  ...common,
+  hooks: {
+    ...common.hooks,
+    async deploy() {
+      const objectType = this.getObjectType();
+      const nameField = await this.salesforce.getNameFieldForObjectType(objectType);
+      this.setNameField(nameField);
+
+      // emit historical events
+      const { recentItems } = await this.salesforce.listSObjectTypeIds(objectType);
+      const ids = recentItems.map((item) => item.Id);
+      for (const id of ids.slice(-25)) {
+        const object = await this.salesforce.getSObject(objectType, id);
+        const event = {
+          body: {
+            "New": object,
+            "UserId": id,
+          },
+        };
+        const meta = this.generateWebhookMeta(event);
+        this.$emit(event.body, meta);
+      }
+    },
+    async activate() {
+      // Attempt to create the webhook
+      const secretToken = uuidv4();
+      let webhookData;
+      const objectType = this.getObjectType();
+      try {
+        webhookData = await this.createWebhook({
+          endpointUrl: this.http.endpoint,
+          sObjectType: objectType,
+          event: this.getEventType(),
+          secretToken,
+          fieldsToCheck: this.getFieldsToCheck(),
+          fieldsToCheckMode: this.getFieldsToCheckMode(),
+          skipValidation: true, // neccessary for custom objects
+        });
+        console.log("Webhook created successfully");
+      } catch (err) {
+        console.log("Error creating webhook:", err);
+        console.log("The source will operate on the polling schedule instead.");
+
+        const latestDateCovered = this.getLatestDateCovered();
+        if (!latestDateCovered) {
+          const now = new Date().toISOString();
+          this.setLatestDateCovered(now);
+        }
+
+        await this.timerActivateHook?.();
+      }
+      this._setSecretToken(secretToken);
+      this._setWebhookData(webhookData);
+
+      const nameField = await this.salesforce.getNameFieldForObjectType(objectType);
+      this.setNameField(nameField);
+    },
+  },
+  methods: {
+    ...common.methods,
+    generateWebhookMeta(data) {
+      const nameField = this.getNameField();
+      const { New: newObject } = data.body;
+      const {
+        LastModifiedDate: lastModifiedDate,
+        Id: id,
+        [nameField]: name,
+      } = newObject;
+      const summary = `${this.getObjectType()} updated: ${name}`;
+      const ts = Date.parse(lastModifiedDate);
+      const compositeId = `${id}-${ts}`;
+      return {
+        id: compositeId,
+        summary,
+        ts,
+      };
+    },
+    generateTimerMeta(item, fieldName) {
+      const {
+        LastModifiedDate: lastModifiedDate,
+        [fieldName]: name,
+        Id: id,
+      } = item;
+
+      const entityType = startCase(this.getObjectType());
+      const summary = `${entityType} updated: ${name}`;
+      const ts = Date.parse(lastModifiedDate);
+      return {
+        id: `${id}-${ts}`,
+        summary,
+        ts,
+      };
+    },
+    getEventType() {
+      return "updated";
+    },
+    isEventRelevant(changedFields) {
+      const { fields } = this;
+      return fields?.length
+        ? Object.keys(changedFields).some((key) => fields.includes(key))
+        : true;
+    },
+    getChangedFields(body) {
+      return Object.entries(body.New).filter(([
+        key,
+        value,
+      ]) => {
+        const oldValue = body.Old[key];
+        return (
+          value !== undefined
+          && oldValue !== undefined
+          && JSON.stringify(value) !== JSON.stringify(oldValue)
+        );
+      })
+        .reduce((obj, [
+          key,
+          value,
+        ]) => {
+          obj[key] = {
+            old: body.Old[key],
+            new: value,
+          };
+          return obj;
+        }, {});
+    },
+    processWebhookEvent(event) {
+      const { body } = event;
+      const changedFields = this.getChangedFields(body);
+      if (this.isEventRelevant(changedFields)) {
+        const meta = this.generateWebhookMeta(event);
+        this.$emit({
+          ...body,
+          changedFields,
+        }, meta);
+      }
+    },
+    async processTimerEvent(eventData) {
+      const {
+        getNameField,
+        getObjectTypeColumns,
+        paginate,
+        setLatestDateCovered,
+        generateTimerMeta,
+        $emit: emit,
+      } = this;
+
+      const {
+        startTimestamp,
+        endTimestamp,
+      } = eventData;
+
+      const fieldName = getNameField();
+      const columns = getObjectTypeColumns();
+
+      const events = await paginate({
+        objectType: this.getObjectType(),
+        startTimestamp,
+        endTimestamp,
+        columns,
+        dateFieldName: constants.FIELD_NAME.LAST_MODIFIED_DATE,
+      });
+
+      const [
+        latestEvent,
+      ] = events;
+
+      if (latestEvent?.LastModifiedDate) {
+        const latestDateCovered = new Date(latestEvent.LastModifiedDate);
+        latestDateCovered.setSeconds(0);
+        setLatestDateCovered(latestDateCovered.toISOString());
+      }
+
+      Array.from(events)
+        .reverse()
+        .forEach((item) => {
+          const meta = generateTimerMeta(item, fieldName);
+          emit(item, meta);
+        });
+    },
+    async timerActivateHook() {
+      const {
+        getObjectTypeDescription,
+        setObjectTypeColumns,
+      } = this;
+
+      const { fields } = await getObjectTypeDescription(this.getObjectType());
+      const columns = fields.map(({ name }) => name);
+
+      setObjectTypeColumns(columns);
+    },
+  },
+};

package/sources/{common.mjs → common/common.mjs}

@@ -1,6 +1,6 @@
 import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
-import salesforce from "../salesforce_rest_api.app.mjs";
-import constants from "../common/constants.mjs";
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import constants from "../../common/constants.mjs";
 import { v4 as uuidv4 } from "uuid";
 import commonWebhookMethods from "./common-webhook-methods.mjs";
 

package/sources/email-template-updated-instant/email-template-updated-instant.mjs

@@ -0,0 +1,43 @@
+import common from "../common/common-updated-record.mjs";
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+
+export default {
+  ...common,
+  type: "source",
+  name: "Email Template Updated (Instant, of Selectable Type)",
+  key: "salesforce_rest_api-email-template-updated-instant",
+  description: "Emit new event when an email template is updated. [See the documentation](https://sforce.co/3yPSJZy)",
+  version: "0.0.2",
+  props: {
+    salesforce: common.props.salesforce,
+    db: "$.service.db",
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    timer: {
+      type: "$.interface.timer",
+      description: "The timer is only used as a fallback if instant event delivery (webhook) is not available.",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+    fieldsToObtain: {
+      propDefinition: [
+        common.props.salesforce,
+        "fieldsToObtain",
+        () => ({
+          objType: "EmailTemplate",
+        }),
+      ],
+      optional: true,
+      description: "Select the field(s) to be retrieved for the records. Only applicable if the source is running on a timer. If running on a webhook, or if not specified, all fields will be retrieved.",
+    },
+  },
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "EmailTemplate";
+    },
+  },
+};