shipstation-client
Version:
ShipStation V2 SDK
105 lines (104 loc) • 4.18 kB
TypeScript
/**
* 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.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { GetWarehouseByIdResponseBody } from '../models';
import type { ListWarehousesResponseBody } from '../models';
/**
* WarehousesApi - axios parameter creator
* @export
*/
export declare const WarehousesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Retrieve warehouse data based on the warehouse ID
* @summary Get warehouse by id
* @param {string} warehouseId Warehouse ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWarehouseById: (warehouseId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Retrieve a list of warehouses associated with this account.
* @summary List warehouses
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listWarehouses: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* WarehousesApi - functional programming interface
* @export
*/
export declare const WarehousesApiFp: (configuration?: Configuration) => {
/**
* Retrieve warehouse data based on the warehouse ID
* @summary Get warehouse by id
* @param {string} warehouseId Warehouse ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWarehouseById(warehouseId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetWarehouseByIdResponseBody>>;
/**
* Retrieve a list of warehouses associated with this account.
* @summary List warehouses
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listWarehouses(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWarehousesResponseBody>>;
};
/**
* WarehousesApi - factory interface
* @export
*/
export declare const WarehousesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Retrieve warehouse data based on the warehouse ID
* @summary Get warehouse by id
* @param {string} warehouseId Warehouse ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWarehouseById(warehouseId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetWarehouseByIdResponseBody>;
/**
* Retrieve a list of warehouses associated with this account.
* @summary List warehouses
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listWarehouses(options?: RawAxiosRequestConfig): AxiosPromise<ListWarehousesResponseBody>;
};
/**
* WarehousesApi - object-oriented interface
* @export
* @class WarehousesApi
* @extends {BaseAPI}
*/
export declare class WarehousesApi extends BaseAPI {
/**
* Retrieve warehouse data based on the warehouse ID
* @summary Get warehouse by id
* @param {string} warehouseId Warehouse ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WarehousesApi
*/
getWarehouseById(warehouseId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Warehouse, any>>;
/**
* Retrieve a list of warehouses associated with this account.
* @summary List warehouses
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WarehousesApi
*/
listWarehouses(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWarehousesResponseBody, any>>;
}