@datenkraft/bb-fulfillment-api-ts-client/dist/Generated/apis/report-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 { ReportClearingOrderCollection } from '../models';
import { ReportInventoryMovementEntryCollection } from '../models';
/**
 * ReportApi - axios parameter creator
 * @export
 */
export declare const ReportApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Read the created orders for the given shopCode in the given dateRange.
     * @summary Read the created orders for the given shopCode in the given dateRange.
     * @param {string} filterDateFrom The start date (inclusive) in format Y-m-d (timezone CET/CEST) for which orders should be returned.
     * @param {string} filterDateTo The end date (inclusive) in format Y-m-d (timezone CET/CEST) for which orders should be returned.
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 20.
     * @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} [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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOrderReportClearingCollection: (filterDateFrom: string, filterDateTo: string, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterShopCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Read the inventory movements for the given shopCode in the given month and year. _Only inventory movements for products with source \'self\' are returned._
     * @summary Read the inventory movements for the given shopCode in the given month and year.
     * @param {number} filterYear The year for which inventory movements should be returned.
     * @param {number} filterMonth The month for which inventory movements should be returned.
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 20.
     * @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: - productNumber - stockStart - stockEnd - stockAdded - stockSubtracted - stockSubtractedExternal - stockCorrected - stockUsedForOwnPurposes - stockReturned - stockReturnedExternal  The default sort order is stockEnd:desc.
     * @param {string} [filterSearch] Filter for inventory movement 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 productTitle and productNumber. - Each search term filters the response for products 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 products 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 product is not included in the results.
     * @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} [filterProductNumbers] The productNumber(s) as comma delimited string for which inventory movements should be returned (optional).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getReportInventoryMovementCollection: (filterYear: number, filterMonth: number, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterSearch?: string, filterShopCode?: string, filterProductNumbers?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ReportApi - functional programming interface
 * @export
 */
export declare const ReportApiFp: (configuration?: Configuration) => {
    /**
     * Read the created orders for the given shopCode in the given dateRange.
     * @summary Read the created orders for the given shopCode in the given dateRange.
     * @param {string} filterDateFrom The start date (inclusive) in format Y-m-d (timezone CET/CEST) for which orders should be returned.
     * @param {string} filterDateTo The end date (inclusive) in format Y-m-d (timezone CET/CEST) for which orders should be returned.
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 20.
     * @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} [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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOrderReportClearingCollection(filterDateFrom: string, filterDateTo: string, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterShopCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportClearingOrderCollection>>;
    /**
     * Read the inventory movements for the given shopCode in the given month and year. _Only inventory movements for products with source \'self\' are returned._
     * @summary Read the inventory movements for the given shopCode in the given month and year.
     * @param {number} filterYear The year for which inventory movements should be returned.
     * @param {number} filterMonth The month for which inventory movements should be returned.
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 20.
     * @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: - productNumber - stockStart - stockEnd - stockAdded - stockSubtracted - stockSubtractedExternal - stockCorrected - stockUsedForOwnPurposes - stockReturned - stockReturnedExternal  The default sort order is stockEnd:desc.
     * @param {string} [filterSearch] Filter for inventory movement 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 productTitle and productNumber. - Each search term filters the response for products 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 products 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 product is not included in the results.
     * @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} [filterProductNumbers] The productNumber(s) as comma delimited string for which inventory movements should be returned (optional).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getReportInventoryMovementCollection(filterYear: number, filterMonth: number, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterSearch?: string, filterShopCode?: string, filterProductNumbers?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportInventoryMovementEntryCollection>>;
};
/**
 * ReportApi - factory interface
 * @export
 */
export declare const ReportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Read the created orders for the given shopCode in the given dateRange.
     * @summary Read the created orders for the given shopCode in the given dateRange.
     * @param {string} filterDateFrom The start date (inclusive) in format Y-m-d (timezone CET/CEST) for which orders should be returned.
     * @param {string} filterDateTo The end date (inclusive) in format Y-m-d (timezone CET/CEST) for which orders should be returned.
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 20.
     * @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} [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 {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOrderReportClearingCollection(filterDateFrom: string, filterDateTo: string, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterShopCode?: string, options?: any): AxiosPromise<ReportClearingOrderCollection>;
    /**
     * Read the inventory movements for the given shopCode in the given month and year. _Only inventory movements for products with source \'self\' are returned._
     * @summary Read the inventory movements for the given shopCode in the given month and year.
     * @param {number} filterYear The year for which inventory movements should be returned.
     * @param {number} filterMonth The month for which inventory movements should be returned.
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 20.
     * @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: - productNumber - stockStart - stockEnd - stockAdded - stockSubtracted - stockSubtractedExternal - stockCorrected - stockUsedForOwnPurposes - stockReturned - stockReturnedExternal  The default sort order is stockEnd:desc.
     * @param {string} [filterSearch] Filter for inventory movement 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 productTitle and productNumber. - Each search term filters the response for products 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 products 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 product is not included in the results.
     * @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} [filterProductNumbers] The productNumber(s) as comma delimited string for which inventory movements should be returned (optional).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getReportInventoryMovementCollection(filterYear: number, filterMonth: number, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterSearch?: string, filterShopCode?: string, filterProductNumbers?: string, options?: any): AxiosPromise<ReportInventoryMovementEntryCollection>;
};
/**
 * ReportApi - interface
 * @export
 * @interface ReportApi
 */
export interface ReportApiInterface {
    /**
     * Read the created orders for the given shopCode in the given dateRange.
     * @summary Read the created orders for the given shopCode in the given dateRange.
     * @param {string} filterDateFrom The start date (inclusive) in format Y-m-d (timezone CET/CEST) for which orders should be returned.
     * @param {string} filterDateTo The end date (inclusive) in format Y-m-d (timezone CET/CEST) for which orders should be returned.
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 20.
     * @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} [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 {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ReportApiInterface
     */
    getOrderReportClearingCollection(filterDateFrom: string, filterDateTo: string, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterShopCode?: string, options?: AxiosRequestConfig): AxiosPromise<ReportClearingOrderCollection>;
    /**
     * Read the inventory movements for the given shopCode in the given month and year. _Only inventory movements for products with source \'self\' are returned._
     * @summary Read the inventory movements for the given shopCode in the given month and year.
     * @param {number} filterYear The year for which inventory movements should be returned.
     * @param {number} filterMonth The month for which inventory movements should be returned.
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 20.
     * @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: - productNumber - stockStart - stockEnd - stockAdded - stockSubtracted - stockSubtractedExternal - stockCorrected - stockUsedForOwnPurposes - stockReturned - stockReturnedExternal  The default sort order is stockEnd:desc.
     * @param {string} [filterSearch] Filter for inventory movement 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 productTitle and productNumber. - Each search term filters the response for products 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 products 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 product is not included in the results.
     * @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} [filterProductNumbers] The productNumber(s) as comma delimited string for which inventory movements should be returned (optional).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ReportApiInterface
     */
    getReportInventoryMovementCollection(filterYear: number, filterMonth: number, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterSearch?: string, filterShopCode?: string, filterProductNumbers?: string, options?: AxiosRequestConfig): AxiosPromise<ReportInventoryMovementEntryCollection>;
}
/**
 * ReportApi - object-oriented interface
 * @export
 * @class ReportApi
 * @extends {BaseAPI}
 */
export declare class ReportApi extends BaseAPI implements ReportApiInterface {
    /**
     * Read the created orders for the given shopCode in the given dateRange.
     * @summary Read the created orders for the given shopCode in the given dateRange.
     * @param {string} filterDateFrom The start date (inclusive) in format Y-m-d (timezone CET/CEST) for which orders should be returned.
     * @param {string} filterDateTo The end date (inclusive) in format Y-m-d (timezone CET/CEST) for which orders should be returned.
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 20.
     * @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} [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 {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ReportApi
     */
    getOrderReportClearingCollection(filterDateFrom: string, filterDateTo: string, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterShopCode?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportClearingOrderCollection, any>>;
    /**
     * Read the inventory movements for the given shopCode in the given month and year. _Only inventory movements for products with source \'self\' are returned._
     * @summary Read the inventory movements for the given shopCode in the given month and year.
     * @param {number} filterYear The year for which inventory movements should be returned.
     * @param {number} filterMonth The month for which inventory movements should be returned.
     * @param {number} [page] The page to read. Default is the first page.
     * @param {number} [pageSize] The maximum size per page is 100. Default is 20.
     * @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: - productNumber - stockStart - stockEnd - stockAdded - stockSubtracted - stockSubtractedExternal - stockCorrected - stockUsedForOwnPurposes - stockReturned - stockReturnedExternal  The default sort order is stockEnd:desc.
     * @param {string} [filterSearch] Filter for inventory movement 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 productTitle and productNumber. - Each search term filters the response for products 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 products 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 product is not included in the results.
     * @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} [filterProductNumbers] The productNumber(s) as comma delimited string for which inventory movements should be returned (optional).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ReportApi
     */
    getReportInventoryMovementCollection(filterYear: number, filterMonth: number, page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterSearch?: string, filterShopCode?: string, filterProductNumbers?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportInventoryMovementEntryCollection, any>>;
}