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.

516 lines (515 loc) 26.8 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.DomainControllerApi = void 0; var runtime = __importStar(require("../runtime")); var models_1 = require("../models"); /** * */ var DomainControllerApi = /** @class */ (function (_super) { __extends(DomainControllerApi, _super); function DomainControllerApi() { return _super !== null && _super.apply(this, arguments) || this; } /** * Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated * Add catch all wild card inbox to domain */ DomainControllerApi.prototype.addDomainWildcardCatchAllRaw = 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 addDomainWildcardCatchAll.'); } 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: "/domains/{id}/wildcard".replace("{".concat('id', "}"), encodeURIComponent(String(requestParameters.id))), method: 'POST', headers: headerParameters, query: queryParameters, }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.DomainDtoFromJSON)(jsonValue); })]; } }); }); }; /** * Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated * Add catch all wild card inbox to domain */ DomainControllerApi.prototype.addDomainWildcardCatchAll = 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.addDomainWildcardCatchAllRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider\'s DNS setup to verify the domain. * Create Domain */ DomainControllerApi.prototype.createDomainRaw = 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.createDomainOptions === null || requestParameters.createDomainOptions === undefined) { throw new runtime.RequiredError('createDomainOptions', 'Required parameter requestParameters.createDomainOptions was null or undefined when calling createDomain.'); } 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: "/domains", method: 'POST', headers: headerParameters, query: queryParameters, body: (0, models_1.CreateDomainOptionsToJSON)(requestParameters.createDomainOptions), }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.DomainDtoFromJSON)(jsonValue); })]; } }); }); }; /** * Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider\'s DNS setup to verify the domain. * Create Domain */ DomainControllerApi.prototype.createDomain = 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.createDomainRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Delete a domain. This will disable any existing inboxes that use this domain. * Delete a domain */ DomainControllerApi.prototype.deleteDomainRaw = 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 deleteDomain.'); } 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: "/domains/{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.JSONApiResponse(response)]; } }); }); }; /** * Delete a domain. This will disable any existing inboxes that use this domain. * Delete a domain */ DomainControllerApi.prototype.deleteDomain = 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.deleteDomainRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Returns domain verification status and tokens for a given domain * Get a domain */ DomainControllerApi.prototype.getDomainRaw = 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 getDomain.'); } queryParameters = {}; if (requestParameters.checkForErrors !== undefined) { queryParameters['checkForErrors'] = requestParameters.checkForErrors; } 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: "/domains/{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.DomainDtoFromJSON)(jsonValue); })]; } }); }); }; /** * Returns domain verification status and tokens for a given domain * Get a domain */ DomainControllerApi.prototype.getDomain = 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.getDomainRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * List domain issues for domains you have created * Get domain issues */ DomainControllerApi.prototype.getDomainIssuesRaw = 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: "/domains/issues", 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.DomainIssuesDtoFromJSON)(jsonValue); })]; } }); }); }; /** * List domain issues for domains you have created * Get domain issues */ DomainControllerApi.prototype.getDomainIssues = 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.getDomainIssuesRaw(initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Get the catch all inbox for a domain for missed emails * Get catch all wild card inbox for domain */ DomainControllerApi.prototype.getDomainWildcardCatchAllInboxRaw = 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 getDomainWildcardCatchAllInbox.'); } 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: "/domains/{id}/wildcard".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.InboxDtoFromJSON)(jsonValue); })]; } }); }); }; /** * Get the catch all inbox for a domain for missed emails * Get catch all wild card inbox for domain */ DomainControllerApi.prototype.getDomainWildcardCatchAllInbox = 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.getDomainWildcardCatchAllInboxRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * List all custom domains you have created * Get domains */ DomainControllerApi.prototype.getDomainsRaw = 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: "/domains", method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(models_1.DomainPreviewFromJSON); })]; } }); }); }; /** * List all custom domains you have created * Get domains */ DomainControllerApi.prototype.getDomains = 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.getDomainsRaw(initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; /** * Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this. * Update a domain */ DomainControllerApi.prototype.updateDomainRaw = 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 updateDomain.'); } if (requestParameters.updateDomainOptions === null || requestParameters.updateDomainOptions === undefined) { throw new runtime.RequiredError('updateDomainOptions', 'Required parameter requestParameters.updateDomainOptions was null or undefined when calling updateDomain.'); } 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: "/domains/{id}".replace("{".concat('id', "}"), encodeURIComponent(String(requestParameters.id))), method: 'PUT', headers: headerParameters, query: queryParameters, body: (0, models_1.UpdateDomainOptionsToJSON)(requestParameters.updateDomainOptions), }, initOverrides)]; case 1: response = _a.sent(); return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.DomainDtoFromJSON)(jsonValue); })]; } }); }); }; /** * Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this. * Update a domain */ DomainControllerApi.prototype.updateDomain = 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.updateDomainRaw(requestParameters, initOverrides)]; case 1: response = _a.sent(); return [4 /*yield*/, response.value()]; case 2: return [2 /*return*/, _a.sent()]; } }); }); }; return DomainControllerApi; }(runtime.BaseAPI)); exports.DomainControllerApi = DomainControllerApi;