new components

Author: michelle0927

components/salesforce_rest_api/actions/get-case/get-case.mjs

@@ -4,8 +4,7 @@ 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.1",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     salesforce,

components/salesforce_rest_api/actions/list-email-messages/list-email-messages.mjs

@@ -18,11 +18,15 @@ export default {
       ],
       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 WHERE RelatedToId = '${this.caseId}'`;
+    let query = `SELECT ${fields.join(", ")} FROM EmailMessage`;
+    if (this.caseId) {
+      query += ` WHERE RelatedToId = '${this.caseId}'`;
+    }
 
     const { records } = await this.salesforce.query({
       $,

components/salesforce_rest_api/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.1",
+  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;
+  },
+};

components/salesforce_rest_api/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.1",
+  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;
+  },
+};

components/salesforce_rest_api/actions/send-email/send-email.mjs

@@ -4,7 +4,7 @@ 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.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     salesforce,
@@ -23,6 +23,12 @@ export default {
       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 = {}) {
@@ -43,6 +49,7 @@ export default {
             emailSubject: this.emailSubject,
             emailBody: this.emailBody,
             senderType: "CurrentUser",
+            logEmailOnSend: this.logEmailOnSend,
           },
         ],
       },

components/salesforce_rest_api/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.1",
+  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;
+  },
+};

components/salesforce_rest_api/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.1",
+  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";
+    },
+  },
+};

components/salesforce_rest_api/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);
+    },
+  },
+};