@commercelayer/sdk 4.33.0 → 4.35.0

package/lib/cjs/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 };

package/lib/cjs/resources/returns.js

@@ -2,14 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Returns extends resource_1.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({ ...resource, type: Returns.TYPE }, 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({ ...resource, type: Returns.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Returns.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: Returns.TYPE } : id, options);
+        await this.resources.delete({ type: Returns.TYPE, id }, options);
     }
     async order(returnId, params, options) {
         const _returnId = returnId.id || returnId;
@@ -47,6 +54,11 @@ class Returns extends resource_1.ApiResource {
         const _returnId = returnId.id || returnId;
         return this.resources.fetch({ type: 'tags' }, `returns/${_returnId}/tags`, params, options);
     }
+    async versions(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'versions' }, `returns/${_returnId}/versions`, 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);
     }

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

@@ -1,43 +1,45 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
 import type { PaymentMethod } from './payment_methods';
-import type { SatispayPayment, SatispayPaymentType } from './satispay_payments';
-type SatispayGatewayType = 'satispay_gateways';
+import type { Version } from './versions';
+import type { SatispayPayment } from './satispay_payments';
 type SatispayGatewayRel = ResourceRel & {
-    type: SatispayGatewayType;
+    type: typeof SatispayGateways.TYPE;
 };
 type SatispayPaymentRel = ResourceRel & {
-    type: SatispayPaymentType;
+    type: 'satispay_payments';
 };
 interface SatispayGateway extends Resource {
-    readonly type: SatispayGatewayType;
-    name: string;
-    token: string;
-    key_id: string;
-    webhook_endpoint_url?: string | null;
-    payment_methods?: PaymentMethod[] | null;
-    satispay_payments?: SatispayPayment[] | null;
+    name?: string;
+    token?: string;
+    key_id?: string;
+    webhook_endpoint_url?: string;
+    payment_methods?: PaymentMethod[];
+    versions?: Version[];
+    satispay_payments?: SatispayPayment[];
 }
 interface SatispayGatewayCreate extends ResourceCreate {
     name: string;
     token: string;
-    satispay_payments?: SatispayPaymentRel[] | null;
+    satispay_payments?: SatispayPaymentRel[];
 }
 interface SatispayGatewayUpdate extends ResourceUpdate {
-    name?: string | null;
-    satispay_payments?: SatispayPaymentRel[] | null;
+    name?: string;
+    satispay_payments?: SatispayPaymentRel[];
 }
-declare class SatispayGateways extends ApiResource<SatispayGateway> {
-    static readonly TYPE: SatispayGatewayType;
+declare class SatispayGateways extends ApiResource {
+    static readonly TYPE: 'satispay_gateways';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SatispayGateway>>;
     create(resource: SatispayGatewayCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayGateway>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayGateway>;
     update(resource: SatispayGatewayUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayGateway>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     payment_methods(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
+    versions(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     satispay_payments(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SatispayPayment>>;
     isSatispayGateway(resource: any): resource is SatispayGateway;
     relationship(id: string | ResourceId | null): SatispayGatewayRel;
-    type(): SatispayGatewayType;
+    type(): string;
 }
 export default SatispayGateways;
-export type { SatispayGateway, SatispayGatewayCreate, SatispayGatewayUpdate, SatispayGatewayType };
+export { SatispayGateway, SatispayGatewayCreate, SatispayGatewayUpdate };

package/lib/cjs/resources/satispay_gateways.js

@@ -2,23 +2,35 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class SatispayGateways extends resource_1.ApiResource {
+    // static readonly PATH = 'satispay_gateways'
+    async list(params, options) {
+        return this.resources.list({ type: SatispayGateways.TYPE }, params, options);
+    }
     async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: SatispayGateways.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: SatispayGateways.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: SatispayGateways.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: SatispayGateways.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: SatispayGateways.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: SatispayGateways.TYPE } : id, options);
+        await this.resources.delete({ type: SatispayGateways.TYPE, id }, options);
     }
     async payment_methods(satispayGatewayId, params, options) {
         const _satispayGatewayId = satispayGatewayId.id || satispayGatewayId;
         return this.resources.fetch({ type: 'payment_methods' }, `satispay_gateways/${_satispayGatewayId}/payment_methods`, params, options);
     }
+    async versions(satispayGatewayId, params, options) {
+        const _satispayGatewayId = satispayGatewayId.id || satispayGatewayId;
+        return this.resources.fetch({ type: 'versions' }, `satispay_gateways/${_satispayGatewayId}/versions`, params, options);
+    }
     async satispay_payments(satispayGatewayId, params, options) {
         const _satispayGatewayId = satispayGatewayId.id || satispayGatewayId;
         return this.resources.fetch({ type: 'satispay_payments' }, `satispay_gateways/${_satispayGatewayId}/satispay_payments`, params, options);
     }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isSatispayGateway(resource) {
         return resource.type && (resource.type === SatispayGateways.TYPE);
     }

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

@@ -1,48 +1,51 @@
-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 { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import type { Order } from './orders';
 import type { PaymentGateway } from './payment_gateways';
-type SatispayPaymentType = 'satispay_payments';
+import type { Version } from './versions';
 type SatispayPaymentRel = ResourceRel & {
-    type: SatispayPaymentType;
+    type: typeof SatispayPayments.TYPE;
 };
 type OrderRel = ResourceRel & {
-    type: OrderType;
+    type: 'orders';
 };
 interface SatispayPayment extends Resource {
-    readonly type: SatispayPaymentType;
-    payment_id?: string | null;
-    flow?: string | null;
-    redirect_url?: string | null;
-    payment_url?: string | null;
-    intent_amount_cents: number;
-    intent_amount_float?: number | null;
-    formatted_intent_amount?: string | null;
-    payment_response?: Record<string, any> | null;
-    order?: Order | null;
-    payment_gateway?: PaymentGateway | null;
+    payment_id?: string;
+    flow?: string;
+    status?: string;
+    redirect_url?: string;
+    payment_url?: string;
+    intent_amount_cents?: number;
+    intent_amount_float?: number;
+    formatted_intent_amount?: string;
+    payment_response?: object;
+    order?: Order;
+    payment_gateway?: PaymentGateway;
+    versions?: Version[];
 }
 interface SatispayPaymentCreate extends ResourceCreate {
-    flow?: string | null;
-    redirect_url?: string | null;
+    flow?: string;
+    redirect_url?: string;
     order: OrderRel;
 }
 interface SatispayPaymentUpdate extends ResourceUpdate {
-    redirect_url?: string | null;
-    _refresh?: boolean | null;
-    order?: OrderRel | null;
+    redirect_url?: string;
+    _refresh?: boolean;
+    order?: OrderRel;
 }
-declare class SatispayPayments extends ApiResource<SatispayPayment> {
-    static readonly TYPE: SatispayPaymentType;
+declare class SatispayPayments extends ApiResource {
+    static readonly TYPE: 'satispay_payments';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SatispayPayment>>;
     create(resource: SatispayPaymentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayPayment>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayPayment>;
     update(resource: SatispayPaymentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayPayment>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     order(satispayPaymentId: string | SatispayPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     payment_gateway(satispayPaymentId: string | SatispayPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
+    versions(satispayPaymentId: string | SatispayPayment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isSatispayPayment(resource: any): resource is SatispayPayment;
     relationship(id: string | ResourceId | null): SatispayPaymentRel;
-    type(): SatispayPaymentType;
+    type(): string;
 }
 export default SatispayPayments;
-export type { SatispayPayment, SatispayPaymentCreate, SatispayPaymentUpdate, SatispayPaymentType };
+export { SatispayPayment, SatispayPaymentCreate, SatispayPaymentUpdate };

package/lib/cjs/resources/satispay_payments.js

@@ -2,14 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class SatispayPayments extends resource_1.ApiResource {
+    // static readonly PATH = 'satispay_payments'
+    async list(params, options) {
+        return this.resources.list({ type: SatispayPayments.TYPE }, params, options);
+    }
     async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: SatispayPayments.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: SatispayPayments.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: SatispayPayments.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: SatispayPayments.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: SatispayPayments.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: SatispayPayments.TYPE } : id, options);
+        await this.resources.delete({ type: SatispayPayments.TYPE, id }, options);
     }
     async order(satispayPaymentId, params, options) {
         const _satispayPaymentId = satispayPaymentId.id || satispayPaymentId;
@@ -19,6 +26,11 @@ class SatispayPayments extends resource_1.ApiResource {
         const _satispayPaymentId = satispayPaymentId.id || satispayPaymentId;
         return this.resources.fetch({ type: 'payment_gateways' }, `satispay_payments/${_satispayPaymentId}/payment_gateway`, params, options);
     }
+    async versions(satispayPaymentId, params, options) {
+        const _satispayPaymentId = satispayPaymentId.id || satispayPaymentId;
+        return this.resources.fetch({ type: 'versions' }, `satispay_payments/${_satispayPaymentId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isSatispayPayment(resource) {
         return resource.type && (resource.type === SatispayPayments.TYPE);
     }

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

@@ -1,11 +1,10 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+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, ShippingMethodType } from './shipping_methods';
+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';
@@ -13,64 +12,71 @@ import type { CarrierAccount } from './carrier_accounts';
 import type { Parcel } from './parcels';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
-type ShipmentType = 'shipments';
+import type { Version } from './versions';
 type ShipmentRel = ResourceRel & {
-    type: ShipmentType;
+    type: typeof Shipments.TYPE;
 };
 type ShippingMethodRel = ResourceRel & {
-    type: ShippingMethodType;
+    type: 'shipping_methods';
 };
 interface Shipment extends Resource {
-    readonly type: ShipmentType;
-    number?: string | null;
-    status: 'draft' | 'upcoming' | 'cancelled' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'shipped';
-    currency_code?: string | null;
-    cost_amount_cents?: number | null;
-    cost_amount_float?: number | null;
-    formatted_cost_amount?: string | null;
-    skus_count?: number | null;
-    selected_rate_id?: string | null;
-    rates?: Array<Record<string, any>> | null;
-    purchase_error_code?: string | null;
-    purchase_error_message?: string | null;
-    get_rates_errors?: Array<Record<string, any>> | null;
-    get_rates_started_at?: string | null;
-    get_rates_completed_at?: string | null;
-    purchase_started_at?: string | null;
-    purchase_completed_at?: string | null;
-    purchase_failed_at?: string | null;
-    order?: Order | null;
-    shipping_category?: ShippingCategory | null;
-    stock_location?: StockLocation | null;
-    origin_address?: Address | null;
-    shipping_address?: Address | null;
-    shipping_method?: ShippingMethod | null;
-    delivery_lead_time?: DeliveryLeadTime | null;
+    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;
+    on_hold_at?: string;
+    picking_at?: string;
+    packing_at?: string;
+    ready_to_ship_at?: string;
+    shipped_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[] | null;
-    stock_transfers?: StockTransfer[] | null;
-    available_shipping_methods?: ShippingMethod[] | null;
-    carrier_accounts?: CarrierAccount[] | null;
-    parcels?: Parcel[] | null;
-    attachments?: Attachment[] | null;
-    events?: Event[] | null;
+    stock_line_items?: StockLineItem[];
+    stock_transfers?: StockTransfer[];
+    available_shipping_methods?: ShippingMethod[];
+    carrier_accounts?: CarrierAccount[];
+    parcels?: Parcel[];
+    attachments?: Attachment[];
+    events?: Event[];
+    versions?: Version[];
 }
 interface ShipmentUpdate extends ResourceUpdate {
-    _on_hold?: boolean | null;
-    _picking?: boolean | null;
-    _packing?: boolean | null;
-    _ready_to_ship?: boolean | null;
-    _ship?: boolean | null;
-    _get_rates?: boolean | null;
-    selected_rate_id?: string | null;
-    _purchase?: boolean | null;
-    shipping_method?: ShippingMethodRel | null;
+    _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<Shipment> {
-    static readonly TYPE: ShipmentType;
+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>;
@@ -86,9 +92,10 @@ declare class Shipments extends ApiResource<Shipment> {
     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>>;
+    versions(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isShipment(resource: any): resource is Shipment;
     relationship(id: string | ResourceId | null): ShipmentRel;
-    type(): ShipmentType;
+    type(): string;
 }
 export default Shipments;
-export type { Shipment, ShipmentUpdate, ShipmentType };
+export { Shipment, ShipmentUpdate };

package/lib/cjs/resources/shipments.js

@@ -2,8 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Shipments extends resource_1.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({ ...resource, type: Shipments.TYPE }, 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;
@@ -61,6 +68,11 @@ class Shipments extends resource_1.ApiResource {
         const _shipmentId = shipmentId.id || shipmentId;
         return this.resources.fetch({ type: 'events' }, `shipments/${_shipmentId}/events`, params, options);
     }
+    async versions(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'versions' }, `shipments/${_shipmentId}/versions`, 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);
     }

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

@@ -1,34 +1,36 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
 import type { Sku } from './skus';
 import type { Attachment } from './attachments';
-type ShippingCategoryType = 'shipping_categories';
+import type { Version } from './versions';
 type ShippingCategoryRel = ResourceRel & {
-    type: ShippingCategoryType;
+    type: typeof ShippingCategories.TYPE;
 };
 interface ShippingCategory extends Resource {
-    readonly type: ShippingCategoryType;
-    name: string;
-    skus?: Sku[] | null;
-    attachments?: Attachment[] | null;
+    name?: string;
+    skus?: Sku[];
+    attachments?: Attachment[];
+    versions?: Version[];
 }
 interface ShippingCategoryCreate extends ResourceCreate {
     name: string;
 }
 interface ShippingCategoryUpdate extends ResourceUpdate {
-    name?: string | null;
+    name?: string;
 }
-declare class ShippingCategories extends ApiResource<ShippingCategory> {
-    static readonly TYPE: ShippingCategoryType;
+declare class ShippingCategories extends ApiResource {
+    static readonly TYPE: 'shipping_categories';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ShippingCategory>>;
     create(resource: ShippingCategoryCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingCategory>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingCategory>;
     update(resource: ShippingCategoryUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingCategory>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     skus(shippingCategoryId: string | ShippingCategory, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
     attachments(shippingCategoryId: string | ShippingCategory, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    versions(shippingCategoryId: string | ShippingCategory, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isShippingCategory(resource: any): resource is ShippingCategory;
     relationship(id: string | ResourceId | null): ShippingCategoryRel;
-    type(): ShippingCategoryType;
+    type(): string;
 }
 export default ShippingCategories;
-export type { ShippingCategory, ShippingCategoryCreate, ShippingCategoryUpdate, ShippingCategoryType };
+export { ShippingCategory, ShippingCategoryCreate, ShippingCategoryUpdate };