shipstation-client
Version:
ShipStation V2 SDK
105 lines (104 loc) • 3.9 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 { CreateTagResponseBody } from '../models';
import type { ListTagsResponseBody } from '../models';
/**
* TagsApi - axios parameter creator
* @export
*/
export declare const TagsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Create a new Tag for customizing how you track your shipments
* @summary Create a new tag
* @param {string} tagName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createTag: (tagName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get a list of all tags associated with an account.
* @summary Get tags
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listTags: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* TagsApi - functional programming interface
* @export
*/
export declare const TagsApiFp: (configuration?: Configuration) => {
/**
* Create a new Tag for customizing how you track your shipments
* @summary Create a new tag
* @param {string} tagName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createTag(tagName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTagResponseBody>>;
/**
* Get a list of all tags associated with an account.
* @summary Get tags
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listTags(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTagsResponseBody>>;
};
/**
* TagsApi - factory interface
* @export
*/
export declare const TagsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Create a new Tag for customizing how you track your shipments
* @summary Create a new tag
* @param {string} tagName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createTag(tagName: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateTagResponseBody>;
/**
* Get a list of all tags associated with an account.
* @summary Get tags
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listTags(options?: RawAxiosRequestConfig): AxiosPromise<ListTagsResponseBody>;
};
/**
* TagsApi - object-oriented interface
* @export
* @class TagsApi
* @extends {BaseAPI}
*/
export declare class TagsApi extends BaseAPI {
/**
* Create a new Tag for customizing how you track your shipments
* @summary Create a new tag
* @param {string} tagName
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TagsApi
*/
createTag(tagName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Tag, any>>;
/**
* Get a list of all tags associated with an account.
* @summary Get tags
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TagsApi
*/
listTags(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTagsResponseBody, any>>;
}