UNPKG

mailslurp-client

Version:

Official client for MailSlurp Email and SMS API. Create email addresses and phone numbers in Javascript without a mail server. Send and receive real emails in applications or tests.

487 lines (486 loc) 25.2 kB
"use strict"; /* tslint:disable */ /* eslint-disable */ /** * MailSlurp API * MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It\'s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository * * The version of the OpenAPI document: 6.5.2 * Contact: contact@mailslurp.dev * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ var __extends = (this && this.__extends) || (function () { var extendStatics = function (d, b) { extendStatics = Object.setPrototypeOf || ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) || function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; }; return extendStatics(d, b); }; return function (d, b) { if (typeof b !== "function" && b !== null) throw new TypeError("Class extends value " + String(b) + " is not a constructor or null"); extendStatics(d, b); function __() { this.constructor = d; } d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __()); }; })(); 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 (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k); __setModuleDefault(result, mod); return result; }; var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } return new (P || (P = Promise))(function (resolve, reject) { function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } step((generator = generator.apply(thisArg, _arguments || [])).next()); }); }; var __generator = (this && this.__generator) || function (thisArg, body) { var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g; return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g; function verb(n) { return function (v) { return step([n, v]); }; } function step(op) { if (f) throw new TypeError("Generator is already executing."); while (g && (g = 0, op[0] && (_ = 0)), _) try { if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t; if (y = 0, t) op = [op[0] & 2, t.value]; switch (op[0]) { case 0: case 1: t = op; break; case 4: _.label++; return { value: op[1], done: false }; case 5: _.label++; y = op[1]; op = [0]; continue; case 7: op = _.ops.pop(); _.trys.pop(); continue; default: if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; } if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; } if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; } if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; } if (t[2]) _.ops.pop(); _.trys.pop(); continue; } op = body.call(thisArg, _); } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; } if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true }; } }; Object.defineProperty(exports, "__esModule", { value: true }); exports.GetSmsMessagesPaginatedSortEnum = exports.SmsControllerApi = void 0; var runtime = __importStar(require("../runtime")); var models_1 = require("../models"); /** * */ var SmsControllerApi = /** @class */ (function (_super) { __extends(SmsControllerApi, _super); function SmsControllerApi() { return _super !== null && _super.apply(this, arguments) || this; } /** * Delete an SMS message * Delete SMS message. */ SmsControllerApi.prototype.deleteSmsMessageRaw = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { var queryParameters, headerParameters, response; return __generator(this, function (_a) { switch (_a.label) { case 0: if (requestParameters.smsId === null || requestParameters.smsId === undefined) { throw new runtime.RequiredError('smsId', 'Required parameter requestParameters.smsId was null or undefined when calling deleteSmsMessage.'); } queryParameters = {}; headerParameters = {}; if (this.configuration && this.configuration.apiKey) { headerParameters['x-api-key'] = this.configuration.apiKey('x-api-key'); // API_KEY authentication } return [4 /*yield*/, this.request({ path: "/sms/{smsId}".replace("{".concat('smsId', "}"), encodeURIComponent(String(requestParameters.smsId))), method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.VoidApiResponse(response)]; } }); }); }; /** * Delete an SMS message * Delete SMS message. */ SmsControllerApi.prototype.deleteSmsMessage = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) { switch (_a.label) { case 0: return [4 /*yield*/, this.deleteSmsMessageRaw(requestParameters, initOverrides)]; case 1: _a.sent(); return [2 /*return*/]; } }); }); }; /** * Delete all SMS messages or all messages for a given phone number * Delete all SMS messages */ SmsControllerApi.prototype.deleteSmsMessagesRaw = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { var queryParameters, headerParameters, response; return __generator(this, function (_a) { switch (_a.label) { case 0: queryParameters = {}; if (requestParameters.phoneNumberId !== undefined) { queryParameters['phoneNumberId'] = requestParameters.phoneNumberId; } headerParameters = {}; if (this.configuration && this.configuration.apiKey) { headerParameters['x-api-key'] = this.configuration.apiKey('x-api-key'); // API_KEY authentication } return [4 /*yield*/, this.request({ path: "/sms", method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.VoidApiResponse(response)]; } }); }); }; /** * Delete all SMS messages or all messages for a given phone number * Delete all SMS messages */ SmsControllerApi.prototype.deleteSmsMessages = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) { switch (_a.label) { case 0: return [4 /*yield*/, this.deleteSmsMessagesRaw(requestParameters, initOverrides)]; case 1: _a.sent(); return [2 /*return*/]; } }); }); }; /** * Get reply for an SMS message. * Get reply for an SMS message */ SmsControllerApi.prototype.getReplyForSmsMessageRaw = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { var queryParameters, headerParameters, response; return __generator(this, function (_a) { switch (_a.label) { case 0: if (requestParameters.smsId === null || requestParameters.smsId === undefined) { throw new runtime.RequiredError('smsId', 'Required parameter requestParameters.smsId was null or undefined when calling getReplyForSmsMessage.'); } queryParameters = {}; headerParameters = {}; if (this.configuration && this.configuration.apiKey) { headerParameters['x-api-key'] = this.configuration.apiKey('x-api-key'); // API_KEY authentication } return [4 /*yield*/, this.request({ path: "/sms/{smsId}/reply".replace("{".concat('smsId', "}"), encodeURIComponent(String(requestParameters.smsId))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ReplyForSmsFromJSON)(jsonValue); })]; } }); }); }; /** * Get reply for an SMS message. * Get reply for an SMS message */ SmsControllerApi.prototype.getReplyForSmsMessage = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { var response; return __generator(this, function (_a) { switch (_a.label) { case 0: return [4 /*yield*/, this.getReplyForSmsMessageRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Returns a SMS summary object with content. * Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. */ SmsControllerApi.prototype.getSmsMessageRaw = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { var queryParameters, headerParameters, response; return __generator(this, function (_a) { switch (_a.label) { case 0: if (requestParameters.smsId === null || requestParameters.smsId === undefined) { throw new runtime.RequiredError('smsId', 'Required parameter requestParameters.smsId was null or undefined when calling getSmsMessage.'); } queryParameters = {}; headerParameters = {}; if (this.configuration && this.configuration.apiKey) { headerParameters['x-api-key'] = this.configuration.apiKey('x-api-key'); // API_KEY authentication } return [4 /*yield*/, this.request({ path: "/sms/{smsId}".replace("{".concat('smsId', "}"), encodeURIComponent(String(requestParameters.smsId))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SmsDtoFromJSON)(jsonValue); })]; } }); }); }; /** * Returns a SMS summary object with content. * Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. */ SmsControllerApi.prototype.getSmsMessage = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { var response; return __generator(this, function (_a) { switch (_a.label) { case 0: return [4 /*yield*/, this.getSmsMessageRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages * Get all SMS messages in all phone numbers in paginated form. . */ SmsControllerApi.prototype.getSmsMessagesPaginatedRaw = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { var queryParameters, headerParameters, response; return __generator(this, function (_a) { switch (_a.label) { case 0: queryParameters = {}; if (requestParameters.phoneNumber !== undefined) { queryParameters['phoneNumber'] = requestParameters.phoneNumber; } if (requestParameters.page !== undefined) { queryParameters['page'] = requestParameters.page; } if (requestParameters.size !== undefined) { queryParameters['size'] = requestParameters.size; } if (requestParameters.sort !== undefined) { queryParameters['sort'] = requestParameters.sort; } if (requestParameters.unreadOnly !== undefined) { queryParameters['unreadOnly'] = requestParameters.unreadOnly; } if (requestParameters.since !== undefined) { queryParameters['since'] = requestParameters.since.toISOString(); } if (requestParameters.before !== undefined) { queryParameters['before'] = requestParameters.before.toISOString(); } headerParameters = {}; if (this.configuration && this.configuration.apiKey) { headerParameters['x-api-key'] = this.configuration.apiKey('x-api-key'); // API_KEY authentication } return [4 /*yield*/, this.request({ path: "/sms", method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.PageSmsProjectionFromJSON)(jsonValue); })]; } }); }); }; /** * By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages * Get all SMS messages in all phone numbers in paginated form. . */ SmsControllerApi.prototype.getSmsMessagesPaginated = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { var response; return __generator(this, function (_a) { switch (_a.label) { case 0: return [4 /*yield*/, this.getSmsMessagesPaginatedRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response * Get unread SMS count */ SmsControllerApi.prototype.getUnreadSmsCountRaw = function (initOverrides) { return __awaiter(this, void 0, void 0, function () { var queryParameters, headerParameters, response; return __generator(this, function (_a) { switch (_a.label) { case 0: queryParameters = {}; headerParameters = {}; if (this.configuration && this.configuration.apiKey) { headerParameters['x-api-key'] = this.configuration.apiKey('x-api-key'); // API_KEY authentication } return [4 /*yield*/, this.request({ path: "/sms/unreadCount", method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.UnreadCountFromJSON)(jsonValue); })]; } }); }); }; /** * Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response * Get unread SMS count */ SmsControllerApi.prototype.getUnreadSmsCount = function (initOverrides) { return __awaiter(this, void 0, void 0, function () { var response; return __generator(this, function (_a) { switch (_a.label) { case 0: return [4 /*yield*/, this.getUnreadSmsCountRaw(initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Reply to an SMS message. * Send a reply to a received SMS message. Replies are sent from the receiving number. */ SmsControllerApi.prototype.replyToSmsMessageRaw = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { var queryParameters, headerParameters, response; return __generator(this, function (_a) { switch (_a.label) { case 0: if (requestParameters.smsId === null || requestParameters.smsId === undefined) { throw new runtime.RequiredError('smsId', 'Required parameter requestParameters.smsId was null or undefined when calling replyToSmsMessage.'); } if (requestParameters.smsReplyOptions === null || requestParameters.smsReplyOptions === undefined) { throw new runtime.RequiredError('smsReplyOptions', 'Required parameter requestParameters.smsReplyOptions was null or undefined when calling replyToSmsMessage.'); } queryParameters = {}; headerParameters = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.apiKey) { headerParameters['x-api-key'] = this.configuration.apiKey('x-api-key'); // API_KEY authentication } return [4 /*yield*/, this.request({ path: "/sms/{smsId}/reply".replace("{".concat('smsId', "}"), encodeURIComponent(String(requestParameters.smsId))), method: 'POST', headers: headerParameters, query: queryParameters, body: (0, models_1.SmsReplyOptionsToJSON)(requestParameters.smsReplyOptions), }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SentSmsDtoFromJSON)(jsonValue); })]; } }); }); }; /** * Reply to an SMS message. * Send a reply to a received SMS message. Replies are sent from the receiving number. */ SmsControllerApi.prototype.replyToSmsMessage = function (requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function () { var response; return __generator(this, function (_a) { switch (_a.label) { case 0: return [4 /*yield*/, this.replyToSmsMessageRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; return SmsControllerApi; }(runtime.BaseAPI)); exports.SmsControllerApi = SmsControllerApi; /** * @export * @enum {string} */ var GetSmsMessagesPaginatedSortEnum; (function (GetSmsMessagesPaginatedSortEnum) { GetSmsMessagesPaginatedSortEnum["ASC"] = "ASC"; GetSmsMessagesPaginatedSortEnum["DESC"] = "DESC"; })(GetSmsMessagesPaginatedSortEnum = exports.GetSmsMessagesPaginatedSortEnum || (exports.GetSmsMessagesPaginatedSortEnum = {}));