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.

673 lines (672 loc) 35 kB
"use strict"; /* tslint:disable */ /* eslint-disable */ /** * MailSlurp API * MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. 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.GetRulesetsSortEnum = exports.RulesetControllerApi = void 0; var runtime = __importStar(require("../runtime")); var models_1 = require("../models"); /** * */ var RulesetControllerApi = /** @class */ (function (_super) { __extends(RulesetControllerApi, _super); function RulesetControllerApi() { return _super !== null && _super.apply(this, arguments) || this; } /** * Create a new inbox or phone number rule for forwarding, blocking, and allowing emails or SMS when sending and receiving * Create a ruleset */ RulesetControllerApi.prototype.createNewRulesetRaw = 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.createRulesetOptions === null || requestParameters.createRulesetOptions === undefined) { throw new runtime.RequiredError('createRulesetOptions', 'Required parameter requestParameters.createRulesetOptions was null or undefined when calling createNewRuleset.'); } queryParameters = {}; if (requestParameters.inboxId !== undefined) { queryParameters['inboxId'] = requestParameters.inboxId; } if (requestParameters.phoneId !== undefined) { queryParameters['phoneId'] = requestParameters.phoneId; } 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: "/rulesets", method: 'POST', headers: headerParameters, query: queryParameters, body: (0, models_1.CreateRulesetOptionsToJSON)(requestParameters.createRulesetOptions), }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.RulesetDtoFromJSON)(jsonValue); })]; } }); }); }; /** * Create a new inbox or phone number rule for forwarding, blocking, and allowing emails or SMS when sending and receiving * Create a ruleset */ RulesetControllerApi.prototype.createNewRuleset = 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.createNewRulesetRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Delete ruleset * Delete a ruleset */ RulesetControllerApi.prototype.deleteRulesetRaw = 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.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling deleteRuleset.'); } 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: "/rulesets/{id}".replace("{".concat('id', "}"), encodeURIComponent(String(requestParameters.id))), method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.VoidApiResponse(response)]; } }); }); }; /** * Delete ruleset * Delete a ruleset */ RulesetControllerApi.prototype.deleteRuleset = 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.deleteRulesetRaw(requestParameters, initOverrides)]; case 1: _a.sent(); return [2 /*return*/]; } }); }); }; /** * Delete rulesets. Accepts optional inboxId or phoneId filters. * Delete rulesets */ RulesetControllerApi.prototype.deleteRulesetsRaw = 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.inboxId !== undefined) { queryParameters['inboxId'] = requestParameters.inboxId; } if (requestParameters.phoneId !== undefined) { queryParameters['phoneId'] = requestParameters.phoneId; } 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: "/rulesets", method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.VoidApiResponse(response)]; } }); }); }; /** * Delete rulesets. Accepts optional inboxId or phoneId filters. * Delete rulesets */ RulesetControllerApi.prototype.deleteRulesets = 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.deleteRulesetsRaw(requestParameters, initOverrides)]; case 1: _a.sent(); return [2 /*return*/]; } }); }); }; /** * Get ruleset * Get a ruleset */ RulesetControllerApi.prototype.getRulesetRaw = 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.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling getRuleset.'); } 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: "/rulesets/{id}".replace("{".concat('id', "}"), encodeURIComponent(String(requestParameters.id))), 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.RulesetDtoFromJSON)(jsonValue); })]; } }); }); }; /** * Get ruleset * Get a ruleset */ RulesetControllerApi.prototype.getRuleset = 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.getRulesetRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * List all rulesets attached to an inbox or phone or account * List rulesets block and allow lists */ RulesetControllerApi.prototype.getRulesetsRaw = 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.inboxId !== undefined) { queryParameters['inboxId'] = requestParameters.inboxId; } if (requestParameters.phoneId !== undefined) { queryParameters['phoneId'] = requestParameters.phoneId; } 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.searchFilter !== undefined) { queryParameters['searchFilter'] = requestParameters.searchFilter; } 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: "/rulesets", 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.PageRulesetDtoFromJSON)(jsonValue); })]; } }); }); }; /** * List all rulesets attached to an inbox or phone or account * List rulesets block and allow lists */ RulesetControllerApi.prototype.getRulesets = 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.getRulesetsRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Test inbox rulesets for inbox * Test inbox rulesets for inbox */ RulesetControllerApi.prototype.testInboxRulesetsForInboxRaw = 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.inboxId === null || requestParameters.inboxId === undefined) { throw new runtime.RequiredError('inboxId', 'Required parameter requestParameters.inboxId was null or undefined when calling testInboxRulesetsForInbox.'); } if (requestParameters.rulesetTestOptions === null || requestParameters.rulesetTestOptions === undefined) { throw new runtime.RequiredError('rulesetTestOptions', 'Required parameter requestParameters.rulesetTestOptions was null or undefined when calling testInboxRulesetsForInbox.'); } queryParameters = {}; if (requestParameters.inboxId !== undefined) { queryParameters['inboxId'] = requestParameters.inboxId; } 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: "/rulesets", method: 'PUT', headers: headerParameters, query: queryParameters, body: (0, models_1.RulesetTestOptionsToJSON)(requestParameters.rulesetTestOptions), }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.InboxRulesetTestResultFromJSON)(jsonValue); })]; } }); }); }; /** * Test inbox rulesets for inbox * Test inbox rulesets for inbox */ RulesetControllerApi.prototype.testInboxRulesetsForInbox = 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.testInboxRulesetsForInboxRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Test new ruleset * Test new ruleset */ RulesetControllerApi.prototype.testNewRulesetRaw = 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.testNewInboxRulesetOptions === null || requestParameters.testNewInboxRulesetOptions === undefined) { throw new runtime.RequiredError('testNewInboxRulesetOptions', 'Required parameter requestParameters.testNewInboxRulesetOptions was null or undefined when calling testNewRuleset.'); } 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: "/rulesets", method: 'PATCH', headers: headerParameters, query: queryParameters, body: (0, models_1.TestNewInboxRulesetOptionsToJSON)(requestParameters.testNewInboxRulesetOptions), }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.InboxRulesetTestResultFromJSON)(jsonValue); })]; } }); }); }; /** * Test new ruleset * Test new ruleset */ RulesetControllerApi.prototype.testNewRuleset = 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.testNewRulesetRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Test an inbox or phone ruleset * Test a ruleset */ RulesetControllerApi.prototype.testRulesetRaw = 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.id === null || requestParameters.id === undefined) { throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling testRuleset.'); } if (requestParameters.rulesetTestOptions === null || requestParameters.rulesetTestOptions === undefined) { throw new runtime.RequiredError('rulesetTestOptions', 'Required parameter requestParameters.rulesetTestOptions was null or undefined when calling testRuleset.'); } 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: "/rulesets/{id}/test".replace("{".concat('id', "}"), encodeURIComponent(String(requestParameters.id))), method: 'POST', headers: headerParameters, query: queryParameters, body: (0, models_1.RulesetTestOptionsToJSON)(requestParameters.rulesetTestOptions), }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.InboxRulesetTestResultFromJSON)(jsonValue); })]; } }); }); }; /** * Test an inbox or phone ruleset * Test a ruleset */ RulesetControllerApi.prototype.testRuleset = 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.testRulesetRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets or test if phone number can receive SMS * Test receiving with rulesets */ RulesetControllerApi.prototype.testRulesetReceivingRaw = 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.testRulesetReceivingOptions === null || requestParameters.testRulesetReceivingOptions === undefined) { throw new runtime.RequiredError('testRulesetReceivingOptions', 'Required parameter requestParameters.testRulesetReceivingOptions was null or undefined when calling testRulesetReceiving.'); } 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: "/rulesets/test-receiving", method: 'POST', headers: headerParameters, query: queryParameters, body: (0, models_1.TestRulesetReceivingOptionsToJSON)(requestParameters.testRulesetReceivingOptions), }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.TestRulesetReceivingResultFromJSON)(jsonValue); })]; } }); }); }; /** * Test whether inbound emails from an email address would be blocked or allowed by inbox rulesets or test if phone number can receive SMS * Test receiving with rulesets */ RulesetControllerApi.prototype.testRulesetReceiving = 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.testRulesetReceivingRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets or whether a phone number can send SMS * Test sending with rulesets */ RulesetControllerApi.prototype.testRulesetSendingRaw = 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.testInboxRulesetSendingOptions === null || requestParameters.testInboxRulesetSendingOptions === undefined) { throw new runtime.RequiredError('testInboxRulesetSendingOptions', 'Required parameter requestParameters.testInboxRulesetSendingOptions was null or undefined when calling testRulesetSending.'); } 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: "/rulesets/test-sending", method: 'POST', headers: headerParameters, query: queryParameters, body: (0, models_1.TestInboxRulesetSendingOptionsToJSON)(requestParameters.testInboxRulesetSendingOptions), }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.TestRulesetSendingResultFromJSON)(jsonValue); })]; } }); }); }; /** * Test whether outbound emails to an email address would be blocked or allowed by inbox rulesets or whether a phone number can send SMS * Test sending with rulesets */ RulesetControllerApi.prototype.testRulesetSending = 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.testRulesetSendingRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; return RulesetControllerApi; }(runtime.BaseAPI)); exports.RulesetControllerApi = RulesetControllerApi; /** * @export * @enum {string} */ var GetRulesetsSortEnum; (function (GetRulesetsSortEnum) { GetRulesetsSortEnum["ASC"] = "ASC"; GetRulesetsSortEnum["DESC"] = "DESC"; })(GetRulesetsSortEnum = exports.GetRulesetsSortEnum || (exports.GetRulesetsSortEnum = {}));