shipstation-client/dist/apis/carriers-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 { GetCarrierByIdResponseBody } from '../models';
import type { GetCarrierOptionsResponseBody } from '../models';
import type { GetCarriersResponseBody } from '../models';
import type { ListCarrierPackageTypesResponseBody } from '../models';
import type { ListCarrierServicesResponseBody } from '../models';
/**
 * CarriersApi - axios parameter creator
 * @export
 */
export declare const CarriersApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Retrive details about a specific carrier by its carrier id.
     * @summary Get carrier by id
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCarrierById: (carrierId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get a list of the options available for a specific carriers.
     * @summary Get carrier options
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCarrierOptions: (carrierId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * List the package types associated with a specific carrier.
     * @summary List carrier package types
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listCarrierPackageTypes: (carrierId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * List the services associated with a specific carrier id.
     * @summary List carrier services
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listCarrierServices: (carrierId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * List all carriers that have been added to this account.
     * @summary List carriers
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listCarriers: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * CarriersApi - functional programming interface
 * @export
 */
export declare const CarriersApiFp: (configuration?: Configuration) => {
    /**
     * Retrive details about a specific carrier by its carrier id.
     * @summary Get carrier by id
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCarrierById(carrierId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCarrierByIdResponseBody>>;
    /**
     * Get a list of the options available for a specific carriers.
     * @summary Get carrier options
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCarrierOptions(carrierId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCarrierOptionsResponseBody>>;
    /**
     * List the package types associated with a specific carrier.
     * @summary List carrier package types
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listCarrierPackageTypes(carrierId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCarrierPackageTypesResponseBody>>;
    /**
     * List the services associated with a specific carrier id.
     * @summary List carrier services
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listCarrierServices(carrierId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCarrierServicesResponseBody>>;
    /**
     * List all carriers that have been added to this account.
     * @summary List carriers
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listCarriers(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCarriersResponseBody>>;
};
/**
 * CarriersApi - factory interface
 * @export
 */
export declare const CarriersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Retrive details about a specific carrier by its carrier id.
     * @summary Get carrier by id
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCarrierById(carrierId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetCarrierByIdResponseBody>;
    /**
     * Get a list of the options available for a specific carriers.
     * @summary Get carrier options
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCarrierOptions(carrierId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetCarrierOptionsResponseBody>;
    /**
     * List the package types associated with a specific carrier.
     * @summary List carrier package types
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listCarrierPackageTypes(carrierId: string, options?: RawAxiosRequestConfig): AxiosPromise<ListCarrierPackageTypesResponseBody>;
    /**
     * List the services associated with a specific carrier id.
     * @summary List carrier services
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listCarrierServices(carrierId: string, options?: RawAxiosRequestConfig): AxiosPromise<ListCarrierServicesResponseBody>;
    /**
     * List all carriers that have been added to this account.
     * @summary List carriers
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listCarriers(options?: RawAxiosRequestConfig): AxiosPromise<GetCarriersResponseBody>;
};
/**
 * CarriersApi - object-oriented interface
 * @export
 * @class CarriersApi
 * @extends {BaseAPI}
 */
export declare class CarriersApi extends BaseAPI {
    /**
     * Retrive details about a specific carrier by its carrier id.
     * @summary Get carrier by id
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CarriersApi
     */
    getCarrierById(carrierId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Carrier, any>>;
    /**
     * Get a list of the options available for a specific carriers.
     * @summary Get carrier options
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CarriersApi
     */
    getCarrierOptions(carrierId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCarrierOptionsResponseBody, any>>;
    /**
     * List the package types associated with a specific carrier.
     * @summary List carrier package types
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CarriersApi
     */
    listCarrierPackageTypes(carrierId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCarrierPackageTypesResponseBody, any>>;
    /**
     * List the services associated with a specific carrier id.
     * @summary List carrier services
     * @param {string} carrierId Carrier ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CarriersApi
     */
    listCarrierServices(carrierId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCarrierServicesResponseBody, any>>;
    /**
     * List all carriers that have been added to this account.
     * @summary List carriers
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CarriersApi
     */
    listCarriers(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCarriersResponseBody, any>>;
}