@commercelayer/sdk 4.28.0 → 4.28.1

package/lib/esm/resources/taxjar_accounts.js

@@ -1,13 +1,20 @@
 import { ApiResource } from '../resource';
 class TaxjarAccounts extends ApiResource {
+    // static readonly PATH = 'taxjar_accounts'
+    async list(params, options) {
+        return this.resources.list({ type: TaxjarAccounts.TYPE }, params, options);
+    }
     async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: TaxjarAccounts.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: TaxjarAccounts.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: TaxjarAccounts.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: TaxjarAccounts.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: TaxjarAccounts.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: TaxjarAccounts.TYPE } : id, options);
+        await this.resources.delete({ type: TaxjarAccounts.TYPE, id }, options);
     }
     async markets(taxjarAccountId, params, options) {
         const _taxjarAccountId = taxjarAccountId.id || taxjarAccountId;
@@ -17,10 +24,15 @@ class TaxjarAccounts extends ApiResource {
         const _taxjarAccountId = taxjarAccountId.id || taxjarAccountId;
         return this.resources.fetch({ type: 'attachments' }, `taxjar_accounts/${_taxjarAccountId}/attachments`, params, options);
     }
+    async versions(taxjarAccountId, params, options) {
+        const _taxjarAccountId = taxjarAccountId.id || taxjarAccountId;
+        return this.resources.fetch({ type: 'versions' }, `taxjar_accounts/${_taxjarAccountId}/versions`, params, options);
+    }
     async tax_categories(taxjarAccountId, params, options) {
         const _taxjarAccountId = taxjarAccountId.id || taxjarAccountId;
         return this.resources.fetch({ type: 'tax_categories' }, `taxjar_accounts/${_taxjarAccountId}/tax_categories`, params, options);
     }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isTaxjarAccount(resource) {
         return resource.type && (resource.type === TaxjarAccounts.TYPE);
     }

package/lib/esm/resources/transactions.d.ts

@@ -1,32 +1,40 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
-import type { QueryParamsRetrieve } from '../query';
+import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
 import type { Order } from './orders';
-type TransactionType = 'transactions';
+import type { Attachment } from './attachments';
+import type { Event } from './events';
+import type { Version } from './versions';
 type TransactionRel = ResourceRel & {
-    type: TransactionType;
+    type: typeof Transactions.TYPE;
 };
 interface Transaction extends Resource {
-    readonly type: TransactionType;
-    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;
+    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[];
+    events?: Event[];
+    versions?: Version[];
 }
-declare class Transactions extends ApiResource<Transaction> {
-    static readonly TYPE: TransactionType;
+declare class Transactions extends ApiResource {
+    static readonly TYPE: 'transactions';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Transaction>>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Transaction>;
     order(transactionId: string | Transaction, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    attachments(transactionId: string | Transaction, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(transactionId: string | Transaction, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    versions(transactionId: string | Transaction, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isTransaction(resource: any): resource is Transaction;
     relationship(id: string | ResourceId | null): TransactionRel;
-    type(): TransactionType;
+    type(): string;
 }
 export default Transactions;
-export type { Transaction, TransactionType };
+export { Transaction };

package/lib/esm/resources/transactions.js

@@ -1,9 +1,29 @@
 import { ApiResource } from '../resource';
 class Transactions extends ApiResource {
+    // static readonly PATH = 'transactions'
+    async list(params, options) {
+        return this.resources.list({ type: Transactions.TYPE }, params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Transactions.TYPE, id }, params, options);
+    }
     async order(transactionId, params, options) {
         const _transactionId = transactionId.id || transactionId;
         return this.resources.fetch({ type: 'orders' }, `transactions/${_transactionId}/order`, params, options);
     }
+    async attachments(transactionId, params, options) {
+        const _transactionId = transactionId.id || transactionId;
+        return this.resources.fetch({ type: 'attachments' }, `transactions/${_transactionId}/attachments`, params, options);
+    }
+    async events(transactionId, params, options) {
+        const _transactionId = transactionId.id || transactionId;
+        return this.resources.fetch({ type: 'events' }, `transactions/${_transactionId}/events`, params, options);
+    }
+    async versions(transactionId, params, options) {
+        const _transactionId = transactionId.id || transactionId;
+        return this.resources.fetch({ type: 'versions' }, `transactions/${_transactionId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isTransaction(resource) {
         return resource.type && (resource.type === Transactions.TYPE);
     }

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

@@ -0,0 +1,22 @@
+import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+type VersionRel = ResourceRel & {
+    type: typeof Versions.TYPE;
+};
+interface Version extends Resource {
+    resource_type?: string;
+    resource_id?: string;
+    event?: string;
+    changes?: object;
+    who?: object;
+}
+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>;
+    isVersion(resource: any): resource is Version;
+    relationship(id: string | ResourceId | null): VersionRel;
+    type(): string;
+}
+export default Versions;
+export { Version };

package/lib/esm/resources/versions.js

@@ -0,0 +1,22 @@
+import { ApiResource } from '../resource';
+class Versions extends 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);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Versions.TYPE } : { id: id.id, type: Versions.TYPE };
+    }
+    type() {
+        return Versions.TYPE;
+    }
+}
+Versions.TYPE = 'versions';
+export default Versions;

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

@@ -1,38 +1,43 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
 import type { Order } from './orders';
-import type { Authorization } from './authorizations';
+import type { Attachment } from './attachments';
 import type { Event } from './events';
-type VoidType = 'voids';
+import type { Version } from './versions';
+import type { Authorization } from './authorizations';
 type VoidRel = ResourceRel & {
-    type: VoidType;
+    type: typeof Voids.TYPE;
 };
 interface Void extends Resource {
-    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;
-    reference_authorization?: Authorization | null;
-    events?: Event[] | null;
+    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[];
+    events?: Event[];
+    versions?: Version[];
+    reference_authorization?: Authorization;
 }
-declare class Voids extends ApiResource<Void> {
-    static readonly TYPE: VoidType;
+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>;
     order(voidId: string | Void, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
-    reference_authorization(voidId: string | Void, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Authorization>;
+    attachments(voidId: string | Void, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     events(voidId: string | Void, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    versions(voidId: string | Void, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    reference_authorization(voidId: string | Void, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Authorization>;
     isVoid(resource: any): resource is Void;
     relationship(id: string | ResourceId | null): VoidRel;
-    type(): VoidType;
+    type(): string;
 }
 export default Voids;
-export type { Void, VoidType };
+export { Void };

package/lib/esm/resources/voids.js

@@ -1,17 +1,33 @@
 import { ApiResource } from '../resource';
 class Voids extends 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);
     }
-    async reference_authorization(voidId, params, options) {
+    async attachments(voidId, params, options) {
         const _voidId = voidId.id || voidId;
-        return this.resources.fetch({ type: 'authorizations' }, `voids/${_voidId}/reference_authorization`, params, options);
+        return this.resources.fetch({ type: 'attachments' }, `voids/${_voidId}/attachments`, params, options);
     }
     async events(voidId, params, options) {
         const _voidId = voidId.id || voidId;
         return this.resources.fetch({ type: 'events' }, `voids/${_voidId}/events`, params, options);
     }
+    async versions(voidId, params, options) {
+        const _voidId = voidId.id || voidId;
+        return this.resources.fetch({ type: 'versions' }, `voids/${_voidId}/versions`, params, options);
+    }
+    async reference_authorization(voidId, params, options) {
+        const _voidId = voidId.id || voidId;
+        return this.resources.fetch({ type: 'authorizations' }, `voids/${_voidId}/reference_authorization`, 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/esm/resources/webhooks.d.ts

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

package/lib/esm/resources/webhooks.js

@@ -1,18 +1,30 @@
 import { ApiResource } from '../resource';
 class Webhooks extends 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({ ...resource, type: Webhooks.TYPE }, 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);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: Webhooks.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Webhooks.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: Webhooks.TYPE } : id, options);
+        await this.resources.delete({ type: Webhooks.TYPE, id }, options);
     }
     async last_event_callbacks(webhookId, params, options) {
         const _webhookId = webhookId.id || webhookId;
         return this.resources.fetch({ type: 'event_callbacks' }, `webhooks/${_webhookId}/last_event_callbacks`, params, options);
     }
+    async versions(webhookId, params, options) {
+        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
     isWebhook(resource) {
         return resource.type && (resource.type === Webhooks.TYPE);
     }

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

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

package/lib/esm/resources/wire_transfers.js

@@ -1,18 +1,30 @@
 import { ApiResource } from '../resource';
 class WireTransfers extends 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({ ...resource, type: WireTransfers.TYPE }, 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);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: WireTransfers.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: WireTransfers.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: WireTransfers.TYPE } : id, options);
+        await this.resources.delete({ type: WireTransfers.TYPE, id }, options);
     }
     async order(wireTransferId, params, options) {
         const _wireTransferId = wireTransferId.id || wireTransferId;
         return this.resources.fetch({ type: 'orders' }, `wire_transfers/${_wireTransferId}/order`, params, options);
     }
+    async versions(wireTransferId, params, options) {
+        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/esm/static.d.ts

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

package/lib/esm/util.d.ts

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