@commercelayer/sdk 5.0.0-alpha.5 → 5.0.0-beta.2

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

@@ -0,0 +1,52 @@
+import { ApiResource, 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';
+type DeliveryLeadTimeType = 'delivery_lead_times';
+type DeliveryLeadTimeRel = ResourceRel & {
+    type: DeliveryLeadTimeType;
+};
+type StockLocationRel = ResourceRel & {
+    type: StockLocationType;
+};
+type ShippingMethodRel = ResourceRel & {
+    type: ShippingMethodType;
+};
+interface DeliveryLeadTime extends Resource {
+    readonly type: DeliveryLeadTimeType;
+    min_hours: number;
+    max_hours: number;
+    min_days?: number;
+    max_days?: number;
+    stock_location?: StockLocation;
+    shipping_method?: ShippingMethod;
+    attachments?: Attachment[];
+}
+interface DeliveryLeadTimeCreate extends ResourceCreate {
+    min_hours: number;
+    max_hours: number;
+    stock_location: StockLocationRel;
+    shipping_method: ShippingMethodRel;
+}
+interface DeliveryLeadTimeUpdate extends ResourceUpdate {
+    min_hours: number;
+    max_hours: number;
+    stock_location?: StockLocationRel;
+    shipping_method?: ShippingMethodRel;
+}
+declare class DeliveryLeadTimes extends ApiResource<DeliveryLeadTime> {
+    static readonly TYPE: DeliveryLeadTimeType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<DeliveryLeadTime>>;
+    create(resource: DeliveryLeadTimeCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<DeliveryLeadTime>;
+    update(resource: DeliveryLeadTimeUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<DeliveryLeadTime>;
+    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>>;
+    isDeliveryLeadTime(resource: any): resource is DeliveryLeadTime;
+    relationship(id: string | ResourceId | null): DeliveryLeadTimeRel;
+    type(): DeliveryLeadTimeType;
+}
+export default DeliveryLeadTimes;
+export type { DeliveryLeadTime, DeliveryLeadTimeCreate, DeliveryLeadTimeUpdate, DeliveryLeadTimeType };

package/lib/cjs/resources/delivery_lead_times.js

@@ -0,0 +1,41 @@
+"use strict";
+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 update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: DeliveryLeadTimes.TYPE }), params, options);
+    }
+    async delete(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;
+        return this.resources.fetch({ type: 'stock_locations' }, `delivery_lead_times/${_deliveryLeadTimeId}/stock_location`, params, options);
+    }
+    async shipping_method(deliveryLeadTimeId, params, options) {
+        const _deliveryLeadTimeId = deliveryLeadTimeId.id || deliveryLeadTimeId;
+        return this.resources.fetch({ type: 'shipping_methods' }, `delivery_lead_times/${_deliveryLeadTimeId}/shipping_method`, params, options);
+    }
+    async attachments(deliveryLeadTimeId, params, options) {
+        const _deliveryLeadTimeId = deliveryLeadTimeId.id || deliveryLeadTimeId;
+        return this.resources.fetch({ type: 'attachments' }, `delivery_lead_times/${_deliveryLeadTimeId}/attachments`, params, options);
+    }
+    isDeliveryLeadTime(resource) {
+        return resource.type && (resource.type === DeliveryLeadTimes.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: DeliveryLeadTimes.TYPE } : { id: id.id, type: DeliveryLeadTimes.TYPE };
+    }
+    type() {
+        return DeliveryLeadTimes.TYPE;
+    }
+}
+DeliveryLeadTimes.TYPE = 'delivery_lead_times';
+exports.default = DeliveryLeadTimes;

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

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

package/lib/cjs/resources/event_callbacks.js

@@ -0,0 +1,24 @@
+"use strict";
+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 webhook(eventCallbackId, params, options) {
+        const _eventCallbackId = eventCallbackId.id || eventCallbackId;
+        return this.resources.fetch({ type: 'webhooks' }, `event_callbacks/${_eventCallbackId}/webhook`, params, options);
+    }
+    isEventCallback(resource) {
+        return resource.type && (resource.type === EventCallbacks.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: EventCallbacks.TYPE } : { id: id.id, type: EventCallbacks.TYPE };
+    }
+    type() {
+        return EventCallbacks.TYPE;
+    }
+}
+EventCallbacks.TYPE = 'event_callbacks';
+exports.default = EventCallbacks;

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

@@ -0,0 +1,25 @@
+import { ApiResource, 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: EventType;
+};
+interface Event extends Resource {
+    readonly type: EventType;
+    name: string;
+    last_event_callbacks?: EventCallback[];
+    webhooks?: Webhook[];
+}
+declare class Events extends ApiResource<Event> {
+    static readonly TYPE: EventType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    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(): EventType;
+}
+export default Events;
+export type { Event, EventType };

package/lib/cjs/resources/events.js

@@ -0,0 +1,28 @@
+"use strict";
+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 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);
+    }
+    async webhooks(eventId, params, options) {
+        const _eventId = eventId.id || eventId;
+        return this.resources.fetch({ type: 'webhooks' }, `events/${_eventId}/webhooks`, params, options);
+    }
+    isEvent(resource) {
+        return resource.type && (resource.type === Events.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Events.TYPE } : { id: id.id, type: Events.TYPE };
+    }
+    type() {
+        return Events.TYPE;
+    }
+}
+Events.TYPE = 'events';
+exports.default = Events;

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

@@ -0,0 +1,41 @@
+import { ApiResource, 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: ExportType;
+};
+interface Export extends Resource {
+    readonly type: ExportType;
+    resource_type: string;
+    format?: string;
+    status?: 'pending' | 'in_progress' | 'completed';
+    includes?: string[];
+    filters?: object;
+    dry_data?: boolean;
+    started_at?: string;
+    completed_at?: string;
+    interrupted_at?: string;
+    records_count?: number;
+    attachment_url?: string;
+    events?: Event[];
+}
+interface ExportCreate extends ResourceCreate {
+    resource_type: string;
+    format?: string;
+    includes?: string[];
+    filters?: object;
+    dry_data?: boolean;
+}
+declare class Exports extends ApiResource<Export> {
+    static readonly TYPE: ExportType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Export>>;
+    create(resource: ExportCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Export>;
+    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(): ExportType;
+}
+export default Exports;
+export type { Export, ExportCreate, ExportType };

package/lib/cjs/resources/exports.js

@@ -0,0 +1,30 @@
+"use strict";
+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 delete(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);
+    }
+    isExport(resource) {
+        return resource.type && (resource.type === Exports.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Exports.TYPE } : { id: id.id, type: Exports.TYPE };
+    }
+    type() {
+        return Exports.TYPE;
+    }
+}
+Exports.TYPE = 'exports';
+exports.default = Exports;

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

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

package/lib/cjs/resources/external_gateways.js

@@ -0,0 +1,37 @@
+"use strict";
+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 update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ExternalGateways.TYPE }), params, options);
+    }
+    async delete(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;
+        return this.resources.fetch({ type: 'payment_methods' }, `external_gateways/${_externalGatewayId}/payment_methods`, params, options);
+    }
+    async external_payments(externalGatewayId, params, options) {
+        const _externalGatewayId = externalGatewayId.id || externalGatewayId;
+        return this.resources.fetch({ type: 'external_payments' }, `external_gateways/${_externalGatewayId}/external_payments`, params, options);
+    }
+    isExternalGateway(resource) {
+        return resource.type && (resource.type === ExternalGateways.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: ExternalGateways.TYPE } : { id: id.id, type: ExternalGateways.TYPE };
+    }
+    type() {
+        return ExternalGateways.TYPE;
+    }
+}
+ExternalGateways.TYPE = 'external_gateways';
+exports.default = ExternalGateways;

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

@@ -0,0 +1,45 @@
+import { ApiResource, 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';
+type ExternalPaymentType = 'external_payments';
+type ExternalPaymentRel = ResourceRel & {
+    type: ExternalPaymentType;
+};
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+interface ExternalPayment extends Resource {
+    readonly type: ExternalPaymentType;
+    payment_source_token: string;
+    options?: object;
+    payment_instrument?: object;
+    order?: Order;
+    payment_gateway?: PaymentGateway;
+    wallet?: CustomerPaymentSource;
+}
+interface ExternalPaymentCreate extends ResourceCreate {
+    payment_source_token: string;
+    options?: object;
+    order: OrderRel;
+}
+interface ExternalPaymentUpdate extends ResourceUpdate {
+    options?: object;
+    order?: OrderRel;
+}
+declare class ExternalPayments extends ApiResource<ExternalPayment> {
+    static readonly TYPE: ExternalPaymentType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ExternalPayment>>;
+    create(resource: ExternalPaymentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPayment>;
+    update(resource: ExternalPaymentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPayment>;
+    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>;
+    isExternalPayment(resource: any): resource is ExternalPayment;
+    relationship(id: string | ResourceId | null): ExternalPaymentRel;
+    type(): ExternalPaymentType;
+}
+export default ExternalPayments;
+export type { ExternalPayment, ExternalPaymentCreate, ExternalPaymentUpdate, ExternalPaymentType };

package/lib/cjs/resources/external_payments.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class ExternalPayments extends resource_1.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 update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ExternalPayments.TYPE }), params, options);
+    }
+    async delete(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;
+        return this.resources.fetch({ type: 'orders' }, `external_payments/${_externalPaymentId}/order`, params, options);
+    }
+    async payment_gateway(externalPaymentId, params, options) {
+        const _externalPaymentId = externalPaymentId.id || externalPaymentId;
+        return this.resources.fetch({ type: 'payment_gateways' }, `external_payments/${_externalPaymentId}/payment_gateway`, params, options);
+    }
+    async wallet(externalPaymentId, params, options) {
+        const _externalPaymentId = externalPaymentId.id || externalPaymentId;
+        return this.resources.fetch({ type: 'customer_payment_sources' }, `external_payments/${_externalPaymentId}/wallet`, params, options);
+    }
+    isExternalPayment(resource) {
+        return resource.type && (resource.type === ExternalPayments.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: ExternalPayments.TYPE } : { id: id.id, type: ExternalPayments.TYPE };
+    }
+    type() {
+        return ExternalPayments.TYPE;
+    }
+}
+ExternalPayments.TYPE = 'external_payments';
+exports.default = ExternalPayments;

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

@@ -0,0 +1,91 @@
+import { ApiResource, 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 { Attachment } from './attachments';
+import type { Event } from './events';
+type ExternalPromotionType = 'external_promotions';
+type ExternalPromotionRel = ResourceRel & {
+    type: ExternalPromotionType;
+};
+type MarketRel = ResourceRel & {
+    type: MarketType;
+};
+type PromotionRuleRel = ResourceRel & {
+    type: PromotionRuleType;
+};
+type OrderAmountPromotionRuleRel = ResourceRel & {
+    type: OrderAmountPromotionRuleType;
+};
+type SkuListPromotionRuleRel = ResourceRel & {
+    type: SkuListPromotionRuleType;
+};
+type CouponCodesPromotionRuleRel = ResourceRel & {
+    type: CouponCodesPromotionRuleType;
+};
+interface ExternalPromotion extends Resource {
+    readonly type: ExternalPromotionType;
+    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;
+    attachments?: Attachment[];
+    events?: Event[];
+}
+interface ExternalPromotionCreate extends ResourceCreate {
+    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;
+}
+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;
+}
+declare class ExternalPromotions extends ApiResource<ExternalPromotion> {
+    static readonly TYPE: ExternalPromotionType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ExternalPromotion>>;
+    create(resource: ExternalPromotionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPromotion>;
+    update(resource: ExternalPromotionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalPromotion>;
+    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>;
+    coupon_codes_promotion_rule(externalPromotionId: string | ExternalPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
+    attachments(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(externalPromotionId: string | ExternalPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isExternalPromotion(resource: any): resource is ExternalPromotion;
+    relationship(id: string | ResourceId | null): ExternalPromotionRel;
+    type(): ExternalPromotionType;
+}
+export default ExternalPromotions;
+export type { ExternalPromotion, ExternalPromotionCreate, ExternalPromotionUpdate, ExternalPromotionType };

package/lib/cjs/resources/external_promotions.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class ExternalPromotions extends resource_1.ApiResource {
+    // static readonly PATH = 'external_promotions'
+    async list(params, options) {
+        return this.resources.list({ type: ExternalPromotions.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ExternalPromotions.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ExternalPromotions.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: ExternalPromotions.TYPE } : id, options);
+    }
+    async market(externalPromotionId, params, options) {
+        const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+        return this.resources.fetch({ type: 'markets' }, `external_promotions/${_externalPromotionId}/market`, params, options);
+    }
+    async order_amount_promotion_rule(externalPromotionId, params, options) {
+        const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+        return this.resources.fetch({ type: 'order_amount_promotion_rules' }, `external_promotions/${_externalPromotionId}/order_amount_promotion_rule`, params, options);
+    }
+    async sku_list_promotion_rule(externalPromotionId, params, options) {
+        const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+        return this.resources.fetch({ type: 'sku_list_promotion_rules' }, `external_promotions/${_externalPromotionId}/sku_list_promotion_rule`, params, options);
+    }
+    async coupon_codes_promotion_rule(externalPromotionId, params, options) {
+        const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+        return this.resources.fetch({ type: 'coupon_codes_promotion_rules' }, `external_promotions/${_externalPromotionId}/coupon_codes_promotion_rule`, params, options);
+    }
+    async attachments(externalPromotionId, params, options) {
+        const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+        return this.resources.fetch({ type: 'attachments' }, `external_promotions/${_externalPromotionId}/attachments`, params, options);
+    }
+    async events(externalPromotionId, params, options) {
+        const _externalPromotionId = externalPromotionId.id || externalPromotionId;
+        return this.resources.fetch({ type: 'events' }, `external_promotions/${_externalPromotionId}/events`, params, options);
+    }
+    isExternalPromotion(resource) {
+        return resource.type && (resource.type === ExternalPromotions.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: ExternalPromotions.TYPE } : { id: id.id, type: ExternalPromotions.TYPE };
+    }
+    type() {
+        return ExternalPromotions.TYPE;
+    }
+}
+ExternalPromotions.TYPE = 'external_promotions';
+exports.default = ExternalPromotions;

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

@@ -0,0 +1,38 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Market } from './markets';
+import type { Attachment } from './attachments';
+type ExternalTaxCalculatorType = 'external_tax_calculators';
+type ExternalTaxCalculatorRel = ResourceRel & {
+    type: ExternalTaxCalculatorType;
+};
+interface ExternalTaxCalculator extends Resource {
+    readonly type: ExternalTaxCalculatorType;
+    name: string;
+    tax_calculator_url: string;
+    shared_secret: string;
+    markets?: Market[];
+    attachments?: Attachment[];
+}
+interface ExternalTaxCalculatorCreate extends ResourceCreate {
+    name: string;
+    tax_calculator_url: string;
+}
+interface ExternalTaxCalculatorUpdate extends ResourceUpdate {
+    name: string;
+    tax_calculator_url: string;
+}
+declare class ExternalTaxCalculators extends ApiResource<ExternalTaxCalculator> {
+    static readonly TYPE: ExternalTaxCalculatorType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ExternalTaxCalculator>>;
+    create(resource: ExternalTaxCalculatorCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalTaxCalculator>;
+    update(resource: ExternalTaxCalculatorUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ExternalTaxCalculator>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    markets(externalTaxCalculatorId: string | ExternalTaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Market>>;
+    attachments(externalTaxCalculatorId: string | ExternalTaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isExternalTaxCalculator(resource: any): resource is ExternalTaxCalculator;
+    relationship(id: string | ResourceId | null): ExternalTaxCalculatorRel;
+    type(): ExternalTaxCalculatorType;
+}
+export default ExternalTaxCalculators;
+export type { ExternalTaxCalculator, ExternalTaxCalculatorCreate, ExternalTaxCalculatorUpdate, ExternalTaxCalculatorType };