@commercelayer/sdk 4.35.0 → 4.37.0

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

@@ -1,6 +1,7 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { CustomerGroup } from './customer_groups';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { CustomerGroup, CustomerGroupType } from './customer_groups';
 import type { CustomerAddress } from './customer_addresses';
 import type { CustomerPaymentSource } from './customer_payment_sources';
 import type { CustomerSubscription } from './customer_subscriptions';
@@ -10,52 +11,52 @@ import type { Return } from './returns';
 import type { SkuList } from './sku_lists';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
-import type { Tag } from './tags';
+import type { Tag, TagType } from './tags';
+type CustomerType = 'customers';
 type CustomerRel = ResourceRel & {
-    type: typeof Customers.TYPE;
+    type: CustomerType;
 };
 type CustomerGroupRel = ResourceRel & {
-    type: 'customer_groups';
+    type: CustomerGroupType;
 };
 type TagRel = ResourceRel & {
-    type: 'tags';
+    type: TagType;
 };
 interface Customer extends Resource {
-    email?: string;
-    status?: string;
-    has_password?: boolean;
-    total_orders_count?: number;
-    customer_group?: CustomerGroup;
-    customer_addresses?: CustomerAddress[];
-    customer_payment_sources?: CustomerPaymentSource[];
-    customer_subscriptions?: CustomerSubscription[];
-    orders?: Order[];
-    order_subscriptions?: OrderSubscription[];
-    returns?: Return[];
-    sku_lists?: SkuList[];
-    attachments?: Attachment[];
-    events?: Event[];
-    tags?: Tag[];
+    readonly type: CustomerType;
+    email: string;
+    status: 'prospect' | 'acquired' | 'repeat';
+    has_password?: boolean | null;
+    total_orders_count?: number | null;
+    customer_group?: CustomerGroup | null;
+    customer_addresses?: CustomerAddress[] | null;
+    customer_payment_sources?: CustomerPaymentSource[] | null;
+    customer_subscriptions?: CustomerSubscription[] | null;
+    orders?: Order[] | null;
+    order_subscriptions?: OrderSubscription[] | null;
+    returns?: Return[] | null;
+    sku_lists?: SkuList[] | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
 }
 interface CustomerCreate extends ResourceCreate {
     email: string;
-    password?: string;
-    customer_group?: CustomerGroupRel;
-    tags?: TagRel[];
+    password?: string | null;
+    customer_group?: CustomerGroupRel | null;
+    tags?: TagRel[] | null;
 }
 interface CustomerUpdate extends ResourceUpdate {
-    email?: string;
-    password?: string;
-    customer_group?: CustomerGroupRel;
-    tags?: TagRel[];
+    email?: string | null;
+    password?: string | null;
+    customer_group?: CustomerGroupRel | null;
+    tags?: TagRel[] | null;
 }
-declare class Customers extends ApiResource {
-    static readonly TYPE: 'customers';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Customer>>;
+declare class Customers extends ApiResource<Customer> {
+    static readonly TYPE: CustomerType;
     create(resource: CustomerCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
     update(resource: CustomerUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     customer_group(customerId: string | Customer, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomerGroup>;
     customer_addresses(customerId: string | Customer, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CustomerAddress>>;
     customer_payment_sources(customerId: string | Customer, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CustomerPaymentSource>>;
@@ -69,7 +70,7 @@ declare class Customers extends ApiResource {
     tags(customerId: string | Customer, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     isCustomer(resource: any): resource is Customer;
     relationship(id: string | ResourceId | null): CustomerRel;
-    type(): string;
+    type(): CustomerType;
 }
 export default Customers;
-export { Customer, CustomerCreate, CustomerUpdate };
+export type { Customer, CustomerCreate, CustomerUpdate, CustomerType };

package/lib/cjs/resources/customers.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Customers extends resource_1.ApiResource {
-    // static readonly PATH = 'customers'
-    async list(params, options) {
-        return this.resources.list({ type: Customers.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Customers.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Customers.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: Customers.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Customers.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Customers.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: Customers.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: Customers.TYPE } : id, options);
     }
     async customer_group(customerId, params, options) {
         const _customerId = customerId.id || customerId;
@@ -62,7 +55,6 @@ class Customers extends resource_1.ApiResource {
         const _customerId = customerId.id || customerId;
         return this.resources.fetch({ type: 'tags' }, `customers/${_customerId}/tags`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isCustomer(resource) {
         return resource.type && (resource.type === Customers.TYPE);
     }

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

@@ -1,27 +1,30 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { StockLocation } from './stock_locations';
-import type { ShippingMethod } from './shipping_methods';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { StockLocation, StockLocationType } from './stock_locations';
+import type { ShippingMethod, ShippingMethodType } from './shipping_methods';
 import type { Attachment } from './attachments';
 import type { Version } from './versions';
+type DeliveryLeadTimeType = 'delivery_lead_times';
 type DeliveryLeadTimeRel = ResourceRel & {
-    type: typeof DeliveryLeadTimes.TYPE;
+    type: DeliveryLeadTimeType;
 };
 type StockLocationRel = ResourceRel & {
-    type: 'stock_locations';
+    type: StockLocationType;
 };
 type ShippingMethodRel = ResourceRel & {
-    type: 'shipping_methods';
+    type: ShippingMethodType;
 };
 interface DeliveryLeadTime extends Resource {
-    min_hours?: number;
-    max_hours?: number;
-    min_days?: number;
-    max_days?: number;
-    stock_location?: StockLocation;
-    shipping_method?: ShippingMethod;
-    attachments?: Attachment[];
-    versions?: Version[];
+    readonly type: DeliveryLeadTimeType;
+    min_hours: number;
+    max_hours: number;
+    min_days?: number | null;
+    max_days?: number | null;
+    stock_location?: StockLocation | null;
+    shipping_method?: ShippingMethod | null;
+    attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
 interface DeliveryLeadTimeCreate extends ResourceCreate {
     min_hours: number;
@@ -30,25 +33,23 @@ interface DeliveryLeadTimeCreate extends ResourceCreate {
     shipping_method: ShippingMethodRel;
 }
 interface DeliveryLeadTimeUpdate extends ResourceUpdate {
-    min_hours?: number;
-    max_hours?: number;
-    stock_location?: StockLocationRel;
-    shipping_method?: ShippingMethodRel;
+    min_hours?: number | null;
+    max_hours?: number | null;
+    stock_location?: StockLocationRel | null;
+    shipping_method?: ShippingMethodRel | null;
 }
-declare class DeliveryLeadTimes extends ApiResource {
-    static readonly TYPE: 'delivery_lead_times';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<DeliveryLeadTime>>;
+declare class DeliveryLeadTimes extends ApiResource<DeliveryLeadTime> {
+    static readonly TYPE: DeliveryLeadTimeType;
     create(resource: DeliveryLeadTimeCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<DeliveryLeadTime>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<DeliveryLeadTime>;
     update(resource: DeliveryLeadTimeUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<DeliveryLeadTime>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     stock_location(deliveryLeadTimeId: string | DeliveryLeadTime, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
     shipping_method(deliveryLeadTimeId: string | DeliveryLeadTime, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
     attachments(deliveryLeadTimeId: string | DeliveryLeadTime, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     versions(deliveryLeadTimeId: string | DeliveryLeadTime, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isDeliveryLeadTime(resource: any): resource is DeliveryLeadTime;
     relationship(id: string | ResourceId | null): DeliveryLeadTimeRel;
-    type(): string;
+    type(): DeliveryLeadTimeType;
 }
 export default DeliveryLeadTimes;
-export { DeliveryLeadTime, DeliveryLeadTimeCreate, DeliveryLeadTimeUpdate };
+export type { DeliveryLeadTime, DeliveryLeadTimeCreate, DeliveryLeadTimeUpdate, DeliveryLeadTimeType };

package/lib/cjs/resources/delivery_lead_times.js

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

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

@@ -1,24 +1,25 @@
-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 } from '../resource';
+import type { QueryParamsRetrieve } from '../query';
 import type { Webhook } from './webhooks';
+type EventCallbackType = 'event_callbacks';
 type EventCallbackRel = ResourceRel & {
-    type: typeof EventCallbacks.TYPE;
+    type: EventCallbackType;
 };
 interface EventCallback extends Resource {
-    callback_url?: string;
-    payload?: object;
-    response_code?: string;
-    response_message?: string;
-    webhook?: Webhook;
+    readonly type: EventCallbackType;
+    callback_url: string;
+    payload?: Record<string, any> | null;
+    response_code?: string | null;
+    response_message?: string | null;
+    webhook?: Webhook | null;
 }
-declare class EventCallbacks extends ApiResource {
-    static readonly TYPE: 'event_callbacks';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<EventCallback>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<EventCallback>;
+declare class EventCallbacks extends ApiResource<EventCallback> {
+    static readonly TYPE: EventCallbackType;
     webhook(eventCallbackId: string | EventCallback, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
     isEventCallback(resource: any): resource is EventCallback;
     relationship(id: string | ResourceId | null): EventCallbackRel;
-    type(): string;
+    type(): EventCallbackType;
 }
 export default EventCallbacks;
-export { EventCallback };
+export type { EventCallback, EventCallbackType };

package/lib/cjs/resources/event_callbacks.js

@@ -2,18 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class EventCallbacks extends resource_1.ApiResource {
-    // static readonly PATH = 'event_callbacks'
-    async list(params, options) {
-        return this.resources.list({ type: EventCallbacks.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: EventCallbacks.TYPE, id }, params, options);
-    }
     async webhook(eventCallbackId, params, options) {
         const _eventCallbackId = eventCallbackId.id || eventCallbackId;
         return this.resources.fetch({ type: 'webhooks' }, `event_callbacks/${_eventCallbackId}/webhook`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isEventCallback(resource) {
         return resource.type && (resource.type === EventCallbacks.TYPE);
     }

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

@@ -1,24 +1,25 @@
-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 { QueryParamsList } from '../query';
 import type { EventCallback } from './event_callbacks';
 import type { Webhook } from './webhooks';
+type EventType = 'events';
 type EventRel = ResourceRel & {
-    type: typeof Events.TYPE;
+    type: EventType;
 };
 interface Event extends Resource {
-    name?: string;
-    last_event_callbacks?: EventCallback[];
-    webhooks?: Webhook[];
+    readonly type: EventType;
+    name: string;
+    last_event_callbacks?: EventCallback[] | null;
+    webhooks?: Webhook[] | null;
 }
-declare class Events extends ApiResource {
-    static readonly TYPE: 'events';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Event>;
+declare class Events extends ApiResource<Event> {
+    static readonly TYPE: EventType;
     last_event_callbacks(eventId: string | Event, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<EventCallback>>;
     webhooks(eventId: string | Event, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Webhook>>;
     isEvent(resource: any): resource is Event;
     relationship(id: string | ResourceId | null): EventRel;
-    type(): string;
+    type(): EventType;
 }
 export default Events;
-export { Event };
+export type { Event, EventType };

package/lib/cjs/resources/events.js

@@ -2,13 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Events extends resource_1.ApiResource {
-    // static readonly PATH = 'events'
-    async list(params, options) {
-        return this.resources.list({ type: Events.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Events.TYPE, id }, params, options);
-    }
     async last_event_callbacks(eventId, params, options) {
         const _eventId = eventId.id || eventId;
         return this.resources.fetch({ type: 'event_callbacks' }, `events/${_eventId}/last_event_callbacks`, params, options);
@@ -17,7 +10,6 @@ class Events extends resource_1.ApiResource {
         const _eventId = eventId.id || eventId;
         return this.resources.fetch({ type: 'webhooks' }, `events/${_eventId}/webhooks`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isEvent(resource) {
         return resource.type && (resource.type === Events.TYPE);
     }

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

@@ -1,40 +1,41 @@
-import { ApiResource, Resource, ResourceCreate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Event } from './events';
+type ExportType = 'exports';
 type ExportRel = ResourceRel & {
-    type: typeof Exports.TYPE;
+    type: ExportType;
 };
 interface Export extends Resource {
-    resource_type?: string;
-    format?: string;
-    status?: string;
-    includes?: string[];
-    filters?: object;
-    dry_data?: boolean;
-    started_at?: string;
-    completed_at?: string;
-    interrupted_at?: string;
-    records_count?: number;
-    attachment_url?: string;
-    events?: Event[];
+    readonly type: ExportType;
+    resource_type: string;
+    format?: string | null;
+    status: 'pending' | 'in_progress' | 'completed';
+    includes?: string[] | null;
+    filters?: Record<string, any> | null;
+    dry_data?: boolean | null;
+    started_at?: string | null;
+    completed_at?: string | null;
+    interrupted_at?: string | null;
+    records_count?: number | null;
+    attachment_url?: string | null;
+    events?: Event[] | null;
 }
 interface ExportCreate extends ResourceCreate {
     resource_type: string;
-    format?: string;
-    includes?: string[];
-    filters?: object;
-    dry_data?: boolean;
+    format?: string | null;
+    includes?: string[] | null;
+    filters?: Record<string, any> | null;
+    dry_data?: boolean | null;
 }
-declare class Exports extends ApiResource {
-    static readonly TYPE: 'exports';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Export>>;
+declare class Exports extends ApiResource<Export> {
+    static readonly TYPE: ExportType;
     create(resource: ExportCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Export>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Export>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     events(exportId: string | Export, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     isExport(resource: any): resource is Export;
     relationship(id: string | ResourceId | null): ExportRel;
-    type(): string;
+    type(): ExportType;
 }
 export default Exports;
-export { Export, ExportCreate };
+export type { Export, ExportCreate, ExportType };

package/lib/cjs/resources/exports.js

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

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

@@ -1,52 +1,53 @@
-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 { ExternalPayment } from './external_payments';
+type ExternalGatewayType = 'external_gateways';
 type ExternalGatewayRel = ResourceRel & {
-    type: typeof ExternalGateways.TYPE;
+    type: ExternalGatewayType;
 };
 interface ExternalGateway extends Resource {
-    name?: string;
-    shared_secret?: string;
-    authorize_url?: string;
-    capture_url?: string;
-    void_url?: string;
-    refund_url?: string;
-    token_url?: string;
-    payment_methods?: PaymentMethod[];
-    versions?: Version[];
-    external_payments?: ExternalPayment[];
+    readonly type: ExternalGatewayType;
+    name: string;
+    shared_secret: string;
+    authorize_url?: string | null;
+    capture_url?: string | null;
+    void_url?: string | null;
+    refund_url?: string | null;
+    token_url?: string | null;
+    payment_methods?: PaymentMethod[] | null;
+    versions?: Version[] | null;
+    external_payments?: ExternalPayment[] | null;
 }
 interface ExternalGatewayCreate extends ResourceCreate {
     name: string;
-    authorize_url?: string;
-    capture_url?: string;
-    void_url?: string;
-    refund_url?: string;
-    token_url?: string;
+    authorize_url?: string | null;
+    capture_url?: string | null;
+    void_url?: string | null;
+    refund_url?: string | null;
+    token_url?: string | null;
 }
 interface ExternalGatewayUpdate extends ResourceUpdate {
-    name?: string;
-    authorize_url?: string;
-    capture_url?: string;
-    void_url?: string;
-    refund_url?: string;
-    token_url?: string;
+    name?: string | null;
+    authorize_url?: string | null;
+    capture_url?: string | null;
+    void_url?: string | null;
+    refund_url?: string | null;
+    token_url?: string | null;
 }
-declare class ExternalGateways extends ApiResource {
-    static readonly TYPE: 'external_gateways';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ExternalGateway>>;
+declare class ExternalGateways extends ApiResource<ExternalGateway> {
+    static readonly TYPE: ExternalGatewayType;
     create(resource: ExternalGatewayCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalGateway>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalGateway>;
     update(resource: ExternalGatewayUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalGateway>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     payment_methods(externalGatewayId: string | ExternalGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
     versions(externalGatewayId: string | ExternalGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     external_payments(externalGatewayId: string | ExternalGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ExternalPayment>>;
     isExternalGateway(resource: any): resource is ExternalGateway;
     relationship(id: string | ResourceId | null): ExternalGatewayRel;
-    type(): string;
+    type(): ExternalGatewayType;
 }
 export default ExternalGateways;
-export { ExternalGateway, ExternalGatewayCreate, ExternalGatewayUpdate };
+export type { ExternalGateway, ExternalGatewayCreate, ExternalGatewayUpdate, ExternalGatewayType };

package/lib/cjs/resources/external_gateways.js

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