@elasticemail/elasticemail-client-ts-axios
Version:
Official ElasticEmail SDK. This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.
407 lines (406 loc) • 21.4 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* Elastic Email REST API
* This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://app.elasticemail.com/marketing/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
*
* The version of the OpenAPI document: 4.0.0
* Contact: support@elasticemail.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
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());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = void 0;
const axios_1 = require("axios");
// Some imports not used depending on template conditions
// @ts-ignore
const common_1 = require("../common");
// @ts-ignore
const base_1 = require("../base");
/**
* FilesApi - axios parameter creator
* @export
*/
exports.FilesApiAxiosParamCreator = function (configuration) {
return {
/**
* Permanently deletes the file from your Account. Required Access Level: ModifyFiles
* @summary Delete File
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesByNameDelete: (name, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'name' is not null or undefined
common_1.assertParamExists('filesByNameDelete', 'name', name);
const localVarPath = `/files/{name}`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication apikey required
yield common_1.setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration);
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Gets content of the specified File. Required Access Level: ViewFiles
* @summary Download File
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesByNameGet: (name, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'name' is not null or undefined
common_1.assertParamExists('filesByNameGet', 'name', name);
const localVarPath = `/files/{name}`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication apikey required
yield common_1.setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration);
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Returns the specified File\'s details. Required Access Level: ViewFiles
* @summary Load File Details
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesByNameInfoGet: (name, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'name' is not null or undefined
common_1.assertParamExists('filesByNameInfoGet', 'name', name);
const localVarPath = `/files/{name}/info`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication apikey required
yield common_1.setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration);
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Returns a list of all your available files. Required Access Level: ViewFiles
* @summary List Files
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesGet: (limit, offset, options = {}) => __awaiter(this, void 0, void 0, function* () {
const localVarPath = `/files`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication apikey required
yield common_1.setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration);
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Uploads selected file to the server. Required Access Level: ModifyFiles
* @summary Upload File
* @param {FilePayload} filePayload
* @param {number} [expiresAfterDays] After how many days should the file be deleted.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesPost: (filePayload, expiresAfterDays, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'filePayload' is not null or undefined
common_1.assertParamExists('filesPost', 'filePayload', filePayload);
const localVarPath = `/files`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication apikey required
yield common_1.setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration);
if (expiresAfterDays !== undefined) {
localVarQueryParameter['expiresAfterDays'] = expiresAfterDays;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = common_1.serializeDataIfNeeded(filePayload, localVarRequestOptions, configuration);
return {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
};
};
/**
* FilesApi - functional programming interface
* @export
*/
exports.FilesApiFp = function (configuration) {
const localVarAxiosParamCreator = exports.FilesApiAxiosParamCreator(configuration);
return {
/**
* Permanently deletes the file from your Account. Required Access Level: ModifyFiles
* @summary Delete File
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesByNameDelete(name, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.filesByNameDelete(name, options);
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Gets content of the specified File. Required Access Level: ViewFiles
* @summary Download File
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesByNameGet(name, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.filesByNameGet(name, options);
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Returns the specified File\'s details. Required Access Level: ViewFiles
* @summary Load File Details
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesByNameInfoGet(name, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.filesByNameInfoGet(name, options);
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Returns a list of all your available files. Required Access Level: ViewFiles
* @summary List Files
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesGet(limit, offset, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.filesGet(limit, offset, options);
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* Uploads selected file to the server. Required Access Level: ModifyFiles
* @summary Upload File
* @param {FilePayload} filePayload
* @param {number} [expiresAfterDays] After how many days should the file be deleted.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesPost(filePayload, expiresAfterDays, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.filesPost(filePayload, expiresAfterDays, options);
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
};
};
/**
* FilesApi - factory interface
* @export
*/
exports.FilesApiFactory = function (configuration, basePath, axios) {
const localVarFp = exports.FilesApiFp(configuration);
return {
/**
* Permanently deletes the file from your Account. Required Access Level: ModifyFiles
* @summary Delete File
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesByNameDelete(name, options) {
return localVarFp.filesByNameDelete(name, options).then((request) => request(axios, basePath));
},
/**
* Gets content of the specified File. Required Access Level: ViewFiles
* @summary Download File
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesByNameGet(name, options) {
return localVarFp.filesByNameGet(name, options).then((request) => request(axios, basePath));
},
/**
* Returns the specified File\'s details. Required Access Level: ViewFiles
* @summary Load File Details
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesByNameInfoGet(name, options) {
return localVarFp.filesByNameInfoGet(name, options).then((request) => request(axios, basePath));
},
/**
* Returns a list of all your available files. Required Access Level: ViewFiles
* @summary List Files
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesGet(limit, offset, options) {
return localVarFp.filesGet(limit, offset, options).then((request) => request(axios, basePath));
},
/**
* Uploads selected file to the server. Required Access Level: ModifyFiles
* @summary Upload File
* @param {FilePayload} filePayload
* @param {number} [expiresAfterDays] After how many days should the file be deleted.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
filesPost(filePayload, expiresAfterDays, options) {
return localVarFp.filesPost(filePayload, expiresAfterDays, options).then((request) => request(axios, basePath));
},
};
};
/**
* FilesApi - object-oriented interface
* @export
* @class FilesApi
* @extends {BaseAPI}
*/
class FilesApi extends base_1.BaseAPI {
/**
* Permanently deletes the file from your Account. Required Access Level: ModifyFiles
* @summary Delete File
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FilesApi
*/
filesByNameDelete(name, options) {
return exports.FilesApiFp(this.configuration).filesByNameDelete(name, options).then((request) => request(this.axios, this.basePath));
}
/**
* Gets content of the specified File. Required Access Level: ViewFiles
* @summary Download File
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FilesApi
*/
filesByNameGet(name, options) {
return exports.FilesApiFp(this.configuration).filesByNameGet(name, options).then((request) => request(this.axios, this.basePath));
}
/**
* Returns the specified File\'s details. Required Access Level: ViewFiles
* @summary Load File Details
* @param {string} name Name of your file including extension.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FilesApi
*/
filesByNameInfoGet(name, options) {
return exports.FilesApiFp(this.configuration).filesByNameInfoGet(name, options).then((request) => request(this.axios, this.basePath));
}
/**
* Returns a list of all your available files. Required Access Level: ViewFiles
* @summary List Files
* @param {number} [limit] Maximum number of returned items.
* @param {number} [offset] How many items should be returned ahead.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FilesApi
*/
filesGet(limit, offset, options) {
return exports.FilesApiFp(this.configuration).filesGet(limit, offset, options).then((request) => request(this.axios, this.basePath));
}
/**
* Uploads selected file to the server. Required Access Level: ModifyFiles
* @summary Upload File
* @param {FilePayload} filePayload
* @param {number} [expiresAfterDays] After how many days should the file be deleted.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FilesApi
*/
filesPost(filePayload, expiresAfterDays, options) {
return exports.FilesApiFp(this.configuration).filesPost(filePayload, expiresAfterDays, options).then((request) => request(this.axios, this.basePath));
}
}
exports.FilesApi = FilesApi;