UNPKG

shipstation-client

Version:
502 lines (501 loc) 25.9 kB
/** * 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 { AddNewInventoryWarehouseRequest } from '../models'; import type { CreateInventoryLocationRequest } from '../models'; import type { GetInventoryLevels200Response } from '../models'; import type { GetInventoryWarehouses200Response } from '../models'; import type { GetInventoryWarehouses200ResponseInventoryWarehousesInner } from '../models'; import type { ListInventoryLocations200Response } from '../models'; import type { ListInventoryLocations200ResponseInventoryLocationsInner } from '../models'; import type { UpdateInventoryWarehouseRequest } from '../models'; import type { UpdateSKUStockLevelsRequest } from '../models'; /** * InventoryApi - axios parameter creator * @export */ export declare const InventoryApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create a new inventory warehouse * @param {AddNewInventoryWarehouseRequest} addNewInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewInventoryWarehouse: (addNewInventoryWarehouseRequest: AddNewInventoryWarehouseRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Create a new inventory location * @param {CreateInventoryLocationRequest} createInventoryLocationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInventoryLocation: (createInventoryLocationRequest: CreateInventoryLocationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Delete an inventory location * @param {string} inventoryLocationId * @param {DeleteInventoryLocationByIdRemoveInventoryEnum} [removeInventory] If 1, remove all inventory from the location before deleting it. If 0 or missing and the location has On Hand inventory, the request will fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInventoryLocationById: (inventoryLocationId: string, removeInventory?: DeleteInventoryLocationByIdRemoveInventoryEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Delete an inventory warehouse * @param {string} inventoryWarehouseId * @param {DeleteInventoryWarehouseRemoveInventoryEnum} [removeInventory] If 1, remove all inventory from the warehouse before deleting it. If 0 or missing and the warehouse has On Hand inventory, the request will fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInventoryWarehouse: (inventoryWarehouseId: string, removeInventory?: DeleteInventoryWarehouseRemoveInventoryEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary List SKU inventory levels * @param {string} [sku] Optional list of SKUs to filter down to * @param {string} [inventoryWarehouseId] * @param {string} [inventoryLocationId] * @param {GetInventoryLevelsGroupByEnum} [groupBy] Get counts for SKUs across locations or warehouses * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryLevels: (sku?: string, inventoryWarehouseId?: string, inventoryLocationId?: string, groupBy?: GetInventoryLevelsGroupByEnum, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get inventory location by ID * @param {string} inventoryLocationId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryLocationById: (inventoryLocationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get a specific inventory warehouse and related properties using its warehouse ID * @param {string} inventoryWarehouseId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryWarehouseById: (inventoryWarehouseId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary List all inventory warehouses * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryWarehouses: (limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary List all inventory locations * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInventoryLocations: (limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Update an inventory location name * @param {string} inventoryLocationId * @param {UpdateInventoryWarehouseRequest} updateInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateInventoryLocation: (inventoryLocationId: string, updateInventoryWarehouseRequest: UpdateInventoryWarehouseRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Update an inventory warehouse name * @param {string} inventoryWarehouseId * @param {UpdateInventoryWarehouseRequest} updateInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateInventoryWarehouse: (inventoryWarehouseId: string, updateInventoryWarehouseRequest: UpdateInventoryWarehouseRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Update SKU stock levels and related properties * @param {UpdateSKUStockLevelsRequest} updateSKUStockLevelsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSKUStockLevels: (updateSKUStockLevelsRequest: UpdateSKUStockLevelsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>; }; /** * InventoryApi - functional programming interface * @export */ export declare const InventoryApiFp: (configuration?: Configuration) => { /** * * @summary Create a new inventory warehouse * @param {AddNewInventoryWarehouseRequest} addNewInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewInventoryWarehouse(addNewInventoryWarehouseRequest: AddNewInventoryWarehouseRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInventoryWarehouses200ResponseInventoryWarehousesInner>>; /** * * @summary Create a new inventory location * @param {CreateInventoryLocationRequest} createInventoryLocationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInventoryLocation(createInventoryLocationRequest: CreateInventoryLocationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInventoryLocations200ResponseInventoryLocationsInner>>; /** * * @summary Delete an inventory location * @param {string} inventoryLocationId * @param {DeleteInventoryLocationByIdRemoveInventoryEnum} [removeInventory] If 1, remove all inventory from the location before deleting it. If 0 or missing and the location has On Hand inventory, the request will fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInventoryLocationById(inventoryLocationId: string, removeInventory?: DeleteInventoryLocationByIdRemoveInventoryEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Delete an inventory warehouse * @param {string} inventoryWarehouseId * @param {DeleteInventoryWarehouseRemoveInventoryEnum} [removeInventory] If 1, remove all inventory from the warehouse before deleting it. If 0 or missing and the warehouse has On Hand inventory, the request will fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInventoryWarehouse(inventoryWarehouseId: string, removeInventory?: DeleteInventoryWarehouseRemoveInventoryEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary List SKU inventory levels * @param {string} [sku] Optional list of SKUs to filter down to * @param {string} [inventoryWarehouseId] * @param {string} [inventoryLocationId] * @param {GetInventoryLevelsGroupByEnum} [groupBy] Get counts for SKUs across locations or warehouses * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryLevels(sku?: string, inventoryWarehouseId?: string, inventoryLocationId?: string, groupBy?: GetInventoryLevelsGroupByEnum, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInventoryLevels200Response>>; /** * * @summary Get inventory location by ID * @param {string} inventoryLocationId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryLocationById(inventoryLocationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInventoryLocations200ResponseInventoryLocationsInner>>; /** * * @summary Get a specific inventory warehouse and related properties using its warehouse ID * @param {string} inventoryWarehouseId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryWarehouseById(inventoryWarehouseId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInventoryWarehouses200ResponseInventoryWarehousesInner>>; /** * * @summary List all inventory warehouses * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryWarehouses(limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInventoryWarehouses200Response>>; /** * * @summary List all inventory locations * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInventoryLocations(limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInventoryLocations200Response>>; /** * * @summary Update an inventory location name * @param {string} inventoryLocationId * @param {UpdateInventoryWarehouseRequest} updateInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateInventoryLocation(inventoryLocationId: string, updateInventoryWarehouseRequest: UpdateInventoryWarehouseRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Update an inventory warehouse name * @param {string} inventoryWarehouseId * @param {UpdateInventoryWarehouseRequest} updateInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateInventoryWarehouse(inventoryWarehouseId: string, updateInventoryWarehouseRequest: UpdateInventoryWarehouseRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary Update SKU stock levels and related properties * @param {UpdateSKUStockLevelsRequest} updateSKUStockLevelsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSKUStockLevels(updateSKUStockLevelsRequest: UpdateSKUStockLevelsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; }; /** * InventoryApi - factory interface * @export */ export declare const InventoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create a new inventory warehouse * @param {AddNewInventoryWarehouseRequest} addNewInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ addNewInventoryWarehouse(addNewInventoryWarehouseRequest: AddNewInventoryWarehouseRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetInventoryWarehouses200ResponseInventoryWarehousesInner>; /** * * @summary Create a new inventory location * @param {CreateInventoryLocationRequest} createInventoryLocationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInventoryLocation(createInventoryLocationRequest: CreateInventoryLocationRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListInventoryLocations200ResponseInventoryLocationsInner>; /** * * @summary Delete an inventory location * @param {string} inventoryLocationId * @param {DeleteInventoryLocationByIdRemoveInventoryEnum} [removeInventory] If 1, remove all inventory from the location before deleting it. If 0 or missing and the location has On Hand inventory, the request will fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInventoryLocationById(inventoryLocationId: string, removeInventory?: DeleteInventoryLocationByIdRemoveInventoryEnum, options?: RawAxiosRequestConfig): AxiosPromise<void>; /** * * @summary Delete an inventory warehouse * @param {string} inventoryWarehouseId * @param {DeleteInventoryWarehouseRemoveInventoryEnum} [removeInventory] If 1, remove all inventory from the warehouse before deleting it. If 0 or missing and the warehouse has On Hand inventory, the request will fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInventoryWarehouse(inventoryWarehouseId: string, removeInventory?: DeleteInventoryWarehouseRemoveInventoryEnum, options?: RawAxiosRequestConfig): AxiosPromise<void>; /** * * @summary List SKU inventory levels * @param {string} [sku] Optional list of SKUs to filter down to * @param {string} [inventoryWarehouseId] * @param {string} [inventoryLocationId] * @param {GetInventoryLevelsGroupByEnum} [groupBy] Get counts for SKUs across locations or warehouses * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryLevels(sku?: string, inventoryWarehouseId?: string, inventoryLocationId?: string, groupBy?: GetInventoryLevelsGroupByEnum, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetInventoryLevels200Response>; /** * * @summary Get inventory location by ID * @param {string} inventoryLocationId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryLocationById(inventoryLocationId: string, options?: RawAxiosRequestConfig): AxiosPromise<ListInventoryLocations200ResponseInventoryLocationsInner>; /** * * @summary Get a specific inventory warehouse and related properties using its warehouse ID * @param {string} inventoryWarehouseId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryWarehouseById(inventoryWarehouseId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetInventoryWarehouses200ResponseInventoryWarehousesInner>; /** * * @summary List all inventory warehouses * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInventoryWarehouses(limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<GetInventoryWarehouses200Response>; /** * * @summary List all inventory locations * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInventoryLocations(limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ListInventoryLocations200Response>; /** * * @summary Update an inventory location name * @param {string} inventoryLocationId * @param {UpdateInventoryWarehouseRequest} updateInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateInventoryLocation(inventoryLocationId: string, updateInventoryWarehouseRequest: UpdateInventoryWarehouseRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; /** * * @summary Update an inventory warehouse name * @param {string} inventoryWarehouseId * @param {UpdateInventoryWarehouseRequest} updateInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateInventoryWarehouse(inventoryWarehouseId: string, updateInventoryWarehouseRequest: UpdateInventoryWarehouseRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; /** * * @summary Update SKU stock levels and related properties * @param {UpdateSKUStockLevelsRequest} updateSKUStockLevelsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSKUStockLevels(updateSKUStockLevelsRequest: UpdateSKUStockLevelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>; }; /** * InventoryApi - object-oriented interface * @export * @class InventoryApi * @extends {BaseAPI} */ export declare class InventoryApi extends BaseAPI { /** * * @summary Create a new inventory warehouse * @param {AddNewInventoryWarehouseRequest} addNewInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ addNewInventoryWarehouse(addNewInventoryWarehouseRequest: AddNewInventoryWarehouseRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetInventoryWarehouses200ResponseInventoryWarehousesInner, any>>; /** * * @summary Create a new inventory location * @param {CreateInventoryLocationRequest} createInventoryLocationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ createInventoryLocation(createInventoryLocationRequest: CreateInventoryLocationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInventoryLocations200ResponseInventoryLocationsInner, any>>; /** * * @summary Delete an inventory location * @param {string} inventoryLocationId * @param {DeleteInventoryLocationByIdRemoveInventoryEnum} [removeInventory] If 1, remove all inventory from the location before deleting it. If 0 or missing and the location has On Hand inventory, the request will fail. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ deleteInventoryLocationById(inventoryLocationId: string, removeInventory?: DeleteInventoryLocationByIdRemoveInventoryEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; /** * * @summary Delete an inventory warehouse * @param {string} inventoryWarehouseId * @param {DeleteInventoryWarehouseRemoveInventoryEnum} [removeInventory] If 1, remove all inventory from the warehouse before deleting it. If 0 or missing and the warehouse has On Hand inventory, the request will fail. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ deleteInventoryWarehouse(inventoryWarehouseId: string, removeInventory?: DeleteInventoryWarehouseRemoveInventoryEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; /** * * @summary List SKU inventory levels * @param {string} [sku] Optional list of SKUs to filter down to * @param {string} [inventoryWarehouseId] * @param {string} [inventoryLocationId] * @param {GetInventoryLevelsGroupByEnum} [groupBy] Get counts for SKUs across locations or warehouses * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ getInventoryLevels(sku?: string, inventoryWarehouseId?: string, inventoryLocationId?: string, groupBy?: GetInventoryLevelsGroupByEnum, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetInventoryLevels200Response, any>>; /** * * @summary Get inventory location by ID * @param {string} inventoryLocationId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ getInventoryLocationById(inventoryLocationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInventoryLocations200ResponseInventoryLocationsInner, any>>; /** * * @summary Get a specific inventory warehouse and related properties using its warehouse ID * @param {string} inventoryWarehouseId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ getInventoryWarehouseById(inventoryWarehouseId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetInventoryWarehouses200ResponseInventoryWarehousesInner, any>>; /** * * @summary List all inventory warehouses * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ getInventoryWarehouses(limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetInventoryWarehouses200Response, any>>; /** * * @summary List all inventory locations * @param {number} [limit] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ listInventoryLocations(limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInventoryLocations200Response, any>>; /** * * @summary Update an inventory location name * @param {string} inventoryLocationId * @param {UpdateInventoryWarehouseRequest} updateInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ updateInventoryLocation(inventoryLocationId: string, updateInventoryWarehouseRequest: UpdateInventoryWarehouseRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; /** * * @summary Update an inventory warehouse name * @param {string} inventoryWarehouseId * @param {UpdateInventoryWarehouseRequest} updateInventoryWarehouseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ updateInventoryWarehouse(inventoryWarehouseId: string, updateInventoryWarehouseRequest: UpdateInventoryWarehouseRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; /** * * @summary Update SKU stock levels and related properties * @param {UpdateSKUStockLevelsRequest} updateSKUStockLevelsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InventoryApi */ updateSKUStockLevels(updateSKUStockLevelsRequest: UpdateSKUStockLevelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; } /** * @export */ export declare const DeleteInventoryLocationByIdRemoveInventoryEnum: { readonly _0: "0"; readonly _1: "1"; }; export type DeleteInventoryLocationByIdRemoveInventoryEnum = typeof DeleteInventoryLocationByIdRemoveInventoryEnum[keyof typeof DeleteInventoryLocationByIdRemoveInventoryEnum]; /** * @export */ export declare const DeleteInventoryWarehouseRemoveInventoryEnum: { readonly _0: "0"; readonly _1: "1"; }; export type DeleteInventoryWarehouseRemoveInventoryEnum = typeof DeleteInventoryWarehouseRemoveInventoryEnum[keyof typeof DeleteInventoryWarehouseRemoveInventoryEnum]; /** * @export */ export declare const GetInventoryLevelsGroupByEnum: { readonly Warehouse: "warehouse"; readonly Location: "location"; }; export type GetInventoryLevelsGroupByEnum = typeof GetInventoryLevelsGroupByEnum[keyof typeof GetInventoryLevelsGroupByEnum];