@commercelayer/sdk 4.41.0 → 4.42.0

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

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

package/lib/cjs/resources/satispay_gateways.js

@@ -2,21 +2,14 @@
 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(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);
+        return this.resources.create({ ...resource, type: SatispayGateways.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: SatispayGateways.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: SatispayGateways.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: SatispayGateways.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: SatispayGateways.TYPE } : id, options);
     }
     async payment_methods(satispayGatewayId, params, options) {
         const _satispayGatewayId = satispayGatewayId.id || satispayGatewayId;
@@ -30,7 +23,6 @@ class SatispayGateways extends resource_1.ApiResource {
         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,51 +1,53 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Order } from './orders';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order, OrderType } from './orders';
 import type { PaymentGateway } from './payment_gateways';
 import type { Version } from './versions';
+type SatispayPaymentType = 'satispay_payments';
 type SatispayPaymentRel = ResourceRel & {
-    type: typeof SatispayPayments.TYPE;
+    type: SatispayPaymentType;
 };
 type OrderRel = ResourceRel & {
-    type: 'orders';
+    type: OrderType;
 };
 interface SatispayPayment extends Resource {
-    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[];
+    readonly type: SatispayPaymentType;
+    payment_id?: string | null;
+    flow?: string | null;
+    status?: 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;
+    versions?: Version[] | null;
 }
 interface SatispayPaymentCreate extends ResourceCreate {
-    flow?: string;
-    redirect_url?: string;
+    flow?: string | null;
+    redirect_url?: string | null;
     order: OrderRel;
 }
 interface SatispayPaymentUpdate extends ResourceUpdate {
-    redirect_url?: string;
-    _refresh?: boolean;
-    order?: OrderRel;
+    redirect_url?: string | null;
+    _refresh?: boolean | null;
+    order?: OrderRel | null;
 }
-declare class SatispayPayments extends ApiResource {
-    static readonly TYPE: 'satispay_payments';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SatispayPayment>>;
+declare class SatispayPayments extends ApiResource<SatispayPayment> {
+    static readonly TYPE: SatispayPaymentType;
     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, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, 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>>;
+    _refresh(id: string | SatispayPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayPayment>;
     isSatispayPayment(resource: any): resource is SatispayPayment;
     relationship(id: string | ResourceId | null): SatispayPaymentRel;
-    type(): string;
+    type(): SatispayPaymentType;
 }
 export default SatispayPayments;
-export { SatispayPayment, SatispayPaymentCreate, SatispayPaymentUpdate };
+export type { SatispayPayment, SatispayPaymentCreate, SatispayPaymentUpdate, SatispayPaymentType };

package/lib/cjs/resources/satispay_payments.js

@@ -2,21 +2,14 @@
 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(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);
+        return this.resources.create({ ...resource, type: SatispayPayments.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: SatispayPayments.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: SatispayPayments.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: SatispayPayments.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: SatispayPayments.TYPE } : id, options);
     }
     async order(satispayPaymentId, params, options) {
         const _satispayPaymentId = satispayPaymentId.id || satispayPaymentId;
@@ -30,7 +23,9 @@ class SatispayPayments extends resource_1.ApiResource {
         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
+    async _refresh(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: SatispayPayments.TYPE, _refresh: true }, params, options);
+    }
     isSatispayPayment(resource) {
         return resource.type && (resource.type === SatispayPayments.TYPE);
     }

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

@@ -1,11 +1,12 @@
-import { ApiResource, Resource, ResourceCreate, 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 { InventoryStockLocation } from './inventory_stock_locations';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order, OrderType } from './orders';
+import type { ShippingCategory, ShippingCategoryType } from './shipping_categories';
+import type { InventoryStockLocation, InventoryStockLocationType } from './inventory_stock_locations';
 import type { StockLocation } from './stock_locations';
-import type { Address } from './addresses';
-import type { ShippingMethod } from './shipping_methods';
+import type { Address, AddressType } from './addresses';
+import type { ShippingMethod, ShippingMethodType } from './shipping_methods';
 import type { DeliveryLeadTime } from './delivery_lead_times';
 import type { StockLineItem } from './stock_line_items';
 import type { StockTransfer } from './stock_transfers';
@@ -13,108 +14,108 @@ import type { CarrierAccount } from './carrier_accounts';
 import type { Parcel } from './parcels';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
-import type { Tag } from './tags';
+import type { Tag, TagType } from './tags';
 import type { Version } from './versions';
+type ShipmentType = 'shipments';
 type ShipmentRel = ResourceRel & {
-    type: typeof Shipments.TYPE;
+    type: ShipmentType;
 };
 type OrderRel = ResourceRel & {
-    type: 'orders';
+    type: OrderType;
 };
 type ShippingCategoryRel = ResourceRel & {
-    type: 'shipping_categories';
+    type: ShippingCategoryType;
 };
 type InventoryStockLocationRel = ResourceRel & {
-    type: 'inventory_stock_locations';
+    type: InventoryStockLocationType;
 };
 type AddressRel = ResourceRel & {
-    type: 'addresses';
+    type: AddressType;
 };
 type ShippingMethodRel = ResourceRel & {
-    type: 'shipping_methods';
+    type: ShippingMethodType;
 };
 type TagRel = ResourceRel & {
-    type: 'tags';
+    type: TagType;
 };
 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;
-    on_hold_at?: string;
-    picking_at?: string;
-    packing_at?: string;
-    ready_to_ship_at?: string;
-    shipped_at?: string;
-    order?: Order;
-    shipping_category?: ShippingCategory;
-    inventory_stock_location?: InventoryStockLocation;
-    stock_location?: StockLocation;
-    origin_address?: Address;
-    shipping_address?: Address;
-    shipping_method?: ShippingMethod;
-    delivery_lead_time?: DeliveryLeadTime;
+    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;
+    on_hold_at?: string | null;
+    picking_at?: string | null;
+    packing_at?: string | null;
+    ready_to_ship_at?: string | null;
+    shipped_at?: string | null;
+    order?: Order | null;
+    shipping_category?: ShippingCategory | null;
+    inventory_stock_location?: InventoryStockLocation | null;
+    stock_location?: StockLocation | null;
+    origin_address?: Address | null;
+    shipping_address?: Address | null;
+    shipping_method?: ShippingMethod | null;
+    delivery_lead_time?: DeliveryLeadTime | null;
     /**
     * @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[];
-    tags?: Tag[];
-    versions?: Version[];
+    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;
+    tags?: Tag[] | null;
+    versions?: Version[] | null;
 }
 interface ShipmentCreate extends ResourceCreate {
     order: OrderRel;
-    shipping_category?: ShippingCategoryRel;
+    shipping_category?: ShippingCategoryRel | null;
     inventory_stock_location: InventoryStockLocationRel;
-    shipping_address?: AddressRel;
-    shipping_method?: ShippingMethodRel;
-    tags?: TagRel[];
+    shipping_address?: AddressRel | null;
+    shipping_method?: ShippingMethodRel | null;
+    tags?: TagRel[] | null;
 }
 interface ShipmentUpdate extends ResourceUpdate {
-    _upcoming?: boolean;
-    _on_hold?: boolean;
-    _picking?: boolean;
-    _packing?: boolean;
-    _ready_to_ship?: boolean;
-    _ship?: boolean;
-    _reserve_stock?: boolean;
-    _release_stock?: boolean;
-    _decrement_stock?: boolean;
-    _get_rates?: boolean;
-    selected_rate_id?: string;
-    _purchase?: boolean;
-    shipping_category?: ShippingCategoryRel;
-    inventory_stock_location?: InventoryStockLocationRel;
-    shipping_address?: AddressRel;
-    shipping_method?: ShippingMethodRel;
-    tags?: TagRel[];
+    _upcoming?: boolean | null;
+    _on_hold?: boolean | null;
+    _picking?: boolean | null;
+    _packing?: boolean | null;
+    _ready_to_ship?: boolean | null;
+    _ship?: boolean | null;
+    _reserve_stock?: boolean | null;
+    _release_stock?: boolean | null;
+    _decrement_stock?: boolean | null;
+    _get_rates?: boolean | null;
+    selected_rate_id?: string | null;
+    _purchase?: boolean | null;
+    shipping_category?: ShippingCategoryRel | null;
+    inventory_stock_location?: InventoryStockLocationRel | null;
+    shipping_address?: AddressRel | null;
+    shipping_method?: ShippingMethodRel | null;
+    tags?: TagRel[] | null;
 }
-declare class Shipments extends ApiResource {
-    static readonly TYPE: 'shipments';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Shipment>>;
+declare class Shipments extends ApiResource<Shipment> {
+    static readonly TYPE: ShipmentType;
     create(resource: ShipmentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
     update(resource: ShipmentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     order(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     shipping_category(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingCategory>;
     inventory_stock_location(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<InventoryStockLocation>;
@@ -132,9 +133,20 @@ declare class Shipments extends ApiResource {
     events(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     tags(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     versions(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _upcoming(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    _on_hold(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    _picking(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    _packing(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    _ready_to_ship(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    _ship(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    _reserve_stock(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    _release_stock(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    _decrement_stock(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    _get_rates(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    _purchase(id: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
     isShipment(resource: any): resource is Shipment;
     relationship(id: string | ResourceId | null): ShipmentRel;
-    type(): string;
+    type(): ShipmentType;
 }
 export default Shipments;
-export { Shipment, ShipmentCreate, ShipmentUpdate };
+export type { Shipment, ShipmentCreate, ShipmentUpdate, ShipmentType };

package/lib/cjs/resources/shipments.js

@@ -2,21 +2,14 @@
 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 create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Shipments.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Shipments.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: Shipments.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Shipments.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Shipments.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: Shipments.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: Shipments.TYPE } : id, options);
     }
     async order(shipmentId, params, options) {
         const _shipmentId = shipmentId.id || shipmentId;
@@ -86,7 +79,39 @@ class Shipments extends resource_1.ApiResource {
         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
+    async _upcoming(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _upcoming: true }, params, options);
+    }
+    async _on_hold(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _on_hold: true }, params, options);
+    }
+    async _picking(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _picking: true }, params, options);
+    }
+    async _packing(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _packing: true }, params, options);
+    }
+    async _ready_to_ship(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _ready_to_ship: true }, params, options);
+    }
+    async _ship(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _ship: true }, params, options);
+    }
+    async _reserve_stock(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _reserve_stock: true }, params, options);
+    }
+    async _release_stock(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _release_stock: true }, params, options);
+    }
+    async _decrement_stock(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _decrement_stock: true }, params, options);
+    }
+    async _get_rates(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _get_rates: true }, params, options);
+    }
+    async _purchase(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Shipments.TYPE, _purchase: true }, params, options);
+    }
     isShipment(resource) {
         return resource.type && (resource.type === Shipments.TYPE);
     }

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

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

package/lib/cjs/resources/shipping_categories.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class ShippingCategories extends resource_1.ApiResource {
-    // static readonly PATH = 'shipping_categories'
-    async list(params, options) {
-        return this.resources.list({ type: ShippingCategories.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ShippingCategories.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: ShippingCategories.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: ShippingCategories.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ShippingCategories.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: ShippingCategories.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: ShippingCategories.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: ShippingCategories.TYPE } : id, options);
     }
     async skus(shippingCategoryId, params, options) {
         const _shippingCategoryId = shippingCategoryId.id || shippingCategoryId;
@@ -30,7 +23,6 @@ class ShippingCategories extends resource_1.ApiResource {
         const _shippingCategoryId = shippingCategoryId.id || shippingCategoryId;
         return this.resources.fetch({ type: 'versions' }, `shipping_categories/${_shippingCategoryId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isShippingCategory(resource) {
         return resource.type && (resource.type === ShippingCategories.TYPE);
     }