@datenkraft/bb-fulfillment-api-ts-client/dist/Generated/apis/stock-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 { StockCollection } from '../models';
/**
 * StockApi - axios parameter creator
 * @export
 */
export declare const StockApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Get the stock for all (per default only valid) products or for a specific product.
     * @summary Get the stock for all (per default only valid) products or for a specific product.
     * @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 - stocked - reserved - available - incoming - locked  The default sort order is stocked:desc.
     * @param {string} [filterProductNumber] Filter for product number(s) (optional).
     * @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 {'_all' | '_invalid'} [filterProductStatus] Filter for productStatus\\ By default, only valid products (available or in stock) are returned. \\ Use \'_all\' to return all products (also invalid products). \\ Use \'_invalid\' to specifically return invalid products (not available and out of stock).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStockCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterProductNumber?: string, filterShopCode?: string, filterProductStatus?: '_all' | '_invalid', options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * StockApi - functional programming interface
 * @export
 */
export declare const StockApiFp: (configuration?: Configuration) => {
    /**
     * Get the stock for all (per default only valid) products or for a specific product.
     * @summary Get the stock for all (per default only valid) products or for a specific product.
     * @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 - stocked - reserved - available - incoming - locked  The default sort order is stocked:desc.
     * @param {string} [filterProductNumber] Filter for product number(s) (optional).
     * @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 {'_all' | '_invalid'} [filterProductStatus] Filter for productStatus\\ By default, only valid products (available or in stock) are returned. \\ Use \&#39;_all\&#39; to return all products (also invalid products). \\ Use \&#39;_invalid\&#39; to specifically return invalid products (not available and out of stock).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStockCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterProductNumber?: string, filterShopCode?: string, filterProductStatus?: '_all' | '_invalid', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StockCollection>>;
};
/**
 * StockApi - factory interface
 * @export
 */
export declare const StockApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Get the stock for all (per default only valid) products or for a specific product.
     * @summary Get the stock for all (per default only valid) products or for a specific product.
     * @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 - stocked - reserved - available - incoming - locked  The default sort order is stocked:desc.
     * @param {string} [filterProductNumber] Filter for product number(s) (optional).
     * @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 {'_all' | '_invalid'} [filterProductStatus] Filter for productStatus\\ By default, only valid products (available or in stock) are returned. \\ Use \&#39;_all\&#39; to return all products (also invalid products). \\ Use \&#39;_invalid\&#39; to specifically return invalid products (not available and out of stock).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStockCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterProductNumber?: string, filterShopCode?: string, filterProductStatus?: '_all' | '_invalid', options?: any): AxiosPromise<StockCollection>;
};
/**
 * StockApi - interface
 * @export
 * @interface StockApi
 */
export interface StockApiInterface {
    /**
     * Get the stock for all (per default only valid) products or for a specific product.
     * @summary Get the stock for all (per default only valid) products or for a specific product.
     * @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 - stocked - reserved - available - incoming - locked  The default sort order is stocked:desc.
     * @param {string} [filterProductNumber] Filter for product number(s) (optional).
     * @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 {'_all' | '_invalid'} [filterProductStatus] Filter for productStatus\\ By default, only valid products (available or in stock) are returned. \\ Use \&#39;_all\&#39; to return all products (also invalid products). \\ Use \&#39;_invalid\&#39; to specifically return invalid products (not available and out of stock).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StockApiInterface
     */
    getStockCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterProductNumber?: string, filterShopCode?: string, filterProductStatus?: '_all' | '_invalid', options?: AxiosRequestConfig): AxiosPromise<StockCollection>;
}
/**
 * StockApi - object-oriented interface
 * @export
 * @class StockApi
 * @extends {BaseAPI}
 */
export declare class StockApi extends BaseAPI implements StockApiInterface {
    /**
     * Get the stock for all (per default only valid) products or for a specific product.
     * @summary Get the stock for all (per default only valid) products or for a specific product.
     * @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 - stocked - reserved - available - incoming - locked  The default sort order is stocked:desc.
     * @param {string} [filterProductNumber] Filter for product number(s) (optional).
     * @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 {'_all' | '_invalid'} [filterProductStatus] Filter for productStatus\\ By default, only valid products (available or in stock) are returned. \\ Use \&#39;_all\&#39; to return all products (also invalid products). \\ Use \&#39;_invalid\&#39; to specifically return invalid products (not available and out of stock).
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StockApi
     */
    getStockCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', sortBy?: string, filterProductNumber?: string, filterShopCode?: string, filterProductStatus?: '_all' | '_invalid', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StockCollection, any>>;
}