pingram 1.0.31 → 1.0.32-alpha.1510

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

@@ -0,0 +1,374 @@
+/**
+ * Pingram
+ * Internal API for notification delivery and management
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { BroadcastMetricsResponse, BroadcastResponse, CreateBroadcastRequest, ListBroadcastRecipientsResponse, ListBroadcastsResponse, MessageResponse, ScheduleBroadcastRequest, UpdateBroadcastRequest } from '../models/index';
+export interface DeleteRequest {
+    broadcastId: string;
+}
+export interface ArchiveRequest {
+    broadcastId: string;
+}
+export interface CancelRequest {
+    broadcastId: string;
+}
+export interface CreateRequest {
+    createBroadcastRequest: CreateBroadcastRequest;
+}
+export interface GetRequest {
+    broadcastId: string;
+}
+export interface GetMetricsRequest {
+    broadcastId: string;
+}
+export interface ListRequest {
+    limit?: number;
+    nextToken?: string;
+}
+export interface ListRecipientsRequest {
+    broadcastId: string;
+    status?: string;
+    limit?: number;
+    nextToken?: string;
+}
+export interface PauseRequest {
+    broadcastId: string;
+}
+export interface ResumeRequest {
+    broadcastId: string;
+}
+export interface ScheduleRequest {
+    broadcastId: string;
+    scheduleBroadcastRequest: ScheduleBroadcastRequest;
+}
+export interface SendRequest {
+    broadcastId: string;
+}
+export interface UnarchiveRequest {
+    broadcastId: string;
+}
+export interface UpdateRequest {
+    broadcastId: string;
+    updateBroadcastRequest: UpdateBroadcastRequest;
+}
+/**
+ * BroadcastsApi - interface
+ *
+ * @export
+ * @interface BroadcastsApiInterface
+ */
+export interface BroadcastsApiInterface {
+    /**
+     *
+     * @summary Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.
+     * @param {string} broadcastId Broadcast ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(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.
+     * @param {string} broadcastId Broadcast ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(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.
+     * @param {string} broadcastId Broadcast ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(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.
+     * @param {CreateBroadcastRequest} createBroadcastRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(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.
+     * @param {string} broadcastId Broadcast ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(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).
+     * @param {string} broadcastId Broadcast ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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).
+     */
+    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.
+     * @param {number} [limit] Max broadcasts to return (default 50)
+     * @param {string} [nextToken] Pagination token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(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.
+     * @param {string} broadcastId Broadcast ID
+     * @param {string} [status] Filter
+     * @param {number} [limit] Max recipients to return (default 50)
+     * @param {string} [nextToken] Pagination token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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.
+     */
+    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.
+     * @param {string} broadcastId Broadcast ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(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.
+     * @param {string} broadcastId Broadcast ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(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.
+     * @param {string} broadcastId Broadcast ID
+     * @param {ScheduleBroadcastRequest} scheduleBroadcastRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(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.
+     * @param {string} broadcastId Broadcast ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
+    /**
+     *
+     * @summary Restore an archived email broadcast to the default broadcast list.
+     * @param {string} broadcastId Broadcast ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BroadcastsApiInterface
+     */
+    unarchiveRaw(requestParameters: UnarchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
+    /**
+     * Restore an archived email broadcast to the default broadcast list.
+     */
+    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.
+     * @param {string} broadcastId Broadcast ID
+     * @param {UpdateBroadcastRequest} updateBroadcastRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof 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(broadcastId: string, updateBroadcastRequest: UpdateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
+}
+/**
+ *
+ */
+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.
+     */
+    _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(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.
+     */
+    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(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.
+     */
+    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(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.
+     */
+    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(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.
+     */
+    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(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).
+     */
+    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).
+     */
+    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.
+     */
+    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(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.
+     */
+    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.
+     */
+    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.
+     */
+    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(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.
+     */
+    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(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.
+     */
+    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(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.
+     */
+    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(broadcastId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
+    /**
+     * Restore an archived email broadcast to the default broadcast list.
+     */
+    unarchiveRaw(requestParameters: UnarchiveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BroadcastResponse>>;
+    /**
+     * Restore an archived email broadcast to the default broadcast list.
+     */
+    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.
+     */
+    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(broadcastId: string, updateBroadcastRequest: UpdateBroadcastRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BroadcastResponse>;
+}