shipstation-client
Version:
ShipStation V2 SDK
90 lines (89 loc) • 3.35 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';
/**
* DownloadsApi - axios parameter creator
* @export
*/
export declare const DownloadsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Download labels and other shipment-related documents.
* @summary Download file
* @param {string} subdir
* @param {string} filename
* @param {string} dir
* @param {string} [download]
* @param {number} [rotation]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
downloadFile: (subdir: string, filename: string, dir: string, download?: string, rotation?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* DownloadsApi - functional programming interface
* @export
*/
export declare const DownloadsApiFp: (configuration?: Configuration) => {
/**
* Download labels and other shipment-related documents.
* @summary Download file
* @param {string} subdir
* @param {string} filename
* @param {string} dir
* @param {string} [download]
* @param {number} [rotation]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
downloadFile(subdir: string, filename: string, dir: string, download?: string, rotation?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
};
/**
* DownloadsApi - factory interface
* @export
*/
export declare const DownloadsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Download labels and other shipment-related documents.
* @summary Download file
* @param {string} subdir
* @param {string} filename
* @param {string} dir
* @param {string} [download]
* @param {number} [rotation]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
downloadFile(subdir: string, filename: string, dir: string, download?: string, rotation?: number, options?: RawAxiosRequestConfig): AxiosPromise<File>;
};
/**
* DownloadsApi - object-oriented interface
* @export
* @class DownloadsApi
* @extends {BaseAPI}
*/
export declare class DownloadsApi extends BaseAPI {
/**
* Download labels and other shipment-related documents.
* @summary Download file
* @param {string} subdir
* @param {string} filename
* @param {string} dir
* @param {string} [download]
* @param {number} [rotation]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DownloadsApi
*/
downloadFile(subdir: string, filename: string, dir: string, download?: string, rotation?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
}