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.
906 lines • 145 kB
JavaScript
"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.ListInboxTrackingPixelsSortEnum = exports.ListInboxRulesetsSortEnum = exports.GetScheduledJobsByInboxIdSortEnum = exports.GetOrganizationInboxesSortEnum = exports.GetInboxesSortEnum = exports.GetInboxSentEmailsSortEnum = exports.GetInboxEmailsPaginatedSortEnum = exports.GetEmailsSortEnum = exports.GetDeliveryStatusesByInboxIdSortEnum = exports.GetAllScheduledJobsSortEnum = exports.GetAllInboxesInboxFunctionEnum = exports.GetAllInboxesInboxTypeEnum = exports.GetAllInboxesSortEnum = exports.CreateInboxInboxTypeEnum = exports.InboxControllerApi = void 0;
var runtime = __importStar(require("../runtime"));
var models_1 = require("../models");
/**
*
*/
var InboxControllerApi = /** @class */ (function (_super) {
__extends(InboxControllerApi, _super);
function InboxControllerApi() {
return _super !== null && _super.apply(this, arguments) || this;
}
/**
* Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.
* Cancel a scheduled email job
*/
InboxControllerApi.prototype.cancelScheduledJobRaw = 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.jobId === null ||
requestParameters.jobId === undefined) {
throw new runtime.RequiredError('jobId', 'Required parameter requestParameters.jobId was null or undefined when calling cancelScheduledJob.');
}
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: "/inboxes/scheduled-jobs/{jobId}".replace("{".concat('jobId', "}"), encodeURIComponent(String(requestParameters.jobId))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) {
return (0, models_1.ScheduledJobDtoFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Get a scheduled email job and cancel it. Will fail if status of job is already cancelled, failed, or complete.
* Cancel a scheduled email job
*/
InboxControllerApi.prototype.cancelScheduledJob = 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.cancelScheduledJobRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
* Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
*/
InboxControllerApi.prototype.createInboxRaw = 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.emailAddress !== undefined) {
queryParameters['emailAddress'] = requestParameters.emailAddress;
}
if (requestParameters.tags) {
queryParameters['tags'] = requestParameters.tags;
}
if (requestParameters.name !== undefined) {
queryParameters['name'] = requestParameters.name;
}
if (requestParameters.description !== undefined) {
queryParameters['description'] = requestParameters.description;
}
if (requestParameters.useDomainPool !== undefined) {
queryParameters['useDomainPool'] = requestParameters.useDomainPool;
}
if (requestParameters.favourite !== undefined) {
queryParameters['favourite'] = requestParameters.favourite;
}
if (requestParameters.expiresAt !== undefined) {
queryParameters['expiresAt'] = requestParameters.expiresAt.toISOString();
}
if (requestParameters.expiresIn !== undefined) {
queryParameters['expiresIn'] = requestParameters.expiresIn;
}
if (requestParameters.allowTeamAccess !== undefined) {
queryParameters['allowTeamAccess'] = requestParameters.allowTeamAccess;
}
if (requestParameters.inboxType !== undefined) {
queryParameters['inboxType'] = requestParameters.inboxType;
}
if (requestParameters.virtualInbox !== undefined) {
queryParameters['virtualInbox'] = requestParameters.virtualInbox;
}
if (requestParameters.useShortAddress !== undefined) {
queryParameters['useShortAddress'] = requestParameters.useShortAddress;
}
if (requestParameters.domainId !== undefined) {
queryParameters['domainId'] = requestParameters.domainId;
}
if (requestParameters.domainName !== undefined) {
queryParameters['domainName'] = requestParameters.domainName;
}
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: "/inboxes",
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.InboxDtoFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
* Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
*/
InboxControllerApi.prototype.createInbox = 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.createInboxRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
* Create an inbox ruleset
*/
InboxControllerApi.prototype.createInboxRulesetRaw = 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 createInboxRuleset.');
}
if (requestParameters.createInboxRulesetOptions === null ||
requestParameters.createInboxRulesetOptions === undefined) {
throw new runtime.RequiredError('createInboxRulesetOptions', 'Required parameter requestParameters.createInboxRulesetOptions was null or undefined when calling createInboxRuleset.');
}
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: "/inboxes/{inboxId}/rulesets".replace("{".concat('inboxId', "}"), encodeURIComponent(String(requestParameters.inboxId))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, models_1.CreateInboxRulesetOptionsToJSON)(requestParameters.createInboxRulesetOptions),
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) {
return (0, models_1.InboxRulesetDtoFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
* Create an inbox ruleset
*/
InboxControllerApi.prototype.createInboxRuleset = 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.createInboxRulesetRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Create an inbox with default options. Uses MailSlurp domain pool address and is private.
*/
InboxControllerApi.prototype.createInboxWithDefaultsRaw = 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: "/inboxes/withDefaults",
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.InboxDtoFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Create an inbox with default options. Uses MailSlurp domain pool address and is private.
*/
InboxControllerApi.prototype.createInboxWithDefaults = 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.createInboxWithDefaultsRaw(initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
* Create an inbox with options. Extended options for inbox creation.
*/
InboxControllerApi.prototype.createInboxWithOptionsRaw = 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.createInboxDto === null ||
requestParameters.createInboxDto === undefined) {
throw new runtime.RequiredError('createInboxDto', 'Required parameter requestParameters.createInboxDto was null or undefined when calling createInboxWithOptions.');
}
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: "/inboxes/withOptions",
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, models_1.CreateInboxDtoToJSON)(requestParameters.createInboxDto),
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) {
return (0, models_1.InboxDtoFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
* Create an inbox with options. Extended options for inbox creation.
*/
InboxControllerApi.prototype.createInboxWithOptions = 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.createInboxWithOptionsRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Deletes all emails in an inbox. Be careful as emails cannot be recovered
* Delete all emails in a given inboxes.
*/
InboxControllerApi.prototype.deleteAllInboxEmailsRaw = 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 deleteAllInboxEmails.');
}
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: "/inboxes/{inboxId}/deleteAllInboxEmails".replace("{".concat('inboxId', "}"), encodeURIComponent(String(requestParameters.inboxId))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.VoidApiResponse(response)];
}
});
});
};
/**
* Deletes all emails in an inbox. Be careful as emails cannot be recovered
* Delete all emails in a given inboxes.
*/
InboxControllerApi.prototype.deleteAllInboxEmails = 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.deleteAllInboxEmailsRaw(requestParameters, initOverrides)];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
/**
* Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.
* Delete all inboxes
*/
InboxControllerApi.prototype.deleteAllInboxesRaw = 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: "/inboxes",
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.VoidApiResponse(response)];
}
});
});
};
/**
* Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have.
* Delete all inboxes
*/
InboxControllerApi.prototype.deleteAllInboxes = function (initOverrides) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.deleteAllInboxesRaw(initOverrides)];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
/**
* Permanently delete all inboxes by description
* Delete inboxes by description
*/
InboxControllerApi.prototype.deleteAllInboxesByDescriptionRaw = 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.description === null ||
requestParameters.description === undefined) {
throw new runtime.RequiredError('description', 'Required parameter requestParameters.description was null or undefined when calling deleteAllInboxesByDescription.');
}
queryParameters = {};
if (requestParameters.description !== undefined) {
queryParameters['description'] = requestParameters.description;
}
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: "/inboxes/by-description",
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.VoidApiResponse(response)];
}
});
});
};
/**
* Permanently delete all inboxes by description
* Delete inboxes by description
*/
InboxControllerApi.prototype.deleteAllInboxesByDescription = 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.deleteAllInboxesByDescriptionRaw(requestParameters, initOverrides)];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
/**
* Permanently delete all inboxes by name
* Delete inboxes by name
*/
InboxControllerApi.prototype.deleteAllInboxesByNameRaw = 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.name === null ||
requestParameters.name === undefined) {
throw new runtime.RequiredError('name', 'Required parameter requestParameters.name was null or undefined when calling deleteAllInboxesByName.');
}
queryParameters = {};
if (requestParameters.name !== undefined) {
queryParameters['name'] = requestParameters.name;
}
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: "/inboxes/by-name",
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.VoidApiResponse(response)];
}
});
});
};
/**
* Permanently delete all inboxes by name
* Delete inboxes by name
*/
InboxControllerApi.prototype.deleteAllInboxesByName = 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.deleteAllInboxesByNameRaw(requestParameters, initOverrides)];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
/**
* Permanently delete all inboxes by tag
* Delete inboxes by tag
*/
InboxControllerApi.prototype.deleteAllInboxesByTagRaw = 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.tag === null || requestParameters.tag === undefined) {
throw new runtime.RequiredError('tag', 'Required parameter requestParameters.tag was null or undefined when calling deleteAllInboxesByTag.');
}
queryParameters = {};
if (requestParameters.tag !== undefined) {
queryParameters['tag'] = requestParameters.tag;
}
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: "/inboxes/by-tag",
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.VoidApiResponse(response)];
}
});
});
};
/**
* Permanently delete all inboxes by tag
* Delete inboxes by tag
*/
InboxControllerApi.prototype.deleteAllInboxesByTag = 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.deleteAllInboxesByTagRaw(requestParameters, initOverrides)];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
/**
* Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
* Delete inbox
*/
InboxControllerApi.prototype.deleteInboxRaw = 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 deleteInbox.');
}
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: "/inboxes/{inboxId}".replace("{".concat('inboxId', "}"), encodeURIComponent(String(requestParameters.inboxId))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.VoidApiResponse(response)];
}
});
});
};
/**
* Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
* Delete inbox
*/
InboxControllerApi.prototype.deleteInbox = 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.deleteInboxRaw(requestParameters, initOverrides)];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
/**
* Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses
* Does inbox exist
*/
InboxControllerApi.prototype.doesInboxExistRaw = 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.emailAddress === null ||
requestParameters.emailAddress === undefined) {
throw new runtime.RequiredError('emailAddress', 'Required parameter requestParameters.emailAddress was null or undefined when calling doesInboxExist.');
}
queryParameters = {};
if (requestParameters.emailAddress !== undefined) {
queryParameters['emailAddress'] = requestParameters.emailAddress;
}
if (requestParameters.allowCatchAll !== undefined) {
queryParameters['allowCatchAll'] = requestParameters.allowCatchAll;
}
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: "/inboxes/exists",
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.InboxExistsDtoFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Check if inboxes exist by email address. Useful if you are sending emails to mailslurp addresses
* Does inbox exist
*/
InboxControllerApi.prototype.doesInboxExist = 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.doesInboxExistRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
* Remove expired inboxes
*/
InboxControllerApi.prototype.flushExpiredRaw = 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.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: "/inboxes/expired",
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) {
return (0, models_1.FlushExpiredInboxesResultFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Remove any expired inboxes for your account (instead of waiting for scheduled removal on server)
* Remove expired inboxes
*/
InboxControllerApi.prototype.flushExpired = 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.flushExpiredRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
* List All Inboxes Paginated
*/
InboxControllerApi.prototype.getAllInboxesRaw = 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.page !== undefined) {
queryParameters['page'] = requestParameters.page;
}
if (requestParameters.size !== undefined) {
queryParameters['size'] = requestParameters.size;
}
if (requestParameters.sort !== undefined) {
queryParameters['sort'] = requestParameters.sort;
}
if (requestParameters.favourite !== undefined) {
queryParameters['favourite'] = requestParameters.favourite;
}
if (requestParameters.search !== undefined) {
queryParameters['search'] = requestParameters.search;
}
if (requestParameters.tag !== undefined) {
queryParameters['tag'] = requestParameters.tag;
}
if (requestParameters.teamAccess !== undefined) {
queryParameters['teamAccess'] = requestParameters.teamAccess;
}
if (requestParameters.since !== undefined) {
queryParameters['since'] = requestParameters.since.toISOString();
}
if (requestParameters.before !== undefined) {
queryParameters['before'] = requestParameters.before.toISOString();
}
if (requestParameters.inboxType !== undefined) {
queryParameters['inboxType'] = requestParameters.inboxType;
}
if (requestParameters.inboxFunction !== undefined) {
queryParameters['inboxFunction'] = requestParameters.inboxFunction;
}
if (requestParameters.domainId !== undefined) {
queryParameters['domainId'] = requestParameters.domainId;
}
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: "/inboxes/paginated",
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.PageInboxProjectionFromJSON)(jsonValue);
})];
}
});
});
};
/**
* List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
* List All Inboxes Paginated
*/
InboxControllerApi.prototype.getAllInboxes = 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.getAllInboxesRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Schedule sending of emails using scheduled jobs. These can be inbox or account level.
* Get all scheduled email sending jobs for account
*/
InboxControllerApi.prototype.getAllScheduledJobsRaw = 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.page !== undefined) {
queryParameters['page'] = requestParameters.page;
}
if (requestParameters.size !== undefined) {
queryParameters['size'] = requestParameters.size;
}
if (requestParameters.sort !== undefined) {
queryParameters['sort'] = requestParameters.sort;
}
if