@datenkraft/bb-fulfillment-api-ts-client/dist/Generated/apis/delivery-expense-api.d.ts

The fulfillment API TS Client enables you to work with the fulfillment API

/**
 * Fulfillment API
 *  - alpha: Currently developed API version. Subject to major changes. - beta: A semi-stable early access version. New features can be added. Breaking changes are possible. - stable: The API is recommended for use in production.  [Changelog](https://fulfillment-api.steve.niceshops.com/v2/docs/changelog.html)  All data is transferred in UTF-8 encoding.\\ The API uses stateless HTTP. No cookies have to be kept.\\ Authentication via OAuth2 client credentials flow.  [Privacy Policy](https://www.niceshops.com/en/dienstleistungen/data-privacy-policy)  [Fulfillment API PHP client @Packagist](https://packagist.org/packages/datenkraft/bb-fulfillment-api-php-client)
 *
 * The version of the OpenAPI document: v2.beta
 *
 *
 * 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, AxiosRequestConfig } from 'axios';
import { RequestArgs, BaseAPI } from '../base';
import { DeliveryExpenseCollection } from '../models';
/**
 * DeliveryExpenseApi - axios parameter creator
 * @export
 */
export declare const DeliveryExpenseApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Get a list of delivery expenses.
     * @summary Get a list of delivery expenses.
     * @param {string} countryCode Country code of the manufacturer (ISO 3166-1 alpha-2).
     * @param {number} weight weight in gram
     * @param {number} length length in mm
     * @param {number} width width in mm
     * @param {number} height height in mm
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 100.
     * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance.
     * @param {string} [shopCode] This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error.
     * @param {string} [zipCode] zip code
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeliveryExpenseCollection: (countryCode: string, weight: number, length: number, width: number, height: number, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', shopCode?: string, zipCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * DeliveryExpenseApi - functional programming interface
 * @export
 */
export declare const DeliveryExpenseApiFp: (configuration?: Configuration) => {
    /**
     * Get a list of delivery expenses.
     * @summary Get a list of delivery expenses.
     * @param {string} countryCode Country code of the manufacturer (ISO 3166-1 alpha-2).
     * @param {number} weight weight in gram
     * @param {number} length length in mm
     * @param {number} width width in mm
     * @param {number} height height in mm
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 100.
     * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance.
     * @param {string} [shopCode] This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error.
     * @param {string} [zipCode] zip code
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeliveryExpenseCollection(countryCode: string, weight: number, length: number, width: number, height: number, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', shopCode?: string, zipCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeliveryExpenseCollection>>;
};
/**
 * DeliveryExpenseApi - factory interface
 * @export
 */
export declare const DeliveryExpenseApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Get a list of delivery expenses.
     * @summary Get a list of delivery expenses.
     * @param {string} countryCode Country code of the manufacturer (ISO 3166-1 alpha-2).
     * @param {number} weight weight in gram
     * @param {number} length length in mm
     * @param {number} width width in mm
     * @param {number} height height in mm
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 100.
     * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance.
     * @param {string} [shopCode] This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error.
     * @param {string} [zipCode] zip code
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeliveryExpenseCollection(countryCode: string, weight: number, length: number, width: number, height: number, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', shopCode?: string, zipCode?: string, options?: any): AxiosPromise<DeliveryExpenseCollection>;
};
/**
 * DeliveryExpenseApi - interface
 * @export
 * @interface DeliveryExpenseApi
 */
export interface DeliveryExpenseApiInterface {
    /**
     * Get a list of delivery expenses.
     * @summary Get a list of delivery expenses.
     * @param {string} countryCode Country code of the manufacturer (ISO 3166-1 alpha-2).
     * @param {number} weight weight in gram
     * @param {number} length length in mm
     * @param {number} width width in mm
     * @param {number} height height in mm
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 100.
     * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance.
     * @param {string} [shopCode] This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error.
     * @param {string} [zipCode] zip code
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DeliveryExpenseApiInterface
     */
    getDeliveryExpenseCollection(countryCode: string, weight: number, length: number, width: number, height: number, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', shopCode?: string, zipCode?: string, options?: AxiosRequestConfig): AxiosPromise<DeliveryExpenseCollection>;
}
/**
 * DeliveryExpenseApi - object-oriented interface
 * @export
 * @class DeliveryExpenseApi
 * @extends {BaseAPI}
 */
export declare class DeliveryExpenseApi extends BaseAPI implements DeliveryExpenseApiInterface {
    /**
     * Get a list of delivery expenses.
     * @summary Get a list of delivery expenses.
     * @param {string} countryCode Country code of the manufacturer (ISO 3166-1 alpha-2).
     * @param {number} weight weight in gram
     * @param {number} length length in mm
     * @param {number} width width in mm
     * @param {number} height height in mm
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 100.
     * @param {'default' | 'totalCount'} [paginationMode] The paginationMode to use: - default: The total number of items in the collection will not be calculated. - totalCount: The total number of items in the collection will be calculated. This can mean loss of performance.
     * @param {string} [shopCode] This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error.
     * @param {string} [zipCode] zip code
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DeliveryExpenseApi
     */
    getDeliveryExpenseCollection(countryCode: string, weight: number, length: number, width: number, height: number, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', shopCode?: string, zipCode?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeliveryExpenseCollection, any>>;
}