shipstation-client/dist/apis/tracking-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';
/**
 * TrackingApi - axios parameter creator
 * @export
 */
export declare const TrackingApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Unsubscribe from tracking updates for a package.
     * @summary Stop tracking a package
     * @param {string} [carrierCode] A [shipping carrier] , such as `fedex`, `dhl_express`, `stamps_com`, etc.
     * @param {string} [trackingNumber] The tracking number associated with a shipment
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    stopTracking: (carrierCode?: string, trackingNumber?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * TrackingApi - functional programming interface
 * @export
 */
export declare const TrackingApiFp: (configuration?: Configuration) => {
    /**
     * Unsubscribe from tracking updates for a package.
     * @summary Stop tracking a package
     * @param {string} [carrierCode] A [shipping carrier] , such as &#x60;fedex&#x60;, &#x60;dhl_express&#x60;, &#x60;stamps_com&#x60;, etc.
     * @param {string} [trackingNumber] The tracking number associated with a shipment
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    stopTracking(carrierCode?: string, trackingNumber?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
};
/**
 * TrackingApi - factory interface
 * @export
 */
export declare const TrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Unsubscribe from tracking updates for a package.
     * @summary Stop tracking a package
     * @param {string} [carrierCode] A [shipping carrier] , such as &#x60;fedex&#x60;, &#x60;dhl_express&#x60;, &#x60;stamps_com&#x60;, etc.
     * @param {string} [trackingNumber] The tracking number associated with a shipment
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    stopTracking(carrierCode?: string, trackingNumber?: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
};
/**
 * TrackingApi - object-oriented interface
 * @export
 * @class TrackingApi
 * @extends {BaseAPI}
 */
export declare class TrackingApi extends BaseAPI {
    /**
     * Unsubscribe from tracking updates for a package.
     * @summary Stop tracking a package
     * @param {string} [carrierCode] A [shipping carrier] , such as &#x60;fedex&#x60;, &#x60;dhl_express&#x60;, &#x60;stamps_com&#x60;, etc.
     * @param {string} [trackingNumber] The tracking number associated with a shipment
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TrackingApi
     */
    stopTracking(carrierCode?: string, trackingNumber?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
}