@commercelayer/sdk 5.0.0-alpha.4 → 5.0.0-beta.1

package/lib/cjs/resources/manual_gateways.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class ManualGateways extends resource_1.ApiResource {
+    // static readonly PATH = 'manual_gateways'
+    async list(params, options) {
+        return this.resources.list({ type: ManualGateways.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ManualGateways.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ManualGateways.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: ManualGateways.TYPE } : id, options);
+    }
+    async payment_methods(manualGatewayId, params, options) {
+        const _manualGatewayId = manualGatewayId.id || manualGatewayId;
+        return this.resources.fetch({ type: 'payment_methods' }, `manual_gateways/${_manualGatewayId}/payment_methods`, params, options);
+    }
+    isManualGateway(resource) {
+        return resource.type && (resource.type === ManualGateways.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: ManualGateways.TYPE } : { id: id.id, type: ManualGateways.TYPE };
+    }
+    type() {
+        return ManualGateways.TYPE;
+    }
+}
+ManualGateways.TYPE = 'manual_gateways';
+exports.default = ManualGateways;

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

@@ -0,0 +1,42 @@
+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';
+import type { TaxRule, TaxRuleType } from './tax_rules';
+type ManualTaxCalculatorType = 'manual_tax_calculators';
+type ManualTaxCalculatorRel = ResourceRel & {
+    type: ManualTaxCalculatorType;
+};
+type TaxRuleRel = ResourceRel & {
+    type: TaxRuleType;
+};
+interface ManualTaxCalculator extends Resource {
+    readonly type: ManualTaxCalculatorType;
+    name?: string;
+    markets?: Market[];
+    attachments?: Attachment[];
+    tax_rules?: TaxRule[];
+}
+interface ManualTaxCalculatorCreate extends ResourceCreate {
+    name: string;
+    tax_rules?: TaxRuleRel[];
+}
+interface ManualTaxCalculatorUpdate extends ResourceUpdate {
+    name?: string;
+    tax_rules?: TaxRuleRel[];
+}
+declare class ManualTaxCalculators extends ApiResource<ManualTaxCalculator> {
+    static readonly TYPE: ManualTaxCalculatorType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ManualTaxCalculator>>;
+    create(resource: ManualTaxCalculatorCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ManualTaxCalculator>;
+    update(resource: ManualTaxCalculatorUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ManualTaxCalculator>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    markets(manualTaxCalculatorId: string | ManualTaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Market>>;
+    attachments(manualTaxCalculatorId: string | ManualTaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    tax_rules(manualTaxCalculatorId: string | ManualTaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<TaxRule>>;
+    isManualTaxCalculator(resource: any): resource is ManualTaxCalculator;
+    relationship(id: string | ResourceId | null): ManualTaxCalculatorRel;
+    type(): ManualTaxCalculatorType;
+}
+export default ManualTaxCalculators;
+export type { ManualTaxCalculator, ManualTaxCalculatorCreate, ManualTaxCalculatorUpdate, ManualTaxCalculatorType };

package/lib/cjs/resources/manual_tax_calculators.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class ManualTaxCalculators extends resource_1.ApiResource {
+    // static readonly PATH = 'manual_tax_calculators'
+    async list(params, options) {
+        return this.resources.list({ type: ManualTaxCalculators.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ManualTaxCalculators.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ManualTaxCalculators.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: ManualTaxCalculators.TYPE } : id, options);
+    }
+    async markets(manualTaxCalculatorId, params, options) {
+        const _manualTaxCalculatorId = manualTaxCalculatorId.id || manualTaxCalculatorId;
+        return this.resources.fetch({ type: 'markets' }, `manual_tax_calculators/${_manualTaxCalculatorId}/markets`, params, options);
+    }
+    async attachments(manualTaxCalculatorId, params, options) {
+        const _manualTaxCalculatorId = manualTaxCalculatorId.id || manualTaxCalculatorId;
+        return this.resources.fetch({ type: 'attachments' }, `manual_tax_calculators/${_manualTaxCalculatorId}/attachments`, params, options);
+    }
+    async tax_rules(manualTaxCalculatorId, params, options) {
+        const _manualTaxCalculatorId = manualTaxCalculatorId.id || manualTaxCalculatorId;
+        return this.resources.fetch({ type: 'tax_rules' }, `manual_tax_calculators/${_manualTaxCalculatorId}/tax_rules`, params, options);
+    }
+    isManualTaxCalculator(resource) {
+        return resource.type && (resource.type === ManualTaxCalculators.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: ManualTaxCalculators.TYPE } : { id: id.id, type: ManualTaxCalculators.TYPE };
+    }
+    type() {
+        return ManualTaxCalculators.TYPE;
+    }
+}
+ManualTaxCalculators.TYPE = 'manual_tax_calculators';
+exports.default = ManualTaxCalculators;

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

@@ -0,0 +1,89 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Merchant, MerchantType } from './merchants';
+import type { PriceList, PriceListType } from './price_lists';
+import type { InventoryModel, InventoryModelType } from './inventory_models';
+import type { TaxCalculator, TaxCalculatorType } from './tax_calculators';
+import type { CustomerGroup, CustomerGroupType } from './customer_groups';
+import type { Attachment } from './attachments';
+type MarketType = 'markets';
+type MarketRel = ResourceRel & {
+    type: MarketType;
+};
+type MerchantRel = ResourceRel & {
+    type: MerchantType;
+};
+type PriceListRel = ResourceRel & {
+    type: PriceListType;
+};
+type InventoryModelRel = ResourceRel & {
+    type: InventoryModelType;
+};
+type TaxCalculatorRel = ResourceRel & {
+    type: TaxCalculatorType;
+};
+type CustomerGroupRel = ResourceRel & {
+    type: CustomerGroupType;
+};
+interface Market extends Resource {
+    readonly type: MarketType;
+    number?: number;
+    name?: string;
+    facebook_pixel_id?: string;
+    checkout_url?: string;
+    external_prices_url?: string;
+    external_order_validation_url?: string;
+    shared_secret?: string;
+    private?: boolean;
+    disabled_at?: string;
+    merchant?: Merchant;
+    price_list?: PriceList;
+    inventory_model?: InventoryModel;
+    tax_calculator?: TaxCalculator;
+    customer_group?: CustomerGroup;
+    attachments?: Attachment[];
+}
+interface MarketCreate extends ResourceCreate {
+    name: string;
+    facebook_pixel_id?: string;
+    checkout_url?: string;
+    external_prices_url?: string;
+    external_order_validation_url?: string;
+    merchant: MerchantRel;
+    price_list: PriceListRel;
+    inventory_model: InventoryModelRel;
+    tax_calculator?: TaxCalculatorRel;
+    customer_group?: CustomerGroupRel;
+}
+interface MarketUpdate extends ResourceUpdate {
+    name?: string;
+    facebook_pixel_id?: string;
+    checkout_url?: string;
+    external_prices_url?: string;
+    external_order_validation_url?: string;
+    _disable?: boolean;
+    _enable?: boolean;
+    merchant?: MerchantRel;
+    price_list?: PriceListRel;
+    inventory_model?: InventoryModelRel;
+    tax_calculator?: TaxCalculatorRel;
+    customer_group?: CustomerGroupRel;
+}
+declare class Markets extends ApiResource<Market> {
+    static readonly TYPE: MarketType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Market>>;
+    create(resource: MarketCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
+    update(resource: MarketUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    merchant(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Merchant>;
+    price_list(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PriceList>;
+    inventory_model(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<InventoryModel>;
+    tax_calculator(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<TaxCalculator>;
+    customer_group(marketId: string | Market, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomerGroup>;
+    attachments(marketId: string | Market, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isMarket(resource: any): resource is Market;
+    relationship(id: string | ResourceId | null): MarketRel;
+    type(): MarketType;
+}
+export default Markets;
+export type { Market, MarketCreate, MarketUpdate, MarketType };

package/lib/cjs/resources/markets.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Markets extends resource_1.ApiResource {
+    // static readonly PATH = 'markets'
+    async list(params, options) {
+        return this.resources.list({ type: Markets.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Markets.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Markets.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Markets.TYPE } : id, options);
+    }
+    async merchant(marketId, params, options) {
+        const _marketId = marketId.id || marketId;
+        return this.resources.fetch({ type: 'merchants' }, `markets/${_marketId}/merchant`, params, options);
+    }
+    async price_list(marketId, params, options) {
+        const _marketId = marketId.id || marketId;
+        return this.resources.fetch({ type: 'price_lists' }, `markets/${_marketId}/price_list`, params, options);
+    }
+    async inventory_model(marketId, params, options) {
+        const _marketId = marketId.id || marketId;
+        return this.resources.fetch({ type: 'inventory_models' }, `markets/${_marketId}/inventory_model`, params, options);
+    }
+    async tax_calculator(marketId, params, options) {
+        const _marketId = marketId.id || marketId;
+        return this.resources.fetch({ type: 'tax_calculators' }, `markets/${_marketId}/tax_calculator`, params, options);
+    }
+    async customer_group(marketId, params, options) {
+        const _marketId = marketId.id || marketId;
+        return this.resources.fetch({ type: 'customer_groups' }, `markets/${_marketId}/customer_group`, params, options);
+    }
+    async attachments(marketId, params, options) {
+        const _marketId = marketId.id || marketId;
+        return this.resources.fetch({ type: 'attachments' }, `markets/${_marketId}/attachments`, params, options);
+    }
+    isMarket(resource) {
+        return resource.type && (resource.type === Markets.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Markets.TYPE } : { id: id.id, type: Markets.TYPE };
+    }
+    type() {
+        return Markets.TYPE;
+    }
+}
+Markets.TYPE = 'markets';
+exports.default = Markets;

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

@@ -0,0 +1,39 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Address, AddressType } from './addresses';
+import type { Attachment } from './attachments';
+type MerchantType = 'merchants';
+type MerchantRel = ResourceRel & {
+    type: MerchantType;
+};
+type AddressRel = ResourceRel & {
+    type: AddressType;
+};
+interface Merchant extends Resource {
+    readonly type: MerchantType;
+    name?: string;
+    address?: Address;
+    attachments?: Attachment[];
+}
+interface MerchantCreate extends ResourceCreate {
+    name: string;
+    address: AddressRel;
+}
+interface MerchantUpdate extends ResourceUpdate {
+    name?: string;
+    address?: AddressRel;
+}
+declare class Merchants extends ApiResource<Merchant> {
+    static readonly TYPE: MerchantType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Merchant>>;
+    create(resource: MerchantCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Merchant>;
+    update(resource: MerchantUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Merchant>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    address(merchantId: string | Merchant, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    attachments(merchantId: string | Merchant, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isMerchant(resource: any): resource is Merchant;
+    relationship(id: string | ResourceId | null): MerchantRel;
+    type(): MerchantType;
+}
+export default Merchants;
+export type { Merchant, MerchantCreate, MerchantUpdate, MerchantType };

package/lib/cjs/resources/merchants.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Merchants extends resource_1.ApiResource {
+    // static readonly PATH = 'merchants'
+    async list(params, options) {
+        return this.resources.list({ type: Merchants.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Merchants.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Merchants.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Merchants.TYPE } : id, options);
+    }
+    async address(merchantId, params, options) {
+        const _merchantId = merchantId.id || merchantId;
+        return this.resources.fetch({ type: 'addresses' }, `merchants/${_merchantId}/address`, params, options);
+    }
+    async attachments(merchantId, params, options) {
+        const _merchantId = merchantId.id || merchantId;
+        return this.resources.fetch({ type: 'attachments' }, `merchants/${_merchantId}/attachments`, params, options);
+    }
+    isMerchant(resource) {
+        return resource.type && (resource.type === Merchants.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Merchants.TYPE } : { id: id.id, type: Merchants.TYPE };
+    }
+    type() {
+        return Merchants.TYPE;
+    }
+}
+Merchants.TYPE = 'merchants';
+exports.default = Merchants;

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

@@ -0,0 +1,57 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { PercentageDiscountPromotion, PercentageDiscountPromotionType } from './percentage_discount_promotions';
+import type { FreeShippingPromotion, FreeShippingPromotionType } from './free_shipping_promotions';
+import type { FreeGiftPromotion, FreeGiftPromotionType } from './free_gift_promotions';
+import type { FixedPricePromotion, FixedPricePromotionType } from './fixed_price_promotions';
+import type { ExternalPromotion, ExternalPromotionType } from './external_promotions';
+import type { FixedAmountPromotion, FixedAmountPromotionType } from './fixed_amount_promotions';
+type OrderAmountPromotionRuleType = 'order_amount_promotion_rules';
+type OrderAmountPromotionRuleRel = ResourceRel & {
+    type: OrderAmountPromotionRuleType;
+};
+type PercentageDiscountPromotionRel = ResourceRel & {
+    type: PercentageDiscountPromotionType;
+};
+type FreeShippingPromotionRel = ResourceRel & {
+    type: FreeShippingPromotionType;
+};
+type FreeGiftPromotionRel = ResourceRel & {
+    type: FreeGiftPromotionType;
+};
+type FixedPricePromotionRel = ResourceRel & {
+    type: FixedPricePromotionType;
+};
+type ExternalPromotionRel = ResourceRel & {
+    type: ExternalPromotionType;
+};
+type FixedAmountPromotionRel = ResourceRel & {
+    type: FixedAmountPromotionType;
+};
+interface OrderAmountPromotionRule extends Resource {
+    readonly type: OrderAmountPromotionRuleType;
+    order_amount_cents?: number;
+    order_amount_float?: number;
+    formatted_order_amount?: string;
+    promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion;
+}
+interface OrderAmountPromotionRuleCreate extends ResourceCreate {
+    order_amount_cents?: number;
+    promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
+}
+interface OrderAmountPromotionRuleUpdate extends ResourceUpdate {
+    order_amount_cents?: number;
+    promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
+}
+declare class OrderAmountPromotionRules extends ApiResource<OrderAmountPromotionRule> {
+    static readonly TYPE: OrderAmountPromotionRuleType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderAmountPromotionRule>>;
+    create(resource: OrderAmountPromotionRuleCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
+    update(resource: OrderAmountPromotionRuleUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    isOrderAmountPromotionRule(resource: any): resource is OrderAmountPromotionRule;
+    relationship(id: string | ResourceId | null): OrderAmountPromotionRuleRel;
+    type(): OrderAmountPromotionRuleType;
+}
+export default OrderAmountPromotionRules;
+export type { OrderAmountPromotionRule, OrderAmountPromotionRuleCreate, OrderAmountPromotionRuleUpdate, OrderAmountPromotionRuleType };

package/lib/cjs/resources/order_amount_promotion_rules.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class OrderAmountPromotionRules extends resource_1.ApiResource {
+    // static readonly PATH = 'order_amount_promotion_rules'
+    async list(params, options) {
+        return this.resources.list({ type: OrderAmountPromotionRules.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: OrderAmountPromotionRules.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: OrderAmountPromotionRules.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: OrderAmountPromotionRules.TYPE } : id, options);
+    }
+    isOrderAmountPromotionRule(resource) {
+        return resource.type && (resource.type === OrderAmountPromotionRules.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: OrderAmountPromotionRules.TYPE } : { id: id.id, type: OrderAmountPromotionRules.TYPE };
+    }
+    type() {
+        return OrderAmountPromotionRules.TYPE;
+    }
+}
+OrderAmountPromotionRules.TYPE = 'order_amount_promotion_rules';
+exports.default = OrderAmountPromotionRules;

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

@@ -0,0 +1,49 @@
+import { ApiResource, Resource, ResourceCreate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order, OrderType } from './orders';
+import type { OrderSubscription } from './order_subscriptions';
+import type { Event } from './events';
+type OrderCopyType = 'order_copies';
+type OrderCopyRel = ResourceRel & {
+    type: OrderCopyType;
+};
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+interface OrderCopy extends Resource {
+    readonly type: OrderCopyType;
+    status?: 'pending' | 'in_progress' | 'failed' | 'completed';
+    started_at?: string;
+    completed_at?: string;
+    failed_at?: string;
+    place_target_order?: boolean;
+    cancel_source_order?: boolean;
+    reuse_wallet?: boolean;
+    errors_log?: object;
+    errors_count?: number;
+    source_order?: Order;
+    target_order?: Order;
+    order_subscription?: OrderSubscription;
+    events?: Event[];
+}
+interface OrderCopyCreate extends ResourceCreate {
+    place_target_order?: boolean;
+    cancel_source_order?: boolean;
+    reuse_wallet?: boolean;
+    source_order: OrderRel;
+}
+declare class OrderCopies extends ApiResource<OrderCopy> {
+    static readonly TYPE: OrderCopyType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderCopy>>;
+    create(resource: OrderCopyCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderCopy>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    source_order(orderCopyId: string | OrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    target_order(orderCopyId: string | OrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    order_subscription(orderCopyId: string | OrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
+    events(orderCopyId: string | OrderCopy, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isOrderCopy(resource: any): resource is OrderCopy;
+    relationship(id: string | ResourceId | null): OrderCopyRel;
+    type(): OrderCopyType;
+}
+export default OrderCopies;
+export type { OrderCopy, OrderCopyCreate, OrderCopyType };

package/lib/cjs/resources/order_copies.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class OrderCopies extends resource_1.ApiResource {
+    // static readonly PATH = 'order_copies'
+    async list(params, options) {
+        return this.resources.list({ type: OrderCopies.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: OrderCopies.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: OrderCopies.TYPE } : id, options);
+    }
+    async source_order(orderCopyId, params, options) {
+        const _orderCopyId = orderCopyId.id || orderCopyId;
+        return this.resources.fetch({ type: 'orders' }, `order_copies/${_orderCopyId}/source_order`, params, options);
+    }
+    async target_order(orderCopyId, params, options) {
+        const _orderCopyId = orderCopyId.id || orderCopyId;
+        return this.resources.fetch({ type: 'orders' }, `order_copies/${_orderCopyId}/target_order`, params, options);
+    }
+    async order_subscription(orderCopyId, params, options) {
+        const _orderCopyId = orderCopyId.id || orderCopyId;
+        return this.resources.fetch({ type: 'order_subscriptions' }, `order_copies/${_orderCopyId}/order_subscription`, params, options);
+    }
+    async events(orderCopyId, params, options) {
+        const _orderCopyId = orderCopyId.id || orderCopyId;
+        return this.resources.fetch({ type: 'events' }, `order_copies/${_orderCopyId}/events`, params, options);
+    }
+    isOrderCopy(resource) {
+        return resource.type && (resource.type === OrderCopies.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: OrderCopies.TYPE } : { id: id.id, type: OrderCopies.TYPE };
+    }
+    type() {
+        return OrderCopies.TYPE;
+    }
+}
+OrderCopies.TYPE = 'order_copies';
+exports.default = OrderCopies;

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

@@ -0,0 +1,71 @@
+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 { Order, OrderType } from './orders';
+import type { Customer } from './customers';
+import type { OrderCopy } from './order_copies';
+import type { Event } from './events';
+type OrderSubscriptionType = 'order_subscriptions';
+type OrderSubscriptionRel = ResourceRel & {
+    type: OrderSubscriptionType;
+};
+type MarketRel = ResourceRel & {
+    type: MarketType;
+};
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+interface OrderSubscription extends Resource {
+    readonly type: OrderSubscriptionType;
+    number?: string;
+    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[];
+}
+interface OrderSubscriptionCreate extends ResourceCreate {
+    frequency: string;
+    activate_by_source_order?: boolean;
+    starts_at?: string;
+    expires_at?: string;
+    options?: object;
+    market?: MarketRel;
+    source_order: OrderRel;
+}
+interface OrderSubscriptionUpdate extends ResourceUpdate {
+    expires_at?: string;
+    _activate?: boolean;
+    _deactivate?: boolean;
+    _cancel?: boolean;
+}
+declare class OrderSubscriptions extends ApiResource<OrderSubscription> {
+    static readonly TYPE: OrderSubscriptionType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderSubscription>>;
+    create(resource: OrderSubscriptionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<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>;
+    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>>;
+    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;
+    relationship(id: string | ResourceId | null): OrderSubscriptionRel;
+    type(): OrderSubscriptionType;
+}
+export default OrderSubscriptions;
+export type { OrderSubscription, OrderSubscriptionCreate, OrderSubscriptionUpdate, OrderSubscriptionType };

package/lib/cjs/resources/order_subscriptions.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class OrderSubscriptions extends resource_1.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 update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: OrderSubscriptions.TYPE }), params, options);
+    }
+    async delete(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;
+        return this.resources.fetch({ type: 'markets' }, `order_subscriptions/${_orderSubscriptionId}/market`, 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);
+    }
+    async customer(orderSubscriptionId, params, options) {
+        const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+        return this.resources.fetch({ type: 'customers' }, `order_subscriptions/${_orderSubscriptionId}/customer`, params, options);
+    }
+    async order_copies(orderSubscriptionId, params, options) {
+        const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+        return this.resources.fetch({ type: 'order_copies' }, `order_subscriptions/${_orderSubscriptionId}/order_copies`, params, options);
+    }
+    async orders(orderSubscriptionId, params, options) {
+        const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+        return this.resources.fetch({ type: 'orders' }, `order_subscriptions/${_orderSubscriptionId}/orders`, params, options);
+    }
+    async events(orderSubscriptionId, params, options) {
+        const _orderSubscriptionId = orderSubscriptionId.id || orderSubscriptionId;
+        return this.resources.fetch({ type: 'events' }, `order_subscriptions/${_orderSubscriptionId}/events`, params, options);
+    }
+    isOrderSubscription(resource) {
+        return resource.type && (resource.type === OrderSubscriptions.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: OrderSubscriptions.TYPE } : { id: id.id, type: OrderSubscriptions.TYPE };
+    }
+    type() {
+        return OrderSubscriptions.TYPE;
+    }
+}
+OrderSubscriptions.TYPE = 'order_subscriptions';
+exports.default = OrderSubscriptions;