@datenkraft/bb-fulfillment-shopify-service-ts-client/dist/Generated/apis/action-api.d.ts

The fulfillment-shopify-service API TS Client enables you to work with the fulfillment-shopify-service API

/**
 * Shopify Fulfillment Service
 *  - 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-service-sy.steve.niceshops.com/v1/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)  [Shopify Fulfillment Service PHP client @Packagist](https://packagist.org/packages/datenkraft/bb-fulfillment-shopify-service-php-client)
 *
 * The version of the OpenAPI document: v1.stable
 *
 *
 * 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 { PostActionShopCreateTestProducts200Response } from '../models';
import { PostActionShopCreateTestProductsCleanup200Response } from '../models';
import { PostActionShopCreateTestProductsInitialize200Response } from '../models';
import { PostActionShopCreateTestProductsRequest } from '../models';
import { ShopClearCache200Response } from '../models';
import { ShopClearCacheRequest } from '../models';
import { ShopToggleSandboxMode200Response } from '../models';
import { TestShopRegister200Response } from '../models';
/**
 * ActionApi - axios parameter creator
 * @export
 */
export declare const ActionApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Create test products for a shop
     * @summary Create test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postActionShopCreateTestProducts: (postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Execute the cleanup after the creation test products for a shop
     * @summary Execute the cleanup after the creation test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postActionShopCreateTestProductsCleanup: (postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Execute the initialization before the creation test products for a shop
     * @summary Execute the initialization for before creation test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postActionShopCreateTestProductsInitialize: (postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Clear shop cache.
     * @summary Clear shop cache.
     * @param {ShopClearCacheRequest} [shopClearCacheRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shopClearCache: (shopClearCacheRequest?: ShopClearCacheRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Toggle sandbox mode for a shop.
     * @summary Toggle sandbox mode for a shop.
     * @param {ShopClearCacheRequest} shopClearCacheRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shopToggleSandboxMode: (shopClearCacheRequest: ShopClearCacheRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Try to register shopify as a test shop.
     * @summary Try to register shopify as a test shop.
     * @param {ShopClearCacheRequest} shopClearCacheRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    testShopRegister: (shopClearCacheRequest: ShopClearCacheRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Reset all test shops.
     * @summary Reset all test shops.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    testShopReset: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ActionApi - functional programming interface
 * @export
 */
export declare const ActionApiFp: (configuration?: Configuration) => {
    /**
     * Create test products for a shop
     * @summary Create test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postActionShopCreateTestProducts(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostActionShopCreateTestProducts200Response>>;
    /**
     * Execute the cleanup after the creation test products for a shop
     * @summary Execute the cleanup after the creation test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postActionShopCreateTestProductsCleanup(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostActionShopCreateTestProductsCleanup200Response>>;
    /**
     * Execute the initialization before the creation test products for a shop
     * @summary Execute the initialization for before creation test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postActionShopCreateTestProductsInitialize(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostActionShopCreateTestProductsInitialize200Response>>;
    /**
     * Clear shop cache.
     * @summary Clear shop cache.
     * @param {ShopClearCacheRequest} [shopClearCacheRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shopClearCache(shopClearCacheRequest?: ShopClearCacheRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShopClearCache200Response>>;
    /**
     * Toggle sandbox mode for a shop.
     * @summary Toggle sandbox mode for a shop.
     * @param {ShopClearCacheRequest} shopClearCacheRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shopToggleSandboxMode(shopClearCacheRequest: ShopClearCacheRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShopToggleSandboxMode200Response>>;
    /**
     * Try to register shopify as a test shop.
     * @summary Try to register shopify as a test shop.
     * @param {ShopClearCacheRequest} shopClearCacheRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    testShopRegister(shopClearCacheRequest: ShopClearCacheRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TestShopRegister200Response>>;
    /**
     * Reset all test shops.
     * @summary Reset all test shops.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    testShopReset(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShopClearCache200Response>>;
};
/**
 * ActionApi - factory interface
 * @export
 */
export declare const ActionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Create test products for a shop
     * @summary Create test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postActionShopCreateTestProducts(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: any): AxiosPromise<PostActionShopCreateTestProducts200Response>;
    /**
     * Execute the cleanup after the creation test products for a shop
     * @summary Execute the cleanup after the creation test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postActionShopCreateTestProductsCleanup(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: any): AxiosPromise<PostActionShopCreateTestProductsCleanup200Response>;
    /**
     * Execute the initialization before the creation test products for a shop
     * @summary Execute the initialization for before creation test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postActionShopCreateTestProductsInitialize(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: any): AxiosPromise<PostActionShopCreateTestProductsInitialize200Response>;
    /**
     * Clear shop cache.
     * @summary Clear shop cache.
     * @param {ShopClearCacheRequest} [shopClearCacheRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shopClearCache(shopClearCacheRequest?: ShopClearCacheRequest, options?: any): AxiosPromise<ShopClearCache200Response>;
    /**
     * Toggle sandbox mode for a shop.
     * @summary Toggle sandbox mode for a shop.
     * @param {ShopClearCacheRequest} shopClearCacheRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shopToggleSandboxMode(shopClearCacheRequest: ShopClearCacheRequest, options?: any): AxiosPromise<ShopToggleSandboxMode200Response>;
    /**
     * Try to register shopify as a test shop.
     * @summary Try to register shopify as a test shop.
     * @param {ShopClearCacheRequest} shopClearCacheRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    testShopRegister(shopClearCacheRequest: ShopClearCacheRequest, options?: any): AxiosPromise<TestShopRegister200Response>;
    /**
     * Reset all test shops.
     * @summary Reset all test shops.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    testShopReset(options?: any): AxiosPromise<ShopClearCache200Response>;
};
/**
 * ActionApi - interface
 * @export
 * @interface ActionApi
 */
export interface ActionApiInterface {
    /**
     * Create test products for a shop
     * @summary Create test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApiInterface
     */
    postActionShopCreateTestProducts(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig): AxiosPromise<PostActionShopCreateTestProducts200Response>;
    /**
     * Execute the cleanup after the creation test products for a shop
     * @summary Execute the cleanup after the creation test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApiInterface
     */
    postActionShopCreateTestProductsCleanup(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig): AxiosPromise<PostActionShopCreateTestProductsCleanup200Response>;
    /**
     * Execute the initialization before the creation test products for a shop
     * @summary Execute the initialization for before creation test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApiInterface
     */
    postActionShopCreateTestProductsInitialize(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig): AxiosPromise<PostActionShopCreateTestProductsInitialize200Response>;
    /**
     * Clear shop cache.
     * @summary Clear shop cache.
     * @param {ShopClearCacheRequest} [shopClearCacheRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApiInterface
     */
    shopClearCache(shopClearCacheRequest?: ShopClearCacheRequest, options?: AxiosRequestConfig): AxiosPromise<ShopClearCache200Response>;
    /**
     * Toggle sandbox mode for a shop.
     * @summary Toggle sandbox mode for a shop.
     * @param {ShopClearCacheRequest} shopClearCacheRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApiInterface
     */
    shopToggleSandboxMode(shopClearCacheRequest: ShopClearCacheRequest, options?: AxiosRequestConfig): AxiosPromise<ShopToggleSandboxMode200Response>;
    /**
     * Try to register shopify as a test shop.
     * @summary Try to register shopify as a test shop.
     * @param {ShopClearCacheRequest} shopClearCacheRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApiInterface
     */
    testShopRegister(shopClearCacheRequest: ShopClearCacheRequest, options?: AxiosRequestConfig): AxiosPromise<TestShopRegister200Response>;
    /**
     * Reset all test shops.
     * @summary Reset all test shops.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApiInterface
     */
    testShopReset(options?: AxiosRequestConfig): AxiosPromise<ShopClearCache200Response>;
}
/**
 * ActionApi - object-oriented interface
 * @export
 * @class ActionApi
 * @extends {BaseAPI}
 */
export declare class ActionApi extends BaseAPI implements ActionApiInterface {
    /**
     * Create test products for a shop
     * @summary Create test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApi
     */
    postActionShopCreateTestProducts(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PostActionShopCreateTestProducts200Response, any>>;
    /**
     * Execute the cleanup after the creation test products for a shop
     * @summary Execute the cleanup after the creation test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApi
     */
    postActionShopCreateTestProductsCleanup(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PostActionShopCreateTestProductsCleanup200Response, any>>;
    /**
     * Execute the initialization before the creation test products for a shop
     * @summary Execute the initialization for before creation test products for a shop
     * @param {PostActionShopCreateTestProductsRequest} postActionShopCreateTestProductsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApi
     */
    postActionShopCreateTestProductsInitialize(postActionShopCreateTestProductsRequest: PostActionShopCreateTestProductsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PostActionShopCreateTestProductsInitialize200Response, any>>;
    /**
     * Clear shop cache.
     * @summary Clear shop cache.
     * @param {ShopClearCacheRequest} [shopClearCacheRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApi
     */
    shopClearCache(shopClearCacheRequest?: ShopClearCacheRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ShopClearCache200Response, any>>;
    /**
     * Toggle sandbox mode for a shop.
     * @summary Toggle sandbox mode for a shop.
     * @param {ShopClearCacheRequest} shopClearCacheRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApi
     */
    shopToggleSandboxMode(shopClearCacheRequest: ShopClearCacheRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ShopToggleSandboxMode200Response, any>>;
    /**
     * Try to register shopify as a test shop.
     * @summary Try to register shopify as a test shop.
     * @param {ShopClearCacheRequest} shopClearCacheRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApi
     */
    testShopRegister(shopClearCacheRequest: ShopClearCacheRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TestShopRegister200Response, any>>;
    /**
     * Reset all test shops.
     * @summary Reset all test shops.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ActionApi
     */
    testShopReset(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ShopClearCache200Response, any>>;
}