@datenkraft/bb-fulfillment-api-ts-client/dist/Generated/apis/delivery-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 { Delivery } from '../models';
import { DeliveryCollection } from '../models';
import { DeliveryShipment } from '../models';
import { UpdateDeliveryShipment } from '../models';
/**
 * DeliveryApi - axios parameter creator
 * @export
 */
export declare const DeliveryApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Get the delivery with the given deliveryNumber.
     * @summary Get the delivery with the given deliveryNumber.
     * @param {string} deliveryNumber Number of the delivery
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDelivery: (deliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get a collection of deliveries.
     * @summary Get a collection of deliveries.
     * @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] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {string} [filterOrderNumber] A filter for a single order number or multiple order numbers separated by a comma. - The filter can contain a maximum of 100 order numbers. - The order numbers in the filter must be unique. - A single order number can have a maximum length of 59 characters.
     * @param {boolean} [filterAllShipmentsHaveExternalShipmentIds] A filter to only return deliveries where all shipments have an external shipment ID or not.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeliveryCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', shopCode?: string, filterOrderNumber?: string, filterAllShipmentsHaveExternalShipmentIds?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Allows to download a document associated with the given delivery.
     * @summary Download delivery related documents
     * @param {string} deliveryNumber The number of the delivery
     * @param {'deliverySlipNote'} documentCode The document type to download. The file format is determined by the Accept request header.\\ **Note:** Only a limited amount of document type to file format combinations are available: - deliverySlipNote: The delivery slip note to confirm successful delivery.\\ Accept header: application/pdf
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeliveryDocument: (deliveryNumber: string, documentCode: 'deliverySlipNote', shopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
     * @summary Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
     * @param {string} deliveryNumber Number of the delivery.
     * @param {string} shipmentNumber Number of the shipment.
     * @param {UpdateDeliveryShipment} updateDeliveryShipment
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchDeliveryShipment: (deliveryNumber: string, shipmentNumber: string, updateDeliveryShipment: UpdateDeliveryShipment, shopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * DeliveryApi - functional programming interface
 * @export
 */
export declare const DeliveryApiFp: (configuration?: Configuration) => {
    /**
     * Get the delivery with the given deliveryNumber.
     * @summary Get the delivery with the given deliveryNumber.
     * @param {string} deliveryNumber Number of the delivery
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDelivery(deliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Delivery>>;
    /**
     * Get a collection of deliveries.
     * @summary Get a collection of deliveries.
     * @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] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {string} [filterOrderNumber] A filter for a single order number or multiple order numbers separated by a comma. - The filter can contain a maximum of 100 order numbers. - The order numbers in the filter must be unique. - A single order number can have a maximum length of 59 characters.
     * @param {boolean} [filterAllShipmentsHaveExternalShipmentIds] A filter to only return deliveries where all shipments have an external shipment ID or not.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeliveryCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', shopCode?: string, filterOrderNumber?: string, filterAllShipmentsHaveExternalShipmentIds?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeliveryCollection>>;
    /**
     * Allows to download a document associated with the given delivery.
     * @summary Download delivery related documents
     * @param {string} deliveryNumber The number of the delivery
     * @param {'deliverySlipNote'} documentCode The document type to download. The file format is determined by the Accept request header.\\ **Note:** Only a limited amount of document type to file format combinations are available: - deliverySlipNote: The delivery slip note to confirm successful delivery.\\ Accept header: application/pdf
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeliveryDocument(deliveryNumber: string, documentCode: 'deliverySlipNote', shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
    /**
     * Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
     * @summary Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
     * @param {string} deliveryNumber Number of the delivery.
     * @param {string} shipmentNumber Number of the shipment.
     * @param {UpdateDeliveryShipment} updateDeliveryShipment
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchDeliveryShipment(deliveryNumber: string, shipmentNumber: string, updateDeliveryShipment: UpdateDeliveryShipment, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeliveryShipment>>;
};
/**
 * DeliveryApi - factory interface
 * @export
 */
export declare const DeliveryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Get the delivery with the given deliveryNumber.
     * @summary Get the delivery with the given deliveryNumber.
     * @param {string} deliveryNumber Number of the delivery
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDelivery(deliveryNumber: string, shopCode?: string, options?: any): AxiosPromise<Delivery>;
    /**
     * Get a collection of deliveries.
     * @summary Get a collection of deliveries.
     * @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] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {string} [filterOrderNumber] A filter for a single order number or multiple order numbers separated by a comma. - The filter can contain a maximum of 100 order numbers. - The order numbers in the filter must be unique. - A single order number can have a maximum length of 59 characters.
     * @param {boolean} [filterAllShipmentsHaveExternalShipmentIds] A filter to only return deliveries where all shipments have an external shipment ID or not.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeliveryCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', shopCode?: string, filterOrderNumber?: string, filterAllShipmentsHaveExternalShipmentIds?: boolean, options?: any): AxiosPromise<DeliveryCollection>;
    /**
     * Allows to download a document associated with the given delivery.
     * @summary Download delivery related documents
     * @param {string} deliveryNumber The number of the delivery
     * @param {'deliverySlipNote'} documentCode The document type to download. The file format is determined by the Accept request header.\\ **Note:** Only a limited amount of document type to file format combinations are available: - deliverySlipNote: The delivery slip note to confirm successful delivery.\\ Accept header: application/pdf
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDeliveryDocument(deliveryNumber: string, documentCode: 'deliverySlipNote', shopCode?: string, options?: any): AxiosPromise<File>;
    /**
     * Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
     * @summary Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
     * @param {string} deliveryNumber Number of the delivery.
     * @param {string} shipmentNumber Number of the shipment.
     * @param {UpdateDeliveryShipment} updateDeliveryShipment
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchDeliveryShipment(deliveryNumber: string, shipmentNumber: string, updateDeliveryShipment: UpdateDeliveryShipment, shopCode?: string, options?: any): AxiosPromise<DeliveryShipment>;
};
/**
 * DeliveryApi - interface
 * @export
 * @interface DeliveryApi
 */
export interface DeliveryApiInterface {
    /**
     * Get the delivery with the given deliveryNumber.
     * @summary Get the delivery with the given deliveryNumber.
     * @param {string} deliveryNumber Number of the delivery
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DeliveryApiInterface
     */
    getDelivery(deliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise<Delivery>;
    /**
     * Get a collection of deliveries.
     * @summary Get a collection of deliveries.
     * @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] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {string} [filterOrderNumber] A filter for a single order number or multiple order numbers separated by a comma. - The filter can contain a maximum of 100 order numbers. - The order numbers in the filter must be unique. - A single order number can have a maximum length of 59 characters.
     * @param {boolean} [filterAllShipmentsHaveExternalShipmentIds] A filter to only return deliveries where all shipments have an external shipment ID or not.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DeliveryApiInterface
     */
    getDeliveryCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', shopCode?: string, filterOrderNumber?: string, filterAllShipmentsHaveExternalShipmentIds?: boolean, options?: AxiosRequestConfig): AxiosPromise<DeliveryCollection>;
    /**
     * Allows to download a document associated with the given delivery.
     * @summary Download delivery related documents
     * @param {string} deliveryNumber The number of the delivery
     * @param {'deliverySlipNote'} documentCode The document type to download. The file format is determined by the Accept request header.\\ **Note:** Only a limited amount of document type to file format combinations are available: - deliverySlipNote: The delivery slip note to confirm successful delivery.\\ Accept header: application/pdf
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DeliveryApiInterface
     */
    getDeliveryDocument(deliveryNumber: string, documentCode: 'deliverySlipNote', shopCode?: string, options?: AxiosRequestConfig): AxiosPromise<File>;
    /**
     * Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
     * @summary Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
     * @param {string} deliveryNumber Number of the delivery.
     * @param {string} shipmentNumber Number of the shipment.
     * @param {UpdateDeliveryShipment} updateDeliveryShipment
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DeliveryApiInterface
     */
    patchDeliveryShipment(deliveryNumber: string, shipmentNumber: string, updateDeliveryShipment: UpdateDeliveryShipment, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise<DeliveryShipment>;
}
/**
 * DeliveryApi - object-oriented interface
 * @export
 * @class DeliveryApi
 * @extends {BaseAPI}
 */
export declare class DeliveryApi extends BaseAPI implements DeliveryApiInterface {
    /**
     * Get the delivery with the given deliveryNumber.
     * @summary Get the delivery with the given deliveryNumber.
     * @param {string} deliveryNumber Number of the delivery
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DeliveryApi
     */
    getDelivery(deliveryNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Delivery, any>>;
    /**
     * Get a collection of deliveries.
     * @summary Get a collection of deliveries.
     * @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] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {string} [filterOrderNumber] A filter for a single order number or multiple order numbers separated by a comma. - The filter can contain a maximum of 100 order numbers. - The order numbers in the filter must be unique. - A single order number can have a maximum length of 59 characters.
     * @param {boolean} [filterAllShipmentsHaveExternalShipmentIds] A filter to only return deliveries where all shipments have an external shipment ID or not.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DeliveryApi
     */
    getDeliveryCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', shopCode?: string, filterOrderNumber?: string, filterAllShipmentsHaveExternalShipmentIds?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeliveryCollection, any>>;
    /**
     * Allows to download a document associated with the given delivery.
     * @summary Download delivery related documents
     * @param {string} deliveryNumber The number of the delivery
     * @param {'deliverySlipNote'} documentCode The document type to download. The file format is determined by the Accept request header.\\ **Note:** Only a limited amount of document type to file format combinations are available: - deliverySlipNote: The delivery slip note to confirm successful delivery.\\ Accept header: application/pdf
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DeliveryApi
     */
    getDeliveryDocument(deliveryNumber: string, documentCode: 'deliverySlipNote', shopCode?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
    /**
     * Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
     * @summary Patch data of the shipment of the delivery specified by the given delivery and shipment numbers.
     * @param {string} deliveryNumber Number of the delivery.
     * @param {string} shipmentNumber Number of the shipment.
     * @param {UpdateDeliveryShipment} updateDeliveryShipment
     * @param {string} [shopCode] The shopCode used internally to distinguish between clients. \\ _This code is optional, if your identity is assigned to only one shop. Otherwise the response would be a 422 HTTP Error._
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DeliveryApi
     */
    patchDeliveryShipment(deliveryNumber: string, shipmentNumber: string, updateDeliveryShipment: UpdateDeliveryShipment, shopCode?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeliveryShipment, any>>;
}