@zyphr-dev/node-sdk 0.1.36 → 0.1.37

package/dist/index.cjs

@@ -1160,6 +1160,10 @@ __export(index_exports, {
   SendSmsResponseFromJSONTyped: () => SendSmsResponseFromJSONTyped,
   SendSmsResponseToJSON: () => SendSmsResponseToJSON,
   SendSmsResponseToJSONTyped: () => SendSmsResponseToJSONTyped,
+  SendTemplateTestEmailRequestFromJSON: () => SendTemplateTestEmailRequestFromJSON,
+  SendTemplateTestEmailRequestFromJSONTyped: () => SendTemplateTestEmailRequestFromJSONTyped,
+  SendTemplateTestEmailRequestToJSON: () => SendTemplateTestEmailRequestToJSON,
+  SendTemplateTestEmailRequestToJSONTyped: () => SendTemplateTestEmailRequestToJSONTyped,
   SendTestSmsDataFromJSON: () => SendTestSmsDataFromJSON,
   SendTestSmsDataFromJSONTyped: () => SendTestSmsDataFromJSONTyped,
   SendTestSmsDataToJSON: () => SendTestSmsDataToJSON,
@@ -2126,6 +2130,7 @@ __export(index_exports, {
   instanceOfSendSmsData: () => instanceOfSendSmsData,
   instanceOfSendSmsRequest: () => instanceOfSendSmsRequest,
   instanceOfSendSmsResponse: () => instanceOfSendSmsResponse,
+  instanceOfSendTemplateTestEmailRequest: () => instanceOfSendTemplateTestEmailRequest,
   instanceOfSendTestSmsData: () => instanceOfSendTestSmsData,
   instanceOfSendTestSmsRequest: () => instanceOfSendTestSmsRequest,
   instanceOfSendTestSmsResponse: () => instanceOfSendTestSmsResponse,
@@ -12081,6 +12086,36 @@ function SendSmsResponseToJSONTyped(value, ignoreDiscriminator = false) {
   };
 }
 
+// src/src/models/SendTemplateTestEmailRequest.ts
+function instanceOfSendTemplateTestEmailRequest(value) {
+  if (!("to" in value) || value["to"] === void 0) return false;
+  return true;
+}
+function SendTemplateTestEmailRequestFromJSON(json) {
+  return SendTemplateTestEmailRequestFromJSONTyped(json, false);
+}
+function SendTemplateTestEmailRequestFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "to": json["to"],
+    "variables": json["variables"] == null ? void 0 : json["variables"]
+  };
+}
+function SendTemplateTestEmailRequestToJSON(json) {
+  return SendTemplateTestEmailRequestToJSONTyped(json, false);
+}
+function SendTemplateTestEmailRequestToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "to": value["to"],
+    "variables": value["variables"]
+  };
+}
+
 // src/src/models/SendTestSmsData.ts
 function instanceOfSendTestSmsData(value) {
   return true;
@@ -23018,6 +23053,49 @@ var TemplatesApi = class extends BaseAPI {
     const response = await this.renderTemplateRaw({ id, renderTemplateRequest }, initOverrides);
     return await response.value();
   }
+  /**
+   * Render the template and send a one-off test email (dashboard JWT auth). Because this is a send-capable endpoint, a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`. 
+   * Send a test email using a template
+   */
+  async sendTemplateTestEmailRaw(requestParameters, initOverrides) {
+    if (requestParameters["id"] == null) {
+      throw new RequiredError(
+        "id",
+        'Required parameter "id" was null or undefined when calling sendTemplateTestEmail().'
+      );
+    }
+    if (requestParameters["sendTemplateTestEmailRequest"] == null) {
+      throw new RequiredError(
+        "sendTemplateTestEmailRequest",
+        'Required parameter "sendTemplateTestEmailRequest" was null or undefined when calling sendTemplateTestEmail().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    headerParameters["Content-Type"] = "application/json";
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token("DashboardAuth", []);
+      if (tokenString) {
+        headerParameters["Authorization"] = `Bearer ${tokenString}`;
+      }
+    }
+    const response = await this.request({
+      path: `/templates/{id}/test`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters["id"]))),
+      method: "POST",
+      headers: headerParameters,
+      query: queryParameters,
+      body: SendTemplateTestEmailRequestToJSON(requestParameters["sendTemplateTestEmailRequest"])
+    }, initOverrides);
+    return new VoidApiResponse(response);
+  }
+  /**
+   * Render the template and send a one-off test email (dashboard JWT auth). Because this is a send-capable endpoint, a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`. 
+   * Send a test email using a template
+   */
+  async sendTemplateTestEmail(id, sendTemplateTestEmailRequest, initOverrides) {
+    await this.sendTemplateTestEmailRaw({ id, sendTemplateTestEmailRequest }, initOverrides);
+  }
   /**
    * Update an existing template. Only provided fields are changed.
    * Update template
@@ -26657,6 +26735,10 @@ var SDK_VERSION = "0.1.0";
   SendSmsResponseFromJSONTyped,
   SendSmsResponseToJSON,
   SendSmsResponseToJSONTyped,
+  SendTemplateTestEmailRequestFromJSON,
+  SendTemplateTestEmailRequestFromJSONTyped,
+  SendTemplateTestEmailRequestToJSON,
+  SendTemplateTestEmailRequestToJSONTyped,
   SendTestSmsDataFromJSON,
   SendTestSmsDataFromJSONTyped,
   SendTestSmsDataToJSON,
@@ -27623,6 +27705,7 @@ var SDK_VERSION = "0.1.0";
   instanceOfSendSmsData,
   instanceOfSendSmsRequest,
   instanceOfSendSmsResponse,
+  instanceOfSendTemplateTestEmailRequest,
   instanceOfSendTestSmsData,
   instanceOfSendTestSmsRequest,
   instanceOfSendTestSmsResponse,