shipstation-client/dist/apis/rates-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 { CalculateRatesRequestBody } from '../models';
import type { CalculateRatesResponseBody } from '../models';
import type { EstimateRatesRequestBody } from '../models';
import type { GetRateByIdResponseBody } from '../models';
import type { RateEstimate } from '../models';
/**
 * RatesApi - axios parameter creator
 * @export
 */
export declare const RatesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * It\'s not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don\'t solely ship things using a single shipping option; so we provide functionality to show you all your options!
     * @summary Get shipping rates
     * @param {CalculateRatesRequestBody} calculateRatesRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    calculateRates: (calculateRatesRequestBody: CalculateRatesRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get Rate Estimates
     * @summary Estimate rates
     * @param {EstimateRatesRequestBody} estimateRatesRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    estimateRates: (estimateRatesRequestBody: EstimateRatesRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieve a previously queried rate by its ID
     * @summary Get rate by id
     * @param {string} rateId Rate ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRateById: (rateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * RatesApi - functional programming interface
 * @export
 */
export declare const RatesApiFp: (configuration?: Configuration) => {
    /**
     * It\'s not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don\'t solely ship things using a single shipping option; so we provide functionality to show you all your options!
     * @summary Get shipping rates
     * @param {CalculateRatesRequestBody} calculateRatesRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    calculateRates(calculateRatesRequestBody: CalculateRatesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CalculateRatesResponseBody>>;
    /**
     * Get Rate Estimates
     * @summary Estimate rates
     * @param {EstimateRatesRequestBody} estimateRatesRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    estimateRates(estimateRatesRequestBody: EstimateRatesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RateEstimate>>>;
    /**
     * Retrieve a previously queried rate by its ID
     * @summary Get rate by id
     * @param {string} rateId Rate ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRateById(rateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRateByIdResponseBody>>;
};
/**
 * RatesApi - factory interface
 * @export
 */
export declare const RatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * It\'s not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don\'t solely ship things using a single shipping option; so we provide functionality to show you all your options!
     * @summary Get shipping rates
     * @param {CalculateRatesRequestBody} calculateRatesRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    calculateRates(calculateRatesRequestBody: CalculateRatesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<CalculateRatesResponseBody>;
    /**
     * Get Rate Estimates
     * @summary Estimate rates
     * @param {EstimateRatesRequestBody} estimateRatesRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    estimateRates(estimateRatesRequestBody: EstimateRatesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<Array<RateEstimate>>;
    /**
     * Retrieve a previously queried rate by its ID
     * @summary Get rate by id
     * @param {string} rateId Rate ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRateById(rateId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetRateByIdResponseBody>;
};
/**
 * RatesApi - object-oriented interface
 * @export
 * @class RatesApi
 * @extends {BaseAPI}
 */
export declare class RatesApi extends BaseAPI {
    /**
     * It\'s not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don\'t solely ship things using a single shipping option; so we provide functionality to show you all your options!
     * @summary Get shipping rates
     * @param {CalculateRatesRequestBody} calculateRatesRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RatesApi
     */
    calculateRates(calculateRatesRequestBody: CalculateRatesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").PartialShipment, any>>;
    /**
     * Get Rate Estimates
     * @summary Estimate rates
     * @param {EstimateRatesRequestBody} estimateRatesRequestBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RatesApi
     */
    estimateRates(estimateRatesRequestBody: EstimateRatesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RateEstimate[], any>>;
    /**
     * Retrieve a previously queried rate by its ID
     * @summary Get rate by id
     * @param {string} rateId Rate ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof RatesApi
     */
    getRateById(rateId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Rate, any>>;
}