@pipedream/salesforce_rest_api 1.2.1 → 1.3.0

package/common/sobjects/attachment.mjs

@@ -1,22 +1,61 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
 export default {
-  ContentType: {
-    type: "string",
-    label: "Content Type",
-    description: "The content type of the attachment. If the Don't allow HTML uploads as attachments or document records security setting is enabled for your organization, you cannot upload files with the following file extensions: .htm, .html, .htt, .htx, .mhtm, .mhtml, .shtm, .shtml, .acgi, .svg. When you insert a document or attachment through the API, make sure that this field is set to the appropriate MIME type.",
+  createProps: {
+    Name: {
+      type: "string",
+      label: "File Name",
+      description: "Name of the attached file. Max 255 characters.",
+    },
+    filePathOrContent: {
+      type: "string",
+      label: "File Path or Content",
+      description: "The path to a file in the `tmp` folder [(see the documentation)](https://pipedream.com/docs/code/nodejs/working-with-files). Alternatively, you can provide the base64-encoded file data.",
+    },
+    ContentType: {
+      type: "string",
+      label: "Content Type",
+      description: "The content type (MIME type) of the attachment. For example, `image/png`.",
+    },
+    ParentId: {
+      type: "string",
+      label: "Parent ID",
+      description: "ID of the parent object of the attachment. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_attachment.htm) for supported objects.",
+    },
   },
-  Description: {
-    type: "string",
-    label: "Description",
-    description: "Description of the attachment. Maximum size is 500 characters. This field is available in API version 18.0 and later.",
+  updateProps: {
+    IsPartnerShared: {
+      type: "boolean",
+      label: "Is Shared With Partner",
+      description: "Whether this record is shared with a connection using Salesforce to Salesforce.",
+      optional: true,
+    },
   },
-  IsPrivate: {
-    type: "boolean",
-    label: "Is Private?",
-    description: "Indicates whether this record is viewable only by the owner and administrators (true) or viewable by all otherwise-allowed users (false). During a create or update call, it is possible to mark an Attachment record as private even if you are not the owner. This can result in a situation in which you can no longer access the record that you just inserted or updated. Label is Private.Attachments on tasks or events can't be marked private.",
-  },
-  OwnerId: {
-    type: "string",
-    label: "Owner ID",
-    description: "ID of the User who owns the attachment. This field was required previous to release 9.0. Beginning with release 9.0, it can be null on create. The owner of an attachment on a task or event must be the same as the owner of the task or event.",
+  initialProps: {
+    Description: {
+      type: "string",
+      label: "Description",
+      description: "Description of the attachment. Max 500 characters.",
+      optional: true,
+    },
+    IsPrivate: {
+      type: "boolean",
+      label: "Private",
+      description: "Whether this record is viewable only by the owner and administrators (true) or viewable by all otherwise-allowed users (false).",
+      optional: true,
+    },
+    OwnerId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "User",
+          nameField: "Name",
+        }),
+      ],
+      label: "Owner ID",
+      description: "ID of the user who owns the attachment.",
+      optional: true,
+    },
   },
 };

package/common/sobjects/campaign.mjs

@@ -1,27 +1,129 @@
+import commonProps from "../props-async-options.mjs";
+
 export default {
-  ActualCost: {
-    type: "string",
-    label: "Actual Cost",
-    description: "Amount of money spent to run the campaign.",
+  initialProps: {
+    Name: {
+      type: "string",
+      label: "Name",
+      description: "Name of the campaign. Max 80 characters.",
+    },
+    Description: {
+      type: "string",
+      label: "Description",
+      description:
+        "Description of the campaign. Limit: 32 KB. Only the first 255 characters display in reports.",
+      optional: true,
+    },
+    Status: {
+      type: "string",
+      label: "Status",
+      description: "Status of the campaign. Max 40 characters.",
+      optional: true,
+      options: [
+        "Planned",
+        "In Progress",
+        "Completed",
+        "Aborted",
+      ],
+    },
+    Type: {
+      type: "string",
+      label: "Type",
+      description: "Type of campaign. Max 40 characters.",
+      optional: true,
+      options: [
+        "Conference",
+        "Webinar",
+        "Trade Show",
+        "Public Relations",
+        "Partners",
+        "Referral Program",
+        "Advertisement",
+        "Banner Ads",
+        "Direct Mail",
+        "Email",
+        "Telemarketing",
+        "Other",
+      ],
+    },
   },
-  BudgetedCost: {
-    type: "string",
-    label: "Budgeted Cost",
-    description: "Amount of money budgeted for the campaign.",
-  },
-  CampaignImageId: {
-    type: "string",
-    label: "Campaign Image ID",
-    description: "ID of the campaign image. Available in API version 42.0 and later.",
-  },
-  CampaignMemberRecordTypeId: {
-    type: "string",
-    label: "Campaign Member Record Type ID",
-    description: "The record type ID for CampaignMember records associated with the campaign.",
-  },
-  Description: {
-    type: "string",
-    label: "Description",
-    description: "Description of the campaign. Limit: 32 KB. Only the first 255 characters display in reports.",
+  extraProps: {
+    OwnerId: {
+      ...commonProps.UserId,
+      label: "Owner ID",
+      description: "The ID of the user who owns this campaign (defaults to the user logged in).",
+      optional: true,
+    },
+    ParentCampaign: {
+      ...commonProps.CampaignId,
+      label: "Parent Campaign ID",
+      description: "The campaign above this one in the campaign hierarchy.",
+      optional: true,
+    },
+    RecordTypeId: {
+      ...commonProps.RecordTypeId,
+      optional: true,
+    },
+    StartDate: {
+      type: "string",
+      label: "Start Date",
+      description: "Starting date for the campaign.",
+      optional: true,
+    },
+    EndDate: {
+      type: "string",
+      label: "End Date",
+      description: "Ending date for the campaign. Responses received after this date are still counted.",
+      optional: true,
+    },
+    ActualCost: {
+      type: "string",
+      label: "Actual Cost",
+      description: "Amount of money spent to run the campaign.",
+      optional: true,
+    },
+    BudgetedCost: {
+      type: "string",
+      label: "Budgeted Cost",
+      description: "Amount of money budgeted for the campaign.",
+      optional: true,
+    },
+    CampaignImageId: {
+      type: "string",
+      label: "Campaign Image ID",
+      description: "ID of the campaign image.",
+      optional: true,
+    },
+    CurrencyIsoCode: {
+      type: "string",
+      label: "Currency ISO Code",
+      description:
+        "Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.",
+      optional: true,
+    },
+    ExpectedResponse: {
+      type: "string",
+      label: "Expected Response (%)",
+      description: "Percentage of responses you expect to receive for the campaign.",
+      optional: true,
+    },
+    ExpectedRevenue: {
+      type: "string",
+      label: "Expected Revenue",
+      description: "Amount of money you expect to generate from the campaign.",
+      optional: true,
+    },
+    IsActive: {
+      type: "boolean",
+      label: "Active",
+      description: "Indicates whether this campaign is active (default is `false`).",
+      optional: true,
+    },
+    NumberSent: {
+      type: "integer",
+      label: "Number Sent",
+      description: "Number of individuals targeted by the campaign. For example, the number of emails sent.",
+      optional: true,
+    },
   },
 };

package/common/sobjects/case.mjs

@@ -1,17 +1,197 @@
+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 case.",
+  initialProps: {
+    Description: {
+      type: "string",
+      label: "Description",
+      description: "A text description of the case. Limit: 32 KB.",
+      optional: true,
+    },
+    Status: {
+      type: "string",
+      label: "Status",
+      description: "The status of the case.",
+      optional: true,
+      options: [
+        "New",
+        "Working",
+        "Escalated",
+        "Closed",
+      ],
+    },
+    SuppliedEmail: {
+      type: "string",
+      label: "Email",
+      description: "The email address associated with the case.",
+      optional: true,
+    },
+    SuppliedName: {
+      type: "string",
+      label: "Name",
+      description: "The name of the case.",
+      optional: true,
+    },
   },
-  Description: {
-    type: "string",
-    label: "Description",
-    description: "A text description of the case. Limit: 32 KB.",
-  },
-  IsEscalated: {
-    type: "boolean",
-    label: "Is Escalated?",
-    description: "Indicates whether the case has been escalated (true) or not. A case's escalated state does not affect how you can use a case, or whether you can query, delete, or update it. You can set this flag via the API. Label is Escalated.",
+  extraProps: {
+    AccountId: {
+      ...commonProps.AccountId,
+      description: "ID of the Account associated with this case.",
+      optional: true,
+    },
+    BusinessHoursId: {
+      ...commonProps.BusinessHoursId,
+      description: "ID of the Business Hours associated with this case.",
+      optional: true,
+    },
+    CommunityId: {
+      ...commonProps.CommunityId,
+      description:
+        "ID of the [Community (Zone)](https://developer.salesforce.com/docs/atlas.en-us.228.0.object_reference.meta/object_reference/sforce_api_objects_community.htm) associated with this case.",
+      optional: true,
+    },
+    ContactId: {
+      ...commonProps.ContactId,
+      description: "ID of the Contact associated with this case.",
+      optional: true,
+    },
+    FeedItemId: {
+      ...commonProps.FeedItemId,
+      description: "ID of the question in Chatter associated with the case.",
+      optional: true,
+    },
+    OwnerId: {
+      ...commonProps.UserId,
+      description: "ID of the user who owns the case.",
+      optional: true,
+    },
+    ParentId: {
+      ...commonProps.CaseId,
+      description: "The ID of the parent case in the hierarchy.",
+      optional: true,
+    },
+    QuestionId: {
+      ...commonProps.QuestionId,
+      description:
+        "The question in the answers community that is associated with the case.",
+      optional: true,
+    },
+    RecordTypeId: {
+      ...commonProps.RecordTypeId,
+      optional: true,
+    },
+    ServiceContractId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "ServiceContract",
+          nameField: "Name",
+        }),
+      ],
+      label: "Service Contract ID",
+      description: "ID of the ServiceContract associated with the entitlement.",
+    },
+    IsEscalated: {
+      type: "boolean",
+      label: "Escalated",
+      description:
+        "Indicates whether the case has been escalated. A case's escalated state does not affect how you can use a case, or whether you can query, delete, or update it.",
+      optional: true,
+    },
+    IsStopped: {
+      type: "boolean",
+      label: "Is Stopped",
+      description:
+        "Indicates whether an entitlement process on a case is stopped.",
+      optional: true,
+    },
+    Language: {
+      type: "string",
+      label: "Language",
+      description: "The language of the case.",
+      optional: true,
+    },
+    Origin: {
+      type: "string",
+      label: "Case Origin",
+      description: "The source of the case.",
+      optional: true,
+      options: [
+        "Phone",
+        "Email",
+        "Web",
+      ],
+    },
+    Priority: {
+      type: "string",
+      label: "Priority",
+      description: "The importance or urgency of the case.",
+      optional: true,
+      options: [
+        "High",
+        "Medium",
+        "Low",
+      ],
+    },
+    Reason: {
+      type: "string",
+      label: "Reason",
+      description: "The reason why the case was created.",
+      optional: true,
+      options: [
+        "Installation",
+        "Equipment Complexity",
+        "Performance",
+        "Breakdown",
+        "Equipment Design",
+        "Feedback",
+        "Other",
+      ],
+    },
+    SlaStartDate: {
+      type: "string",
+      label: "SLA Start Date",
+      description: "The time that the case entered an entitlement process.",
+      optional: true,
+    },
+    SourceId: {
+      type: "string",
+      label: "Source ID",
+      description: "The ID of the social post source.",
+      optional: true,
+    },
+    Subject: {
+      type: "string",
+      label: "Subject",
+      description: "The subject of the case. Max 255 characters.",
+      optional: true,
+    },
+    SuppliedCompany: {
+      type: "string",
+      label: "Company",
+      description: "The company name that was entered when the case was created.",
+      optional: true,
+    },
+    SuppliedPhone: {
+      type: "string",
+      label: "Phone",
+      description: "The phone number that was entered when the case was created.",
+      optional: true,
+    },
+    Type: {
+      type: "string",
+      label: "Type",
+      description: "The type of case.",
+      optional: true,
+      options: [
+        "Mechanical",
+        "Electrical",
+        "Electronic",
+        "Structural",
+        "Other",
+      ],
+    },
   },
 };

package/common/sobjects/caseComment.mjs

@@ -1,7 +1,31 @@
+import salesforce from "../../salesforce_rest_api.app.mjs";
+
 export default {
-  CommentBody: {
-    type: "string",
-    label: "Comment Body",
-    description: "Text of the CaseComment. The maximum size of the comment body is 4,000 bytes. Label is Body.",
+  initialProps: {
+    CommentBody: {
+      type: "string",
+      label: "Body",
+      description: "Text of the CaseComment. Max size is 4,000 bytes.",
+      optional: true,
+    },
+    ParentId: {
+      propDefinition: [
+        salesforce,
+        "recordId",
+        () => ({
+          objType: "Case",
+          nameField: "CaseNumber",
+        }),
+      ],
+      label: "Parent Case ID",
+      description: "ID of the parent Case.",
+    },
+    IsPublished: {
+      type: "boolean",
+      label: "Is Published",
+      description:
+        "Indicates whether the CaseComment is visible to customers in the Self-Service portal.",
+      optional: true,
+    },
   },
 };