/** * 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 { Reconsignment } from '../models'; import { ReconsignmentCollection } from '../models'; /** * ReconsignmentApi - axios parameter creator * @export */ export declare const ReconsignmentApiAxiosParamCreator: (configuration?: Configuration) => { /** * Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber). * @summary Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber). * @param {string} reconsignmentNumber * @param {string} [shopCode] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReconsignment: (reconsignmentNumber: string, shopCode?: string, options?: AxiosRequestConfig) => Promise; /** * Read the reconsignments in the given dateRange. * @summary Read the reconsignments in the given dateRange. * @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: - reconsignmentDate The default sort order is reconsignmentDate:desc. * @param {string} [filterShopCode] The shop to which the reconsignments belongs to. * @param {string} [filterOrderNumber] The order number which the reconsignments belong to. * @param {boolean} [filterReconsignmentWasPreAnnounced] Filter for reconsignments that were pre-announced (true) or not (false). * @param {string} [filterSearch] Filter for reconsignment 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 \'reconsignmentNumber\' and \'orderNumber\'. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for reconsignment announcements where \'term1\' is found in any field and \'term2\' is also found in any field.\\ If only \'term1\' or \'term2\' is found in the fields, the reconsignment announcement is not included in the results. * @param {string} [filterReconsignmentDateFrom] filter for reconsignmentDate format in ISO 8601 with UTC offsets * @param {string} [filterReconsignmentDateTo] filter for reconsignmentDate format in ISO 8601 with UTC offsets * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReconsignmentCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterOrderNumber?: string, filterReconsignmentWasPreAnnounced?: boolean, filterSearch?: string, filterReconsignmentDateFrom?: string, filterReconsignmentDateTo?: string, options?: AxiosRequestConfig) => Promise; }; /** * ReconsignmentApi - functional programming interface * @export */ export declare const ReconsignmentApiFp: (configuration?: Configuration) => { /** * Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber). * @summary Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber). * @param {string} reconsignmentNumber * @param {string} [shopCode] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReconsignment(reconsignmentNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Read the reconsignments in the given dateRange. * @summary Read the reconsignments in the given dateRange. * @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: - reconsignmentDate The default sort order is reconsignmentDate:desc. * @param {string} [filterShopCode] The shop to which the reconsignments belongs to. * @param {string} [filterOrderNumber] The order number which the reconsignments belong to. * @param {boolean} [filterReconsignmentWasPreAnnounced] Filter for reconsignments that were pre-announced (true) or not (false). * @param {string} [filterSearch] Filter for reconsignment 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 \'reconsignmentNumber\' and \'orderNumber\'. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for reconsignment announcements where \'term1\' is found in any field and \'term2\' is also found in any field.\\ If only \'term1\' or \'term2\' is found in the fields, the reconsignment announcement is not included in the results. * @param {string} [filterReconsignmentDateFrom] filter for reconsignmentDate format in ISO 8601 with UTC offsets * @param {string} [filterReconsignmentDateTo] filter for reconsignmentDate format in ISO 8601 with UTC offsets * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReconsignmentCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterOrderNumber?: string, filterReconsignmentWasPreAnnounced?: boolean, filterSearch?: string, filterReconsignmentDateFrom?: string, filterReconsignmentDateTo?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ReconsignmentApi - factory interface * @export */ export declare const ReconsignmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber). * @summary Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber). * @param {string} reconsignmentNumber * @param {string} [shopCode] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReconsignment(reconsignmentNumber: string, shopCode?: string, options?: any): AxiosPromise; /** * Read the reconsignments in the given dateRange. * @summary Read the reconsignments in the given dateRange. * @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: - reconsignmentDate The default sort order is reconsignmentDate:desc. * @param {string} [filterShopCode] The shop to which the reconsignments belongs to. * @param {string} [filterOrderNumber] The order number which the reconsignments belong to. * @param {boolean} [filterReconsignmentWasPreAnnounced] Filter for reconsignments that were pre-announced (true) or not (false). * @param {string} [filterSearch] Filter for reconsignment 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 \'reconsignmentNumber\' and \'orderNumber\'. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for reconsignment announcements where \'term1\' is found in any field and \'term2\' is also found in any field.\\ If only \'term1\' or \'term2\' is found in the fields, the reconsignment announcement is not included in the results. * @param {string} [filterReconsignmentDateFrom] filter for reconsignmentDate format in ISO 8601 with UTC offsets * @param {string} [filterReconsignmentDateTo] filter for reconsignmentDate format in ISO 8601 with UTC offsets * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReconsignmentCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterOrderNumber?: string, filterReconsignmentWasPreAnnounced?: boolean, filterSearch?: string, filterReconsignmentDateFrom?: string, filterReconsignmentDateTo?: string, options?: any): AxiosPromise; }; /** * ReconsignmentApi - interface * @export * @interface ReconsignmentApi */ export interface ReconsignmentApiInterface { /** * Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber). * @summary Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber). * @param {string} reconsignmentNumber * @param {string} [shopCode] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReconsignmentApiInterface */ getReconsignment(reconsignmentNumber: string, shopCode?: string, options?: AxiosRequestConfig): AxiosPromise; /** * Read the reconsignments in the given dateRange. * @summary Read the reconsignments in the given dateRange. * @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: - reconsignmentDate The default sort order is reconsignmentDate:desc. * @param {string} [filterShopCode] The shop to which the reconsignments belongs to. * @param {string} [filterOrderNumber] The order number which the reconsignments belong to. * @param {boolean} [filterReconsignmentWasPreAnnounced] Filter for reconsignments that were pre-announced (true) or not (false). * @param {string} [filterSearch] Filter for reconsignment 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 \'reconsignmentNumber\' and \'orderNumber\'. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for reconsignment announcements where \'term1\' is found in any field and \'term2\' is also found in any field.\\ If only \'term1\' or \'term2\' is found in the fields, the reconsignment announcement is not included in the results. * @param {string} [filterReconsignmentDateFrom] filter for reconsignmentDate format in ISO 8601 with UTC offsets * @param {string} [filterReconsignmentDateTo] filter for reconsignmentDate format in ISO 8601 with UTC offsets * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReconsignmentApiInterface */ getReconsignmentCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterOrderNumber?: string, filterReconsignmentWasPreAnnounced?: boolean, filterSearch?: string, filterReconsignmentDateFrom?: string, filterReconsignmentDateTo?: string, options?: AxiosRequestConfig): AxiosPromise; } /** * ReconsignmentApi - object-oriented interface * @export * @class ReconsignmentApi * @extends {BaseAPI} */ export declare class ReconsignmentApi extends BaseAPI implements ReconsignmentApiInterface { /** * Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber). * @summary Read the reconsignment specified by the given reconsignment number (set in param reconsignmentNumber). * @param {string} reconsignmentNumber * @param {string} [shopCode] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReconsignmentApi */ getReconsignment(reconsignmentNumber: string, shopCode?: string, options?: AxiosRequestConfig): Promise>; /** * Read the reconsignments in the given dateRange. * @summary Read the reconsignments in the given dateRange. * @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: - reconsignmentDate The default sort order is reconsignmentDate:desc. * @param {string} [filterShopCode] The shop to which the reconsignments belongs to. * @param {string} [filterOrderNumber] The order number which the reconsignments belong to. * @param {boolean} [filterReconsignmentWasPreAnnounced] Filter for reconsignments that were pre-announced (true) or not (false). * @param {string} [filterSearch] Filter for reconsignment 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 \'reconsignmentNumber\' and \'orderNumber\'. - Each search term filters the response for reconsignment announcements where at least one of the fields contains the search term. - For example, filter[search]=\'term1 term2\' will filter the result for reconsignment announcements where \'term1\' is found in any field and \'term2\' is also found in any field.\\ If only \'term1\' or \'term2\' is found in the fields, the reconsignment announcement is not included in the results. * @param {string} [filterReconsignmentDateFrom] filter for reconsignmentDate format in ISO 8601 with UTC offsets * @param {string} [filterReconsignmentDateTo] filter for reconsignmentDate format in ISO 8601 with UTC offsets * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReconsignmentApi */ getReconsignmentCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterShopCode?: string, filterOrderNumber?: string, filterReconsignmentWasPreAnnounced?: boolean, filterSearch?: string, filterReconsignmentDateFrom?: string, filterReconsignmentDateTo?: string, options?: AxiosRequestConfig): Promise>; }