@pipedream/salesforce_rest_api 0.3.3 → 0.4.0

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

@@ -0,0 +1,51 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import account from "../../common/sobjects/account.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-create-account",
+  name: "Create Account",
+  description: toSingleLineString(`
+    Creates a Salesforce account, representing an individual account,
+    which is an organization or person involved with your business (such as customers, competitors, and partners).
+    See [Account SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_account.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    Name: {
+      type: "string",
+      label: "Name",
+      description: "Name of the account.",
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Account`,
+      options: () => Object.keys(account),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, account);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "Name",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.createAccount({
+      $,
+      data,
+    });
+    $.export("$summary", `Successfully created account "${this.Name}"`);
+    return response;
+  },
+};

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

@@ -0,0 +1,62 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import attachment from "../../common/sobjects/attachment.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-create-attachment",
+  name: "Create Attachment",
+  description: toSingleLineString(`
+    Creates an attachment, which represents a file that a User has uploaded and attached to a parent object.
+    See [Attachment SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_attachment.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    Body: {
+      type: "string",
+      label: "Body",
+      description: "Encoded file data.",
+    },
+    Name: {
+      type: "string",
+      label: "Name",
+      description: "Name of the attached file. Maximum size is 255 characters.",
+    },
+    ParentId: {
+      type: "string",
+      label: "Parent ID",
+      description: "ID of the parent object of the attachment. The following objects are supported as parents of attachments:\n* Account\n* Asset\n* Campaign\n* Case\n* Contact\n* Contract\n* Custom objects\n* EmailMessage\n* EmailTemplate\n* Event\n* Lead\n* Opportunity\n* Product2\n* Solution\n* Task",
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Attachment`,
+      options: () => Object.keys(attachment),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, attachment);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "Body",
+      "Name",
+      "ParentId",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.createAttachment({
+      $,
+      data,
+    });
+    $.export("$summary", `Successfully created attachment "${this.Name}"`);
+    return response;
+  },
+};

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

@@ -0,0 +1,51 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import campaign from "../../common/sobjects/campaign.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-create-campaign",
+  name: "Create Campaign",
+  description: toSingleLineString(`
+    Creates a marketing campaign, such as a direct mail promotion, webinar, or trade show.
+    See [Campaign SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_campaign.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    Name: {
+      type: "string",
+      label: "Name",
+      description: "Required. Name of the campaign. Limit: is 80 characters.",
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Campaign`,
+      options: () => Object.keys(campaign),
+      reloadProps: true,
+      optional: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, campaign);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "Name",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.createCampaign({
+      $,
+      data,
+    });
+    $.export("$summary", `Created campaign "${this.Name}"`);
+    return response;
+  },
+};

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

@@ -0,0 +1,50 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import salesforceCase from "../../common/sobjects/case.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-create-case",
+  name: "Create Case",
+  description: toSingleLineString(`
+    Creates a Salesforce case, which represents a customer issue or problem.
+    See [Case SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_case.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    SuppliedEmail: {
+      type: "string",
+      label: "Supplied email",
+      description: "The email address that was entered when the case was created. Label is Email.If your organization has an active auto-response rule, SuppliedEmail is required when creating a case via the API. Auto-response rules use the email in the contact specified by ContactId. If no email address is in the contact record, the email specified here is used.",
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Case`,
+      options: () => Object.keys(salesforceCase),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, salesforceCase);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "SuppliedEmail",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.createCase({
+      $,
+      data,
+    });
+    $.export("$summary", `Successfully created case for ${this.SuppliedEmail}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,50 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import caseComment from "../../common/sobjects/caseComment.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-create-casecomment",
+  name: "Create CaseComment",
+  description: toSingleLineString(`
+    Creates a Case Comment that provides additional information about the associated Case.
+    See [CaseComment SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_casecomment.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    ParentId: {
+      type: "string",
+      label: "Parent ID",
+      description: "Required. ID of the parent Case of the CaseComment.",
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} CaseComment`,
+      options: () => Object.keys(caseComment),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, caseComment);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "ParentId",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.createCaseComment({
+      $,
+      data,
+    });
+    $.export("$summary", `Successfully created case comment for ${this.ParentId}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,50 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import contact from "../../common/sobjects/contact.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-create-contact",
+  name: "Create Contact",
+  description: toSingleLineString(`
+    Creates a Contact, which is a person associated with an account.
+    See [Contact SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_contact.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    LastName: {
+      type: "string",
+      label: "Last name",
+      description: "Last name of the contact up to 80 characters.",
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Contact`,
+      options: () => Object.keys(contact),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, contact);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "LastName",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.createContact({
+      $,
+      data,
+    });
+    $.export("$summary", `Successfully created contact "${this.LastName}"`);
+    return response;
+  },
+};

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

@@ -0,0 +1,80 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import {
+  removeNullEntries, toSingleLineString,
+} from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-create-event",
+  name: "Create Event",
+  description: toSingleLineString(`
+    Creates an event, which represents an event in the calendar.
+    See [Event SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_event.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    IsAllDayEvent: {
+      type: "boolean",
+      label: "All-Day Event",
+      description: "Indicates whether the ActivityDate field (true) or the ActivityDateTime field (false) is used to define the date or time of the event.",
+      reloadProps: true,
+    },
+    AcceptedEventInviteeIds: {
+      propDefinition: [
+        salesforce,
+        "AcceptedEventInviteeIds",
+      ],
+    },
+    Description: {
+      type: "string",
+      label: "Description",
+      description: "Contains a text description of the event. Limit: 32,000 characters.",
+    },
+    Subject: {
+      type: "string",
+      label: "Subject",
+      description: "The subject line of the event, such as Call, Email, or Meeting. Limit: 255 characters.",
+    },
+  },
+  async additionalProps() {
+    const props = {};
+    if (this.IsAllDayEvent) {
+      props.ActivityDate = {
+        type: "string",
+        label: "Due Date Only (YYYY/MM/DD)",
+        description: "Contains the event's due date if the IsAllDayEvent flag is set to true.",
+      };
+    } else {
+      props.ActivityDateTime = {
+        type: "string",
+        label: "Due Date Time",
+        description: "Contains the event's due date if the IsAllDayEvent flag is set to false. The time portion of this field is always transferred in the Coordinated Universal Time (UTC) time zone. Translate the time portion to or from a local time zone for the user or the application, as appropriate.",
+      };
+      props.DurationInMinutes = {
+        type: "integer",
+        label: "Duration in minutes",
+        description: "Contains the event length, in minutes.",
+      };
+    }
+    return props;
+  },
+  async run({ $ }) {
+    const data = removeNullEntries({
+      IsAllDayEvent: this.IsAllDayEvent,
+      AcceptedEventInviteeIds: this.AcceptedEventInviteeIds,
+      Description: this.Description,
+      Subject: this.Subject,
+      ActivityDate: this.ActivityDate && new Date(this.ActivityDate).toUTCString(),
+      ActivityDateTime: this.ActivityDateTime,
+      DurationInMinutes: this.DurationInMinutes,
+    });
+    const response = await this.salesforce.createEvent({
+      $,
+      data,
+    });
+    $.export("$summary", "Succcessfully created event");
+    return response;
+  },
+};

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

@@ -0,0 +1,56 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import lead from "../../common/sobjects/lead.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-create-lead",
+  name: "Create Lead",
+  description: toSingleLineString(`
+    Creates a lead, which represents a prospect or lead.
+    See [Lead SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_lead.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    Company: {
+      type: "string",
+      label: "Company",
+      description: "The lead's company. Note If person account record types have been enabled, and if the value of Company is null, the lead converts to a person account.",
+    },
+    LastName: {
+      type: "string",
+      label: "Last name",
+      description: "Required. Last name of the lead up to 80 characters.",
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Lead`,
+      options: () => Object.keys(lead),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, lead);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "Company",
+      "LastName",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.createLead({
+      $,
+      data,
+    });
+    $.export("$summary", `Successfully created lead for ${this.Company}`);
+    return response;
+  },
+};

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

@@ -0,0 +1,56 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import note from "../../common/sobjects/note.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  key: "salesforce_rest_api-create-note",
+  name: "Create Note",
+  description: toSingleLineString(`
+    Creates a note, which is text associated with a custom object or a standard object, such as a Contact, Contract, or Opportunity.
+    See [Note SObject](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_note.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    ParentId: {
+      type: "string",
+      label: "Parent ID",
+      description: "ID of the object associated with the note.",
+    },
+    Title: {
+      type: "string",
+      label: "Title",
+      description: "Title of the note.",
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Note`,
+      options: () => Object.keys(note),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, note);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "ParentId",
+      "Title",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.createNote({
+      $,
+      data,
+    });
+    $.export("$summary", `Successfully created note "${this.Title}"`);
+    return response;
+  },
+};

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

@@ -0,0 +1,62 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import opportunity from "../../common/sobjects/opportunity.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  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.2",
+  type: "action",
+  props: {
+    salesforce,
+    CloseDate: {
+      type: "string",
+      label: "Close date",
+      description: "Date when the opportunity is expected to close.",
+    },
+    Name: {
+      type: "string",
+      label: "Name",
+      description: "A name for this opportunity. Limit: 120 characters.",
+    },
+    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,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, opportunity);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "CloseDate",
+      "Name",
+      "StageName",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.createOpportunity({
+      $,
+      data,
+    });
+    $.export("$summary", `Successfully created opportunity "${this.Name}"`);
+    return response;
+  },
+};

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

@@ -0,0 +1,36 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import { toSingleLineString } from "../../common/utils.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.2",
+  type: "action",
+  props: {
+    salesforce,
+    objectType: {
+      propDefinition: [
+        salesforce,
+        "objectType",
+      ],
+      description: "SObject Type for this record",
+    },
+    sobject: {
+      type: "object",
+      label: "SObject fields and values",
+      description: "Data of the SObject record to create",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.salesforce.createRecord(this.objectType, {
+      $,
+      data: this.sobject,
+    });
+    $.export("$summary", `Created record "${this.objectType}"`);
+    return response;
+  },
+};

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

@@ -0,0 +1,56 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+import task from "../../common/sobjects/task.mjs";
+import {
+  pickBy, pick,
+} from "lodash-es";
+import { toSingleLineString } from "../../common/utils.mjs";
+
+export default {
+  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.2",
+  type: "action",
+  props: {
+    salesforce,
+    Priority: {
+      type: "string",
+      label: "Priority",
+      description: "Required. Indicates the importance or urgency of a task, such as high or low.",
+    },
+    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).",
+    },
+    selector: {
+      propDefinition: [
+        salesforce,
+        "fieldSelector",
+      ],
+      description: `${salesforce.propDefinitions.fieldSelector.description} Task`,
+      options: () => Object.keys(task),
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    return this.salesforce.additionalProps(this.selector, task);
+  },
+  async run({ $ }) {
+    const data = pickBy(pick(this, [
+      "Priority",
+      "Status",
+      ...this.selector,
+    ]));
+    const response = await this.salesforce.createTask({
+      $,
+      data,
+    });
+    $.export("$summary", "Successfully created task");
+    return response;
+  },
+};