@epilot/email-template-client - npm Package Compare versions

Comparing version 1.6.0 to 1.6.1

dist/openapi.d.ts

@@ -161,2 +161,8 @@ /* eslint-disable */
             /**
+             * Organization ID
+             * example:
+             * 206801
+             */
+            org_id?: string;
+            /**
              * Job ID for tracking the status of bulk message action
@@ -169,2 +175,3 @@ * example:
              * Status of the bulk message action
+             * * PROCESSING: Bulk message action is processing the request
              * * QUEUEING: Bulk message action is generating emails to send in a queue
@@ -177,4 +184,4 @@ * * SENDING: Bulk message action is sending emails from the queue
              */
-            status: "QUEUEING" | "SENDING" | "SUCCESS" | "FAILED" | "CANCELLED";
-            request: BulkSendMessageRequest;
+            status: "PROCESSING" | "QUEUEING" | "SENDING" | "SUCCESS" | "FAILED" | "CANCELLED";
+            request: BulkSendMessageRequest | BulkSendMessageRequestWithQuery;
             /**
@@ -187,2 +194,10 @@ * Total number of emails generated and queued for sending
             /**
+             * Time when the bulk message action was created
+             */
+            created_at?: string; // date-time
+            /**
+             * Time when the bulk message action was last updated
+             */
+            updated_at?: string; // date-time
+            /**
              * List of entity ids and message ids that were sent successfully
@@ -238,2 +253,16 @@ */
         }
+        export interface BulkSendMessageRequestWithQuery {
+            /**
+             * ID of email template to use for sending bulk emails
+             * example:
+             * 511ceb90-f738-47aa-8b1e-915ace0ae13c
+             */
+            email_template_id: string;
+            /**
+             * Entity search query to select recipients
+             * example:
+             * _schema:contact AND consent_email_marketing:active
+             */
+            recipient_query: string;
+        }
         export interface EmailTemplateEntity {
@@ -504,17 +533,4 @@ /**
     namespace BulkSendMessage {
-        export type RequestBody = {
+        export type RequestBody = Components.Schemas.BulkSendMessageRequestWithQuery | Components.Schemas.BulkSendMessageRequest | {
             /**
-             * ID of email template to use for sending bulk emails
-             * example:
-             * 511ceb90-f738-47aa-8b1e-915ace0ae13c
-             */
-            email_template_id: string;
-            /**
-             * Entity search query to select recipients
-             * example:
-             * _schema:contact AND consent_email_marketing:active
-             */
-            recipient_query: string;
-        } | Components.Schemas.BulkSendMessageRequest | {
-            /**
              * Job ID for tracking the status of a bulk message request
@@ -521,0 +537,0 @@ * example:

dist/openapi.json

@@ -15,3 +15,3 @@ {
       "name": "Variables",
-      "description": null
+      "description": "Variable service"
     }
@@ -227,19 +227,3 @@ ],
                   {
-                    "type": "object",
-                    "required": [
-                      "email_template_id",
-                      "recipient_query"
-                    ],
-                    "properties": {
-                      "email_template_id": {
-                        "type": "string",
-                        "description": "ID of email template to use for sending bulk emails",
-                        "example": "511ceb90-f738-47aa-8b1e-915ace0ae13c"
-                      },
-                      "recipient_query": {
-                        "type": "string",
-                        "description": "Entity search query to select recipients",
-                        "example": "_schema:contact AND consent_email_marketing:active"
-                      }
-                    }
+                    "$ref": "#/components/schemas/BulkSendMessageRequestWithQuery"
                   },
@@ -860,2 +844,21 @@ {
       },
+      "BulkSendMessageRequestWithQuery": {
+        "type": "object",
+        "required": [
+          "email_template_id",
+          "recipient_query"
+        ],
+        "properties": {
+          "email_template_id": {
+            "type": "string",
+            "description": "ID of email template to use for sending bulk emails",
+            "example": "511ceb90-f738-47aa-8b1e-915ace0ae13c"
+          },
+          "recipient_query": {
+            "type": "string",
+            "description": "Entity search query to select recipients",
+            "example": "_schema:contact AND consent_email_marketing:active"
+          }
+        }
+      },
       "BulkSendMessageJob": {
@@ -869,2 +872,8 @@ "type": "object",
         "properties": {
+          "org_id": {
+            "type": "string",
+            "description": "Organization ID",
+            "example": "206801",
+            "readonly": true
+          },
           "job_id": {
@@ -877,4 +886,5 @@ "type": "string",
             "type": "string",
-            "description": "Status of the bulk message action\n* QUEUEING: Bulk message action is generating emails to send in a queue\n* SENDING: Bulk message action is sending emails from the queue\n* SUCCESS: Bulk message action is completed successfully\n* FAILED: Bulk message action is failed\n* CANCELLED: Bulk message action was cancelled\n",
+            "description": "Status of the bulk message action\n* PROCESSING: Bulk message action is processing the request\n* QUEUEING: Bulk message action is generating emails to send in a queue\n* SENDING: Bulk message action is sending emails from the queue\n* SUCCESS: Bulk message action is completed successfully\n* FAILED: Bulk message action is failed\n* CANCELLED: Bulk message action was cancelled\n",
             "enum": [
+              "PROCESSING",
               "QUEUEING",
@@ -888,3 +898,10 @@ "SENDING",
           "request": {
-            "$ref": "#/components/schemas/BulkSendMessageRequest"
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/BulkSendMessageRequest"
+              },
+              {
+                "$ref": "#/components/schemas/BulkSendMessageRequestWithQuery"
+              }
+            ]
           },
@@ -896,2 +913,14 @@ "total_queued": {
           },
+          "created_at": {
+            "type": "string",
+            "description": "Time when the bulk message action was created",
+            "format": "date-time",
+            "readonly": true
+          },
+          "updated_at": {
+            "type": "string",
+            "description": "Time when the bulk message action was last updated",
+            "format": "date-time",
+            "readonly": true
+          },
           "sent": {
@@ -898,0 +927,0 @@ "type": "array",

package.json

 {
   "name": "@epilot/email-template-client",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "API Client for epilot Email Template API",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

64457

increased by2.33%

Lines of code

1916

increased by2.41%

No dependency changes