[ACTION] Sendgrid "Campaign sends" #14026

Actions
 - Create Send

Author: luancazarine

components/sendgrid/actions/add-email-to-global-suppression/add-email-to-global-suppression.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sendgrid-add-email-to-global-suppression",
   name: "Add Email to Global Suppression",
   description: "Allows you to add one or more email addresses to the global suppressions group. [See the docs here](https://sendgrid.api-docs.io/v3.0/suppressions-global-suppressions/add-recipient-addresses-to-the-global-suppression-group)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,

components/sendgrid/actions/add-or-update-contact/add-or-update-contact.mjs

@@ -6,7 +6,7 @@ export default {
   key: "sendgrid-add-or-update-contact",
   name: "Add or Update Contact",
   description: "Adds or updates a contact. [See the docs here](https://docs.sendgrid.com/api-reference/contacts/add-or-update-a-contact)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,

components/sendgrid/actions/create-contact-list/create-contact-list.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sendgrid-create-contact-list",
   name: "Create Contact List",
   description: "Allows you to create a new contact list. [See the docs here](https://docs.sendgrid.com/api-reference/lists/create-list)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,

components/sendgrid/actions/create-send/create-send.mjs

@@ -0,0 +1,159 @@
+import { ConfigurationError } from "@pipedream/platform";
+import { parseObject } from "../../common/utils.mjs";
+import common from "../common/common.mjs";
+
+export default {
+  ...common,
+  key: "sendgrid-create-send",
+  name: "Create Send",
+  description: "Create a single send. [See the docs here](https://www.twilio.com/docs/sendgrid/api-reference/single-sends/create-single-send)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the Single Send.",
+    },
+    categoryIds: {
+      propDefinition: [
+        common.props.sendgrid,
+        "categoryIds",
+      ],
+      optional: true,
+    },
+    sendAt: {
+      type: "string",
+      label: "Send At",
+      description: "Set this property to an ISO 8601 formatted date-time (YYYY-MM-DDTHH:MM:SSZ) when you would like to send the Single Send. Please note that any `send_at` property value set with this endpoint will prepopulate the send date in the SendGrid user interface (UI). However, the Single Send will remain an unscheduled draft until it's updated with the [Schedule Single Send](https://www.twilio.com/docs/sendgrid/api-reference/single-sends/schedule-single-send) endpoint or SendGrid application UI. Setting this property to `now` with this endpoint will cause an error.",
+      optional: true,
+    },
+    listIds: {
+      propDefinition: [
+        common.props.sendgrid,
+        "listIds",
+      ],
+      description: "The recipient List IDs that will receive the Single Send.",
+      optional: true,
+    },
+    segmentIds: {
+      propDefinition: [
+        common.props.sendgrid,
+        "segmentIds",
+      ],
+      optional: true,
+    },
+    all: {
+      type: "boolean",
+      label: "All",
+      description: "Set to `true` to send to All Contacts. If set to `false`, at least one `List Ids` or `Segment Ids` value must be provided before the Single Send is scheduled to be sent to recipients.",
+      optional: true,
+    },
+    subject: {
+      type: "string",
+      label: "Subject",
+      description: "The subject line of the Single Send. Do not include this field when using a `Design Id`.",
+      optional: true,
+    },
+    htmlContent: {
+      type: "string",
+      label: "HTML Content",
+      description: "The HTML content of the Single Send. Do not include this field when using a `Design Id`.",
+      optional: true,
+    },
+    plainContent: {
+      type: "string",
+      label: "Plain Content",
+      description: "The plain text content of the Single Send. Do not include this field when using a `Design Id`.",
+      optional: true,
+    },
+    generatePlainContent: {
+      type: "boolean",
+      label: "Generate Plain Content",
+      description: "If set to `true`, `Plain Content` is always generated from `HTML Content`. If set to false, `Plain Content` is not altered.",
+      optional: true,
+    },
+    designId: {
+      propDefinition: [
+        common.props.sendgrid,
+        "designId",
+      ],
+      optional: true,
+    },
+    editor: {
+      type: "string",
+      label: "Editor",
+      description: "The editor is used to modify the Single Send's design in the Marketing Campaigns App.",
+      options: [
+        "design",
+        "code",
+      ],
+      optional: true,
+    },
+    suppressionGroupId: {
+      type: "integer",
+      label: "Suppression Group Id",
+      description: "The ID of the Suppression Group to allow recipients to unsubscribe — you must provide this or the `Custom Unsubscribe URL`.",
+      optional: true,
+    },
+    customUnsubscribeUrl: {
+      type: "string",
+      label: "Custom Unsubscribe URL",
+      description: "The URL allowing recipients to unsubscribe — you must provide this or the `Suppression Group Id`.",
+      optional: true,
+    },
+    senderId: {
+      propDefinition: [
+        common.props.sendgrid,
+        "senderId",
+      ],
+      optional: true,
+    },
+    ipPool: {
+      type: "string",
+      label: "IP Pool",
+      description: "The name of the IP Pool from which the Single Send emails are sent.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    if (!this.suppressionGroupId && !this.customUnsubscribeUrl) {
+      throw new ConfigurationError("You must provide either `Suppression Goup Id` or the `Custom Unsubscribe URL`.");
+    }
+    try {
+      const resp = await this.sendgrid.createSingleSend({
+        $,
+        data: {
+          name: this.name,
+          categories: parseObject(this.categories),
+          send_at: this.sendAt,
+          send_to: {
+            list_ids: parseObject(this.listIds),
+            segment_ids: parseObject(this.segmentIds),
+            all: this.all,
+          },
+          email_config: {
+            subject: this.subject,
+            html_content: this.htmlContent,
+            plain_content: this.plainContent,
+            generate_plain_content: this.generatePlainContent,
+            design_id: this.designId,
+            editor: this.editor,
+            suppression_group_id: this.suppressionGroupId,
+            custom_unsubscribe_url: this.customUnsubscribeUrl,
+            sender_id: this.senderId,
+            ip_pool: this.ipPool,
+          },
+        },
+      });
+      $.export("$summary", `Successfully created contact ${this.name}`);
+      return resp;
+    } catch (e) {
+      const errors = e.split("Unexpected error (status code: ERR_BAD_REQUEST):")[1];
+      const errorJson = JSON.parse(errors);
+
+      throw new ConfigurationError(errorJson.data.errors[0].message);
+    }
+  },
+};

components/sendgrid/actions/delete-blocks/delete-blocks.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sendgrid-delete-blocks",
   name: "Delete Blocks",
   description: "Allows you to delete all email addresses on your blocks list. [See the docs here](https://docs.sendgrid.com/api-reference/blocks-api/delete-blocks)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,

components/sendgrid/actions/delete-bounces/delete-bounces.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sendgrid-delete-bounces",
   name: "Delete Bounces",
   description: "Allows you to delete all emails on your bounces list. [See the docs here](https://docs.sendgrid.com/api-reference/bounces-api/delete-bounces)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,

components/sendgrid/actions/delete-contacts/delete-contacts.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sendgrid-delete-contacts",
   name: "Delete Contacts",
   description: "Allows you to delete one or more contacts. [See the docs here](https://docs.sendgrid.com/api-reference/contacts/delete-contacts)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,

components/sendgrid/actions/delete-global-suppression/delete-global-suppression.mjs

@@ -6,7 +6,7 @@ export default {
   key: "sendgrid-delete-global-suppression",
   name: "Delete Global Suppression",
   description: "Allows you to remove an email address from the global suppressions group. [See the docs here](https://docs.sendgrid.com/api-reference/suppressions-global-suppressions/delete-a-global-suppression)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,

components/sendgrid/actions/delete-list/delete-list.mjs

@@ -5,7 +5,7 @@ export default {
   key: "sendgrid-delete-list",
   name: "Delete List",
   description: "Allows you to delete a specific contact list. [See the docs here](https://docs.sendgrid.com/api-reference/lists/delete-a-list)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,

components/sendgrid/actions/get-a-block/get-a-block.mjs

@@ -6,7 +6,7 @@ export default {
   key: "sendgrid-get-a-block",
   name: "Get a Block",
   description: "Gets a specific block. [See the docs here](https://docs.sendgrid.com/api-reference/blocks-api/retrieve-a-specific-block)",
-  version: "0.0.3",
+  version: "0.0.4",
   type: "action",
   props: {
     ...common.props,