@commercelayer/sdk 4.33.0 → 4.34.0

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

@@ -1,6 +1,5 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
 import type { Market } from './markets';
 import type { PromotionRule } from './promotion_rules';
 import type { OrderAmountPromotionRule } from './order_amount_promotion_rules';
@@ -10,31 +9,33 @@ import type { SkuList } from './sku_lists';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
 import type { Tag } from './tags';
-type PromotionType = 'promotions';
+import type { Version } from './versions';
 type PromotionRel = ResourceRel & {
-    type: PromotionType;
+    type: typeof Promotions.TYPE;
 };
 interface Promotion extends Resource {
-    readonly type: PromotionType;
-    name: string;
-    currency_code?: string | null;
-    starts_at: string;
-    expires_at: string;
-    total_usage_limit: number;
-    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;
-    sku_list?: SkuList | null;
-    attachments?: Attachment[] | null;
-    events?: Event[] | null;
-    tags?: Tag[] | null;
+    name?: string;
+    currency_code?: string;
+    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;
+    sku_list?: SkuList;
+    attachments?: Attachment[];
+    events?: Event[];
+    tags?: Tag[];
+    versions?: Version[];
 }
-declare class Promotions extends ApiResource<Promotion> {
-    static readonly TYPE: PromotionType;
+declare class Promotions extends ApiResource {
+    static readonly TYPE: 'promotions';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Promotion>>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Promotion>;
     market(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     order_amount_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
     sku_list_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
@@ -43,9 +44,10 @@ declare class Promotions extends ApiResource<Promotion> {
     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>>;
+    versions(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isPromotion(resource: any): resource is Promotion;
     relationship(id: string | ResourceId | null): PromotionRel;
-    type(): PromotionType;
+    type(): string;
 }
 export default Promotions;
-export type { Promotion, PromotionType };
+export { Promotion };

package/lib/esm/resources/promotions.js

@@ -1,5 +1,12 @@
 import { ApiResource } from '../resource';
 class Promotions extends ApiResource {
+    // static readonly PATH = 'promotions'
+    async list(params, options) {
+        return this.resources.list({ type: Promotions.TYPE }, params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Promotions.TYPE, id }, params, options);
+    }
     async market(promotionId, params, options) {
         const _promotionId = promotionId.id || promotionId;
         return this.resources.fetch({ type: 'markets' }, `promotions/${_promotionId}/market`, params, options);
@@ -32,6 +39,11 @@ class Promotions extends ApiResource {
         const _promotionId = promotionId.id || promotionId;
         return this.resources.fetch({ type: 'tags' }, `promotions/${_promotionId}/tags`, params, options);
     }
+    async versions(promotionId, params, options) {
+        const _promotionId = promotionId.id || promotionId;
+        return this.resources.fetch({ type: 'versions' }, `promotions/${_promotionId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isPromotion(resource) {
         return resource.type && (resource.type === Promotions.TYPE);
     }

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

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

package/lib/esm/resources/recurring_order_copies.js

@@ -1,13 +1,20 @@
 import { ApiResource } from '../resource';
 class RecurringOrderCopies extends ApiResource {
+    // static readonly PATH = 'recurring_order_copies'
+    async list(params, options) {
+        return this.resources.list({ type: RecurringOrderCopies.TYPE }, params, options);
+    }
     async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: RecurringOrderCopies.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: RecurringOrderCopies.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: RecurringOrderCopies.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: RecurringOrderCopies.TYPE } : id, options);
+        await this.resources.delete({ type: RecurringOrderCopies.TYPE, id }, options);
     }
     async source_order(recurringOrderCopyId, params, options) {
         const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
@@ -25,6 +32,7 @@ class RecurringOrderCopies extends ApiResource {
         const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
         return this.resources.fetch({ type: 'order_subscriptions' }, `recurring_order_copies/${_recurringOrderCopyId}/order_subscription`, params, options);
     }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isRecurringOrderCopy(resource) {
         return resource.type && (resource.type === RecurringOrderCopies.TYPE);
     }

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

@@ -1,41 +1,43 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
 import type { Order } from './orders';
 import type { Attachment } from './attachments';
+import type { Version } from './versions';
 import type { Capture } from './captures';
 import type { Event } from './events';
-type RefundType = 'refunds';
 type RefundRel = ResourceRel & {
-    type: RefundType;
+    type: typeof Refunds.TYPE;
 };
 interface Refund extends Resource {
-    readonly type: RefundType;
-    number: string;
-    currency_code: string;
-    amount_cents: number;
-    amount_float: number;
-    formatted_amount: string;
-    succeeded: boolean;
-    message?: string | null;
-    error_code?: string | null;
-    error_detail?: string | null;
-    token?: string | null;
-    gateway_transaction_id?: string | null;
-    order?: Order | null;
-    attachments?: Attachment[] | null;
-    reference_capture?: Capture | null;
-    events?: Event[] | null;
+    number?: string;
+    currency_code?: string;
+    amount_cents?: number;
+    amount_float?: number;
+    formatted_amount?: string;
+    succeeded?: boolean;
+    message?: string;
+    error_code?: string;
+    error_detail?: string;
+    token?: string;
+    gateway_transaction_id?: string;
+    order?: Order;
+    attachments?: Attachment[];
+    versions?: Version[];
+    reference_capture?: Capture;
+    events?: Event[];
 }
-declare class Refunds extends ApiResource<Refund> {
-    static readonly TYPE: RefundType;
+declare class Refunds extends ApiResource {
+    static readonly TYPE: 'refunds';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Refund>>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Refund>;
     order(refundId: string | Refund, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     attachments(refundId: string | Refund, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    versions(refundId: string | Refund, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     reference_capture(refundId: string | Refund, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Capture>;
     events(refundId: string | Refund, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     isRefund(resource: any): resource is Refund;
     relationship(id: string | ResourceId | null): RefundRel;
-    type(): RefundType;
+    type(): string;
 }
 export default Refunds;
-export type { Refund, RefundType };
+export { Refund };

package/lib/esm/resources/refunds.js

@@ -1,5 +1,12 @@
 import { ApiResource } from '../resource';
 class Refunds extends ApiResource {
+    // static readonly PATH = 'refunds'
+    async list(params, options) {
+        return this.resources.list({ type: Refunds.TYPE }, params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Refunds.TYPE, id }, params, options);
+    }
     async order(refundId, params, options) {
         const _refundId = refundId.id || refundId;
         return this.resources.fetch({ type: 'orders' }, `refunds/${_refundId}/order`, params, options);
@@ -8,6 +15,10 @@ class Refunds extends ApiResource {
         const _refundId = refundId.id || refundId;
         return this.resources.fetch({ type: 'attachments' }, `refunds/${_refundId}/attachments`, params, options);
     }
+    async versions(refundId, params, options) {
+        const _refundId = refundId.id || refundId;
+        return this.resources.fetch({ type: 'versions' }, `refunds/${_refundId}/versions`, params, options);
+    }
     async reference_capture(refundId, params, options) {
         const _refundId = refundId.id || refundId;
         return this.resources.fetch({ type: 'captures' }, `refunds/${_refundId}/reference_capture`, params, options);
@@ -16,6 +27,7 @@ class Refunds extends ApiResource {
         const _refundId = refundId.id || refundId;
         return this.resources.fetch({ type: 'events' }, `refunds/${_refundId}/events`, params, options);
     }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isRefund(resource) {
         return resource.type && (resource.type === Refunds.TYPE);
     }

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

@@ -1,28 +1,27 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
 import type { StockItem } from './stock_items';
 import type { Sku } from './skus';
 import type { StockReservation } from './stock_reservations';
-type ReservedStockType = 'reserved_stocks';
 type ReservedStockRel = ResourceRel & {
-    type: ReservedStockType;
+    type: typeof ReservedStocks.TYPE;
 };
 interface ReservedStock extends Resource {
-    readonly type: ReservedStockType;
-    quantity: number;
-    stock_item?: StockItem | null;
-    sku?: Sku | null;
-    stock_reservations?: StockReservation[] | null;
+    quantity?: number;
+    stock_item?: StockItem;
+    sku?: Sku;
+    stock_reservations?: StockReservation[];
 }
-declare class ReservedStocks extends ApiResource<ReservedStock> {
-    static readonly TYPE: ReservedStockType;
+declare class ReservedStocks extends ApiResource {
+    static readonly TYPE: 'reserved_stocks';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ReservedStock>>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ReservedStock>;
     stock_item(reservedStockId: string | ReservedStock, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockItem>;
     sku(reservedStockId: string | ReservedStock, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
     stock_reservations(reservedStockId: string | ReservedStock, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockReservation>>;
     isReservedStock(resource: any): resource is ReservedStock;
     relationship(id: string | ResourceId | null): ReservedStockRel;
-    type(): ReservedStockType;
+    type(): string;
 }
 export default ReservedStocks;
-export type { ReservedStock, ReservedStockType };
+export { ReservedStock };

package/lib/esm/resources/reserved_stocks.js

@@ -1,5 +1,12 @@
 import { ApiResource } from '../resource';
 class ReservedStocks extends ApiResource {
+    // static readonly PATH = 'reserved_stocks'
+    async list(params, options) {
+        return this.resources.list({ type: ReservedStocks.TYPE }, params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: ReservedStocks.TYPE, id }, params, options);
+    }
     async stock_item(reservedStockId, params, options) {
         const _reservedStockId = reservedStockId.id || reservedStockId;
         return this.resources.fetch({ type: 'stock_items' }, `reserved_stocks/${_reservedStockId}/stock_item`, params, options);
@@ -12,6 +19,7 @@ class ReservedStocks extends ApiResource {
         const _reservedStockId = reservedStockId.id || reservedStockId;
         return this.resources.fetch({ type: 'stock_reservations' }, `reserved_stocks/${_reservedStockId}/stock_reservations`, params, options);
     }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isReservedStock(resource) {
         return resource.type && (resource.type === ReservedStocks.TYPE);
     }

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

@@ -1,51 +1,50 @@
-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';
-type ReturnLineItemType = 'return_line_items';
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import type { Return } from './returns';
+import type { LineItem } from './line_items';
 type ReturnLineItemRel = ResourceRel & {
-    type: ReturnLineItemType;
+    type: typeof ReturnLineItems.TYPE;
 };
 type ReturnRel = ResourceRel & {
-    type: ReturnType;
+    type: 'returns';
 };
 type LineItemRel = ResourceRel & {
-    type: LineItemType;
+    type: 'line_items';
 };
 interface ReturnLineItem extends Resource {
-    readonly type: ReturnLineItemType;
-    sku_code?: string | null;
-    bundle_code?: string | null;
-    quantity: number;
-    name?: string | null;
-    image_url?: string | null;
-    return_reason?: Record<string, any> | null;
-    restocked_at?: string | null;
-    return?: Return | null;
-    line_item?: LineItem | null;
+    sku_code?: string;
+    bundle_code?: string;
+    quantity?: number;
+    name?: string;
+    image_url?: string;
+    return_reason?: object;
+    restocked_at?: string;
+    return?: Return;
+    line_item?: LineItem;
 }
 interface ReturnLineItemCreate extends ResourceCreate {
     quantity: number;
-    return_reason?: Record<string, any> | null;
+    return_reason?: object;
     return: ReturnRel;
     line_item: LineItemRel;
 }
 interface ReturnLineItemUpdate extends ResourceUpdate {
-    quantity?: number | null;
-    _restock?: boolean | null;
-    return_reason?: Record<string, any> | null;
+    quantity?: number;
+    _restock?: boolean;
+    return_reason?: object;
 }
-declare class ReturnLineItems extends ApiResource<ReturnLineItem> {
-    static readonly TYPE: ReturnLineItemType;
+declare class ReturnLineItems extends ApiResource {
+    static readonly TYPE: 'return_line_items';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ReturnLineItem>>;
     create(resource: ReturnLineItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ReturnLineItem>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ReturnLineItem>;
     update(resource: ReturnLineItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ReturnLineItem>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     return(returnLineItemId: string | ReturnLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Return>;
     line_item(returnLineItemId: string | ReturnLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<LineItem>;
     isReturnLineItem(resource: any): resource is ReturnLineItem;
     relationship(id: string | ResourceId | null): ReturnLineItemRel;
-    type(): ReturnLineItemType;
+    type(): string;
 }
 export default ReturnLineItems;
-export type { ReturnLineItem, ReturnLineItemCreate, ReturnLineItemUpdate, ReturnLineItemType };
+export { ReturnLineItem, ReturnLineItemCreate, ReturnLineItemUpdate };

package/lib/esm/resources/return_line_items.js

@@ -1,13 +1,20 @@
 import { ApiResource } from '../resource';
 class ReturnLineItems extends ApiResource {
+    // static readonly PATH = 'return_line_items'
+    async list(params, options) {
+        return this.resources.list({ type: ReturnLineItems.TYPE }, params, options);
+    }
     async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: ReturnLineItems.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ReturnLineItems.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: ReturnLineItems.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: ReturnLineItems.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ReturnLineItems.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: ReturnLineItems.TYPE } : id, options);
+        await this.resources.delete({ type: ReturnLineItems.TYPE, id }, options);
     }
     async return(returnLineItemId, params, options) {
         const _returnLineItemId = returnLineItemId.id || returnLineItemId;
@@ -17,6 +24,7 @@ class ReturnLineItems extends ApiResource {
         const _returnLineItemId = returnLineItemId.id || returnLineItemId;
         return this.resources.fetch({ type: 'line_items' }, `return_line_items/${_returnLineItemId}/line_item`, params, options);
     }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isReturnLineItem(resource) {
         return resource.type && (resource.type === ReturnLineItems.TYPE);
     }

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

@@ -1,72 +1,73 @@
-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 { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import type { Order } from './orders';
 import type { Customer } from './customers';
-import type { StockLocation, StockLocationType } from './stock_locations';
+import type { StockLocation } from './stock_locations';
 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';
+import type { Tag } from './tags';
+import type { Version } from './versions';
 type ReturnRel = ResourceRel & {
-    type: ReturnType;
+    type: typeof Returns.TYPE;
 };
 type OrderRel = ResourceRel & {
-    type: OrderType;
+    type: 'orders';
 };
 type StockLocationRel = ResourceRel & {
-    type: StockLocationType;
+    type: 'stock_locations';
 };
 type TagRel = ResourceRel & {
-    type: TagType;
+    type: 'tags';
 };
 interface Return extends Resource {
-    readonly type: ReturnType;
-    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;
+    number?: string;
+    status?: string;
+    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[];
+    tags?: Tag[];
+    versions?: Version[];
 }
 interface ReturnCreate extends ResourceCreate {
     order: OrderRel;
-    stock_location?: StockLocationRel | null;
-    tags?: TagRel[] | null;
+    stock_location?: StockLocationRel;
+    tags?: TagRel[];
 }
 interface ReturnUpdate extends ResourceUpdate {
-    _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;
+    _request?: boolean;
+    _approve?: boolean;
+    _cancel?: boolean;
+    _ship?: boolean;
+    _reject?: boolean;
+    _receive?: boolean;
+    _restock?: boolean;
+    _archive?: boolean;
+    _unarchive?: boolean;
+    stock_location?: StockLocationRel;
+    tags?: TagRel[];
 }
-declare class Returns extends ApiResource<Return> {
-    static readonly TYPE: ReturnType;
+declare class Returns extends ApiResource {
+    static readonly TYPE: 'returns';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Return>>;
     create(resource: ReturnCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Return>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Return>;
     update(resource: ReturnUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Return>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     order(returnId: string | Return, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     customer(returnId: string | Return, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
     stock_location(returnId: string | Return, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
@@ -76,9 +77,10 @@ declare class Returns extends ApiResource<Return> {
     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>>;
+    versions(returnId: string | Return, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isReturn(resource: any): resource is Return;
     relationship(id: string | ResourceId | null): ReturnRel;
-    type(): ReturnType;
+    type(): string;
 }
 export default Returns;
-export type { Return, ReturnCreate, ReturnUpdate, ReturnType };
+export { Return, ReturnCreate, ReturnUpdate };