Parameter object for sendTransactionalEmail

Author: danrowden

README.md

@@ -391,29 +391,29 @@ Send a transactional email to a contact. [Learn about sending transactional emai
 #### Examples
 
 ```javascript
-const dataVariables = {
-  loginUrl: "https://myapp.com/login/",
-};
-const resp = await loops.sendTransactionalEmail(
-  "clfq6dinn000yl70fgwwyp82l",
-  "[email protected]",
-  dataVariables
-);
+const resp = await loops.sendTransactionalEmail({
+  transactionalId: "clfq6dinn000yl70fgwwyp82l",
+  email: "[email protected]",
+  dataVariables: {
+    loginUrl: "https://myapp.com/login/",
+  },
+});
 
 // Please contact us to enable attachments on your account.
-const attachments = [
-  {
-    filename: "presentation.pdf",
-    contentType: "application/pdf",
-    data: "JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPD...",
+const resp = await loops.sendTransactionalEmail({
+  transactionalId: "clfq6dinn000yl70fgwwyp82l",
+  email: "[email protected]",
+  dataVariables: {
+    loginUrl: "https://myapp.com/login/",
   },
-];
-const resp = await loops.sendTransactionalEmail(
-  "clfq6dinn000yl70fgwwyp82l",
-  "[email protected]",
-  dataVariables,
-  attachments
-);
+  attachments: [
+    {
+      filename: "presentation.pdf",
+      contentType: "application/pdf",
+      data: "JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPD...",
+    },
+  ]
+});
 ```
 
 #### Response
@@ -490,7 +490,8 @@ If your account has no custom fields, an empty list will be returned.
 
 ## Version history
 
-- `v2.2.0` (Jul 2, 2024) - Added new `addToAudience` option to [`sendTransactionalEmail()`](#sendtransactionalemail).
+- `v3.0.0` (Jul 2, 2024) - [`sendTransactionalEmail()`](#sendtransactionalemail) now accepts an object instead of separate parameters (breaking change).
+- `v2.2.0` (Jul 2, 2024) - Deprecated. Added new `addToAudience` option to [`sendTransactionalEmail()`](#sendtransactionalemail).
 - `v2.1.1` (Jun 20, 2024) - Added support for mailing lists in [`createContact()`](#createcontact), [`updateContact()`](#updatecontact) and [`sendEvent()`](#sendevent).
 - `v2.1.0` (Jun 19, 2024) - Added support for new [List mailing lists](#getmailinglists) endpoint.
 - `v2.0.0` (Apr 19, 2024)

src/index.ts

@@ -334,32 +334,37 @@ class LoopsClient {
   /**
    * Send a transactional email.
    *
-   * @param {string} transactionalId The ID of the transactional email to send.
-   * @param {string} email The email address of the recipient.
-   * @param {boolean} [addToAudience] Create a contact in your audience using the provided email address (if one doesn't already exist).
-   * @param {Object} [dataVariables] Data variables as defined by the transational email template.
-   * @param {Object[]} [attachments] File(s) to be sent along with the email message.
+   * @param {Object} params
+   * @param {string} params.transactionalId The ID of the transactional email to send.
+   * @param {string} params.email The email address of the recipient.
+   * @param {boolean} [params.addToAudience] Create a contact in your audience using the provided email address (if one doesn't already exist).
+   * @param {Object} [params.dataVariables] Data variables as defined by the transational email template.
+   * @param {Object[]} [params.attachments] File(s) to be sent along with the email message.
    *
    * @see https://loops.so/docs/api-reference/send-transactional-email
    *
    * @returns {Object} Confirmation or error response (JSON)
    */
-  async sendTransactionalEmail(
-    transactionalId: string,
-    email: string,
-    addToAudience?: boolean,
-    dataVariables?: TransactionalVariables,
-    attachments?: Array<TransactionalAttachment>
-  ): Promise<TransactionalResponse> {
-    const payload: {
-      transactionalId: string;
-      email: string;
-      addToAudience?: boolean;
-      dataVariables?: TransactionalVariables;
-      attachments?: Array<TransactionalAttachment>;
-    } = { transactionalId, email, addToAudience };
-    if (dataVariables) payload["dataVariables"] = dataVariables;
-    if (attachments) payload["attachments"] = attachments;
+  async sendTransactionalEmail({
+    transactionalId,
+    email,
+    addToAudience,
+    dataVariables,
+    attachments,
+  }: {
+    transactionalId: string;
+    email: string;
+    addToAudience?: boolean;
+    dataVariables?: TransactionalVariables;
+    attachments?: Array<TransactionalAttachment>;
+  }): Promise<TransactionalResponse> {
+    const payload = {
+      transactionalId,
+      email,
+      addToAudience,
+      dataVariables,
+      attachments,
+    };
     return this._makeQuery({
       path: "v1/transactional",
       method: "POST",
@@ -381,4 +386,4 @@ class LoopsClient {
   }
 }
 
-export { LoopsClient };
+export { LoopsClient };