@commercelayer/sdk 4.41.0 → 4.42.0

package/lib/cjs/api.d.ts

@@ -1,3 +1,6 @@
+import type { Resource, ResourceRel } from './resource';
+import type { TagType } from './resources/tags';
+import type { VersionType } from './resources/versions';
 /**
  * ©2024 Commerce Layer Inc.
  **/
@@ -123,3 +126,38 @@ export { default as Webhooks } from './resources/webhooks';
 export { default as WireTransfers } from './resources/wire_transfers';
 export type ResourceTypeLock = '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' | '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 declare const resourceList: readonly ["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", "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 declare const singletonList: readonly ["application", "organization"];
+export type RetrievableResourceType = ResourceTypeLock;
+export type RetrievableResource = Resource & {
+    type: RetrievableResourceType;
+};
+export type ListableResourceType = Exclude<ResourceTypeLock, 'application' | 'organization'>;
+export type ListableResource = Resource & {
+    type: ListableResourceType;
+};
+export type CreatableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'buy_x_pay_y_promotions' | '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' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | '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_subscription_items' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'payment_options' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'recurring_order_copies' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | '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_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+export type CreatableResource = Resource & {
+    type: CreatableResourceType;
+};
+export type UpdatableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | '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' | 'checkout_com_gateways' | 'checkout_com_payments' | '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' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | '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_subscription_items' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'payment_options' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'recurring_order_copies' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | '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_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+export type UpdatableResource = Resource & {
+    type: UpdatableResourceType;
+};
+export type DeletableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'buy_x_pay_y_promotions' | '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' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | '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_subscription_items' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'payment_options' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'recurring_order_copies' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | '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_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+export type DeletableResource = Resource & {
+    type: DeletableResourceType;
+};
+export type TaggableResourceType = 'addresses' | 'bundles' | 'buy_x_pay_y_promotions' | 'coupons' | 'customers' | 'external_promotions' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_cards' | 'line_item_options' | 'line_items' | 'orders' | 'percentage_discount_promotions' | 'promotions' | 'returns' | 'shipments' | 'sku_options' | 'skus';
+export type TaggableResource = Resource & {
+    type: TaggableResourceType;
+    tags?: Array<ResourceRel & {
+        type: TagType;
+    }> | null;
+};
+export type VersionableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | '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_payment_sources' | 'customer_subscriptions' | 'delivery_lead_times' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_subscriptions' | 'order_validation_rules' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'refunds' | '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';
+export type VersionableResource = Resource & {
+    type: VersionableResourceType;
+    versions?: Array<ResourceRel & {
+        type: VersionType;
+    }> | null;
+};

package/lib/cjs/api.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InventoryModels = exports.InStockSubscriptions = exports.Imports = exports.GoogleGeocoders = exports.GiftCards = exports.GiftCardRecipients = exports.Geocoders = exports.FreeShippingPromotions = exports.FreeGiftPromotions = exports.FixedPricePromotions = exports.FixedAmountPromotions = exports.ExternalTaxCalculators = exports.ExternalPromotions = exports.ExternalPayments = exports.ExternalGateways = exports.Exports = exports.Events = exports.EventCallbacks = exports.DeliveryLeadTimes = exports.Customers = exports.CustomerSubscriptions = exports.CustomerPaymentSources = exports.CustomerPasswordResets = exports.CustomerGroups = exports.CustomerAddresses = exports.CustomPromotionRules = exports.Coupons = exports.CouponRecipients = exports.CouponCodesPromotionRules = exports.Cleanups = exports.CheckoutComPayments = exports.CheckoutComGateways = exports.CarrierAccounts = exports.Captures = exports.BuyXPayYPromotions = exports.Bundles = exports.BraintreePayments = exports.BraintreeGateways = exports.BingGeocoders = exports.BillingInfoValidationRules = exports.AxervePayments = exports.AxerveGateways = exports.AvalaraAccounts = exports.Authorizations = exports.Attachments = exports.Applications = exports.AdyenPayments = exports.AdyenGateways = exports.Adjustments = exports.Addresses = void 0;
 exports.SkuLists = exports.SkuListPromotionRules = exports.SkuListItems = exports.ShippingZones = exports.ShippingWeightTiers = exports.ShippingMethods = exports.ShippingMethodTiers = exports.ShippingCategories = exports.Shipments = exports.SatispayPayments = exports.SatispayGateways = exports.Returns = exports.ReturnLineItems = exports.ReservedStocks = exports.Refunds = exports.RecurringOrderCopies = exports.Promotions = exports.PromotionRules = exports.Prices = exports.PriceVolumeTiers = exports.PriceTiers = exports.PriceLists = exports.PriceFrequencyTiers = exports.PercentageDiscountPromotions = exports.PaypalPayments = exports.PaypalGateways = exports.PaymentOptions = exports.PaymentMethods = exports.PaymentGateways = exports.Parcels = exports.ParcelLineItems = exports.Packages = exports.Organizations = exports.Orders = exports.OrderValidationRules = exports.OrderSubscriptions = exports.OrderSubscriptionItems = exports.OrderFactories = exports.OrderCopies = exports.OrderAmountPromotionRules = exports.Merchants = exports.Markets = exports.ManualTaxCalculators = exports.ManualGateways = exports.LineItems = exports.LineItemOptions = exports.KlarnaPayments = exports.KlarnaGateways = exports.InventoryStockLocations = exports.InventoryReturnLocations = void 0;
-exports.resourceList = exports.WireTransfers = exports.Webhooks = exports.Voids = exports.Versions = exports.Transactions = exports.TaxjarAccounts = exports.TaxRules = exports.TaxCategories = exports.TaxCalculators = exports.Tags = exports.SubscriptionModels = exports.StripePayments = exports.StripeGateways = exports.StockTransfers = exports.StockReservations = exports.StockLocations = exports.StockLineItems = exports.StockItems = exports.Skus = exports.SkuOptions = void 0;
+exports.singletonList = exports.resourceList = exports.WireTransfers = exports.Webhooks = exports.Voids = exports.Versions = exports.Transactions = exports.TaxjarAccounts = exports.TaxRules = exports.TaxCategories = exports.TaxCalculators = exports.Tags = exports.SubscriptionModels = exports.StripePayments = exports.StripeGateways = exports.StockTransfers = exports.StockReservations = exports.StockLocations = exports.StockLineItems = exports.StockItems = exports.Skus = exports.SkuOptions = void 0;
 // ##__API_RESOURCES_START__##
 // ##__API_RESOURCES_TEMPLATE:: export { default as ##__RESOURCE_CLASS__## } from './resources/##__RESOURCE_TYPE__##'
 /**
@@ -376,16 +376,9 @@ exports.resourceList = [
     'wire_transfers'
     // ##__API_RESOURCE_LIST_STOP__##
 ];
-/*
-type ResourceInfo = {
-    name: string;
-    type: string;
-    api: string;
-}
-
-
-export const resourceMap: { [res: string]: ResourceInfo } = {
-    // ##__API_RESOURCE_MAP_START__##
-    // ##__API_RESOURCE_MAP_STOP__##
-} as const
-*/ 
+exports.singletonList = [
+    // ##__API_RESOURCE_SINGLETON_START__##
+    'application',
+    'organization'
+    // ##__API_RESOURCE_SINGLETON_STOP__##
+];

package/lib/cjs/client.d.ts

@@ -1,24 +1,27 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { AxiosProxyConfig, Method } from 'axios';
+import type { AxiosAdapter, 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 Adapter = AxiosAdapter;
+type RequestParams = Record<string, string | number | boolean>;
+type RequestHeaders = Record<string, string>;
 type RequestConfig = {
     timeout?: number;
-    params?: {
-        [key: string]: string | number | boolean;
-    };
-    httpAgent?: HttpAgent;
-    httpsAgent?: HttpsAgent;
+    params?: RequestParams;
+    httpAgent?: any;
+    httpsAgent?: any;
     proxy?: ProxyConfig;
+    headers?: RequestHeaders;
 };
-type ApiClientInitConfig = {
+type RequestConfigExtra = {
+    adapter?: Adapter;
+    userAgent?: string;
+};
+type ApiConfig = {
     organization: string;
     domain?: string;
     accessToken: string;
-} & RequestConfig;
+};
+type ApiClientInitConfig = ApiConfig & RequestConfig & RequestConfigExtra;
 type ApiClientConfig = Partial<ApiClientInitConfig>;
 declare class ApiClient {
     #private;
@@ -26,8 +29,11 @@ declare class ApiClient {
     baseUrl: string;
     interceptors: InterceptorManager;
     private constructor();
-    config(config: ApiClientConfig): void;
+    config(config: ApiClientConfig): ApiClient;
+    userAgent(userAgent: string): ApiClient;
+    adapter(adapter: Adapter): ApiClient;
     request(method: Method, path: string, body?: any, options?: ApiClientConfig): Promise<any>;
+    private customHeaders;
 }
 export default ApiClient;
-export { ApiClientInitConfig, ApiClientConfig, RequestConfig };
+export type { ApiClientInitConfig, ApiClientConfig, RequestConfig };

package/lib/cjs/client.js

@@ -15,50 +15,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _ApiClient_accessToken, _ApiClient_client;
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable @typescript-eslint/no-explicit-any */
 const axios_1 = __importDefault(require("axios"));
 const error_1 = require("./error");
 const config_1 = __importDefault(require("./config"));
+// import type { Agent as HttpAgent } from 'http'
+// import type { Agent as HttpsAgent } from 'https'
+// import { packageInfo } from './util'
 const debug_1 = __importDefault(require("./debug"));
 const debug = (0, debug_1.default)('client');
 const baseURL = (organization, domain) => {
     return `https://${organization.toLowerCase()}.${domain || config_1.default.default.domain}/api`;
 };
-const handleError = (error) => {
-    let sdkError = new error_1.SdkError({ message: error.message });
-    if (axios_1.default.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 error_1.ApiError(sdkError);
-            apiError.type = error_1.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 = error_1.ErrorType.REQUEST;
-            sdkError.request = error.request;
-        }
-        else {
-            // Something happened in setting up the request that triggered an Error
-            sdkError.type = error_1.ErrorType.CLIENT;
-        }
-    }
-    else if (axios_1.default.isCancel(error))
-        sdkError.type = error_1.ErrorType.CANCEL;
-    else
-        sdkError.source = error;
-    throw sdkError;
-};
 class ApiClient {
     static create(options) {
-        if (!(options === null || options === void 0 ? void 0 : options.organization))
-            throw new Error("Undefined 'organization' parameter");
-        if (!(options === null || options === void 0 ? void 0 : options.accessToken))
-            throw new Error("Undefined 'accessToken' parameter");
+        for (const attr of config_1.default.client.requiredAttributes)
+            if (!options || !options[attr])
+                throw new error_1.SdkError({ message: `Undefined '${attr}' parameter` });
         return new ApiClient(options);
     }
     constructor(options) {
@@ -71,13 +43,32 @@ class ApiClient {
             timeout: options.timeout || config_1.default.client.timeout,
             proxy: options.proxy,
             httpAgent: options.httpAgent,
-            httpsAgent: options.httpsAgent,
+            httpsAgent: options.httpsAgent
+        };
+        // Set custom headers
+        const customHeaders = this.customHeaders(options.headers);
+        // Set headers
+        const headers = {
+            ...customHeaders,
+            'Accept': 'application/vnd.api+json',
+            'Content-Type': 'application/vnd.api+json',
+            'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f")
         };
-        const axiosOptions = Object.assign({ baseURL: this.baseUrl, timeout: config_1.default.client.timeout, headers: {
-                'Accept': 'application/vnd.api+json',
-                'Content-Type': 'application/vnd.api+json',
-                'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f"),
-            } }, axiosConfig);
+        // Set User-Agent
+        let userAgent = options.userAgent; // || `SDK-core axios/${axios.VERSION}`
+        if (userAgent) {
+            if (!userAgent.includes('axios/'))
+                userAgent += ` axios/${axios_1.default.VERSION}`;
+            headers['User-Agent'] = userAgent;
+        }
+        const axiosOptions = {
+            baseURL: this.baseUrl,
+            timeout: config_1.default.client.timeout,
+            headers,
+            ...axiosConfig
+        };
+        if (options.adapter)
+            axiosOptions.adapter = options.adapter;
         debug('axios options: %O', axiosOptions);
         __classPrivateFieldSet(this, _ApiClient_client, axios_1.default.create(axiosOptions), "f");
         this.interceptors = __classPrivateFieldGet(this, _ApiClient_client, "f").interceptors;
@@ -94,6 +85,10 @@ class ApiClient {
             def.httpAgent = config.httpAgent;
         if (config.httpsAgent)
             def.httpsAgent = config.httpsAgent;
+        if (config.adapter)
+            this.adapter(config.adapter);
+        if (config.userAgent)
+            this.userAgent(config.userAgent);
         // API Client config
         if (config.organization)
             this.baseUrl = baseURL(config.organization, config.domain);
@@ -101,23 +96,59 @@ class ApiClient {
             __classPrivateFieldSet(this, _ApiClient_accessToken, config.accessToken, "f");
             def.headers.common.Authorization = 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f");
         }
+        if (config.headers)
+            def.headers.common = this.customHeaders(config.headers);
+        return this;
+    }
+    userAgent(userAgent) {
+        if (userAgent) {
+            let ua = userAgent;
+            if (!ua.includes('axios/')) {
+                // const axiosVer = packageInfo(['dependencies.axios'], { nestedName: true })
+                if (axios_1.default.VERSION)
+                    ua += ` axios/${axios_1.default.VERSION}`;
+            }
+            __classPrivateFieldGet(this, _ApiClient_client, "f").defaults.headers['User-Agent'] = ua;
+        }
+        return this;
+    }
+    adapter(adapter) {
+        if (adapter)
+            __classPrivateFieldGet(this, _ApiClient_client, "f").defaults.adapter = adapter;
+        return this;
     }
     async request(method, path, body, options) {
         debug('request %s %s, %O, %O', method, path, body || {}, options || {});
+        // Ignored params alerts (in debug mode)
+        if (options === null || options === void 0 ? void 0 : options.adapter)
+            debug('Adapter ignored in request config');
+        if (options === null || options === void 0 ? void 0 : options.userAgent)
+            debug('User-Agent header ignored in request config');
         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 = Object.assign({ method, baseURL: baseUrl, url, data, headers }, options);
+        const headers = this.customHeaders(options === null || options === void 0 ? void 0 : options.headers);
+        if (accessToken)
+            headers.Authorization = 'Bearer ' + accessToken;
+        const requestParams = { method, baseURL: baseUrl, url, data, ...options, headers };
         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));
+            .catch((error) => (0, error_1.handleError)(error));
         // .finally(() => console.log(`<<-- ${method} ${path} ${Date.now() - start}`))
     }
+    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;
+    }
 }
 _ApiClient_accessToken = new WeakMap(), _ApiClient_client = new WeakMap();
 exports.default = ApiClient;

package/lib/cjs/commercelayer.d.ts

@@ -1,16 +1,15 @@
 import * as api from './api';
-import { ApiError } from './error';
+import type { ApiError } from './error';
 import type { ErrorInterceptor, InterceptorType, RawResponseReader, RequestInterceptor, ResponseInterceptor } from './interceptor';
-import { ResourcesInitConfig } from './resource';
-declare const OPEN_API_SCHEMA_VERSION = "4.23.0";
+import { type ResourcesInitConfig } from './resource';
+declare const OPEN_API_SCHEMA_VERSION = "4.24.0";
 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.23.0";
+    readonly openApiSchemaVersion = "4.24.0";
     addresses: api.Addresses;
     adjustments: api.Adjustments;
     adyen_gateways: api.AdyenGateways;
@@ -134,8 +133,10 @@ declare class CommerceLayerClient {
     constructor(config: CommerceLayerInitConfig);
     get currentOrganization(): string;
     private localConfig;
-    config(config: CommerceLayerConfig): void;
+    config(config: CommerceLayerConfig): CommerceLayerClient;
     resources(): readonly string[];
+    singletons(): readonly string[];
+    isSingleton(resource: api.ResourceTypeLock): boolean;
     isApiError(error: any): error is ApiError;
     addRequestInterceptor(onFulfilled?: RequestInterceptor, onRejected?: ErrorInterceptor): number;
     addResponseInterceptor(onFulfilled?: ResponseInterceptor, onRejected?: ErrorInterceptor): number;

package/lib/cjs/commercelayer.js

@@ -45,18 +45,19 @@ const resource_1 = __importDefault(require("./resource"));
 const debug_1 = __importDefault(require("./debug"));
 const debug = (0, debug_1.default)('commercelayer');
 // Autogenerated schema version number, do not remove this line
-const OPEN_API_SCHEMA_VERSION = '4.23.0';
+const OPEN_API_SCHEMA_VERSION = '4.24.0';
 exports.OPEN_API_SCHEMA_VERSION = OPEN_API_SCHEMA_VERSION;
 class CommerceLayerClient {
-    static get openApiSchemaVersion() { return OPEN_API_SCHEMA_VERSION; }
     // ##__CL_RESOURCES_DEF_STOP__##
     constructor(config) {
+        // static get openApiSchemaVersion(): string { return OPEN_API_SCHEMA_VERSION }
         this.openApiSchemaVersion = OPEN_API_SCHEMA_VERSION;
         _CommerceLayerClient_adapter.set(this, void 0);
         _CommerceLayerClient_organization.set(this, void 0);
         debug('new commercelayer instance %O', config);
         __classPrivateFieldSet(this, _CommerceLayerClient_adapter, new resource_1.default(config), "f");
         __classPrivateFieldSet(this, _CommerceLayerClient_organization, config.organization, "f");
+        // this.#environment = 'test'
         // ##__CL_RESOURCES_INIT_START__##
         // ##__CL_RESOURCES_INIT_TEMPLATE:: ##__TAB__####__TAB__##this.##__RESOURCE_TYPE__## = new api.##__RESOURCE_CLASS__##(this.#adapter)
         this.addresses = new api.Addresses(__classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f"));
@@ -182,6 +183,8 @@ class CommerceLayerClient {
         // ##__CL_RESOURCES_INIT_STOP__##
     }
     get currentOrganization() { return __classPrivateFieldGet(this, _CommerceLayerClient_organization, "f"); }
+    // get currentAccessToken(): string { return this.#adapter?.clientInstance?.currentAccessToken}
+    // get environment(): ApiMode { return this.#environment }
     localConfig(config) {
         if (config.organization)
             __classPrivateFieldSet(this, _CommerceLayerClient_organization, config.organization, "f");
@@ -195,10 +198,17 @@ class CommerceLayerClient {
         if (!config.organization)
             config.organization = this.currentOrganization;
         __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").config(config);
+        return this;
     }
     resources() {
         return static_1.CommerceLayerStatic.resources();
     }
+    singletons() {
+        return static_1.CommerceLayerStatic.singletons();
+    }
+    isSingleton(resource) {
+        return static_1.CommerceLayerStatic.isSingleton(resource);
+    }
     // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isApiError(error) {
         return static_1.CommerceLayerStatic.isApiError(error);
@@ -210,7 +220,7 @@ class CommerceLayerClient {
         return __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors.response.use(onFulfilled, onRejected);
     }
     removeInterceptor(type, id) {
-        return __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors[type].eject(id);
+        __classPrivateFieldGet(this, _CommerceLayerClient_adapter, "f").interceptors[type].eject(id);
     }
     addRawResponseReader(options) {
         const reader = {
@@ -231,7 +241,7 @@ class CommerceLayerClient {
     removeRawResponseReader(reader) {
         const id = (typeof reader === 'number') ? reader : reader === null || reader === void 0 ? void 0 : reader.id;
         if (id && (id >= 0))
-            return this.removeInterceptor('response', id);
+            this.removeInterceptor('response', id);
     }
 }
 _CommerceLayerClient_adapter = new WeakMap(), _CommerceLayerClient_organization = new WeakMap();

package/lib/cjs/common.d.ts

@@ -2,3 +2,4 @@ import type { ResourceId, ResourceType } from './resource';
 declare const isResourceId: (resource: any) => resource is ResourceId;
 declare const isResourceType: (resource: any) => resource is ResourceType;
 export { isResourceId, isResourceType };
+export type ObjectType = Record<string, any>;

package/lib/cjs/common.js

@@ -1,6 +1,4 @@
 "use strict";
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isResourceType = exports.isResourceId = void 0;
 const api_1 = require("./api");
@@ -12,3 +10,14 @@ const isResourceType = (resource) => {
     return resource && (typeof resource.type !== 'undefined') && resource.type && api_1.resourceList.includes(resource.type);
 };
 exports.isResourceType = isResourceType;
+/*
+// Nullable types
+type StringNullable = string | null
+type NumberNullable = number | null
+type BooleanNullable = boolean | null
+type ResourceNullable<R extends Resource> = R | null
+type ResourceArrayNullable<R extends Resource> = R[] | null
+
+
+export type { StringNullable, NumberNullable, BooleanNullable, ResourceNullable, ResourceArrayNullable }
+*/

package/lib/cjs/config.d.ts

@@ -6,6 +6,7 @@ declare const config: {
     };
     readonly client: {
         readonly timeout: 15000;
+        readonly requiredAttributes: readonly ["organization", "accessToken"];
     };
 };
 export default config;

package/lib/cjs/config.js

@@ -1,13 +1,16 @@
 "use strict";
+// export type ApiMode = 'test' | 'live'
 Object.defineProperty(exports, "__esModule", { value: true });
 const config = {
     default: {
+        // environment: 'test',
         domain: 'commercelayer.io',
         pageNumber: 1,
         pageSize: 10,
     },
     client: {
         timeout: 15000,
+        requiredAttributes: ['organization', 'accessToken'],
     }
 };
 exports.default = config;

package/lib/cjs/debug.js

@@ -1,7 +1,4 @@
 "use strict";
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/no-unused-vars */
-// import Debug from 'debug'
 Object.defineProperty(exports, "__esModule", { value: true });
 /* Nope debugger */
 const debuggerFunction = (_pattern, ..._args) => {
@@ -10,7 +7,6 @@ const debuggerFunction = (_pattern, ..._args) => {
 let debuggerFactory = (_namespace) => debuggerFunction;
 /* Try loading 'debug' module */
 try {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     const debugModule = require('debug');
     if (debugModule && (typeof debugModule === 'function'))
         debuggerFactory = debugModule;

package/lib/cjs/error.d.ts

@@ -1,14 +1,15 @@
 declare enum ErrorType {
-    CLIENT = "client",
-    REQUEST = "request",
-    RESPONSE = "response",
-    GENERIC = "generic",
-    CANCEL = "cancel"
+    CLIENT = "client",// Error instantiating the client
+    REQUEST = "request",// Error preparing API request
+    RESPONSE = "response",// Error response from API
+    CANCEL = "cancel",// Forced request abort using interceptor
+    PARSE = "parse",// Error parsing API resource
+    GENERIC = "generic"
 }
 declare class SdkError extends Error {
     static NAME: string;
-    static isSdkError(error: any): error is ApiError;
-    type: string;
+    static isSdkError(error: any): error is SdkError;
+    type: ErrorType;
     code?: string;
     source?: Error;
     request?: any;
@@ -22,7 +23,9 @@ declare class ApiError extends SdkError {
     static isApiError(error: any): error is ApiError;
     errors: any[];
     status?: number;
+    statusText?: string;
     constructor(error: SdkError);
     first(): any;
 }
-export { SdkError, ApiError, ErrorType };
+declare const handleError: (error: Error) => never;
+export { SdkError, ApiError, ErrorType, handleError };

package/lib/cjs/error.js

@@ -1,18 +1,20 @@
 "use strict";
-/* eslint-disable @typescript-eslint/no-explicit-any */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorType = exports.ApiError = exports.SdkError = void 0;
+exports.handleError = exports.ErrorType = exports.ApiError = exports.SdkError = void 0;
+const axios_1 = __importDefault(require("axios"));
 var ErrorType;
 (function (ErrorType) {
     ErrorType["CLIENT"] = "client";
     ErrorType["REQUEST"] = "request";
     ErrorType["RESPONSE"] = "response";
-    ErrorType["GENERIC"] = "generic";
     ErrorType["CANCEL"] = "cancel";
-})(ErrorType || (ErrorType = {}));
-exports.ErrorType = ErrorType;
+    ErrorType["PARSE"] = "parse";
+    ErrorType["GENERIC"] = "generic";
+})(ErrorType || (exports.ErrorType = ErrorType = {}));
 class SdkError extends Error {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     static isSdkError(error) {
         return error && [SdkError.NAME, ApiError.NAME].includes(error.name) && Object.values(ErrorType).includes(error.type);
     }
@@ -25,12 +27,11 @@ class SdkError extends Error {
 exports.SdkError = SdkError;
 SdkError.NAME = 'SdkError';
 class ApiError extends SdkError {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     static isApiError(error) {
         return SdkError.isSdkError(error) && (error.name === ApiError.NAME) && (error.type === ErrorType.RESPONSE);
     }
     constructor(error) {
-        super(Object.assign(Object.assign({}, error), { type: ErrorType.RESPONSE }));
+        super({ ...error, type: ErrorType.RESPONSE });
         this.errors = [];
         this.name = ApiError.NAME; // this.constructor.name
     }
@@ -41,3 +42,36 @@ class ApiError extends SdkError {
 }
 exports.ApiError = ApiError;
 ApiError.NAME = 'ApiError';
+const handleError = (error) => {
+    let sdkError = new SdkError({ message: error.message });
+    if (axios_1.default.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.statusText = error.response.statusText;
+            apiError.code = String(apiError.status);
+            apiError.errors = error.response.data.errors;
+            if (!apiError.message && apiError.statusText)
+                apiError.message = apiError.statusText;
+            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_1.default.isCancel(error))
+        sdkError.type = ErrorType.CANCEL;
+    else
+        sdkError.source = error;
+    throw sdkError;
+};
+exports.handleError = handleError;

package/lib/cjs/index.d.ts

@@ -2,6 +2,6 @@ export { default, CommerceLayer } from './commercelayer';
 export type { CommerceLayerClient } from './commercelayer';
 export { CommerceLayerStatic } from './static';
 export type { QueryParamsRetrieve, QueryParamsList, QueryParams } from './query';
-export * from './model';
+export type * from './model';
 export type { RequestObj, ResponseObj, ErrorObj, HeadersObj } from './interceptor';
 export type { SdkError, ApiError, ErrorType } from './error';