@commercelayer/sdk 5.0.0-beta.9 → 5.1.0

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

@@ -1,4 +1,5 @@
-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 { Customer, CustomerType } from './customers';
 import type { Sku } from './skus';
@@ -16,31 +17,31 @@ interface SkuList extends Resource {
     readonly type: SkuListType;
     name: string;
     slug: string;
-    description?: string;
-    image_url?: string;
-    manual?: boolean;
-    sku_code_regex?: string;
-    customer?: Customer;
-    skus?: Sku[];
-    sku_list_items?: SkuListItem[];
-    bundles?: Bundle[];
-    attachments?: Attachment[];
+    description?: string | null;
+    image_url?: string | null;
+    manual?: boolean | null;
+    sku_code_regex?: string | null;
+    customer?: Customer | null;
+    skus?: Sku[] | null;
+    sku_list_items?: SkuListItem[] | null;
+    bundles?: Bundle[] | null;
+    attachments?: Attachment[] | null;
 }
 interface SkuListCreate extends ResourceCreate {
     name: string;
-    description?: string;
-    image_url?: string;
-    manual?: boolean;
-    sku_code_regex?: string;
-    customer?: CustomerRel;
+    description?: string | null;
+    image_url?: string | null;
+    manual?: boolean | null;
+    sku_code_regex?: string | null;
+    customer?: CustomerRel | null;
 }
 interface SkuListUpdate extends ResourceUpdate {
-    name: string;
-    description?: string;
-    image_url?: string;
-    manual?: boolean;
-    sku_code_regex?: string;
-    customer?: CustomerRel;
+    name?: string | null;
+    description?: string | null;
+    image_url?: string | null;
+    manual?: boolean | null;
+    sku_code_regex?: string | null;
+    customer?: CustomerRel | null;
 }
 declare class SkuLists extends ApiResource<SkuList> {
     static readonly TYPE: SkuListType;

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

@@ -1,7 +1,10 @@
-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 { Attachment } from './attachments';
+import type { Event } from './events';
+import type { Tag, TagType } from './tags';
 type SkuOptionType = 'sku_options';
 type SkuOptionRel = ResourceRel & {
     type: SkuOptionType;
@@ -9,37 +12,44 @@ type SkuOptionRel = ResourceRel & {
 type MarketRel = ResourceRel & {
     type: MarketType;
 };
+type TagRel = ResourceRel & {
+    type: TagType;
+};
 interface SkuOption extends Resource {
     readonly type: SkuOptionType;
     name: string;
-    currency_code?: string;
-    description?: string;
-    price_amount_cents?: number;
-    price_amount_float?: number;
-    formatted_price_amount?: string;
-    delay_hours?: number;
-    delay_days?: number;
-    sku_code_regex?: string;
-    market?: Market;
-    attachments?: Attachment[];
+    currency_code?: string | null;
+    description?: string | null;
+    price_amount_cents?: number | null;
+    price_amount_float?: number | null;
+    formatted_price_amount?: string | null;
+    delay_hours?: number | null;
+    delay_days?: number | null;
+    sku_code_regex?: string | null;
+    market?: Market | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
 }
 interface SkuOptionCreate extends ResourceCreate {
     name: string;
-    currency_code?: string;
-    description?: string;
-    price_amount_cents?: number;
-    delay_hours?: number;
-    sku_code_regex?: string;
-    market?: MarketRel;
+    currency_code?: string | null;
+    description?: string | null;
+    price_amount_cents?: number | null;
+    delay_hours?: number | null;
+    sku_code_regex?: string | null;
+    market?: MarketRel | null;
+    tags?: TagRel[] | null;
 }
 interface SkuOptionUpdate extends ResourceUpdate {
-    name: string;
-    currency_code?: string;
-    description?: string;
-    price_amount_cents?: number;
-    delay_hours?: number;
-    sku_code_regex?: string;
-    market?: MarketRel;
+    name?: string | null;
+    currency_code?: string | null;
+    description?: string | null;
+    price_amount_cents?: number | null;
+    delay_hours?: number | null;
+    sku_code_regex?: string | null;
+    market?: MarketRel | null;
+    tags?: TagRel[] | null;
 }
 declare class SkuOptions extends ApiResource<SkuOption> {
     static readonly TYPE: SkuOptionType;
@@ -48,6 +58,8 @@ declare class SkuOptions extends ApiResource<SkuOption> {
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     market(skuOptionId: string | SkuOption, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     attachments(skuOptionId: string | SkuOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(skuOptionId: string | SkuOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    tags(skuOptionId: string | SkuOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     isSkuOption(resource: any): resource is SkuOption;
     relationship(id: string | ResourceId | null): SkuOptionRel;
     type(): SkuOptionType;

package/lib/cjs/resources/sku_options.js

@@ -19,6 +19,14 @@ class SkuOptions extends resource_1.ApiResource {
         const _skuOptionId = skuOptionId.id || skuOptionId;
         return this.resources.fetch({ type: 'attachments' }, `sku_options/${_skuOptionId}/attachments`, params, options);
     }
+    async events(skuOptionId, params, options) {
+        const _skuOptionId = skuOptionId.id || skuOptionId;
+        return this.resources.fetch({ type: 'events' }, `sku_options/${_skuOptionId}/events`, params, options);
+    }
+    async tags(skuOptionId, params, options) {
+        const _skuOptionId = skuOptionId.id || skuOptionId;
+        return this.resources.fetch({ type: 'tags' }, `sku_options/${_skuOptionId}/tags`, params, options);
+    }
     isSkuOption(resource) {
         return resource.type && (resource.type === SkuOptions.TYPE);
     }

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

@@ -1,4 +1,5 @@
-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 { ShippingCategory, ShippingCategoryType } from './shipping_categories';
 import type { Price } from './prices';
@@ -6,6 +7,8 @@ import type { StockItem } from './stock_items';
 import type { DeliveryLeadTime } from './delivery_lead_times';
 import type { SkuOption } from './sku_options';
 import type { Attachment } from './attachments';
+import type { Event } from './events';
+import type { Tag, TagType } from './tags';
 type SkuType = 'skus';
 type SkuRel = ResourceRel & {
     type: SkuType;
@@ -13,51 +16,58 @@ type SkuRel = ResourceRel & {
 type ShippingCategoryRel = ResourceRel & {
     type: ShippingCategoryType;
 };
+type TagRel = ResourceRel & {
+    type: TagType;
+};
 interface Sku extends Resource {
     readonly type: SkuType;
     code: string;
     name: string;
-    description?: string;
-    image_url?: string;
-    pieces_per_pack?: number;
-    weight?: number;
-    unit_of_weight?: string;
-    hs_tariff_number?: string;
-    do_not_ship?: boolean;
-    do_not_track?: boolean;
-    inventory?: object;
-    shipping_category?: ShippingCategory;
-    prices?: Price[];
-    stock_items?: StockItem[];
-    delivery_lead_times?: DeliveryLeadTime[];
-    sku_options?: SkuOption[];
-    attachments?: Attachment[];
+    description?: string | null;
+    image_url?: string | null;
+    pieces_per_pack?: number | null;
+    weight?: number | null;
+    unit_of_weight?: string | null;
+    hs_tariff_number?: string | null;
+    do_not_ship?: boolean | null;
+    do_not_track?: boolean | null;
+    inventory?: Record<string, any> | null;
+    shipping_category?: ShippingCategory | null;
+    prices?: Price[] | null;
+    stock_items?: StockItem[] | null;
+    delivery_lead_times?: DeliveryLeadTime[] | null;
+    sku_options?: SkuOption[] | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
 }
 interface SkuCreate extends ResourceCreate {
     code: string;
     name: string;
-    description?: string;
-    image_url?: string;
-    pieces_per_pack?: number;
-    weight?: number;
-    unit_of_weight?: string;
-    hs_tariff_number?: string;
-    do_not_ship?: boolean;
-    do_not_track?: boolean;
+    description?: string | null;
+    image_url?: string | null;
+    pieces_per_pack?: number | null;
+    weight?: number | null;
+    unit_of_weight?: string | null;
+    hs_tariff_number?: string | null;
+    do_not_ship?: boolean | null;
+    do_not_track?: boolean | null;
     shipping_category: ShippingCategoryRel;
+    tags?: TagRel[] | null;
 }
 interface SkuUpdate extends ResourceUpdate {
-    code: string;
-    name: string;
-    description?: string;
-    image_url?: string;
-    pieces_per_pack?: number;
-    weight?: number;
-    unit_of_weight?: string;
-    hs_tariff_number?: string;
-    do_not_ship?: boolean;
-    do_not_track?: boolean;
-    shipping_category?: ShippingCategoryRel;
+    code?: string | null;
+    name?: string | null;
+    description?: string | null;
+    image_url?: string | null;
+    pieces_per_pack?: number | null;
+    weight?: number | null;
+    unit_of_weight?: string | null;
+    hs_tariff_number?: string | null;
+    do_not_ship?: boolean | null;
+    do_not_track?: boolean | null;
+    shipping_category?: ShippingCategoryRel | null;
+    tags?: TagRel[] | null;
 }
 declare class Skus extends ApiResource<Sku> {
     static readonly TYPE: SkuType;
@@ -70,6 +80,8 @@ declare class Skus extends ApiResource<Sku> {
     delivery_lead_times(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<DeliveryLeadTime>>;
     sku_options(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SkuOption>>;
     attachments(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    tags(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     isSku(resource: any): resource is Sku;
     relationship(id: string | ResourceId | null): SkuRel;
     type(): SkuType;

package/lib/cjs/resources/skus.js

@@ -35,6 +35,14 @@ class Skus extends resource_1.ApiResource {
         const _skuId = skuId.id || skuId;
         return this.resources.fetch({ type: 'attachments' }, `skus/${_skuId}/attachments`, params, options);
     }
+    async events(skuId, params, options) {
+        const _skuId = skuId.id || skuId;
+        return this.resources.fetch({ type: 'events' }, `skus/${_skuId}/events`, params, options);
+    }
+    async tags(skuId, params, options) {
+        const _skuId = skuId.id || skuId;
+        return this.resources.fetch({ type: 'tags' }, `skus/${_skuId}/tags`, params, options);
+    }
     isSku(resource) {
         return resource.type && (resource.type === Skus.TYPE);
     }

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

@@ -1,4 +1,5 @@
-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 { StockLocation, StockLocationType } from './stock_locations';
 import type { Sku, SkuType } from './skus';
@@ -15,23 +16,23 @@ type SkuRel = ResourceRel & {
 };
 interface StockItem extends Resource {
     readonly type: StockItemType;
-    sku_code?: string;
+    sku_code?: string | null;
     quantity: number;
-    stock_location?: StockLocation;
-    sku?: Sku;
-    attachments?: Attachment[];
+    stock_location?: StockLocation | null;
+    sku?: Sku | null;
+    attachments?: Attachment[] | null;
 }
 interface StockItemCreate extends ResourceCreate {
-    sku_code?: string;
+    sku_code?: string | null;
     quantity: number;
     stock_location: StockLocationRel;
-    sku?: SkuRel;
+    sku?: SkuRel | null;
 }
 interface StockItemUpdate extends ResourceUpdate {
-    sku_code?: string;
-    quantity: number;
-    stock_location?: StockLocationRel;
-    sku?: SkuRel;
+    sku_code?: string | null;
+    quantity?: number | null;
+    stock_location?: StockLocationRel | null;
+    sku?: SkuRel | null;
 }
 declare class StockItems extends ApiResource<StockItem> {
     static readonly TYPE: StockItemType;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
 import type { QueryParamsRetrieve } from '../query';
 import type { Shipment } from './shipments';
 import type { LineItem } from './line_items';
@@ -9,12 +10,12 @@ type StockLineItemRel = ResourceRel & {
 };
 interface StockLineItem extends Resource {
     readonly type: StockLineItemType;
-    sku_code?: string;
-    bundle_code?: string;
+    sku_code?: string | null;
+    bundle_code?: string | null;
     quantity: number;
-    shipment?: Shipment;
-    line_item?: LineItem;
-    stock_item?: StockItem;
+    shipment?: Shipment | null;
+    line_item?: LineItem | null;
+    stock_item?: StockItem | null;
 }
 declare class StockLineItems extends ApiResource<StockLineItem> {
     static readonly TYPE: StockLineItemType;

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

@@ -1,4 +1,5 @@
-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 { Address, AddressType } from './addresses';
 import type { InventoryStockLocation } from './inventory_stock_locations';
@@ -15,28 +16,28 @@ type AddressRel = ResourceRel & {
 };
 interface StockLocation extends Resource {
     readonly type: StockLocationType;
-    number?: number;
+    number?: number | null;
     name: string;
-    label_format?: string;
-    suppress_etd?: boolean;
-    address?: Address;
-    inventory_stock_locations?: InventoryStockLocation[];
-    inventory_return_locations?: InventoryReturnLocation[];
-    stock_items?: StockItem[];
-    stock_transfers?: StockTransfer[];
-    attachments?: Attachment[];
+    label_format?: string | null;
+    suppress_etd?: boolean | null;
+    address?: Address | null;
+    inventory_stock_locations?: InventoryStockLocation[] | null;
+    inventory_return_locations?: InventoryReturnLocation[] | null;
+    stock_items?: StockItem[] | null;
+    stock_transfers?: StockTransfer[] | null;
+    attachments?: Attachment[] | null;
 }
 interface StockLocationCreate extends ResourceCreate {
     name: string;
-    label_format?: string;
-    suppress_etd?: boolean;
+    label_format?: string | null;
+    suppress_etd?: boolean | null;
     address: AddressRel;
 }
 interface StockLocationUpdate extends ResourceUpdate {
-    name: string;
-    label_format?: string;
-    suppress_etd?: boolean;
-    address?: AddressRel;
+    name?: string | null;
+    label_format?: string | null;
+    suppress_etd?: boolean | null;
+    address?: AddressRel | null;
 }
 declare class StockLocations extends ApiResource<StockLocation> {
     static readonly TYPE: StockLocationType;

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

@@ -1,4 +1,5 @@
-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 { Sku, SkuType } from './skus';
 import type { StockLocation, StockLocationType } from './stock_locations';
@@ -23,37 +24,37 @@ type LineItemRel = ResourceRel & {
 };
 interface StockTransfer extends Resource {
     readonly type: StockTransferType;
-    sku_code?: string;
-    status?: 'draft' | 'upcoming' | 'picking' | 'in_transit' | 'completed' | 'cancelled';
+    sku_code?: string | null;
+    status: 'draft' | 'upcoming' | 'picking' | 'in_transit' | 'completed' | 'cancelled';
     quantity: number;
-    completed_at?: string;
-    cancelled_at?: string;
-    sku?: Sku;
-    origin_stock_location?: StockLocation;
-    destination_stock_location?: StockLocation;
-    shipment?: Shipment;
-    line_item?: LineItem;
-    events?: Event[];
+    completed_at?: string | null;
+    cancelled_at?: string | null;
+    sku?: Sku | null;
+    origin_stock_location?: StockLocation | null;
+    destination_stock_location?: StockLocation | null;
+    shipment?: Shipment | null;
+    line_item?: LineItem | null;
+    events?: Event[] | null;
 }
 interface StockTransferCreate extends ResourceCreate {
-    sku_code?: string;
+    sku_code?: string | null;
     quantity: number;
     sku: SkuRel;
     origin_stock_location: StockLocationRel;
     destination_stock_location: StockLocationRel;
-    shipment?: ShipmentRel;
-    line_item?: LineItemRel;
+    shipment?: ShipmentRel | null;
+    line_item?: LineItemRel | null;
 }
 interface StockTransferUpdate extends ResourceUpdate {
-    sku_code?: string;
-    _upcoming?: boolean;
-    _picking?: boolean;
-    _in_transit?: boolean;
-    _complete?: boolean;
-    _cancel?: boolean;
-    sku?: SkuRel;
-    origin_stock_location?: StockLocationRel;
-    destination_stock_location?: StockLocationRel;
+    sku_code?: string | null;
+    _upcoming?: boolean | null;
+    _picking?: boolean | null;
+    _in_transit?: boolean | null;
+    _complete?: boolean | null;
+    _cancel?: boolean | null;
+    sku?: SkuRel | null;
+    origin_stock_location?: StockLocationRel | null;
+    destination_stock_location?: StockLocationRel | null;
 }
 declare class StockTransfers extends ApiResource<StockTransfer> {
     static readonly TYPE: StockTransferType;

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

@@ -1,4 +1,5 @@
-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 { PaymentMethod } from './payment_methods';
 import type { StripePayment } from './stripe_payments';
@@ -9,22 +10,22 @@ type StripeGatewayRel = ResourceRel & {
 interface StripeGateway extends Resource {
     readonly type: StripeGatewayType;
     name: string;
-    auto_payments?: boolean;
-    webhook_endpoint_id?: string;
-    webhook_endpoint_secret?: string;
-    webhook_endpoint_url?: string;
-    payment_methods?: PaymentMethod[];
-    stripe_payments?: StripePayment[];
+    auto_payments?: boolean | null;
+    webhook_endpoint_id?: string | null;
+    webhook_endpoint_secret?: string | null;
+    webhook_endpoint_url?: string | null;
+    payment_methods?: PaymentMethod[] | null;
+    stripe_payments?: StripePayment[] | null;
 }
 interface StripeGatewayCreate extends ResourceCreate {
     name: string;
     login: string;
-    publishable_key?: string;
-    auto_payments?: boolean;
+    publishable_key?: string | null;
+    auto_payments?: boolean | null;
 }
 interface StripeGatewayUpdate extends ResourceUpdate {
-    name: string;
-    auto_payments?: boolean;
+    name?: string | null;
+    auto_payments?: boolean | null;
 }
 declare class StripeGateways extends ApiResource<StripeGateway> {
     static readonly TYPE: StripeGatewayType;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
 import type { QueryParamsRetrieve } from '../query';
 import type { Order, OrderType } from './orders';
 import type { PaymentGateway } from './payment_gateways';
@@ -12,25 +13,25 @@ type OrderRel = ResourceRel & {
 interface StripePayment extends Resource {
     readonly type: StripePaymentType;
     client_secret: string;
-    publishable_key?: string;
-    options?: object;
-    payment_method?: object;
-    mismatched_amounts?: boolean;
+    publishable_key?: string | null;
+    options?: Record<string, any> | null;
+    payment_method?: Record<string, any> | null;
+    mismatched_amounts?: boolean | null;
     intent_amount_cents: number;
-    intent_amount_float?: number;
-    formatted_intent_amount?: string;
-    payment_instrument?: object;
-    order?: Order;
-    payment_gateway?: PaymentGateway;
+    intent_amount_float?: number | null;
+    formatted_intent_amount?: string | null;
+    payment_instrument?: Record<string, any> | null;
+    order?: Order | null;
+    payment_gateway?: PaymentGateway | null;
 }
 interface StripePaymentCreate extends ResourceCreate {
-    options?: object;
+    options?: Record<string, any> | null;
     order: OrderRel;
 }
 interface StripePaymentUpdate extends ResourceUpdate {
-    options?: object;
-    _refresh?: boolean;
-    order?: OrderRel;
+    options?: Record<string, any> | null;
+    _refresh?: boolean | null;
+    order?: OrderRel | null;
 }
 declare class StripePayments extends ApiResource<StripePayment> {
     static readonly TYPE: StripePaymentType;

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

@@ -0,0 +1,49 @@
+import { ApiResource } from '../resource';
+import type { 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/cjs/resources/subscription_models.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class SubscriptionModels extends resource_1.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';
+exports.default = SubscriptionModels;