@commercelayer/sdk 4.35.0 → 4.37.0

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

@@ -1,17 +1,9 @@
 import { ApiResource } from '../resource';
 class EventCallbacks extends 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/esm/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/esm/resources/events.js

@@ -1,12 +1,5 @@
 import { ApiResource } from '../resource';
 class Events extends 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);
@@ -15,7 +8,6 @@ class Events extends 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/esm/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/esm/resources/exports.js

@@ -1,23 +1,15 @@
 import { ApiResource } from '../resource';
 class Exports extends 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/esm/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/esm/resources/external_gateways.js

@@ -1,20 +1,13 @@
 import { ApiResource } from '../resource';
 class ExternalGateways extends 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;
@@ -28,7 +21,6 @@ class ExternalGateways extends 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);
     }

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

@@ -1,47 +1,48 @@
-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 { PaymentGateway } from './payment_gateways';
 import type { CustomerPaymentSource } from './customer_payment_sources';
 import type { Version } from './versions';
+type ExternalPaymentType = 'external_payments';
 type ExternalPaymentRel = ResourceRel & {
-    type: typeof ExternalPayments.TYPE;
+    type: ExternalPaymentType;
 };
 type OrderRel = ResourceRel & {
-    type: 'orders';
+    type: OrderType;
 };
 interface ExternalPayment extends Resource {
-    payment_source_token?: string;
-    options?: object;
-    payment_instrument?: object;
-    order?: Order;
-    payment_gateway?: PaymentGateway;
-    wallet?: CustomerPaymentSource;
-    versions?: Version[];
+    readonly type: ExternalPaymentType;
+    payment_source_token: string;
+    options?: Record<string, any> | null;
+    payment_instrument?: Record<string, any> | null;
+    order?: Order | null;
+    payment_gateway?: PaymentGateway | null;
+    wallet?: CustomerPaymentSource | null;
+    versions?: Version[] | null;
 }
 interface ExternalPaymentCreate extends ResourceCreate {
     payment_source_token: string;
-    options?: object;
+    options?: Record<string, any> | null;
     order: OrderRel;
 }
 interface ExternalPaymentUpdate extends ResourceUpdate {
-    options?: object;
-    order?: OrderRel;
+    options?: Record<string, any> | null;
+    order?: OrderRel | null;
 }
-declare class ExternalPayments extends ApiResource {
-    static readonly TYPE: 'external_payments';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ExternalPayment>>;
+declare class ExternalPayments extends ApiResource<ExternalPayment> {
+    static readonly TYPE: ExternalPaymentType;
     create(resource: ExternalPaymentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPayment>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPayment>;
     update(resource: ExternalPaymentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPayment>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     order(externalPaymentId: string | ExternalPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     payment_gateway(externalPaymentId: string | ExternalPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
     wallet(externalPaymentId: string | ExternalPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomerPaymentSource>;
     versions(externalPaymentId: string | ExternalPayment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isExternalPayment(resource: any): resource is ExternalPayment;
     relationship(id: string | ResourceId | null): ExternalPaymentRel;
-    type(): string;
+    type(): ExternalPaymentType;
 }
 export default ExternalPayments;
-export { ExternalPayment, ExternalPaymentCreate, ExternalPaymentUpdate };
+export type { ExternalPayment, ExternalPaymentCreate, ExternalPaymentUpdate, ExternalPaymentType };

package/lib/esm/resources/external_payments.js

@@ -1,20 +1,13 @@
 import { ApiResource } from '../resource';
 class ExternalPayments extends ApiResource {
-    // static readonly PATH = 'external_payments'
-    async list(params, options) {
-        return this.resources.list({ type: ExternalPayments.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ExternalPayments.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: ExternalPayments.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: ExternalPayments.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ExternalPayments.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: ExternalPayments.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: ExternalPayments.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: ExternalPayments.TYPE } : id, options);
     }
     async order(externalPaymentId, params, options) {
         const _externalPaymentId = externalPaymentId.id || externalPaymentId;
@@ -32,7 +25,6 @@ class ExternalPayments extends ApiResource {
         const _externalPaymentId = externalPaymentId.id || externalPaymentId;
         return this.resources.fetch({ type: 'versions' }, `external_payments/${_externalPaymentId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isExternalPayment(resource) {
         return resource.type && (resource.type === ExternalPayments.TYPE);
     }

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

@@ -1,99 +1,100 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Market } from './markets';
-import type { PromotionRule } from './promotion_rules';
-import type { OrderAmountPromotionRule } from './order_amount_promotion_rules';
-import type { SkuListPromotionRule } from './sku_list_promotion_rules';
-import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
-import type { Coupon } from './coupons';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Market, MarketType } from './markets';
+import type { PromotionRule, PromotionRuleType } from './promotion_rules';
+import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './order_amount_promotion_rules';
+import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
+import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
+import type { Coupon, CouponType } from './coupons';
 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';
 import type { Version } from './versions';
+type ExternalPromotionType = 'external_promotions';
 type ExternalPromotionRel = ResourceRel & {
-    type: typeof ExternalPromotions.TYPE;
+    type: ExternalPromotionType;
 };
 type MarketRel = ResourceRel & {
-    type: 'markets';
+    type: MarketType;
 };
 type PromotionRuleRel = ResourceRel & {
-    type: 'promotion_rules';
+    type: PromotionRuleType;
 };
 type OrderAmountPromotionRuleRel = ResourceRel & {
-    type: 'order_amount_promotion_rules';
+    type: OrderAmountPromotionRuleType;
 };
 type SkuListPromotionRuleRel = ResourceRel & {
-    type: 'sku_list_promotion_rules';
+    type: SkuListPromotionRuleType;
 };
 type CouponCodesPromotionRuleRel = ResourceRel & {
-    type: 'coupon_codes_promotion_rules';
+    type: CouponCodesPromotionRuleType;
 };
 type CouponRel = ResourceRel & {
-    type: 'coupons';
+    type: CouponType;
 };
 type TagRel = ResourceRel & {
-    type: 'tags';
+    type: TagType;
 };
 interface ExternalPromotion extends Resource {
-    name?: string;
-    currency_code?: string;
-    starts_at?: string;
-    expires_at?: string;
-    total_usage_limit?: number;
-    total_usage_count?: number;
-    active?: boolean;
-    promotion_url?: string;
-    shared_secret?: string;
-    market?: Market;
-    promotion_rules?: PromotionRule[];
-    order_amount_promotion_rule?: OrderAmountPromotionRule;
-    sku_list_promotion_rule?: SkuListPromotionRule;
-    coupon_codes_promotion_rule?: CouponCodesPromotionRule;
-    coupons?: Coupon[];
-    sku_list?: SkuList;
-    attachments?: Attachment[];
-    events?: Event[];
-    tags?: Tag[];
-    versions?: Version[];
+    readonly type: ExternalPromotionType;
+    name: string;
+    currency_code?: string | null;
+    starts_at: string;
+    expires_at: string;
+    total_usage_limit: number;
+    total_usage_count?: number | null;
+    active?: boolean | null;
+    promotion_url: string;
+    shared_secret: string;
+    market?: Market | null;
+    promotion_rules?: PromotionRule[] | null;
+    order_amount_promotion_rule?: OrderAmountPromotionRule | null;
+    sku_list_promotion_rule?: SkuListPromotionRule | null;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
+    coupons?: Coupon[] | null;
+    sku_list?: SkuList | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
+    versions?: Version[] | null;
 }
 interface ExternalPromotionCreate extends ResourceCreate {
     name: string;
-    currency_code?: string;
+    currency_code?: string | null;
     starts_at: string;
     expires_at: string;
     total_usage_limit: number;
     promotion_url: string;
-    market?: MarketRel;
-    promotion_rules?: PromotionRuleRel[];
-    order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
-    sku_list_promotion_rule?: SkuListPromotionRuleRel;
-    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
-    coupons?: CouponRel[];
-    tags?: TagRel[];
+    market?: MarketRel | null;
+    promotion_rules?: PromotionRuleRel[] | null;
+    order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
+    sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
+    coupons?: CouponRel[] | null;
+    tags?: TagRel[] | null;
 }
 interface ExternalPromotionUpdate extends ResourceUpdate {
-    name?: string;
-    currency_code?: string;
-    starts_at?: string;
-    expires_at?: string;
-    total_usage_limit?: number;
-    promotion_url?: string;
-    market?: MarketRel;
-    promotion_rules?: PromotionRuleRel[];
-    order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
-    sku_list_promotion_rule?: SkuListPromotionRuleRel;
-    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
-    coupons?: CouponRel[];
-    tags?: TagRel[];
+    name?: string | null;
+    currency_code?: string | null;
+    starts_at?: string | null;
+    expires_at?: string | null;
+    total_usage_limit?: number | null;
+    promotion_url?: string | null;
+    market?: MarketRel | null;
+    promotion_rules?: PromotionRuleRel[] | null;
+    order_amount_promotion_rule?: OrderAmountPromotionRuleRel | null;
+    sku_list_promotion_rule?: SkuListPromotionRuleRel | null;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel | null;
+    coupons?: CouponRel[] | null;
+    tags?: TagRel[] | null;
 }
-declare class ExternalPromotions extends ApiResource {
-    static readonly TYPE: 'external_promotions';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ExternalPromotion>>;
+declare class ExternalPromotions extends ApiResource<ExternalPromotion> {
+    static readonly TYPE: ExternalPromotionType;
     create(resource: ExternalPromotionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPromotion>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPromotion>;
     update(resource: ExternalPromotionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPromotion>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     market(externalPromotionId: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     order_amount_promotion_rule(externalPromotionId: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
     sku_list_promotion_rule(externalPromotionId: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
@@ -106,7 +107,7 @@ declare class ExternalPromotions extends ApiResource {
     versions(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isExternalPromotion(resource: any): resource is ExternalPromotion;
     relationship(id: string | ResourceId | null): ExternalPromotionRel;
-    type(): string;
+    type(): ExternalPromotionType;
 }
 export default ExternalPromotions;
-export { ExternalPromotion, ExternalPromotionCreate, ExternalPromotionUpdate };
+export type { ExternalPromotion, ExternalPromotionCreate, ExternalPromotionUpdate, ExternalPromotionType };