@commercelayer/sdk 4.35.0 → 4.37.0

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

@@ -1,10 +1,11 @@
-import { ApiResource, Resource, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } 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 { 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,70 +14,70 @@ import type { Parcel } from './parcels';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
 import type { Version } from './versions';
+type ShipmentType = 'shipments';
 type ShipmentRel = ResourceRel & {
-    type: typeof Shipments.TYPE;
+    type: ShipmentType;
 };
 type ShippingMethodRel = ResourceRel & {
-    type: 'shipping_methods';
+    type: ShippingMethodType;
 };
 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;
-    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;
+    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[];
-    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;
+    versions?: Version[] | null;
 }
 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;
+    _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;
 }
-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>;
+declare class Shipments extends ApiResource<Shipment> {
+    static readonly TYPE: ShipmentType;
     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>;
@@ -93,9 +94,16 @@ declare class Shipments extends ApiResource {
     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>>;
+    _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>;
+    _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, ShipmentUpdate };
+export type { Shipment, ShipmentUpdate, ShipmentType };

package/lib/cjs/resources/shipments.js

@@ -2,15 +2,8 @@
 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(Object.assign(Object.assign({}, resource), { type: Shipments.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Shipments.TYPE }, params, options);
     }
     async order(shipmentId, params, options) {
         const _shipmentId = shipmentId.id || shipmentId;
@@ -72,7 +65,27 @@ 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 _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 _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,36 +1,37 @@
-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;
-    skus?: Sku[];
-    attachments?: Attachment[];
-    versions?: Version[];
+    readonly type: ShippingCategoryType;
+    name: string;
+    skus?: Sku[] | null;
+    attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
 interface ShippingCategoryCreate extends ResourceCreate {
     name: string;
 }
 interface ShippingCategoryUpdate extends ResourceUpdate {
-    name?: string;
+    name?: 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);
     }

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

@@ -1,31 +1,32 @@
-import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { ShippingMethod } from './shipping_methods';
 import type { Attachment } from './attachments';
 import type { Version } from './versions';
+type ShippingMethodTierType = 'shipping_method_tiers';
 type ShippingMethodTierRel = ResourceRel & {
-    type: typeof ShippingMethodTiers.TYPE;
+    type: ShippingMethodTierType;
 };
 interface ShippingMethodTier extends Resource {
-    name?: string;
-    up_to?: number;
-    price_amount_cents?: number;
-    price_amount_float?: number;
-    formatted_price_amount?: string;
-    shipping_method?: ShippingMethod;
-    attachments?: Attachment[];
-    versions?: Version[];
+    readonly type: ShippingMethodTierType;
+    name: string;
+    up_to?: number | null;
+    price_amount_cents: number;
+    price_amount_float?: number | null;
+    formatted_price_amount?: string | null;
+    shipping_method?: ShippingMethod | null;
+    attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
-declare class ShippingMethodTiers extends ApiResource {
-    static readonly TYPE: 'shipping_method_tiers';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ShippingMethodTier>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethodTier>;
+declare class ShippingMethodTiers extends ApiResource<ShippingMethodTier> {
+    static readonly TYPE: ShippingMethodTierType;
     shipping_method(shippingMethodTierId: string | ShippingMethodTier, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
     attachments(shippingMethodTierId: string | ShippingMethodTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     versions(shippingMethodTierId: string | ShippingMethodTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isShippingMethodTier(resource: any): resource is ShippingMethodTier;
     relationship(id: string | ResourceId | null): ShippingMethodTierRel;
-    type(): string;
+    type(): ShippingMethodTierType;
 }
 export default ShippingMethodTiers;
-export { ShippingMethodTier };
+export type { ShippingMethodTier, ShippingMethodTierType };

package/lib/cjs/resources/shipping_method_tiers.js

@@ -2,13 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class ShippingMethodTiers extends resource_1.ApiResource {
-    // static readonly PATH = 'shipping_method_tiers'
-    async list(params, options) {
-        return this.resources.list({ type: ShippingMethodTiers.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: ShippingMethodTiers.TYPE, id }, params, options);
-    }
     async shipping_method(shippingMethodTierId, params, options) {
         const _shippingMethodTierId = shippingMethodTierId.id || shippingMethodTierId;
         return this.resources.fetch({ type: 'shipping_methods' }, `shipping_method_tiers/${_shippingMethodTierId}/shipping_method`, params, options);
@@ -21,7 +14,6 @@ class ShippingMethodTiers extends resource_1.ApiResource {
         const _shippingMethodTierId = shippingMethodTierId.id || shippingMethodTierId;
         return this.resources.fetch({ type: 'versions' }, `shipping_method_tiers/${_shippingMethodTierId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isShippingMethodTier(resource) {
         return resource.type && (resource.type === ShippingMethodTiers.TYPE);
     }

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

@@ -1,104 +1,105 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Market } from './markets';
-import type { ShippingZone } from './shipping_zones';
-import type { ShippingCategory } from './shipping_categories';
-import type { StockLocation } from './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 { Market, MarketType } from './markets';
+import type { ShippingZone, ShippingZoneType } from './shipping_zones';
+import type { ShippingCategory, ShippingCategoryType } from './shipping_categories';
+import type { StockLocation, StockLocationType } from './stock_locations';
 import type { DeliveryLeadTime } from './delivery_lead_times';
-import type { ShippingMethodTier } from './shipping_method_tiers';
+import type { ShippingMethodTier, ShippingMethodTierType } from './shipping_method_tiers';
 import type { ShippingWeightTier } from './shipping_weight_tiers';
 import type { Attachment } from './attachments';
 import type { Version } from './versions';
+type ShippingMethodType = 'shipping_methods';
 type ShippingMethodRel = ResourceRel & {
-    type: typeof ShippingMethods.TYPE;
+    type: ShippingMethodType;
 };
 type MarketRel = ResourceRel & {
-    type: 'markets';
+    type: MarketType;
 };
 type ShippingZoneRel = ResourceRel & {
-    type: 'shipping_zones';
+    type: ShippingZoneType;
 };
 type ShippingCategoryRel = ResourceRel & {
-    type: 'shipping_categories';
+    type: ShippingCategoryType;
 };
 type StockLocationRel = ResourceRel & {
-    type: 'stock_locations';
+    type: StockLocationType;
 };
 type ShippingMethodTierRel = ResourceRel & {
-    type: 'shipping_method_tiers';
+    type: ShippingMethodTierType;
 };
 interface ShippingMethod extends Resource {
-    name?: string;
-    scheme?: string;
-    currency_code?: string;
-    external_prices_url?: string;
-    disabled_at?: string;
-    price_amount_cents?: number;
-    price_amount_float?: number;
-    formatted_price_amount?: string;
-    free_over_amount_cents?: number;
-    free_over_amount_float?: number;
-    formatted_free_over_amount?: string;
-    use_subtotal?: boolean;
-    price_amount_for_shipment_cents?: number;
-    price_amount_for_shipment_float?: number;
-    formatted_price_amount_for_shipment?: string;
-    min_weight?: number;
-    max_weight?: number;
-    unit_of_weight?: string;
-    market?: Market;
-    shipping_zone?: ShippingZone;
-    shipping_category?: ShippingCategory;
-    stock_location?: StockLocation;
-    delivery_lead_time_for_shipment?: DeliveryLeadTime;
-    shipping_method_tiers?: ShippingMethodTier[];
-    shipping_weight_tiers?: ShippingWeightTier[];
-    attachments?: Attachment[];
-    versions?: Version[];
+    readonly type: ShippingMethodType;
+    name: string;
+    scheme?: string | null;
+    currency_code?: string | null;
+    external_prices_url?: string | null;
+    disabled_at?: string | null;
+    price_amount_cents: number;
+    price_amount_float?: number | null;
+    formatted_price_amount?: string | null;
+    free_over_amount_cents?: number | null;
+    free_over_amount_float?: number | null;
+    formatted_free_over_amount?: string | null;
+    use_subtotal?: boolean | null;
+    price_amount_for_shipment_cents?: number | null;
+    price_amount_for_shipment_float?: number | null;
+    formatted_price_amount_for_shipment?: string | null;
+    min_weight?: number | null;
+    max_weight?: number | null;
+    unit_of_weight?: string | null;
+    market?: Market | null;
+    shipping_zone?: ShippingZone | null;
+    shipping_category?: ShippingCategory | null;
+    stock_location?: StockLocation | null;
+    delivery_lead_time_for_shipment?: DeliveryLeadTime | null;
+    shipping_method_tiers?: ShippingMethodTier[] | null;
+    shipping_weight_tiers?: ShippingWeightTier[] | null;
+    attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
 interface ShippingMethodCreate extends ResourceCreate {
     name: string;
-    scheme?: string;
-    currency_code?: string;
-    external_prices_url?: string;
+    scheme?: string | null;
+    currency_code?: string | null;
+    external_prices_url?: string | null;
     price_amount_cents: number;
-    free_over_amount_cents?: number;
-    use_subtotal?: boolean;
-    min_weight?: number;
-    max_weight?: number;
-    unit_of_weight?: string;
-    market?: MarketRel;
-    shipping_zone?: ShippingZoneRel;
-    shipping_category?: ShippingCategoryRel;
-    stock_location?: StockLocationRel;
-    shipping_method_tiers?: ShippingMethodTierRel[];
+    free_over_amount_cents?: number | null;
+    use_subtotal?: boolean | null;
+    min_weight?: number | null;
+    max_weight?: number | null;
+    unit_of_weight?: string | null;
+    market?: MarketRel | null;
+    shipping_zone?: ShippingZoneRel | null;
+    shipping_category?: ShippingCategoryRel | null;
+    stock_location?: StockLocationRel | null;
+    shipping_method_tiers?: ShippingMethodTierRel[] | null;
 }
 interface ShippingMethodUpdate extends ResourceUpdate {
-    name?: string;
-    scheme?: string;
-    currency_code?: string;
-    external_prices_url?: string;
-    _disable?: boolean;
-    _enable?: boolean;
-    price_amount_cents?: number;
-    free_over_amount_cents?: number;
-    use_subtotal?: boolean;
-    min_weight?: number;
-    max_weight?: number;
-    unit_of_weight?: string;
-    market?: MarketRel;
-    shipping_zone?: ShippingZoneRel;
-    shipping_category?: ShippingCategoryRel;
-    stock_location?: StockLocationRel;
-    shipping_method_tiers?: ShippingMethodTierRel[];
+    name?: string | null;
+    scheme?: string | null;
+    currency_code?: string | null;
+    external_prices_url?: string | null;
+    _disable?: boolean | null;
+    _enable?: boolean | null;
+    price_amount_cents?: number | null;
+    free_over_amount_cents?: number | null;
+    use_subtotal?: boolean | null;
+    min_weight?: number | null;
+    max_weight?: number | null;
+    unit_of_weight?: string | null;
+    market?: MarketRel | null;
+    shipping_zone?: ShippingZoneRel | null;
+    shipping_category?: ShippingCategoryRel | null;
+    stock_location?: StockLocationRel | null;
+    shipping_method_tiers?: ShippingMethodTierRel[] | null;
 }
-declare class ShippingMethods extends ApiResource {
-    static readonly TYPE: 'shipping_methods';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ShippingMethod>>;
+declare class ShippingMethods extends ApiResource<ShippingMethod> {
+    static readonly TYPE: ShippingMethodType;
     create(resource: ShippingMethodCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
     update(resource: ShippingMethodUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     market(shippingMethodId: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     shipping_zone(shippingMethodId: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingZone>;
     shipping_category(shippingMethodId: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingCategory>;
@@ -108,9 +109,11 @@ declare class ShippingMethods extends ApiResource {
     shipping_weight_tiers(shippingMethodId: string | ShippingMethod, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ShippingWeightTier>>;
     attachments(shippingMethodId: string | ShippingMethod, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     versions(shippingMethodId: string | ShippingMethod, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _disable(id: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
+    _enable(id: string | ShippingMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
     isShippingMethod(resource: any): resource is ShippingMethod;
     relationship(id: string | ResourceId | null): ShippingMethodRel;
-    type(): string;
+    type(): ShippingMethodType;
 }
 export default ShippingMethods;
-export { ShippingMethod, ShippingMethodCreate, ShippingMethodUpdate };
+export type { ShippingMethod, ShippingMethodCreate, ShippingMethodUpdate, ShippingMethodType };

package/lib/cjs/resources/shipping_methods.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class ShippingMethods extends resource_1.ApiResource {
-    // static readonly PATH = 'shipping_methods'
-    async list(params, options) {
-        return this.resources.list({ type: ShippingMethods.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ShippingMethods.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: ShippingMethods.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: ShippingMethods.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ShippingMethods.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: ShippingMethods.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: ShippingMethods.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: ShippingMethods.TYPE } : id, options);
     }
     async market(shippingMethodId, params, options) {
         const _shippingMethodId = shippingMethodId.id || shippingMethodId;
@@ -54,7 +47,12 @@ class ShippingMethods extends resource_1.ApiResource {
         const _shippingMethodId = shippingMethodId.id || shippingMethodId;
         return this.resources.fetch({ type: 'versions' }, `shipping_methods/${_shippingMethodId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    async _disable(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: ShippingMethods.TYPE, _disable: true }, params, options);
+    }
+    async _enable(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: ShippingMethods.TYPE, _enable: true }, params, options);
+    }
     isShippingMethod(resource) {
         return resource.type && (resource.type === ShippingMethods.TYPE);
     }