@commercelayer/sdk 6.0.0-alfa.8 → 6.0.0-beta.1

package/lib/esm/api.js

@@ -1,248 +0,0 @@
-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 BuyXPayYPromotions } from './resources/buy_x_pay_y_promotions';
-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 CustomPromotionRules } from './resources/custom_promotion_rules';
-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 OrderFactories } from './resources/order_factories';
-export { default as OrderSubscriptionItems } from './resources/order_subscription_items';
-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 PaymentOptions } from './resources/payment_options';
-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 PriceFrequencyTiers } from './resources/price_frequency_tiers';
-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 RecurringOrderCopies } from './resources/recurring_order_copies';
-export { default as Refunds } from './resources/refunds';
-export { default as ReservedStocks } from './resources/reserved_stocks';
-export { default as ResourceErrors } from './resources/resource_errors';
-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 StockReservations } from './resources/stock_reservations';
-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 SubscriptionModels } from './resources/subscription_models';
-export { default as Tags } from './resources/tags';
-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 Versions } from './resources/versions';
-export { default as Voids } from './resources/voids';
-export { default as Webhooks } from './resources/webhooks';
-export { default as WireTransfers } from './resources/wire_transfers';
-export const resourceList = [
-    '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',
-    'buy_x_pay_y_promotions',
-    'captures',
-    'carrier_accounts',
-    'checkout_com_gateways',
-    'checkout_com_payments',
-    'cleanups',
-    'coupon_codes_promotion_rules',
-    'coupon_recipients',
-    'coupons',
-    'custom_promotion_rules',
-    '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_factories',
-    'order_subscription_items',
-    'order_subscriptions',
-    'order_validation_rules',
-    'orders',
-    'organization',
-    'packages',
-    'parcel_line_items',
-    'parcels',
-    'payment_gateways',
-    'payment_methods',
-    'payment_options',
-    'paypal_gateways',
-    'paypal_payments',
-    'percentage_discount_promotions',
-    'price_frequency_tiers',
-    'price_lists',
-    'price_tiers',
-    'price_volume_tiers',
-    'prices',
-    'promotion_rules',
-    'promotions',
-    'recurring_order_copies',
-    'refunds',
-    'reserved_stocks',
-    'resource_errors',
-    '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_reservations',
-    'stock_transfers',
-    'stripe_gateways',
-    'stripe_payments',
-    'subscription_models',
-    'tags',
-    'tax_calculators',
-    'tax_categories',
-    'tax_rules',
-    'taxjar_accounts',
-    'transactions',
-    'versions',
-    'voids',
-    'webhooks',
-    'wire_transfers'
-];
-export const singletonList = [
-    'application',
-    'organization'
-];

package/lib/esm/client.d.ts

@@ -1,31 +0,0 @@
-import type { InterceptorManager } from './interceptor';
-import { type FetchResponse } from './fetch';
-type RequestParams = Record<string, string | number | boolean>;
-type RequestHeaders = Record<string, string>;
-type RequestConfig = {
-    timeout?: number;
-    params?: RequestParams;
-    headers?: RequestHeaders;
-    userAgent?: string;
-};
-type ApiConfig = {
-    organization: string;
-    domain?: string;
-    accessToken: string;
-};
-type ApiClientInitConfig = ApiConfig & RequestConfig;
-type ApiClientConfig = Partial<ApiClientInitConfig>;
-export type Method = 'GET' | 'DELETE' | 'POST' | 'PUT' | 'PATCH';
-declare class ApiClient {
-    #private;
-    static create(options: ApiClientInitConfig): ApiClient;
-    private constructor();
-    get interceptors(): InterceptorManager;
-    get requestHeaders(): RequestHeaders;
-    config(config: ApiClientConfig): ApiClient;
-    userAgent(userAgent: string): ApiClient;
-    request(method: Method, path: string, body?: any, options?: ApiClientConfig): Promise<FetchResponse>;
-    private customHeaders;
-}
-export default ApiClient;
-export type { ApiClientInitConfig, ApiClientConfig, RequestConfig };

package/lib/esm/client.js

@@ -1,102 +0,0 @@
-import { SdkError, handleError } from './error';
-import config from './config';
-import { fetchURL } from './fetch';
-import Debug from './debug';
-const debug = Debug('client');
-const baseURL = (organization, domain) => {
-    return `https://${organization.toLowerCase()}.${domain || config.default.domain}/api`;
-};
-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);
-    }
-    #baseUrl;
-    #accessToken;
-    #clientConfig;
-    #interceptors;
-    constructor(options) {
-        debug('new client instance %O', options);
-        this.#baseUrl = baseURL(options.organization, options.domain);
-        this.#accessToken = options.accessToken;
-        const fetchConfig = {
-            timeout: options.timeout || config.client.timeout,
-        };
-        const customHeaders = this.customHeaders(options.headers);
-        const headers = {
-            ...customHeaders,
-            'Accept': 'application/vnd.api+json',
-            'Content-Type': 'application/vnd.api+json',
-            'Authorization': 'Bearer ' + this.#accessToken
-        };
-        const userAgent = options.userAgent;
-        if (userAgent)
-            headers['User-Agent'] = userAgent;
-        fetchConfig.headers = headers;
-        this.#clientConfig = fetchConfig;
-        debug('fetch config: %O', fetchConfig);
-        this.#interceptors = {};
-    }
-    get interceptors() { return this.#interceptors; }
-    get requestHeaders() {
-        if (!this.#clientConfig.headers)
-            this.#clientConfig.headers = {};
-        return this.#clientConfig.headers;
-    }
-    config(config) {
-        debug('config %o', config);
-        const def = this.#clientConfig;
-        if (!def.headers)
-            def.headers = {};
-        if (config.timeout)
-            def.timeout = config.timeout;
-        if (config.userAgent)
-            this.userAgent(config.userAgent);
-        if (config.organization)
-            this.#baseUrl = baseURL(config.organization, config.domain);
-        if (config.accessToken) {
-            this.#accessToken = config.accessToken;
-            def.headers.Authorization = 'Bearer ' + this.#accessToken;
-        }
-        if (config.headers)
-            def.headers = { ...def.headers, ...this.customHeaders(config.headers) };
-        return this;
-    }
-    userAgent(userAgent) {
-        if (userAgent)
-            this.requestHeaders['User-Agent'] = userAgent;
-        return this;
-    }
-    async request(method, path, body, options) {
-        debug('request %s %s, %O, %O', method, path, body || {}, options || {});
-        if (options?.userAgent)
-            debug('User-Agent header ignored in request config');
-        const baseUrl = options?.organization ? baseURL(options.organization, options.domain) : this.#baseUrl;
-        const url = new URL(`${baseUrl}/${path}`);
-        const bodyData = body ? JSON.stringify({ data: body }) : undefined;
-        const headers = { ...this.requestHeaders, ...this.customHeaders(options?.headers) };
-        const accessToken = options?.accessToken || this.#accessToken;
-        if (accessToken)
-            headers.Authorization = 'Bearer ' + accessToken;
-        const fetchOptions = { method, body: bodyData, headers };
-        const timeout = options?.timeout || this.#clientConfig.timeout;
-        if (timeout)
-            fetchOptions.signal = AbortSignal.timeout(timeout);
-        if (options?.params)
-            Object.entries(options?.params).forEach(([name, value]) => { url.searchParams.append(name, String(value)); });
-        return await fetchURL(url, fetchOptions, this.interceptors)
-            .catch((error) => handleError(error));
-    }
-    customHeaders(headers) {
-        const customHeaders = {};
-        if (headers) {
-            for (const [name, value] of Object.entries(headers))
-                if (!['accept', 'content-type', 'authorization', 'user-agent'].includes(name.toLowerCase()))
-                    customHeaders[name] = value;
-        }
-        return customHeaders;
-    }
-}
-export default ApiClient;

package/lib/esm/commercelayer.d.ts

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