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.
593 lines (592 loc) • 30.4 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.GetListUnsubscribeRecipientsSortEnum = exports.GetComplaintsSortEnum = exports.GetBouncedRecipientsSortEnum = exports.GetBouncedEmailsSortEnum = exports.BounceControllerApi = void 0;
var runtime = __importStar(require("../runtime"));
var models_1 = require("../models");
/**
*
*/
var BounceControllerApi = /** @class */ (function (_super) {
__extends(BounceControllerApi, _super);
function BounceControllerApi() {
return _super !== null && _super.apply(this, arguments) || this;
}
/**
* Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
* Filter a list of email recipients and remove those who have bounced
*/
BounceControllerApi.prototype.filterBouncedRecipientRaw = 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.filterBouncedRecipientsOptions === null ||
requestParameters.filterBouncedRecipientsOptions === undefined) {
throw new runtime.RequiredError('filterBouncedRecipientsOptions', 'Required parameter requestParameters.filterBouncedRecipientsOptions was null or undefined when calling filterBouncedRecipient.');
}
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: "/bounce/filter-recipients",
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: (0, models_1.FilterBouncedRecipientsOptionsToJSON)(requestParameters.filterBouncedRecipientsOptions),
}, initOverrides)];
case 1:
response = _a.sent();
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) {
return (0, models_1.FilterBouncedRecipientsResultFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
* Filter a list of email recipients and remove those who have bounced
*/
BounceControllerApi.prototype.filterBouncedRecipient = 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.filterBouncedRecipientRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Check if account block status prevents sending
* Can account send email
*/
BounceControllerApi.prototype.getAccountBounceBlockStatusRaw = 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: "/bounce/account-block",
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.AccountBounceBlockDtoFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Check if account block status prevents sending
* Can account send email
*/
BounceControllerApi.prototype.getAccountBounceBlockStatus = 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.getAccountBounceBlockStatusRaw(initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Bounced emails are email you have sent that were rejected by a recipient
* Get a bounced email.
*/
BounceControllerApi.prototype.getBouncedEmailRaw = 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 getBouncedEmail.');
}
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: "/bounce/emails/{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.BouncedEmailDtoFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Bounced emails are email you have sent that were rejected by a recipient
* Get a bounced email.
*/
BounceControllerApi.prototype.getBouncedEmail = 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.getBouncedEmailRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Bounced emails are email you have sent that were rejected by a recipient
* Get paginated list of bounced emails.
*/
BounceControllerApi.prototype.getBouncedEmailsRaw = 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.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: "/bounce/emails",
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.PageBouncedEmailFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Bounced emails are email you have sent that were rejected by a recipient
* Get paginated list of bounced emails.
*/
BounceControllerApi.prototype.getBouncedEmails = 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.getBouncedEmailsRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Bounced emails are email you have sent that were rejected by a recipient
* Get a bounced email.
*/
BounceControllerApi.prototype.getBouncedRecipientRaw = 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 getBouncedRecipient.');
}
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: "/bounce/recipients/{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.BouncedRecipientDtoFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Bounced emails are email you have sent that were rejected by a recipient
* Get a bounced email.
*/
BounceControllerApi.prototype.getBouncedRecipient = 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.getBouncedRecipientRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.
* Get paginated list of bounced recipients.
*/
BounceControllerApi.prototype.getBouncedRecipientsRaw = 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.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: "/bounce/recipients",
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.PageBouncedRecipientsFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.
* Get paginated list of bounced recipients.
*/
BounceControllerApi.prototype.getBouncedRecipients = 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.getBouncedRecipientsRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* SMTP complaints made against your account
* Get paginated list of complaints.
*/
BounceControllerApi.prototype.getComplaintsRaw = 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.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: "/bounce/complaints",
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.PageComplaintFromJSON)(jsonValue);
})];
}
});
});
};
/**
* SMTP complaints made against your account
* Get paginated list of complaints.
*/
BounceControllerApi.prototype.getComplaints = 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.getComplaintsRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.
* Get paginated list of unsubscribed recipients.
*/
BounceControllerApi.prototype.getListUnsubscribeRecipientsRaw = 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.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: "/bounce/list-unsubscribe-recipients",
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.PageListUnsubscribeRecipientsFromJSON)(jsonValue);
})];
}
});
});
};
/**
* Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.
* Get paginated list of unsubscribed recipients.
*/
BounceControllerApi.prototype.getListUnsubscribeRecipients = 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.getListUnsubscribeRecipientsRaw(requestParameters, initOverrides)];
case 1:
response = _a.sent();
return [4 /*yield*/, response.value()];
case 2: return [2 /*return*/, _a.sent()];
}
});
});
};
return BounceControllerApi;
}(runtime.BaseAPI));
exports.BounceControllerApi = BounceControllerApi;
/**
* @export
* @enum {string}
*/
var GetBouncedEmailsSortEnum;
(function (GetBouncedEmailsSortEnum) {
GetBouncedEmailsSortEnum["ASC"] = "ASC";
GetBouncedEmailsSortEnum["DESC"] = "DESC";
})(GetBouncedEmailsSortEnum = exports.GetBouncedEmailsSortEnum || (exports.GetBouncedEmailsSortEnum = {}));
/**
* @export
* @enum {string}
*/
var GetBouncedRecipientsSortEnum;
(function (GetBouncedRecipientsSortEnum) {
GetBouncedRecipientsSortEnum["ASC"] = "ASC";
GetBouncedRecipientsSortEnum["DESC"] = "DESC";
})(GetBouncedRecipientsSortEnum = exports.GetBouncedRecipientsSortEnum || (exports.GetBouncedRecipientsSortEnum = {}));
/**
* @export
* @enum {string}
*/
var GetComplaintsSortEnum;
(function (GetComplaintsSortEnum) {
GetComplaintsSortEnum["ASC"] = "ASC";
GetComplaintsSortEnum["DESC"] = "DESC";
})(GetComplaintsSortEnum = exports.GetComplaintsSortEnum || (exports.GetComplaintsSortEnum = {}));
/**
* @export
* @enum {string}
*/
var GetListUnsubscribeRecipientsSortEnum;
(function (GetListUnsubscribeRecipientsSortEnum) {
GetListUnsubscribeRecipientsSortEnum["ASC"] = "ASC";
GetListUnsubscribeRecipientsSortEnum["DESC"] = "DESC";
})(GetListUnsubscribeRecipientsSortEnum = exports.GetListUnsubscribeRecipientsSortEnum || (exports.GetListUnsubscribeRecipientsSortEnum = {}));