@commercelayer/sdk 4.22.0 → 4.23.0

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

@@ -1 +1,41 @@
-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';import type{SkuListPromotionRule}from'./sku_list_promotion_rules';import type{CouponCodesPromotionRule}from'./coupon_codes_promotion_rules';import type{Attachment}from'./attachments';type PromotionRel=ResourceRel&{type:typeof Promotions.TYPE;};interface Promotion extends Resource{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;attachments?:Attachment[];}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>;coupon_codes_promotion_rule(promotionId:string|Promotion,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<CouponCodesPromotionRule>;attachments(promotionId:string|Promotion,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Attachment>>;isPromotion(resource:any):resource is Promotion;relationship(id:string|ResourceId|null):PromotionRel;type():string;}export default Promotions;export{Promotion};
+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';
+import type { SkuListPromotionRule } from './sku_list_promotion_rules';
+import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
+import type { Attachment } from './attachments';
+type PromotionRel = ResourceRel & {
+    type: typeof Promotions.TYPE;
+};
+interface Promotion extends Resource {
+    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;
+    attachments?: Attachment[];
+}
+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>;
+    coupon_codes_promotion_rule(promotionId: string | Promotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
+    attachments(promotionId: string | Promotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isPromotion(resource: any): resource is Promotion;
+    relationship(id: string | ResourceId | null): PromotionRel;
+    type(): string;
+}
+export default Promotions;
+export { Promotion };

package/lib/esm/resources/promotions.js

@@ -1 +1,42 @@
-import{ApiResource as n}from"../resource";class s extends n{async list(t,r){return this.resources.list({type:s.TYPE},t,r)}async retrieve(t,r,e){return this.resources.retrieve({type:s.TYPE,id:t},r,e)}async market(t,r,e){const o=t.id||t;return this.resources.fetch({type:"markets"},`promotions/${o}/market`,r,e)}async order_amount_promotion_rule(t,r,e){const o=t.id||t;return this.resources.fetch({type:"order_amount_promotion_rules"},`promotions/${o}/order_amount_promotion_rule`,r,e)}async sku_list_promotion_rule(t,r,e){const o=t.id||t;return this.resources.fetch({type:"sku_list_promotion_rules"},`promotions/${o}/sku_list_promotion_rule`,r,e)}async coupon_codes_promotion_rule(t,r,e){const o=t.id||t;return this.resources.fetch({type:"coupon_codes_promotion_rules"},`promotions/${o}/coupon_codes_promotion_rule`,r,e)}async attachments(t,r,e){const o=t.id||t;return this.resources.fetch({type:"attachments"},`promotions/${o}/attachments`,r,e)}isPromotion(t){return t.type&&t.type===s.TYPE}relationship(t){return t===null||typeof t=="string"?{id:t,type:s.TYPE}:{id:t.id,type:s.TYPE}}type(){return s.TYPE}}s.TYPE="promotions";export default s;
+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);
+    }
+    async order_amount_promotion_rule(promotionId, params, options) {
+        const _promotionId = promotionId.id || promotionId;
+        return this.resources.fetch({ type: 'order_amount_promotion_rules' }, `promotions/${_promotionId}/order_amount_promotion_rule`, params, options);
+    }
+    async sku_list_promotion_rule(promotionId, params, options) {
+        const _promotionId = promotionId.id || promotionId;
+        return this.resources.fetch({ type: 'sku_list_promotion_rules' }, `promotions/${_promotionId}/sku_list_promotion_rule`, params, options);
+    }
+    async coupon_codes_promotion_rule(promotionId, params, options) {
+        const _promotionId = promotionId.id || promotionId;
+        return this.resources.fetch({ type: 'coupon_codes_promotion_rules' }, `promotions/${_promotionId}/coupon_codes_promotion_rule`, params, options);
+    }
+    async attachments(promotionId, params, options) {
+        const _promotionId = promotionId.id || promotionId;
+        return this.resources.fetch({ type: 'attachments' }, `promotions/${_promotionId}/attachments`, 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);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Promotions.TYPE } : { id: id.id, type: Promotions.TYPE };
+    }
+    type() {
+        return Promotions.TYPE;
+    }
+}
+Promotions.TYPE = 'promotions';
+export default Promotions;

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

@@ -1 +1,37 @@
-import{ApiResource,Resource,ResourcesConfig,ResourceId,ResourceRel,ListResponse}from'../resource';import type{QueryParamsList,QueryParamsRetrieve}from'../query';import type{Order}from'./orders';import type{Capture}from'./captures';import type{Event}from'./events';type RefundRel=ResourceRel&{type:typeof Refunds.TYPE;};interface Refund extends Resource{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;reference_capture?:Capture;events?:Event[];}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>;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():string;}export default Refunds;export{Refund};
+import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import type { Order } from './orders';
+import type { Capture } from './captures';
+import type { Event } from './events';
+type RefundRel = ResourceRel & {
+    type: typeof Refunds.TYPE;
+};
+interface Refund extends Resource {
+    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;
+    reference_capture?: Capture;
+    events?: Event[];
+}
+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>;
+    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(): string;
+}
+export default Refunds;
+export { Refund };

package/lib/esm/resources/refunds.js

@@ -1 +1,34 @@
-import{ApiResource as c}from"../resource";class t extends c{async list(e,r){return this.resources.list({type:t.TYPE},e,r)}async retrieve(e,r,s){return this.resources.retrieve({type:t.TYPE,id:e},r,s)}async order(e,r,s){const n=e.id||e;return this.resources.fetch({type:"orders"},`refunds/${n}/order`,r,s)}async reference_capture(e,r,s){const n=e.id||e;return this.resources.fetch({type:"captures"},`refunds/${n}/reference_capture`,r,s)}async events(e,r,s){const n=e.id||e;return this.resources.fetch({type:"events"},`refunds/${n}/events`,r,s)}isRefund(e){return e.type&&e.type===t.TYPE}relationship(e){return e===null||typeof e=="string"?{id:e,type:t.TYPE}:{id:e.id,type:t.TYPE}}type(){return t.TYPE}}t.TYPE="refunds";export default t;
+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);
+    }
+    async reference_capture(refundId, params, options) {
+        const _refundId = refundId.id || refundId;
+        return this.resources.fetch({ type: 'captures' }, `refunds/${_refundId}/reference_capture`, params, options);
+    }
+    async events(refundId, params, options) {
+        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);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Refunds.TYPE } : { id: id.id, type: Refunds.TYPE };
+    }
+    type() {
+        return Refunds.TYPE;
+    }
+}
+Refunds.TYPE = 'refunds';
+export default Refunds;

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

@@ -1 +1,49 @@
-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:typeof ReturnLineItems.TYPE;};type ReturnRel=ResourceRel&{type:'returns';};type LineItemRel=ResourceRel&{type:'line_items';};interface ReturnLineItem extends Resource{sku_code?:string;bundle_code?:string;name?:string;quantity?:number;return_reason?:object;restocked_at?:string;return?:Return;line_item?:LineItem;}interface ReturnLineItemCreate extends ResourceCreate{quantity:number;return_reason?:object;return:ReturnRel;line_item:LineItemRel;}interface ReturnLineItemUpdate extends ResourceUpdate{quantity?:number;_restock?:boolean;return_reason?:object;}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,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():string;}export default ReturnLineItems;export{ReturnLineItem,ReturnLineItemCreate,ReturnLineItemUpdate};
+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: typeof ReturnLineItems.TYPE;
+};
+type ReturnRel = ResourceRel & {
+    type: 'returns';
+};
+type LineItemRel = ResourceRel & {
+    type: 'line_items';
+};
+interface ReturnLineItem extends Resource {
+    sku_code?: string;
+    bundle_code?: string;
+    name?: string;
+    quantity?: number;
+    return_reason?: object;
+    restocked_at?: string;
+    return?: Return;
+    line_item?: LineItem;
+}
+interface ReturnLineItemCreate extends ResourceCreate {
+    quantity: number;
+    return_reason?: object;
+    return: ReturnRel;
+    line_item: LineItemRel;
+}
+interface ReturnLineItemUpdate extends ResourceUpdate {
+    quantity?: number;
+    _restock?: boolean;
+    return_reason?: object;
+}
+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, 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(): string;
+}
+export default ReturnLineItems;
+export { ReturnLineItem, ReturnLineItemCreate, ReturnLineItemUpdate };

package/lib/esm/resources/return_line_items.js

@@ -1 +1,39 @@
-import{ApiResource as n}from"../resource";class r extends n{async list(e,t){return this.resources.list({type:r.TYPE},e,t)}async create(e,t,s){return this.resources.create(Object.assign(Object.assign({},e),{type:r.TYPE}),t,s)}async retrieve(e,t,s){return this.resources.retrieve({type:r.TYPE,id:e},t,s)}async update(e,t,s){return this.resources.update(Object.assign(Object.assign({},e),{type:r.TYPE}),t,s)}async delete(e,t){await this.resources.delete({type:r.TYPE,id:e},t)}async return(e,t,s){const i=e.id||e;return this.resources.fetch({type:"returns"},`return_line_items/${i}/return`,t,s)}async line_item(e,t,s){const i=e.id||e;return this.resources.fetch({type:"line_items"},`return_line_items/${i}/line_item`,t,s)}isReturnLineItem(e){return e.type&&e.type===r.TYPE}relationship(e){return e===null||typeof e=="string"?{id:e,type:r.TYPE}:{id:e.id,type:r.TYPE}}type(){return r.TYPE}}r.TYPE="return_line_items";export default r;
+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(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(Object.assign(Object.assign({}, resource), { type: ReturnLineItems.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete({ type: ReturnLineItems.TYPE, id }, options);
+    }
+    async return(returnLineItemId, params, options) {
+        const _returnLineItemId = returnLineItemId.id || returnLineItemId;
+        return this.resources.fetch({ type: 'returns' }, `return_line_items/${_returnLineItemId}/return`, params, options);
+    }
+    async line_item(returnLineItemId, params, options) {
+        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);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: ReturnLineItems.TYPE } : { id: id.id, type: ReturnLineItems.TYPE };
+    }
+    type() {
+        return ReturnLineItems.TYPE;
+    }
+}
+ReturnLineItems.TYPE = 'return_line_items';
+export default ReturnLineItems;

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

@@ -1 +1,75 @@
-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}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';type ReturnRel=ResourceRel&{type:typeof Returns.TYPE;};type OrderRel=ResourceRel&{type:'orders';};type StockLocationRel=ResourceRel&{type:'stock_locations';};interface Return extends Resource{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[];}interface ReturnCreate extends ResourceCreate{order:OrderRel;stock_location?:StockLocationRel;}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;}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,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>;origin_address(returnId:string|Return,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Address>;destination_address(returnId:string|Return,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Address>;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>>;isReturn(resource:any):resource is Return;relationship(id:string|ResourceId|null):ReturnRel;type():string;}export default Returns;export{Return,ReturnCreate,ReturnUpdate};
+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 } 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';
+type ReturnRel = ResourceRel & {
+    type: typeof Returns.TYPE;
+};
+type OrderRel = ResourceRel & {
+    type: 'orders';
+};
+type StockLocationRel = ResourceRel & {
+    type: 'stock_locations';
+};
+interface Return extends Resource {
+    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[];
+}
+interface ReturnCreate extends ResourceCreate {
+    order: OrderRel;
+    stock_location?: StockLocationRel;
+}
+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;
+}
+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, 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>;
+    origin_address(returnId: string | Return, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    destination_address(returnId: string | Return, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    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>>;
+    isReturn(resource: any): resource is Return;
+    relationship(id: string | ResourceId | null): ReturnRel;
+    type(): string;
+}
+export default Returns;
+export { Return, ReturnCreate, ReturnUpdate };

package/lib/esm/resources/returns.js

@@ -1 +1,63 @@
-import{ApiResource as c}from"../resource";class n extends c{async list(e,t){return this.resources.list({type:n.TYPE},e,t)}async create(e,t,s){return this.resources.create(Object.assign(Object.assign({},e),{type:n.TYPE}),t,s)}async retrieve(e,t,s){return this.resources.retrieve({type:n.TYPE,id:e},t,s)}async update(e,t,s){return this.resources.update(Object.assign(Object.assign({},e),{type:n.TYPE}),t,s)}async delete(e,t){await this.resources.delete({type:n.TYPE,id:e},t)}async order(e,t,s){const r=e.id||e;return this.resources.fetch({type:"orders"},`returns/${r}/order`,t,s)}async customer(e,t,s){const r=e.id||e;return this.resources.fetch({type:"customers"},`returns/${r}/customer`,t,s)}async stock_location(e,t,s){const r=e.id||e;return this.resources.fetch({type:"stock_locations"},`returns/${r}/stock_location`,t,s)}async origin_address(e,t,s){const r=e.id||e;return this.resources.fetch({type:"addresses"},`returns/${r}/origin_address`,t,s)}async destination_address(e,t,s){const r=e.id||e;return this.resources.fetch({type:"addresses"},`returns/${r}/destination_address`,t,s)}async return_line_items(e,t,s){const r=e.id||e;return this.resources.fetch({type:"return_line_items"},`returns/${r}/return_line_items`,t,s)}async attachments(e,t,s){const r=e.id||e;return this.resources.fetch({type:"attachments"},`returns/${r}/attachments`,t,s)}async events(e,t,s){const r=e.id||e;return this.resources.fetch({type:"events"},`returns/${r}/events`,t,s)}isReturn(e){return e.type&&e.type===n.TYPE}relationship(e){return e===null||typeof e=="string"?{id:e,type:n.TYPE}:{id:e.id,type:n.TYPE}}type(){return n.TYPE}}n.TYPE="returns";export default n;
+import { ApiResource } from '../resource';
+class Returns extends ApiResource {
+    // static readonly PATH = 'returns'
+    async list(params, options) {
+        return this.resources.list({ type: Returns.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Returns.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Returns.TYPE, id }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Returns.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete({ type: Returns.TYPE, id }, options);
+    }
+    async order(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'orders' }, `returns/${_returnId}/order`, params, options);
+    }
+    async customer(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'customers' }, `returns/${_returnId}/customer`, params, options);
+    }
+    async stock_location(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'stock_locations' }, `returns/${_returnId}/stock_location`, params, options);
+    }
+    async origin_address(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'addresses' }, `returns/${_returnId}/origin_address`, params, options);
+    }
+    async destination_address(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'addresses' }, `returns/${_returnId}/destination_address`, params, options);
+    }
+    async return_line_items(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'return_line_items' }, `returns/${_returnId}/return_line_items`, params, options);
+    }
+    async attachments(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'attachments' }, `returns/${_returnId}/attachments`, params, options);
+    }
+    async events(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'events' }, `returns/${_returnId}/events`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isReturn(resource) {
+        return resource.type && (resource.type === Returns.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Returns.TYPE } : { id: id.id, type: Returns.TYPE };
+    }
+    type() {
+        return Returns.TYPE;
+    }
+}
+Returns.TYPE = 'returns';
+export default Returns;

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

@@ -1 +1,93 @@
-import{ApiResource,Resource,ResourceUpdate,ResourcesConfig,ResourceId,ResourceRel,ListResponse}from'../resource';import type{QueryParamsList,QueryParamsRetrieve}from'../query';import type{Order}from'./orders';import type{ShippingCategory}from'./shipping_categories';import type{StockLocation}from'./stock_locations';import type{Address}from'./addresses';import type{ShippingMethod}from'./shipping_methods';import type{DeliveryLeadTime}from'./delivery_lead_times';import type{StockLineItem}from'./stock_line_items';import type{StockTransfer}from'./stock_transfers';import type{CarrierAccount}from'./carrier_accounts';import type{Parcel}from'./parcels';import type{Attachment}from'./attachments';import type{Event}from'./events';type ShipmentRel=ResourceRel&{type:typeof Shipments.TYPE;};type ShippingMethodRel=ResourceRel&{type:'shipping_methods';};interface Shipment extends Resource{number?:string;status?:string;currency_code?:string;cost_amount_cents?:number;cost_amount_float?:number;formatted_cost_amount?:string;skus_count?:number;selected_rate_id?:string;rates?:object[];purchase_error_code?:string;purchase_error_message?:string;get_rates_errors?:object[];get_rates_started_at?:string;get_rates_completed_at?:string;purchase_started_at?:string;purchase_completed_at?:string;purchase_failed_at?:string;order?:Order;shipping_category?:ShippingCategory;stock_location?:StockLocation;origin_address?:Address;shipping_address?:Address;shipping_method?:ShippingMethod;delivery_lead_time?:DeliveryLeadTime;shipment_line_items?:object[];stock_line_items?:StockLineItem[];stock_transfers?:StockTransfer[];available_shipping_methods?:ShippingMethod[];carrier_accounts?:CarrierAccount[];parcels?:Parcel[];attachments?:Attachment[];events?:Event[];}interface ShipmentUpdate extends ResourceUpdate{_on_hold?:boolean;_picking?:boolean;_packing?:boolean;_ready_to_ship?:boolean;_ship?:boolean;_get_rates?:boolean;selected_rate_id?:string;_purchase?:boolean;shipping_method?:ShippingMethodRel;}declare class Shipments extends ApiResource{static readonly TYPE:'shipments';list(params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Shipment>>;retrieve(id:string,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Shipment>;update(resource:ShipmentUpdate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Shipment>;order(shipmentId:string|Shipment,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Order>;shipping_category(shipmentId:string|Shipment,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<ShippingCategory>;stock_location(shipmentId:string|Shipment,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<StockLocation>;origin_address(shipmentId:string|Shipment,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Address>;shipping_address(shipmentId:string|Shipment,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Address>;shipping_method(shipmentId:string|Shipment,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<ShippingMethod>;delivery_lead_time(shipmentId:string|Shipment,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<DeliveryLeadTime>;stock_line_items(shipmentId:string|Shipment,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<StockLineItem>>;stock_transfers(shipmentId:string|Shipment,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<StockTransfer>>;available_shipping_methods(shipmentId:string|Shipment,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<ShippingMethod>>;carrier_accounts(shipmentId:string|Shipment,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<CarrierAccount>>;parcels(shipmentId:string|Shipment,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Parcel>>;attachments(shipmentId:string|Shipment,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Attachment>>;events(shipmentId:string|Shipment,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Event>>;isShipment(resource:any):resource is Shipment;relationship(id:string|ResourceId|null):ShipmentRel;type():string;}export default Shipments;export{Shipment,ShipmentUpdate};
+import { ApiResource, Resource, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import type { Order } from './orders';
+import type { ShippingCategory } from './shipping_categories';
+import type { StockLocation } from './stock_locations';
+import type { Address } from './addresses';
+import type { ShippingMethod } from './shipping_methods';
+import type { DeliveryLeadTime } from './delivery_lead_times';
+import type { StockLineItem } from './stock_line_items';
+import type { StockTransfer } from './stock_transfers';
+import type { CarrierAccount } from './carrier_accounts';
+import type { Parcel } from './parcels';
+import type { Attachment } from './attachments';
+import type { Event } from './events';
+type ShipmentRel = ResourceRel & {
+    type: typeof Shipments.TYPE;
+};
+type ShippingMethodRel = ResourceRel & {
+    type: 'shipping_methods';
+};
+interface Shipment extends Resource {
+    number?: string;
+    status?: string;
+    currency_code?: string;
+    cost_amount_cents?: number;
+    cost_amount_float?: number;
+    formatted_cost_amount?: string;
+    skus_count?: number;
+    selected_rate_id?: string;
+    rates?: object[];
+    purchase_error_code?: string;
+    purchase_error_message?: string;
+    get_rates_errors?: object[];
+    get_rates_started_at?: string;
+    get_rates_completed_at?: string;
+    purchase_started_at?: string;
+    purchase_completed_at?: string;
+    purchase_failed_at?: string;
+    order?: Order;
+    shipping_category?: ShippingCategory;
+    stock_location?: StockLocation;
+    origin_address?: Address;
+    shipping_address?: Address;
+    shipping_method?: ShippingMethod;
+    delivery_lead_time?: DeliveryLeadTime;
+    /**
+    * @deprecated This field should not be used as it may be removed in the future without notice
+    */
+    shipment_line_items?: object[];
+    stock_line_items?: StockLineItem[];
+    stock_transfers?: StockTransfer[];
+    available_shipping_methods?: ShippingMethod[];
+    carrier_accounts?: CarrierAccount[];
+    parcels?: Parcel[];
+    attachments?: Attachment[];
+    events?: Event[];
+}
+interface ShipmentUpdate extends ResourceUpdate {
+    _on_hold?: boolean;
+    _picking?: boolean;
+    _packing?: boolean;
+    _ready_to_ship?: boolean;
+    _ship?: boolean;
+    _get_rates?: boolean;
+    selected_rate_id?: string;
+    _purchase?: boolean;
+    shipping_method?: ShippingMethodRel;
+}
+declare class Shipments extends ApiResource {
+    static readonly TYPE: 'shipments';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Shipment>>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    update(resource: ShipmentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    order(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    shipping_category(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingCategory>;
+    stock_location(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
+    origin_address(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    shipping_address(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    shipping_method(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
+    delivery_lead_time(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<DeliveryLeadTime>;
+    stock_line_items(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockLineItem>>;
+    stock_transfers(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockTransfer>>;
+    available_shipping_methods(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ShippingMethod>>;
+    carrier_accounts(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CarrierAccount>>;
+    parcels(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Parcel>>;
+    attachments(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isShipment(resource: any): resource is Shipment;
+    relationship(id: string | ResourceId | null): ShipmentRel;
+    type(): string;
+}
+export default Shipments;
+export { Shipment, ShipmentUpdate };

package/lib/esm/resources/shipments.js

@@ -1 +1,81 @@
-import{ApiResource as n}from"../resource";class i extends n{async list(s,e){return this.resources.list({type:i.TYPE},s,e)}async retrieve(s,e,t){return this.resources.retrieve({type:i.TYPE,id:s},e,t)}async update(s,e,t){return this.resources.update(Object.assign(Object.assign({},s),{type:i.TYPE}),e,t)}async order(s,e,t){const r=s.id||s;return this.resources.fetch({type:"orders"},`shipments/${r}/order`,e,t)}async shipping_category(s,e,t){const r=s.id||s;return this.resources.fetch({type:"shipping_categories"},`shipments/${r}/shipping_category`,e,t)}async stock_location(s,e,t){const r=s.id||s;return this.resources.fetch({type:"stock_locations"},`shipments/${r}/stock_location`,e,t)}async origin_address(s,e,t){const r=s.id||s;return this.resources.fetch({type:"addresses"},`shipments/${r}/origin_address`,e,t)}async shipping_address(s,e,t){const r=s.id||s;return this.resources.fetch({type:"addresses"},`shipments/${r}/shipping_address`,e,t)}async shipping_method(s,e,t){const r=s.id||s;return this.resources.fetch({type:"shipping_methods"},`shipments/${r}/shipping_method`,e,t)}async delivery_lead_time(s,e,t){const r=s.id||s;return this.resources.fetch({type:"delivery_lead_times"},`shipments/${r}/delivery_lead_time`,e,t)}async stock_line_items(s,e,t){const r=s.id||s;return this.resources.fetch({type:"stock_line_items"},`shipments/${r}/stock_line_items`,e,t)}async stock_transfers(s,e,t){const r=s.id||s;return this.resources.fetch({type:"stock_transfers"},`shipments/${r}/stock_transfers`,e,t)}async available_shipping_methods(s,e,t){const r=s.id||s;return this.resources.fetch({type:"shipping_methods"},`shipments/${r}/available_shipping_methods`,e,t)}async carrier_accounts(s,e,t){const r=s.id||s;return this.resources.fetch({type:"carrier_accounts"},`shipments/${r}/carrier_accounts`,e,t)}async parcels(s,e,t){const r=s.id||s;return this.resources.fetch({type:"parcels"},`shipments/${r}/parcels`,e,t)}async attachments(s,e,t){const r=s.id||s;return this.resources.fetch({type:"attachments"},`shipments/${r}/attachments`,e,t)}async events(s,e,t){const r=s.id||s;return this.resources.fetch({type:"events"},`shipments/${r}/events`,e,t)}isShipment(s){return s.type&&s.type===i.TYPE}relationship(s){return s===null||typeof s=="string"?{id:s,type:i.TYPE}:{id:s.id,type:i.TYPE}}type(){return i.TYPE}}i.TYPE="shipments";export default i;
+import { ApiResource } from '../resource';
+class Shipments extends ApiResource {
+    // static readonly PATH = 'shipments'
+    async list(params, options) {
+        return this.resources.list({ type: Shipments.TYPE }, params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Shipments.TYPE, id }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Shipments.TYPE }), params, options);
+    }
+    async order(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'orders' }, `shipments/${_shipmentId}/order`, params, options);
+    }
+    async shipping_category(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'shipping_categories' }, `shipments/${_shipmentId}/shipping_category`, params, options);
+    }
+    async stock_location(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'stock_locations' }, `shipments/${_shipmentId}/stock_location`, params, options);
+    }
+    async origin_address(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'addresses' }, `shipments/${_shipmentId}/origin_address`, params, options);
+    }
+    async shipping_address(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'addresses' }, `shipments/${_shipmentId}/shipping_address`, params, options);
+    }
+    async shipping_method(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'shipping_methods' }, `shipments/${_shipmentId}/shipping_method`, params, options);
+    }
+    async delivery_lead_time(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'delivery_lead_times' }, `shipments/${_shipmentId}/delivery_lead_time`, params, options);
+    }
+    async stock_line_items(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'stock_line_items' }, `shipments/${_shipmentId}/stock_line_items`, params, options);
+    }
+    async stock_transfers(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'stock_transfers' }, `shipments/${_shipmentId}/stock_transfers`, params, options);
+    }
+    async available_shipping_methods(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'shipping_methods' }, `shipments/${_shipmentId}/available_shipping_methods`, params, options);
+    }
+    async carrier_accounts(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'carrier_accounts' }, `shipments/${_shipmentId}/carrier_accounts`, params, options);
+    }
+    async parcels(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'parcels' }, `shipments/${_shipmentId}/parcels`, params, options);
+    }
+    async attachments(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'attachments' }, `shipments/${_shipmentId}/attachments`, params, options);
+    }
+    async events(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'events' }, `shipments/${_shipmentId}/events`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isShipment(resource) {
+        return resource.type && (resource.type === Shipments.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Shipments.TYPE } : { id: id.id, type: Shipments.TYPE };
+    }
+    type() {
+        return Shipments.TYPE;
+    }
+}
+Shipments.TYPE = 'shipments';
+export default Shipments;