@commercelayer/sdk 5.0.0-beta.10 → 5.0.0-beta.11

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

@@ -0,0 +1,49 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Price, PriceType } from './prices';
+import type { Attachment } from './attachments';
+import type { Event } from './events';
+type PriceFrequencyTierType = 'price_frequency_tiers';
+type PriceFrequencyTierRel = ResourceRel & {
+    type: PriceFrequencyTierType;
+};
+type PriceRel = ResourceRel & {
+    type: PriceType;
+};
+interface PriceFrequencyTier extends Resource {
+    readonly type: PriceFrequencyTierType;
+    name: string;
+    up_to?: number | null;
+    price_amount_cents: number;
+    price_amount_float?: number | null;
+    formatted_price_amount?: string | null;
+    price?: Price | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+}
+interface PriceFrequencyTierCreate extends ResourceCreate {
+    name: string;
+    up_to?: number | null;
+    price_amount_cents: number;
+    price: PriceRel;
+}
+interface PriceFrequencyTierUpdate extends ResourceUpdate {
+    name?: string | null;
+    up_to?: number | null;
+    price_amount_cents?: number | null;
+    price?: PriceRel | null;
+}
+declare class PriceFrequencyTiers extends ApiResource<PriceFrequencyTier> {
+    static readonly TYPE: PriceFrequencyTierType;
+    create(resource: PriceFrequencyTierCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PriceFrequencyTier>;
+    update(resource: PriceFrequencyTierUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PriceFrequencyTier>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    price(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Price>;
+    attachments(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(priceFrequencyTierId: string | PriceFrequencyTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isPriceFrequencyTier(resource: any): resource is PriceFrequencyTier;
+    relationship(id: string | ResourceId | null): PriceFrequencyTierRel;
+    type(): PriceFrequencyTierType;
+}
+export default PriceFrequencyTiers;
+export type { PriceFrequencyTier, PriceFrequencyTierCreate, PriceFrequencyTierUpdate, PriceFrequencyTierType };

package/lib/esm/resources/price_frequency_tiers.js

@@ -0,0 +1,35 @@
+import { ApiResource } from '../resource';
+class PriceFrequencyTiers extends ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: PriceFrequencyTiers.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: PriceFrequencyTiers.TYPE }, params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: PriceFrequencyTiers.TYPE } : id, options);
+    }
+    async price(priceFrequencyTierId, params, options) {
+        const _priceFrequencyTierId = priceFrequencyTierId.id || priceFrequencyTierId;
+        return this.resources.fetch({ type: 'prices' }, `price_frequency_tiers/${_priceFrequencyTierId}/price`, params, options);
+    }
+    async attachments(priceFrequencyTierId, params, options) {
+        const _priceFrequencyTierId = priceFrequencyTierId.id || priceFrequencyTierId;
+        return this.resources.fetch({ type: 'attachments' }, `price_frequency_tiers/${_priceFrequencyTierId}/attachments`, params, options);
+    }
+    async events(priceFrequencyTierId, params, options) {
+        const _priceFrequencyTierId = priceFrequencyTierId.id || priceFrequencyTierId;
+        return this.resources.fetch({ type: 'events' }, `price_frequency_tiers/${_priceFrequencyTierId}/events`, params, options);
+    }
+    isPriceFrequencyTier(resource) {
+        return resource.type && (resource.type === PriceFrequencyTiers.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: PriceFrequencyTiers.TYPE } : { id: id.id, type: PriceFrequencyTiers.TYPE };
+    }
+    type() {
+        return PriceFrequencyTiers.TYPE;
+    }
+}
+PriceFrequencyTiers.TYPE = 'price_frequency_tiers';
+export default PriceFrequencyTiers;

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

@@ -2,6 +2,7 @@ import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, Reso
 import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Price, PriceType } from './prices';
 import type { Attachment } from './attachments';
+import type { Event } from './events';
 type PriceVolumeTierType = 'price_volume_tiers';
 type PriceVolumeTierRel = ResourceRel & {
     type: PriceVolumeTierType;
@@ -18,6 +19,7 @@ interface PriceVolumeTier extends Resource {
     formatted_price_amount?: string | null;
     price?: Price | null;
     attachments?: Attachment[] | null;
+    events?: Event[] | null;
 }
 interface PriceVolumeTierCreate extends ResourceCreate {
     name: string;
@@ -38,6 +40,7 @@ declare class PriceVolumeTiers extends ApiResource<PriceVolumeTier> {
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     price(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Price>;
     attachments(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     isPriceVolumeTier(resource: any): resource is PriceVolumeTier;
     relationship(id: string | ResourceId | null): PriceVolumeTierRel;
     type(): PriceVolumeTierType;

package/lib/esm/resources/price_volume_tiers.js

@@ -17,6 +17,10 @@ class PriceVolumeTiers extends ApiResource {
         const _priceVolumeTierId = priceVolumeTierId.id || priceVolumeTierId;
         return this.resources.fetch({ type: 'attachments' }, `price_volume_tiers/${_priceVolumeTierId}/attachments`, params, options);
     }
+    async events(priceVolumeTierId, params, options) {
+        const _priceVolumeTierId = priceVolumeTierId.id || priceVolumeTierId;
+        return this.resources.fetch({ type: 'events' }, `price_volume_tiers/${_priceVolumeTierId}/events`, params, options);
+    }
     isPriceVolumeTier(resource) {
         return resource.type && (resource.type === PriceVolumeTiers.TYPE);
     }

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

@@ -4,6 +4,7 @@ import type { PriceList, PriceListType } from './price_lists';
 import type { Sku, SkuType } from './skus';
 import type { PriceTier, PriceTierType } from './price_tiers';
 import type { PriceVolumeTier } from './price_volume_tiers';
+import type { PriceFrequencyTier } from './price_frequency_tiers';
 import type { Attachment } from './attachments';
 type PriceType = 'prices';
 type PriceRel = ResourceRel & {
@@ -32,6 +33,7 @@ interface Price extends Resource {
     sku?: Sku | null;
     price_tiers?: PriceTier[] | null;
     price_volume_tiers?: PriceVolumeTier[] | null;
+    price_frequency_tiers?: PriceFrequencyTier[] | null;
     attachments?: Attachment[] | null;
 }
 interface PriceCreate extends ResourceCreate {
@@ -59,6 +61,7 @@ declare class Prices extends ApiResource<Price> {
     sku(priceId: string | Price, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
     price_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceTier>>;
     price_volume_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceVolumeTier>>;
+    price_frequency_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceFrequencyTier>>;
     attachments(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     isPrice(resource: any): resource is Price;
     relationship(id: string | ResourceId | null): PriceRel;

package/lib/esm/resources/prices.js

@@ -25,6 +25,10 @@ class Prices extends ApiResource {
         const _priceId = priceId.id || priceId;
         return this.resources.fetch({ type: 'price_volume_tiers' }, `prices/${_priceId}/price_volume_tiers`, params, options);
     }
+    async price_frequency_tiers(priceId, params, options) {
+        const _priceId = priceId.id || priceId;
+        return this.resources.fetch({ type: 'price_frequency_tiers' }, `prices/${_priceId}/price_frequency_tiers`, params, options);
+    }
     async attachments(priceId, params, options) {
         const _priceId = priceId.id || priceId;
         return this.resources.fetch({ type: 'attachments' }, `prices/${_priceId}/attachments`, params, options);

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

@@ -6,6 +6,7 @@ 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 { Attachment } from './attachments';
+import type { Event } from './events';
 type PromotionType = 'promotions';
 type PromotionRel = ResourceRel & {
     type: PromotionType;
@@ -25,6 +26,7 @@ interface Promotion extends Resource {
     sku_list_promotion_rule?: SkuListPromotionRule | null;
     coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
     attachments?: Attachment[] | null;
+    events?: Event[] | null;
 }
 declare class Promotions extends ApiResource<Promotion> {
     static readonly TYPE: PromotionType;
@@ -33,6 +35,7 @@ declare class Promotions extends ApiResource<Promotion> {
     sku_list_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
     coupon_codes_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
     attachments(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     isPromotion(resource: any): resource is Promotion;
     relationship(id: string | ResourceId | null): PromotionRel;
     type(): PromotionType;

package/lib/esm/resources/promotions.js

@@ -20,6 +20,10 @@ class Promotions extends ApiResource {
         const _promotionId = promotionId.id || promotionId;
         return this.resources.fetch({ type: 'attachments' }, `promotions/${_promotionId}/attachments`, params, options);
     }
+    async events(promotionId, params, options) {
+        const _promotionId = promotionId.id || promotionId;
+        return this.resources.fetch({ type: 'events' }, `promotions/${_promotionId}/events`, params, options);
+    }
     isPromotion(resource) {
         return resource.type && (resource.type === Promotions.TYPE);
     }

package/lib/esm/resources/recurring_order_copies.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 { Order, OrderType } from './orders';
+import type { Event } from './events';
+import type { OrderSubscription, OrderSubscriptionType } from './order_subscriptions';
+type RecurringOrderCopyType = 'recurring_order_copies';
+type RecurringOrderCopyRel = ResourceRel & {
+    type: RecurringOrderCopyType;
+};
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+type OrderSubscriptionRel = ResourceRel & {
+    type: OrderSubscriptionType;
+};
+interface RecurringOrderCopy extends Resource {
+    readonly type: RecurringOrderCopyType;
+    status?: string | null;
+    started_at?: string | null;
+    completed_at?: string | null;
+    failed_at?: string | null;
+    errors_log?: object | 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;
+    order_subscription?: OrderSubscription | null;
+}
+interface RecurringOrderCopyCreate extends ResourceCreate {
+    place_target_order?: boolean | null;
+    reuse_wallet?: boolean | null;
+    source_order: OrderRel;
+    order_subscription: OrderSubscriptionRel;
+}
+type RecurringOrderCopyUpdate = ResourceUpdate;
+declare class RecurringOrderCopies extends ApiResource<RecurringOrderCopy> {
+    static readonly TYPE: RecurringOrderCopyType;
+    create(resource: RecurringOrderCopyCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<RecurringOrderCopy>;
+    update(resource: RecurringOrderCopyUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<RecurringOrderCopy>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    source_order(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    target_order(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    events(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    order_subscription(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
+    isRecurringOrderCopy(resource: any): resource is RecurringOrderCopy;
+    relationship(id: string | ResourceId | null): RecurringOrderCopyRel;
+    type(): RecurringOrderCopyType;
+}
+export default RecurringOrderCopies;
+export type { RecurringOrderCopy, RecurringOrderCopyCreate, RecurringOrderCopyUpdate, RecurringOrderCopyType };

package/lib/esm/resources/recurring_order_copies.js

@@ -0,0 +1,39 @@
+import { ApiResource } from '../resource';
+class RecurringOrderCopies extends ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: RecurringOrderCopies.TYPE } : id, options);
+    }
+    async source_order(recurringOrderCopyId, params, options) {
+        const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
+        return this.resources.fetch({ type: 'orders' }, `recurring_order_copies/${_recurringOrderCopyId}/source_order`, params, options);
+    }
+    async target_order(recurringOrderCopyId, params, options) {
+        const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
+        return this.resources.fetch({ type: 'orders' }, `recurring_order_copies/${_recurringOrderCopyId}/target_order`, params, options);
+    }
+    async events(recurringOrderCopyId, params, options) {
+        const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
+        return this.resources.fetch({ type: 'events' }, `recurring_order_copies/${_recurringOrderCopyId}/events`, params, options);
+    }
+    async order_subscription(recurringOrderCopyId, params, options) {
+        const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
+        return this.resources.fetch({ type: 'order_subscriptions' }, `recurring_order_copies/${_recurringOrderCopyId}/order_subscription`, params, options);
+    }
+    isRecurringOrderCopy(resource) {
+        return resource.type && (resource.type === RecurringOrderCopies.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: RecurringOrderCopies.TYPE } : { id: id.id, type: RecurringOrderCopies.TYPE };
+    }
+    type() {
+        return RecurringOrderCopies.TYPE;
+    }
+}
+RecurringOrderCopies.TYPE = 'recurring_order_copies';
+export default RecurringOrderCopies;

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

@@ -0,0 +1,48 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Market } from './markets';
+import type { OrderSubscription } from './order_subscriptions';
+import type { Attachment } from './attachments';
+type SubscriptionModelType = 'subscription_models';
+type SubscriptionModelRel = ResourceRel & {
+    type: SubscriptionModelType;
+};
+interface SubscriptionModel extends Resource {
+    readonly type: SubscriptionModelType;
+    name: string;
+    strategy?: string | null;
+    frequencies: string[];
+    auto_activate?: boolean | null;
+    auto_cancel?: boolean | null;
+    markets?: Market[] | null;
+    order_subscriptions?: OrderSubscription[] | null;
+    attachments?: Attachment[] | null;
+}
+interface SubscriptionModelCreate extends ResourceCreate {
+    name: string;
+    strategy?: string | null;
+    frequencies: string[];
+    auto_activate?: boolean | null;
+    auto_cancel?: boolean | null;
+}
+interface SubscriptionModelUpdate extends ResourceUpdate {
+    name?: string | null;
+    strategy?: string | null;
+    frequencies?: string[] | null;
+    auto_activate?: boolean | null;
+    auto_cancel?: boolean | null;
+}
+declare class SubscriptionModels extends ApiResource<SubscriptionModel> {
+    static readonly TYPE: SubscriptionModelType;
+    create(resource: SubscriptionModelCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SubscriptionModel>;
+    update(resource: SubscriptionModelUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SubscriptionModel>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    markets(subscriptionModelId: string | SubscriptionModel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Market>>;
+    order_subscriptions(subscriptionModelId: string | SubscriptionModel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderSubscription>>;
+    attachments(subscriptionModelId: string | SubscriptionModel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isSubscriptionModel(resource: any): resource is SubscriptionModel;
+    relationship(id: string | ResourceId | null): SubscriptionModelRel;
+    type(): SubscriptionModelType;
+}
+export default SubscriptionModels;
+export type { SubscriptionModel, SubscriptionModelCreate, SubscriptionModelUpdate, SubscriptionModelType };

package/lib/esm/resources/subscription_models.js

@@ -0,0 +1,35 @@
+import { ApiResource } from '../resource';
+class SubscriptionModels extends ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: SubscriptionModels.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: SubscriptionModels.TYPE }, params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: SubscriptionModels.TYPE } : id, options);
+    }
+    async markets(subscriptionModelId, params, options) {
+        const _subscriptionModelId = subscriptionModelId.id || subscriptionModelId;
+        return this.resources.fetch({ type: 'markets' }, `subscription_models/${_subscriptionModelId}/markets`, params, options);
+    }
+    async order_subscriptions(subscriptionModelId, params, options) {
+        const _subscriptionModelId = subscriptionModelId.id || subscriptionModelId;
+        return this.resources.fetch({ type: 'order_subscriptions' }, `subscription_models/${_subscriptionModelId}/order_subscriptions`, params, options);
+    }
+    async attachments(subscriptionModelId, params, options) {
+        const _subscriptionModelId = subscriptionModelId.id || subscriptionModelId;
+        return this.resources.fetch({ type: 'attachments' }, `subscription_models/${_subscriptionModelId}/attachments`, params, options);
+    }
+    isSubscriptionModel(resource) {
+        return resource.type && (resource.type === SubscriptionModels.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: SubscriptionModels.TYPE } : { id: id.id, type: SubscriptionModels.TYPE };
+    }
+    type() {
+        return SubscriptionModels.TYPE;
+    }
+}
+SubscriptionModels.TYPE = 'subscription_models';
+export default SubscriptionModels;