@datenkraft/bb-fulfillment-api-ts-client/dist/Generated/apis/shop-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 { PostShop } from '../models';
import { Shop } from '../models';
import { ShopCollection } from '../models';
import { UpdateShop } from '../models';
/**
 * ShopApi - axios parameter creator
 * @export
 */
export declare const ShopApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Get a list of shops the used identity is assigned to.
     * @summary Get a list of shops the used identity is assigned to.
     * @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} [filterMetaShopifyShopDomain] A filter for the Shopify hostname of the shop.
     * @param {string} [filterShopCode] A filter for one or more shopCode(s) of the shop(s) (optional).
     * @param {string} [filterProjectId] A filter for the projectId of a shop (optional).
     * @param {boolean} [filterIsActive] A filter to only return shops that are active or not.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getShopCollection: (page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterMetaShopifyShopDomain?: string, filterShopCode?: string, filterProjectId?: string, filterIsActive?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Set one or more fields of a shop. Only a limited set of fields can be updated.
     * @summary Update a shop
     * @param {string} shopId Shop Id
     * @param {UpdateShop} updateShop
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchShop: (shopId: string, updateShop: UpdateShop, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Post a new shop.
     * @summary Add a new shop.
     * @param {PostShop} postShop
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postShop: (postShop: PostShop, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ShopApi - functional programming interface
 * @export
 */
export declare const ShopApiFp: (configuration?: Configuration) => {
    /**
     * Get a list of shops the used identity is assigned to.
     * @summary Get a list of shops the used identity is assigned to.
     * @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} [filterMetaShopifyShopDomain] A filter for the Shopify hostname of the shop.
     * @param {string} [filterShopCode] A filter for one or more shopCode(s) of the shop(s) (optional).
     * @param {string} [filterProjectId] A filter for the projectId of a shop (optional).
     * @param {boolean} [filterIsActive] A filter to only return shops that are active or not.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getShopCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterMetaShopifyShopDomain?: string, filterShopCode?: string, filterProjectId?: string, filterIsActive?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShopCollection>>;
    /**
     * Set one or more fields of a shop. Only a limited set of fields can be updated.
     * @summary Update a shop
     * @param {string} shopId Shop Id
     * @param {UpdateShop} updateShop
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchShop(shopId: string, updateShop: UpdateShop, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shop>>;
    /**
     * Post a new shop.
     * @summary Add a new shop.
     * @param {PostShop} postShop
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postShop(postShop: PostShop, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Shop>>;
};
/**
 * ShopApi - factory interface
 * @export
 */
export declare const ShopApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Get a list of shops the used identity is assigned to.
     * @summary Get a list of shops the used identity is assigned to.
     * @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} [filterMetaShopifyShopDomain] A filter for the Shopify hostname of the shop.
     * @param {string} [filterShopCode] A filter for one or more shopCode(s) of the shop(s) (optional).
     * @param {string} [filterProjectId] A filter for the projectId of a shop (optional).
     * @param {boolean} [filterIsActive] A filter to only return shops that are active or not.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getShopCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterMetaShopifyShopDomain?: string, filterShopCode?: string, filterProjectId?: string, filterIsActive?: boolean, options?: any): AxiosPromise<ShopCollection>;
    /**
     * Set one or more fields of a shop. Only a limited set of fields can be updated.
     * @summary Update a shop
     * @param {string} shopId Shop Id
     * @param {UpdateShop} updateShop
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    patchShop(shopId: string, updateShop: UpdateShop, options?: any): AxiosPromise<Shop>;
    /**
     * Post a new shop.
     * @summary Add a new shop.
     * @param {PostShop} postShop
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postShop(postShop: PostShop, options?: any): AxiosPromise<Shop>;
};
/**
 * ShopApi - interface
 * @export
 * @interface ShopApi
 */
export interface ShopApiInterface {
    /**
     * Get a list of shops the used identity is assigned to.
     * @summary Get a list of shops the used identity is assigned to.
     * @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} [filterMetaShopifyShopDomain] A filter for the Shopify hostname of the shop.
     * @param {string} [filterShopCode] A filter for one or more shopCode(s) of the shop(s) (optional).
     * @param {string} [filterProjectId] A filter for the projectId of a shop (optional).
     * @param {boolean} [filterIsActive] A filter to only return shops that are active or not.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ShopApiInterface
     */
    getShopCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterMetaShopifyShopDomain?: string, filterShopCode?: string, filterProjectId?: string, filterIsActive?: boolean, options?: AxiosRequestConfig): AxiosPromise<ShopCollection>;
    /**
     * Set one or more fields of a shop. Only a limited set of fields can be updated.
     * @summary Update a shop
     * @param {string} shopId Shop Id
     * @param {UpdateShop} updateShop
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ShopApiInterface
     */
    patchShop(shopId: string, updateShop: UpdateShop, options?: AxiosRequestConfig): AxiosPromise<Shop>;
    /**
     * Post a new shop.
     * @summary Add a new shop.
     * @param {PostShop} postShop
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ShopApiInterface
     */
    postShop(postShop: PostShop, options?: AxiosRequestConfig): AxiosPromise<Shop>;
}
/**
 * ShopApi - object-oriented interface
 * @export
 * @class ShopApi
 * @extends {BaseAPI}
 */
export declare class ShopApi extends BaseAPI implements ShopApiInterface {
    /**
     * Get a list of shops the used identity is assigned to.
     * @summary Get a list of shops the used identity is assigned to.
     * @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} [filterMetaShopifyShopDomain] A filter for the Shopify hostname of the shop.
     * @param {string} [filterShopCode] A filter for one or more shopCode(s) of the shop(s) (optional).
     * @param {string} [filterProjectId] A filter for the projectId of a shop (optional).
     * @param {boolean} [filterIsActive] A filter to only return shops that are active or not.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ShopApi
     */
    getShopCollection(page?: number, pageSize?: number, paginationMode?: 'default' | 'totalCount', filterMetaShopifyShopDomain?: string, filterShopCode?: string, filterProjectId?: string, filterIsActive?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ShopCollection, any>>;
    /**
     * Set one or more fields of a shop. Only a limited set of fields can be updated.
     * @summary Update a shop
     * @param {string} shopId Shop Id
     * @param {UpdateShop} updateShop
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ShopApi
     */
    patchShop(shopId: string, updateShop: UpdateShop, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Shop, any>>;
    /**
     * Post a new shop.
     * @summary Add a new shop.
     * @param {PostShop} postShop
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ShopApi
     */
    postShop(postShop: PostShop, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Shop, any>>;
}