@commercelayer/sdk 5.12.5 → 5.13.0

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

@@ -1,8 +1,9 @@
 import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
-import type { QueryParamsRetrieve } from '../query';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Order, OrderType } from './orders';
 import type { PaymentGateway } from './payment_gateways';
+import type { Version } from './versions';
 type StripePaymentType = 'stripe_payments';
 type StripePaymentRel = ResourceRel & {
     type: StripePaymentType;
@@ -20,16 +21,20 @@ interface StripePayment extends Resource {
     intent_amount_cents: number;
     intent_amount_float?: number | null;
     formatted_intent_amount?: string | null;
+    return_url?: string | null;
     payment_instrument?: Record<string, any> | null;
     order?: Order | null;
     payment_gateway?: PaymentGateway | null;
+    versions?: Version[] | null;
 }
 interface StripePaymentCreate extends ResourceCreate {
     options?: Record<string, any> | null;
+    return_url?: string | null;
     order: OrderRel;
 }
 interface StripePaymentUpdate extends ResourceUpdate {
     options?: Record<string, any> | null;
+    return_url?: string | null;
     _update?: boolean | null;
     _refresh?: boolean | null;
     order?: OrderRel | null;
@@ -41,6 +46,7 @@ declare class StripePayments extends ApiResource<StripePayment> {
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     order(stripePaymentId: string | StripePayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     payment_gateway(stripePaymentId: string | StripePayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
+    versions(stripePaymentId: string | StripePayment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     _update(id: string | StripePayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StripePayment>;
     _refresh(id: string | StripePayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StripePayment>;
     isStripePayment(resource: any): resource is StripePayment;

package/lib/esm/resources/stripe_payments.js

@@ -17,6 +17,10 @@ class StripePayments extends ApiResource {
         const _stripePaymentId = stripePaymentId.id || stripePaymentId;
         return this.resources.fetch({ type: 'payment_gateways' }, `stripe_payments/${_stripePaymentId}/payment_gateway`, params, options);
     }
+    async versions(stripePaymentId, params, options) {
+        const _stripePaymentId = stripePaymentId.id || stripePaymentId;
+        return this.resources.fetch({ type: 'versions' }, `stripe_payments/${_stripePaymentId}/versions`, params, options);
+    }
     async _update(id, params, options) {
         return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: StripePayments.TYPE, _update: true }, params, options);
     }

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

@@ -3,6 +3,7 @@ import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse }
 import type { QueryParamsList } from '../query';
 import type { Market } from './markets';
 import type { Attachment } from './attachments';
+import type { Version } from './versions';
 type TaxCalculatorType = 'tax_calculators';
 type TaxCalculatorRel = ResourceRel & {
     type: TaxCalculatorType;
@@ -12,11 +13,13 @@ interface TaxCalculator extends Resource {
     name: string;
     markets?: Market[] | null;
     attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
 declare class TaxCalculators extends ApiResource<TaxCalculator> {
     static readonly TYPE: TaxCalculatorType;
     markets(taxCalculatorId: string | TaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Market>>;
     attachments(taxCalculatorId: string | TaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    versions(taxCalculatorId: string | TaxCalculator, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isTaxCalculator(resource: any): resource is TaxCalculator;
     relationship(id: string | ResourceId | null): TaxCalculatorRel;
     type(): TaxCalculatorType;

package/lib/esm/resources/tax_calculators.js

@@ -8,6 +8,10 @@ class TaxCalculators extends ApiResource {
         const _taxCalculatorId = taxCalculatorId.id || taxCalculatorId;
         return this.resources.fetch({ type: 'attachments' }, `tax_calculators/${_taxCalculatorId}/attachments`, params, options);
     }
+    async versions(taxCalculatorId, params, options) {
+        const _taxCalculatorId = taxCalculatorId.id || taxCalculatorId;
+        return this.resources.fetch({ type: 'versions' }, `tax_calculators/${_taxCalculatorId}/versions`, params, options);
+    }
     isTaxCalculator(resource) {
         return resource.type && (resource.type === TaxCalculators.TYPE);
     }

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

@@ -7,6 +7,7 @@ import type { TaxjarAccount, TaxjarAccountType } from './taxjar_accounts';
 import type { ManualTaxCalculator, ManualTaxCalculatorType } from './manual_tax_calculators';
 import type { ExternalTaxCalculator, ExternalTaxCalculatorType } from './external_tax_calculators';
 import type { Attachment } from './attachments';
+import type { Version } from './versions';
 type TaxCategoryType = 'tax_categories';
 type TaxCategoryRel = ResourceRel & {
     type: TaxCategoryType;
@@ -33,6 +34,7 @@ interface TaxCategory extends Resource {
     sku?: Sku | null;
     tax_calculator?: AvalaraAccount | TaxjarAccount | ManualTaxCalculator | ExternalTaxCalculator | null;
     attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
 interface TaxCategoryCreate extends ResourceCreate {
     code: string;
@@ -52,6 +54,7 @@ declare class TaxCategories extends ApiResource<TaxCategory> {
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     sku(taxCategoryId: string | TaxCategory, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
     attachments(taxCategoryId: string | TaxCategory, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    versions(taxCategoryId: string | TaxCategory, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isTaxCategory(resource: any): resource is TaxCategory;
     relationship(id: string | ResourceId | null): TaxCategoryRel;
     type(): TaxCategoryType;

package/lib/esm/resources/tax_categories.js

@@ -17,6 +17,10 @@ class TaxCategories extends ApiResource {
         const _taxCategoryId = taxCategoryId.id || taxCategoryId;
         return this.resources.fetch({ type: 'attachments' }, `tax_categories/${_taxCategoryId}/attachments`, params, options);
     }
+    async versions(taxCategoryId, params, options) {
+        const _taxCategoryId = taxCategoryId.id || taxCategoryId;
+        return this.resources.fetch({ type: 'versions' }, `tax_categories/${_taxCategoryId}/versions`, params, options);
+    }
     isTaxCategory(resource) {
         return resource.type && (resource.type === TaxCategories.TYPE);
     }

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

@@ -1,7 +1,8 @@
 import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
-import type { QueryParamsRetrieve } from '../query';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { ManualTaxCalculator, ManualTaxCalculatorType } from './manual_tax_calculators';
+import type { Version } from './versions';
 type TaxRuleType = 'tax_rules';
 type TaxRuleRel = ResourceRel & {
     type: TaxRuleType;
@@ -25,6 +26,7 @@ interface TaxRule extends Resource {
     adjustment_taxable?: boolean | null;
     breakdown?: Record<string, any> | null;
     manual_tax_calculator?: ManualTaxCalculator | null;
+    versions?: Version[] | null;
 }
 interface TaxRuleCreate extends ResourceCreate {
     name: string;
@@ -62,6 +64,7 @@ declare class TaxRules extends ApiResource<TaxRule> {
     update(resource: TaxRuleUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<TaxRule>;
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     manual_tax_calculator(taxRuleId: string | TaxRule, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ManualTaxCalculator>;
+    versions(taxRuleId: string | TaxRule, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isTaxRule(resource: any): resource is TaxRule;
     relationship(id: string | ResourceId | null): TaxRuleRel;
     type(): TaxRuleType;

package/lib/esm/resources/tax_rules.js

@@ -13,6 +13,10 @@ class TaxRules extends ApiResource {
         const _taxRuleId = taxRuleId.id || taxRuleId;
         return this.resources.fetch({ type: 'manual_tax_calculators' }, `tax_rules/${_taxRuleId}/manual_tax_calculator`, params, options);
     }
+    async versions(taxRuleId, params, options) {
+        const _taxRuleId = taxRuleId.id || taxRuleId;
+        return this.resources.fetch({ type: 'versions' }, `tax_rules/${_taxRuleId}/versions`, params, options);
+    }
     isTaxRule(resource) {
         return resource.type && (resource.type === TaxRules.TYPE);
     }

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

@@ -3,6 +3,7 @@ import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesCon
 import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Market } from './markets';
 import type { Attachment } from './attachments';
+import type { Version } from './versions';
 import type { TaxCategory, TaxCategoryType } from './tax_categories';
 type TaxjarAccountType = 'taxjar_accounts';
 type TaxjarAccountRel = ResourceRel & {
@@ -16,6 +17,7 @@ interface TaxjarAccount extends Resource {
     name: string;
     markets?: Market[] | null;
     attachments?: Attachment[] | null;
+    versions?: Version[] | null;
     tax_categories?: TaxCategory[] | null;
 }
 interface TaxjarAccountCreate extends ResourceCreate {
@@ -35,6 +37,7 @@ declare class TaxjarAccounts extends ApiResource<TaxjarAccount> {
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     markets(taxjarAccountId: string | TaxjarAccount, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Market>>;
     attachments(taxjarAccountId: string | TaxjarAccount, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    versions(taxjarAccountId: string | TaxjarAccount, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     tax_categories(taxjarAccountId: string | TaxjarAccount, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<TaxCategory>>;
     isTaxjarAccount(resource: any): resource is TaxjarAccount;
     relationship(id: string | ResourceId | null): TaxjarAccountRel;

package/lib/esm/resources/taxjar_accounts.js

@@ -17,6 +17,10 @@ class TaxjarAccounts extends ApiResource {
         const _taxjarAccountId = taxjarAccountId.id || taxjarAccountId;
         return this.resources.fetch({ type: 'attachments' }, `taxjar_accounts/${_taxjarAccountId}/attachments`, params, options);
     }
+    async versions(taxjarAccountId, params, options) {
+        const _taxjarAccountId = taxjarAccountId.id || taxjarAccountId;
+        return this.resources.fetch({ type: 'versions' }, `taxjar_accounts/${_taxjarAccountId}/versions`, params, options);
+    }
     async tax_categories(taxjarAccountId, params, options) {
         const _taxjarAccountId = taxjarAccountId.id || taxjarAccountId;
         return this.resources.fetch({ type: 'tax_categories' }, `taxjar_accounts/${_taxjarAccountId}/tax_categories`, params, options);

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

@@ -3,6 +3,7 @@ import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse }
 import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Order } from './orders';
 import type { Attachment } from './attachments';
+import type { Version } from './versions';
 type TransactionType = 'transactions';
 type TransactionRel = ResourceRel & {
     type: TransactionType;
@@ -22,11 +23,13 @@ interface Transaction extends Resource {
     gateway_transaction_id?: string | null;
     order?: Order | null;
     attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
 declare class Transactions extends ApiResource<Transaction> {
     static readonly TYPE: TransactionType;
     order(transactionId: string | Transaction, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     attachments(transactionId: string | Transaction, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    versions(transactionId: string | Transaction, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isTransaction(resource: any): resource is Transaction;
     relationship(id: string | ResourceId | null): TransactionRel;
     type(): TransactionType;

package/lib/esm/resources/transactions.js

@@ -8,6 +8,10 @@ class Transactions extends ApiResource {
         const _transactionId = transactionId.id || transactionId;
         return this.resources.fetch({ type: 'attachments' }, `transactions/${_transactionId}/attachments`, params, options);
     }
+    async versions(transactionId, params, options) {
+        const _transactionId = transactionId.id || transactionId;
+        return this.resources.fetch({ type: 'versions' }, `transactions/${_transactionId}/versions`, params, options);
+    }
     isTransaction(resource) {
         return resource.type && (resource.type === Transactions.TYPE);
     }

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

@@ -0,0 +1,22 @@
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourceRel } from '../resource';
+type VersionType = 'versions';
+type VersionRel = ResourceRel & {
+    type: VersionType;
+};
+interface Version extends Resource {
+    readonly type: VersionType;
+    resource_type?: string | null;
+    resource_id?: string | null;
+    event?: string | null;
+    changes?: Record<string, any> | null;
+    who?: Record<string, any> | null;
+}
+declare class Versions extends ApiResource<Version> {
+    static readonly TYPE: VersionType;
+    isVersion(resource: any): resource is Version;
+    relationship(id: string | ResourceId | null): VersionRel;
+    type(): VersionType;
+}
+export default Versions;
+export type { Version, VersionType };

package/lib/esm/resources/versions.js

@@ -0,0 +1,14 @@
+import { ApiResource } from '../resource';
+class Versions extends ApiResource {
+    isVersion(resource) {
+        return resource.type && (resource.type === Versions.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Versions.TYPE } : { id: id.id, type: Versions.TYPE };
+    }
+    type() {
+        return Versions.TYPE;
+    }
+}
+Versions.TYPE = 'versions';
+export default Versions;

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

@@ -3,6 +3,7 @@ import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse }
 import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Order } from './orders';
 import type { Attachment } from './attachments';
+import type { Version } from './versions';
 import type { Authorization } from './authorizations';
 import type { Event } from './events';
 type VoidType = 'voids';
@@ -24,6 +25,7 @@ interface Void extends Resource {
     gateway_transaction_id?: string | null;
     order?: Order | null;
     attachments?: Attachment[] | null;
+    versions?: Version[] | null;
     reference_authorization?: Authorization | null;
     events?: Event[] | null;
 }
@@ -31,6 +33,7 @@ declare class Voids extends ApiResource<Void> {
     static readonly TYPE: VoidType;
     order(voidId: string | Void, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     attachments(voidId: string | Void, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    versions(voidId: string | Void, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     reference_authorization(voidId: string | Void, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Authorization>;
     events(voidId: string | Void, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     isVoid(resource: any): resource is Void;

package/lib/esm/resources/voids.js

@@ -8,6 +8,10 @@ class Voids extends ApiResource {
         const _voidId = voidId.id || voidId;
         return this.resources.fetch({ type: 'attachments' }, `voids/${_voidId}/attachments`, params, options);
     }
+    async versions(voidId, params, options) {
+        const _voidId = voidId.id || voidId;
+        return this.resources.fetch({ type: 'versions' }, `voids/${_voidId}/versions`, params, options);
+    }
     async reference_authorization(voidId, params, options) {
         const _voidId = voidId.id || voidId;
         return this.resources.fetch({ type: 'authorizations' }, `voids/${_voidId}/reference_authorization`, params, options);

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

@@ -2,6 +2,7 @@ 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';
+import type { Version } from './versions';
 type WebhookType = 'webhooks';
 type WebhookRel = ResourceRel & {
     type: WebhookType;
@@ -16,6 +17,7 @@ interface Webhook extends Resource {
     circuit_failure_count?: number | null;
     shared_secret: string;
     last_event_callbacks?: EventCallback[] | null;
+    versions?: Version[] | null;
 }
 interface WebhookCreate extends ResourceCreate {
     name?: string | null;
@@ -36,6 +38,7 @@ declare class Webhooks extends ApiResource<Webhook> {
     update(resource: WebhookUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     last_event_callbacks(webhookId: string | Webhook, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<EventCallback>>;
+    versions(webhookId: string | Webhook, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     _reset_circuit(id: string | Webhook, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Webhook>;
     isWebhook(resource: any): resource is Webhook;
     relationship(id: string | ResourceId | null): WebhookRel;

package/lib/esm/resources/webhooks.js

@@ -13,6 +13,10 @@ class Webhooks extends ApiResource {
         const _webhookId = webhookId.id || webhookId;
         return this.resources.fetch({ type: 'event_callbacks' }, `webhooks/${_webhookId}/last_event_callbacks`, params, options);
     }
+    async versions(webhookId, params, options) {
+        const _webhookId = webhookId.id || webhookId;
+        return this.resources.fetch({ type: 'versions' }, `webhooks/${_webhookId}/versions`, params, options);
+    }
     async _reset_circuit(id, params, options) {
         return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Webhooks.TYPE, _reset_circuit: true }, params, options);
     }

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

@@ -1,7 +1,8 @@
 import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
-import type { QueryParamsRetrieve } from '../query';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Order, OrderType } from './orders';
+import type { Version } from './versions';
 type WireTransferType = 'wire_transfers';
 type WireTransferRel = ResourceRel & {
     type: WireTransferType;
@@ -13,6 +14,7 @@ interface WireTransfer extends Resource {
     readonly type: WireTransferType;
     payment_instrument?: Record<string, any> | null;
     order?: Order | null;
+    versions?: Version[] | null;
 }
 interface WireTransferCreate extends ResourceCreate {
     order: OrderRel;
@@ -26,6 +28,7 @@ declare class WireTransfers extends ApiResource<WireTransfer> {
     update(resource: WireTransferUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<WireTransfer>;
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     order(wireTransferId: string | WireTransfer, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    versions(wireTransferId: string | WireTransfer, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isWireTransfer(resource: any): resource is WireTransfer;
     relationship(id: string | ResourceId | null): WireTransferRel;
     type(): WireTransferType;

package/lib/esm/resources/wire_transfers.js

@@ -13,6 +13,10 @@ class WireTransfers extends ApiResource {
         const _wireTransferId = wireTransferId.id || wireTransferId;
         return this.resources.fetch({ type: 'orders' }, `wire_transfers/${_wireTransferId}/order`, params, options);
     }
+    async versions(wireTransferId, params, options) {
+        const _wireTransferId = wireTransferId.id || wireTransferId;
+        return this.resources.fetch({ type: 'versions' }, `wire_transfers/${_wireTransferId}/versions`, params, options);
+    }
     isWireTransfer(resource) {
         return resource.type && (resource.type === WireTransfers.TYPE);
     }

package/lib/esm/util.d.ts

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