@datenkraft/bb-fulfillment-api-ts-client/dist/Generated/apis/reconsignment-announcement-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 { ReconsignmentAnnouncement } from '../models';
import { ReconsignmentAnnouncementPaginatedCollection } from '../models';
/**
 * ReconsignmentAnnouncementApi - axios parameter creator
 * @export
 */
export declare const ReconsignmentAnnouncementApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
     * @summary Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
     * @param {string} reconsignmentAnnouncementNumber Number of the reconsignment announcement
     * @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}
     */
    getReconsignmentAnnouncement: (reconsignmentAnnouncementNumber: string, shopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Get reconsignment announcements.
     * @summary Get reconsignment announcements.
     * @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} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority.  Available sort orders: - asc: ascending order - desc: descending order  Available fields for sorting: - reconsignmentAnnouncementDate  The default sort order is reconsignmentAnnouncementDate:desc.
     * @param {string} [filterShopCode] 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] Filter for a single order number.
     * @param {boolean} [filterReconsignmentAnnouncementCompleted] Filter for completed or not completed reconsignment announcements.
     * @param {string} [filterReconsignmentAnnouncementDateFrom] Filter for reconsignmentAnnouncementDate (from)
     * @param {string} [filterReconsignmentAnnouncementDateTo] Filter for reconsignmentAnnouncementDate (to)
     * @param {string} [filterSearch] Filter for reconsignment announcement search.  Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields reconsignmentAnnouncementNumber, orderNumber, externalOrderReference and reconsignmentTrackingCode. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]&#x3D;\&#39;term1 term2\&#39; will filter the result for reconsignment announcements where \&#39;term1\&#39; is found in any field and \&#39;term2\&#39; is also found in any field.\\ If only \&#39;term1\&#39; or \&#39;term2\&#39; is found in the fields, the reconsignment announcement is not included in the results.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getReconsignmentAnnouncementCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterOrderNumber?: string, filterReconsignmentAnnouncementCompleted?: boolean, filterReconsignmentAnnouncementDateFrom?: string, filterReconsignmentAnnouncementDateTo?: string, filterSearch?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Allows to download a document associated with the given reconsignmentAnnouncement.
     * @summary Download reconsignmentAnnouncement related documents.
     * @param {string} reconsignmentAnnouncementNumber The number of the reconsignmentAnnouncement.
     * @param {'shippingLabel'} 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: - shippingLabel: The shipping label for the end customer to ship goods back to the steve warehouse.\\ 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}
     */
    getReconsignmentAnnouncementDocument: (reconsignmentAnnouncementNumber: string, documentCode: 'shippingLabel', shopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ReconsignmentAnnouncementApi - functional programming interface
 * @export
 */
export declare const ReconsignmentAnnouncementApiFp: (configuration?: Configuration) => {
    /**
     * Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
     * @summary Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
     * @param {string} reconsignmentAnnouncementNumber Number of the reconsignment announcement
     * @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}
     */
    getReconsignmentAnnouncement(reconsignmentAnnouncementNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReconsignmentAnnouncement>>;
    /**
     * Get reconsignment announcements.
     * @summary Get reconsignment announcements.
     * @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} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority.  Available sort orders: - asc: ascending order - desc: descending order  Available fields for sorting: - reconsignmentAnnouncementDate  The default sort order is reconsignmentAnnouncementDate:desc.
     * @param {string} [filterShopCode] 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] Filter for a single order number.
     * @param {boolean} [filterReconsignmentAnnouncementCompleted] Filter for completed or not completed reconsignment announcements.
     * @param {string} [filterReconsignmentAnnouncementDateFrom] Filter for reconsignmentAnnouncementDate (from)
     * @param {string} [filterReconsignmentAnnouncementDateTo] Filter for reconsignmentAnnouncementDate (to)
     * @param {string} [filterSearch] Filter for reconsignment announcement search.  Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields reconsignmentAnnouncementNumber, orderNumber, externalOrderReference and reconsignmentTrackingCode. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]&#x3D;\&#39;term1 term2\&#39; will filter the result for reconsignment announcements where \&#39;term1\&#39; is found in any field and \&#39;term2\&#39; is also found in any field.\\ If only \&#39;term1\&#39; or \&#39;term2\&#39; is found in the fields, the reconsignment announcement is not included in the results.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getReconsignmentAnnouncementCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterOrderNumber?: string, filterReconsignmentAnnouncementCompleted?: boolean, filterReconsignmentAnnouncementDateFrom?: string, filterReconsignmentAnnouncementDateTo?: string, filterSearch?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReconsignmentAnnouncementPaginatedCollection>>;
    /**
     * Allows to download a document associated with the given reconsignmentAnnouncement.
     * @summary Download reconsignmentAnnouncement related documents.
     * @param {string} reconsignmentAnnouncementNumber The number of the reconsignmentAnnouncement.
     * @param {'shippingLabel'} 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: - shippingLabel: The shipping label for the end customer to ship goods back to the steve warehouse.\\ 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}
     */
    getReconsignmentAnnouncementDocument(reconsignmentAnnouncementNumber: string, documentCode: 'shippingLabel', shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
};
/**
 * ReconsignmentAnnouncementApi - factory interface
 * @export
 */
export declare const ReconsignmentAnnouncementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
     * @summary Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
     * @param {string} reconsignmentAnnouncementNumber Number of the reconsignment announcement
     * @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}
     */
    getReconsignmentAnnouncement(reconsignmentAnnouncementNumber: string, shopCode?: string, options?: any): AxiosPromise<ReconsignmentAnnouncement>;
    /**
     * Get reconsignment announcements.
     * @summary Get reconsignment announcements.
     * @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} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority.  Available sort orders: - asc: ascending order - desc: descending order  Available fields for sorting: - reconsignmentAnnouncementDate  The default sort order is reconsignmentAnnouncementDate:desc.
     * @param {string} [filterShopCode] 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] Filter for a single order number.
     * @param {boolean} [filterReconsignmentAnnouncementCompleted] Filter for completed or not completed reconsignment announcements.
     * @param {string} [filterReconsignmentAnnouncementDateFrom] Filter for reconsignmentAnnouncementDate (from)
     * @param {string} [filterReconsignmentAnnouncementDateTo] Filter for reconsignmentAnnouncementDate (to)
     * @param {string} [filterSearch] Filter for reconsignment announcement search.  Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields reconsignmentAnnouncementNumber, orderNumber, externalOrderReference and reconsignmentTrackingCode. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]&#x3D;\&#39;term1 term2\&#39; will filter the result for reconsignment announcements where \&#39;term1\&#39; is found in any field and \&#39;term2\&#39; is also found in any field.\\ If only \&#39;term1\&#39; or \&#39;term2\&#39; is found in the fields, the reconsignment announcement is not included in the results.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getReconsignmentAnnouncementCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterOrderNumber?: string, filterReconsignmentAnnouncementCompleted?: boolean, filterReconsignmentAnnouncementDateFrom?: string, filterReconsignmentAnnouncementDateTo?: string, filterSearch?: string, options?: any): AxiosPromise<ReconsignmentAnnouncementPaginatedCollection>;
    /**
     * Allows to download a document associated with the given reconsignmentAnnouncement.
     * @summary Download reconsignmentAnnouncement related documents.
     * @param {string} reconsignmentAnnouncementNumber The number of the reconsignmentAnnouncement.
     * @param {'shippingLabel'} 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: - shippingLabel: The shipping label for the end customer to ship goods back to the steve warehouse.\\ 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}
     */
    getReconsignmentAnnouncementDocument(reconsignmentAnnouncementNumber: string, documentCode: 'shippingLabel', shopCode?: string, options?: any): AxiosPromise<File>;
};
/**
 * ReconsignmentAnnouncementApi - interface
 * @export
 * @interface ReconsignmentAnnouncementApi
 */
export interface ReconsignmentAnnouncementApiInterface {
    /**
     * Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
     * @summary Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
     * @param {string} reconsignmentAnnouncementNumber Number of the reconsignment announcement
     * @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 ReconsignmentAnnouncementApiInterface
     */
    getReconsignmentAnnouncement(reconsignmentAnnouncementNumber: string, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise<ReconsignmentAnnouncement>;
    /**
     * Get reconsignment announcements.
     * @summary Get reconsignment announcements.
     * @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} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority.  Available sort orders: - asc: ascending order - desc: descending order  Available fields for sorting: - reconsignmentAnnouncementDate  The default sort order is reconsignmentAnnouncementDate:desc.
     * @param {string} [filterShopCode] 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] Filter for a single order number.
     * @param {boolean} [filterReconsignmentAnnouncementCompleted] Filter for completed or not completed reconsignment announcements.
     * @param {string} [filterReconsignmentAnnouncementDateFrom] Filter for reconsignmentAnnouncementDate (from)
     * @param {string} [filterReconsignmentAnnouncementDateTo] Filter for reconsignmentAnnouncementDate (to)
     * @param {string} [filterSearch] Filter for reconsignment announcement search.  Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields reconsignmentAnnouncementNumber, orderNumber, externalOrderReference and reconsignmentTrackingCode. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]&#x3D;\&#39;term1 term2\&#39; will filter the result for reconsignment announcements where \&#39;term1\&#39; is found in any field and \&#39;term2\&#39; is also found in any field.\\ If only \&#39;term1\&#39; or \&#39;term2\&#39; is found in the fields, the reconsignment announcement is not included in the results.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ReconsignmentAnnouncementApiInterface
     */
    getReconsignmentAnnouncementCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterOrderNumber?: string, filterReconsignmentAnnouncementCompleted?: boolean, filterReconsignmentAnnouncementDateFrom?: string, filterReconsignmentAnnouncementDateTo?: string, filterSearch?: string, options?: AxiosRequestConfig): AxiosPromise<ReconsignmentAnnouncementPaginatedCollection>;
    /**
     * Allows to download a document associated with the given reconsignmentAnnouncement.
     * @summary Download reconsignmentAnnouncement related documents.
     * @param {string} reconsignmentAnnouncementNumber The number of the reconsignmentAnnouncement.
     * @param {'shippingLabel'} 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: - shippingLabel: The shipping label for the end customer to ship goods back to the steve warehouse.\\ 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 ReconsignmentAnnouncementApiInterface
     */
    getReconsignmentAnnouncementDocument(reconsignmentAnnouncementNumber: string, documentCode: 'shippingLabel', shopCode?: string, options?: AxiosRequestConfig): AxiosPromise<File>;
}
/**
 * ReconsignmentAnnouncementApi - object-oriented interface
 * @export
 * @class ReconsignmentAnnouncementApi
 * @extends {BaseAPI}
 */
export declare class ReconsignmentAnnouncementApi extends BaseAPI implements ReconsignmentAnnouncementApiInterface {
    /**
     * Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
     * @summary Get the reconsignment announcement with the given reconsignmentAnnouncementNumber.
     * @param {string} reconsignmentAnnouncementNumber Number of the reconsignment announcement
     * @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 ReconsignmentAnnouncementApi
     */
    getReconsignmentAnnouncement(reconsignmentAnnouncementNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReconsignmentAnnouncement, any>>;
    /**
     * Get reconsignment announcements.
     * @summary Get reconsignment announcements.
     * @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} [sortBy] Sort the results by one or more comma-separated sort criteria, with the criterion specified first having priority.  Available sort orders: - asc: ascending order - desc: descending order  Available fields for sorting: - reconsignmentAnnouncementDate  The default sort order is reconsignmentAnnouncementDate:desc.
     * @param {string} [filterShopCode] 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] Filter for a single order number.
     * @param {boolean} [filterReconsignmentAnnouncementCompleted] Filter for completed or not completed reconsignment announcements.
     * @param {string} [filterReconsignmentAnnouncementDateFrom] Filter for reconsignmentAnnouncementDate (from)
     * @param {string} [filterReconsignmentAnnouncementDateTo] Filter for reconsignmentAnnouncementDate (to)
     * @param {string} [filterSearch] Filter for reconsignment announcement search.  Usage: - Provide one or multiple search terms (min. 2 characters) to filter results. - Multiple search terms are separated by spaces. - The search is not case sensitive. - The search is enabled for the fields reconsignmentAnnouncementNumber, orderNumber, externalOrderReference and reconsignmentTrackingCode. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]&#x3D;\&#39;term1 term2\&#39; will filter the result for reconsignment announcements where \&#39;term1\&#39; is found in any field and \&#39;term2\&#39; is also found in any field.\\ If only \&#39;term1\&#39; or \&#39;term2\&#39; is found in the fields, the reconsignment announcement is not included in the results.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ReconsignmentAnnouncementApi
     */
    getReconsignmentAnnouncementCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterOrderNumber?: string, filterReconsignmentAnnouncementCompleted?: boolean, filterReconsignmentAnnouncementDateFrom?: string, filterReconsignmentAnnouncementDateTo?: string, filterSearch?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReconsignmentAnnouncementPaginatedCollection, any>>;
    /**
     * Allows to download a document associated with the given reconsignmentAnnouncement.
     * @summary Download reconsignmentAnnouncement related documents.
     * @param {string} reconsignmentAnnouncementNumber The number of the reconsignmentAnnouncement.
     * @param {'shippingLabel'} 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: - shippingLabel: The shipping label for the end customer to ship goods back to the steve warehouse.\\ 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 ReconsignmentAnnouncementApi
     */
    getReconsignmentAnnouncementDocument(reconsignmentAnnouncementNumber: string, documentCode: 'shippingLabel', shopCode?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
}