@commercelayer/sdk 4.35.0 → 4.37.0

package/lib/cjs/resource.d.ts

@@ -1,8 +1,7 @@
 import { type ApiClientInitConfig } from './client';
-import { type QueryParamsRetrieve, type QueryParamsList } from './query';
+import type { QueryParamsRetrieve, QueryParamsList, QueryFilter, QueryParams } from './query';
 import type { ResourceTypeLock } from './api';
 import type { InterceptorManager } from './interceptor';
-import type { QueryParams } from '.';
 type ResourceNull = {
     id: null;
 } & ResourceType;
@@ -14,23 +13,19 @@ interface ResourceType {
 interface ResourceId extends ResourceType {
     readonly id: string;
 }
-interface Resource extends ResourceId {
-    reference?: string;
-    reference_origin?: string;
+interface ResourceBase {
+    reference?: string | null;
+    reference_origin?: string | null;
     metadata?: Metadata;
+}
+interface Resource extends ResourceBase, ResourceId {
     readonly created_at: string;
     readonly updated_at: string;
 }
-interface ResourceCreate {
-    reference?: string;
-    reference_origin?: string;
-    metadata?: Metadata;
+interface ResourceCreate extends ResourceBase {
 }
-interface ResourceUpdate {
+interface ResourceUpdate extends ResourceBase {
     readonly id: string;
-    reference?: string;
-    reference_origin?: string;
-    metadata?: Metadata;
 }
 type ListMeta = {
     readonly pageCount: number;
@@ -44,8 +39,14 @@ declare class ListResponse<R> extends Array<R> {
     first(): R | undefined;
     last(): R | undefined;
     get(index: number): R | undefined;
+    hasNextPage(): boolean;
+    hasPrevPage(): boolean;
+    getRecordCount(): number;
+    getPageCount(): number;
+    get recordCount(): number;
+    get pageCount(): number;
 }
-export type { Metadata, ResourceType, ResourceId, Resource, ResourceCreate, ResourceUpdate, ListResponse, ResourceRel };
+export type { Metadata, ResourceType, ResourceId, Resource, ResourceCreate, ResourceUpdate, ListResponse, ListMeta, ResourceRel };
 type ResourceAdapterConfig = {};
 type ResourcesInitConfig = ResourceAdapterConfig & ApiClientInitConfig;
 type ResourcesConfig = Partial<ResourcesInitConfig>;
@@ -54,7 +55,7 @@ declare class ResourceAdapter {
     constructor(config: ResourcesInitConfig);
     get interceptors(): InterceptorManager;
     private localConfig;
-    config(config: ResourcesConfig): void;
+    config(config: ResourcesConfig): ResourceAdapter;
     singleton<R extends Resource>(resource: ResourceType, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
     retrieve<R extends Resource>(resource: ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
     list<R extends Resource>(resource: ResourceType, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
@@ -63,13 +64,22 @@ declare class ResourceAdapter {
     delete(resource: ResourceId, options?: ResourcesConfig): Promise<void>;
     fetch<R extends Resource>(resource: string | ResourceType, path: string, params?: QueryParams, options?: ResourcesConfig): Promise<R | ListResponse<R>>;
 }
-declare abstract class ApiResource {
+declare abstract class ApiResourceBase<R extends Resource> {
     static readonly TYPE: ResourceTypeLock;
-    protected resources: ResourceAdapter;
+    protected readonly resources: ResourceAdapter;
     constructor(adapter: ResourceAdapter);
     abstract relationship(id: string | ResourceId | null): ResourceRel;
-    abstract type(): string;
-    update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Resource>;
+    abstract type(): ResourceTypeLock;
+    update(resource: ResourceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
+}
+declare abstract class ApiResource<R extends Resource> extends ApiResourceBase<R> {
+    retrieve(id: string | ResourceId, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<R>>;
+    count(filter?: QueryFilter | QueryParamsList, options?: ResourcesConfig): Promise<number>;
+}
+declare abstract class ApiSingleton<R extends Resource> extends ApiResourceBase<R> {
+    retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<R>;
 }
 export default ResourceAdapter;
-export { ApiResource, type ResourcesConfig, type ResourcesInitConfig };
+export { ApiResource, ApiSingleton };
+export type { ResourcesConfig, ResourcesInitConfig };

package/lib/cjs/resource.js

@@ -15,7 +15,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _ResourceAdapter_client, _ResourceAdapter_config;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiResource = void 0;
+exports.ApiSingleton = exports.ApiResource = void 0;
 const client_1 = __importDefault(require("./client"));
 const jsonapi_1 = require("./jsonapi");
 const query_1 = require("./query");
@@ -30,6 +30,12 @@ class ListResponse extends Array {
     first() { return this.length ? this[0] : undefined; }
     last() { return this.length ? this[this.length - 1] : undefined; }
     get(index) { return (this.length && (index >= 0)) ? this[index] : undefined; }
+    hasNextPage() { return (this.meta.currentPage < this.meta.pageCount); }
+    hasPrevPage() { return (this.meta.currentPage > 1); }
+    getRecordCount() { return this.meta.recordCount; }
+    getPageCount() { return this.meta.pageCount; }
+    get recordCount() { return this.meta.recordCount; }
+    get pageCount() { return this.meta.pageCount; }
 }
 class ResourceAdapter {
     constructor(config) {
@@ -49,13 +55,19 @@ class ResourceAdapter {
         this.localConfig(config);
         // Client config
         __classPrivateFieldGet(this, _ResourceAdapter_client, "f").config(config);
+        return this;
     }
+    /*
+    get clientInstance(): ApiClient {
+        return this.#client
+    }
+    */
     async singleton(resource, params, options) {
         debug('singleton: %o, %O, %O', resource, params || {}, options || {});
         const queryParams = (0, query_1.generateQueryStringParams)(params, resource);
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, { ...options, params: queryParams });
         const r = (0, jsonapi_1.denormalize)(res);
         return r;
     }
@@ -64,7 +76,7 @@ class ResourceAdapter {
         const queryParams = (0, query_1.generateQueryStringParams)(params, resource);
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}/${resource.id}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}/${resource.id}`, undefined, { ...options, params: queryParams });
         const r = (0, jsonapi_1.denormalize)(res);
         return r;
     }
@@ -74,7 +86,7 @@ class ResourceAdapter {
         const queryParams = (0, query_1.generateQueryStringParams)(params, resource);
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', `${resource.type}`, undefined, { ...options, params: queryParams });
         const r = (0, jsonapi_1.denormalize)(res);
         const meta = {
             pageCount: Number((_a = res.meta) === null || _a === void 0 ? void 0 : _a.page_count),
@@ -90,7 +102,7 @@ class ResourceAdapter {
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
         const data = (0, jsonapi_1.normalize)(resource);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('post', resource.type, data, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('post', resource.type, data, { ...options, params: queryParams });
         const r = (0, jsonapi_1.denormalize)(res);
         return r;
     }
@@ -100,7 +112,7 @@ class ResourceAdapter {
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
         const data = (0, jsonapi_1.normalize)(resource);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('patch', `${resource.type}/${resource.id}`, data, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('patch', `${resource.type}/${resource.id}`, data, { ...options, params: queryParams });
         const r = (0, jsonapi_1.denormalize)(res);
         return r;
     }
@@ -114,7 +126,7 @@ class ResourceAdapter {
         const queryParams = (0, query_1.generateQueryStringParams)(params, resource);
         if (options === null || options === void 0 ? void 0 : options.params)
             Object.assign(queryParams, options === null || options === void 0 ? void 0 : options.params);
-        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', path, undefined, Object.assign(Object.assign({}, options), { params: queryParams }));
+        const res = await __classPrivateFieldGet(this, _ResourceAdapter_client, "f").request('get', path, undefined, { ...options, params: queryParams });
         const r = (0, jsonapi_1.denormalize)(res);
         if (Array.isArray(r)) {
             const p = params;
@@ -131,15 +143,34 @@ class ResourceAdapter {
     }
 }
 _ResourceAdapter_client = new WeakMap(), _ResourceAdapter_config = new WeakMap();
-class ApiResource {
+class ApiResourceBase {
     constructor(adapter) {
         debug('new resource instance: %s', this.type());
         this.resources = adapter;
     }
     // reference, reference_origin and metadata attributes are always updatable
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: this.type() }), params, options);
+        return this.resources.update({ ...resource, type: this.type() }, params, options);
+    }
+}
+class ApiResource extends ApiResourceBase {
+    async retrieve(id, params, options) {
+        return this.resources.retrieve((typeof id === 'string') ? { type: this.type(), id } : id, params, options);
+    }
+    async list(params, options) {
+        return this.resources.list({ type: this.type() }, params, options);
+    }
+    async count(filter, options) {
+        const params = { filters: (0, query_1.isParamsList)(filter) ? filter.filters : filter, pageNumber: 1, pageSize: 1 };
+        const response = await this.list(params, options);
+        return Promise.resolve(response.meta.recordCount);
     }
 }
 exports.ApiResource = ApiResource;
+class ApiSingleton extends ApiResourceBase {
+    async retrieve(params, options) {
+        return this.resources.singleton({ type: this.type() }, params, options);
+    }
+}
+exports.ApiSingleton = ApiSingleton;
 exports.default = ResourceAdapter;

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

@@ -1,102 +1,103 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Geocoder } from './geocoders';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Geocoder, GeocoderType } from './geocoders';
 import type { Event } from './events';
-import type { Tag } from './tags';
+import type { Tag, TagType } from './tags';
 import type { Version } from './versions';
+type AddressType = 'addresses';
 type AddressRel = ResourceRel & {
-    type: typeof Addresses.TYPE;
+    type: AddressType;
 };
 type GeocoderRel = ResourceRel & {
-    type: 'geocoders';
+    type: GeocoderType;
 };
 type TagRel = ResourceRel & {
-    type: 'tags';
+    type: TagType;
 };
 interface Address extends Resource {
-    business?: boolean;
-    first_name?: string;
-    last_name?: string;
-    company?: string;
-    full_name?: string;
-    line_1?: string;
-    line_2?: string;
-    city?: string;
-    zip_code?: string;
-    state_code?: string;
-    country_code?: string;
-    phone?: string;
-    full_address?: string;
-    name?: string;
-    email?: string;
-    notes?: string;
-    lat?: number;
-    lng?: number;
-    is_localized?: boolean;
-    is_geocoded?: boolean;
-    provider_name?: string;
-    map_url?: string;
-    static_map_url?: string;
-    billing_info?: string;
-    geocoder?: Geocoder;
-    events?: Event[];
-    tags?: Tag[];
-    versions?: Version[];
+    readonly type: AddressType;
+    business?: boolean | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    company?: string | null;
+    full_name?: string | null;
+    line_1: string;
+    line_2?: string | null;
+    city: string;
+    zip_code?: string | null;
+    state_code: string;
+    country_code: string;
+    phone: string;
+    full_address?: string | null;
+    name?: string | null;
+    email?: string | null;
+    notes?: string | null;
+    lat?: number | null;
+    lng?: number | null;
+    is_localized?: boolean | null;
+    is_geocoded?: boolean | null;
+    provider_name?: string | null;
+    map_url?: string | null;
+    static_map_url?: string | null;
+    billing_info?: string | null;
+    geocoder?: Geocoder | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
+    versions?: Version[] | null;
 }
 interface AddressCreate extends ResourceCreate {
-    business?: boolean;
-    first_name?: string;
-    last_name?: string;
-    company?: string;
+    business?: boolean | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    company?: string | null;
     line_1: string;
-    line_2?: string;
+    line_2?: string | null;
     city: string;
-    zip_code?: string;
+    zip_code?: string | null;
     state_code: string;
     country_code: string;
     phone: string;
-    email?: string;
-    notes?: string;
-    lat?: number;
-    lng?: number;
-    billing_info?: string;
-    geocoder?: GeocoderRel;
-    tags?: TagRel[];
+    email?: string | null;
+    notes?: string | null;
+    lat?: number | null;
+    lng?: number | null;
+    billing_info?: string | null;
+    geocoder?: GeocoderRel | null;
+    tags?: TagRel[] | null;
 }
 interface AddressUpdate extends ResourceUpdate {
-    business?: boolean;
-    first_name?: string;
-    last_name?: string;
-    company?: string;
-    line_1?: string;
-    line_2?: string;
-    city?: string;
-    zip_code?: string;
-    state_code?: string;
-    country_code?: string;
-    phone?: string;
-    email?: string;
-    notes?: string;
-    lat?: number;
-    lng?: number;
-    billing_info?: string;
-    geocoder?: GeocoderRel;
-    tags?: TagRel[];
+    business?: boolean | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    company?: string | null;
+    line_1?: string | null;
+    line_2?: string | null;
+    city?: string | null;
+    zip_code?: string | null;
+    state_code?: string | null;
+    country_code?: string | null;
+    phone?: string | null;
+    email?: string | null;
+    notes?: string | null;
+    lat?: number | null;
+    lng?: number | null;
+    billing_info?: string | null;
+    geocoder?: GeocoderRel | null;
+    tags?: TagRel[] | null;
 }
-declare class Addresses extends ApiResource {
-    static readonly TYPE: 'addresses';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Address>>;
+declare class Addresses extends ApiResource<Address> {
+    static readonly TYPE: AddressType;
     create(resource: AddressCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
     update(resource: AddressUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     geocoder(addressId: string | Address, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Geocoder>;
     events(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     tags(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     versions(addressId: string | Address, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isAddress(resource: any): resource is Address;
     relationship(id: string | ResourceId | null): AddressRel;
-    type(): string;
+    type(): AddressType;
 }
 export default Addresses;
-export { Address, AddressCreate, AddressUpdate };
+export type { Address, AddressCreate, AddressUpdate, AddressType };

package/lib/cjs/resources/addresses.js

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

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

@@ -1,16 +1,19 @@
-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 { Version } from './versions';
+type AdjustmentType = 'adjustments';
 type AdjustmentRel = ResourceRel & {
-    type: typeof Adjustments.TYPE;
+    type: AdjustmentType;
 };
 interface Adjustment extends Resource {
-    name?: string;
-    currency_code?: string;
-    amount_cents?: number;
-    amount_float?: number;
-    formatted_amount?: string;
-    versions?: Version[];
+    readonly type: AdjustmentType;
+    name: string;
+    currency_code: string;
+    amount_cents: number;
+    amount_float: number;
+    formatted_amount: string;
+    versions?: Version[] | null;
 }
 interface AdjustmentCreate extends ResourceCreate {
     name: string;
@@ -18,21 +21,19 @@ interface AdjustmentCreate extends ResourceCreate {
     amount_cents: number;
 }
 interface AdjustmentUpdate extends ResourceUpdate {
-    name?: string;
-    currency_code?: string;
-    amount_cents?: number;
+    name?: string | null;
+    currency_code?: string | null;
+    amount_cents?: number | null;
 }
-declare class Adjustments extends ApiResource {
-    static readonly TYPE: 'adjustments';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Adjustment>>;
+declare class Adjustments extends ApiResource<Adjustment> {
+    static readonly TYPE: AdjustmentType;
     create(resource: AdjustmentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Adjustment>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Adjustment>;
     update(resource: AdjustmentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Adjustment>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     versions(adjustmentId: string | Adjustment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isAdjustment(resource: any): resource is Adjustment;
     relationship(id: string | ResourceId | null): AdjustmentRel;
-    type(): string;
+    type(): AdjustmentType;
 }
 export default Adjustments;
-export { Adjustment, AdjustmentCreate, AdjustmentUpdate };
+export type { Adjustment, AdjustmentCreate, AdjustmentUpdate, AdjustmentType };

package/lib/cjs/resources/adjustments.js

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

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

@@ -1,59 +1,60 @@
-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 { PaymentMethod } from './payment_methods';
 import type { Version } from './versions';
-import type { AdyenPayment } from './adyen_payments';
+import type { AdyenPayment, AdyenPaymentType } from './adyen_payments';
+type AdyenGatewayType = 'adyen_gateways';
 type AdyenGatewayRel = ResourceRel & {
-    type: typeof AdyenGateways.TYPE;
+    type: AdyenGatewayType;
 };
 type AdyenPaymentRel = ResourceRel & {
-    type: 'adyen_payments';
+    type: AdyenPaymentType;
 };
 interface AdyenGateway extends Resource {
-    name?: string;
-    live_url_prefix?: string;
-    async_api?: boolean;
-    webhook_endpoint_secret?: string;
-    webhook_endpoint_url?: string;
-    payment_methods?: PaymentMethod[];
-    versions?: Version[];
-    adyen_payments?: AdyenPayment[];
+    readonly type: AdyenGatewayType;
+    name: string;
+    live_url_prefix: string;
+    async_api?: boolean | null;
+    webhook_endpoint_secret?: string | null;
+    webhook_endpoint_url?: string | null;
+    payment_methods?: PaymentMethod[] | null;
+    versions?: Version[] | null;
+    adyen_payments?: AdyenPayment[] | null;
 }
 interface AdyenGatewayCreate extends ResourceCreate {
     name: string;
     merchant_account: string;
     api_key: string;
-    public_key?: string;
+    public_key?: string | null;
     live_url_prefix: string;
-    api_version?: string;
-    async_api?: boolean;
-    webhook_endpoint_secret?: string;
-    adyen_payments?: AdyenPaymentRel[];
+    api_version?: string | null;
+    async_api?: boolean | null;
+    webhook_endpoint_secret?: string | null;
+    adyen_payments?: AdyenPaymentRel[] | null;
 }
 interface AdyenGatewayUpdate extends ResourceUpdate {
-    name?: string;
-    merchant_account?: string;
-    api_key?: string;
-    public_key?: string;
-    live_url_prefix?: string;
-    api_version?: string;
-    async_api?: boolean;
-    webhook_endpoint_secret?: string;
-    adyen_payments?: AdyenPaymentRel[];
+    name?: string | null;
+    merchant_account?: string | null;
+    api_key?: string | null;
+    public_key?: string | null;
+    live_url_prefix?: string | null;
+    api_version?: string | null;
+    async_api?: boolean | null;
+    webhook_endpoint_secret?: string | null;
+    adyen_payments?: AdyenPaymentRel[] | null;
 }
-declare class AdyenGateways extends ApiResource {
-    static readonly TYPE: 'adyen_gateways';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<AdyenGateway>>;
+declare class AdyenGateways extends ApiResource<AdyenGateway> {
+    static readonly TYPE: AdyenGatewayType;
     create(resource: AdyenGatewayCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenGateway>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenGateway>;
     update(resource: AdyenGatewayUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<AdyenGateway>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     payment_methods(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
     versions(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     adyen_payments(adyenGatewayId: string | AdyenGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<AdyenPayment>>;
     isAdyenGateway(resource: any): resource is AdyenGateway;
     relationship(id: string | ResourceId | null): AdyenGatewayRel;
-    type(): string;
+    type(): AdyenGatewayType;
 }
 export default AdyenGateways;
-export { AdyenGateway, AdyenGatewayCreate, AdyenGatewayUpdate };
+export type { AdyenGateway, AdyenGatewayCreate, AdyenGatewayUpdate, AdyenGatewayType };

package/lib/cjs/resources/adyen_gateways.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class AdyenGateways extends resource_1.ApiResource {
-    // static readonly PATH = 'adyen_gateways'
-    async list(params, options) {
-        return this.resources.list({ type: AdyenGateways.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: AdyenGateways.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: AdyenGateways.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: AdyenGateways.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: AdyenGateways.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: AdyenGateways.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: AdyenGateways.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: AdyenGateways.TYPE } : id, options);
     }
     async payment_methods(adyenGatewayId, params, options) {
         const _adyenGatewayId = adyenGatewayId.id || adyenGatewayId;
@@ -30,7 +23,6 @@ class AdyenGateways extends resource_1.ApiResource {
         const _adyenGatewayId = adyenGatewayId.id || adyenGatewayId;
         return this.resources.fetch({ type: 'adyen_payments' }, `adyen_gateways/${_adyenGatewayId}/adyen_payments`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isAdyenGateway(resource) {
         return resource.type && (resource.type === AdyenGateways.TYPE);
     }