@commercelayer/sdk 4.27.1 → 4.28.0

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

@@ -1,56 +1,68 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Market } from './markets';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Market, MarketType } from './markets';
 import type { Attachment } from './attachments';
+import type { Event } from './events';
+import type { Tag, TagType } from './tags';
+type SkuOptionType = 'sku_options';
 type SkuOptionRel = ResourceRel & {
-    type: typeof SkuOptions.TYPE;
+    type: SkuOptionType;
 };
 type MarketRel = ResourceRel & {
-    type: 'markets';
+    type: MarketType;
+};
+type TagRel = ResourceRel & {
+    type: TagType;
 };
 interface SkuOption extends Resource {
-    name?: string;
-    currency_code?: string;
-    description?: string;
-    price_amount_cents?: number;
-    price_amount_float?: number;
-    formatted_price_amount?: string;
-    delay_hours?: number;
-    delay_days?: number;
-    sku_code_regex?: string;
-    market?: Market;
-    attachments?: Attachment[];
+    readonly type: SkuOptionType;
+    name: string;
+    currency_code?: string | null;
+    description?: string | null;
+    price_amount_cents?: number | null;
+    price_amount_float?: number | null;
+    formatted_price_amount?: string | null;
+    delay_hours?: number | null;
+    delay_days?: number | null;
+    sku_code_regex?: string | null;
+    market?: Market | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
 }
 interface SkuOptionCreate extends ResourceCreate {
     name: string;
-    currency_code?: string;
-    description?: string;
-    price_amount_cents?: number;
-    delay_hours?: number;
-    sku_code_regex?: string;
-    market?: MarketRel;
+    currency_code?: string | null;
+    description?: string | null;
+    price_amount_cents?: number | null;
+    delay_hours?: number | null;
+    sku_code_regex?: string | null;
+    market?: MarketRel | null;
+    tags?: TagRel[] | null;
 }
 interface SkuOptionUpdate extends ResourceUpdate {
-    name?: string;
-    currency_code?: string;
-    description?: string;
-    price_amount_cents?: number;
-    delay_hours?: number;
-    sku_code_regex?: string;
-    market?: MarketRel;
+    name?: string | null;
+    currency_code?: string | null;
+    description?: string | null;
+    price_amount_cents?: number | null;
+    delay_hours?: number | null;
+    sku_code_regex?: string | null;
+    market?: MarketRel | null;
+    tags?: TagRel[] | null;
 }
-declare class SkuOptions extends ApiResource {
-    static readonly TYPE: 'sku_options';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SkuOption>>;
+declare class SkuOptions extends ApiResource<SkuOption> {
+    static readonly TYPE: SkuOptionType;
     create(resource: SkuOptionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuOption>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuOption>;
     update(resource: SkuOptionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuOption>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     market(skuOptionId: string | SkuOption, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     attachments(skuOptionId: string | SkuOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(skuOptionId: string | SkuOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    tags(skuOptionId: string | SkuOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     isSkuOption(resource: any): resource is SkuOption;
     relationship(id: string | ResourceId | null): SkuOptionRel;
-    type(): string;
+    type(): SkuOptionType;
 }
 export default SkuOptions;
-export { SkuOption, SkuOptionCreate, SkuOptionUpdate };
+export type { SkuOption, SkuOptionCreate, SkuOptionUpdate, SkuOptionType };

package/lib/cjs/resources/sku_options.js

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

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

@@ -1,78 +1,90 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { ShippingCategory } from './shipping_categories';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { ShippingCategory, ShippingCategoryType } from './shipping_categories';
 import type { Price } from './prices';
 import type { StockItem } from './stock_items';
 import type { DeliveryLeadTime } from './delivery_lead_times';
 import type { SkuOption } from './sku_options';
 import type { Attachment } from './attachments';
+import type { Event } from './events';
+import type { Tag, TagType } from './tags';
+type SkuType = 'skus';
 type SkuRel = ResourceRel & {
-    type: typeof Skus.TYPE;
+    type: SkuType;
 };
 type ShippingCategoryRel = ResourceRel & {
-    type: 'shipping_categories';
+    type: ShippingCategoryType;
+};
+type TagRel = ResourceRel & {
+    type: TagType;
 };
 interface Sku extends Resource {
-    code?: string;
-    name?: string;
-    description?: string;
-    image_url?: string;
-    pieces_per_pack?: number;
-    weight?: number;
-    unit_of_weight?: string;
-    hs_tariff_number?: string;
-    do_not_ship?: boolean;
-    do_not_track?: boolean;
-    inventory?: object;
-    shipping_category?: ShippingCategory;
-    prices?: Price[];
-    stock_items?: StockItem[];
-    delivery_lead_times?: DeliveryLeadTime[];
-    sku_options?: SkuOption[];
-    attachments?: Attachment[];
+    readonly type: SkuType;
+    code: string;
+    name: string;
+    description?: string | null;
+    image_url?: string | null;
+    pieces_per_pack?: number | null;
+    weight?: number | null;
+    unit_of_weight?: string | null;
+    hs_tariff_number?: string | null;
+    do_not_ship?: boolean | null;
+    do_not_track?: boolean | null;
+    inventory?: Record<string, any> | null;
+    shipping_category?: ShippingCategory | null;
+    prices?: Price[] | null;
+    stock_items?: StockItem[] | null;
+    delivery_lead_times?: DeliveryLeadTime[] | null;
+    sku_options?: SkuOption[] | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
 }
 interface SkuCreate extends ResourceCreate {
     code: string;
     name: string;
-    description?: string;
-    image_url?: string;
-    pieces_per_pack?: number;
-    weight?: number;
-    unit_of_weight?: string;
-    hs_tariff_number?: string;
-    do_not_ship?: boolean;
-    do_not_track?: boolean;
+    description?: string | null;
+    image_url?: string | null;
+    pieces_per_pack?: number | null;
+    weight?: number | null;
+    unit_of_weight?: string | null;
+    hs_tariff_number?: string | null;
+    do_not_ship?: boolean | null;
+    do_not_track?: boolean | null;
     shipping_category: ShippingCategoryRel;
+    tags?: TagRel[] | null;
 }
 interface SkuUpdate extends ResourceUpdate {
-    code?: string;
-    name?: string;
-    description?: string;
-    image_url?: string;
-    pieces_per_pack?: number;
-    weight?: number;
-    unit_of_weight?: string;
-    hs_tariff_number?: string;
-    do_not_ship?: boolean;
-    do_not_track?: boolean;
-    shipping_category?: ShippingCategoryRel;
+    code?: string | null;
+    name?: string | null;
+    description?: string | null;
+    image_url?: string | null;
+    pieces_per_pack?: number | null;
+    weight?: number | null;
+    unit_of_weight?: string | null;
+    hs_tariff_number?: string | null;
+    do_not_ship?: boolean | null;
+    do_not_track?: boolean | null;
+    shipping_category?: ShippingCategoryRel | null;
+    tags?: TagRel[] | null;
 }
-declare class Skus extends ApiResource {
-    static readonly TYPE: 'skus';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
+declare class Skus extends ApiResource<Sku> {
+    static readonly TYPE: SkuType;
     create(resource: SkuCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
     update(resource: SkuUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     shipping_category(skuId: string | Sku, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingCategory>;
     prices(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Price>>;
     stock_items(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockItem>>;
     delivery_lead_times(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<DeliveryLeadTime>>;
     sku_options(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SkuOption>>;
     attachments(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    tags(skuId: string | Sku, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     isSku(resource: any): resource is Sku;
     relationship(id: string | ResourceId | null): SkuRel;
-    type(): string;
+    type(): SkuType;
 }
 export default Skus;
-export { Sku, SkuCreate, SkuUpdate };
+export type { Sku, SkuCreate, SkuUpdate, SkuType };

package/lib/cjs/resources/skus.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Skus extends resource_1.ApiResource {
-    // static readonly PATH = 'skus'
-    async list(params, options) {
-        return this.resources.list({ type: Skus.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Skus.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Skus.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: Skus.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Skus.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Skus.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: Skus.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: Skus.TYPE } : id, options);
     }
     async shipping_category(skuId, params, options) {
         const _skuId = skuId.id || skuId;
@@ -42,7 +35,14 @@ class Skus extends resource_1.ApiResource {
         const _skuId = skuId.id || skuId;
         return this.resources.fetch({ type: 'attachments' }, `skus/${_skuId}/attachments`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    async events(skuId, params, options) {
+        const _skuId = skuId.id || skuId;
+        return this.resources.fetch({ type: 'events' }, `skus/${_skuId}/events`, params, options);
+    }
+    async tags(skuId, params, options) {
+        const _skuId = skuId.id || skuId;
+        return this.resources.fetch({ type: 'tags' }, `skus/${_skuId}/tags`, params, options);
+    }
     isSku(resource) {
         return resource.type && (resource.type === Skus.TYPE);
     }

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

@@ -1,49 +1,50 @@
-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 { Sku } from './skus';
+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 { Sku, SkuType } from './skus';
 import type { Attachment } from './attachments';
+type StockItemType = 'stock_items';
 type StockItemRel = ResourceRel & {
-    type: typeof StockItems.TYPE;
+    type: StockItemType;
 };
 type StockLocationRel = ResourceRel & {
-    type: 'stock_locations';
+    type: StockLocationType;
 };
 type SkuRel = ResourceRel & {
-    type: 'skus';
+    type: SkuType;
 };
 interface StockItem extends Resource {
-    sku_code?: string;
-    quantity?: number;
-    stock_location?: StockLocation;
-    sku?: Sku;
-    attachments?: Attachment[];
+    readonly type: StockItemType;
+    sku_code?: string | null;
+    quantity: number;
+    stock_location?: StockLocation | null;
+    sku?: Sku | null;
+    attachments?: Attachment[] | null;
 }
 interface StockItemCreate extends ResourceCreate {
-    sku_code?: string;
+    sku_code?: string | null;
     quantity: number;
     stock_location: StockLocationRel;
-    sku?: SkuRel;
+    sku?: SkuRel | null;
 }
 interface StockItemUpdate extends ResourceUpdate {
-    sku_code?: string;
-    quantity?: number;
-    stock_location?: StockLocationRel;
-    sku?: SkuRel;
+    sku_code?: string | null;
+    quantity?: number | null;
+    stock_location?: StockLocationRel | null;
+    sku?: SkuRel | null;
 }
-declare class StockItems extends ApiResource {
-    static readonly TYPE: 'stock_items';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockItem>>;
+declare class StockItems extends ApiResource<StockItem> {
+    static readonly TYPE: StockItemType;
     create(resource: StockItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockItem>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockItem>;
     update(resource: StockItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockItem>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     stock_location(stockItemId: string | StockItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
     sku(stockItemId: string | StockItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
     attachments(stockItemId: string | StockItem, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     isStockItem(resource: any): resource is StockItem;
     relationship(id: string | ResourceId | null): StockItemRel;
-    type(): string;
+    type(): StockItemType;
 }
 export default StockItems;
-export { StockItem, StockItemCreate, StockItemUpdate };
+export type { StockItem, StockItemCreate, StockItemUpdate, StockItemType };

package/lib/cjs/resources/stock_items.js

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

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

@@ -1,29 +1,30 @@
-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 } from '../resource';
+import type { QueryParamsRetrieve } from '../query';
 import type { Shipment } from './shipments';
 import type { LineItem } from './line_items';
 import type { StockItem } from './stock_items';
+type StockLineItemType = 'stock_line_items';
 type StockLineItemRel = ResourceRel & {
-    type: typeof StockLineItems.TYPE;
+    type: StockLineItemType;
 };
 interface StockLineItem extends Resource {
-    sku_code?: string;
-    bundle_code?: string;
-    quantity?: number;
-    shipment?: Shipment;
-    line_item?: LineItem;
-    stock_item?: StockItem;
+    readonly type: StockLineItemType;
+    sku_code?: string | null;
+    bundle_code?: string | null;
+    quantity: number;
+    shipment?: Shipment | null;
+    line_item?: LineItem | null;
+    stock_item?: StockItem | null;
 }
-declare class StockLineItems extends ApiResource {
-    static readonly TYPE: 'stock_line_items';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockLineItem>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLineItem>;
+declare class StockLineItems extends ApiResource<StockLineItem> {
+    static readonly TYPE: StockLineItemType;
     shipment(stockLineItemId: string | StockLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
     line_item(stockLineItemId: string | StockLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<LineItem>;
     stock_item(stockLineItemId: string | StockLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockItem>;
     isStockLineItem(resource: any): resource is StockLineItem;
     relationship(id: string | ResourceId | null): StockLineItemRel;
-    type(): string;
+    type(): StockLineItemType;
 }
 export default StockLineItems;
-export { StockLineItem };
+export type { StockLineItem, StockLineItemType };

package/lib/cjs/resources/stock_line_items.js

@@ -2,13 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class StockLineItems extends resource_1.ApiResource {
-    // static readonly PATH = 'stock_line_items'
-    async list(params, options) {
-        return this.resources.list({ type: StockLineItems.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: StockLineItems.TYPE, id }, params, options);
-    }
     async shipment(stockLineItemId, params, options) {
         const _stockLineItemId = stockLineItemId.id || stockLineItemId;
         return this.resources.fetch({ type: 'shipments' }, `stock_line_items/${_stockLineItemId}/shipment`, params, options);
@@ -21,7 +14,6 @@ class StockLineItems extends resource_1.ApiResource {
         const _stockLineItemId = stockLineItemId.id || stockLineItemId;
         return this.resources.fetch({ type: 'stock_items' }, `stock_line_items/${_stockLineItemId}/stock_item`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isStockLineItem(resource) {
         return resource.type && (resource.type === StockLineItems.TYPE);
     }

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

@@ -1,48 +1,49 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Address } from './addresses';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Address, AddressType } from './addresses';
 import type { InventoryStockLocation } from './inventory_stock_locations';
 import type { InventoryReturnLocation } from './inventory_return_locations';
 import type { StockItem } from './stock_items';
 import type { StockTransfer } from './stock_transfers';
 import type { Attachment } from './attachments';
+type StockLocationType = 'stock_locations';
 type StockLocationRel = ResourceRel & {
-    type: typeof StockLocations.TYPE;
+    type: StockLocationType;
 };
 type AddressRel = ResourceRel & {
-    type: 'addresses';
+    type: AddressType;
 };
 interface StockLocation extends Resource {
-    number?: number;
-    name?: string;
-    label_format?: string;
-    suppress_etd?: boolean;
-    address?: Address;
-    inventory_stock_locations?: InventoryStockLocation[];
-    inventory_return_locations?: InventoryReturnLocation[];
-    stock_items?: StockItem[];
-    stock_transfers?: StockTransfer[];
-    attachments?: Attachment[];
+    readonly type: StockLocationType;
+    number?: number | null;
+    name: string;
+    label_format?: string | null;
+    suppress_etd?: boolean | null;
+    address?: Address | null;
+    inventory_stock_locations?: InventoryStockLocation[] | null;
+    inventory_return_locations?: InventoryReturnLocation[] | null;
+    stock_items?: StockItem[] | null;
+    stock_transfers?: StockTransfer[] | null;
+    attachments?: Attachment[] | null;
 }
 interface StockLocationCreate extends ResourceCreate {
     name: string;
-    label_format?: string;
-    suppress_etd?: boolean;
+    label_format?: string | null;
+    suppress_etd?: boolean | null;
     address: AddressRel;
 }
 interface StockLocationUpdate extends ResourceUpdate {
-    name?: string;
-    label_format?: string;
-    suppress_etd?: boolean;
-    address?: AddressRel;
+    name?: string | null;
+    label_format?: string | null;
+    suppress_etd?: boolean | null;
+    address?: AddressRel | null;
 }
-declare class StockLocations extends ApiResource {
-    static readonly TYPE: 'stock_locations';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockLocation>>;
+declare class StockLocations extends ApiResource<StockLocation> {
+    static readonly TYPE: StockLocationType;
     create(resource: StockLocationCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
     update(resource: StockLocationUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     address(stockLocationId: string | StockLocation, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
     inventory_stock_locations(stockLocationId: string | StockLocation, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<InventoryStockLocation>>;
     inventory_return_locations(stockLocationId: string | StockLocation, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<InventoryReturnLocation>>;
@@ -51,7 +52,7 @@ declare class StockLocations extends ApiResource {
     attachments(stockLocationId: string | StockLocation, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     isStockLocation(resource: any): resource is StockLocation;
     relationship(id: string | ResourceId | null): StockLocationRel;
-    type(): string;
+    type(): StockLocationType;
 }
 export default StockLocations;
-export { StockLocation, StockLocationCreate, StockLocationUpdate };
+export type { StockLocation, StockLocationCreate, StockLocationUpdate, StockLocationType };

package/lib/cjs/resources/stock_locations.js

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