@commercelayer/sdk 4.41.0 → 4.42.0

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

@@ -1,51 +1,55 @@
-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;
-    disabled_at?: 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;
+    disabled_at?: string | null;
+    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[];
-    _disable?: boolean;
-    _enable?: boolean;
+    include_resources?: string[] | null;
+    _disable?: boolean | null;
+    _enable?: boolean | null;
 }
 interface WebhookUpdate extends ResourceUpdate {
-    name?: string;
-    topic?: string;
-    callback_url?: string;
-    include_resources?: string[];
-    _reset_circuit?: boolean;
-    _disable?: boolean;
-    _enable?: boolean;
+    name?: string | null;
+    topic?: string | null;
+    callback_url?: string | null;
+    include_resources?: string[] | null;
+    _reset_circuit?: boolean | null;
+    _disable?: boolean | null;
+    _enable?: 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>;
+    _disable(id: string | Webhook, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
+    _enable(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/esm/resources/webhooks.js

@@ -1,20 +1,13 @@
 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(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;
@@ -24,7 +17,15 @@ class Webhooks extends 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);
+    }
+    async _disable(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Webhooks.TYPE, _disable: true }, params, options);
+    }
+    async _enable(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Webhooks.TYPE, _enable: true }, params, options);
+    }
     isWebhook(resource) {
         return resource.type && (resource.type === Webhooks.TYPE);
     }

package/lib/esm/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/esm/resources/wire_transfers.js

@@ -1,20 +1,13 @@
 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(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;
@@ -24,7 +17,6 @@ class WireTransfers extends 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/esm/static.d.ts

@@ -1,7 +1,10 @@
+import * as api from './api';
 import { SdkError, ApiError } from './error';
-import { CommerceLayerClient, CommerceLayerInitConfig } from './commercelayer';
+import type { CommerceLayerClient, CommerceLayerInitConfig } from './commercelayer';
 export declare const CommerceLayerStatic: {
-    resources: () => readonly string[];
+    resources: (sort?: boolean) => readonly string[];
+    singletons: (sort?: boolean) => readonly string[];
+    isSingleton: (resource: api.ResourceTypeLock) => boolean;
     isSdkError: (error: unknown) => error is SdkError;
     isApiError: (error: unknown) => error is ApiError;
     init: (config: CommerceLayerInitConfig) => CommerceLayerClient;

package/lib/esm/static.js

@@ -3,8 +3,14 @@ import { SdkError, ApiError } from './error';
 import CommerceLayer, { OPEN_API_SCHEMA_VERSION } from './commercelayer';
 /* Static functions */
 export const CommerceLayerStatic = {
-    resources: () => {
-        return api.resourceList;
+    resources: (sort) => {
+        return sort ? [...api.resourceList].sort() : api.resourceList;
+    },
+    singletons: (sort) => {
+        return sort ? [...api.singletonList].sort() : api.singletonList;
+    },
+    isSingleton: (resource) => {
+        return api.singletonList.includes(resource);
     },
     isSdkError: (error) => {
         return SdkError.isSdkError(error);

package/lib/esm/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 };
+export { sleep, sortObjectFields, };

package/lib/esm/util.js

@@ -1,3 +1,4 @@
+// import path from 'node:path'
 const sleep = async (ms) => {
     return new Promise(resolve => setTimeout(resolve, ms));
 };
@@ -8,4 +9,29 @@ const sortObjectFields = (obj) => {
     }, {});
     return sorted;
 };
-export { sleep, sortObjectFields };
+/*
+const nestedField = (obj: any, field: string): { key: string, val: any } => {
+
+    let fp = field
+    if (fp.endsWith('.')) fp = fp.substring(0, fp.length-1)
+
+    const dots = field.split(".")
+
+    const key = dots[dots.length-1]
+    let val = obj
+    while (dots.length && (val = val[dots.shift() || '']));
+    
+    return { key, val }
+}
+*/
+/*
+const packageInfo = (fields?: string | string[], options?: any): Record<string, any>  => {
+    const pjson = require(path.resolve('./', 'package.json'))
+    return fields? (Array.isArray(fields)? fields : [ fields ]).reduce((info: any, field) => {
+        const nf = nestedField(pjson, field)
+        info[options?.nestedName? nf.key : field] = nf.val
+        return info
+      }, {}) : pjson
+}
+*/
+export { sleep, sortObjectFields, /* packageInfo */ };