@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
144 lines (143 loc) • 8.29 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 { ShopifyInventoryItemCollection } from '../models';
import { ShopifyProductVariantCollection } from '../models';
/**
* ShopifyApi - axios parameter creator
* @export
*/
export declare const ShopifyApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get a list of Inventory Items..
* @summary Get a list of Inventory Items.
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {string} filterProductNumbers Filter for productNumber/productNumbers. The maximum number of productNumbers allowed is 100. The values must be separated by a comma.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getShopifyInventoryItemCollection: (shopifyShopDomain: string, filterProductNumbers: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Get a list of Product Variants.
* @summary Get a list of Product Variants.
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {string} [filterProductNumbers] Filter for productNumber/productNumbers. The maximum number of productNumbers allowed is 100. The values must be separated by a comma.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getShopifyProductVariantCollection: (shopifyShopDomain: string, filterProductNumbers?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ShopifyApi - functional programming interface
* @export
*/
export declare const ShopifyApiFp: (configuration?: Configuration) => {
/**
* Get a list of Inventory Items..
* @summary Get a list of Inventory Items.
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {string} filterProductNumbers Filter for productNumber/productNumbers. The maximum number of productNumbers allowed is 100. The values must be separated by a comma.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getShopifyInventoryItemCollection(shopifyShopDomain: string, filterProductNumbers: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShopifyInventoryItemCollection>>;
/**
* Get a list of Product Variants.
* @summary Get a list of Product Variants.
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {string} [filterProductNumbers] Filter for productNumber/productNumbers. The maximum number of productNumbers allowed is 100. The values must be separated by a comma.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getShopifyProductVariantCollection(shopifyShopDomain: string, filterProductNumbers?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShopifyProductVariantCollection>>;
};
/**
* ShopifyApi - factory interface
* @export
*/
export declare const ShopifyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get a list of Inventory Items..
* @summary Get a list of Inventory Items.
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {string} filterProductNumbers Filter for productNumber/productNumbers. The maximum number of productNumbers allowed is 100. The values must be separated by a comma.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getShopifyInventoryItemCollection(shopifyShopDomain: string, filterProductNumbers: string, options?: any): AxiosPromise<ShopifyInventoryItemCollection>;
/**
* Get a list of Product Variants.
* @summary Get a list of Product Variants.
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {string} [filterProductNumbers] Filter for productNumber/productNumbers. The maximum number of productNumbers allowed is 100. The values must be separated by a comma.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getShopifyProductVariantCollection(shopifyShopDomain: string, filterProductNumbers?: string, options?: any): AxiosPromise<ShopifyProductVariantCollection>;
};
/**
* ShopifyApi - interface
* @export
* @interface ShopifyApi
*/
export interface ShopifyApiInterface {
/**
* Get a list of Inventory Items..
* @summary Get a list of Inventory Items.
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {string} filterProductNumbers Filter for productNumber/productNumbers. The maximum number of productNumbers allowed is 100. The values must be separated by a comma.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShopifyApiInterface
*/
getShopifyInventoryItemCollection(shopifyShopDomain: string, filterProductNumbers: string, options?: AxiosRequestConfig): AxiosPromise<ShopifyInventoryItemCollection>;
/**
* Get a list of Product Variants.
* @summary Get a list of Product Variants.
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {string} [filterProductNumbers] Filter for productNumber/productNumbers. The maximum number of productNumbers allowed is 100. The values must be separated by a comma.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShopifyApiInterface
*/
getShopifyProductVariantCollection(shopifyShopDomain: string, filterProductNumbers?: string, options?: AxiosRequestConfig): AxiosPromise<ShopifyProductVariantCollection>;
}
/**
* ShopifyApi - object-oriented interface
* @export
* @class ShopifyApi
* @extends {BaseAPI}
*/
export declare class ShopifyApi extends BaseAPI implements ShopifyApiInterface {
/**
* Get a list of Inventory Items..
* @summary Get a list of Inventory Items.
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {string} filterProductNumbers Filter for productNumber/productNumbers. The maximum number of productNumbers allowed is 100. The values must be separated by a comma.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShopifyApi
*/
getShopifyInventoryItemCollection(shopifyShopDomain: string, filterProductNumbers: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ShopifyInventoryItemCollection, any>>;
/**
* Get a list of Product Variants.
* @summary Get a list of Product Variants.
* @param {string} shopifyShopDomain shopifyShopDomain
* @param {string} [filterProductNumbers] Filter for productNumber/productNumbers. The maximum number of productNumbers allowed is 100. The values must be separated by a comma.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ShopifyApi
*/
getShopifyProductVariantCollection(shopifyShopDomain: string, filterProductNumbers?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ShopifyProductVariantCollection, any>>;
}