@commercelayer/sdk 4.41.0 → 4.42.0

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

@@ -1,67 +1,68 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { OrderSubscription } from './order_subscriptions';
-import type { Adjustment } from './adjustments';
-import type { Bundle } from './bundles';
-import type { Sku } from './skus';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import type { QueryParamsRetrieve } from '../query';
+import type { OrderSubscription, OrderSubscriptionType } from './order_subscriptions';
+import type { Adjustment, AdjustmentType } from './adjustments';
+import type { Bundle, BundleType } from './bundles';
+import type { Sku, SkuType } from './skus';
 import type { LineItem } from './line_items';
+type OrderSubscriptionItemType = 'order_subscription_items';
 type OrderSubscriptionItemRel = ResourceRel & {
-    type: typeof OrderSubscriptionItems.TYPE;
+    type: OrderSubscriptionItemType;
 };
 type OrderSubscriptionRel = ResourceRel & {
-    type: 'order_subscriptions';
+    type: OrderSubscriptionType;
 };
 type AdjustmentRel = ResourceRel & {
-    type: 'adjustments';
+    type: AdjustmentType;
 };
 type BundleRel = ResourceRel & {
-    type: 'bundles';
+    type: BundleType;
 };
 type SkuRel = ResourceRel & {
-    type: 'skus';
+    type: SkuType;
 };
 interface OrderSubscriptionItem extends Resource {
-    quantity?: number;
-    unit_amount_cents?: number;
-    unit_amount_float?: number;
-    formatted_unit_amount?: string;
-    total_amount_cents?: number;
-    total_amount_float?: number;
-    formatted_total_amount?: string;
-    order_subscription?: OrderSubscription;
-    item?: Adjustment | Bundle | Sku;
-    sku?: Sku;
-    bundle?: Bundle;
-    source_line_item?: LineItem;
+    readonly type: OrderSubscriptionItemType;
+    quantity: number;
+    unit_amount_cents?: number | null;
+    unit_amount_float?: number | null;
+    formatted_unit_amount?: string | null;
+    total_amount_cents?: number | null;
+    total_amount_float: number;
+    formatted_total_amount?: string | null;
+    order_subscription?: OrderSubscription | null;
+    item?: Adjustment | Bundle | Sku | null;
+    sku?: Sku | null;
+    bundle?: Bundle | null;
+    source_line_item?: LineItem | null;
 }
 interface OrderSubscriptionItemCreate extends ResourceCreate {
-    sku_code?: string;
-    bundle_code?: string;
+    sku_code?: string | null;
+    bundle_code?: string | null;
     quantity: number;
-    unit_amount_cents?: number;
+    unit_amount_cents?: number | null;
     order_subscription: OrderSubscriptionRel;
     item: AdjustmentRel | BundleRel | SkuRel;
-    sku?: SkuRel;
-    bundle?: BundleRel;
+    sku?: SkuRel | null;
+    bundle?: BundleRel | null;
 }
 interface OrderSubscriptionItemUpdate extends ResourceUpdate {
-    sku_code?: string;
-    bundle_code?: string;
-    quantity?: number;
-    unit_amount_cents?: number;
+    sku_code?: string | null;
+    bundle_code?: string | null;
+    quantity?: number | null;
+    unit_amount_cents?: number | null;
 }
-declare class OrderSubscriptionItems extends ApiResource {
-    static readonly TYPE: 'order_subscription_items';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderSubscriptionItem>>;
+declare class OrderSubscriptionItems extends ApiResource<OrderSubscriptionItem> {
+    static readonly TYPE: OrderSubscriptionItemType;
     create(resource: OrderSubscriptionItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscriptionItem>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscriptionItem>;
     update(resource: OrderSubscriptionItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscriptionItem>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     order_subscription(orderSubscriptionItemId: string | OrderSubscriptionItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
     source_line_item(orderSubscriptionItemId: string | OrderSubscriptionItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<LineItem>;
     isOrderSubscriptionItem(resource: any): resource is OrderSubscriptionItem;
     relationship(id: string | ResourceId | null): OrderSubscriptionItemRel;
-    type(): string;
+    type(): OrderSubscriptionItemType;
 }
 export default OrderSubscriptionItems;
-export { OrderSubscriptionItem, OrderSubscriptionItemCreate, OrderSubscriptionItemUpdate };
+export type { OrderSubscriptionItem, OrderSubscriptionItemCreate, OrderSubscriptionItemUpdate, OrderSubscriptionItemType };

package/lib/esm/resources/order_subscription_items.js

@@ -1,20 +1,13 @@
 import { ApiResource } from '../resource';
 class OrderSubscriptionItems extends ApiResource {
-    // static readonly PATH = 'order_subscription_items'
-    async list(params, options) {
-        return this.resources.list({ type: OrderSubscriptionItems.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: OrderSubscriptionItems.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: OrderSubscriptionItems.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: OrderSubscriptionItems.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: OrderSubscriptionItems.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: OrderSubscriptionItems.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: OrderSubscriptionItems.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: OrderSubscriptionItems.TYPE } : id, options);
     }
     async order_subscription(orderSubscriptionItemId, params, options) {
         const _orderSubscriptionItemId = orderSubscriptionItemId.id || orderSubscriptionItemId;
@@ -24,7 +17,6 @@ class OrderSubscriptionItems extends ApiResource {
         const _orderSubscriptionItemId = orderSubscriptionItemId.id || orderSubscriptionItemId;
         return this.resources.fetch({ type: 'line_items' }, `order_subscription_items/${_orderSubscriptionItemId}/source_line_item`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isOrderSubscriptionItem(resource) {
         return resource.type && (resource.type === OrderSubscriptionItems.TYPE);
     }

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

@@ -1,81 +1,82 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Market } from './markets';
+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 { SubscriptionModel } from './subscription_models';
-import type { Order } from './orders';
+import type { Order, OrderType } from './orders';
 import type { Customer } from './customers';
-import type { CustomerPaymentSource } from './customer_payment_sources';
+import type { CustomerPaymentSource, CustomerPaymentSourceType } from './customer_payment_sources';
 import type { OrderSubscriptionItem } from './order_subscription_items';
 import type { OrderFactory } from './order_factories';
 import type { RecurringOrderCopy } from './recurring_order_copies';
 import type { Event } from './events';
 import type { Version } from './versions';
+type OrderSubscriptionType = 'order_subscriptions';
 type OrderSubscriptionRel = ResourceRel & {
-    type: typeof OrderSubscriptions.TYPE;
+    type: OrderSubscriptionType;
 };
 type MarketRel = ResourceRel & {
-    type: 'markets';
+    type: MarketType;
 };
 type OrderRel = ResourceRel & {
-    type: 'orders';
+    type: OrderType;
 };
 type CustomerPaymentSourceRel = ResourceRel & {
-    type: 'customer_payment_sources';
+    type: CustomerPaymentSourceType;
 };
 interface OrderSubscription extends Resource {
-    number?: string;
-    status?: string;
-    frequency?: string;
-    activate_by_source_order?: boolean;
-    customer_email?: string;
-    starts_at?: string;
-    expires_at?: string;
-    next_run_at?: string;
-    occurrencies?: number;
-    errors_count?: number;
-    succeeded_on_last_run?: boolean;
-    options?: object;
-    market?: Market;
-    subscription_model?: SubscriptionModel;
-    source_order?: Order;
-    customer?: Customer;
-    customer_payment_source?: CustomerPaymentSource;
-    order_subscription_items?: OrderSubscriptionItem[];
-    order_factories?: OrderFactory[];
+    readonly type: OrderSubscriptionType;
+    number?: string | null;
+    status: 'draft' | 'inactive' | 'active' | 'cancelled';
+    frequency: string;
+    activate_by_source_order?: boolean | null;
+    customer_email?: string | null;
+    starts_at?: string | null;
+    expires_at?: string | null;
+    next_run_at?: string | null;
+    occurrencies?: number | null;
+    errors_count?: number | null;
+    succeeded_on_last_run?: boolean | null;
+    options?: Record<string, any> | null;
+    market?: Market | null;
+    subscription_model?: SubscriptionModel | null;
+    source_order?: Order | null;
+    customer?: Customer | null;
+    customer_payment_source?: CustomerPaymentSource | null;
+    order_subscription_items?: OrderSubscriptionItem[] | null;
+    order_factories?: OrderFactory[] | null;
     /**
     * @deprecated This field should not be used as it may be removed in the future without notice
     */
     order_copies?: object[];
-    recurring_order_copies?: RecurringOrderCopy[];
-    orders?: Order[];
-    events?: Event[];
-    versions?: Version[];
+    recurring_order_copies?: RecurringOrderCopy[] | null;
+    orders?: Order[] | null;
+    events?: Event[] | null;
+    versions?: Version[] | null;
 }
 interface OrderSubscriptionCreate extends ResourceCreate {
     frequency: string;
-    activate_by_source_order?: boolean;
-    starts_at?: string;
-    expires_at?: string;
-    options?: object;
-    market?: MarketRel;
+    activate_by_source_order?: boolean | null;
+    starts_at?: string | null;
+    expires_at?: string | null;
+    options?: Record<string, any> | null;
+    market?: MarketRel | null;
     source_order: OrderRel;
 }
 interface OrderSubscriptionUpdate extends ResourceUpdate {
-    frequency?: string;
-    expires_at?: string;
-    next_run_at?: string;
-    _activate?: boolean;
-    _deactivate?: boolean;
-    _cancel?: boolean;
-    customer_payment_source?: CustomerPaymentSourceRel;
+    frequency?: string | null;
+    expires_at?: string | null;
+    next_run_at?: string | null;
+    _activate?: boolean | null;
+    _deactivate?: boolean | null;
+    _cancel?: boolean | null;
+    customer_payment_source?: CustomerPaymentSourceRel | null;
 }
-declare class OrderSubscriptions extends ApiResource {
-    static readonly TYPE: 'order_subscriptions';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderSubscription>>;
+declare class OrderSubscriptions extends ApiResource<OrderSubscription> {
+    static readonly TYPE: OrderSubscriptionType;
     create(resource: OrderSubscriptionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
     update(resource: OrderSubscriptionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     market(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     subscription_model(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SubscriptionModel>;
     source_order(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
@@ -87,9 +88,12 @@ declare class OrderSubscriptions extends ApiResource {
     orders(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Order>>;
     events(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     versions(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _activate(id: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
+    _deactivate(id: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
+    _cancel(id: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
     isOrderSubscription(resource: any): resource is OrderSubscription;
     relationship(id: string | ResourceId | null): OrderSubscriptionRel;
-    type(): string;
+    type(): OrderSubscriptionType;
 }
 export default OrderSubscriptions;
-export { OrderSubscription, OrderSubscriptionCreate, OrderSubscriptionUpdate };
+export type { OrderSubscription, OrderSubscriptionCreate, OrderSubscriptionUpdate, OrderSubscriptionType };

package/lib/esm/resources/order_subscriptions.js

@@ -1,20 +1,13 @@
 import { ApiResource } from '../resource';
 class OrderSubscriptions extends ApiResource {
-    // static readonly PATH = 'order_subscriptions'
-    async list(params, options) {
-        return this.resources.list({ type: OrderSubscriptions.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: OrderSubscriptions.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: OrderSubscriptions.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: OrderSubscriptions.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: OrderSubscriptions.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: OrderSubscriptions.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: OrderSubscriptions.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: OrderSubscriptions.TYPE } : id, options);
     }
     async market(orderSubscriptionId, params, options) {
         const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
@@ -60,7 +53,15 @@ class OrderSubscriptions extends ApiResource {
         const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
         return this.resources.fetch({ type: 'versions' }, `order_subscriptions/${_orderSubscriptionId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    async _activate(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: OrderSubscriptions.TYPE, _activate: true }, params, options);
+    }
+    async _deactivate(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: OrderSubscriptions.TYPE, _deactivate: true }, params, options);
+    }
+    async _cancel(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: OrderSubscriptions.TYPE, _cancel: true }, params, options);
+    }
     isOrderSubscription(resource) {
         return resource.type && (resource.type === OrderSubscriptions.TYPE);
     }

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

@@ -1,26 +1,27 @@
-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 { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Market } from './markets';
 import type { Attachment } from './attachments';
 import type { Version } from './versions';
+type OrderValidationRuleType = 'order_validation_rules';
 type OrderValidationRuleRel = ResourceRel & {
-    type: typeof OrderValidationRules.TYPE;
+    type: OrderValidationRuleType;
 };
 interface OrderValidationRule extends Resource {
-    market?: Market;
-    attachments?: Attachment[];
-    versions?: Version[];
+    readonly type: OrderValidationRuleType;
+    market?: Market | null;
+    attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
-declare class OrderValidationRules extends ApiResource {
-    static readonly TYPE: 'order_validation_rules';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderValidationRule>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderValidationRule>;
+declare class OrderValidationRules extends ApiResource<OrderValidationRule> {
+    static readonly TYPE: OrderValidationRuleType;
     market(orderValidationRuleId: string | OrderValidationRule, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     attachments(orderValidationRuleId: string | OrderValidationRule, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     versions(orderValidationRuleId: string | OrderValidationRule, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isOrderValidationRule(resource: any): resource is OrderValidationRule;
     relationship(id: string | ResourceId | null): OrderValidationRuleRel;
-    type(): string;
+    type(): OrderValidationRuleType;
 }
 export default OrderValidationRules;
-export { OrderValidationRule };
+export type { OrderValidationRule, OrderValidationRuleType };

package/lib/esm/resources/order_validation_rules.js

@@ -1,12 +1,5 @@
 import { ApiResource } from '../resource';
 class OrderValidationRules extends ApiResource {
-    // static readonly PATH = 'order_validation_rules'
-    async list(params, options) {
-        return this.resources.list({ type: OrderValidationRules.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: OrderValidationRules.TYPE, id }, params, options);
-    }
     async market(orderValidationRuleId, params, options) {
         const _orderValidationRuleId = orderValidationRuleId.id || orderValidationRuleId;
         return this.resources.fetch({ type: 'markets' }, `order_validation_rules/${_orderValidationRuleId}/market`, params, options);
@@ -19,7 +12,6 @@ class OrderValidationRules extends ApiResource {
         const _orderValidationRuleId = orderValidationRuleId.id || orderValidationRuleId;
         return this.resources.fetch({ type: 'versions' }, `order_validation_rules/${_orderValidationRuleId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isOrderValidationRule(resource) {
         return resource.type && (resource.type === OrderValidationRules.TYPE);
     }