@liquidcommerce/cloud-sdk
Version:
LiquidCommerce Cloud SDK
20 lines (19 loc) • 897 B
TypeScript
import type { ILiquidCommerceOrderClient } from './interfaces';
import type { ILiquidCommerceOrderConfig } from './types';
/**
* Factory function to create and initialize a LiquidCommerceOrderClient instance.
*
* @param {ILiquidCommerceOrderConfig} config - The configuration object containing options such as environment settings, base URLs, and other preferences.
* @return {Promise<LiquidCommerceOrderClient>} - A promise that resolves to a fully initialized LiquidCommerceOrderClient instance.
*
* @example
* // Example usage:
* const orderLiquidClient = await LiquidCommerceOrders({
* userID: 'yourUserID',
* password: 'yourPassword',
* env: LIQUID_COMMERCE_ENV.STAGE,
* });
*
* @throws {Error} - Throws an error if the client initialization fails.
*/
export declare function LiquidCommerceOrders(config: ILiquidCommerceOrderConfig): Promise<ILiquidCommerceOrderClient>;