@pipedream/salesforce_rest_api 1.2.1 → 1.3.1

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

@@ -1,75 +1,77 @@
-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";
+import { docsLink } from "../create-opportunity/create-opportunity.mjs";
 
-const { salesforce } = common.props;
+const {
+  salesforce, ...props
+} = getProps({
+  createOrUpdate: "update",
+  objType: opportunity,
+  docsLink,
+  showDateInfo: true,
+});
 
 export default {
   ...common,
   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.7",
+  description: `Updates an opportunity. [See the documentation](${docsLink})`,
+  version: "0.3.0",
   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,
+  methods: {
+    ...common.methods,
+    getObjectType() {
+      return "Opportunity";
     },
-    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,
+    getAdvancedProps() {
+      return opportunity.extraProps;
     },
-    selector: {
+  },
+  props: {
+    salesforce,
+    opportunityId: {
       propDefinition: [
         salesforce,
-        "fieldSelector",
+        "recordId",
+        () => ({
+          objType: "Opportunity",
+          nameField: "Name",
+        }),
       ],
-      description: `${salesforce.propDefinitions.fieldSelector.description} Opportunity`,
-      options: () => Object.keys(opportunity),
-      reloadProps: true,
+      label: "Opportunity ID",
+      description: "The Opportunity to update.",
     },
-  },
-  additionalProps() {
-    return this.additionalProps(this.selector, opportunity);
+    ...props,
   },
   async run({ $ }) {
-    const data = pickBy(pick(this, [
-      "OpportunityId",
-      "CloseDate",
-      "Name",
-      "StageName",
-      ...this.selector,
-    ]));
-    const response = await this.salesforce.updateOpportunity({
+    /* eslint-disable no-unused-vars */
+    const {
+      salesforce,
+      getAdvancedProps,
+      getObjectType,
+      getAdditionalFields,
+      formatDateTimeProps,
+      opportunityId,
+      useAdvancedProps,
+      docsInfo,
+      dateInfo,
+      additionalFields,
+      CloseDate,
+      ...data
+    } = this;
+    /* eslint-enable no-unused-vars */
+    const response = await salesforce.updateRecord("Opportunity", {
       $,
-      id: this.OpportunityId,
-      data,
+      id: opportunityId,
+      data: {
+        ...data,
+        ...formatDateTimeProps({
+          CloseDate,
+        }),
+        ...getAdditionalFields(),
+      },
     });
-    $.export("$summary", `Successfully updated opportunity ${this.OpportunityId}`);
+    $.export("$summary", `Successfully updated opportunity (ID: ${opportunityId})`);
     return response;
   },
 };

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

@@ -1,46 +1,93 @@
+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-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.7",
+  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.0",
   type: "action",
   props: {
     salesforce,
-    objectType: {
+    sobjectType: {
       propDefinition: [
         salesforce,
         "objectType",
       ],
-      description: "SObject Type of record to be updated",
+      description: "The type of object to update a record of.",
+
     },
-    sobjectId: {
+    recordId: {
       propDefinition: [
         salesforce,
-        "sobjectId",
+        "recordId",
         (c) => ({
-          objectType: c.objectType,
+          objType: c.sobjectType,
         }),
       ],
-      description: "ID of the SObject record to be updated",
+      description:
+        "The record to update.",
     },
-    sobject: {
-      type: "object",
-      label: "SObject fields and values",
-      description: "SObject record data to patch",
+    fieldsToUpdate: {
+      propDefinition: [
+        salesforce,
+        "fieldsToUpdate",
+        (c) => ({
+          objType: c.sobjectType,
+        }),
+      ],
+      reloadProps: true,
     },
   },
+  methods: {
+    getAdditionalFields,
+    convertFieldsToProps,
+  },
+  async additionalProps() {
+    const {
+      sobjectType, fieldsToUpdate,
+    } = this;
+    const fields = await this.salesforce.getFieldsForObjectType(sobjectType);
+
+    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_${sobjectType.toLowerCase()}.htm) for information on all available fields.`,
+      },
+      ...selectedFieldProps,
+      additionalFields,
+    };
+  },
   async run({ $ }) {
-    await this.salesforce.updateRecord(this.objectType, {
+    /* eslint-disable no-unused-vars */
+    const {
+      salesforce,
+      sobjectType,
+      recordId,
+      fieldsToUpdate,
+      getAdditionalFields: getData,
+      convertFieldsToProps,
+      docsInfo,
+      additionalFields,
+      ...data
+    } = this;
+    /* eslint-enable no-unused-vars */
+    const response = await this.salesforce.updateRecord(sobjectType, {
       $,
-      id: this.sobjectId,
-      data: this.sobject,
+      id: recordId,
+      data: {
+        ...data,
+        ...getData(),
+      },
     });
-    $.export("$summary", `Updated record ${this.objectType}`);
+    $.export("$summary", `Successfully updated ${sobjectType} record (ID: ${recordId})`);
+    return response;
   },
 };