@pipedream/salesforce_rest_api 1.2.1 → 1.3.0

package/common/sobjects/lead.mjs

@@ -1,27 +1,250 @@
+import {
+  CLEAN_STATUS_OPTIONS, GEOCODE_ACCURACY_OPTIONS, RECORD_SOURCE_OPTIONS,
+} from "../constants-props.mjs";
+import commonProps from "../props-async-options.mjs";
+
 export default {
-  City: {
-    type: "string",
-    label: "City",
-    description: "City for the lead's address.",
+  createProps: {
+    IsConverted: {
+      type: "boolean",
+      label: "Converted",
+      description: "Indicates whether the lead has been converted",
+      optional: true,
+    },
   },
-  Country: {
-    type: "string",
-    label: "Country",
-    description: "The lead's country.",
+  initialProps: {
+    Company: {
+      type: "string",
+      label: "Company",
+      description: "The lead's company.",
+    },
+    Description: {
+      type: "string",
+      label: "Description",
+      description: "The lead's description.",
+      optional: true,
+    },
+    Email: {
+      type: "string",
+      label: "Email",
+      description: "The lead's email address.",
+      optional: true,
+    },
+    FirstName: {
+      type: "string",
+      label: "First Name",
+      description: "The lead's first name.",
+      optional: true,
+    },
+    LastName: {
+      type: "string",
+      label: "Last Name",
+      description: "The lead's last name.",
+    },
+    Phone: {
+      type: "string",
+      label: "Phone",
+      description: "The lead's phone number.",
+      optional: true,
+    },
   },
-  Description: {
-    type: "string",
-    label: "Description",
-    description: "The lead's description.",
-  },
-  Email: {
-    type: "string",
-    label: "Email",
-    description: "The lead's email address.",
-  },
-  FirstName: {
-    type: "string",
-    label: "First Name",
-    description: "The lead's first name up to 40 characters.",
+  extraProps: {
+    ConvertedAccountId: {
+      ...commonProps.AccountId,
+      label: "Converted Account ID",
+      description: "The account into which the lead converted.",
+      optional: true,
+    },
+    ConvertedContactId: {
+      ...commonProps.ContactId,
+      label: "Converted Contact ID",
+      description: "The contact into which the lead converted.",
+      optional: true,
+    },
+    ConvertedOpportunityId: {
+      ...commonProps.OpportunityId,
+      label: "Converted Opportunity ID",
+      description: "The opportunity into which the lead converted.",
+      optional: true,
+    },
+    IndividualId: {
+      ...commonProps.IndividualId,
+      label: "Individual ID",
+      description: "ID of the data privacy record associated with this lead.",
+      optional: true,
+    },
+    OwnerId: {
+      ...commonProps.UserId,
+      label: "Owner ID",
+      description: "ID of the lead's owner.",
+      optional: true,
+    },
+    RecordTypeId: {
+      ...commonProps.RecordTypeId,
+      optional: true,
+    },
+    AnnualRevenue: {
+      type: "string",
+      label: "Annual Revenue",
+      description: "Annual revenue for the lead's company.",
+      optional: true,
+    },
+    City: {
+      type: "string",
+      label: "City",
+      description: "City for the lead's address.",
+      optional: true,
+    },
+    CleanStatus: {
+      type: "string",
+      label: "Clean Status",
+      description:
+        "Indicates the record's clean status compared with Data.com.",
+      options: CLEAN_STATUS_OPTIONS,
+    },
+    CompanyDunsNumber: {
+      type: "string",
+      label: "Company D-U-N-S Number",
+      description:
+        "The Data Universal Numbering System (D-U-N-S) number (max 9 characters).",
+      optional: true,
+    },
+    Country: {
+      type: "string",
+      label: "Country",
+      description: "The lead's country.",
+      optional: true,
+    },
+    Fax: {
+      type: "string",
+      label: "Fax",
+      description: "The lead's fax number.",
+      optional: true,
+    },
+    HasOptedOutOfFax: {
+      type: "boolean",
+      label: "Fax Opt Out",
+      description:
+        "Indicates whether the lead doesn't want to receive faxes from Salesforce (`true`) or not (`false`)",
+      optional: true,
+    },
+    GeocodeAccuracy: {
+      type: "string",
+      label: "Geocode Accuracy",
+      description: "Accuracy level of the geocode for the address.",
+      optional: true,
+      options: GEOCODE_ACCURACY_OPTIONS,
+    },
+    Industry: {
+      type: "string",
+      label: "Industry",
+      description: "Industry in which the lead works.",
+      optional: true,
+    },
+    IsUnreadByOwner: {
+      type: "boolean",
+      label: "Unread by Owner",
+      description: "If true, lead has been assigned, but not yet viewed.",
+      optional: true,
+    },
+    Latitude: {
+      type: "string",
+      label: "Latitude",
+      description:
+        "A number between -90 and 90 with up to 15 decimal places. Use with `Longitude` to specify the precise geolocation of an address.",
+      optional: true,
+    },
+    Longitude: {
+      type: "string",
+      label: "Longitude",
+      description:
+        "A number between -180 and 180 with up to 15 decimal places. Use with `Latitude` to specify the precise geolocation of an address.",
+      optional: true,
+    },
+    LeadSource: {
+      type: "string",
+      label: "Lead Source",
+      description: "The lead's source.",
+      optional: true,
+      options: RECORD_SOURCE_OPTIONS,
+    },
+    MiddleName: {
+      type: "string",
+      label: "Middle Name",
+      description: "The lead's middle name up to 40 characters.",
+      optional: true,
+    },
+    MobilePhone: {
+      type: "string",
+      label: "Mobile Phone",
+      description: "The lead's mobile phone number.",
+      optional: true,
+    },
+    NumberOfEmployees: {
+      type: "integer",
+      label: "Employees",
+      description: "Number of employees at the lead's company.",
+      optional: true,
+    },
+    PostalCode: {
+      type: "string",
+      label: "Zip/Postal Code",
+      description: "The lead's postal code.",
+      optional: true,
+    },
+    Rating: {
+      type: "string",
+      label: "Rating",
+      description: "Rating of the lead.",
+      optional: true,
+      options: [
+        "Hot",
+        "Warm",
+        "Cold",
+      ],
+    },
+    State: {
+      type: "string",
+      label: "State/Province",
+      description: "State for the address of the lead.",
+      optional: true,
+    },
+    Status: {
+      type: "string",
+      label: "Status",
+      description: "Status code for this converted lead.",
+      optional: true,
+      options: [
+        "Open - Not Contacted",
+        "Working - Contacted",
+        "Closed - Converted",
+        "Closed - Not Converted",
+      ],
+    },
+    Street: {
+      type: "string",
+      label: "Street",
+      description: "Street number and name for the address of the lead.",
+      optional: true,
+    },
+    Suffix: {
+      type: "string",
+      label: "Suffix",
+      description: "The lead's name suffix up to 40 characters.",
+      optional: true,
+    },
+    Title: {
+      type: "string",
+      label: "Title",
+      description:
+        "Title for the lead, such as CFO or CEO. The maximum size is 128 characters. ",
+      optional: true,
+    },
+    Website: {
+      type: "string",
+      label: "Website",
+      description: "Website for the lead.",
+      optional: true,
+    },
   },
 };

package/common/sobjects/note.mjs

@@ -1,17 +1,40 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
 export default {
-  Body: {
-    type: "string",
-    label: "Body",
-    description: "Body of the note. Limited to 32 KB.",
-  },
-  IsPrivate: {
-    type: "boolean",
-    label: "Is Private",
-    description: "If true, only the note owner or a user with the “Modify All Data” permission can view the note or query it via the API. Note that if a user who does not have the “Modify All Data” permission sets this field to true on a note that they do not own, then they can no longer query, delete, or update the note.",
-  },
-  OwnerId: {
-    type: "string",
-    label: "Owner ID",
-    description: "ID of the user who owns the note.",
+  initialProps: {
+    Body: {
+      type: "string",
+      label: "Body",
+      description: "Body of the note. Limited to 32 KB.",
+    },
+    IsPrivate: {
+      type: "boolean",
+      label: "Private",
+      description: "If true, only the note owner or a user with the “Modify All Data” permission can view the note or query it via the API.",
+      optional: true,
+    },
+    OwnerId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "User",
+          nameField: "Name",
+        }),
+      ],
+      label: "Owner ID",
+      description: "ID of the user who owns the note.",
+      optional: true,
+    },
+    ParentId: {
+      type: "string",
+      label: "Parent ID",
+      description: "ID of the object associated with the note. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_note.htm) for which objects can be referenced.",
+    },
+    Title: {
+      type: "string",
+      label: "Title",
+      description: "Title of the note.",
+    },
   },
 };

package/common/sobjects/opportunity.mjs

@@ -1,27 +1,153 @@
+import { RECORD_SOURCE_OPTIONS } from "../constants-props.mjs";
+import commonProps from "../props-async-options.mjs";
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
 export default {
-  AccountId: {
-    type: "string",
-    label: "Account ID",
-    description: "ID of the account associated with this opportunity.",
+  createProps: {
+    ContactId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "Contact",
+          nameField: "Name",
+        }),
+      ],
+      label: "Contact ID",
+      description:
+        "ID of the contact associated with this opportunity, set as the primary contact.",
+      optional: true,
+    },
   },
-  Amount: {
-    type: "string",
-    label: "Amount",
-    description: "Estimated total sale amount. For opportunities with products, the amount is the sum of the related products. Any attempt to update this field, if the record has products, will be ignored. The update call will not be rejected, and other fields will be updated as specified, but the Amount will be unchanged.",
+  initialProps: {
+    CloseDate: {
+      type: "string",
+      label: "Close Date",
+      description: "Date when the opportunity is expected to close.",
+    },
+    Description: {
+      type: "string",
+      label: "Description",
+      description:
+        "Text description of the opportunity. Limit: 32,000 characters.",
+      optional: true,
+    },
+    Name: {
+      type: "string",
+      label: "Name",
+      description: "A name for this opportunity. Limit: 120 characters",
+    },
+    StageName: {
+      type: "string",
+      label: "Stage Name",
+      description:
+        "Current stage of this record. This controls several other fields on an opportunity.",
+      options: [
+        "Prospecting",
+        "Qualification",
+        "Needs Analysis",
+        "Value Proposition",
+        "Id. Decision Makers",
+        "Perception Analysis",
+        "Proposal/Price Quote",
+        "Negotiation/Review",
+        "Closed Won",
+        "Closed Lost",
+      ],
+    },
   },
-  CampaignId: {
-    type: "string",
-    label: "Campaign ID",
-    description: "ID of a related Campaign. This field is defined only for those organizations that have the campaign feature Campaigns enabled. The User must have read access rights to the cross-referenced Campaign object in order to create or update that campaign into this field on the opportunity.",
-  },
-  ContactId: {
-    type: "string",
-    label: "Contact ID",
-    description: "ID of the contact associated with this opportunity, set as the primary contact. Read-only field that is derived from the opportunity contact role, which is created at the same time the opportunity is created. This field can only be populated when it's created, and can't be updated. To update the value in this field, change the IsPrimary flag on the OpportunityContactRole associated with this opportunity. Available in API version 46.0 and later.",
-  },
-  ContractId: {
-    type: "string",
-    label: "Contract ID",
-    description: "ID of the contract that's associated with this opportunity.",
+  extraProps: {
+    AccountId: {
+      ...commonProps.AccountId,
+      description: "ID of the account associated with this opportunity.",
+      optional: true,
+    },
+    CampaignId: {
+      ...commonProps.CampaignId,
+      description: "ID of a related Campaign.",
+      optional: true,
+    },
+    OwnerId: {
+      ...commonProps.UserId,
+      description:
+        "ID of the User who has been assigned to work this opportunity.",
+      optional: true,
+    },
+    Pricebook2Id: {
+      ...commonProps.Pricebook2Id,
+      description: "ID of a related Pricebook2 object.",
+      optional: true,
+    },
+    RecordTypeId: {
+      ...commonProps.RecordTypeId,
+      optional: true,
+    },
+    Amount: {
+      type: "string",
+      label: "Amount",
+      description:
+        "Estimated total sale amount. For opportunities with products, the amount is the sum of the related products.",
+      optional: true,
+    },
+    ForecastCategoryName: {
+      type: "string",
+      label: "Forecast Category Name",
+      description: "The name of the forecast category.",
+      optional: true,
+      options: [
+        "Omitted",
+        "Pipeline",
+        "Best Case",
+        "Commit",
+        "Closed",
+      ],
+    },
+    IsExcludedFromTerritory2Filter: {
+      type: "boolean",
+      label: "Excluded from Filter",
+      description:
+        "Used for Filter-Based Opportunity Territory Assignment. Indicates whether the opportunity is excluded (`true`) or included (`false`) each time the APEX filter is executed.",
+      optional: true,
+    },
+    LeadSource: {
+      type: "string",
+      label: "Lead Source",
+      description:
+        "Source of this opportunity.",
+      optional: true,
+      options: RECORD_SOURCE_OPTIONS,
+    },
+    NextStep: {
+      type: "string",
+      label: "Next Step",
+      description:
+        "Description of next task in closing opportunity. Limit: 255 characters.",
+      optional: true,
+    },
+    Probability: {
+      type: "string",
+      label: "Probability (%)",
+      description:
+        "Percentage of estimated confidence in closing the opportunity.",
+      optional: true,
+    },
+    TotalOpportunityQuantity: {
+      type: "integer",
+      label: "Quantity",
+      description: "Number of items included in this opportunity.",
+      optional: true,
+    },
+    Type: {
+      type: "string",
+      label: "Opportunity Type",
+      description: "Type of opportunity.",
+      optional: true,
+      options: [
+        "Existing Customer - Upgrade",
+        "Existing Customer - Replacement",
+        "Existing Customer - Downgrade",
+        "New Customer",
+      ],
+    },
   },
 };