shipstation-client
Version:
ShipStation V2 SDK
138 lines (137 loc) • 6.94 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());
});
};
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
/**
* TrackingApi - axios parameter creator
* @export
*/
export const TrackingApiAxiosParamCreator = function (configuration) {
return {
/**
* Unsubscribe from tracking updates for a package.
* @summary Stop tracking a package
* @param {string} [carrierCode] A [shipping carrier] , such as `fedex`, `dhl_express`, `stamps_com`, etc.
* @param {string} [trackingNumber] The tracking number associated with a shipment
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
stopTracking: (carrierCode_1, trackingNumber_1, ...args_1) => __awaiter(this, [carrierCode_1, trackingNumber_1, ...args_1], void 0, function* (carrierCode, trackingNumber, options = {}) {
const localVarPath = `/v2/tracking/stop`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 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 api_keys required
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
if (carrierCode !== undefined) {
localVarQueryParameter['carrier_code'] = carrierCode;
}
if (trackingNumber !== undefined) {
localVarQueryParameter['tracking_number'] = trackingNumber;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
};
};
/**
* TrackingApi - functional programming interface
* @export
*/
export const TrackingApiFp = function (configuration) {
const localVarAxiosParamCreator = TrackingApiAxiosParamCreator(configuration);
return {
/**
* Unsubscribe from tracking updates for a package.
* @summary Stop tracking a package
* @param {string} [carrierCode] A [shipping carrier] , such as `fedex`, `dhl_express`, `stamps_com`, etc.
* @param {string} [trackingNumber] The tracking number associated with a shipment
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
stopTracking(carrierCode, trackingNumber, options) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b, _c;
const localVarAxiosArgs = yield localVarAxiosParamCreator.stopTracking(carrierCode, trackingNumber, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['TrackingApi.stopTracking']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
});
},
};
};
/**
* TrackingApi - factory interface
* @export
*/
export const TrackingApiFactory = function (configuration, basePath, axios) {
const localVarFp = TrackingApiFp(configuration);
return {
/**
* Unsubscribe from tracking updates for a package.
* @summary Stop tracking a package
* @param {string} [carrierCode] A [shipping carrier] , such as `fedex`, `dhl_express`, `stamps_com`, etc.
* @param {string} [trackingNumber] The tracking number associated with a shipment
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
stopTracking(carrierCode, trackingNumber, options) {
return localVarFp.stopTracking(carrierCode, trackingNumber, options).then((request) => request(axios, basePath));
},
};
};
/**
* TrackingApi - object-oriented interface
* @export
* @class TrackingApi
* @extends {BaseAPI}
*/
export class TrackingApi extends BaseAPI {
/**
* Unsubscribe from tracking updates for a package.
* @summary Stop tracking a package
* @param {string} [carrierCode] A [shipping carrier] , such as `fedex`, `dhl_express`, `stamps_com`, etc.
* @param {string} [trackingNumber] The tracking number associated with a shipment
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TrackingApi
*/
stopTracking(carrierCode, trackingNumber, options) {
return TrackingApiFp(this.configuration).stopTracking(carrierCode, trackingNumber, options).then((request) => request(this.axios, this.basePath));
}
}