@pipedream/salesforce_rest_api 1.2.0 → 1.3.0

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

@@ -1,63 +1,54 @@
-import common from "../common/base.mjs";
+import common, { getProps } from "../common/base-create-update.mjs";
 import opportunity from "../../common/sobjects/opportunity.mjs";
-import {
-  pickBy, pick,
-} from "lodash-es";
-import { toSingleLineString } from "../../common/utils.mjs";
 
-const { salesforce } = common.props;
+export const docsLink = "https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_opportunity.htm";
 
 export default {
   ...common,
   key: "salesforce_rest_api-create-opportunity",
   name: "Create Opportunity",
-  description: toSingleLineString(`
-    Creates 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 [Create Record](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_sobject_create.htm)
-  `),
-  version: "0.2.7",
+  description: `Creates an opportunity. [See the documentation](${docsLink})`,
+  version: "0.3.0",
   type: "action",
-  props: {
-    salesforce,
-    CloseDate: {
-      type: "string",
-      label: "Close date",
-      description: "Date when the opportunity is expected to close.",
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "Opportunity";
     },
-    Name: {
-      type: "string",
-      label: "Name",
-      description: "A name for this opportunity. Limit: 120 characters.",
+    getAdvancedProps() {
+      return opportunity.extraProps;
     },
-    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.",
-    },
-    selector: {
-      propDefinition: [
-        salesforce,
-        "fieldSelector",
-      ],
-      description: `${salesforce.propDefinitions.fieldSelector.description} Opportunity`,
-      options: () => Object.keys(opportunity),
-      reloadProps: true,
-    },
-  },
-  additionalProps() {
-    return this.additionalProps(this.selector, opportunity);
   },
+  props: getProps({
+    objType: opportunity,
+    docsLink,
+    showDateInfo: true,
+  }),
   async run({ $ }) {
-    const data = pickBy(pick(this, [
-      "CloseDate",
-      "Name",
-      "StageName",
-      ...this.selector,
-    ]));
-    const response = await this.salesforce.createOpportunity({
+    /* eslint-disable no-unused-vars */
+    const {
+      salesforce,
+      getAdvancedProps,
+      getObjectType,
+      getAdditionalFields,
+      formatDateTimeProps,
+      useAdvancedProps,
+      docsInfo,
+      dateInfo,
+      additionalFields,
+      CloseDate,
+      ...data
+    } = this;
+    /* eslint-enable no-unused-vars */
+    const response = await salesforce.createRecord("Opportunity", {
       $,
-      data,
+      data: {
+        ...data,
+        ...formatDateTimeProps({
+          CloseDate,
+        }),
+        ...getAdditionalFields(),
+      },
     });
     $.export("$summary", `Successfully created opportunity "${this.Name}"`);
     return response;

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

@@ -1,14 +1,14 @@
+import {
+  convertFieldsToProps, getAdditionalFields,
+} from "../../common/props-utils.mjs";
 import salesforce from "../../salesforce_rest_api.app.mjs";
-import { toSingleLineString } from "../../common/utils.mjs";
+import { additionalFields } from "../common/base-create-update.mjs";
 
 export default {
   key: "salesforce_rest_api-create-record",
   name: "Create Record",
-  description: toSingleLineString(`
-    Create new records of a given resource.
-    See [docs](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_sobject_create.htm)
-  `),
-  version: "0.2.7",
+  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.0",
   type: "action",
   props: {
     salesforce,
@@ -17,20 +17,54 @@ export default {
         salesforce,
         "objectType",
       ],
-      description: "SObject Type for this record",
-    },
-    sobject: {
-      type: "object",
-      label: "SObject fields and values",
-      description: "Data of the SObject record to create",
+      description: "The type of object to create a record of",
+      reloadProps: true,
     },
   },
+  methods: {
+    getAdditionalFields,
+    convertFieldsToProps,
+  },
+  async additionalProps() {
+    const { objectType } = this;
+    const fields = await this.salesforce.getFieldsForObjectType(objectType);
+
+    const requiredFields = fields.filter((field) => {
+      return field.createable && !field.nillable && !field.defaultedOnCreate;
+    });
+
+    const requiredFieldProps = this.convertFieldsToProps(requiredFields);
+
+    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_${objectType.toLowerCase()}.htm) for information on all available fields.`,
+      },
+      ...requiredFieldProps,
+      additionalFields,
+    };
+  },
   async run({ $ }) {
-    const response = await this.salesforce.createRecord(this.objectType, {
+    /* eslint-disable no-unused-vars */
+    const {
+      salesforce,
+      objectType,
+      getAdditionalFields: getData,
+      convertFieldsToProps,
+      docsInfo,
+      additionalFields,
+      ...data
+    } = this;
+    /* eslint-enable no-unused-vars */
+    const response = await salesforce.createRecord(objectType, {
       $,
-      data: this.sobject,
+      data: {
+        ...data,
+        ...getData(),
+      },
     });
-    $.export("$summary", `Created record "${this.objectType}"`);
+    $.export("$summary", `Successfully created ${objectType} record (ID: ${response.id})`);
     return response;
   },
 };

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

@@ -1,59 +1,67 @@
-import common from "../common/base.mjs";
+import common, { getProps } from "../common/base-create-update.mjs";
 import task from "../../common/sobjects/task.mjs";
-import {
-  pickBy, pick,
-} from "lodash-es";
-import { toSingleLineString } from "../../common/utils.mjs";
 
-const { salesforce } = common.props;
+const docsLink =
+  "https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_task.htm";
 
 export default {
   ...common,
   key: "salesforce_rest_api-create-task",
   name: "Create Task",
-  description: toSingleLineString(`
-    Creates a task, which represents a business activity such as making a phone call or other to-do items.
-    See [Task SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_task.htm)
-    and [Create Record](https://developer.salesforce.com/docs/atlas.en-us.228.0.api_rest.meta/api_rest/dome_sobject_create.htm)
-  `),
-  version: "0.3.7",
+  description: `Creates a task. [See the documentation](${docsLink})`,
+  version: "0.4.0",
   type: "action",
-  props: {
-    salesforce,
-    Priority: {
-      type: "string",
-      label: "Priority",
-      description: "Required. Indicates the importance or urgency of a task, such as high or low.",
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "Task";
     },
-    Status: {
-      type: "string",
-      label: "Status",
-      description: "Required. The status of the task, such as In Progress or Completed. Each predefined Status field implies a value for the IsClosed flag. To obtain picklist values, query the TaskStatus object. Note This field can't be updated for recurring tasks (IsRecurrence is true).",
+    getAdvancedProps() {
+      return task.extraProps;
     },
-    selector: {
-      propDefinition: [
-        salesforce,
-        "fieldSelector",
-      ],
-      description: `${salesforce.propDefinitions.fieldSelector.description} Task`,
-      options: () => Object.keys(task),
-      reloadProps: true,
-    },
-  },
-  additionalProps() {
-    return this.additionalProps(this.selector, task);
   },
+  props: getProps({
+    objType: task,
+    docsLink,
+    showDateInfo: true,
+  }),
   async run({ $ }) {
-    const data = pickBy(pick(this, [
-      "Priority",
-      "Status",
-      ...this.selector,
-    ]));
-    const response = await this.salesforce.createTask({
+    /* eslint-disable no-unused-vars */
+    const {
+      salesforce,
+      getAdvancedProps,
+      getObjectType,
+      getAdditionalFields,
+      formatDateTimeProps,
+      useAdvancedProps,
+      docsInfo,
+      dateInfo,
+      additionalFields,
+      ActivityDate,
+      RecurrenceEndDateOnly,
+      RecurrenceStartDateOnly,
+      ReminderDateTime,
+      RecurrenceDayOfWeekMask,
+      ...data
+    } = this;
+    /* eslint-enable no-unused-vars */
+    const response = await salesforce.createRecord("Task", {
       $,
-      data,
+      data: {
+        ...data,
+        ...formatDateTimeProps({
+          ActivityDate,
+          RecurrenceEndDateOnly,
+          RecurrenceStartDateOnly,
+          ReminderDateTime,
+        }),
+        RecurrenceDayOfWeekMask: RecurrenceDayOfWeekMask?.reduce?.((acc, val) => acc + val, 0),
+        ...getAdditionalFields(),
+      },
     });
-    $.export("$summary", "Successfully created task");
+    $.export("$summary", `Succcessfully created task${this.Subject
+      ? ` "${this.Subject}"`
+      : ""}`);
     return response;
   },
 };

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

@@ -1,215 +1,52 @@
-import common from "../common/base.mjs";
-import utils from "../../common/props-utils.mjs";
-import { toSingleLineString } from "../../common/utils.mjs";
+import common, { getProps } from "../common/base-create-update.mjs";
+import user from "../../common/sobjects/user.mjs";
 
-const { salesforce } = common.props;
+const docsLink =
+  "https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_user.htm";
 
 export default {
   ...common,
   key: "salesforce_rest_api-create-user",
   name: "Create User",
-  description: toSingleLineString(`
-    Creates a Salesforce user.
-    See [User SObject](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_user.htm)
-    and [Create Record](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_sobject_create.htm)
-  `),
-  version: "0.0.1",
+  description: `Creates a Salesforce user. [See the documentation](${docsLink})`,
+  version: "0.1.0",
   type: "action",
-  props: {
-    salesforce,
-    alias: {
-      type: "string",
-      label: "Alias",
-      description: "Alias of the user. The alias can contain only underscores and alphanumeric characters. It must be unique in your org, not include spaces, not end with a hyphen, and not contain two consecutive hyphens.",
-    },
-    email: {
-      type: "string",
-      label: "Email",
-      description: "The email address of the user.",
-    },
-    emailEncodingKey: {
-      type: "string",
-      label: "Email Encoding Key",
-      description: "The key used to encode the user's email.",
-      options: [
-        "ISO-8859-1",
-        "UTF-8",
-        "Shift_JIS",
-        "EUC-JP",
-        "ISO-2022-JP",
-      ],
-      default: "UTF-8",
-    },
-    languageLocaleKey: {
-      type: "string",
-      label: "Language Locale Key",
-      description: "The user's language locale key.",
-      async options() {
-        const fields = await this.salesforce.getFieldsForObjectType("User");
-        const { picklistValues } = fields.find(({ name }) => name === "LanguageLocaleKey");
-        return picklistValues.map(({
-          value, label,
-        }) => ({
-          label,
-          value,
-        }));
-      },
-    },
-    firstName: {
-      type: "string",
-      label: "First Name",
-      description: "The user's first name.",
-      optional: true,
-    },
-    lastName: {
-      type: "string",
-      label: "Last Name",
-      description: "The user's last name.",
-    },
-    localeSidKey: {
-      type: "string",
-      label: "Locale Sid Key",
-      description: "The user's locale sid key.",
-      async options() {
-        const fields = await this.salesforce.getFieldsForObjectType("User");
-        const { picklistValues } = fields.find(({ name }) => name === "LocaleSidKey");
-        return picklistValues.map(({
-          value, label,
-        }) => ({
-          label,
-          value,
-        }));
-      },
-    },
-    profileId: {
-      type: "string",
-      label: "Profile ID",
-      description: "The ID of the user's profile.",
-      async options() {
-        const { records } = await this.salesforce.query({
-          query: "SELECT Id, Name FROM Profile",
-        });
-        return records.map(({
-          Id: value, Name: label,
-        }) => ({
-          label,
-          value,
-        }));
-      },
-    },
-    timeZoneSidKey: {
-      type: "string",
-      label: "Time Zone Sid Key",
-      description: "The user's time zone sid key.",
-      async options() {
-        const fields = await this.salesforce.getFieldsForObjectType("User");
-        const { picklistValues } = fields.find(({ name }) => name === "TimeZoneSidKey");
-        return picklistValues.map(({
-          value, label,
-        }) => ({
-          label,
-          value,
-        }));
-      },
-    },
-    userName: {
-      type: "string",
-      label: "User Name",
-      description: "The user's username. It should be in email format. Eg. `john@acme.com`.",
-    },
-    title: {
-      type: "string",
-      label: "Title",
-      description: "The user's title.",
-      optional: true,
-    },
-    department: {
-      type: "string",
-      label: "Department",
-      description: "The department the user belongs to.",
-      optional: true,
-    },
-    division: {
-      type: "string",
-      label: "Division",
-      description: "The division the user belongs to.",
-      optional: true,
-    },
-    phone: {
-      type: "string",
-      label: "Phone",
-      description: "The user's phone number.",
-      optional: true,
-    },
-    mobilePhone: {
-      type: "string",
-      label: "Mobile Phone",
-      description: "The user's mobile phone number.",
-      optional: true,
-    },
-    street: {
-      type: "string",
-      label: "Street",
-      description: "The user's street address.",
-      optional: true,
-    },
-    city: {
-      type: "string",
-      label: "City",
-      description: "The user's city.",
-      optional: true,
-    },
-    state: {
-      type: "string",
-      label: "State",
-      description: "The user's state.",
-      optional: true,
-    },
-    postalCode: {
-      type: "string",
-      label: "Postal Code",
-      description: "The user's postal code.",
-      optional: true,
-    },
-    country: {
-      type: "string",
-      label: "Country",
-      description: "The user's country.",
-      optional: true,
-    },
-    userRoleId: {
-      type: "string",
-      label: "User Role ID",
-      description: "The ID of the user's role.",
-      optional: true,
-    },
-    isActive: {
-      type: "boolean",
-      label: "Is Active",
-      description: "Whether the user is active.",
-      optional: true,
-    },
-  },
   methods: {
-    createUser(args = {}) {
-      return this.salesforce._makeRequest({
-        method: "POST",
-        url: this.salesforce._sObjectTypeApiUrl("User"),
-        ...args,
-      });
+    ...common.methods,
+    getObjectType() {
+      return "User";
+    },
+    getAdvancedProps() {
+      return user.extraProps;
     },
   },
+  props: getProps({
+    objType: user,
+    docsLink,
+  }),
   async run({ $ }) {
+    /* eslint-disable no-unused-vars */
     const {
-      createUser,
+      salesforce,
+      getAdvancedProps,
+      getObjectType,
+      getAdditionalFields,
+      formatDateTimeProps,
+      useAdvancedProps,
+      docsInfo,
+      dateInfo,
+      additionalFields,
       ...data
     } = this;
-
-    const response = await createUser({
+    /* eslint-enable no-unused-vars */
+    const response = await salesforce.createRecord("User", {
       $,
-      data: utils.keysToCapitalCase(data),
+      data: {
+        ...data,
+        ...getAdditionalFields(),
+      },
     });
-    $.export("$summary", `Successfully created user with ID \`${response.id}\``);
+    $.export("$summary", `Successfully created user (ID: ${response.id})`);
     return response;
   },
 };

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

@@ -1,30 +1,34 @@
 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.7",
+  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",
   type: "action",
   props: {
     salesforce,
-    OpportunityId: {
-      type: "string",
+    recordId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "Opportunity",
+          nameField: "Name",
+        }),
+      ],
       label: "Opportunity ID",
-      description: "ID of the Opportunity to delete",
+      description: "ID of the opportunity to delete.",
     },
   },
   async run({ $ }) {
-    const response = await this.salesforce.deleteOpportunity({
+    const { recordId } = this;
+    const response = await this.salesforce.deleteRecord({
+      sobjectType: "Opportunity",
       $,
-      id: this.OpportunityId,
+      recordId,
     });
-    $.export("$summary", "Successfully deleted opportunity");
+    $.export("$summary", `Successfully deleted opportunity (ID: ${recordId})`);
     return response;
   },
 };

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

@@ -1,42 +1,44 @@
-import salesForceRestApi from "../../salesforce_rest_api.app.mjs";
+import salesforce from "../../salesforce_rest_api.app.mjs";
 
 export default {
   key: "salesforce_rest_api-delete-record",
-  name: "Delete a Record in an Object",
+  name: "Delete Record",
   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.5",
+    "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",
   type: "action",
   props: {
-    salesForceRestApi,
+    salesforce,
     sobjectType: {
       propDefinition: [
-        salesForceRestApi,
+        salesforce,
         "objectType",
       ],
+      description: "The type of object to delete a record of.",
     },
-    sobjectId: {
+    recordId: {
       propDefinition: [
-        salesForceRestApi,
-        "sobjectId",
+        salesforce,
+        "recordId",
         (c) => ({
-          objectType: c.sobjectType,
+          objType: c.sobjectType,
         }),
       ],
       description:
-        "ID of the Salesforce standard object to get field values from.",
+        "The record to delete.",
     },
   },
   async run({ $ }) {
     const {
       sobjectType,
-      sobjectId,
+      recordId,
     } = this;
-    const response = await this.salesForceRestApi.deleteObject(
+    const response = await this.salesforce.deleteRecord({
+      $,
       sobjectType,
-      sobjectId,
-    );
-    response && $.export("$summary", `Successfully deleted record with ID ${sobjectId}`);
+      recordId,
+    });
+    $.export("$summary", `Successfully deleted record (ID: ${recordId})`);
     return response;
   },
 };