@bitblit/ratchet-misc
Version:
Ratchet miscellaneous tooling that requires smallish dependant libraries
159 lines • 7.61 kB
JavaScript
import * as runtime from '../runtime.js';
import { GetSmsEventReportFromJSON, GetTransacAggregatedSmsReportFromJSON, GetTransacSmsReportFromJSON, SendSmsFromJSON, SendTransacSmsToJSON, } from '../models/index.js';
export class TransactionalSMSApi extends runtime.BaseAPI {
async getSmsEventsRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters.limit !== undefined) {
queryParameters['limit'] = requestParameters.limit;
}
if (requestParameters.startDate !== undefined) {
queryParameters['startDate'] = requestParameters.startDate;
}
if (requestParameters.endDate !== undefined) {
queryParameters['endDate'] = requestParameters.endDate;
}
if (requestParameters.offset !== undefined) {
queryParameters['offset'] = requestParameters.offset;
}
if (requestParameters.days !== undefined) {
queryParameters['days'] = requestParameters.days;
}
if (requestParameters.phoneNumber !== undefined) {
queryParameters['phoneNumber'] = requestParameters.phoneNumber;
}
if (requestParameters.event !== undefined) {
queryParameters['event'] = requestParameters.event;
}
if (requestParameters.tags !== undefined) {
queryParameters['tags'] = requestParameters.tags;
}
if (requestParameters.sort !== undefined) {
queryParameters['sort'] = requestParameters.sort;
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters['api-key'] = await this.configuration.apiKey('api-key');
}
const response = await this.request({
path: `/transactionalSMS/statistics/events`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => GetSmsEventReportFromJSON(jsonValue));
}
async getSmsEvents(requestParameters = {}, initOverrides) {
const response = await this.getSmsEventsRaw(requestParameters, initOverrides);
return await response.value();
}
async getTransacAggregatedSmsReportRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters.startDate !== undefined) {
queryParameters['startDate'] = requestParameters.startDate;
}
if (requestParameters.endDate !== undefined) {
queryParameters['endDate'] = requestParameters.endDate;
}
if (requestParameters.days !== undefined) {
queryParameters['days'] = requestParameters.days;
}
if (requestParameters.tag !== undefined) {
queryParameters['tag'] = requestParameters.tag;
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters['api-key'] = await this.configuration.apiKey('api-key');
}
const response = await this.request({
path: `/transactionalSMS/statistics/aggregatedReport`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => GetTransacAggregatedSmsReportFromJSON(jsonValue));
}
async getTransacAggregatedSmsReport(requestParameters = {}, initOverrides) {
const response = await this.getTransacAggregatedSmsReportRaw(requestParameters, initOverrides);
return await response.value();
}
async getTransacSmsReportRaw(requestParameters, initOverrides) {
const queryParameters = {};
if (requestParameters.startDate !== undefined) {
queryParameters['startDate'] = requestParameters.startDate;
}
if (requestParameters.endDate !== undefined) {
queryParameters['endDate'] = requestParameters.endDate;
}
if (requestParameters.days !== undefined) {
queryParameters['days'] = requestParameters.days;
}
if (requestParameters.tag !== undefined) {
queryParameters['tag'] = requestParameters.tag;
}
if (requestParameters.sort !== undefined) {
queryParameters['sort'] = requestParameters.sort;
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters['api-key'] = await this.configuration.apiKey('api-key');
}
const response = await this.request({
path: `/transactionalSMS/statistics/reports`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => GetTransacSmsReportFromJSON(jsonValue));
}
async getTransacSmsReport(requestParameters = {}, initOverrides) {
const response = await this.getTransacSmsReportRaw(requestParameters, initOverrides);
return await response.value();
}
async sendTransacSmsRaw(requestParameters, initOverrides) {
if (requestParameters.sendTransacSms === null || requestParameters.sendTransacSms === undefined) {
throw new runtime.RequiredError('sendTransacSms', 'Required parameter requestParameters.sendTransacSms was null or undefined when calling sendTransacSms.');
}
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: `/transactionalSMS/sms`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: SendTransacSmsToJSON(requestParameters.sendTransacSms),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => SendSmsFromJSON(jsonValue));
}
async sendTransacSms(requestParameters, initOverrides) {
const response = await this.sendTransacSmsRaw(requestParameters, initOverrides);
return await response.value();
}
}
export var GetSmsEventsEventEnum;
(function (GetSmsEventsEventEnum) {
GetSmsEventsEventEnum["Bounces"] = "bounces";
GetSmsEventsEventEnum["HardBounces"] = "hardBounces";
GetSmsEventsEventEnum["SoftBounces"] = "softBounces";
GetSmsEventsEventEnum["Delivered"] = "delivered";
GetSmsEventsEventEnum["Sent"] = "sent";
GetSmsEventsEventEnum["Accepted"] = "accepted";
GetSmsEventsEventEnum["Unsubscription"] = "unsubscription";
GetSmsEventsEventEnum["Replies"] = "replies";
GetSmsEventsEventEnum["Blocked"] = "blocked";
GetSmsEventsEventEnum["Rejected"] = "rejected";
})(GetSmsEventsEventEnum || (GetSmsEventsEventEnum = {}));
export var GetSmsEventsSortEnum;
(function (GetSmsEventsSortEnum) {
GetSmsEventsSortEnum["Asc"] = "asc";
GetSmsEventsSortEnum["Desc"] = "desc";
})(GetSmsEventsSortEnum || (GetSmsEventsSortEnum = {}));
export var GetTransacSmsReportSortEnum;
(function (GetTransacSmsReportSortEnum) {
GetTransacSmsReportSortEnum["Asc"] = "asc";
GetTransacSmsReportSortEnum["Desc"] = "desc";
})(GetTransacSmsReportSortEnum || (GetTransacSmsReportSortEnum = {}));
//# sourceMappingURL=TransactionalSMSApi.js.map