shipstation-client
Version:
ShipStation V2 SDK
403 lines (402 loc) • 22.1 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* ShipStation API v2
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.0.0
*
*
* 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.CarriersApi = exports.CarriersApiFactory = exports.CarriersApiFp = exports.CarriersApiAxiosParamCreator = 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");
/**
* CarriersApi - axios parameter creator
* @export
*/
const CarriersApiAxiosParamCreator = function (configuration) {
return {
/**
* Retrive details about a specific carrier by its carrier id.
* @summary Get carrier by id
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCarrierById: (carrierId_1, ...args_1) => __awaiter(this, [carrierId_1, ...args_1], void 0, function* (carrierId, options = {}) {
// verify required parameter 'carrierId' is not null or undefined
(0, common_1.assertParamExists)('getCarrierById', 'carrierId', carrierId);
const localVarPath = `/v2/carriers/{carrier_id}`
.replace(`{${"carrier_id"}}`, encodeURIComponent(String(carrierId)));
// 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 api_keys required
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
(0, 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: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Get a list of the options available for a specific carriers.
* @summary Get carrier options
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCarrierOptions: (carrierId_1, ...args_1) => __awaiter(this, [carrierId_1, ...args_1], void 0, function* (carrierId, options = {}) {
// verify required parameter 'carrierId' is not null or undefined
(0, common_1.assertParamExists)('getCarrierOptions', 'carrierId', carrierId);
const localVarPath = `/v2/carriers/{carrier_id}/options`
.replace(`{${"carrier_id"}}`, encodeURIComponent(String(carrierId)));
// 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 api_keys required
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
(0, 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: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* List the package types associated with a specific carrier.
* @summary List carrier package types
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listCarrierPackageTypes: (carrierId_1, ...args_1) => __awaiter(this, [carrierId_1, ...args_1], void 0, function* (carrierId, options = {}) {
// verify required parameter 'carrierId' is not null or undefined
(0, common_1.assertParamExists)('listCarrierPackageTypes', 'carrierId', carrierId);
const localVarPath = `/v2/carriers/{carrier_id}/packages`
.replace(`{${"carrier_id"}}`, encodeURIComponent(String(carrierId)));
// 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 api_keys required
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
(0, 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: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* List the services associated with a specific carrier id.
* @summary List carrier services
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listCarrierServices: (carrierId_1, ...args_1) => __awaiter(this, [carrierId_1, ...args_1], void 0, function* (carrierId, options = {}) {
// verify required parameter 'carrierId' is not null or undefined
(0, common_1.assertParamExists)('listCarrierServices', 'carrierId', carrierId);
const localVarPath = `/v2/carriers/{carrier_id}/services`
.replace(`{${"carrier_id"}}`, encodeURIComponent(String(carrierId)));
// 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 api_keys required
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
(0, 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: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* List all carriers that have been added to this account.
* @summary List carriers
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listCarriers: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
const localVarPath = `/v2/carriers`;
// 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 api_keys required
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
(0, 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: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
}),
};
};
exports.CarriersApiAxiosParamCreator = CarriersApiAxiosParamCreator;
/**
* CarriersApi - functional programming interface
* @export
*/
const CarriersApiFp = function (configuration) {
const localVarAxiosParamCreator = (0, exports.CarriersApiAxiosParamCreator)(configuration);
return {
/**
* Retrive details about a specific carrier by its carrier id.
* @summary Get carrier by id
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCarrierById(carrierId, options) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c;
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCarrierById(carrierId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CarriersApi.getCarrierById']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
});
},
/**
* Get a list of the options available for a specific carriers.
* @summary Get carrier options
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCarrierOptions(carrierId, options) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c;
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCarrierOptions(carrierId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CarriersApi.getCarrierOptions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
});
},
/**
* List the package types associated with a specific carrier.
* @summary List carrier package types
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listCarrierPackageTypes(carrierId, options) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c;
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCarrierPackageTypes(carrierId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CarriersApi.listCarrierPackageTypes']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
});
},
/**
* List the services associated with a specific carrier id.
* @summary List carrier services
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listCarrierServices(carrierId, options) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c;
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCarrierServices(carrierId, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CarriersApi.listCarrierServices']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
});
},
/**
* List all carriers that have been added to this account.
* @summary List carriers
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listCarriers(options) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c;
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCarriers(options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CarriersApi.listCarriers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
});
},
};
};
exports.CarriersApiFp = CarriersApiFp;
/**
* CarriersApi - factory interface
* @export
*/
const CarriersApiFactory = function (configuration, basePath, axios) {
const localVarFp = (0, exports.CarriersApiFp)(configuration);
return {
/**
* Retrive details about a specific carrier by its carrier id.
* @summary Get carrier by id
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCarrierById(carrierId, options) {
return localVarFp.getCarrierById(carrierId, options).then((request) => request(axios, basePath));
},
/**
* Get a list of the options available for a specific carriers.
* @summary Get carrier options
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCarrierOptions(carrierId, options) {
return localVarFp.getCarrierOptions(carrierId, options).then((request) => request(axios, basePath));
},
/**
* List the package types associated with a specific carrier.
* @summary List carrier package types
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listCarrierPackageTypes(carrierId, options) {
return localVarFp.listCarrierPackageTypes(carrierId, options).then((request) => request(axios, basePath));
},
/**
* List the services associated with a specific carrier id.
* @summary List carrier services
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listCarrierServices(carrierId, options) {
return localVarFp.listCarrierServices(carrierId, options).then((request) => request(axios, basePath));
},
/**
* List all carriers that have been added to this account.
* @summary List carriers
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listCarriers(options) {
return localVarFp.listCarriers(options).then((request) => request(axios, basePath));
},
};
};
exports.CarriersApiFactory = CarriersApiFactory;
/**
* CarriersApi - object-oriented interface
* @export
* @class CarriersApi
* @extends {BaseAPI}
*/
class CarriersApi extends base_1.BaseAPI {
/**
* Retrive details about a specific carrier by its carrier id.
* @summary Get carrier by id
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CarriersApi
*/
getCarrierById(carrierId, options) {
return (0, exports.CarriersApiFp)(this.configuration).getCarrierById(carrierId, options).then((request) => request(this.axios, this.basePath));
}
/**
* Get a list of the options available for a specific carriers.
* @summary Get carrier options
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CarriersApi
*/
getCarrierOptions(carrierId, options) {
return (0, exports.CarriersApiFp)(this.configuration).getCarrierOptions(carrierId, options).then((request) => request(this.axios, this.basePath));
}
/**
* List the package types associated with a specific carrier.
* @summary List carrier package types
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CarriersApi
*/
listCarrierPackageTypes(carrierId, options) {
return (0, exports.CarriersApiFp)(this.configuration).listCarrierPackageTypes(carrierId, options).then((request) => request(this.axios, this.basePath));
}
/**
* List the services associated with a specific carrier id.
* @summary List carrier services
* @param {string} carrierId Carrier ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CarriersApi
*/
listCarrierServices(carrierId, options) {
return (0, exports.CarriersApiFp)(this.configuration).listCarrierServices(carrierId, options).then((request) => request(this.axios, this.basePath));
}
/**
* List all carriers that have been added to this account.
* @summary List carriers
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CarriersApi
*/
listCarriers(options) {
return (0, exports.CarriersApiFp)(this.configuration).listCarriers(options).then((request) => request(this.axios, this.basePath));
}
}
exports.CarriersApi = CarriersApi;