pingram 1.0.42 → 1.0.43-alpha.1742

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

@@ -55,6 +55,7 @@ const index_1 = require("../models/index");
 class AccountsApi extends runtime.BaseAPI {
     /**
      * Create one additional Pingram account (a separate workspace) for the signed-in user. The caller must already belong to an account. Requires a user session or personal access token; an account API key cannot call this. Does not create a login, and does not change, delete, or grant access to existing accounts. Omit plan and nothing is charged. The new account is ready for billing to be added later, and it cannot send until then. Setting plan charges immediately. It starts a paid subscription on the payment method already saved on sourceBillingAccountId, an account the caller must own. Optional memberEmails adds people who already share an account with the caller and invites everyone else.
+     * Create another Pingram account
      */
     async createAccountRaw(requestParameters, initOverrides) {
         if (requestParameters['createAccountRequest'] == null) {
@@ -103,6 +104,7 @@ class AccountsApi extends runtime.BaseAPI {
     }
     /**
      * Create one additional Pingram account (a separate workspace) for the signed-in user. The caller must already belong to an account. Requires a user session or personal access token; an account API key cannot call this. Does not create a login, and does not change, delete, or grant access to existing accounts. Omit plan and nothing is charged. The new account is ready for billing to be added later, and it cannot send until then. Setting plan charges immediately. It starts a paid subscription on the payment method already saved on sourceBillingAccountId, an account the caller must own. Optional memberEmails adds people who already share an account with the caller and invites everyone else.
+     * Create another Pingram account
      */
     async createAccount(createAccountRequest, initOverrides) {
         const response = await this.createAccountRaw({ createAccountRequest: createAccountRequest }, initOverrides);
@@ -158,5 +160,66 @@ class AccountsApi extends runtime.BaseAPI {
         const response = await this.listAccountsRaw(initOverrides);
         return await response.value();
     }
+    /**
+     * Change the display name of an account the caller can access. The name is the label shown in the dashboard and in account lists.
+     * Change the display name of an account
+     */
+    async updateAccountRaw(requestParameters, initOverrides) {
+        if (requestParameters['accountId'] == null) {
+            throw new runtime.RequiredError('accountId', 'Required parameter "accountId" was null or undefined when calling updateAccount().');
+        }
+        if (requestParameters['updateAccountRequest'] == null) {
+            throw new runtime.RequiredError('updateAccountRequest', 'Required parameter "updateAccountRequest" was null or undefined when calling updateAccount().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token('apiKey', []);
+            if (tokenString) {
+                headerParameters['Authorization'] = `Bearer ${tokenString}`;
+            }
+        }
+        if (this.configuration &&
+            (this.configuration.username !== undefined ||
+                this.configuration.password !== undefined)) {
+            headerParameters['Authorization'] =
+                'Basic ' +
+                    btoa(this.configuration.username + ':' + this.configuration.password);
+        }
+        let urlPath = `/accounts/{accountId}`;
+        urlPath = urlPath.replace(`{${'accountId'}}`, encodeURIComponent(String(requestParameters['accountId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.UpdateAccountRequestToJSON)(requestParameters['updateAccountRequest'])
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AccountSummaryFromJSON)(jsonValue));
+    }
+    /**
+     * Change the display name of an account the caller can access. The name is the label shown in the dashboard and in account lists.
+     * Change the display name of an account
+     */
+    async updateAccount(accountId, updateAccountRequest, initOverrides) {
+        const response = await this.updateAccountRaw({ accountId: accountId, updateAccountRequest: updateAccountRequest }, initOverrides);
+        return await response.value();
+    }
 }
 exports.AccountsApi = AccountsApi;

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

@@ -67,8 +67,8 @@ export interface UpdateRequest {
  */
 export interface BroadcastsApiInterface {
     /**
-     *
-     * @summary Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.
+     * Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.
+     * @summary Delete an email broadcast
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -77,11 +77,12 @@ export interface BroadcastsApiInterface {
     _deleteRaw(requestParameters: DeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
     /**
      * Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.
+     * Delete an email broadcast
      */
     _delete(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
     /**
-     *
-     * @summary Archive an email broadcast so it is hidden from the default broadcast list. Allowed for draft, paused, sent, and canceled broadcasts. Not allowed while sending or scheduled.
+     * Archive an email broadcast so it is hidden from the default broadcast list. Allowed for draft, paused, sent, and canceled broadcasts. Not allowed while sending or scheduled.
+     * @summary Archive an email broadcast
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -90,11 +91,12 @@ export interface BroadcastsApiInterface {
     archiveRaw(requestParameters: ArchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Archive an email broadcast so it is hidden from the default broadcast list. Allowed for draft, paused, sent, and canceled broadcasts. Not allowed while sending or scheduled.
+     * Archive an email broadcast
      */
     archive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     *
-     * @summary Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
+     * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
+     * @summary Cancel an email broadcast
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -103,11 +105,12 @@ export interface BroadcastsApiInterface {
     cancelRaw(requestParameters: CancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
+     * Cancel an email broadcast
      */
     cancel(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     *
-     * @summary Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html. A later update can add it to a draft by sending it with html. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
+     * Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html. A later update can add it to a draft by sending it with html. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
+     * @summary Create a draft email broadcast
      * @param {CreateBroadcastRequest} createBroadcastRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -116,11 +119,12 @@ export interface BroadcastsApiInterface {
     createRaw(requestParameters: CreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html. A later update can add it to a draft by sending it with html. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
+     * Create a draft email broadcast
      */
     create(createBroadcastRequest: CreateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     *
-     * @summary Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.
+     * Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.
+     * @summary Get one email broadcast by ID
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -129,11 +133,12 @@ export interface BroadcastsApiInterface {
     getRaw(requestParameters: GetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.
+     * Get one email broadcast by ID
      */
     get(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     *
-     * @summary Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).
+     * Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).
+     * @summary Get live broadcast metrics
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -142,11 +147,12 @@ export interface BroadcastsApiInterface {
     getMetricsRaw(requestParameters: GetMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastMetricsResponse>>;
     /**
      * Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).
+     * Get live broadcast metrics
      */
     getMetrics(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastMetricsResponse>;
     /**
-     *
-     * @summary List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
+     * List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
+     * @summary List email broadcasts for the account, newest first
      * @param {number} [limit] Max broadcasts to return (default 50)
      * @param {string} [nextToken] Pagination token
      * @param {*} [options] Override http request option.
@@ -156,11 +162,12 @@ export interface BroadcastsApiInterface {
     listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBroadcastsResponse>>;
     /**
      * List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
+     * List email broadcasts for the account, newest first
      */
     list(limit?: number, nextToken?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBroadcastsResponse>;
     /**
-     *
-     * @summary List email broadcast recipients with per-recipient delivery fact timestamps (sentAt, deliveredAt, openedAt, etc.). Derive display status client-side from timestamps. Filter by status (pending, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed, problems). Paginate with limit (default 50, max 200) and nextToken.
+     * List email broadcast recipients with per-recipient delivery fact timestamps (sentAt, deliveredAt, openedAt, etc.). Derive display status client-side from timestamps. Filter by status (pending, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed, problems). Paginate with limit (default 50, max 200) and nextToken.
+     * @summary List email broadcast recipients
      * @param {string} broadcastId Broadcast ID
      * @param {string} [status] Filter
      * @param {number} [limit] Max recipients to return (default 50)
@@ -172,11 +179,12 @@ export interface BroadcastsApiInterface {
     listRecipientsRaw(requestParameters: ListRecipientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBroadcastRecipientsResponse>>;
     /**
      * List email broadcast recipients with per-recipient delivery fact timestamps (sentAt, deliveredAt, openedAt, etc.). Derive display status client-side from timestamps. Filter by status (pending, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed, problems). Paginate with limit (default 50, max 200) and nextToken.
+     * List email broadcast recipients
      */
     listRecipients(broadcastId: string, status?: string, limit?: number, nextToken?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBroadcastRecipientsResponse>;
     /**
-     *
-     * @summary Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.
+     * Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.
+     * @summary Pause an actively sending email broadcast
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -185,11 +193,12 @@ export interface BroadcastsApiInterface {
     pauseRaw(requestParameters: PauseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.
+     * Pause an actively sending email broadcast
      */
     pause(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     *
-     * @summary Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.
+     * Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.
+     * @summary Resume a paused email broadcast
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -198,11 +207,12 @@ export interface BroadcastsApiInterface {
     resumeRaw(requestParameters: ResumeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.
+     * Resume a paused email broadcast
      */
     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. 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.
+     * @summary Schedule a draft email broadcast for a future ISO datetime
      * @param {string} broadcastId Broadcast ID
      * @param {ScheduleBroadcastRequest} scheduleBroadcastRequest
      * @param {*} [options] Override http request option.
@@ -212,11 +222,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. Cancels any existing schedule when the broadcast is returned to draft via cancel.
+     * Schedule a draft email broadcast for a future ISO datetime
      */
     schedule(broadcastId: string, scheduleBroadcastRequest: ScheduleBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     *
-     * @summary Send a draft email broadcast immediately. Requires a non-empty subject. 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.
+     * @summary Send a draft email broadcast immediately
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -225,11 +236,12 @@ 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. Transitions status to sending and starts delivery.
+     * Send a draft email broadcast immediately
      */
     send(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     *
-     * @summary Restore an archived email broadcast to the default broadcast list.
+     * Restore an archived email broadcast to the default broadcast list.
+     * @summary Restore an archived email broadcast
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -238,11 +250,12 @@ export interface BroadcastsApiInterface {
     unarchiveRaw(requestParameters: UnarchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Restore an archived email broadcast to the default broadcast list.
+     * Restore an archived email broadcast
      */
     unarchive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     *
-     * @summary Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate is visual-editor source: send it with html to add it to an html-only draft or to update it. It cannot be removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
+     * Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate is visual-editor source: send it with html to add it to an html-only draft or to update it. It cannot be removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
+     * @summary Update a draft email broadcast
      * @param {string} broadcastId Broadcast ID
      * @param {UpdateBroadcastRequest} updateBroadcastRequest
      * @param {*} [options] Override http request option.
@@ -252,6 +265,7 @@ export interface BroadcastsApiInterface {
     updateRaw(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate is visual-editor source: send it with html to add it to an html-only draft or to update it. It cannot be removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
+     * Update a draft email broadcast
      */
     update(broadcastId: string, updateBroadcastRequest: UpdateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
 }
@@ -261,114 +275,142 @@ export interface BroadcastsApiInterface {
 export declare class BroadcastsApi extends runtime.BaseAPI implements BroadcastsApiInterface {
     /**
      * Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.
+     * Delete an email broadcast
      */
     _deleteRaw(requestParameters: DeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
     /**
      * Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.
+     * Delete an email broadcast
      */
     _delete(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
     /**
      * Archive an email broadcast so it is hidden from the default broadcast list. Allowed for draft, paused, sent, and canceled broadcasts. Not allowed while sending or scheduled.
+     * Archive an email broadcast
      */
     archiveRaw(requestParameters: ArchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Archive an email broadcast so it is hidden from the default broadcast list. Allowed for draft, paused, sent, and canceled broadcasts. Not allowed while sending or scheduled.
+     * Archive an email broadcast
      */
     archive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
+     * Cancel an email broadcast
      */
     cancelRaw(requestParameters: CancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule (they can be scheduled again). Sending or paused broadcasts become canceled; recipients already processed stay as they are, and remaining pending recipients are skipped and will not be sent. That skip cannot be undone.
+     * Cancel an email broadcast
      */
     cancel(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      * Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html. A later update can add it to a draft by sending it with html. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
+     * Create a draft email broadcast
      */
     createRaw(requestParameters: CreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Create a draft email broadcast. html is the send-ready body. Optional internalTemplate is visual-editor source; if set it must be paired with html. A later update can add it to a draft by sending it with html. Set audience to either a Mongo-style user filter (sync users via Users API first; for large lists) or a raw email list (max 10,000). Include name, from fields, subject, and HTML. Notification type is optional on create and required before send or schedule; it is created automatically if missing.
+     * Create a draft email broadcast
      */
     create(createBroadcastRequest: CreateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      * Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.
+     * Get one email broadcast by ID
      */
     getRaw(requestParameters: GetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.
+     * Get one email broadcast by ID
      */
     get(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      * Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).
+     * Get live broadcast metrics
      */
     getMetricsRaw(requestParameters: GetMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastMetricsResponse>>;
     /**
      * Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).
+     * Get live broadcast metrics
      */
     getMetrics(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastMetricsResponse>;
     /**
      * List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
+     * List email broadcasts for the account, newest first
      */
     listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBroadcastsResponse>>;
     /**
      * List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.
+     * List email broadcasts for the account, newest first
      */
     list(limit?: number, nextToken?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBroadcastsResponse>;
     /**
      * List email broadcast recipients with per-recipient delivery fact timestamps (sentAt, deliveredAt, openedAt, etc.). Derive display status client-side from timestamps. Filter by status (pending, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed, problems). Paginate with limit (default 50, max 200) and nextToken.
+     * List email broadcast recipients
      */
     listRecipientsRaw(requestParameters: ListRecipientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBroadcastRecipientsResponse>>;
     /**
      * List email broadcast recipients with per-recipient delivery fact timestamps (sentAt, deliveredAt, openedAt, etc.). Derive display status client-side from timestamps. Filter by status (pending, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed, problems). Paginate with limit (default 50, max 200) and nextToken.
+     * List email broadcast recipients
      */
     listRecipients(broadcastId: string, status?: string, limit?: number, nextToken?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBroadcastRecipientsResponse>;
     /**
      * Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.
+     * Pause an actively sending email broadcast
      */
     pauseRaw(requestParameters: PauseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.
+     * Pause an actively sending email broadcast
      */
     pause(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      * Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.
+     * Resume a paused email broadcast
      */
     resumeRaw(requestParameters: ResumeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.
+     * Resume a paused email broadcast
      */
     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. Cancels any existing schedule when the broadcast is returned to draft via cancel.
+     * Schedule a draft email broadcast for a future ISO datetime
      */
     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. Cancels any existing schedule when the broadcast is returned to draft via cancel.
+     * Schedule a draft email broadcast for a future ISO datetime
      */
     schedule(broadcastId: string, scheduleBroadcastRequest: ScheduleBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      * Send a draft email broadcast immediately. Requires a non-empty subject. Transitions status to sending and starts delivery.
+     * Send a draft email broadcast immediately
      */
     sendRaw(requestParameters: SendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Send a draft email broadcast immediately. Requires a non-empty subject. Transitions status to sending and starts delivery.
+     * Send a draft email broadcast immediately
      */
     send(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      * Restore an archived email broadcast to the default broadcast list.
+     * Restore an archived email broadcast
      */
     unarchiveRaw(requestParameters: UnarchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Restore an archived email broadcast to the default broadcast list.
+     * Restore an archived email broadcast
      */
     unarchive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      * Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate is visual-editor source: send it with html to add it to an html-only draft or to update it. It cannot be removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
+     * Update a draft email broadcast
      */
     updateRaw(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
      * Update a draft email broadcast. Fields you send replace the stored values (name, type, audience, sender, subject, html) and the previous values are not kept; omitted fields stay. html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate is visual-editor source: send it with html to add it to an html-only draft or to update it. It cannot be removed. Only drafts can be edited; scheduled or active broadcasts are locked. This does not send the broadcast.
+     * Update a draft email broadcast
      */
     update(broadcastId: string, updateBroadcastRequest: UpdateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
 }