@commercelayer/sdk 5.0.0-beta.9 → 5.1.0

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

@@ -0,0 +1,34 @@
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order } from './orders';
+import type { Event } from './events';
+type OrderFactoryType = 'order_factories';
+type OrderFactoryRel = ResourceRel & {
+    type: OrderFactoryType;
+};
+interface OrderFactory extends Resource {
+    readonly type: OrderFactoryType;
+    status: 'pending' | 'in_progress' | 'failed' | 'completed';
+    started_at?: string | null;
+    completed_at?: string | null;
+    failed_at?: string | null;
+    errors_log?: Record<string, any> | null;
+    errors_count?: number | null;
+    place_target_order?: boolean | null;
+    reuse_wallet?: boolean | null;
+    source_order?: Order | null;
+    target_order?: Order | null;
+    events?: Event[] | null;
+}
+declare class OrderFactories extends ApiResource<OrderFactory> {
+    static readonly TYPE: OrderFactoryType;
+    source_order(orderFactoryId: string | OrderFactory, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    target_order(orderFactoryId: string | OrderFactory, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    events(orderFactoryId: string | OrderFactory, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isOrderFactory(resource: any): resource is OrderFactory;
+    relationship(id: string | ResourceId | null): OrderFactoryRel;
+    type(): OrderFactoryType;
+}
+export default OrderFactories;
+export type { OrderFactory, OrderFactoryType };

package/lib/esm/resources/order_factories.js

@@ -0,0 +1,26 @@
+import { ApiResource } from '../resource';
+class OrderFactories extends ApiResource {
+    async source_order(orderFactoryId, params, options) {
+        const _orderFactoryId = orderFactoryId.id || orderFactoryId;
+        return this.resources.fetch({ type: 'orders' }, `order_factories/${_orderFactoryId}/source_order`, params, options);
+    }
+    async target_order(orderFactoryId, params, options) {
+        const _orderFactoryId = orderFactoryId.id || orderFactoryId;
+        return this.resources.fetch({ type: 'orders' }, `order_factories/${_orderFactoryId}/target_order`, params, options);
+    }
+    async events(orderFactoryId, params, options) {
+        const _orderFactoryId = orderFactoryId.id || orderFactoryId;
+        return this.resources.fetch({ type: 'events' }, `order_factories/${_orderFactoryId}/events`, params, options);
+    }
+    isOrderFactory(resource) {
+        return resource.type && (resource.type === OrderFactories.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: OrderFactories.TYPE } : { id: id.id, type: OrderFactories.TYPE };
+    }
+    type() {
+        return OrderFactories.TYPE;
+    }
+}
+OrderFactories.TYPE = 'order_factories';
+export default OrderFactories;

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

@@ -0,0 +1,61 @@
+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';
+type OrderSubscriptionItemType = 'order_subscription_items';
+type OrderSubscriptionItemRel = ResourceRel & {
+    type: OrderSubscriptionItemType;
+};
+type OrderSubscriptionRel = ResourceRel & {
+    type: OrderSubscriptionType;
+};
+type AdjustmentRel = ResourceRel & {
+    type: AdjustmentType;
+};
+type BundleRel = ResourceRel & {
+    type: BundleType;
+};
+type SkuRel = ResourceRel & {
+    type: SkuType;
+};
+interface OrderSubscriptionItem extends Resource {
+    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;
+}
+interface OrderSubscriptionItemCreate extends ResourceCreate {
+    sku_code?: string | null;
+    bundle_code?: string | null;
+    quantity: number;
+    unit_amount_cents?: number | null;
+    order_subscription: OrderSubscriptionRel;
+    item: AdjustmentRel | BundleRel | SkuRel;
+}
+interface OrderSubscriptionItemUpdate extends ResourceUpdate {
+    sku_code?: string | null;
+    bundle_code?: string | null;
+    quantity?: number | null;
+    unit_amount_cents?: number | null;
+}
+declare class OrderSubscriptionItems extends ApiResource<OrderSubscriptionItem> {
+    static readonly TYPE: OrderSubscriptionItemType;
+    create(resource: OrderSubscriptionItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscriptionItem>;
+    update(resource: OrderSubscriptionItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscriptionItem>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    order_subscription(orderSubscriptionItemId: string | OrderSubscriptionItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
+    isOrderSubscriptionItem(resource: any): resource is OrderSubscriptionItem;
+    relationship(id: string | ResourceId | null): OrderSubscriptionItemRel;
+    type(): OrderSubscriptionItemType;
+}
+export default OrderSubscriptionItems;
+export type { OrderSubscriptionItem, OrderSubscriptionItemCreate, OrderSubscriptionItemUpdate, OrderSubscriptionItemType };

package/lib/esm/resources/order_subscription_items.js

@@ -0,0 +1,27 @@
+import { ApiResource } from '../resource';
+class OrderSubscriptionItems extends ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: OrderSubscriptionItems.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: OrderSubscriptionItems.TYPE }, params, options);
+    }
+    async delete(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;
+        return this.resources.fetch({ type: 'order_subscriptions' }, `order_subscription_items/${_orderSubscriptionItemId}/order_subscription`, params, options);
+    }
+    isOrderSubscriptionItem(resource) {
+        return resource.type && (resource.type === OrderSubscriptionItems.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: OrderSubscriptionItems.TYPE } : { id: id.id, type: OrderSubscriptionItems.TYPE };
+    }
+    type() {
+        return OrderSubscriptionItems.TYPE;
+    }
+}
+OrderSubscriptionItems.TYPE = 'order_subscription_items';
+export default OrderSubscriptionItems;

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

@@ -1,9 +1,14 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+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, OrderType } from './orders';
 import type { Customer } from './customers';
-import type { OrderCopy } from './order_copies';
+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';
 type OrderSubscriptionType = 'order_subscriptions';
 type OrderSubscriptionRel = ResourceRel & {
@@ -15,41 +20,55 @@ type MarketRel = ResourceRel & {
 type OrderRel = ResourceRel & {
     type: OrderType;
 };
+type CustomerPaymentSourceRel = ResourceRel & {
+    type: CustomerPaymentSourceType;
+};
 interface OrderSubscription extends Resource {
     readonly type: OrderSubscriptionType;
-    number?: string;
-    status?: 'draft' | 'inactive' | 'active' | 'cancelled';
+    number?: string | null;
+    status: 'draft' | 'inactive' | 'active' | 'cancelled';
     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;
-    source_order?: Order;
-    customer?: Customer;
-    order_copies?: OrderCopy[];
-    orders?: Order[];
-    events?: Event[];
+    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[] | null;
+    orders?: Order[] | null;
+    events?: Event[] | 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 {
-    expires_at?: string;
-    _activate?: boolean;
-    _deactivate?: boolean;
-    _cancel?: boolean;
+    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<OrderSubscription> {
     static readonly TYPE: OrderSubscriptionType;
@@ -57,9 +76,13 @@ declare class OrderSubscriptions extends ApiResource<OrderSubscription> {
     update(resource: OrderSubscriptionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
     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>;
     customer(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
-    order_copies(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderCopy>>;
+    customer_payment_source(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomerPaymentSource>;
+    order_subscription_items(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderSubscriptionItem>>;
+    order_factories(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderFactory>>;
+    recurring_order_copies(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<RecurringOrderCopy>>;
     orders(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Order>>;
     events(orderSubscriptionId: string | OrderSubscription, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     isOrderSubscription(resource: any): resource is OrderSubscription;

package/lib/esm/resources/order_subscriptions.js

@@ -13,6 +13,10 @@ class OrderSubscriptions extends ApiResource {
         const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
         return this.resources.fetch({ type: 'markets' }, `order_subscriptions/${_orderSubscriptionId}/market`, params, options);
     }
+    async subscription_model(orderSubscriptionId, params, options) {
+        const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+        return this.resources.fetch({ type: 'subscription_models' }, `order_subscriptions/${_orderSubscriptionId}/subscription_model`, params, options);
+    }
     async source_order(orderSubscriptionId, params, options) {
         const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
         return this.resources.fetch({ type: 'orders' }, `order_subscriptions/${_orderSubscriptionId}/source_order`, params, options);
@@ -21,9 +25,21 @@ class OrderSubscriptions extends ApiResource {
         const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
         return this.resources.fetch({ type: 'customers' }, `order_subscriptions/${_orderSubscriptionId}/customer`, params, options);
     }
-    async order_copies(orderSubscriptionId, params, options) {
+    async customer_payment_source(orderSubscriptionId, params, options) {
+        const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+        return this.resources.fetch({ type: 'customer_payment_sources' }, `order_subscriptions/${_orderSubscriptionId}/customer_payment_source`, params, options);
+    }
+    async order_subscription_items(orderSubscriptionId, params, options) {
+        const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+        return this.resources.fetch({ type: 'order_subscription_items' }, `order_subscriptions/${_orderSubscriptionId}/order_subscription_items`, params, options);
+    }
+    async order_factories(orderSubscriptionId, params, options) {
+        const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+        return this.resources.fetch({ type: 'order_factories' }, `order_subscriptions/${_orderSubscriptionId}/order_factories`, params, options);
+    }
+    async recurring_order_copies(orderSubscriptionId, params, options) {
         const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
-        return this.resources.fetch({ type: 'order_copies' }, `order_subscriptions/${_orderSubscriptionId}/order_copies`, params, options);
+        return this.resources.fetch({ type: 'recurring_order_copies' }, `order_subscriptions/${_orderSubscriptionId}/recurring_order_copies`, params, options);
     }
     async orders(orderSubscriptionId, params, options) {
         const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+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';
@@ -8,8 +9,8 @@ type OrderValidationRuleRel = ResourceRel & {
 };
 interface OrderValidationRule extends Resource {
     readonly type: OrderValidationRuleType;
-    market?: Market;
-    attachments?: Attachment[];
+    market?: Market | null;
+    attachments?: Attachment[] | null;
 }
 declare class OrderValidationRules extends ApiResource<OrderValidationRule> {
     static readonly TYPE: OrderValidationRuleType;