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

Ratchet miscellaneous tooling that requires smallish dependant libraries

import * as runtime from '../runtime.js';
import { AbTestCampaignResultFromJSON, CreatedProcessIdFromJSON, CreateEmailCampaignToJSON, CreateModelFromJSON, EmailExportRecipientsToJSON, GetEmailCampaignFromJSON, GetEmailCampaignsFromJSON, GetSharedTemplateUrlFromJSON, SendReportToJSON, SendTestEmailToJSON, UpdateCampaignStatusToJSON, UpdateEmailCampaignToJSON, UploadImageToGalleryToJSON, } from '../models/index.js';
export class EmailCampaignsApi extends runtime.BaseAPI {
    async createEmailCampaignRaw(requestParameters, initOverrides) {
        if (requestParameters.emailCampaigns === null || requestParameters.emailCampaigns === undefined) {
            throw new runtime.RequiredError('emailCampaigns', 'Required parameter requestParameters.emailCampaigns was null or undefined when calling createEmailCampaign.');
        }
        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: `/emailCampaigns`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: CreateEmailCampaignToJSON(requestParameters.emailCampaigns),
        }, initOverrides);
        return new runtime.JSONApiResponse(response, (jsonValue) => CreateModelFromJSON(jsonValue));
    }
    async createEmailCampaign(requestParameters, initOverrides) {
        const response = await this.createEmailCampaignRaw(requestParameters, initOverrides);
        return await response.value();
    }
    async deleteEmailCampaignRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling deleteEmailCampaign.');
        }
        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: `/emailCampaigns/{campaignId}`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'DELETE',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async deleteEmailCampaign(requestParameters, initOverrides) {
        await this.deleteEmailCampaignRaw(requestParameters, initOverrides);
    }
    async emailExportRecipientsRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling emailExportRecipients.');
        }
        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: `/emailCampaigns/{campaignId}/exportRecipients`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: EmailExportRecipientsToJSON(requestParameters.recipientExport),
        }, initOverrides);
        return new runtime.JSONApiResponse(response, (jsonValue) => CreatedProcessIdFromJSON(jsonValue));
    }
    async emailExportRecipients(requestParameters, initOverrides) {
        const response = await this.emailExportRecipientsRaw(requestParameters, initOverrides);
        return await response.value();
    }
    async getAbTestCampaignResultRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling getAbTestCampaignResult.');
        }
        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: `/emailCampaigns/{campaignId}/abTestCampaignResult`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);
        return new runtime.JSONApiResponse(response, (jsonValue) => AbTestCampaignResultFromJSON(jsonValue));
    }
    async getAbTestCampaignResult(requestParameters, initOverrides) {
        const response = await this.getAbTestCampaignResultRaw(requestParameters, initOverrides);
        return await response.value();
    }
    async getEmailCampaignRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling getEmailCampaign.');
        }
        const queryParameters = {};
        if (requestParameters.statistics !== undefined) {
            queryParameters['statistics'] = requestParameters.statistics;
        }
        const headerParameters = {};
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/emailCampaigns/{campaignId}`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);
        return new runtime.JSONApiResponse(response, (jsonValue) => GetEmailCampaignFromJSON(jsonValue));
    }
    async getEmailCampaign(requestParameters, initOverrides) {
        const response = await this.getEmailCampaignRaw(requestParameters, initOverrides);
        return await response.value();
    }
    async getEmailCampaignsRaw(requestParameters, initOverrides) {
        const queryParameters = {};
        if (requestParameters.type !== undefined) {
            queryParameters['type'] = requestParameters.type;
        }
        if (requestParameters.status !== undefined) {
            queryParameters['status'] = requestParameters.status;
        }
        if (requestParameters.statistics !== undefined) {
            queryParameters['statistics'] = requestParameters.statistics;
        }
        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;
        }
        if (requestParameters.excludeHtmlContent !== undefined) {
            queryParameters['excludeHtmlContent'] = requestParameters.excludeHtmlContent;
        }
        const headerParameters = {};
        if (this.configuration && this.configuration.apiKey) {
            headerParameters['api-key'] = await this.configuration.apiKey('api-key');
        }
        const response = await this.request({
            path: `/emailCampaigns`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);
        return new runtime.JSONApiResponse(response, (jsonValue) => GetEmailCampaignsFromJSON(jsonValue));
    }
    async getEmailCampaigns(requestParameters = {}, initOverrides) {
        const response = await this.getEmailCampaignsRaw(requestParameters, initOverrides);
        return await response.value();
    }
    async getSharedTemplateUrlRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling getSharedTemplateUrl.');
        }
        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: `/emailCampaigns/{campaignId}/sharedUrl`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);
        return new runtime.JSONApiResponse(response, (jsonValue) => GetSharedTemplateUrlFromJSON(jsonValue));
    }
    async getSharedTemplateUrl(requestParameters, initOverrides) {
        const response = await this.getSharedTemplateUrlRaw(requestParameters, initOverrides);
        return await response.value();
    }
    async sendEmailCampaignNowRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling sendEmailCampaignNow.');
        }
        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: `/emailCampaigns/{campaignId}/sendNow`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async sendEmailCampaignNow(requestParameters, initOverrides) {
        await this.sendEmailCampaignNowRaw(requestParameters, initOverrides);
    }
    async sendReportRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling sendReport.');
        }
        if (requestParameters.sendReport === null || requestParameters.sendReport === undefined) {
            throw new runtime.RequiredError('sendReport', 'Required parameter requestParameters.sendReport was null or undefined when calling sendReport.');
        }
        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: `/emailCampaigns/{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 sendReport(requestParameters, initOverrides) {
        await this.sendReportRaw(requestParameters, initOverrides);
    }
    async sendTestEmailRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling sendTestEmail.');
        }
        if (requestParameters.emailTo === null || requestParameters.emailTo === undefined) {
            throw new runtime.RequiredError('emailTo', 'Required parameter requestParameters.emailTo was null or undefined when calling sendTestEmail.');
        }
        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: `/emailCampaigns/{campaignId}/sendTest`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: SendTestEmailToJSON(requestParameters.emailTo),
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async sendTestEmail(requestParameters, initOverrides) {
        await this.sendTestEmailRaw(requestParameters, initOverrides);
    }
    async updateCampaignStatusRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling updateCampaignStatus.');
        }
        if (requestParameters.status === null || requestParameters.status === undefined) {
            throw new runtime.RequiredError('status', 'Required parameter requestParameters.status was null or undefined when calling updateCampaignStatus.');
        }
        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: `/emailCampaigns/{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 updateCampaignStatus(requestParameters, initOverrides) {
        await this.updateCampaignStatusRaw(requestParameters, initOverrides);
    }
    async updateEmailCampaignRaw(requestParameters, initOverrides) {
        if (requestParameters.campaignId === null || requestParameters.campaignId === undefined) {
            throw new runtime.RequiredError('campaignId', 'Required parameter requestParameters.campaignId was null or undefined when calling updateEmailCampaign.');
        }
        if (requestParameters.emailCampaign === null || requestParameters.emailCampaign === undefined) {
            throw new runtime.RequiredError('emailCampaign', 'Required parameter requestParameters.emailCampaign was null or undefined when calling updateEmailCampaign.');
        }
        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: `/emailCampaigns/{campaignId}`.replace(`{${'campaignId'}}`, encodeURIComponent(String(requestParameters.campaignId))),
            method: 'PUT',
            headers: headerParameters,
            query: queryParameters,
            body: UpdateEmailCampaignToJSON(requestParameters.emailCampaign),
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async updateEmailCampaign(requestParameters, initOverrides) {
        await this.updateEmailCampaignRaw(requestParameters, initOverrides);
    }
    async uploadImageToGalleryRaw(requestParameters, initOverrides) {
        if (requestParameters.uploadImage === null || requestParameters.uploadImage === undefined) {
            throw new runtime.RequiredError('uploadImage', 'Required parameter requestParameters.uploadImage was null or undefined when calling uploadImageToGallery.');
        }
        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: `/emailCampaigns/images`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: UploadImageToGalleryToJSON(requestParameters.uploadImage),
        }, initOverrides);
        return new runtime.VoidApiResponse(response);
    }
    async uploadImageToGallery(requestParameters, initOverrides) {
        await this.uploadImageToGalleryRaw(requestParameters, initOverrides);
    }
}
export var GetEmailCampaignStatisticsEnum;
(function (GetEmailCampaignStatisticsEnum) {
    GetEmailCampaignStatisticsEnum["GlobalStats"] = "globalStats";
    GetEmailCampaignStatisticsEnum["LinksStats"] = "linksStats";
    GetEmailCampaignStatisticsEnum["StatsByDomain"] = "statsByDomain";
    GetEmailCampaignStatisticsEnum["StatsByDevice"] = "statsByDevice";
    GetEmailCampaignStatisticsEnum["StatsByBrowser"] = "statsByBrowser";
})(GetEmailCampaignStatisticsEnum || (GetEmailCampaignStatisticsEnum = {}));
export var GetEmailCampaignsTypeEnum;
(function (GetEmailCampaignsTypeEnum) {
    GetEmailCampaignsTypeEnum["Classic"] = "classic";
    GetEmailCampaignsTypeEnum["Trigger"] = "trigger";
})(GetEmailCampaignsTypeEnum || (GetEmailCampaignsTypeEnum = {}));
export var GetEmailCampaignsStatusEnum;
(function (GetEmailCampaignsStatusEnum) {
    GetEmailCampaignsStatusEnum["Suspended"] = "suspended";
    GetEmailCampaignsStatusEnum["Archive"] = "archive";
    GetEmailCampaignsStatusEnum["Sent"] = "sent";
    GetEmailCampaignsStatusEnum["Queued"] = "queued";
    GetEmailCampaignsStatusEnum["Draft"] = "draft";
    GetEmailCampaignsStatusEnum["InProcess"] = "inProcess";
})(GetEmailCampaignsStatusEnum || (GetEmailCampaignsStatusEnum = {}));
export var GetEmailCampaignsStatisticsEnum;
(function (GetEmailCampaignsStatisticsEnum) {
    GetEmailCampaignsStatisticsEnum["GlobalStats"] = "globalStats";
    GetEmailCampaignsStatisticsEnum["LinksStats"] = "linksStats";
    GetEmailCampaignsStatisticsEnum["StatsByDomain"] = "statsByDomain";
})(GetEmailCampaignsStatisticsEnum || (GetEmailCampaignsStatisticsEnum = {}));
//# sourceMappingURL=EmailCampaignsApi.js.map