@commercelayer/sdk 4.41.0 → 4.42.0

package/lib/cjs/resources/orders.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Orders extends resource_1.ApiResource {
-    // static readonly PATH = 'orders'
-    async list(params, options) {
-        return this.resources.list({ type: Orders.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Orders.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Orders.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: Orders.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Orders.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Orders.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: Orders.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: Orders.TYPE } : id, options);
     }
     async market(orderId, params, options) {
         const _orderId = orderId.id || orderId;
@@ -102,6 +95,10 @@ class Orders extends resource_1.ApiResource {
         const _orderId = orderId.id || orderId;
         return this.resources.fetch({ type: 'returns' }, `orders/${_orderId}/returns`, params, options);
     }
+    async order_subscription(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'order_subscriptions' }, `orders/${_orderId}/order_subscription`, params, options);
+    }
     async order_subscriptions(orderId, params, options) {
         const _orderId = orderId.id || orderId;
         return this.resources.fetch({ type: 'order_subscriptions' }, `orders/${_orderId}/order_subscriptions`, params, options);
@@ -134,7 +131,87 @@ class Orders extends resource_1.ApiResource {
         const _orderId = orderId.id || orderId;
         return this.resources.fetch({ type: 'versions' }, `orders/${_orderId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    async _archive(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _archive: true }, params, options);
+    }
+    async _unarchive(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _unarchive: true }, params, options);
+    }
+    async _place(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _place: true }, params, options);
+    }
+    async _cancel(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _cancel: true }, params, options);
+    }
+    async _approve(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _approve: true }, params, options);
+    }
+    async _approve_and_capture(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _approve_and_capture: true }, params, options);
+    }
+    async _authorize(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _authorize: true }, params, options);
+    }
+    async _authorization_amount_cents(id, triggerValue, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _authorization_amount_cents: triggerValue }, params, options);
+    }
+    async _capture(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _capture: true }, params, options);
+    }
+    async _refund(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _refund: true }, params, options);
+    }
+    async _update_taxes(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _update_taxes: true }, params, options);
+    }
+    async _nullify_payment_source(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _nullify_payment_source: true }, params, options);
+    }
+    async _billing_address_clone_id(id, triggerValue, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _billing_address_clone_id: triggerValue }, params, options);
+    }
+    async _shipping_address_clone_id(id, triggerValue, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _shipping_address_clone_id: triggerValue }, params, options);
+    }
+    async _customer_payment_source_id(id, triggerValue, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _customer_payment_source_id: triggerValue }, params, options);
+    }
+    async _shipping_address_same_as_billing(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _shipping_address_same_as_billing: true }, params, options);
+    }
+    async _billing_address_same_as_shipping(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _billing_address_same_as_shipping: true }, params, options);
+    }
+    async _commit_invoice(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _commit_invoice: true }, params, options);
+    }
+    async _refund_invoice(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _refund_invoice: true }, params, options);
+    }
+    async _save_payment_source_to_customer_wallet(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _save_payment_source_to_customer_wallet: true }, params, options);
+    }
+    async _save_shipping_address_to_customer_address_book(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _save_shipping_address_to_customer_address_book: true }, params, options);
+    }
+    async _save_billing_address_to_customer_address_book(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _save_billing_address_to_customer_address_book: true }, params, options);
+    }
+    async _refresh(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _refresh: true }, params, options);
+    }
+    async _validate(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _validate: true }, params, options);
+    }
+    async _create_subscriptions(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _create_subscriptions: true }, params, options);
+    }
+    async _start_editing(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _start_editing: true }, params, options);
+    }
+    async _stop_editing(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _stop_editing: true }, params, options);
+    }
     isOrder(resource) {
         return resource.type && (resource.type === Orders.TYPE);
     }

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

@@ -1,32 +1,33 @@
-import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel } from '../resource';
-import type { QueryParamsRetrieve } from '../query';
+import { ApiSingleton } from '../resource';
+import type { Resource, ResourceId, ResourceRel } from '../resource';
+type OrganizationType = 'organization';
 type OrganizationRel = ResourceRel & {
-    type: typeof Organizations.TYPE;
+    type: OrganizationType;
 };
 interface Organization extends Resource {
-    name?: string;
-    slug?: string;
-    domain?: string;
-    support_phone?: string;
-    support_email?: string;
-    logo_url?: string;
-    favicon_url?: string;
-    primary_color?: string;
-    gtm_id?: string;
-    gtm_id_test?: string;
-    max_concurrent_promotions?: number;
-    max_concurrent_imports?: number;
-    max_concurrent_exports?: number;
-    max_concurrent_cleanups?: number;
-    order_number_editable_test?: boolean;
-    order_number_editable_live?: boolean;
+    readonly type: OrganizationType;
+    name?: string | null;
+    slug?: string | null;
+    domain?: string | null;
+    support_phone?: string | null;
+    support_email?: string | null;
+    logo_url?: string | null;
+    favicon_url?: string | null;
+    primary_color?: string | null;
+    gtm_id?: string | null;
+    gtm_id_test?: string | null;
+    max_concurrent_promotions?: number | null;
+    max_concurrent_imports?: number | null;
+    max_concurrent_exports?: number | null;
+    max_concurrent_cleanups?: number | null;
+    order_number_editable_test?: boolean | null;
+    order_number_editable_live?: boolean | null;
 }
-declare class Organizations extends ApiResource {
-    static readonly TYPE: 'organization';
-    retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
+declare class Organizations extends ApiSingleton<Organization> {
+    static readonly TYPE: OrganizationType;
     isOrganization(resource: any): resource is Organization;
     relationship(id: string | ResourceId | null): OrganizationRel;
-    type(): string;
+    type(): OrganizationType;
 }
 export default Organizations;
-export { Organization };
+export type { Organization, OrganizationType };

package/lib/cjs/resources/organization.js

@@ -1,12 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
-class Organizations extends resource_1.ApiResource {
-    // static readonly PATH = 'organization'
-    async retrieve(params, options) {
-        return this.resources.singleton({ type: Organizations.TYPE }, params, options);
-    }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+class Organizations extends resource_1.ApiSingleton {
     isOrganization(resource) {
         return resource.type && (resource.type === Organizations.TYPE);
     }

package/lib/cjs/resources/packages.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 { 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';
 import type { Version } from './versions';
+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[];
-    versions?: Version[];
+    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;
+    versions?: Version[] | null;
 }
 interface PackageCreate extends ResourceCreate {
     name: string;
-    code?: string;
+    code?: string | null;
     length: number;
     width: number;
     height: number;
@@ -32,28 +35,26 @@ 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>>;
     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;
+    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;
@@ -34,7 +27,6 @@ class Packages extends resource_1.ApiResource {
         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);
     }

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, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Parcel, ParcelType } from './parcels';
+import type { StockLineItem, StockLineItemType } from './stock_line_items';
 import type { Version } from './versions';
+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;
-    bundle_code?: string;
-    quantity?: number;
-    name?: string;
-    image_url?: string;
-    parcel?: Parcel;
-    stock_line_item?: StockLineItem;
+    readonly type: ParcelLineItemType;
+    sku_code?: string | null;
+    bundle_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;
-    versions?: Version[];
+    versions?: Version[] | null;
 }
 interface ParcelLineItemCreate extends ResourceCreate {
     quantity: number;
@@ -36,19 +39,17 @@ 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>;
     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;
+    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;
@@ -30,7 +23,6 @@ class ParcelLineItems extends resource_1.ApiResource {
         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);
     }