shipstation-client/dist/apis/package-types-api.d.ts

ShipStation V2 SDK

/**
 * 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 { CreatePackageTypeRequestBody } from '../models';
import type { CreatePackageTypeResponseBody } from '../models';
import type { GetPackageTypeByIdResponseBody } from '../models';
import type { ListPackageTypesResponseBody } from '../models';
import type { UpdatePackageTypeRequestBody } from '../models';
/**
 * PackageTypesApi - axios parameter creator
 * @export
 */
export declare const PackageTypesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Create a custom package type to better assist in getting accurate rate estimates
     * @summary Create custom package type
     * @param {CreatePackageTypeRequestBody} createPackageTypeRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createPackageType: (createPackageTypeRequestBody: CreatePackageTypeRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Delete a custom package using the ID
     * @summary Delete a custom package by id
     * @param {string} packageId Package ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePackageTyp: (packageId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get Custom Package Type by ID
     * @summary Get custom package type by id
     * @param {string} packageId Package ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPackageTypeById: (packageId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * List the custom package types associated with the account
     * @summary List custom package types
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listPackageTypes: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Update the custom package type object by ID
     * @summary Update custom package type by id
     * @param {string} packageId Package ID
     * @param {UpdatePackageTypeRequestBody} updatePackageTypeRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePackageType: (packageId: string, updatePackageTypeRequestBody: UpdatePackageTypeRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * PackageTypesApi - functional programming interface
 * @export
 */
export declare const PackageTypesApiFp: (configuration?: Configuration) => {
    /**
     * Create a custom package type to better assist in getting accurate rate estimates
     * @summary Create custom package type
     * @param {CreatePackageTypeRequestBody} createPackageTypeRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createPackageType(createPackageTypeRequestBody: CreatePackageTypeRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePackageTypeResponseBody>>;
    /**
     * Delete a custom package using the ID
     * @summary Delete a custom package by id
     * @param {string} packageId Package ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePackageTyp(packageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * Get Custom Package Type by ID
     * @summary Get custom package type by id
     * @param {string} packageId Package ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPackageTypeById(packageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPackageTypeByIdResponseBody>>;
    /**
     * List the custom package types associated with the account
     * @summary List custom package types
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listPackageTypes(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPackageTypesResponseBody>>;
    /**
     * Update the custom package type object by ID
     * @summary Update custom package type by id
     * @param {string} packageId Package ID
     * @param {UpdatePackageTypeRequestBody} updatePackageTypeRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePackageType(packageId: string, updatePackageTypeRequestBody: UpdatePackageTypeRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
};
/**
 * PackageTypesApi - factory interface
 * @export
 */
export declare const PackageTypesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Create a custom package type to better assist in getting accurate rate estimates
     * @summary Create custom package type
     * @param {CreatePackageTypeRequestBody} createPackageTypeRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createPackageType(createPackageTypeRequestBody: CreatePackageTypeRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<CreatePackageTypeResponseBody>;
    /**
     * Delete a custom package using the ID
     * @summary Delete a custom package by id
     * @param {string} packageId Package ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePackageTyp(packageId: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
    /**
     * Get Custom Package Type by ID
     * @summary Get custom package type by id
     * @param {string} packageId Package ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPackageTypeById(packageId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetPackageTypeByIdResponseBody>;
    /**
     * List the custom package types associated with the account
     * @summary List custom package types
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listPackageTypes(options?: RawAxiosRequestConfig): AxiosPromise<ListPackageTypesResponseBody>;
    /**
     * Update the custom package type object by ID
     * @summary Update custom package type by id
     * @param {string} packageId Package ID
     * @param {UpdatePackageTypeRequestBody} updatePackageTypeRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePackageType(packageId: string, updatePackageTypeRequestBody: UpdatePackageTypeRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<string>;
};
/**
 * PackageTypesApi - object-oriented interface
 * @export
 * @class PackageTypesApi
 * @extends {BaseAPI}
 */
export declare class PackageTypesApi extends BaseAPI {
    /**
     * Create a custom package type to better assist in getting accurate rate estimates
     * @summary Create custom package type
     * @param {CreatePackageTypeRequestBody} createPackageTypeRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageTypesApi
     */
    createPackageType(createPackageTypeRequestBody: CreatePackageTypeRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").PackageType, any>>;
    /**
     * Delete a custom package using the ID
     * @summary Delete a custom package by id
     * @param {string} packageId Package ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageTypesApi
     */
    deletePackageTyp(packageId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
    /**
     * Get Custom Package Type by ID
     * @summary Get custom package type by id
     * @param {string} packageId Package ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageTypesApi
     */
    getPackageTypeById(packageId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").PackageType, any>>;
    /**
     * List the custom package types associated with the account
     * @summary List custom package types
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageTypesApi
     */
    listPackageTypes(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPackageTypesResponseBody, any>>;
    /**
     * Update the custom package type object by ID
     * @summary Update custom package type by id
     * @param {string} packageId Package ID
     * @param {UpdatePackageTypeRequestBody} updatePackageTypeRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageTypesApi
     */
    updatePackageType(packageId: string, updatePackageTypeRequestBody: UpdatePackageTypeRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
}