@commercelayer/sdk 5.0.0-beta.9 → 5.1.0

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

@@ -1,7 +1,9 @@
-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 { Price, PriceType } from './prices';
 import type { Attachment } from './attachments';
+import type { Event } from './events';
 type PriceVolumeTierType = 'price_volume_tiers';
 type PriceVolumeTierRel = ResourceRel & {
     type: PriceVolumeTierType;
@@ -12,24 +14,25 @@ type PriceRel = ResourceRel & {
 interface PriceVolumeTier extends Resource {
     readonly type: PriceVolumeTierType;
     name: string;
-    up_to?: number;
+    up_to?: number | null;
     price_amount_cents: number;
-    price_amount_float?: number;
-    formatted_price_amount?: string;
-    price?: Price;
-    attachments?: Attachment[];
+    price_amount_float?: number | null;
+    formatted_price_amount?: string | null;
+    price?: Price | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
 }
 interface PriceVolumeTierCreate extends ResourceCreate {
     name: string;
-    up_to?: number;
+    up_to?: number | null;
     price_amount_cents: number;
     price: PriceRel;
 }
 interface PriceVolumeTierUpdate extends ResourceUpdate {
-    name: string;
-    up_to?: number;
-    price_amount_cents: number;
-    price?: PriceRel;
+    name?: string | null;
+    up_to?: number | null;
+    price_amount_cents?: number | null;
+    price?: PriceRel | null;
 }
 declare class PriceVolumeTiers extends ApiResource<PriceVolumeTier> {
     static readonly TYPE: PriceVolumeTierType;
@@ -38,6 +41,7 @@ declare class PriceVolumeTiers extends ApiResource<PriceVolumeTier> {
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     price(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Price>;
     attachments(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(priceVolumeTierId: string | PriceVolumeTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     isPriceVolumeTier(resource: any): resource is PriceVolumeTier;
     relationship(id: string | ResourceId | null): PriceVolumeTierRel;
     type(): PriceVolumeTierType;

package/lib/esm/resources/price_volume_tiers.js

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

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

@@ -1,9 +1,11 @@
-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 { PriceList, PriceListType } from './price_lists';
 import type { Sku, SkuType } from './skus';
 import type { PriceTier, PriceTierType } from './price_tiers';
 import type { PriceVolumeTier } from './price_volume_tiers';
+import type { PriceFrequencyTier } from './price_frequency_tiers';
 import type { Attachment } from './attachments';
 type PriceType = 'prices';
 type PriceRel = ResourceRel & {
@@ -20,35 +22,36 @@ type PriceTierRel = ResourceRel & {
 };
 interface Price extends Resource {
     readonly type: PriceType;
-    currency_code?: string;
-    sku_code?: string;
+    currency_code?: string | null;
+    sku_code?: string | null;
     amount_cents: number;
     amount_float: number;
     formatted_amount: string;
     compare_at_amount_cents: number;
     compare_at_amount_float: number;
     formatted_compare_at_amount: string;
-    price_list?: PriceList;
-    sku?: Sku;
-    price_tiers?: PriceTier[];
-    price_volume_tiers?: PriceVolumeTier[];
-    attachments?: Attachment[];
+    price_list?: PriceList | null;
+    sku?: Sku | null;
+    price_tiers?: PriceTier[] | null;
+    price_volume_tiers?: PriceVolumeTier[] | null;
+    price_frequency_tiers?: PriceFrequencyTier[] | null;
+    attachments?: Attachment[] | null;
 }
 interface PriceCreate extends ResourceCreate {
-    sku_code?: string;
+    sku_code?: string | null;
     amount_cents: number;
     compare_at_amount_cents: number;
     price_list: PriceListRel;
     sku: SkuRel;
-    price_tiers?: PriceTierRel[];
+    price_tiers?: PriceTierRel[] | null;
 }
 interface PriceUpdate extends ResourceUpdate {
-    sku_code?: string;
-    amount_cents: number;
-    compare_at_amount_cents: number;
-    price_list?: PriceListRel;
-    sku?: SkuRel;
-    price_tiers?: PriceTierRel[];
+    sku_code?: string | null;
+    amount_cents?: number | null;
+    compare_at_amount_cents?: number | null;
+    price_list?: PriceListRel | null;
+    sku?: SkuRel | null;
+    price_tiers?: PriceTierRel[] | null;
 }
 declare class Prices extends ApiResource<Price> {
     static readonly TYPE: PriceType;
@@ -59,6 +62,7 @@ declare class Prices extends ApiResource<Price> {
     sku(priceId: string | Price, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
     price_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceTier>>;
     price_volume_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceVolumeTier>>;
+    price_frequency_tiers(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PriceFrequencyTier>>;
     attachments(priceId: string | Price, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     isPrice(resource: any): resource is Price;
     relationship(id: string | ResourceId | null): PriceRel;

package/lib/esm/resources/prices.js

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

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceId, ResourceRel } from '../resource';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourceRel } from '../resource';
 import type { PercentageDiscountPromotion } from './percentage_discount_promotions';
 import type { FreeShippingPromotion } from './free_shipping_promotions';
 import type { FreeGiftPromotion } from './free_gift_promotions';
@@ -11,7 +12,7 @@ type PromotionRuleRel = ResourceRel & {
 };
 interface PromotionRule extends Resource {
     readonly type: PromotionRuleType;
-    promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion;
+    promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | null;
 }
 declare class PromotionRules extends ApiResource<PromotionRule> {
     static readonly TYPE: PromotionRuleType;

package/lib/esm/resources/promotions.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 { Market } from './markets';
 import type { PromotionRule } from './promotion_rules';
@@ -6,6 +7,8 @@ import type { OrderAmountPromotionRule } from './order_amount_promotion_rules';
 import type { SkuListPromotionRule } from './sku_list_promotion_rules';
 import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
 import type { Attachment } from './attachments';
+import type { Event } from './events';
+import type { Tag } from './tags';
 type PromotionType = 'promotions';
 type PromotionRel = ResourceRel & {
     type: PromotionType;
@@ -13,18 +16,20 @@ type PromotionRel = ResourceRel & {
 interface Promotion extends Resource {
     readonly type: PromotionType;
     name: string;
-    currency_code?: string;
+    currency_code?: string | null;
     starts_at: string;
     expires_at: string;
     total_usage_limit: number;
-    total_usage_count?: number;
-    active?: boolean;
-    market?: Market;
-    promotion_rules?: PromotionRule[];
-    order_amount_promotion_rule?: OrderAmountPromotionRule;
-    sku_list_promotion_rule?: SkuListPromotionRule;
-    coupon_codes_promotion_rule?: CouponCodesPromotionRule;
-    attachments?: Attachment[];
+    total_usage_count?: number | null;
+    active?: boolean | null;
+    market?: Market | null;
+    promotion_rules?: PromotionRule[] | null;
+    order_amount_promotion_rule?: OrderAmountPromotionRule | null;
+    sku_list_promotion_rule?: SkuListPromotionRule | null;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRule | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
 }
 declare class Promotions extends ApiResource<Promotion> {
     static readonly TYPE: PromotionType;
@@ -33,6 +38,8 @@ declare class Promotions extends ApiResource<Promotion> {
     sku_list_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
     coupon_codes_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
     attachments(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    tags(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     isPromotion(resource: any): resource is Promotion;
     relationship(id: string | ResourceId | null): PromotionRel;
     type(): PromotionType;

package/lib/esm/resources/promotions.js

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

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

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

package/lib/esm/resources/recurring_order_copies.js

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

package/lib/esm/resources/refunds.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 { Capture } from './captures';
@@ -15,14 +16,14 @@ interface Refund 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_capture?: Capture;
-    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_capture?: Capture | null;
+    events?: Event[] | null;
 }
 declare class Refunds extends ApiResource<Refund> {
     static readonly TYPE: RefundType;

package/lib/esm/resources/return_line_items.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 { Return, ReturnType } from './returns';
 import type { LineItem, LineItemType } from './line_items';
@@ -14,25 +15,25 @@ type LineItemRel = ResourceRel & {
 };
 interface ReturnLineItem extends Resource {
     readonly type: ReturnLineItemType;
-    sku_code?: string;
-    bundle_code?: string;
-    name?: string;
+    sku_code?: string | null;
+    bundle_code?: string | null;
+    name?: string | null;
     quantity: number;
-    return_reason?: object;
-    restocked_at?: string;
-    return?: Return;
-    line_item?: LineItem;
+    return_reason?: Record<string, any> | null;
+    restocked_at?: string | null;
+    return?: Return | null;
+    line_item?: LineItem | null;
 }
 interface ReturnLineItemCreate extends ResourceCreate {
     quantity: number;
-    return_reason?: object;
+    return_reason?: Record<string, any> | null;
     return: ReturnRel;
     line_item: LineItemRel;
 }
 interface ReturnLineItemUpdate extends ResourceUpdate {
-    quantity: number;
-    _restock?: boolean;
-    return_reason?: object;
+    quantity?: number | null;
+    _restock?: boolean | null;
+    return_reason?: Record<string, any> | null;
 }
 declare class ReturnLineItems extends ApiResource<ReturnLineItem> {
     static readonly TYPE: ReturnLineItemType;

package/lib/esm/resources/returns.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 { Order, OrderType } from './orders';
 import type { Customer } from './customers';
@@ -7,6 +8,7 @@ import type { Address } from './addresses';
 import type { ReturnLineItem } from './return_line_items';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
+import type { Tag, TagType } from './tags';
 type ReturnType = 'returns';
 type ReturnRel = ResourceRel & {
     type: ReturnType;
@@ -17,42 +19,48 @@ type OrderRel = ResourceRel & {
 type StockLocationRel = ResourceRel & {
     type: StockLocationType;
 };
+type TagRel = ResourceRel & {
+    type: TagType;
+};
 interface Return extends Resource {
     readonly type: ReturnType;
-    number?: string;
-    status?: 'draft' | 'requested' | 'approved' | 'cancelled' | 'shipped' | 'rejected' | 'received';
-    customer_email?: string;
-    skus_count?: number;
-    approved_at?: string;
-    cancelled_at?: string;
-    shipped_at?: string;
-    rejected_at?: string;
-    received_at?: string;
-    archived_at?: string;
-    order?: Order;
-    customer?: Customer;
-    stock_location?: StockLocation;
-    origin_address?: Address;
-    destination_address?: Address;
-    return_line_items?: ReturnLineItem[];
-    attachments?: Attachment[];
-    events?: Event[];
+    number?: string | null;
+    status: 'draft' | 'requested' | 'approved' | 'cancelled' | 'shipped' | 'rejected' | 'received';
+    customer_email?: string | null;
+    skus_count?: number | null;
+    approved_at?: string | null;
+    cancelled_at?: string | null;
+    shipped_at?: string | null;
+    rejected_at?: string | null;
+    received_at?: string | null;
+    archived_at?: string | null;
+    order?: Order | null;
+    customer?: Customer | null;
+    stock_location?: StockLocation | null;
+    origin_address?: Address | null;
+    destination_address?: Address | null;
+    return_line_items?: ReturnLineItem[] | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
 }
 interface ReturnCreate extends ResourceCreate {
     order: OrderRel;
-    stock_location?: StockLocationRel;
+    stock_location?: StockLocationRel | null;
+    tags?: TagRel[] | null;
 }
 interface ReturnUpdate extends ResourceUpdate {
-    _request?: boolean;
-    _approve?: boolean;
-    _cancel?: boolean;
-    _ship?: boolean;
-    _reject?: boolean;
-    _receive?: boolean;
-    _restock?: boolean;
-    _archive?: boolean;
-    _unarchive?: boolean;
-    stock_location?: StockLocationRel;
+    _request?: boolean | null;
+    _approve?: boolean | null;
+    _cancel?: boolean | null;
+    _ship?: boolean | null;
+    _reject?: boolean | null;
+    _receive?: boolean | null;
+    _restock?: boolean | null;
+    _archive?: boolean | null;
+    _unarchive?: boolean | null;
+    stock_location?: StockLocationRel | null;
+    tags?: TagRel[] | null;
 }
 declare class Returns extends ApiResource<Return> {
     static readonly TYPE: ReturnType;
@@ -67,6 +75,7 @@ declare class Returns extends ApiResource<Return> {
     return_line_items(returnId: string | Return, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ReturnLineItem>>;
     attachments(returnId: string | Return, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     events(returnId: string | Return, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    tags(returnId: string | Return, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     isReturn(resource: any): resource is Return;
     relationship(id: string | ResourceId | null): ReturnRel;
     type(): ReturnType;

package/lib/esm/resources/returns.js

@@ -41,6 +41,10 @@ class Returns extends ApiResource {
         const _returnId = returnId.id || returnId;
         return this.resources.fetch({ type: 'events' }, `returns/${_returnId}/events`, params, options);
     }
+    async tags(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'tags' }, `returns/${_returnId}/tags`, params, options);
+    }
     isReturn(resource) {
         return resource.type && (resource.type === Returns.TYPE);
     }

package/lib/esm/resources/satispay_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 { SatispayPayment, SatispayPaymentType } from './satispay_payments';
@@ -12,17 +13,20 @@ type SatispayPaymentRel = ResourceRel & {
 interface SatispayGateway extends Resource {
     readonly type: SatispayGatewayType;
     name: string;
-    webhook_endpoint_url?: string;
-    payment_methods?: PaymentMethod[];
-    satispay_payments?: SatispayPayment[];
+    token: string;
+    key_id: string;
+    webhook_endpoint_url?: string | null;
+    payment_methods?: PaymentMethod[] | null;
+    satispay_payments?: SatispayPayment[] | null;
 }
 interface SatispayGatewayCreate extends ResourceCreate {
     name: string;
-    satispay_payments?: SatispayPaymentRel[];
+    token: string;
+    satispay_payments?: SatispayPaymentRel[] | null;
 }
 interface SatispayGatewayUpdate extends ResourceUpdate {
-    name: string;
-    satispay_payments?: SatispayPaymentRel[];
+    name?: string | null;
+    satispay_payments?: SatispayPaymentRel[] | null;
 }
 declare class SatispayGateways extends ApiResource<SatispayGateway> {
     static readonly TYPE: SatispayGatewayType;

package/lib/esm/resources/satispay_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';
@@ -11,22 +12,19 @@ type OrderRel = ResourceRel & {
 };
 interface SatispayPayment extends Resource {
     readonly type: SatispayPaymentType;
-    token?: string;
-    key_id: string;
-    payment_id?: string;
-    redirect_url?: string;
-    order?: Order;
-    payment_gateway?: PaymentGateway;
+    payment_id?: string | null;
+    redirect_url?: string | null;
+    order?: Order | null;
+    payment_gateway?: PaymentGateway | null;
 }
 interface SatispayPaymentCreate extends ResourceCreate {
-    token?: string;
-    redirect_url?: string;
+    redirect_url?: string | null;
     order: OrderRel;
 }
 interface SatispayPaymentUpdate extends ResourceUpdate {
-    redirect_url?: string;
-    _refresh?: boolean;
-    order?: OrderRel;
+    redirect_url?: string | null;
+    _refresh?: boolean | null;
+    order?: OrderRel | null;
 }
 declare class SatispayPayments extends ApiResource<SatispayPayment> {
     static readonly TYPE: SatispayPaymentType;