@datenkraft/bb-fulfillment-shopify-service-ts-client
Version:
The fulfillment-shopify-service API TS Client enables you to work with the fulfillment-shopify-service API
91 lines (90 loc) • 4.27 kB
TypeScript
/**
* 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 { ShopInfo200Response } from '../models';
/**
* ShopInfoApi - axios parameter creator
* @export
*/
export declare const ShopInfoApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get parameters for the shopify shop frontend (is Sandbox enabled etc.)
* @summary Get parameters for the shopify shop frontend (is Sandbox enabled etc.)
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
shopInfo: (shopifyShopDomain: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ShopInfoApi - functional programming interface
* @export
*/
export declare const ShopInfoApiFp: (configuration?: Configuration) => {
/**
* Get parameters for the shopify shop frontend (is Sandbox enabled etc.)
* @summary Get parameters for the shopify shop frontend (is Sandbox enabled etc.)
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
shopInfo(shopifyShopDomain: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShopInfo200Response>>;
};
/**
* ShopInfoApi - factory interface
* @export
*/
export declare const ShopInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get parameters for the shopify shop frontend (is Sandbox enabled etc.)
* @summary Get parameters for the shopify shop frontend (is Sandbox enabled etc.)
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
shopInfo(shopifyShopDomain: string, options?: any): AxiosPromise<ShopInfo200Response>;
};
/**
* ShopInfoApi - interface
* @export
* @interface ShopInfoApi
*/
export interface ShopInfoApiInterface {
/**
* Get parameters for the shopify shop frontend (is Sandbox enabled etc.)
* @summary Get parameters for the shopify shop frontend (is Sandbox enabled etc.)
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShopInfoApiInterface
*/
shopInfo(shopifyShopDomain: string, options?: AxiosRequestConfig): AxiosPromise<ShopInfo200Response>;
}
/**
* ShopInfoApi - object-oriented interface
* @export
* @class ShopInfoApi
* @extends {BaseAPI}
*/
export declare class ShopInfoApi extends BaseAPI implements ShopInfoApiInterface {
/**
* Get parameters for the shopify shop frontend (is Sandbox enabled etc.)
* @summary Get parameters for the shopify shop frontend (is Sandbox enabled etc.)
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShopInfoApi
*/
shopInfo(shopifyShopDomain: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ShopInfo200Response, any>>;
}