@commercelayer/sdk 5.0.0-alpha.5 → 5.0.0-beta.10

package/lib/esm/api.js

@@ -0,0 +1,226 @@
+// ##__API_RESOURCES_START__##
+// ##__API_RESOURCES_TEMPLATE:: export { default as ##__RESOURCE_CLASS__## } from './resources/##__RESOURCE_TYPE__##'
+/**
+ * ©2023 Commerce Layer Inc.
+ **/
+export { default as Addresses } from './resources/addresses';
+export { default as Adjustments } from './resources/adjustments';
+export { default as AdyenGateways } from './resources/adyen_gateways';
+export { default as AdyenPayments } from './resources/adyen_payments';
+export { default as Applications } from './resources/application';
+export { default as Attachments } from './resources/attachments';
+export { default as Authorizations } from './resources/authorizations';
+export { default as AvalaraAccounts } from './resources/avalara_accounts';
+export { default as AxerveGateways } from './resources/axerve_gateways';
+export { default as AxervePayments } from './resources/axerve_payments';
+export { default as BillingInfoValidationRules } from './resources/billing_info_validation_rules';
+export { default as BingGeocoders } from './resources/bing_geocoders';
+export { default as BraintreeGateways } from './resources/braintree_gateways';
+export { default as BraintreePayments } from './resources/braintree_payments';
+export { default as Bundles } from './resources/bundles';
+export { default as Captures } from './resources/captures';
+export { default as CarrierAccounts } from './resources/carrier_accounts';
+export { default as CheckoutComGateways } from './resources/checkout_com_gateways';
+export { default as CheckoutComPayments } from './resources/checkout_com_payments';
+export { default as Cleanups } from './resources/cleanups';
+export { default as CouponCodesPromotionRules } from './resources/coupon_codes_promotion_rules';
+export { default as CouponRecipients } from './resources/coupon_recipients';
+export { default as Coupons } from './resources/coupons';
+export { default as CustomerAddresses } from './resources/customer_addresses';
+export { default as CustomerGroups } from './resources/customer_groups';
+export { default as CustomerPasswordResets } from './resources/customer_password_resets';
+export { default as CustomerPaymentSources } from './resources/customer_payment_sources';
+export { default as CustomerSubscriptions } from './resources/customer_subscriptions';
+export { default as Customers } from './resources/customers';
+export { default as DeliveryLeadTimes } from './resources/delivery_lead_times';
+export { default as EventCallbacks } from './resources/event_callbacks';
+export { default as Events } from './resources/events';
+export { default as Exports } from './resources/exports';
+export { default as ExternalGateways } from './resources/external_gateways';
+export { default as ExternalPayments } from './resources/external_payments';
+export { default as ExternalPromotions } from './resources/external_promotions';
+export { default as ExternalTaxCalculators } from './resources/external_tax_calculators';
+export { default as FixedAmountPromotions } from './resources/fixed_amount_promotions';
+export { default as FixedPricePromotions } from './resources/fixed_price_promotions';
+export { default as FreeGiftPromotions } from './resources/free_gift_promotions';
+export { default as FreeShippingPromotions } from './resources/free_shipping_promotions';
+export { default as Geocoders } from './resources/geocoders';
+export { default as GiftCardRecipients } from './resources/gift_card_recipients';
+export { default as GiftCards } from './resources/gift_cards';
+export { default as GoogleGeocoders } from './resources/google_geocoders';
+export { default as Imports } from './resources/imports';
+export { default as InStockSubscriptions } from './resources/in_stock_subscriptions';
+export { default as InventoryModels } from './resources/inventory_models';
+export { default as InventoryReturnLocations } from './resources/inventory_return_locations';
+export { default as InventoryStockLocations } from './resources/inventory_stock_locations';
+export { default as KlarnaGateways } from './resources/klarna_gateways';
+export { default as KlarnaPayments } from './resources/klarna_payments';
+export { default as LineItemOptions } from './resources/line_item_options';
+export { default as LineItems } from './resources/line_items';
+export { default as ManualGateways } from './resources/manual_gateways';
+export { default as ManualTaxCalculators } from './resources/manual_tax_calculators';
+export { default as Markets } from './resources/markets';
+export { default as Merchants } from './resources/merchants';
+export { default as OrderAmountPromotionRules } from './resources/order_amount_promotion_rules';
+export { default as OrderCopies } from './resources/order_copies';
+export { default as OrderSubscriptions } from './resources/order_subscriptions';
+export { default as OrderValidationRules } from './resources/order_validation_rules';
+export { default as Orders } from './resources/orders';
+export { default as Organizations } from './resources/organization';
+export { default as Packages } from './resources/packages';
+export { default as ParcelLineItems } from './resources/parcel_line_items';
+export { default as Parcels } from './resources/parcels';
+export { default as PaymentGateways } from './resources/payment_gateways';
+export { default as PaymentMethods } from './resources/payment_methods';
+export { default as PaypalGateways } from './resources/paypal_gateways';
+export { default as PaypalPayments } from './resources/paypal_payments';
+export { default as PercentageDiscountPromotions } from './resources/percentage_discount_promotions';
+export { default as PriceLists } from './resources/price_lists';
+export { default as PriceTiers } from './resources/price_tiers';
+export { default as PriceVolumeTiers } from './resources/price_volume_tiers';
+export { default as Prices } from './resources/prices';
+export { default as PromotionRules } from './resources/promotion_rules';
+export { default as Promotions } from './resources/promotions';
+export { default as Refunds } from './resources/refunds';
+export { default as ReturnLineItems } from './resources/return_line_items';
+export { default as Returns } from './resources/returns';
+export { default as SatispayGateways } from './resources/satispay_gateways';
+export { default as SatispayPayments } from './resources/satispay_payments';
+export { default as Shipments } from './resources/shipments';
+export { default as ShippingCategories } from './resources/shipping_categories';
+export { default as ShippingMethodTiers } from './resources/shipping_method_tiers';
+export { default as ShippingMethods } from './resources/shipping_methods';
+export { default as ShippingWeightTiers } from './resources/shipping_weight_tiers';
+export { default as ShippingZones } from './resources/shipping_zones';
+export { default as SkuListItems } from './resources/sku_list_items';
+export { default as SkuListPromotionRules } from './resources/sku_list_promotion_rules';
+export { default as SkuLists } from './resources/sku_lists';
+export { default as SkuOptions } from './resources/sku_options';
+export { default as Skus } from './resources/skus';
+export { default as StockItems } from './resources/stock_items';
+export { default as StockLineItems } from './resources/stock_line_items';
+export { default as StockLocations } from './resources/stock_locations';
+export { default as StockTransfers } from './resources/stock_transfers';
+export { default as StripeGateways } from './resources/stripe_gateways';
+export { default as StripePayments } from './resources/stripe_payments';
+export { default as TaxCalculators } from './resources/tax_calculators';
+export { default as TaxCategories } from './resources/tax_categories';
+export { default as TaxRules } from './resources/tax_rules';
+export { default as TaxjarAccounts } from './resources/taxjar_accounts';
+export { default as Transactions } from './resources/transactions';
+export { default as Voids } from './resources/voids';
+export { default as Webhooks } from './resources/webhooks';
+export { default as WireTransfers } from './resources/wire_transfers';
+// ##__API_RESOURCE_TYPES_STOP__##
+export const resourceList = [
+    // ##__API_RESOURCE_LIST_START__##
+    'addresses',
+    'adjustments',
+    'adyen_gateways',
+    'adyen_payments',
+    'application',
+    'attachments',
+    'authorizations',
+    'avalara_accounts',
+    'axerve_gateways',
+    'axerve_payments',
+    'billing_info_validation_rules',
+    'bing_geocoders',
+    'braintree_gateways',
+    'braintree_payments',
+    'bundles',
+    'captures',
+    'carrier_accounts',
+    'checkout_com_gateways',
+    'checkout_com_payments',
+    'cleanups',
+    'coupon_codes_promotion_rules',
+    'coupon_recipients',
+    'coupons',
+    'customer_addresses',
+    'customer_groups',
+    'customer_password_resets',
+    'customer_payment_sources',
+    'customer_subscriptions',
+    'customers',
+    'delivery_lead_times',
+    'event_callbacks',
+    'events',
+    'exports',
+    'external_gateways',
+    'external_payments',
+    'external_promotions',
+    'external_tax_calculators',
+    'fixed_amount_promotions',
+    'fixed_price_promotions',
+    'free_gift_promotions',
+    'free_shipping_promotions',
+    'geocoders',
+    'gift_card_recipients',
+    'gift_cards',
+    'google_geocoders',
+    'imports',
+    'in_stock_subscriptions',
+    'inventory_models',
+    'inventory_return_locations',
+    'inventory_stock_locations',
+    'klarna_gateways',
+    'klarna_payments',
+    'line_item_options',
+    'line_items',
+    'manual_gateways',
+    'manual_tax_calculators',
+    'markets',
+    'merchants',
+    'order_amount_promotion_rules',
+    'order_copies',
+    'order_subscriptions',
+    'order_validation_rules',
+    'orders',
+    'organization',
+    'packages',
+    'parcel_line_items',
+    'parcels',
+    'payment_gateways',
+    'payment_methods',
+    'paypal_gateways',
+    'paypal_payments',
+    'percentage_discount_promotions',
+    'price_lists',
+    'price_tiers',
+    'price_volume_tiers',
+    'prices',
+    'promotion_rules',
+    'promotions',
+    'refunds',
+    'return_line_items',
+    'returns',
+    'satispay_gateways',
+    'satispay_payments',
+    'shipments',
+    'shipping_categories',
+    'shipping_method_tiers',
+    'shipping_methods',
+    'shipping_weight_tiers',
+    'shipping_zones',
+    'sku_list_items',
+    'sku_list_promotion_rules',
+    'sku_lists',
+    'sku_options',
+    'skus',
+    'stock_items',
+    'stock_line_items',
+    'stock_locations',
+    'stock_transfers',
+    'stripe_gateways',
+    'stripe_payments',
+    'tax_calculators',
+    'tax_categories',
+    'tax_rules',
+    'taxjar_accounts',
+    'transactions',
+    'voids',
+    'webhooks',
+    'wire_transfers'
+    // ##__API_RESOURCE_LIST_STOP__##
+];

package/lib/esm/client.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { AxiosProxyConfig, Method } from 'axios';
+import type { InterceptorManager } from './interceptor';
+import type { Agent as HttpAgent } from 'http';
+import type { Agent as HttpsAgent } from 'https';
+type ProxyConfig = AxiosProxyConfig | false;
+type RequestConfig = {
+    timeout?: number;
+    params?: {
+        [key: string]: string | number | boolean;
+    };
+    httpAgent?: HttpAgent;
+    httpsAgent?: HttpsAgent;
+    proxy?: ProxyConfig;
+};
+type ApiClientInitConfig = {
+    organization: string;
+    domain?: string;
+    accessToken: string;
+} & RequestConfig;
+type ApiClientConfig = Partial<ApiClientInitConfig>;
+declare class ApiClient {
+    #private;
+    static create(options: ApiClientInitConfig): ApiClient;
+    baseUrl: string;
+    interceptors: InterceptorManager;
+    private constructor();
+    config(config: ApiClientConfig): void;
+    request(method: Method, path: string, body?: any, options?: ApiClientConfig): Promise<any>;
+}
+export default ApiClient;
+export { ApiClientInitConfig, ApiClientConfig, RequestConfig };

package/lib/esm/client.js

@@ -0,0 +1,121 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ApiClient_accessToken, _ApiClient_client;
+import axios from 'axios';
+import { SdkError, ApiError, ErrorType } from './error';
+import config from './config';
+import Debug from './debug';
+const debug = Debug('client');
+const baseURL = (organization, domain) => {
+    return `https://${organization.toLowerCase()}.${domain || config.default.domain}/api`;
+};
+const handleError = (error) => {
+    let sdkError = new SdkError({ message: error.message });
+    if (axios.isAxiosError(error)) {
+        if (error.response) {
+            // The request was made and the server responded with a status code that falls out of the range of 2xx
+            const apiError = new ApiError(sdkError);
+            apiError.type = ErrorType.RESPONSE;
+            apiError.status = error.response.status;
+            apiError.code = String(apiError.status);
+            apiError.errors = error.response.data.errors;
+            sdkError = apiError;
+        }
+        else if (error.request) {
+            // The request was made but no response was received
+            // `error.request` is an instance of XMLHttpRequest in the browser and an instance of http.ClientRequest in node.js
+            sdkError.type = ErrorType.REQUEST;
+            sdkError.request = error.request;
+        }
+        else {
+            // Something happened in setting up the request that triggered an Error
+            sdkError.type = ErrorType.CLIENT;
+        }
+    }
+    else if (axios.isCancel(error))
+        sdkError.type = ErrorType.CANCEL;
+    else
+        sdkError.source = error;
+    throw sdkError;
+};
+class ApiClient {
+    static create(options) {
+        for (const attr of config.client.requiredAttributes)
+            if (!options || !options[attr])
+                throw new SdkError({ message: `Undefined '${attr}' parameter` });
+        return new ApiClient(options);
+    }
+    constructor(options) {
+        _ApiClient_accessToken.set(this, void 0);
+        _ApiClient_client.set(this, void 0);
+        debug('new client instance %O', options);
+        this.baseUrl = baseURL(options.organization, options.domain);
+        __classPrivateFieldSet(this, _ApiClient_accessToken, options.accessToken, "f");
+        const axiosConfig = {
+            timeout: options.timeout || config.client.timeout,
+            proxy: options.proxy,
+            httpAgent: options.httpAgent,
+            httpsAgent: options.httpsAgent,
+        };
+        const axiosOptions = {
+            baseURL: this.baseUrl,
+            timeout: config.client.timeout,
+            headers: {
+                'Accept': 'application/vnd.api+json',
+                'Content-Type': 'application/vnd.api+json',
+                'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f"),
+            },
+            ...axiosConfig
+        };
+        debug('axios options: %O', axiosOptions);
+        __classPrivateFieldSet(this, _ApiClient_client, axios.create(axiosOptions), "f");
+        this.interceptors = __classPrivateFieldGet(this, _ApiClient_client, "f").interceptors;
+    }
+    config(config) {
+        debug('config %o', config);
+        const def = __classPrivateFieldGet(this, _ApiClient_client, "f").defaults;
+        // Axios config
+        if (config.timeout)
+            def.timeout = config.timeout;
+        if (config.proxy)
+            def.proxy = config.proxy;
+        if (config.httpAgent)
+            def.httpAgent = config.httpAgent;
+        if (config.httpsAgent)
+            def.httpsAgent = config.httpsAgent;
+        // API Client config
+        if (config.organization)
+            this.baseUrl = baseURL(config.organization, config.domain);
+        if (config.accessToken) {
+            __classPrivateFieldSet(this, _ApiClient_accessToken, config.accessToken, "f");
+            def.headers.common.Authorization = 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f");
+        }
+    }
+    async request(method, path, body, options) {
+        debug('request %s %s, %O, %O', method, path, body || {}, options || {});
+        const data = body ? { data: body } : undefined;
+        const url = path;
+        // Runtime request parameters
+        const baseUrl = (options === null || options === void 0 ? void 0 : options.organization) ? baseURL(options.organization, options.domain) : undefined;
+        const accessToken = (options === null || options === void 0 ? void 0 : options.accessToken) || __classPrivateFieldGet(this, _ApiClient_accessToken, "f");
+        const headers = accessToken ? { 'Authorization': 'Bearer ' + accessToken } : undefined;
+        const requestParams = { method, baseURL: baseUrl, url, data, headers, ...options };
+        debug('request params: %O', requestParams);
+        // const start = Date.now()
+        return __classPrivateFieldGet(this, _ApiClient_client, "f").request(requestParams)
+            .then(response => response.data)
+            .catch(error => handleError(error));
+        // .finally(() => console.log(`<<-- ${method} ${path} ${Date.now() - start}`))
+    }
+}
+_ApiClient_accessToken = new WeakMap(), _ApiClient_client = new WeakMap();
+export default ApiClient;

package/lib/esm/commercelayer.d.ts

@@ -0,0 +1,139 @@
+import * as api from './api';
+import type { ApiError } from './error';
+import type { ErrorInterceptor, InterceptorType, RawResponseReader, RequestInterceptor, ResponseInterceptor } from './interceptor';
+import type { ResourcesInitConfig } from './resource';
+declare const OPEN_API_SCHEMA_VERSION = "4.0.1";
+export { OPEN_API_SCHEMA_VERSION };
+type SdkConfig = {};
+type CommerceLayerInitConfig = SdkConfig & ResourcesInitConfig;
+type CommerceLayerConfig = Partial<CommerceLayerInitConfig>;
+declare class CommerceLayerClient {
+    #private;
+    static get openApiSchemaVersion(): string;
+    readonly openApiSchemaVersion = "4.0.1";
+    addresses: api.Addresses;
+    adjustments: api.Adjustments;
+    adyen_gateways: api.AdyenGateways;
+    adyen_payments: api.AdyenPayments;
+    application: api.Applications;
+    attachments: api.Attachments;
+    authorizations: api.Authorizations;
+    avalara_accounts: api.AvalaraAccounts;
+    axerve_gateways: api.AxerveGateways;
+    axerve_payments: api.AxervePayments;
+    billing_info_validation_rules: api.BillingInfoValidationRules;
+    bing_geocoders: api.BingGeocoders;
+    braintree_gateways: api.BraintreeGateways;
+    braintree_payments: api.BraintreePayments;
+    bundles: api.Bundles;
+    captures: api.Captures;
+    carrier_accounts: api.CarrierAccounts;
+    checkout_com_gateways: api.CheckoutComGateways;
+    checkout_com_payments: api.CheckoutComPayments;
+    cleanups: api.Cleanups;
+    coupon_codes_promotion_rules: api.CouponCodesPromotionRules;
+    coupon_recipients: api.CouponRecipients;
+    coupons: api.Coupons;
+    customer_addresses: api.CustomerAddresses;
+    customer_groups: api.CustomerGroups;
+    customer_password_resets: api.CustomerPasswordResets;
+    customer_payment_sources: api.CustomerPaymentSources;
+    customer_subscriptions: api.CustomerSubscriptions;
+    customers: api.Customers;
+    delivery_lead_times: api.DeliveryLeadTimes;
+    event_callbacks: api.EventCallbacks;
+    events: api.Events;
+    exports: api.Exports;
+    external_gateways: api.ExternalGateways;
+    external_payments: api.ExternalPayments;
+    external_promotions: api.ExternalPromotions;
+    external_tax_calculators: api.ExternalTaxCalculators;
+    fixed_amount_promotions: api.FixedAmountPromotions;
+    fixed_price_promotions: api.FixedPricePromotions;
+    free_gift_promotions: api.FreeGiftPromotions;
+    free_shipping_promotions: api.FreeShippingPromotions;
+    geocoders: api.Geocoders;
+    gift_card_recipients: api.GiftCardRecipients;
+    gift_cards: api.GiftCards;
+    google_geocoders: api.GoogleGeocoders;
+    imports: api.Imports;
+    in_stock_subscriptions: api.InStockSubscriptions;
+    inventory_models: api.InventoryModels;
+    inventory_return_locations: api.InventoryReturnLocations;
+    inventory_stock_locations: api.InventoryStockLocations;
+    klarna_gateways: api.KlarnaGateways;
+    klarna_payments: api.KlarnaPayments;
+    line_item_options: api.LineItemOptions;
+    line_items: api.LineItems;
+    manual_gateways: api.ManualGateways;
+    manual_tax_calculators: api.ManualTaxCalculators;
+    markets: api.Markets;
+    merchants: api.Merchants;
+    order_amount_promotion_rules: api.OrderAmountPromotionRules;
+    order_copies: api.OrderCopies;
+    order_subscriptions: api.OrderSubscriptions;
+    order_validation_rules: api.OrderValidationRules;
+    orders: api.Orders;
+    organization: api.Organizations;
+    packages: api.Packages;
+    parcel_line_items: api.ParcelLineItems;
+    parcels: api.Parcels;
+    payment_gateways: api.PaymentGateways;
+    payment_methods: api.PaymentMethods;
+    paypal_gateways: api.PaypalGateways;
+    paypal_payments: api.PaypalPayments;
+    percentage_discount_promotions: api.PercentageDiscountPromotions;
+    price_lists: api.PriceLists;
+    price_tiers: api.PriceTiers;
+    price_volume_tiers: api.PriceVolumeTiers;
+    prices: api.Prices;
+    promotion_rules: api.PromotionRules;
+    promotions: api.Promotions;
+    refunds: api.Refunds;
+    return_line_items: api.ReturnLineItems;
+    returns: api.Returns;
+    satispay_gateways: api.SatispayGateways;
+    satispay_payments: api.SatispayPayments;
+    shipments: api.Shipments;
+    shipping_categories: api.ShippingCategories;
+    shipping_method_tiers: api.ShippingMethodTiers;
+    shipping_methods: api.ShippingMethods;
+    shipping_weight_tiers: api.ShippingWeightTiers;
+    shipping_zones: api.ShippingZones;
+    sku_list_items: api.SkuListItems;
+    sku_list_promotion_rules: api.SkuListPromotionRules;
+    sku_lists: api.SkuLists;
+    sku_options: api.SkuOptions;
+    skus: api.Skus;
+    stock_items: api.StockItems;
+    stock_line_items: api.StockLineItems;
+    stock_locations: api.StockLocations;
+    stock_transfers: api.StockTransfers;
+    stripe_gateways: api.StripeGateways;
+    stripe_payments: api.StripePayments;
+    tax_calculators: api.TaxCalculators;
+    tax_categories: api.TaxCategories;
+    tax_rules: api.TaxRules;
+    taxjar_accounts: api.TaxjarAccounts;
+    transactions: api.Transactions;
+    voids: api.Voids;
+    webhooks: api.Webhooks;
+    wire_transfers: api.WireTransfers;
+    constructor(config: CommerceLayerInitConfig);
+    get currentOrganization(): string;
+    private localConfig;
+    config(config: CommerceLayerConfig): void;
+    resources(): readonly string[];
+    isApiError(error: any): error is ApiError;
+    addRequestInterceptor(onFulfilled?: RequestInterceptor, onRejected?: ErrorInterceptor): number;
+    addResponseInterceptor(onFulfilled?: ResponseInterceptor, onRejected?: ErrorInterceptor): number;
+    removeInterceptor(type: InterceptorType, id: number): void;
+    addRawResponseReader(options?: {
+        headers: boolean;
+    }): RawResponseReader;
+    removeRawResponseReader(reader: number | RawResponseReader): void;
+}
+declare const CommerceLayer: (config: CommerceLayerInitConfig) => CommerceLayerClient;
+export default CommerceLayer;
+export { CommerceLayer };
+export type { CommerceLayerClient, CommerceLayerConfig, CommerceLayerInitConfig };