@pipedream/salesforce_rest_api 1.2.1 → 1.3.0

package/common/sobjects/contact.mjs

@@ -1,47 +1,211 @@
+import {
+  CLEAN_STATUS_OPTIONS, GEOCODE_ACCURACY_OPTIONS, RECORD_SOURCE_OPTIONS,
+} from "../constants-props.mjs";
+import commonProps from "../props-async-options.mjs";
+
 export default {
-  AccountId: {
-    type: "string",
-    label: "Account ID",
-    description: "ID of the account that's the parent of this contact. We recommend that you update up to 50 contacts simultaneously when changing the accounts on contacts enabled for a Customer Portal or partner portal. We also recommend that you make this update after business hours.",
+  initialProps: {
+    Description: {
+      type: "string",
+      label: "Contact Description",
+      description: "A description of the contact, up to 32 KB.",
+      optional: true,
+    },
+    Email: {
+      type: "string",
+      label: "Email",
+      description: "The contact's email address.",
+      optional: true,
+    },
+    FirstName: {
+      type: "string",
+      label: "First Name",
+      description: "The contact's first name, up to 40 characters.",
+      optional: true,
+    },
+    LastName: {
+      type: "string",
+      label: "Last Name",
+      description: "The contact's last name, up to 80 characters.",
+    },
+    Phone: {
+      type: "string",
+      label: "Business Phone",
+      description: "Phone number for the contact.",
+      optional: true,
+    },
   },
-  Birthdate: {
-    type: "string",
-    label: "Birth Date",
-    description: "The contact's birth date.Filter criteria for report filters, list view filters, and SOQL queries ignore the year portion of the Birthdate field. For example, this SOQL query returns contacts with birthdays later in the year than today:view sourceprint?1SELECT Name, Birthdate2FROM Contact3WHERE Birthdate > TODAY",
-  },
-  Department: {
-    type: "string",
-    label: "Department",
-    description: "The contact's department.",
-  },
-  Description: {
-    type: "string",
-    label: "Description",
-    description: "A description of the contact. Label is Contact Description up to 32 KB.",
-  },
-  Email: {
-    type: "string",
-    label: "Email",
-    description: "The contact's email address.",
-  },
-  FirstName: {
-    type: "string",
-    label: "First Name",
-    description: "The contact's first name up to 40 characters.",
-  },
-  Phone: {
-    type: "string",
-    label: "Phone",
-    description: "Telephone number for the contact. Label is Business Phone.",
-  },
-  Suffix: {
-    type: "string",
-    label: "Suffix",
-    description: "Name suffix of the contact up to 40 characters. To enable this field, ask Salesforce Customer Support for help.",
-  },
-  Title: {
-    type: "string",
-    label: "Title",
-    description: "Title of the contact, such as CEO or Vice President.",
+  extraProps: {
+    AccountId: {
+      ...commonProps.AccountId,
+      description: "ID of the account that's the parent of this contact.",
+      optional: true,
+    },
+    IndividualId: {
+      ...commonProps.IndividualId,
+      optional: true,
+    },
+    OwnerId: {
+      ...commonProps.UserId,
+      description:
+        "The ID of the owner of the account associated with this contact.",
+      optional: true,
+    },
+    RecordTypeId: {
+      ...commonProps.RecordTypeId,
+      optional: true,
+    },
+    ReportsToId: {
+      ...commonProps.ContactId,
+      label: "Reports To ID",
+      optional: true,
+    },
+    AssistantName: {
+      type: "string",
+      label: "Assistant's Name",
+      description: "The assistant's name.",
+      optional: true,
+    },
+    AssistantPhone: {
+      type: "string",
+      label: "Assistant's Phone",
+      description: "The assistant's phone number.",
+      optional: true,
+    },
+    Birthdate: {
+      type: "string",
+      label: "Birthdate",
+      description: "The contact's birthdate.",
+      optional: true,
+    },
+    CleanStatus: {
+      type: "string",
+      label: "Clean Status",
+      description:
+        "Indicates the record's clean status as compared with Data.com.",
+      optional: true,
+      options: CLEAN_STATUS_OPTIONS,
+    },
+    Department: {
+      type: "string",
+      label: "Department",
+      description: "The contact's department.",
+      optional: true,
+    },
+    Fax: {
+      type: "string",
+      label: "Business Fax",
+      description: "The contact's fax number.",
+      optional: true,
+    },
+    HasOptedOutOfEmail: {
+      type: "boolean",
+      label: "Email Opt Out",
+      description:
+        "Indicates whether the contact doesn't want to receive email from Salesforce (`true`) or does (`false`).",
+      optional: true,
+    },
+    HasOptedOutOfFax: {
+      type: "boolean",
+      label: "Fax Opt Out",
+      description: "Indicates whether the contact prohibits receiving faxes.",
+      optional: true,
+    },
+    HomePhone: {
+      type: "string",
+      label: "Home Phone",
+      description: "The contact's home phone number.",
+      optional: true,
+    },
+    LeadSource: {
+      type: "string",
+      label: "Lead Source",
+      description: "The source of the lead that was converted to this contact.",
+      optional: true,
+      options: RECORD_SOURCE_OPTIONS,
+    },
+    MailingCity: {
+      type: "string",
+      label: "Mailing City",
+      description: "The city of the contact's mailing address.",
+      optional: true,
+    },
+    MailingCountry: {
+      type: "string",
+      label: "Mailing Country",
+      description: "The country of the contact's mailing address.",
+      optional: true,
+    },
+    MailingGeocodeAccuracy: {
+      type: "string",
+      label: "Mailing Geocode Accuracy",
+      description: "Accuracy level of the geocode for the mailing address.",
+      optional: true,
+      options: GEOCODE_ACCURACY_OPTIONS,
+    },
+    MailingLatitude: {
+      type: "string",
+      label: "Mailing Latitude",
+      description:
+        "A number between -90 and 90 with up to 15 decimal places. Use with `Mailing Longitude` to specify the precise geolocation of a mailing address.",
+      optional: true,
+    },
+    MailingLongitude: {
+      type: "string",
+      label: "Mailing Longitude",
+      description:
+        "A number between -180 and 180 with up to 15 decimal places. Use with `Mailing Latitude` to specify the precise geolocation of a mailing address.",
+      optional: true,
+    },
+    MailingPostalCode: {
+      type: "string",
+      label: "Mailing Postal Code",
+      description: "The postal code of the contact's mailing address.",
+      optional: true,
+    },
+    MailingState: {
+      type: "string",
+      label: "Mailing State",
+      description: "The state of the contact's mailing address.",
+      optional: true,
+    },
+    MiddleName: {
+      type: "string",
+      label: "Middle Name",
+      description: "The contact's middle name, up to 40 characters.",
+      optional: true,
+    },
+    MobilePhone: {
+      type: "string",
+      label: "Mobile Phone",
+      description: "The contact's mobile phone number.",
+      optional: true,
+    },
+    Salutation: {
+      type: "string",
+      label: "Salutation",
+      description: "The contact's salutation.",
+      optional: true,
+      options: [
+        "Mr.",
+        "Ms.",
+        "Mrs.",
+        "Dr.",
+        "Prof.",
+        "Mx.",
+      ],
+    },
+    Suffix: {
+      type: "string",
+      label: "Suffix",
+      description: "Name suffix of the contact up to 40 characters.",
+      optional: true,
+    },
+    Title: {
+      type: "string",
+      label: "Title",
+      description: "Title of the contact, such as CEO or Vice President.",
+      optional: true,
+    },
   },
 };

package/common/sobjects/event.mjs

@@ -1,22 +1,222 @@
+import { // eslint-disable-next-line max-len
+  RECURRENCE_INSTANCE_OPTIONS, RECURRENCE_MONTH_OPTIONS, TIMEZONE_OPTIONS, RECURRENCE_TYPE_OPTIONS, WEEKDAY_MASK_OPTIONS,
+} from "../constants-props.mjs";
+import commonProps from "../props-async-options.mjs";
+
 export default {
-  AcceptedEventInviteeIds: {
-    type: "string",
-    label: "Accepted Event Invitee IDs",
-    description: "A string array of contact or lead IDs who accepted this event. This JunctionIdList is linked to the AcceptedEventRelation child relationship. Warning Adding a JunctionIdList field name to the fieldsToNull property deletes all related junction records. This action can't be undone.",
+  initialProps: {
+    AcceptedEventInviteeIds: {
+      ...commonProps.ContactOrLeadIds,
+      label: "Accepted Event Invitee IDs",
+      description: "One or more Contact or Lead IDs who accepted this event.",
+      optional: true,
+      async options() {
+        const contacts = await this.salesforce.listRecordOptions({
+          objType: "Contact",
+          nameField: "Name",
+        });
+        const leads = await this.salesforce.listRecordOptions({
+          objType: "Lead",
+          nameField: "Name",
+        });
+        return [
+          ...(contacts ?? []),
+          ...(leads ?? []),
+        ];
+      },
+    },
+    ActivityDate: {
+      type: "string",
+      label: "Due Date / Time",
+      description:
+        "The date/time (`ActivityDateTime`) of the event, or only the date (`ActivityDate`) if it is an all-day event.",
+    },
+    Description: {
+      type: "string",
+      label: "Description",
+      description: "A text description of the event. Limit: 32,000 characters.",
+      optional: true,
+    },
+    DurationInMinutes: {
+      type: "integer",
+      label: "Duration (in minutes)",
+      description: "The event length in minutes.",
+      optional: true,
+    },
+    EndDateTime: {
+      type: "string",
+      label: "End Date / Time",
+      description: "The date/time when the event ends.",
+      optional: true,
+    },
+    IsAllDayEvent: {
+      type: "boolean",
+      label: "All-Day Event",
+      description: "Whether the event is an all-day event.",
+      optional: true,
+    },
+    Location: {
+      type: "string",
+      label: "Location",
+      description: "The location of the event.",
+      optional: true,
+    },
   },
-  ActivityDate: {
-    type: "string",
-    label: "Activity Date",
-    description: "Contains the event's due date if the IsAllDayEvent flag is set to true. This field is a date field with a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. Don't attempt to alter the timestamp to account for time zone differences. Label is Due Date Only.This field is required in versions 12.0 and earlier if the IsAllDayEvent flag is set to true. The value for this field and StartDateTime must match, or one of them must be null.",
-  },
-  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.",
+  extraProps: {
+    DeclinedEventInviteeIds: {
+      ...commonProps.ContactOrLeadIds,
+      label: "Declined Event Invitee IDs",
+      description: "One or more Contact or Lead IDs who declined this event.",
+      optional: true,
+    },
+    UndecidedEventInviteeIds: {
+      ...commonProps.ContactOrLeadIds,
+      label: "Undecided Event Invitee IDs",
+      description: "One or more Contact or Lead IDs who are undecided about this event.",
+      optional: true,
+    },
+    OwnerId: {
+      ...commonProps.UserId,
+      label: "Assigned to ID",
+      description: "ID of the user or public calendar who owns the event.",
+      optional: true,
+    },
+    IsPrivate: {
+      type: "boolean",
+      label: "Private",
+      description:
+        "If true, users other than the creator of the event can't see the event details when viewing the event user's calendar.",
+      optional: true,
+    },
+    IsRecurrence: {
+      type: "boolean",
+      label: "Recurring Event",
+      description:
+        "Indicates whether a Salesforce Classic event is scheduled to repeat itself.",
+      optional: true,
+    },
+    IsReminderSet: {
+      type: "boolean",
+      label: "Reminder Set",
+      description: "Indicates whether the activity is a reminder.",
+      optional: true,
+    },
+    IsVisibleInSelfService: {
+      type: "boolean",
+      label: "Visible in Self-Service",
+      description:
+        "Indicates whether an event associated with an object can be viewed in the Customer Portal.",
+      optional: true,
+    },
+    RecurrenceDayOfMonth: {
+      type: "integer",
+      label: "Recurrence Day of Month",
+      description: "The day of the month on which the event repeats.",
+      optional: true,
+    },
+    RecurrenceDayOfWeekMask: {
+      type: "integer[]",
+      label: "Recurrence Day of Week",
+      description: "The day(s) of the week on which the event repeats.",
+      optional: true,
+      options: WEEKDAY_MASK_OPTIONS,
+    },
+    RecurrenceEndDateOnly: {
+      type: "string",
+      label: "Recurrence End Date",
+      description: "Indicates the last date on which the event repeats.",
+      optional: true,
+    },
+    RecurrenceInstance: {
+      type: "string",
+      label: "Recurrence Instance",
+      description:
+        "Indicates the frequency of the Salesforce Classic event's recurrence.",
+      optional: true,
+      options: RECURRENCE_INSTANCE_OPTIONS,
+    },
+    RecurrenceInterval: {
+      type: "integer",
+      label: "Recurrence Interval",
+      description:
+        "Indicates the interval between Salesforce Classic recurring events.",
+      optional: true,
+    },
+    RecurrenceMonthOfYear: {
+      type: "string",
+      label: "Recurrence Month of Year",
+      description:
+        "Indicates the month in which the Salesforce Classic recurring event repeats.",
+      optional: true,
+      options: RECURRENCE_MONTH_OPTIONS,
+    },
+    RecurrenceStartDateTime: {
+      type: "string",
+      label: "Recurrence Start Date / Time",
+      description:
+        "Indicates the date and time when the Salesforce Classic recurring event begins.",
+      optional: true,
+    },
+    RecurrenceTimeZoneSidKey: {
+      type: "string",
+      label: "Recurrence Time Zone",
+      description:
+        "Indicates the time zone associated with a Salesforce Classic recurring event.",
+      optional: true,
+      options: TIMEZONE_OPTIONS,
+    },
+    RecurrenceType: {
+      type: "string",
+      label: "Recurrence Type",
+      description: "Indicates how often the Salesforce Classic event repeats.",
+      optional: true,
+      options: RECURRENCE_TYPE_OPTIONS,
+    },
+    ReminderDateTime: {
+      type: "string",
+      label: "Reminder Date / Time",
+      description: "Represents the time when the reminder is scheduled to fire",
+      optional: true,
+    },
+    ShowAs: {
+      type: "string",
+      label: "Show As",
+      description:
+        "Indicates how this event appears when another user views the calendar.",
+      optional: true,
+      options: [
+        {
+          label: "Busy",
+          value: "Busy",
+        },
+        {
+          label: "Out of Office",
+          value: "OutOfOffice",
+        },
+        {
+          label: "Free",
+          value: "Free",
+        },
+      ],
+    },
+    StartDateTime: {
+      type: "string",
+      label: "Start Date / Time",
+      description: "Indicates the start date and time of the event.",
+      optional: true,
+    },
+    Subject: {
+      type: "string",
+      label: "Subject",
+      description: "The subject line of the event. Limit: 255 characters.",
+      optional: true,
+      options: [
+        "Call",
+        "Email",
+        "Meeting",
+        "Send Letter/Quote",
+        "Other",
+      ],
+    },
   },
 };