@bitblit/ratchet-misc/lib/brevo/generated/apis/SMSCampaignsApi.js

Ratchet miscellaneous tooling that requires smallish dependant libraries

import * as runtime from '../runtime.js';
import { CreatedProcessIdFromJSON, CreateModelFromJSON, CreateSmsCampaignToJSON, GetSmsCampaignFromJSON, GetSmsCampaignsFromJSON, RequestSmsRecipientExportToJSON, SendReportToJSON, SendTestSmsToJSON, UpdateCampaignStatusToJSON, UpdateSmsCampaignToJSON, } from '../models/index.js';
export class SMSCampaignsApi extends runtime.BaseAPI {
    async createSmsCampaignRaw(requestParameters, initOverrides) {
        if (requestParameters.createSmsCampaign === null || requestParameters.createSmsCampaign === undefined) {
            throw new runtime.RequiredError('createSmsCampaign', 'Required parameter requestParameters.createSmsCampaign was null or undefined when calling createSmsCampaign.');
        }
        const queryParameters = {};
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/smsCampaigns`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: CreateSmsCampaignToJSON(requestParameters.createSmsCampaign),
        }, initOverrides);
        return new runtime.JSONApiResponse(response, (jsonValue) => CreateModelFromJSON(jsonValue));
    }
    async createSmsCampaign(requestParameters, initOverrides) {
        const response = await this.createSmsCampaignRaw(requestParameters, initOverrides);
        return await response.value();
    }
    async deleteSmsCampaignRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling deleteSmsCampaign.');
        }
        const queryParameters = {};
        const headerParameters = {};
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/smsCampaigns/{campaignId}`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'DELETE',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async deleteSmsCampaign(requestParameters, initOverrides) {
        await this.deleteSmsCampaignRaw(requestParameters, initOverrides);
    }
    async getSmsCampaignRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling getSmsCampaign.');
        }
        const queryParameters = {};
        const headerParameters = {};
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/smsCampaigns/{campaignId}`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);
        return new runtime.JSONApiResponse(response, (jsonValue) => GetSmsCampaignFromJSON(jsonValue));
    }
    async getSmsCampaign(requestParameters, initOverrides) {
        const response = await this.getSmsCampaignRaw(requestParameters, initOverrides);
        return await response.value();
    }
    async getSmsCampaignsRaw(requestParameters, initOverrides) {
        const queryParameters = {};
        if (requestParameters.status !== undefined) {
            queryParameters['status'] = requestParameters.status;
        }
        if (requestParameters.startDate !== undefined) {
            queryParameters['startDate'] = requestParameters.startDate.toISOString();
        }
        if (requestParameters.endDate !== undefined) {
            queryParameters['endDate'] = requestParameters.endDate.toISOString();
        }
        if (requestParameters.limit !== undefined) {
            queryParameters['limit'] = requestParameters.limit;
        }
        if (requestParameters.offset !== undefined) {
            queryParameters['offset'] = requestParameters.offset;
        }
        const headerParameters = {};
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/smsCampaigns`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);
        return new runtime.JSONApiResponse(response, (jsonValue) => GetSmsCampaignsFromJSON(jsonValue));
    }
    async getSmsCampaigns(requestParameters = {}, initOverrides) {
        const response = await this.getSmsCampaignsRaw(requestParameters, initOverrides);
        return await response.value();
    }
    async requestSmsRecipientExportRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling requestSmsRecipientExport.');
        }
        const queryParameters = {};
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/smsCampaigns/{campaignId}/exportRecipients`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: RequestSmsRecipientExportToJSON(requestParameters.recipientExport),
        }, initOverrides);
        return new runtime.JSONApiResponse(response, (jsonValue) => CreatedProcessIdFromJSON(jsonValue));
    }
    async requestSmsRecipientExport(requestParameters, initOverrides) {
        const response = await this.requestSmsRecipientExportRaw(requestParameters, initOverrides);
        return await response.value();
    }
    async sendSmsCampaignNowRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling sendSmsCampaignNow.');
        }
        const queryParameters = {};
        const headerParameters = {};
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/smsCampaigns/{campaignId}/sendNow`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async sendSmsCampaignNow(requestParameters, initOverrides) {
        await this.sendSmsCampaignNowRaw(requestParameters, initOverrides);
    }
    async sendSmsReportRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling sendSmsReport.');
        }
        if (requestParameters.sendReport === null || requestParameters.sendReport === undefined) {
            throw new runtime.RequiredError('sendReport', 'Required parameter requestParameters.sendReport was null or undefined when calling sendSmsReport.');
        }
        const queryParameters = {};
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/smsCampaigns/{campaignId}/sendReport`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: SendReportToJSON(requestParameters.sendReport),
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async sendSmsReport(requestParameters, initOverrides) {
        await this.sendSmsReportRaw(requestParameters, initOverrides);
    }
    async sendTestSmsRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling sendTestSms.');
        }
        if (requestParameters.phoneNumber === null || requestParameters.phoneNumber === undefined) {
            throw new runtime.RequiredError('phoneNumber', 'Required parameter requestParameters.phoneNumber was null or undefined when calling sendTestSms.');
        }
        const queryParameters = {};
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/smsCampaigns/{campaignId}/sendTest`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: SendTestSmsToJSON(requestParameters.phoneNumber),
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async sendTestSms(requestParameters, initOverrides) {
        await this.sendTestSmsRaw(requestParameters, initOverrides);
    }
    async updateSmsCampaignRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling updateSmsCampaign.');
        }
        if (requestParameters.updateSmsCampaign === null || requestParameters.updateSmsCampaign === undefined) {
            throw new runtime.RequiredError('updateSmsCampaign', 'Required parameter requestParameters.updateSmsCampaign was null or undefined when calling updateSmsCampaign.');
        }
        const queryParameters = {};
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/smsCampaigns/{campaignId}`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'PUT',
            headers: headerParameters,
            query: queryParameters,
            body: UpdateSmsCampaignToJSON(requestParameters.updateSmsCampaign),
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async updateSmsCampaign(requestParameters, initOverrides) {
        await this.updateSmsCampaignRaw(requestParameters, initOverrides);
    }
    async updateSmsCampaignStatusRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling updateSmsCampaignStatus.');
        }
        if (requestParameters.status === null || requestParameters.status === undefined) {
            throw new runtime.RequiredError('status', 'Required parameter requestParameters.status was null or undefined when calling updateSmsCampaignStatus.');
        }
        const queryParameters = {};
        const headerParameters = {};
        headerParameters['Content-Type'] = 'application/json';
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/smsCampaigns/{campaignId}/status`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'PUT',
            headers: headerParameters,
            query: queryParameters,
            body: UpdateCampaignStatusToJSON(requestParameters.status),
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async updateSmsCampaignStatus(requestParameters, initOverrides) {
        await this.updateSmsCampaignStatusRaw(requestParameters, initOverrides);
    }
}
export var GetSmsCampaignsStatusEnum;
(function (GetSmsCampaignsStatusEnum) {
    GetSmsCampaignsStatusEnum["Suspended"] = "suspended";
    GetSmsCampaignsStatusEnum["Archive"] = "archive";
    GetSmsCampaignsStatusEnum["Sent"] = "sent";
    GetSmsCampaignsStatusEnum["Queued"] = "queued";
    GetSmsCampaignsStatusEnum["Draft"] = "draft";
    GetSmsCampaignsStatusEnum["InProcess"] = "inProcess";
})(GetSmsCampaignsStatusEnum || (GetSmsCampaignsStatusEnum = {}));
//# sourceMappingURL=SMSCampaignsApi.js.map