@commercelayer/sdk 4.47.0 → 4.49.0

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

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

package/lib/cjs/resources/packages.js

@@ -1,49 +1 @@
-"use strict";
-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);
-    }
-    async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Packages.TYPE }), params, options);
-    }
-    async delete(id, options) {
-        await this.resources.delete({ type: Packages.TYPE, id }, options);
-    }
-    async stock_location(packageId, params, options) {
-        const _packageId = packageId.id || packageId;
-        return this.resources.fetch({ type: 'stock_locations' }, `packages/${_packageId}/stock_location`, params, options);
-    }
-    async parcels(packageId, params, options) {
-        const _packageId = packageId.id || packageId;
-        return this.resources.fetch({ type: 'parcels' }, `packages/${_packageId}/parcels`, params, options);
-    }
-    async attachments(packageId, params, options) {
-        const _packageId = packageId.id || packageId;
-        return this.resources.fetch({ type: 'attachments' }, `packages/${_packageId}/attachments`, params, options);
-    }
-    async versions(packageId, params, options) {
-        const _packageId = packageId.id || packageId;
-        return this.resources.fetch({ type: 'versions' }, `packages/${_packageId}/versions`, 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);
-    }
-    relationship(id) {
-        return ((id === null) || (typeof id === 'string')) ? { id, type: Packages.TYPE } : { id: id.id, type: Packages.TYPE };
-    }
-    type() {
-        return Packages.TYPE;
-    }
-}
-Packages.TYPE = 'packages';
-exports.default = Packages;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const resource_1=require("../resource");class Packages extends resource_1.ApiResource{async list(e,t){return this.resources.list({type:Packages.TYPE},e,t)}async create(e,t,s){return this.resources.create(Object.assign(Object.assign({},e),{type:Packages.TYPE}),t,s)}async retrieve(e,t,s){return this.resources.retrieve({type:Packages.TYPE,id:e},t,s)}async update(e,t,s){return this.resources.update(Object.assign(Object.assign({},e),{type:Packages.TYPE}),t,s)}async delete(e,t){await this.resources.delete({type:Packages.TYPE,id:e},t)}async stock_location(e,t,s){const r=e.id||e;return this.resources.fetch({type:"stock_locations"},`packages/${r}/stock_location`,t,s)}async parcels(e,t,s){const r=e.id||e;return this.resources.fetch({type:"parcels"},`packages/${r}/parcels`,t,s)}async attachments(e,t,s){const r=e.id||e;return this.resources.fetch({type:"attachments"},`packages/${r}/attachments`,t,s)}async versions(e,t,s){const r=e.id||e;return this.resources.fetch({type:"versions"},`packages/${r}/versions`,t,s)}isPackage(e){return e.type&&e.type===Packages.TYPE}relationship(e){return e===null||typeof e=="string"?{id:e,type:Packages.TYPE}:{id:e.id,type:Packages.TYPE}}type(){return Packages.TYPE}}Packages.TYPE="packages",exports.default=Packages;

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

@@ -1,46 +1 @@
-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 type { Version } from './versions';
-type ParcelLineItemRel = ResourceRel & {
-    type: typeof ParcelLineItems.TYPE;
-};
-type ParcelRel = ResourceRel & {
-    type: 'parcels';
-};
-type StockLineItemRel = ResourceRel & {
-    type: 'stock_line_items';
-};
-interface ParcelLineItem extends Resource {
-    sku_code?: string;
-    bundle_code?: string;
-    quantity?: number;
-    name?: string;
-    image_url?: string;
-    parcel?: Parcel;
-    stock_line_item?: StockLineItem;
-    versions?: Version[];
-}
-interface ParcelLineItemCreate extends ResourceCreate {
-    quantity: number;
-    parcel: ParcelRel;
-    stock_line_item: StockLineItemRel;
-}
-type ParcelLineItemUpdate = ResourceUpdate;
-declare class ParcelLineItems extends ApiResource {
-    static readonly TYPE: 'parcel_line_items';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ParcelLineItem>>;
-    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>;
-    parcel(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
-    stock_line_item(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLineItem>;
-    versions(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
-    isParcelLineItem(resource: any): resource is ParcelLineItem;
-    relationship(id: string | ResourceId | null): ParcelLineItemRel;
-    type(): string;
-}
-export default ParcelLineItems;
-export { ParcelLineItem, ParcelLineItemCreate, ParcelLineItemUpdate };
+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 type{Version}from'./versions';type ParcelLineItemRel=ResourceRel&{type:typeof ParcelLineItems.TYPE;};type ParcelRel=ResourceRel&{type:'parcels';};type StockLineItemRel=ResourceRel&{type:'stock_line_items';};interface ParcelLineItem extends Resource{sku_code?:string;bundle_code?:string;quantity?:number;name?:string;image_url?:string;parcel?:Parcel;stock_line_item?:StockLineItem;versions?:Version[];}interface ParcelLineItemCreate extends ResourceCreate{quantity:number;parcel:ParcelRel;stock_line_item:StockLineItemRel;}type ParcelLineItemUpdate=ResourceUpdate;declare class ParcelLineItems extends ApiResource{static readonly TYPE:'parcel_line_items';list(params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<ParcelLineItem>>;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>;parcel(parcelLineItemId:string|ParcelLineItem,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Parcel>;stock_line_item(parcelLineItemId:string|ParcelLineItem,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<StockLineItem>;versions(parcelLineItemId:string|ParcelLineItem,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Version>>;isParcelLineItem(resource:any):resource is ParcelLineItem;relationship(id:string|ResourceId|null):ParcelLineItemRel;type():string;}export default ParcelLineItems;export{ParcelLineItem,ParcelLineItemCreate,ParcelLineItemUpdate};

package/lib/cjs/resources/parcel_line_items.js

@@ -1,45 +1 @@
-"use strict";
-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);
-    }
-    async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ParcelLineItems.TYPE }), params, options);
-    }
-    async delete(id, options) {
-        await this.resources.delete({ type: ParcelLineItems.TYPE, id }, options);
-    }
-    async parcel(parcelLineItemId, params, options) {
-        const _parcelLineItemId = parcelLineItemId.id || parcelLineItemId;
-        return this.resources.fetch({ type: 'parcels' }, `parcel_line_items/${_parcelLineItemId}/parcel`, params, options);
-    }
-    async stock_line_item(parcelLineItemId, params, options) {
-        const _parcelLineItemId = parcelLineItemId.id || parcelLineItemId;
-        return this.resources.fetch({ type: 'stock_line_items' }, `parcel_line_items/${_parcelLineItemId}/stock_line_item`, params, options);
-    }
-    async versions(parcelLineItemId, params, options) {
-        const _parcelLineItemId = parcelLineItemId.id || parcelLineItemId;
-        return this.resources.fetch({ type: 'versions' }, `parcel_line_items/${_parcelLineItemId}/versions`, 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);
-    }
-    relationship(id) {
-        return ((id === null) || (typeof id === 'string')) ? { id, type: ParcelLineItems.TYPE } : { id: id.id, type: ParcelLineItems.TYPE };
-    }
-    type() {
-        return ParcelLineItems.TYPE;
-    }
-}
-ParcelLineItems.TYPE = 'parcel_line_items';
-exports.default = ParcelLineItems;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const resource_1=require("../resource");class ParcelLineItems extends resource_1.ApiResource{async list(e,t){return this.resources.list({type:ParcelLineItems.TYPE},e,t)}async create(e,t,s){return this.resources.create(Object.assign(Object.assign({},e),{type:ParcelLineItems.TYPE}),t,s)}async retrieve(e,t,s){return this.resources.retrieve({type:ParcelLineItems.TYPE,id:e},t,s)}async update(e,t,s){return this.resources.update(Object.assign(Object.assign({},e),{type:ParcelLineItems.TYPE}),t,s)}async delete(e,t){await this.resources.delete({type:ParcelLineItems.TYPE,id:e},t)}async parcel(e,t,s){const r=e.id||e;return this.resources.fetch({type:"parcels"},`parcel_line_items/${r}/parcel`,t,s)}async stock_line_item(e,t,s){const r=e.id||e;return this.resources.fetch({type:"stock_line_items"},`parcel_line_items/${r}/stock_line_item`,t,s)}async versions(e,t,s){const r=e.id||e;return this.resources.fetch({type:"versions"},`parcel_line_items/${r}/versions`,t,s)}isParcelLineItem(e){return e.type&&e.type===ParcelLineItems.TYPE}relationship(e){return e===null||typeof e=="string"?{id:e,type:ParcelLineItems.TYPE}:{id:e.id,type:ParcelLineItems.TYPE}}type(){return ParcelLineItems.TYPE}}ParcelLineItems.TYPE="parcel_line_items",exports.default=ParcelLineItems;

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

@@ -1,125 +1 @@
-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 type { ParcelLineItem } from './parcel_line_items';
-import type { Attachment } from './attachments';
-import type { Event } from './events';
-import type { Version } from './versions';
-type ParcelRel = ResourceRel & {
-    type: typeof Parcels.TYPE;
-};
-type ShipmentRel = ResourceRel & {
-    type: 'shipments';
-};
-type PackageRel = ResourceRel & {
-    type: 'packages';
-};
-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?: object;
-    carrier_weight_oz?: string;
-    signed_by?: string;
-    incoterm?: string;
-    delivery_confirmation?: string;
-    shipment?: Shipment;
-    package?: Package;
-    parcel_line_items?: ParcelLineItem[];
-    attachments?: Attachment[];
-    events?: Event[];
-    versions?: Version[];
-}
-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?: object;
-    carrier_weight_oz?: string;
-    signed_by?: string;
-    incoterm?: string;
-    delivery_confirmation?: string;
-    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?: object;
-    carrier_weight_oz?: string;
-    signed_by?: string;
-    incoterm?: string;
-    delivery_confirmation?: string;
-    shipment?: ShipmentRel;
-    package?: PackageRel;
-}
-declare class Parcels extends ApiResource {
-    static readonly TYPE: 'parcels';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Parcel>>;
-    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>;
-    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>>;
-    attachments(parcelId: string | Parcel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
-    events(parcelId: string | Parcel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
-    versions(parcelId: string | Parcel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
-    isParcel(resource: any): resource is Parcel;
-    relationship(id: string | ResourceId | null): ParcelRel;
-    type(): string;
-}
-export default Parcels;
-export { Parcel, ParcelCreate, ParcelUpdate };
+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 type{ParcelLineItem}from'./parcel_line_items';import type{Attachment}from'./attachments';import type{Event}from'./events';import type{Version}from'./versions';type ParcelRel=ResourceRel&{type:typeof Parcels.TYPE;};type ShipmentRel=ResourceRel&{type:'shipments';};type PackageRel=ResourceRel&{type:'packages';};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?:object;carrier_weight_oz?:string;signed_by?:string;incoterm?:string;delivery_confirmation?:string;shipment?:Shipment;package?:Package;parcel_line_items?:ParcelLineItem[];attachments?:Attachment[];events?:Event[];versions?:Version[];}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?:object;carrier_weight_oz?:string;signed_by?:string;incoterm?:string;delivery_confirmation?:string;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?:object;carrier_weight_oz?:string;signed_by?:string;incoterm?:string;delivery_confirmation?:string;shipment?:ShipmentRel;package?:PackageRel;}declare class Parcels extends ApiResource{static readonly TYPE:'parcels';list(params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Parcel>>;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>;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>>;attachments(parcelId:string|Parcel,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Attachment>>;events(parcelId:string|Parcel,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Event>>;versions(parcelId:string|Parcel,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Version>>;isParcel(resource:any):resource is Parcel;relationship(id:string|ResourceId|null):ParcelRel;type():string;}export default Parcels;export{Parcel,ParcelCreate,ParcelUpdate};

package/lib/cjs/resources/parcels.js

@@ -1,57 +1 @@
-"use strict";
-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);
-    }
-    async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Parcels.TYPE }), params, options);
-    }
-    async delete(id, options) {
-        await this.resources.delete({ type: Parcels.TYPE, id }, options);
-    }
-    async shipment(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'shipments' }, `parcels/${_parcelId}/shipment`, params, options);
-    }
-    async package(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'packages' }, `parcels/${_parcelId}/package`, params, options);
-    }
-    async parcel_line_items(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'parcel_line_items' }, `parcels/${_parcelId}/parcel_line_items`, params, options);
-    }
-    async attachments(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'attachments' }, `parcels/${_parcelId}/attachments`, params, options);
-    }
-    async events(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'events' }, `parcels/${_parcelId}/events`, params, options);
-    }
-    async versions(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'versions' }, `parcels/${_parcelId}/versions`, 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);
-    }
-    relationship(id) {
-        return ((id === null) || (typeof id === 'string')) ? { id, type: Parcels.TYPE } : { id: id.id, type: Parcels.TYPE };
-    }
-    type() {
-        return Parcels.TYPE;
-    }
-}
-Parcels.TYPE = 'parcels';
-exports.default = Parcels;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const resource_1=require("../resource");class Parcels extends resource_1.ApiResource{async list(e,t){return this.resources.list({type:Parcels.TYPE},e,t)}async create(e,t,s){return this.resources.create(Object.assign(Object.assign({},e),{type:Parcels.TYPE}),t,s)}async retrieve(e,t,s){return this.resources.retrieve({type:Parcels.TYPE,id:e},t,s)}async update(e,t,s){return this.resources.update(Object.assign(Object.assign({},e),{type:Parcels.TYPE}),t,s)}async delete(e,t){await this.resources.delete({type:Parcels.TYPE,id:e},t)}async shipment(e,t,s){const r=e.id||e;return this.resources.fetch({type:"shipments"},`parcels/${r}/shipment`,t,s)}async package(e,t,s){const r=e.id||e;return this.resources.fetch({type:"packages"},`parcels/${r}/package`,t,s)}async parcel_line_items(e,t,s){const r=e.id||e;return this.resources.fetch({type:"parcel_line_items"},`parcels/${r}/parcel_line_items`,t,s)}async attachments(e,t,s){const r=e.id||e;return this.resources.fetch({type:"attachments"},`parcels/${r}/attachments`,t,s)}async events(e,t,s){const r=e.id||e;return this.resources.fetch({type:"events"},`parcels/${r}/events`,t,s)}async versions(e,t,s){const r=e.id||e;return this.resources.fetch({type:"versions"},`parcels/${r}/versions`,t,s)}isParcel(e){return e.type&&e.type===Parcels.TYPE}relationship(e){return e===null||typeof e=="string"?{id:e,type:Parcels.TYPE}:{id:e.id,type:Parcels.TYPE}}type(){return Parcels.TYPE}}Parcels.TYPE="parcels",exports.default=Parcels;

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

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

package/lib/cjs/resources/payment_gateways.js

@@ -1,32 +1 @@
-"use strict";
-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);
-    }
-    async versions(paymentGatewayId, params, options) {
-        const _paymentGatewayId = paymentGatewayId.id || paymentGatewayId;
-        return this.resources.fetch({ type: 'versions' }, `payment_gateways/${_paymentGatewayId}/versions`, 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);
-    }
-    relationship(id) {
-        return ((id === null) || (typeof id === 'string')) ? { id, type: PaymentGateways.TYPE } : { id: id.id, type: PaymentGateways.TYPE };
-    }
-    type() {
-        return PaymentGateways.TYPE;
-    }
-}
-PaymentGateways.TYPE = 'payment_gateways';
-exports.default = PaymentGateways;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const resource_1=require("../resource");class PaymentGateways extends resource_1.ApiResource{async list(e,t){return this.resources.list({type:PaymentGateways.TYPE},e,t)}async retrieve(e,t,r){return this.resources.retrieve({type:PaymentGateways.TYPE,id:e},t,r)}async payment_methods(e,t,r){const s=e.id||e;return this.resources.fetch({type:"payment_methods"},`payment_gateways/${s}/payment_methods`,t,r)}async versions(e,t,r){const s=e.id||e;return this.resources.fetch({type:"versions"},`payment_gateways/${s}/versions`,t,r)}isPaymentGateway(e){return e.type&&e.type===PaymentGateways.TYPE}relationship(e){return e===null||typeof e=="string"?{id:e,type:PaymentGateways.TYPE}:{id:e.id,type:PaymentGateways.TYPE}}type(){return PaymentGateways.TYPE}}PaymentGateways.TYPE="payment_gateways",exports.default=PaymentGateways;

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

@@ -1,80 +1 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Market } from './markets';
-import type { PaymentGateway } from './payment_gateways';
-import type { Attachment } from './attachments';
-import type { Version } from './versions';
-type PaymentMethodRel = ResourceRel & {
-    type: typeof PaymentMethods.TYPE;
-};
-type MarketRel = ResourceRel & {
-    type: 'markets';
-};
-type PaymentGatewayRel = ResourceRel & {
-    type: 'payment_gateways';
-};
-interface PaymentMethod extends Resource {
-    name?: string;
-    payment_source_type?: string;
-    currency_code?: string;
-    moto?: boolean;
-    require_capture?: boolean;
-    auto_place?: boolean;
-    auto_capture?: boolean;
-    price_amount_cents?: number;
-    price_amount_float?: number;
-    formatted_price_amount?: string;
-    auto_capture_max_amount_cents?: number;
-    auto_capture_max_amount_float?: number;
-    formatted_auto_capture_max_amount?: string;
-    disabled_at?: string;
-    market?: Market;
-    payment_gateway?: PaymentGateway;
-    attachments?: Attachment[];
-    versions?: Version[];
-}
-interface PaymentMethodCreate extends ResourceCreate {
-    payment_source_type: string;
-    currency_code?: string;
-    moto?: boolean;
-    require_capture?: boolean;
-    auto_place?: boolean;
-    auto_capture?: boolean;
-    price_amount_cents: number;
-    auto_capture_max_amount_cents?: number;
-    _disable?: boolean;
-    _enable?: boolean;
-    market?: MarketRel;
-    payment_gateway: PaymentGatewayRel;
-}
-interface PaymentMethodUpdate extends ResourceUpdate {
-    payment_source_type?: string;
-    currency_code?: string;
-    moto?: boolean;
-    require_capture?: boolean;
-    auto_place?: boolean;
-    auto_capture?: boolean;
-    price_amount_cents?: number;
-    auto_capture_max_amount_cents?: number;
-    _disable?: boolean;
-    _enable?: boolean;
-    market?: MarketRel;
-    payment_gateway?: PaymentGatewayRel;
-}
-declare class PaymentMethods extends ApiResource {
-    static readonly TYPE: 'payment_methods';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
-    create(resource: PaymentMethodCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
-    update(resource: PaymentMethodUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
-    market(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
-    payment_gateway(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
-    attachments(paymentMethodId: string | PaymentMethod, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
-    versions(paymentMethodId: string | PaymentMethod, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
-    isPaymentMethod(resource: any): resource is PaymentMethod;
-    relationship(id: string | ResourceId | null): PaymentMethodRel;
-    type(): string;
-}
-export default PaymentMethods;
-export { PaymentMethod, PaymentMethodCreate, PaymentMethodUpdate };
+import{ApiResource,Resource,ResourceCreate,ResourceUpdate,ResourcesConfig,ResourceId,ResourceRel,ListResponse}from'../resource';import type{QueryParamsList,QueryParamsRetrieve}from'../query';import type{Market}from'./markets';import type{PaymentGateway}from'./payment_gateways';import type{Attachment}from'./attachments';import type{Version}from'./versions';type PaymentMethodRel=ResourceRel&{type:typeof PaymentMethods.TYPE;};type MarketRel=ResourceRel&{type:'markets';};type PaymentGatewayRel=ResourceRel&{type:'payment_gateways';};interface PaymentMethod extends Resource{name?:string;payment_source_type?:string;currency_code?:string;moto?:boolean;require_capture?:boolean;auto_place?:boolean;auto_capture?:boolean;price_amount_cents?:number;price_amount_float?:number;formatted_price_amount?:string;auto_capture_max_amount_cents?:number;auto_capture_max_amount_float?:number;formatted_auto_capture_max_amount?:string;disabled_at?:string;market?:Market;payment_gateway?:PaymentGateway;attachments?:Attachment[];versions?:Version[];}interface PaymentMethodCreate extends ResourceCreate{payment_source_type:string;currency_code?:string;moto?:boolean;require_capture?:boolean;auto_place?:boolean;auto_capture?:boolean;price_amount_cents:number;auto_capture_max_amount_cents?:number;_disable?:boolean;_enable?:boolean;market?:MarketRel;payment_gateway:PaymentGatewayRel;}interface PaymentMethodUpdate extends ResourceUpdate{payment_source_type?:string;currency_code?:string;moto?:boolean;require_capture?:boolean;auto_place?:boolean;auto_capture?:boolean;price_amount_cents?:number;auto_capture_max_amount_cents?:number;_disable?:boolean;_enable?:boolean;market?:MarketRel;payment_gateway?:PaymentGatewayRel;}declare class PaymentMethods extends ApiResource{static readonly TYPE:'payment_methods';list(params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<PaymentMethod>>;create(resource:PaymentMethodCreate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<PaymentMethod>;retrieve(id:string,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<PaymentMethod>;update(resource:PaymentMethodUpdate,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<PaymentMethod>;delete(id:string,options?:ResourcesConfig):Promise<void>;market(paymentMethodId:string|PaymentMethod,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<Market>;payment_gateway(paymentMethodId:string|PaymentMethod,params?:QueryParamsRetrieve,options?:ResourcesConfig):Promise<PaymentGateway>;attachments(paymentMethodId:string|PaymentMethod,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Attachment>>;versions(paymentMethodId:string|PaymentMethod,params?:QueryParamsList,options?:ResourcesConfig):Promise<ListResponse<Version>>;isPaymentMethod(resource:any):resource is PaymentMethod;relationship(id:string|ResourceId|null):PaymentMethodRel;type():string;}export default PaymentMethods;export{PaymentMethod,PaymentMethodCreate,PaymentMethodUpdate};

package/lib/cjs/resources/payment_methods.js

@@ -1,49 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const resource_1 = require("../resource");
-class PaymentMethods extends resource_1.ApiResource {
-    // static readonly PATH = 'payment_methods'
-    async list(params, options) {
-        return this.resources.list({ type: PaymentMethods.TYPE }, params, options);
-    }
-    async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: PaymentMethods.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: PaymentMethods.TYPE, id }, params, options);
-    }
-    async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: PaymentMethods.TYPE }), params, options);
-    }
-    async delete(id, options) {
-        await this.resources.delete({ type: PaymentMethods.TYPE, id }, options);
-    }
-    async market(paymentMethodId, params, options) {
-        const _paymentMethodId = paymentMethodId.id || paymentMethodId;
-        return this.resources.fetch({ type: 'markets' }, `payment_methods/${_paymentMethodId}/market`, params, options);
-    }
-    async payment_gateway(paymentMethodId, params, options) {
-        const _paymentMethodId = paymentMethodId.id || paymentMethodId;
-        return this.resources.fetch({ type: 'payment_gateways' }, `payment_methods/${_paymentMethodId}/payment_gateway`, params, options);
-    }
-    async attachments(paymentMethodId, params, options) {
-        const _paymentMethodId = paymentMethodId.id || paymentMethodId;
-        return this.resources.fetch({ type: 'attachments' }, `payment_methods/${_paymentMethodId}/attachments`, params, options);
-    }
-    async versions(paymentMethodId, params, options) {
-        const _paymentMethodId = paymentMethodId.id || paymentMethodId;
-        return this.resources.fetch({ type: 'versions' }, `payment_methods/${_paymentMethodId}/versions`, params, options);
-    }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
-    isPaymentMethod(resource) {
-        return resource.type && (resource.type === PaymentMethods.TYPE);
-    }
-    relationship(id) {
-        return ((id === null) || (typeof id === 'string')) ? { id, type: PaymentMethods.TYPE } : { id: id.id, type: PaymentMethods.TYPE };
-    }
-    type() {
-        return PaymentMethods.TYPE;
-    }
-}
-PaymentMethods.TYPE = 'payment_methods';
-exports.default = PaymentMethods;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const resource_1=require("../resource");class PaymentMethods extends resource_1.ApiResource{async list(e,t){return this.resources.list({type:PaymentMethods.TYPE},e,t)}async create(e,t,s){return this.resources.create(Object.assign(Object.assign({},e),{type:PaymentMethods.TYPE}),t,s)}async retrieve(e,t,s){return this.resources.retrieve({type:PaymentMethods.TYPE,id:e},t,s)}async update(e,t,s){return this.resources.update(Object.assign(Object.assign({},e),{type:PaymentMethods.TYPE}),t,s)}async delete(e,t){await this.resources.delete({type:PaymentMethods.TYPE,id:e},t)}async market(e,t,s){const r=e.id||e;return this.resources.fetch({type:"markets"},`payment_methods/${r}/market`,t,s)}async payment_gateway(e,t,s){const r=e.id||e;return this.resources.fetch({type:"payment_gateways"},`payment_methods/${r}/payment_gateway`,t,s)}async attachments(e,t,s){const r=e.id||e;return this.resources.fetch({type:"attachments"},`payment_methods/${r}/attachments`,t,s)}async versions(e,t,s){const r=e.id||e;return this.resources.fetch({type:"versions"},`payment_methods/${r}/versions`,t,s)}isPaymentMethod(e){return e.type&&e.type===PaymentMethods.TYPE}relationship(e){return e===null||typeof e=="string"?{id:e,type:PaymentMethods.TYPE}:{id:e.id,type:PaymentMethods.TYPE}}type(){return PaymentMethods.TYPE}}PaymentMethods.TYPE="payment_methods",exports.default=PaymentMethods;