@commercelayer/sdk 4.35.0 → 4.37.0

package/lib/cjs/resources/versions.d.ts

@@ -1,22 +1,22 @@
-import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourceRel } from '../resource';
+type VersionType = 'versions';
 type VersionRel = ResourceRel & {
-    type: typeof Versions.TYPE;
+    type: VersionType;
 };
 interface Version extends Resource {
-    resource_type?: string;
-    resource_id?: string;
-    event?: string;
-    changes?: object;
-    who?: object;
+    readonly type: VersionType;
+    resource_type?: string | null;
+    resource_id?: string | null;
+    event?: string | null;
+    changes?: Record<string, any> | null;
+    who?: Record<string, any> | null;
 }
-declare class Versions extends ApiResource {
-    static readonly TYPE: 'versions';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Version>;
+declare class Versions extends ApiResource<Version> {
+    static readonly TYPE: VersionType;
     isVersion(resource: any): resource is Version;
     relationship(id: string | ResourceId | null): VersionRel;
-    type(): string;
+    type(): VersionType;
 }
 export default Versions;
-export { Version };
+export type { Version, VersionType };

package/lib/cjs/resources/versions.js

@@ -2,14 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Versions extends resource_1.ApiResource {
-    // static readonly PATH = 'versions'
-    async list(params, options) {
-        return this.resources.list({ type: Versions.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Versions.TYPE, id }, params, options);
-    }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isVersion(resource) {
         return resource.type && (resource.type === Versions.TYPE);
     }

package/lib/cjs/resources/voids.d.ts

@@ -1,35 +1,36 @@
-import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Order } from './orders';
 import type { Attachment } from './attachments';
 import type { Version } from './versions';
 import type { Authorization } from './authorizations';
 import type { Event } from './events';
+type VoidType = 'voids';
 type VoidRel = ResourceRel & {
-    type: typeof Voids.TYPE;
+    type: VoidType;
 };
 interface Void extends Resource {
-    number?: string;
-    currency_code?: string;
-    amount_cents?: number;
-    amount_float?: number;
-    formatted_amount?: string;
-    succeeded?: boolean;
-    message?: string;
-    error_code?: string;
-    error_detail?: string;
-    token?: string;
-    gateway_transaction_id?: string;
-    order?: Order;
-    attachments?: Attachment[];
-    versions?: Version[];
-    reference_authorization?: Authorization;
-    events?: Event[];
+    readonly type: VoidType;
+    number: string;
+    currency_code: string;
+    amount_cents: number;
+    amount_float: number;
+    formatted_amount: string;
+    succeeded: boolean;
+    message?: string | null;
+    error_code?: string | null;
+    error_detail?: string | null;
+    token?: string | null;
+    gateway_transaction_id?: string | null;
+    order?: Order | null;
+    attachments?: Attachment[] | null;
+    versions?: Version[] | null;
+    reference_authorization?: Authorization | null;
+    events?: Event[] | null;
 }
-declare class Voids extends ApiResource {
-    static readonly TYPE: 'voids';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Void>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Void>;
+declare class Voids extends ApiResource<Void> {
+    static readonly TYPE: VoidType;
     order(voidId: string | Void, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     attachments(voidId: string | Void, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     versions(voidId: string | Void, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
@@ -37,7 +38,7 @@ declare class Voids extends ApiResource {
     events(voidId: string | Void, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     isVoid(resource: any): resource is Void;
     relationship(id: string | ResourceId | null): VoidRel;
-    type(): string;
+    type(): VoidType;
 }
 export default Voids;
-export { Void };
+export type { Void, VoidType };

package/lib/cjs/resources/voids.js

@@ -2,13 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Voids extends resource_1.ApiResource {
-    // static readonly PATH = 'voids'
-    async list(params, options) {
-        return this.resources.list({ type: Voids.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Voids.TYPE, id }, params, options);
-    }
     async order(voidId, params, options) {
         const _voidId = voidId.id || voidId;
         return this.resources.fetch({ type: 'orders' }, `voids/${_voidId}/order`, params, options);
@@ -29,7 +22,6 @@ class Voids extends resource_1.ApiResource {
         const _voidId = voidId.id || voidId;
         return this.resources.fetch({ type: 'events' }, `voids/${_voidId}/events`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isVoid(resource) {
         return resource.type && (resource.type === Voids.TYPE);
     }

package/lib/cjs/resources/webhooks.d.ts

@@ -1,46 +1,48 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { EventCallback } from './event_callbacks';
 import type { Version } from './versions';
+type WebhookType = 'webhooks';
 type WebhookRel = ResourceRel & {
-    type: typeof Webhooks.TYPE;
+    type: WebhookType;
 };
 interface Webhook extends Resource {
-    name?: string;
-    topic?: string;
-    callback_url?: string;
-    include_resources?: string[];
-    circuit_state?: string;
-    circuit_failure_count?: number;
-    shared_secret?: string;
-    last_event_callbacks?: EventCallback[];
-    versions?: Version[];
+    readonly type: WebhookType;
+    name?: string | null;
+    topic: string;
+    callback_url: string;
+    include_resources?: string[] | null;
+    circuit_state?: string | null;
+    circuit_failure_count?: number | null;
+    shared_secret: string;
+    last_event_callbacks?: EventCallback[] | null;
+    versions?: Version[] | null;
 }
 interface WebhookCreate extends ResourceCreate {
-    name?: string;
+    name?: string | null;
     topic: string;
     callback_url: string;
-    include_resources?: string[];
+    include_resources?: string[] | null;
 }
 interface WebhookUpdate extends ResourceUpdate {
-    name?: string;
-    topic?: string;
-    callback_url?: string;
-    include_resources?: string[];
-    _reset_circuit?: boolean;
+    name?: string | null;
+    topic?: string | null;
+    callback_url?: string | null;
+    include_resources?: string[] | null;
+    _reset_circuit?: boolean | null;
 }
-declare class Webhooks extends ApiResource {
-    static readonly TYPE: 'webhooks';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Webhook>>;
+declare class Webhooks extends ApiResource<Webhook> {
+    static readonly TYPE: WebhookType;
     create(resource: WebhookCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
     update(resource: WebhookUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     last_event_callbacks(webhookId: string | Webhook, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<EventCallback>>;
     versions(webhookId: string | Webhook, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _reset_circuit(id: string | Webhook, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
     isWebhook(resource: any): resource is Webhook;
     relationship(id: string | ResourceId | null): WebhookRel;
-    type(): string;
+    type(): WebhookType;
 }
 export default Webhooks;
-export { Webhook, WebhookCreate, WebhookUpdate };
+export type { Webhook, WebhookCreate, WebhookUpdate, WebhookType };

package/lib/cjs/resources/webhooks.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Webhooks extends resource_1.ApiResource {
-    // static readonly PATH = 'webhooks'
-    async list(params, options) {
-        return this.resources.list({ type: Webhooks.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Webhooks.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Webhooks.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: Webhooks.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Webhooks.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Webhooks.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: Webhooks.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: Webhooks.TYPE } : id, options);
     }
     async last_event_callbacks(webhookId, params, options) {
         const _webhookId = webhookId.id || webhookId;
@@ -26,7 +19,9 @@ class Webhooks extends resource_1.ApiResource {
         const _webhookId = webhookId.id || webhookId;
         return this.resources.fetch({ type: 'versions' }, `webhooks/${_webhookId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    async _reset_circuit(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Webhooks.TYPE, _reset_circuit: true }, params, options);
+    }
     isWebhook(resource) {
         return resource.type && (resource.type === Webhooks.TYPE);
     }

package/lib/cjs/resources/wire_transfers.d.ts

@@ -1,36 +1,37 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Order } from './orders';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order, OrderType } from './orders';
 import type { Version } from './versions';
+type WireTransferType = 'wire_transfers';
 type WireTransferRel = ResourceRel & {
-    type: typeof WireTransfers.TYPE;
+    type: WireTransferType;
 };
 type OrderRel = ResourceRel & {
-    type: 'orders';
+    type: OrderType;
 };
 interface WireTransfer extends Resource {
-    payment_instrument?: object;
-    order?: Order;
-    versions?: Version[];
+    readonly type: WireTransferType;
+    payment_instrument?: Record<string, any> | null;
+    order?: Order | null;
+    versions?: Version[] | null;
 }
 interface WireTransferCreate extends ResourceCreate {
     order: OrderRel;
 }
 interface WireTransferUpdate extends ResourceUpdate {
-    order?: OrderRel;
+    order?: OrderRel | null;
 }
-declare class WireTransfers extends ApiResource {
-    static readonly TYPE: 'wire_transfers';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<WireTransfer>>;
+declare class WireTransfers extends ApiResource<WireTransfer> {
+    static readonly TYPE: WireTransferType;
     create(resource: WireTransferCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<WireTransfer>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<WireTransfer>;
     update(resource: WireTransferUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<WireTransfer>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     order(wireTransferId: string | WireTransfer, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     versions(wireTransferId: string | WireTransfer, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isWireTransfer(resource: any): resource is WireTransfer;
     relationship(id: string | ResourceId | null): WireTransferRel;
-    type(): string;
+    type(): WireTransferType;
 }
 export default WireTransfers;
-export { WireTransfer, WireTransferCreate, WireTransferUpdate };
+export type { WireTransfer, WireTransferCreate, WireTransferUpdate, WireTransferType };

package/lib/cjs/resources/wire_transfers.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class WireTransfers extends resource_1.ApiResource {
-    // static readonly PATH = 'wire_transfers'
-    async list(params, options) {
-        return this.resources.list({ type: WireTransfers.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: WireTransfers.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: WireTransfers.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: WireTransfers.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: WireTransfers.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: WireTransfers.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: WireTransfers.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: WireTransfers.TYPE } : id, options);
     }
     async order(wireTransferId, params, options) {
         const _wireTransferId = wireTransferId.id || wireTransferId;
@@ -26,7 +19,6 @@ class WireTransfers extends resource_1.ApiResource {
         const _wireTransferId = wireTransferId.id || wireTransferId;
         return this.resources.fetch({ type: 'versions' }, `wire_transfers/${_wireTransferId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isWireTransfer(resource) {
         return resource.type && (resource.type === WireTransfers.TYPE);
     }

package/lib/cjs/static.d.ts

@@ -1,5 +1,5 @@
 import { SdkError, ApiError } from './error';
-import { CommerceLayerClient, CommerceLayerInitConfig } from './commercelayer';
+import type { CommerceLayerClient, CommerceLayerInitConfig } from './commercelayer';
 export declare const CommerceLayerStatic: {
     resources: () => readonly string[];
     isSdkError: (error: unknown) => error is SdkError;

package/lib/cjs/util.d.ts

@@ -3,9 +3,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-type ObjectType = {
-    [key: string]: any;
-};
+import type { ObjectType } from "../src/common";
 declare const sleep: (ms: number) => Promise<NodeJS.Timeout>;
 declare const sortObjectFields: (obj: ObjectType) => ObjectType;
 export { sleep, sortObjectFields };

package/lib/esm/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';
 /**
  * ©2023 Commerce Layer Inc.
  **/
@@ -120,3 +123,37 @@ 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' | '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_factories' | 'order_subscription_items' | 'order_subscriptions' | 'order_validation_rules' | 'orders' | 'organization' | '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' | '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", "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_factories", "order_subscription_items", "order_subscriptions", "order_validation_rules", "orders", "organization", "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", "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 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' | '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' | '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' | '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' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | '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' | 'captures' | 'checkout_com_gateways' | 'checkout_com_payments' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | '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' | '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_locations' | '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' | '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' | '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' | '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' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | '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' | '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' | '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' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | '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/esm/api.js

@@ -242,16 +242,3 @@ export const 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
-*/ 

package/lib/esm/client.d.ts

@@ -1,24 +1,29 @@
 /// <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;
-    };
+    params?: RequestParams;
     httpAgent?: HttpAgent;
     httpsAgent?: HttpsAgent;
     proxy?: ProxyConfig;
+    headers?: RequestHeaders;
 };
-type ApiClientInitConfig = {
+type ApiConfig = {
     organization: string;
     domain?: string;
     accessToken: string;
-} & RequestConfig;
+};
+type ApiClientInitConfig = ApiConfig & RequestConfig & {
+    adapter?: Adapter;
+};
 type ApiClientConfig = Partial<ApiClientInitConfig>;
 declare class ApiClient {
     #private;
@@ -26,8 +31,10 @@ declare class ApiClient {
     baseUrl: string;
     interceptors: InterceptorManager;
     private constructor();
-    config(config: ApiClientConfig): void;
+    config(config: ApiClientConfig): 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/esm/client.js

@@ -10,50 +10,19 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ApiClient_accessToken, _ApiClient_client;
-/* eslint-disable @typescript-eslint/no-explicit-any */
 import axios from 'axios';
-import { SdkError, ApiError, ErrorType } from './error';
+import { SdkError, handleError } 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) {
-        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.client.requiredAttributes)
+            if (!options || !options[attr])
+                throw new SdkError({ message: `Undefined '${attr}' parameter` });
         return new ApiClient(options);
     }
     constructor(options) {
@@ -68,11 +37,21 @@ class ApiClient {
             httpAgent: options.httpAgent,
             httpsAgent: options.httpsAgent,
         };
-        const axiosOptions = Object.assign({ baseURL: this.baseUrl, timeout: config.client.timeout, headers: {
+        // Set custom headers
+        const customHeaders = this.customHeaders(options.headers);
+        const axiosOptions = {
+            baseURL: this.baseUrl,
+            timeout: config.client.timeout,
+            headers: {
+                ...customHeaders,
                 'Accept': 'application/vnd.api+json',
                 'Content-Type': 'application/vnd.api+json',
-                'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f"),
-            } }, axiosConfig);
+                'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f")
+            },
+            ...axiosConfig
+        };
+        if (options.adapter)
+            axiosOptions.adapter = options.adapter;
         debug('axios options: %O', axiosOptions);
         __classPrivateFieldSet(this, _ApiClient_client, axios.create(axiosOptions), "f");
         this.interceptors = __classPrivateFieldGet(this, _ApiClient_client, "f").interceptors;
@@ -96,6 +75,16 @@ 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);
+        if (config.adapter)
+            this.adapter(config.adapter);
+        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 || {});
@@ -104,8 +93,10 @@ class ApiClient {
         // 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)
@@ -113,6 +104,15 @@ class ApiClient {
             .catch(error => 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'].includes(name.toLowerCase()))
+                    customHeaders[name] = value;
+        }
+        return customHeaders;
+    }
 }
 _ApiClient_accessToken = new WeakMap(), _ApiClient_client = new WeakMap();
 export default ApiClient;