pingram 1.0.39 → 1.0.40-alpha.1695

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

@@ -23,7 +23,7 @@ export interface CreateAccountOperationRequest {
 export interface AccountsApiInterface {
     /**
      *
-     * @summary Create an additional account for the authenticated user
+     * @summary 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.
      * @param {CreateAccountRequest} createAccountRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -31,7 +31,7 @@ export interface AccountsApiInterface {
      */
     createAccountRaw(requestParameters: CreateAccountOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAccountResponse>>;
     /**
-     * Create an additional account for the authenticated user
+     * 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.
      */
     createAccount(createAccountRequest: CreateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAccountResponse>;
     /**
@@ -52,11 +52,11 @@ export interface AccountsApiInterface {
  */
 export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface {
     /**
-     * Create an additional account for the authenticated user
+     * 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.
      */
     createAccountRaw(requestParameters: CreateAccountOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAccountResponse>>;
     /**
-     * Create an additional account for the authenticated user
+     * 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.
      */
     createAccount(createAccountRequest: CreateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAccountResponse>;
     /**

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

@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
  */
 class AccountsApi extends runtime.BaseAPI {
     /**
-     * Create an additional account for the authenticated user
+     * 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.
      */
     async createAccountRaw(requestParameters, initOverrides) {
         if (requestParameters['createAccountRequest'] == null) {
@@ -102,7 +102,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateAccountResponseFromJSON)(jsonValue));
     }
     /**
-     * Create an additional account for the authenticated user
+     * 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.
      */
     async createAccount(createAccountRequest, initOverrides) {
         const response = await this.createAccountRaw({ createAccountRequest: createAccountRequest }, initOverrides);

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

@@ -67,7 +67,7 @@ export interface AddressesApiInterface {
     listAddresses(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountAddressesResponse>;
     /**
      *
-     * @summary Update an inbox prefix or display name.
+     * @summary Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
      * @param {UpdateAddressRequest} updateAddressRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -75,7 +75,7 @@ export interface AddressesApiInterface {
      */
     updateAddressRaw(requestParameters: UpdateAddressOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddressResponse>>;
     /**
-     * Update an inbox prefix or display name.
+     * Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
      */
     updateAddress(updateAddressRequest: UpdateAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddressResponse>;
 }
@@ -108,11 +108,11 @@ export declare class AddressesApi extends runtime.BaseAPI implements AddressesAp
      */
     listAddresses(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountAddressesResponse>;
     /**
-     * Update an inbox prefix or display name.
+     * Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
      */
     updateAddressRaw(requestParameters: UpdateAddressOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddressResponse>>;
     /**
-     * Update an inbox prefix or display name.
+     * Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
      */
     updateAddress(updateAddressRequest: UpdateAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddressResponse>;
 }

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

@@ -213,7 +213,7 @@ class AddressesApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Update an inbox prefix or display name.
+     * Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
      */
     async updateAddressRaw(requestParameters, initOverrides) {
         if (requestParameters['updateAddressRequest'] == null) {
@@ -261,7 +261,7 @@ class AddressesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AddressResponseFromJSON)(jsonValue));
     }
     /**
-     * Update an inbox prefix or display name.
+     * Update one inbox on this account. A new prefix deletes the old address, so mail to the previous address stops, and that address is not kept. displayName only relabels a custom inbox and does not change where mail is delivered. Does not create an inbox or change its domain.
      */
     async updateAddress(updateAddressRequest, initOverrides) {
         const response = await this.updateAddressRaw({ updateAddressRequest: updateAddressRequest }, initOverrides);

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

@@ -94,7 +94,7 @@ export interface BroadcastsApiInterface {
     archive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      *
-     * @summary Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
+     * @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.
      * @param {string} broadcastId Broadcast ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -102,12 +102,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. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
+     * 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(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 and cannot be added later. 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. 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.
      * @param {CreateBroadcastRequest} createBroadcastRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -115,7 +115,7 @@ 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 and cannot be added later. 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.
      */
     create(createBroadcastRequest: CreateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
@@ -146,7 +146,7 @@ export interface BroadcastsApiInterface {
     getMetrics(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastMetricsResponse>;
     /**
      *
-     * @summary List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. Paginate with limit (default 50, max 100) and nextToken.
+     * @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.
      * @param {number} [limit] Max broadcasts to return (default 50)
      * @param {string} [nextToken] Pagination token
      * @param {*} [options] Override http request option.
@@ -155,7 +155,7 @@ export interface BroadcastsApiInterface {
      */
     listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBroadcastsResponse>>;
     /**
-     * List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. 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.
      */
     list(limit?: number, nextToken?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBroadcastsResponse>;
     /**
@@ -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>;
     /**
@@ -242,7 +242,7 @@ export interface BroadcastsApiInterface {
     unarchive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
      *
-     * @summary Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
+     * @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.
      * @param {string} broadcastId Broadcast ID
      * @param {UpdateBroadcastRequest} updateBroadcastRequest
      * @param {*} [options] Override http request option.
@@ -251,7 +251,7 @@ export interface BroadcastsApiInterface {
      */
     updateRaw(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
-     * Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
+     * 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(broadcastId: string, updateBroadcastRequest: UpdateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
 }
@@ -276,19 +276,19 @@ export declare class BroadcastsApi extends runtime.BaseAPI implements Broadcasts
      */
     archive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
+     * 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.
      */
     cancelRaw(requestParameters: CancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
-     * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
+     * 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(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 and cannot be added later. 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.
      */
     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 and cannot be added later. 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.
      */
     create(createBroadcastRequest: CreateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
@@ -308,11 +308,11 @@ export declare class BroadcastsApi extends runtime.BaseAPI implements Broadcasts
      */
     getMetrics(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastMetricsResponse>;
     /**
-     * List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. 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.
      */
     listRaw(requestParameters: ListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBroadcastsResponse>>;
     /**
-     * List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. 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.
      */
     list(limit?: number, nextToken?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBroadcastsResponse>;
     /**
@@ -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>;
     /**
@@ -364,11 +364,11 @@ export declare class BroadcastsApi extends runtime.BaseAPI implements Broadcasts
      */
     unarchive(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
     /**
-     * Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
+     * 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.
      */
     updateRaw(requestParameters: UpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
     /**
-     * Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
+     * 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(broadcastId: string, updateBroadcastRequest: UpdateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
 }

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

@@ -162,7 +162,7 @@ class BroadcastsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
+     * 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.
      */
     async cancelRaw(requestParameters, initOverrides) {
         if (requestParameters['broadcastId'] == null) {
@@ -209,14 +209,14 @@ class BroadcastsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
     }
     /**
-     * Cancel an email broadcast. Scheduled broadcasts revert to draft and drop their schedule. Sending or paused broadcasts become canceled; remaining pending recipients are skipped.
+     * 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.
      */
     async cancel(broadcastId, initOverrides) {
         const response = await this.cancelRaw({ broadcastId: broadcastId }, initOverrides);
         return await response.value();
     }
     /**
-     * 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 and cannot be added later. 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.
      */
     async createRaw(requestParameters, initOverrides) {
         if (requestParameters['createBroadcastRequest'] == null) {
@@ -264,7 +264,7 @@ class BroadcastsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
     }
     /**
-     * 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 and cannot be added later. 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.
      */
     async create(createBroadcastRequest, initOverrides) {
         const response = await this.createRaw({ createBroadcastRequest: createBroadcastRequest }, initOverrides);
@@ -379,7 +379,7 @@ class BroadcastsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. 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.
      */
     async listRaw(requestParameters, initOverrides) {
         const queryParameters = {};
@@ -428,7 +428,7 @@ class BroadcastsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListBroadcastsResponseFromJSON)(jsonValue));
     }
     /**
-     * List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. 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.
      */
     async list(limit, nextToken, initOverrides) {
         const response = await this.listRaw({ limit: limit, nextToken: nextToken }, initOverrides);
@@ -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);
@@ -781,7 +781,7 @@ class BroadcastsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
+     * 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.
      */
     async updateRaw(requestParameters, initOverrides) {
         if (requestParameters['broadcastId'] == null) {
@@ -833,7 +833,7 @@ class BroadcastsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
     }
     /**
-     * Update a draft email broadcast (name, type, audience, sender, subject, html). html is the send-ready body. Send an empty replyToAddress to clear Reply-To. internalTemplate can be updated only when the broadcast was created with it; it cannot be added to an html-only broadcast or removed. Only drafts can be edited; scheduled or active broadcasts are locked.
+     * 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.
      */
     async update(broadcastId, updateBroadcastRequest, initOverrides) {
         const response = await this.updateRaw({

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

@@ -29,7 +29,7 @@ export interface StartDomainVerificationRequest {
 export interface DomainsApiInterface {
     /**
      *
-     * @summary Add and start verification for a new sender domain. Pass the domain only (not a full email address).
+     * @summary Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
      * @param {PostSendersRequestBody} postSendersRequestBody
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -37,7 +37,7 @@ export interface DomainsApiInterface {
      */
     addDomainRaw(requestParameters: AddDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetSendersResponseInner>>>;
     /**
-     * Add and start verification for a new sender domain. Pass the domain only (not a full email address).
+     * Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
      */
     addDomain(postSendersRequestBody: PostSendersRequestBody, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetSendersResponseInner>>;
     /**
@@ -55,14 +55,14 @@ export interface DomainsApiInterface {
     deleteDomain(sender: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResponse>;
     /**
      *
-     * @summary List sender domains configured for the account (for outbound email).
+     * @summary List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DomainsApiInterface
      */
     listDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetSendersResponseInner>>>;
     /**
-     * List sender domains configured for the account (for outbound email).
+     * List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
      */
     listDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetSendersResponseInner>>;
     /**
@@ -84,11 +84,11 @@ export interface DomainsApiInterface {
  */
 export declare class DomainsApi extends runtime.BaseAPI implements DomainsApiInterface {
     /**
-     * Add and start verification for a new sender domain. Pass the domain only (not a full email address).
+     * Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
      */
     addDomainRaw(requestParameters: AddDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetSendersResponseInner>>>;
     /**
-     * Add and start verification for a new sender domain. Pass the domain only (not a full email address).
+     * Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
      */
     addDomain(postSendersRequestBody: PostSendersRequestBody, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetSendersResponseInner>>;
     /**
@@ -100,11 +100,11 @@ export declare class DomainsApi extends runtime.BaseAPI implements DomainsApiInt
      */
     deleteDomain(sender: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessResponse>;
     /**
-     * List sender domains configured for the account (for outbound email).
+     * List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
      */
     listDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetSendersResponseInner>>>;
     /**
-     * List sender domains configured for the account (for outbound email).
+     * List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
      */
     listDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetSendersResponseInner>>;
     /**

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

@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
  */
 class DomainsApi extends runtime.BaseAPI {
     /**
-     * Add and start verification for a new sender domain. Pass the domain only (not a full email address).
+     * Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
      */
     async addDomainRaw(requestParameters, initOverrides) {
         if (requestParameters['postSendersRequestBody'] == null) {
@@ -102,7 +102,7 @@ class DomainsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetSendersResponseInnerFromJSON));
     }
     /**
-     * Add and start verification for a new sender domain. Pass the domain only (not a full email address).
+     * Start verification for a domain you already own so Pingram can use it for email. Pass a bare domain (example.com) or subdomain (mail.example.com). This does not purchase, transfer, renew, or control the domain, does not edit DNS, and does not disable sending or receiving on other platforms. It saves the domain on this Pingram account and returns DNS records for you to publish. Required DKIM lets Pingram send email from addresses on this domain once verification completes. Optional inbound MX, once you publish it, routes that domain\'s inbound email to Pingram. This call only begins verification. Publish the records, then start verification in the dashboard or with the start-verification API. Adding a domain that is already on the account returns the existing records.
      */
     async addDomain(postSendersRequestBody, initOverrides) {
         const response = await this.addDomainRaw({ postSendersRequestBody: postSendersRequestBody }, initOverrides);
@@ -163,7 +163,7 @@ class DomainsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * List sender domains configured for the account (for outbound email).
+     * List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
      */
     async listDomainsRaw(initOverrides) {
         const queryParameters = {};
@@ -206,7 +206,7 @@ class DomainsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetSendersResponseInnerFromJSON));
     }
     /**
-     * List sender domains configured for the account (for outbound email).
+     * List domains already added to this Pingram account for email. Each entry includes verification status and the DNS records Pingram expects you to publish. Does not search a registrar, purchase or transfer a domain, change DNS, or include domains that have not been added to this account.
      */
     async listDomains(initOverrides) {
         const response = await this.listDomainsRaw(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);