@commercelayer/sdk 4.27.0 → 4.28.0

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

@@ -1,28 +1,31 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-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 { StockLocation, StockLocationType } from './stock_locations';
 import type { Parcel } from './parcels';
 import type { Attachment } from './attachments';
+type PackageType = 'packages';
 type PackageRel = ResourceRel & {
-    type: typeof Packages.TYPE;
+    type: PackageType;
 };
 type StockLocationRel = ResourceRel & {
-    type: 'stock_locations';
+    type: StockLocationType;
 };
 interface Package extends Resource {
-    name?: string;
-    code?: string;
-    length?: number;
-    width?: number;
-    height?: number;
-    unit_of_length?: string;
-    stock_location?: StockLocation;
-    parcels?: Parcel[];
-    attachments?: Attachment[];
+    readonly type: PackageType;
+    name: string;
+    code?: string | null;
+    length: number;
+    width: number;
+    height: number;
+    unit_of_length: string;
+    stock_location?: StockLocation | null;
+    parcels?: Parcel[] | null;
+    attachments?: Attachment[] | null;
 }
 interface PackageCreate extends ResourceCreate {
     name: string;
-    code?: string;
+    code?: string | null;
     length: number;
     width: number;
     height: number;
@@ -30,27 +33,25 @@ interface PackageCreate extends ResourceCreate {
     stock_location: StockLocationRel;
 }
 interface PackageUpdate extends ResourceUpdate {
-    name?: string;
-    code?: string;
-    length?: number;
-    width?: number;
-    height?: number;
-    unit_of_length?: string;
-    stock_location?: StockLocationRel;
+    name?: string | null;
+    code?: string | null;
+    length?: number | null;
+    width?: number | null;
+    height?: number | null;
+    unit_of_length?: string | null;
+    stock_location?: StockLocationRel | null;
 }
-declare class Packages extends ApiResource {
-    static readonly TYPE: 'packages';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Package>>;
+declare class Packages extends ApiResource<Package> {
+    static readonly TYPE: PackageType;
     create(resource: PackageCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
     update(resource: PackageUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     stock_location(packageId: string | Package, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
     parcels(packageId: string | Package, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Parcel>>;
     attachments(packageId: string | Package, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     isPackage(resource: any): resource is Package;
     relationship(id: string | ResourceId | null): PackageRel;
-    type(): string;
+    type(): PackageType;
 }
 export default Packages;
-export { Package, PackageCreate, PackageUpdate };
+export type { Package, PackageCreate, PackageUpdate, PackageType };

package/lib/cjs/resources/packages.js

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

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

@@ -1,30 +1,33 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Parcel } from './parcels';
-import type { StockLineItem } from './stock_line_items';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import type { QueryParamsRetrieve } from '../query';
+import type { Parcel, ParcelType } from './parcels';
+import type { StockLineItem, StockLineItemType } from './stock_line_items';
+type ParcelLineItemType = 'parcel_line_items';
 type ParcelLineItemRel = ResourceRel & {
-    type: typeof ParcelLineItems.TYPE;
+    type: ParcelLineItemType;
 };
 type ParcelRel = ResourceRel & {
-    type: 'parcels';
+    type: ParcelType;
 };
 type StockLineItemRel = ResourceRel & {
-    type: 'stock_line_items';
+    type: StockLineItemType;
 };
 interface ParcelLineItem extends Resource {
-    sku_code?: string;
-    quantity?: number;
-    name?: string;
-    image_url?: string;
-    parcel?: Parcel;
-    stock_line_item?: StockLineItem;
+    readonly type: ParcelLineItemType;
+    sku_code?: string | null;
+    quantity: number;
+    name: string;
+    image_url?: string | null;
+    parcel?: Parcel | null;
+    stock_line_item?: StockLineItem | null;
     /**
     * @deprecated This field should not be used as it may be removed in the future without notice
     */
     shipment_line_item?: object;
 }
 interface ParcelLineItemCreate extends ResourceCreate {
-    sku_code?: string;
+    sku_code?: string | null;
     quantity: number;
     parcel: ParcelRel;
     stock_line_item: StockLineItemRel;
@@ -34,18 +37,16 @@ interface ParcelLineItemCreate extends ResourceCreate {
     shipment_line_item?: object;
 }
 type ParcelLineItemUpdate = ResourceUpdate;
-declare class ParcelLineItems extends ApiResource {
-    static readonly TYPE: 'parcel_line_items';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ParcelLineItem>>;
+declare class ParcelLineItems extends ApiResource<ParcelLineItem> {
+    static readonly TYPE: ParcelLineItemType;
     create(resource: ParcelLineItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
     update(resource: ParcelLineItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     parcel(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
     stock_line_item(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLineItem>;
     isParcelLineItem(resource: any): resource is ParcelLineItem;
     relationship(id: string | ResourceId | null): ParcelLineItemRel;
-    type(): string;
+    type(): ParcelLineItemType;
 }
 export default ParcelLineItems;
-export { ParcelLineItem, ParcelLineItemCreate, ParcelLineItemUpdate };
+export type { ParcelLineItem, ParcelLineItemCreate, ParcelLineItemUpdate, ParcelLineItemType };

package/lib/cjs/resources/parcel_line_items.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class ParcelLineItems extends resource_1.ApiResource {
-    // static readonly PATH = 'parcel_line_items'
-    async list(params, options) {
-        return this.resources.list({ type: ParcelLineItems.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ParcelLineItems.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: ParcelLineItems.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: ParcelLineItems.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ParcelLineItems.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: ParcelLineItems.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: ParcelLineItems.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: ParcelLineItems.TYPE } : id, options);
     }
     async parcel(parcelLineItemId, params, options) {
         const _parcelLineItemId = parcelLineItemId.id || parcelLineItemId;
@@ -26,7 +19,6 @@ class ParcelLineItems extends resource_1.ApiResource {
         const _parcelLineItemId = parcelLineItemId.id || parcelLineItemId;
         return this.resources.fetch({ type: 'stock_line_items' }, `parcel_line_items/${_parcelLineItemId}/stock_line_item`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isParcelLineItem(resource) {
         return resource.type && (resource.type === ParcelLineItems.TYPE);
     }

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

@@ -1,111 +1,115 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Shipment } from './shipments';
-import type { Package } from './packages';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Shipment, ShipmentType } from './shipments';
+import type { Package, PackageType } from './packages';
 import type { ParcelLineItem } from './parcel_line_items';
 import type { Attachment } from './attachments';
 import type { Event } from './events';
+type ParcelType = 'parcels';
 type ParcelRel = ResourceRel & {
-    type: typeof Parcels.TYPE;
+    type: ParcelType;
 };
 type ShipmentRel = ResourceRel & {
-    type: 'shipments';
+    type: ShipmentType;
 };
 type PackageRel = ResourceRel & {
-    type: 'packages';
+    type: PackageType;
 };
 interface Parcel extends Resource {
-    number?: string;
-    weight?: number;
-    unit_of_weight?: string;
-    eel_pfc?: string;
-    contents_type?: string;
-    contents_explanation?: string;
-    customs_certify?: boolean;
-    customs_signer?: string;
-    non_delivery_option?: string;
-    restriction_type?: string;
-    restriction_comments?: string;
-    customs_info_required?: boolean;
-    shipping_label_url?: string;
-    shipping_label_file_type?: string;
-    shipping_label_size?: string;
-    shipping_label_resolution?: string;
-    tracking_number?: string;
-    tracking_status?: string;
-    tracking_status_detail?: string;
-    tracking_status_updated_at?: string;
-    tracking_details?: string;
-    carrier_weight_oz?: string;
-    signed_by?: string;
-    incoterm?: string;
-    shipment?: Shipment;
-    package?: Package;
-    parcel_line_items?: ParcelLineItem[];
-    attachments?: Attachment[];
-    events?: Event[];
+    readonly type: ParcelType;
+    number?: string | null;
+    weight: number;
+    unit_of_weight: string;
+    eel_pfc?: string | null;
+    contents_type?: string | null;
+    contents_explanation?: string | null;
+    customs_certify?: boolean | null;
+    customs_signer?: string | null;
+    non_delivery_option?: string | null;
+    restriction_type?: string | null;
+    restriction_comments?: string | null;
+    customs_info_required?: boolean | null;
+    shipping_label_url?: string | null;
+    shipping_label_file_type?: string | null;
+    shipping_label_size?: string | null;
+    shipping_label_resolution?: string | null;
+    tracking_number?: string | null;
+    tracking_status?: string | null;
+    tracking_status_detail?: string | null;
+    tracking_status_updated_at?: string | null;
+    tracking_details?: string | null;
+    carrier_weight_oz?: string | null;
+    signed_by?: string | null;
+    incoterm?: string | null;
+    delivery_confirmation?: string | null;
+    shipment?: Shipment | null;
+    package?: Package | null;
+    parcel_line_items?: ParcelLineItem[] | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
 }
 interface ParcelCreate extends ResourceCreate {
     weight: number;
     unit_of_weight: string;
-    eel_pfc?: string;
-    contents_type?: string;
-    contents_explanation?: string;
-    customs_certify?: boolean;
-    customs_signer?: string;
-    non_delivery_option?: string;
-    restriction_type?: string;
-    restriction_comments?: string;
-    customs_info_required?: boolean;
-    shipping_label_url?: string;
-    shipping_label_file_type?: string;
-    shipping_label_size?: string;
-    shipping_label_resolution?: string;
-    tracking_number?: string;
-    tracking_status?: string;
-    tracking_status_detail?: string;
-    tracking_status_updated_at?: string;
-    tracking_details?: string;
-    carrier_weight_oz?: string;
-    signed_by?: string;
-    incoterm?: string;
+    eel_pfc?: string | null;
+    contents_type?: string | null;
+    contents_explanation?: string | null;
+    customs_certify?: boolean | null;
+    customs_signer?: string | null;
+    non_delivery_option?: string | null;
+    restriction_type?: string | null;
+    restriction_comments?: string | null;
+    customs_info_required?: boolean | null;
+    shipping_label_url?: string | null;
+    shipping_label_file_type?: string | null;
+    shipping_label_size?: string | null;
+    shipping_label_resolution?: string | null;
+    tracking_number?: string | null;
+    tracking_status?: string | null;
+    tracking_status_detail?: string | null;
+    tracking_status_updated_at?: string | null;
+    tracking_details?: string | null;
+    carrier_weight_oz?: string | null;
+    signed_by?: string | null;
+    incoterm?: string | null;
+    delivery_confirmation?: string | null;
     shipment: ShipmentRel;
     package: PackageRel;
 }
 interface ParcelUpdate extends ResourceUpdate {
-    weight?: number;
-    unit_of_weight?: string;
-    eel_pfc?: string;
-    contents_type?: string;
-    contents_explanation?: string;
-    customs_certify?: boolean;
-    customs_signer?: string;
-    non_delivery_option?: string;
-    restriction_type?: string;
-    restriction_comments?: string;
-    customs_info_required?: boolean;
-    shipping_label_url?: string;
-    shipping_label_file_type?: string;
-    shipping_label_size?: string;
-    shipping_label_resolution?: string;
-    tracking_number?: string;
-    tracking_status?: string;
-    tracking_status_detail?: string;
-    tracking_status_updated_at?: string;
-    tracking_details?: string;
-    carrier_weight_oz?: string;
-    signed_by?: string;
-    incoterm?: string;
-    shipment?: ShipmentRel;
-    package?: PackageRel;
+    weight?: number | null;
+    unit_of_weight?: string | null;
+    eel_pfc?: string | null;
+    contents_type?: string | null;
+    contents_explanation?: string | null;
+    customs_certify?: boolean | null;
+    customs_signer?: string | null;
+    non_delivery_option?: string | null;
+    restriction_type?: string | null;
+    restriction_comments?: string | null;
+    customs_info_required?: boolean | null;
+    shipping_label_url?: string | null;
+    shipping_label_file_type?: string | null;
+    shipping_label_size?: string | null;
+    shipping_label_resolution?: string | null;
+    tracking_number?: string | null;
+    tracking_status?: string | null;
+    tracking_status_detail?: string | null;
+    tracking_status_updated_at?: string | null;
+    tracking_details?: string | null;
+    carrier_weight_oz?: string | null;
+    signed_by?: string | null;
+    incoterm?: string | null;
+    delivery_confirmation?: string | null;
+    shipment?: ShipmentRel | null;
+    package?: PackageRel | null;
 }
-declare class Parcels extends ApiResource {
-    static readonly TYPE: 'parcels';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Parcel>>;
+declare class Parcels extends ApiResource<Parcel> {
+    static readonly TYPE: ParcelType;
     create(resource: ParcelCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
     update(resource: ParcelUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     shipment(parcelId: string | Parcel, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
     package(parcelId: string | Parcel, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
     parcel_line_items(parcelId: string | Parcel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ParcelLineItem>>;
@@ -113,7 +117,7 @@ declare class Parcels extends ApiResource {
     events(parcelId: string | Parcel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     isParcel(resource: any): resource is Parcel;
     relationship(id: string | ResourceId | null): ParcelRel;
-    type(): string;
+    type(): ParcelType;
 }
 export default Parcels;
-export { Parcel, ParcelCreate, ParcelUpdate };
+export type { Parcel, ParcelCreate, ParcelUpdate, ParcelType };

package/lib/cjs/resources/parcels.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Parcels extends resource_1.ApiResource {
-    // static readonly PATH = 'parcels'
-    async list(params, options) {
-        return this.resources.list({ type: Parcels.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Parcels.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Parcels.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: Parcels.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Parcels.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Parcels.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: Parcels.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: Parcels.TYPE } : id, options);
     }
     async shipment(parcelId, params, options) {
         const _parcelId = parcelId.id || parcelId;
@@ -38,7 +31,6 @@ class Parcels extends resource_1.ApiResource {
         const _parcelId = parcelId.id || parcelId;
         return this.resources.fetch({ type: 'events' }, `parcels/${_parcelId}/events`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isParcel(resource) {
         return resource.type && (resource.type === Parcels.TYPE);
     }

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

@@ -1,21 +1,22 @@
-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 { QueryParamsList } from '../query';
 import type { PaymentMethod } from './payment_methods';
+type PaymentGatewayType = 'payment_gateways';
 type PaymentGatewayRel = ResourceRel & {
-    type: typeof PaymentGateways.TYPE;
+    type: PaymentGatewayType;
 };
 interface PaymentGateway extends Resource {
-    name?: string;
-    payment_methods?: PaymentMethod[];
+    readonly type: PaymentGatewayType;
+    name: string;
+    payment_methods?: PaymentMethod[] | null;
 }
-declare class PaymentGateways extends ApiResource {
-    static readonly TYPE: 'payment_gateways';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentGateway>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
+declare class PaymentGateways extends ApiResource<PaymentGateway> {
+    static readonly TYPE: PaymentGatewayType;
     payment_methods(paymentGatewayId: string | PaymentGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
     isPaymentGateway(resource: any): resource is PaymentGateway;
     relationship(id: string | ResourceId | null): PaymentGatewayRel;
-    type(): string;
+    type(): PaymentGatewayType;
 }
 export default PaymentGateways;
-export { PaymentGateway };
+export type { PaymentGateway, PaymentGatewayType };

package/lib/cjs/resources/payment_gateways.js

@@ -2,18 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class PaymentGateways extends resource_1.ApiResource {
-    // static readonly PATH = 'payment_gateways'
-    async list(params, options) {
-        return this.resources.list({ type: PaymentGateways.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: PaymentGateways.TYPE, id }, params, options);
-    }
     async payment_methods(paymentGatewayId, params, options) {
         const _paymentGatewayId = paymentGatewayId.id || paymentGatewayId;
         return this.resources.fetch({ type: 'payment_methods' }, `payment_gateways/${_paymentGatewayId}/payment_methods`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isPaymentGateway(resource) {
         return resource.type && (resource.type === PaymentGateways.TYPE);
     }