@lob/lob-typescript-sdk/dist/api/buckslip-orders-api.d.ts

Lob API wrapper

/**
 * Lob
 * The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
 *
 * The version of the OpenAPI document: 1.3.0
 * Contact: lob-openapi@lob.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios";
import { Configuration } from "../configuration";
import { RequestArgs, BaseAPI } from "../base";
import { BuckslipOrder } from "../models";
import { BuckslipOrderEditable } from "../models";
import { BuckslipOrdersList } from "../models";
/**
 * BuckslipOrdersApi - axios parameter creator
 * @export
 */
export declare const BuckslipOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Creates a new buckslip order given information
     * @summary create
     * @param {string} buckslipId The ID of the buckslip to which the buckslip orders belong.
     * @param {BuckslipOrderEditable} buckslipOrderEditable
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    buckslipOrderCreate: (buckslipId: string, buckslipOrderEditable: BuckslipOrderEditable, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves the buckslip orders associated with the given buckslip id.
     * @summary get
     * @param {string} buckslipId The ID of the buckslip to which the buckslip orders belong.
     * @param {number} [limit] How many results to return.
     * @param {number} [offset] An integer that designates the offset at which to begin returning results. Defaults to 0.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    buckslipOrdersRetrieve: (buckslipId: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * BuckslipOrdersApi - functional programming interface
 * @export
 */
export declare const BuckslipOrdersApiFp: (configuration?: Configuration) => {
    /**
     * Creates a new buckslip order given information
     * @summary create
     * @param {string} buckslipId The ID of the buckslip to which the buckslip orders belong.
     * @param {BuckslipOrderEditable} buckslipOrderEditable
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    buckslipOrderCreate(buckslipId: string, buckslipOrderEditable: BuckslipOrderEditable, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuckslipOrder>>;
    /**
     * Retrieves the buckslip orders associated with the given buckslip id.
     * @summary get
     * @param {string} buckslipId The ID of the buckslip to which the buckslip orders belong.
     * @param {number} [limit] How many results to return.
     * @param {number} [offset] An integer that designates the offset at which to begin returning results. Defaults to 0.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    buckslipOrdersRetrieve(buckslipId: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuckslipOrdersList>>;
};
/**
 * BuckslipOrdersApi - object-oriented interface
 * @export
 * @class BuckslipOrdersApi
 * @extends {BaseAPI}
 */
export declare class BuckslipOrdersApi extends BaseAPI {
    /**
     * Creates a new buckslip order given information
     * @summary create
     * @param {string} buckslipId The ID of the buckslip to which the buckslip orders belong.
     * @param {BuckslipOrderEditable} buckslipOrderEditable
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BuckslipOrdersApi
     */
    create(buckslipId: string, buckslipOrderEditable: BuckslipOrderEditable, options?: AxiosRequestConfig): Promise<BuckslipOrder>;
    /**
     * Retrieves the buckslip orders associated with the given buckslip id.
     * @summary get
     * @param {string} buckslipId The ID of the buckslip to which the buckslip orders belong.
     * @param {number} [limit] How many results to return.
     * @param {number} [offset] An integer that designates the offset at which to begin returning results. Defaults to 0.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BuckslipOrdersApi
     */
    get(buckslipId: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<BuckslipOrdersList>;
}
/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */