pingram 1.0.39-alpha.1692 → 1.0.40-alpha.1693

package/dist/generated/src/apis/BroadcastsApi.d.ts

@@ -202,7 +202,7 @@ export interface BroadcastsApiInterface {
     resume(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      *
-     * @summary Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.
+     * @summary Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. Cancels any existing schedule when the broadcast is returned to draft via cancel.
      * @param {string} broadcastId Broadcast ID
      * @param {ScheduleBroadcastRequest} scheduleBroadcastRequest
      * @param {*} [options] Override http request option.
@@ -211,12 +211,12 @@ export interface BroadcastsApiInterface {
      */
     scheduleRaw(requestParameters: ScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
-     * Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.
+     * Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. Cancels any existing schedule when the broadcast is returned to draft via cancel.
      */
     schedule(broadcastId: string, scheduleBroadcastRequest: ScheduleBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      *
-     * @summary Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.
+     * @summary Send a draft email broadcast immediately. Requires a non-empty subject. Transitions status to sending and starts delivery.
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -224,7 +224,7 @@ export interface BroadcastsApiInterface {
      */
     sendRaw(requestParameters: SendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
-     * Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.
+     * Send a draft email broadcast immediately. Requires a non-empty subject. Transitions status to sending and starts delivery.
      */
     send(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
@@ -340,19 +340,19 @@ export declare class BroadcastsApi extends runtime.BaseAPI implements Broadcasts
      */
     resume(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     * Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.
+     * Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. Cancels any existing schedule when the broadcast is returned to draft via cancel.
      */
     scheduleRaw(requestParameters: ScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
-     * Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.
+     * Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. Cancels any existing schedule when the broadcast is returned to draft via cancel.
      */
     schedule(broadcastId: string, scheduleBroadcastRequest: ScheduleBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     * Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.
+     * Send a draft email broadcast immediately. Requires a non-empty subject. Transitions status to sending and starts delivery.
      */
     sendRaw(requestParameters: SendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
-     * Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.
+     * Send a draft email broadcast immediately. Requires a non-empty subject. Transitions status to sending and starts delivery.
      */
     send(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**

package/dist/generated/src/apis/BroadcastsApi.js

@@ -611,7 +611,7 @@ class BroadcastsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.
+     * Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. Cancels any existing schedule when the broadcast is returned to draft via cancel.
      */
     async scheduleRaw(requestParameters, initOverrides) {
         if (requestParameters['broadcastId'] == null) {
@@ -663,7 +663,7 @@ class BroadcastsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
     }
     /**
-     * Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Cancels any existing schedule when the broadcast is returned to draft via cancel.
+     * Schedule a draft email broadcast for a future ISO datetime (sendAt). Requires a non-empty subject. Cancels any existing schedule when the broadcast is returned to draft via cancel.
      */
     async schedule(broadcastId, scheduleBroadcastRequest, initOverrides) {
         const response = await this.scheduleRaw({
@@ -673,7 +673,7 @@ class BroadcastsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.
+     * Send a draft email broadcast immediately. Requires a non-empty subject. Transitions status to sending and starts delivery.
      */
     async sendRaw(requestParameters, initOverrides) {
         if (requestParameters['broadcastId'] == null) {
@@ -720,7 +720,7 @@ class BroadcastsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
     }
     /**
-     * Send a draft email broadcast immediately. Requires a non-empty subject. fromAddress must be the platform default sender or a domain verified for this account (Settings → Domain Verification). The platform default sender is for testing only (at most 10 recipients, heavily throttled). Transitions status to sending and starts delivery.
+     * Send a draft email broadcast immediately. Requires a non-empty subject. Transitions status to sending and starts delivery.
      */
     async send(broadcastId, initOverrides) {
         const response = await this.sendRaw({ broadcastId: broadcastId }, initOverrides);

package/dist/generated/src/apis/EmailApi.d.ts

@@ -39,7 +39,7 @@ export interface EmailApiInterface {
     deleteSuppressions(reason: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
     /**
      *
-     * @summary Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.
+     * @summary Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. To reach people outside your account, use an address on a verified domain. The shared Pingram address can only email the account itself and always sends as noreply.
      * @param {SendEmailRequest} sendEmailRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -47,7 +47,7 @@ export interface EmailApiInterface {
      */
     sendRaw(requestParameters: SendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendEmailApiResponse>>;
     /**
-     * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.
+     * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. To reach people outside your account, use an address on a verified domain. The shared Pingram address can only email the account itself and always sends as noreply.
      */
     send(sendEmailRequest: SendEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendEmailApiResponse>;
 }
@@ -64,11 +64,11 @@ export declare class EmailApi extends runtime.BaseAPI implements EmailApiInterfa
      */
     deleteSuppressions(reason: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
     /**
-     * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.
+     * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. To reach people outside your account, use an address on a verified domain. The shared Pingram address can only email the account itself and always sends as noreply.
      */
     sendRaw(requestParameters: SendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendEmailApiResponse>>;
     /**
-     * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.
+     * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. To reach people outside your account, use an address on a verified domain. The shared Pingram address can only email the account itself and always sends as noreply.
      */
     send(sendEmailRequest: SendEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendEmailApiResponse>;
 }

package/dist/generated/src/apis/EmailApi.js

@@ -108,7 +108,7 @@ class EmailApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.
+     * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. To reach people outside your account, use an address on a verified domain. The shared Pingram address can only email the account itself and always sends as noreply.
      */
     async sendRaw(requestParameters, initOverrides) {
         if (requestParameters['sendEmailRequest'] == null) {
@@ -156,7 +156,7 @@ class EmailApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SendEmailApiResponseFromJSON)(jsonValue));
     }
     /**
-     * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.
+     * Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. To reach people outside your account, use an address on a verified domain. The shared Pingram address can only email the account itself and always sends as noreply.
      */
     async send(sendEmailRequest, initOverrides) {
         const response = await this.sendRaw({ sendEmailRequest: sendEmailRequest }, initOverrides);

package/dist/generated/src/models/BroadcastResponse.d.ts

@@ -65,7 +65,7 @@ export interface BroadcastResponse {
      */
     fromName: string;
     /**
-     *
+     * From address. Use an address on a domain verified for this account to email other people. The shared address `noreply@pingram.io` can send a test broadcast only to your own account email as the sole recipient. Verify a domain to send to a wider audience.
      * @type {string}
      * @memberof BroadcastResponse
      */

package/dist/generated/src/models/CreateBroadcastRequest.d.ts

@@ -47,7 +47,7 @@ export interface CreateBroadcastRequest {
      */
     fromName: string;
     /**
-     *
+     * From address. Use an address on a domain verified for this account to email other people. The shared address `noreply@pingram.io` can send a test broadcast only to your own account email as the sole recipient. Verify a domain to send to a wider audience.
      * @type {string}
      * @memberof CreateBroadcastRequest
      */

package/dist/generated/src/models/ListBroadcastsResponseBroadcastsInner.d.ts

@@ -65,7 +65,7 @@ export interface ListBroadcastsResponseBroadcastsInner {
      */
     fromName: string;
     /**
-     *
+     * From address. Use an address on a domain verified for this account to email other people. The shared address `noreply@pingram.io` can send a test broadcast only to your own account email as the sole recipient. Verify a domain to send to a wider audience.
      * @type {string}
      * @memberof ListBroadcastsResponseBroadcastsInner
      */

package/dist/generated/src/models/LogsGetResponseLogsInner.d.ts

@@ -1136,6 +1136,7 @@ export declare const LogsGetResponseLogsInnerEmailFailedCodeEnum: {
     readonly COMPLAINT_VIRUS: "COMPLAINT_VIRUS";
     readonly SUPPRESSED_COMPLAINT: "SUPPRESSED_COMPLAINT";
     readonly SUPPRESSED_BOUNCE: "SUPPRESSED_BOUNCE";
+    readonly DOMAIN_VERIFICATION_REQUIRED: "DOMAIN_VERIFICATION_REQUIRED";
     readonly MISSING_EMAIL_RECIPIENT: "MISSING_EMAIL_RECIPIENT";
     readonly MISSING_EMAIL_SUBJECT: "MISSING_EMAIL_SUBJECT";
     readonly MISSING_EMAIL_HTML: "MISSING_EMAIL_HTML";

package/dist/generated/src/models/LogsGetResponseLogsInner.js

@@ -68,6 +68,7 @@ exports.LogsGetResponseLogsInnerEmailFailedCodeEnum = {
     COMPLAINT_VIRUS: 'COMPLAINT_VIRUS',
     SUPPRESSED_COMPLAINT: 'SUPPRESSED_COMPLAINT',
     SUPPRESSED_BOUNCE: 'SUPPRESSED_BOUNCE',
+    DOMAIN_VERIFICATION_REQUIRED: 'DOMAIN_VERIFICATION_REQUIRED',
     MISSING_EMAIL_RECIPIENT: 'MISSING_EMAIL_RECIPIENT',
     MISSING_EMAIL_SUBJECT: 'MISSING_EMAIL_SUBJECT',
     MISSING_EMAIL_HTML: 'MISSING_EMAIL_HTML',

package/dist/generated/src/models/UpdateBroadcastRequest.d.ts

@@ -47,7 +47,7 @@ export interface UpdateBroadcastRequest {
      */
     fromName?: string;
     /**
-     *
+     * From address. Use an address on a domain verified for this account to email other people. The shared address `noreply@pingram.io` can send a test broadcast only to your own account email as the sole recipient. Verify a domain to send to a wider audience.
      * @type {string}
      * @memberof UpdateBroadcastRequest
      */

package/dist/src/client.js

@@ -8,7 +8,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Pingram = void 0;
 const src_1 = require("../generated/src");
 // SDK version for User-Agent header (injected at codegen time)
-const SDK_VERSION = '1.0.39';
+const SDK_VERSION = '1.0.40';
 const USER_AGENT = `pingram-node/${SDK_VERSION}`;
 const src_2 = require("../generated/src");
 const src_3 = require("../generated/src");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pingram",
-  "version": "1.0.39-alpha.1692",
+  "version": "1.0.40-alpha.1693",
   "description": "Official Node.js SDK for Pingram - Send notifications via Email, SMS, Push, In-App, and more",
   "main": "dist/index.js",
   "module": "dist/index.js",