@commercelayer/sdk 5.0.0-beta.9 → 5.1.0

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

@@ -0,0 +1,28 @@
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import type { QueryParamsRetrieve } from '../query';
+type TagType = 'tags';
+type TagRel = ResourceRel & {
+    type: TagType;
+};
+interface Tag extends Resource {
+    readonly type: TagType;
+    name: string;
+}
+interface TagCreate extends ResourceCreate {
+    name: string;
+}
+interface TagUpdate extends ResourceUpdate {
+    name?: string | null;
+}
+declare class Tags extends ApiResource<Tag> {
+    static readonly TYPE: TagType;
+    create(resource: TagCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Tag>;
+    update(resource: TagUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Tag>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    isTag(resource: any): resource is Tag;
+    relationship(id: string | ResourceId | null): TagRel;
+    type(): TagType;
+}
+export default Tags;
+export type { Tag, TagCreate, TagUpdate, TagType };

package/lib/cjs/resources/tags.js

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

package/lib/cjs/resources/tax_calculators.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 { QueryParamsList } from '../query';
 import type { Market } from './markets';
 import type { Attachment } from './attachments';
@@ -9,8 +10,8 @@ type TaxCalculatorRel = ResourceRel & {
 interface TaxCalculator extends Resource {
     readonly type: TaxCalculatorType;
     name: string;
-    markets?: Market[];
-    attachments?: Attachment[];
+    markets?: Market[] | null;
+    attachments?: Attachment[] | null;
 }
 declare class TaxCalculators extends ApiResource<TaxCalculator> {
     static readonly TYPE: TaxCalculatorType;

package/lib/cjs/resources/tax_categories.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 { AvalaraAccount, AvalaraAccountType } from './avalara_accounts';
@@ -28,21 +29,21 @@ type ExternalTaxCalculatorRel = ResourceRel & {
 interface TaxCategory extends Resource {
     readonly type: TaxCategoryType;
     code: string;
-    sku_code?: string;
-    sku?: Sku;
-    tax_calculator?: AvalaraAccount | TaxjarAccount | ManualTaxCalculator | ExternalTaxCalculator;
-    attachments?: Attachment[];
+    sku_code?: string | null;
+    sku?: Sku | null;
+    tax_calculator?: AvalaraAccount | TaxjarAccount | ManualTaxCalculator | ExternalTaxCalculator | null;
+    attachments?: Attachment[] | null;
 }
 interface TaxCategoryCreate extends ResourceCreate {
     code: string;
-    sku_code?: string;
+    sku_code?: string | null;
     sku: SkuRel;
     tax_calculator: AvalaraAccountRel | TaxjarAccountRel | ManualTaxCalculatorRel | ExternalTaxCalculatorRel;
 }
 interface TaxCategoryUpdate extends ResourceUpdate {
-    code: string;
-    sku_code?: string;
-    sku?: SkuRel;
+    code?: string | null;
+    sku_code?: string | null;
+    sku?: SkuRel | null;
 }
 declare class TaxCategories extends ApiResource<TaxCategory> {
     static readonly TYPE: TaxCategoryType;

package/lib/cjs/resources/tax_rules.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 { ManualTaxCalculator, ManualTaxCalculatorType } from './manual_tax_calculators';
 type TaxRuleType = 'tax_rules';
@@ -11,49 +12,49 @@ type ManualTaxCalculatorRel = ResourceRel & {
 interface TaxRule extends Resource {
     readonly type: TaxRuleType;
     name: string;
-    tax_rate?: number;
-    country_code_regex?: string;
-    not_country_code_regex?: string;
-    state_code_regex?: string;
-    not_state_code_regex?: string;
-    zip_code_regex?: string;
-    not_zip_code_regex?: string;
-    freight_taxable?: boolean;
-    payment_method_taxable?: boolean;
-    gift_card_taxable?: boolean;
-    adjustment_taxable?: boolean;
-    breakdown?: object;
-    manual_tax_calculator?: ManualTaxCalculator;
+    tax_rate?: number | null;
+    country_code_regex?: string | null;
+    not_country_code_regex?: string | null;
+    state_code_regex?: string | null;
+    not_state_code_regex?: string | null;
+    zip_code_regex?: string | null;
+    not_zip_code_regex?: string | null;
+    freight_taxable?: boolean | null;
+    payment_method_taxable?: boolean | null;
+    gift_card_taxable?: boolean | null;
+    adjustment_taxable?: boolean | null;
+    breakdown?: Record<string, any> | null;
+    manual_tax_calculator?: ManualTaxCalculator | null;
 }
 interface TaxRuleCreate extends ResourceCreate {
     name: string;
-    tax_rate?: number;
-    country_code_regex?: string;
-    not_country_code_regex?: string;
-    state_code_regex?: string;
-    not_state_code_regex?: string;
-    zip_code_regex?: string;
-    not_zip_code_regex?: string;
-    freight_taxable?: boolean;
-    payment_method_taxable?: boolean;
-    gift_card_taxable?: boolean;
-    adjustment_taxable?: boolean;
+    tax_rate?: number | null;
+    country_code_regex?: string | null;
+    not_country_code_regex?: string | null;
+    state_code_regex?: string | null;
+    not_state_code_regex?: string | null;
+    zip_code_regex?: string | null;
+    not_zip_code_regex?: string | null;
+    freight_taxable?: boolean | null;
+    payment_method_taxable?: boolean | null;
+    gift_card_taxable?: boolean | null;
+    adjustment_taxable?: boolean | null;
     manual_tax_calculator: ManualTaxCalculatorRel;
 }
 interface TaxRuleUpdate extends ResourceUpdate {
-    name: string;
-    tax_rate?: number;
-    country_code_regex?: string;
-    not_country_code_regex?: string;
-    state_code_regex?: string;
-    not_state_code_regex?: string;
-    zip_code_regex?: string;
-    not_zip_code_regex?: string;
-    freight_taxable?: boolean;
-    payment_method_taxable?: boolean;
-    gift_card_taxable?: boolean;
-    adjustment_taxable?: boolean;
-    manual_tax_calculator?: ManualTaxCalculatorRel;
+    name?: string | null;
+    tax_rate?: number | null;
+    country_code_regex?: string | null;
+    not_country_code_regex?: string | null;
+    state_code_regex?: string | null;
+    not_state_code_regex?: string | null;
+    zip_code_regex?: string | null;
+    not_zip_code_regex?: string | null;
+    freight_taxable?: boolean | null;
+    payment_method_taxable?: boolean | null;
+    gift_card_taxable?: boolean | null;
+    adjustment_taxable?: boolean | null;
+    manual_tax_calculator?: ManualTaxCalculatorRel | null;
 }
 declare class TaxRules extends ApiResource<TaxRule> {
     static readonly TYPE: TaxRuleType;

package/lib/cjs/resources/taxjar_accounts.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 { Market } from './markets';
 import type { Attachment } from './attachments';
@@ -13,19 +14,19 @@ type TaxCategoryRel = ResourceRel & {
 interface TaxjarAccount extends Resource {
     readonly type: TaxjarAccountType;
     name: string;
-    markets?: Market[];
-    attachments?: Attachment[];
-    tax_categories?: TaxCategory[];
+    markets?: Market[] | null;
+    attachments?: Attachment[] | null;
+    tax_categories?: TaxCategory[] | null;
 }
 interface TaxjarAccountCreate extends ResourceCreate {
     name: string;
     api_key: string;
-    tax_categories?: TaxCategoryRel[];
+    tax_categories?: TaxCategoryRel[] | null;
 }
 interface TaxjarAccountUpdate extends ResourceUpdate {
-    name: string;
-    api_key?: string;
-    tax_categories?: TaxCategoryRel[];
+    name?: string | null;
+    api_key?: string | null;
+    tax_categories?: TaxCategoryRel[] | null;
 }
 declare class TaxjarAccounts extends ApiResource<TaxjarAccount> {
     static readonly TYPE: TaxjarAccountType;

package/lib/cjs/resources/transactions.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 { Order } from './orders';
 type TransactionType = 'transactions';
@@ -13,12 +14,12 @@ interface Transaction extends Resource {
     amount_float: number;
     formatted_amount: string;
     succeeded: boolean;
-    message?: string;
-    error_code?: string;
-    error_detail?: string;
-    token?: string;
-    gateway_transaction_id?: string;
-    order?: Order;
+    message?: string | null;
+    error_code?: string | null;
+    error_detail?: string | null;
+    token?: string | null;
+    gateway_transaction_id?: string | null;
+    order?: Order | null;
 }
 declare class Transactions extends ApiResource<Transaction> {
     static readonly TYPE: TransactionType;

package/lib/cjs/resources/voids.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 { Order } from './orders';
 import type { Authorization } from './authorizations';
@@ -15,14 +16,14 @@ interface Void extends Resource {
     amount_float: number;
     formatted_amount: string;
     succeeded: boolean;
-    message?: string;
-    error_code?: string;
-    error_detail?: string;
-    token?: string;
-    gateway_transaction_id?: string;
-    order?: Order;
-    reference_authorization?: Authorization;
-    events?: Event[];
+    message?: string | null;
+    error_code?: string | null;
+    error_detail?: string | null;
+    token?: string | null;
+    gateway_transaction_id?: string | null;
+    order?: Order | null;
+    reference_authorization?: Authorization | null;
+    events?: Event[] | null;
 }
 declare class Voids extends ApiResource<Void> {
     static readonly TYPE: VoidType;

package/lib/cjs/resources/webhooks.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 { EventCallback } from './event_callbacks';
 type WebhookType = 'webhooks';
@@ -7,27 +8,27 @@ type WebhookRel = ResourceRel & {
 };
 interface Webhook extends Resource {
     readonly type: WebhookType;
-    name?: string;
+    name?: string | null;
     topic: string;
     callback_url: string;
-    include_resources?: string[];
-    circuit_state?: string;
-    circuit_failure_count?: number;
+    include_resources?: string[] | null;
+    circuit_state?: string | null;
+    circuit_failure_count?: number | null;
     shared_secret: string;
-    last_event_callbacks?: EventCallback[];
+    last_event_callbacks?: EventCallback[] | null;
 }
 interface WebhookCreate extends ResourceCreate {
-    name?: string;
+    name?: string | null;
     topic: string;
     callback_url: string;
-    include_resources?: string[];
+    include_resources?: string[] | null;
 }
 interface WebhookUpdate extends ResourceUpdate {
-    name?: string;
-    topic: string;
-    callback_url: string;
-    include_resources?: string[];
-    _reset_circuit?: boolean;
+    name?: string | null;
+    topic?: string | null;
+    callback_url?: string | null;
+    include_resources?: string[] | null;
+    _reset_circuit?: boolean | null;
 }
 declare class Webhooks extends ApiResource<Webhook> {
     static readonly TYPE: WebhookType;

package/lib/cjs/resources/wire_transfers.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';
 type WireTransferType = 'wire_transfers';
@@ -10,14 +11,14 @@ type OrderRel = ResourceRel & {
 };
 interface WireTransfer extends Resource {
     readonly type: WireTransferType;
-    payment_instrument?: object;
-    order?: Order;
+    payment_instrument?: Record<string, any> | null;
+    order?: Order | null;
 }
 interface WireTransferCreate extends ResourceCreate {
     order: OrderRel;
 }
 interface WireTransferUpdate extends ResourceUpdate {
-    order?: OrderRel;
+    order?: OrderRel | null;
 }
 declare class WireTransfers extends ApiResource<WireTransfer> {
     static readonly TYPE: WireTransferType;

package/lib/cjs/util.d.ts

@@ -2,9 +2,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-type ObjectType = {
-    [key: string]: any;
-};
+import type { ObjectType } from "./common";
 declare const sleep: (ms: number) => Promise<NodeJS.Timeout>;
 declare const sortObjectFields: (obj: ObjectType) => ObjectType;
 export { sleep, sortObjectFields };

package/lib/esm/api.d.ts

@@ -61,6 +61,8 @@ export { default as Markets } from './resources/markets';
 export { default as Merchants } from './resources/merchants';
 export { default as OrderAmountPromotionRules } from './resources/order_amount_promotion_rules';
 export { default as OrderCopies } from './resources/order_copies';
+export { default as OrderFactories } from './resources/order_factories';
+export { default as OrderSubscriptionItems } from './resources/order_subscription_items';
 export { default as OrderSubscriptions } from './resources/order_subscriptions';
 export { default as OrderValidationRules } from './resources/order_validation_rules';
 export { default as Orders } from './resources/orders';
@@ -73,12 +75,14 @@ export { default as PaymentMethods } from './resources/payment_methods';
 export { default as PaypalGateways } from './resources/paypal_gateways';
 export { default as PaypalPayments } from './resources/paypal_payments';
 export { default as PercentageDiscountPromotions } from './resources/percentage_discount_promotions';
+export { default as PriceFrequencyTiers } from './resources/price_frequency_tiers';
 export { default as PriceLists } from './resources/price_lists';
 export { default as PriceTiers } from './resources/price_tiers';
 export { default as PriceVolumeTiers } from './resources/price_volume_tiers';
 export { default as Prices } from './resources/prices';
 export { default as PromotionRules } from './resources/promotion_rules';
 export { default as Promotions } from './resources/promotions';
+export { default as RecurringOrderCopies } from './resources/recurring_order_copies';
 export { default as Refunds } from './resources/refunds';
 export { default as ReturnLineItems } from './resources/return_line_items';
 export { default as Returns } from './resources/returns';
@@ -101,6 +105,8 @@ export { default as StockLocations } from './resources/stock_locations';
 export { default as StockTransfers } from './resources/stock_transfers';
 export { default as StripeGateways } from './resources/stripe_gateways';
 export { default as StripePayments } from './resources/stripe_payments';
+export { default as SubscriptionModels } from './resources/subscription_models';
+export { default as Tags } from './resources/tags';
 export { default as TaxCalculators } from './resources/tax_calculators';
 export { default as TaxCategories } from './resources/tax_categories';
 export { default as TaxRules } from './resources/tax_rules';
@@ -109,20 +115,25 @@ export { default as Transactions } from './resources/transactions';
 export { default as Voids } from './resources/voids';
 export { default as Webhooks } from './resources/webhooks';
 export { default as WireTransfers } from './resources/wire_transfers';
-export type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'application' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'event_callbacks' | 'events' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'geocoders' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscriptions' | 'order_validation_rules' | 'orders' | 'organization' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'refunds' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | 'voids' | 'webhooks' | 'wire_transfers';
-export declare const resourceList: readonly ["addresses", "adjustments", "adyen_gateways", "adyen_payments", "application", "attachments", "authorizations", "avalara_accounts", "axerve_gateways", "axerve_payments", "billing_info_validation_rules", "bing_geocoders", "braintree_gateways", "braintree_payments", "bundles", "captures", "carrier_accounts", "checkout_com_gateways", "checkout_com_payments", "cleanups", "coupon_codes_promotion_rules", "coupon_recipients", "coupons", "customer_addresses", "customer_groups", "customer_password_resets", "customer_payment_sources", "customer_subscriptions", "customers", "delivery_lead_times", "event_callbacks", "events", "exports", "external_gateways", "external_payments", "external_promotions", "external_tax_calculators", "fixed_amount_promotions", "fixed_price_promotions", "free_gift_promotions", "free_shipping_promotions", "geocoders", "gift_card_recipients", "gift_cards", "google_geocoders", "imports", "in_stock_subscriptions", "inventory_models", "inventory_return_locations", "inventory_stock_locations", "klarna_gateways", "klarna_payments", "line_item_options", "line_items", "manual_gateways", "manual_tax_calculators", "markets", "merchants", "order_amount_promotion_rules", "order_copies", "order_subscriptions", "order_validation_rules", "orders", "organization", "packages", "parcel_line_items", "parcels", "payment_gateways", "payment_methods", "paypal_gateways", "paypal_payments", "percentage_discount_promotions", "price_lists", "price_tiers", "price_volume_tiers", "prices", "promotion_rules", "promotions", "refunds", "return_line_items", "returns", "satispay_gateways", "satispay_payments", "shipments", "shipping_categories", "shipping_method_tiers", "shipping_methods", "shipping_weight_tiers", "shipping_zones", "sku_list_items", "sku_list_promotion_rules", "sku_lists", "sku_options", "skus", "stock_items", "stock_line_items", "stock_locations", "stock_transfers", "stripe_gateways", "stripe_payments", "tax_calculators", "tax_categories", "tax_rules", "taxjar_accounts", "transactions", "voids", "webhooks", "wire_transfers"];
-export type ResourceRetrievable = {
-    type: ResourceTypeLock;
+export type ResourceTypeLock = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'application' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'carrier_accounts' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'event_callbacks' | 'events' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'geocoders' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_factories' | 'order_subscription_items' | 'order_subscriptions' | 'order_validation_rules' | 'orders' | 'organization' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_gateways' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_tiers' | 'price_volume_tiers' | 'prices' | 'promotion_rules' | 'promotions' | 'recurring_order_copies' | 'refunds' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_method_tiers' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_line_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tags' | 'tax_calculators' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'transactions' | 'voids' | 'webhooks' | 'wire_transfers';
+export declare const resourceList: readonly ["addresses", "adjustments", "adyen_gateways", "adyen_payments", "application", "attachments", "authorizations", "avalara_accounts", "axerve_gateways", "axerve_payments", "billing_info_validation_rules", "bing_geocoders", "braintree_gateways", "braintree_payments", "bundles", "captures", "carrier_accounts", "checkout_com_gateways", "checkout_com_payments", "cleanups", "coupon_codes_promotion_rules", "coupon_recipients", "coupons", "customer_addresses", "customer_groups", "customer_password_resets", "customer_payment_sources", "customer_subscriptions", "customers", "delivery_lead_times", "event_callbacks", "events", "exports", "external_gateways", "external_payments", "external_promotions", "external_tax_calculators", "fixed_amount_promotions", "fixed_price_promotions", "free_gift_promotions", "free_shipping_promotions", "geocoders", "gift_card_recipients", "gift_cards", "google_geocoders", "imports", "in_stock_subscriptions", "inventory_models", "inventory_return_locations", "inventory_stock_locations", "klarna_gateways", "klarna_payments", "line_item_options", "line_items", "manual_gateways", "manual_tax_calculators", "markets", "merchants", "order_amount_promotion_rules", "order_copies", "order_factories", "order_subscription_items", "order_subscriptions", "order_validation_rules", "orders", "organization", "packages", "parcel_line_items", "parcels", "payment_gateways", "payment_methods", "paypal_gateways", "paypal_payments", "percentage_discount_promotions", "price_frequency_tiers", "price_lists", "price_tiers", "price_volume_tiers", "prices", "promotion_rules", "promotions", "recurring_order_copies", "refunds", "return_line_items", "returns", "satispay_gateways", "satispay_payments", "shipments", "shipping_categories", "shipping_method_tiers", "shipping_methods", "shipping_weight_tiers", "shipping_zones", "sku_list_items", "sku_list_promotion_rules", "sku_lists", "sku_options", "skus", "stock_items", "stock_line_items", "stock_locations", "stock_transfers", "stripe_gateways", "stripe_payments", "subscription_models", "tags", "tax_calculators", "tax_categories", "tax_rules", "taxjar_accounts", "transactions", "voids", "webhooks", "wire_transfers"];
+export type RetrievableResourceType = ResourceTypeLock;
+export type RetrievableResource = {
+    type: RetrievableResourceType;
 };
-export type ResourceListable = {
-    type: Exclude<ResourceTypeLock, 'application' | 'organization'>;
+export type ListableResourceType = Exclude<ResourceTypeLock, 'application' | 'organization'>;
+export type ListableResource = {
+    type: ListableResourceType;
 };
-export type ResourceCreatable = {
-    type: 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+export type CreatableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscription_items' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'recurring_order_copies' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tags' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+export type CreatableResource = {
+    type: CreatableResourceType;
 };
-export type ResourceUpdatable = {
-    type: 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'checkout_com_gateways' | 'checkout_com_payments' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+export type UpdatableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'authorizations' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'captures' | 'checkout_com_gateways' | 'checkout_com_payments' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscription_items' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'recurring_order_copies' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tags' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+export type UpdatableResource = {
+    type: UpdatableResourceType;
 };
-export type ResourceDeletable = {
-    type: 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+export type DeletableResourceType = 'addresses' | 'adjustments' | 'adyen_gateways' | 'adyen_payments' | 'attachments' | 'avalara_accounts' | 'axerve_gateways' | 'axerve_payments' | 'billing_info_validation_rules' | 'bing_geocoders' | 'braintree_gateways' | 'braintree_payments' | 'bundles' | 'checkout_com_gateways' | 'checkout_com_payments' | 'cleanups' | 'coupon_codes_promotion_rules' | 'coupon_recipients' | 'coupons' | 'customer_addresses' | 'customer_groups' | 'customer_password_resets' | 'customer_payment_sources' | 'customer_subscriptions' | 'customers' | 'delivery_lead_times' | 'exports' | 'external_gateways' | 'external_payments' | 'external_promotions' | 'external_tax_calculators' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'gift_card_recipients' | 'gift_cards' | 'google_geocoders' | 'imports' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_return_locations' | 'inventory_stock_locations' | 'klarna_gateways' | 'klarna_payments' | 'line_item_options' | 'line_items' | 'manual_gateways' | 'manual_tax_calculators' | 'markets' | 'merchants' | 'order_amount_promotion_rules' | 'order_copies' | 'order_subscription_items' | 'order_subscriptions' | 'orders' | 'packages' | 'parcel_line_items' | 'parcels' | 'payment_methods' | 'paypal_gateways' | 'paypal_payments' | 'percentage_discount_promotions' | 'price_frequency_tiers' | 'price_lists' | 'price_volume_tiers' | 'prices' | 'recurring_order_copies' | 'return_line_items' | 'returns' | 'satispay_gateways' | 'satispay_payments' | 'shipping_categories' | 'shipping_methods' | 'shipping_weight_tiers' | 'shipping_zones' | 'sku_list_items' | 'sku_list_promotion_rules' | 'sku_lists' | 'sku_options' | 'skus' | 'stock_items' | 'stock_locations' | 'stock_transfers' | 'stripe_gateways' | 'stripe_payments' | 'subscription_models' | 'tags' | 'tax_categories' | 'tax_rules' | 'taxjar_accounts' | 'webhooks' | 'wire_transfers';
+export type DeletableResource = {
+    type: DeletableResourceType;
 };

package/lib/esm/api.js

@@ -63,6 +63,8 @@ export { default as Markets } from './resources/markets';
 export { default as Merchants } from './resources/merchants';
 export { default as OrderAmountPromotionRules } from './resources/order_amount_promotion_rules';
 export { default as OrderCopies } from './resources/order_copies';
+export { default as OrderFactories } from './resources/order_factories';
+export { default as OrderSubscriptionItems } from './resources/order_subscription_items';
 export { default as OrderSubscriptions } from './resources/order_subscriptions';
 export { default as OrderValidationRules } from './resources/order_validation_rules';
 export { default as Orders } from './resources/orders';
@@ -75,12 +77,14 @@ export { default as PaymentMethods } from './resources/payment_methods';
 export { default as PaypalGateways } from './resources/paypal_gateways';
 export { default as PaypalPayments } from './resources/paypal_payments';
 export { default as PercentageDiscountPromotions } from './resources/percentage_discount_promotions';
+export { default as PriceFrequencyTiers } from './resources/price_frequency_tiers';
 export { default as PriceLists } from './resources/price_lists';
 export { default as PriceTiers } from './resources/price_tiers';
 export { default as PriceVolumeTiers } from './resources/price_volume_tiers';
 export { default as Prices } from './resources/prices';
 export { default as PromotionRules } from './resources/promotion_rules';
 export { default as Promotions } from './resources/promotions';
+export { default as RecurringOrderCopies } from './resources/recurring_order_copies';
 export { default as Refunds } from './resources/refunds';
 export { default as ReturnLineItems } from './resources/return_line_items';
 export { default as Returns } from './resources/returns';
@@ -103,6 +107,8 @@ export { default as StockLocations } from './resources/stock_locations';
 export { default as StockTransfers } from './resources/stock_transfers';
 export { default as StripeGateways } from './resources/stripe_gateways';
 export { default as StripePayments } from './resources/stripe_payments';
+export { default as SubscriptionModels } from './resources/subscription_models';
+export { default as Tags } from './resources/tags';
 export { default as TaxCalculators } from './resources/tax_calculators';
 export { default as TaxCategories } from './resources/tax_categories';
 export { default as TaxRules } from './resources/tax_rules';
@@ -174,6 +180,8 @@ export const resourceList = [
     'merchants',
     'order_amount_promotion_rules',
     'order_copies',
+    'order_factories',
+    'order_subscription_items',
     'order_subscriptions',
     'order_validation_rules',
     'orders',
@@ -186,12 +194,14 @@ export const resourceList = [
     'paypal_gateways',
     'paypal_payments',
     'percentage_discount_promotions',
+    'price_frequency_tiers',
     'price_lists',
     'price_tiers',
     'price_volume_tiers',
     'prices',
     'promotion_rules',
     'promotions',
+    'recurring_order_copies',
     'refunds',
     'return_line_items',
     'returns',
@@ -214,6 +224,8 @@ export const resourceList = [
     'stock_transfers',
     'stripe_gateways',
     'stripe_payments',
+    'subscription_models',
+    'tags',
     'tax_calculators',
     'tax_categories',
     'tax_rules',

package/lib/esm/client.d.ts

@@ -1,15 +1,13 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { AxiosProxyConfig, Method } from 'axios';
+import { type AxiosProxyConfig, type Method } from 'axios';
 import type { InterceptorManager } from './interceptor';
 import type { Agent as HttpAgent } from 'http';
 import type { Agent as HttpsAgent } from 'https';
 type ProxyConfig = AxiosProxyConfig | false;
 type RequestConfig = {
     timeout?: number;
-    params?: {
-        [key: string]: string | number | boolean;
-    };
+    params?: Record<string, string | number | boolean>;
     httpAgent?: HttpAgent;
     httpsAgent?: HttpsAgent;
     proxy?: ProxyConfig;
@@ -30,4 +28,4 @@ declare class ApiClient {
     request(method: Method, path: string, body?: any, options?: ApiClientConfig): Promise<any>;
 }
 export default ApiClient;
-export { ApiClientInitConfig, ApiClientConfig, RequestConfig };
+export type { ApiClientInitConfig, ApiClientConfig, RequestConfig };