pingram 1.0.31 → 1.0.32-alpha.1509

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

@@ -0,0 +1,846 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BroadcastsApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class BroadcastsApi extends runtime.BaseAPI {
+    /**
+     * Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.
+     */
+    async _deleteRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling _delete().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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 = `/broadcasts/{broadcastId}`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MessageResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Delete an email broadcast. Allowed for drafts, scheduled, paused, completed, and canceled broadcasts. Not allowed while status is sending.
+     */
+    async _delete(broadcastId, initOverrides) {
+        const response = await this._deleteRaw({ broadcastId: broadcastId }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * 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.
+     */
+    async archiveRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling archive().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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 = `/broadcasts/{broadcastId}/archive`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
+    }
+    /**
+     * 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.
+     */
+    async archive(broadcastId, initOverrides) {
+        const response = await this.archiveRaw({ broadcastId: broadcastId }, initOverrides);
+        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.
+     */
+    async cancelRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling cancel().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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 = `/broadcasts/{broadcastId}/cancel`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        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.
+     */
+    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.
+     */
+    async createRaw(requestParameters, initOverrides) {
+        if (requestParameters['createBroadcastRequest'] == null) {
+            throw new runtime.RequiredError('createBroadcastRequest', 'Required parameter "createBroadcastRequest" was null or undefined when calling create().');
+        }
+        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 = `/broadcasts`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateBroadcastRequestToJSON)(requestParameters['createBroadcastRequest'])
+        }, initOverrides);
+        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.
+     */
+    async create(createBroadcastRequest, initOverrides) {
+        const response = await this.createRaw({ createBroadcastRequest: createBroadcastRequest }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.
+     */
+    async getRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling get().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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 = `/broadcasts/{broadcastId}`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Get one email broadcast by ID, including the send-ready html body, optional internalTemplate (visual-editor source), and audience definition.
+     */
+    async get(broadcastId, initOverrides) {
+        const response = await this.getRaw({ broadcastId: broadcastId }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).
+     */
+    async getMetricsRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling getMetrics().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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 = `/broadcasts/{broadcastId}/metrics`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastMetricsResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Poll live email broadcast metrics: status, optional pausedReason or scheduleAt, and aggregate counters (total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed).
+     */
+    async getMetrics(broadcastId, initOverrides) {
+        const response = await this.getMetricsRaw({ broadcastId: broadcastId }, initOverrides);
+        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.
+     */
+    async listRaw(requestParameters, initOverrides) {
+        const queryParameters = {};
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+        if (requestParameters['nextToken'] != null) {
+            queryParameters['nextToken'] = requestParameters['nextToken'];
+        }
+        const headerParameters = {};
+        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 = `/broadcasts`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        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.
+     */
+    async list(limit, nextToken, initOverrides) {
+        const response = await this.listRaw({ limit: limit, nextToken: nextToken }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * 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.
+     */
+    async listRecipientsRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling listRecipients().');
+        }
+        const queryParameters = {};
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+        if (requestParameters['nextToken'] != null) {
+            queryParameters['nextToken'] = requestParameters['nextToken'];
+        }
+        const headerParameters = {};
+        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 = `/broadcasts/{broadcastId}/recipients`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListBroadcastRecipientsResponseFromJSON)(jsonValue));
+    }
+    /**
+     * 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.
+     */
+    async listRecipients(broadcastId, status, limit, nextToken, initOverrides) {
+        const response = await this.listRecipientsRaw({
+            broadcastId: broadcastId,
+            status: status,
+            limit: limit,
+            nextToken: nextToken
+        }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.
+     */
+    async pauseRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling pause().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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 = `/broadcasts/{broadcastId}/pause`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Pause an actively sending email broadcast. Status becomes paused with pausedReason PAUSED_BY_USER.
+     */
+    async pause(broadcastId, initOverrides) {
+        const response = await this.pauseRaw({ broadcastId: broadcastId }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.
+     */
+    async resumeRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling resume().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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 = `/broadcasts/{broadcastId}/resume`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Resume a paused email broadcast. Continues sending remaining recipients. Broadcasts paused for spam content cannot be resumed.
+     */
+    async resume(broadcastId, initOverrides) {
+        const response = await this.resumeRaw({ broadcastId: broadcastId }, initOverrides);
+        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.
+     */
+    async scheduleRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling schedule().');
+        }
+        if (requestParameters['scheduleBroadcastRequest'] == null) {
+            throw new runtime.RequiredError('scheduleBroadcastRequest', 'Required parameter "scheduleBroadcastRequest" was null or undefined when calling schedule().');
+        }
+        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 = `/broadcasts/{broadcastId}/schedule`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.ScheduleBroadcastRequestToJSON)(requestParameters['scheduleBroadcastRequest'])
+        }, initOverrides);
+        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.
+     */
+    async schedule(broadcastId, scheduleBroadcastRequest, initOverrides) {
+        const response = await this.scheduleRaw({
+            broadcastId: broadcastId,
+            scheduleBroadcastRequest: scheduleBroadcastRequest
+        }, initOverrides);
+        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.
+     */
+    async sendRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling send().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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 = `/broadcasts/{broadcastId}/send`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        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.
+     */
+    async send(broadcastId, initOverrides) {
+        const response = await this.sendRaw({ broadcastId: broadcastId }, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Restore an archived email broadcast to the default broadcast list.
+     */
+    async unarchiveRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling unarchive().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        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 = `/broadcasts/{broadcastId}/unarchive`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.BroadcastResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Restore an archived email broadcast to the default broadcast list.
+     */
+    async unarchive(broadcastId, initOverrides) {
+        const response = await this.unarchiveRaw({ broadcastId: broadcastId }, initOverrides);
+        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.
+     */
+    async updateRaw(requestParameters, initOverrides) {
+        if (requestParameters['broadcastId'] == null) {
+            throw new runtime.RequiredError('broadcastId', 'Required parameter "broadcastId" was null or undefined when calling update().');
+        }
+        if (requestParameters['updateBroadcastRequest'] == null) {
+            throw new runtime.RequiredError('updateBroadcastRequest', 'Required parameter "updateBroadcastRequest" was null or undefined when calling update().');
+        }
+        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 = `/broadcasts/{broadcastId}`;
+        urlPath = urlPath.replace(`{${'broadcastId'}}`, encodeURIComponent(String(requestParameters['broadcastId'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.UpdateBroadcastRequestToJSON)(requestParameters['updateBroadcastRequest'])
+        }, initOverrides);
+        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.
+     */
+    async update(broadcastId, updateBroadcastRequest, initOverrides) {
+        const response = await this.updateRaw({
+            broadcastId: broadcastId,
+            updateBroadcastRequest: updateBroadcastRequest
+        }, initOverrides);
+        return await response.value();
+    }
+}
+exports.BroadcastsApi = BroadcastsApi;