@commercelayer/sdk 5.0.0-alpha.5 → 5.0.0-beta.1

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

@@ -0,0 +1,57 @@
+import { ApiResource, 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';
+type SkuOptionType = 'sku_options';
+type SkuOptionRel = ResourceRel & {
+    type: SkuOptionType;
+};
+type MarketRel = ResourceRel & {
+    type: MarketType;
+};
+interface SkuOption extends Resource {
+    readonly type: SkuOptionType;
+    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[];
+}
+interface SkuOptionCreate extends ResourceCreate {
+    name: string;
+    currency_code?: string;
+    description?: string;
+    price_amount_cents?: number;
+    delay_hours?: number;
+    sku_code_regex?: string;
+    market?: MarketRel;
+}
+interface SkuOptionUpdate extends ResourceUpdate {
+    name?: string;
+    currency_code?: string;
+    description?: string;
+    price_amount_cents?: number;
+    delay_hours?: number;
+    sku_code_regex?: string;
+    market?: MarketRel;
+}
+declare class SkuOptions extends ApiResource<SkuOption> {
+    static readonly TYPE: SkuOptionType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SkuOption>>;
+    create(resource: SkuOptionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuOption>;
+    update(resource: SkuOptionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuOption>;
+    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>>;
+    isSkuOption(resource: any): resource is SkuOption;
+    relationship(id: string | ResourceId | null): SkuOptionRel;
+    type(): SkuOptionType;
+}
+export default SkuOptions;
+export type { SkuOption, SkuOptionCreate, SkuOptionUpdate, SkuOptionType };

package/lib/cjs/resources/sku_options.js

@@ -0,0 +1,37 @@
+"use strict";
+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 update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: SkuOptions.TYPE }), params, options);
+    }
+    async delete(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;
+        return this.resources.fetch({ type: 'markets' }, `sku_options/${_skuOptionId}/market`, params, options);
+    }
+    async attachments(skuOptionId, params, options) {
+        const _skuOptionId = skuOptionId.id || skuOptionId;
+        return this.resources.fetch({ type: 'attachments' }, `sku_options/${_skuOptionId}/attachments`, params, options);
+    }
+    isSkuOption(resource) {
+        return resource.type && (resource.type === SkuOptions.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: SkuOptions.TYPE } : { id: id.id, type: SkuOptions.TYPE };
+    }
+    type() {
+        return SkuOptions.TYPE;
+    }
+}
+SkuOptions.TYPE = 'sku_options';
+exports.default = SkuOptions;

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

@@ -0,0 +1,79 @@
+import { ApiResource, 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';
+type SkuType = 'skus';
+type SkuRel = ResourceRel & {
+    type: SkuType;
+};
+type ShippingCategoryRel = ResourceRel & {
+    type: ShippingCategoryType;
+};
+interface Sku extends Resource {
+    readonly type: SkuType;
+    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[];
+}
+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;
+    shipping_category: ShippingCategoryRel;
+}
+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;
+}
+declare class Skus extends ApiResource<Sku> {
+    static readonly TYPE: SkuType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
+    create(resource: SkuCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
+    update(resource: SkuUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
+    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>>;
+    isSku(resource: any): resource is Sku;
+    relationship(id: string | ResourceId | null): SkuRel;
+    type(): SkuType;
+}
+export default Skus;
+export type { Sku, SkuCreate, SkuUpdate, SkuType };

package/lib/cjs/resources/skus.js

@@ -0,0 +1,53 @@
+"use strict";
+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 update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Skus.TYPE }), params, options);
+    }
+    async delete(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;
+        return this.resources.fetch({ type: 'shipping_categories' }, `skus/${_skuId}/shipping_category`, params, options);
+    }
+    async prices(skuId, params, options) {
+        const _skuId = skuId.id || skuId;
+        return this.resources.fetch({ type: 'prices' }, `skus/${_skuId}/prices`, params, options);
+    }
+    async stock_items(skuId, params, options) {
+        const _skuId = skuId.id || skuId;
+        return this.resources.fetch({ type: 'stock_items' }, `skus/${_skuId}/stock_items`, params, options);
+    }
+    async delivery_lead_times(skuId, params, options) {
+        const _skuId = skuId.id || skuId;
+        return this.resources.fetch({ type: 'delivery_lead_times' }, `skus/${_skuId}/delivery_lead_times`, params, options);
+    }
+    async sku_options(skuId, params, options) {
+        const _skuId = skuId.id || skuId;
+        return this.resources.fetch({ type: 'sku_options' }, `skus/${_skuId}/sku_options`, params, options);
+    }
+    async attachments(skuId, params, options) {
+        const _skuId = skuId.id || skuId;
+        return this.resources.fetch({ type: 'attachments' }, `skus/${_skuId}/attachments`, params, options);
+    }
+    isSku(resource) {
+        return resource.type && (resource.type === Skus.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Skus.TYPE } : { id: id.id, type: Skus.TYPE };
+    }
+    type() {
+        return Skus.TYPE;
+    }
+}
+Skus.TYPE = 'skus';
+exports.default = Skus;

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

@@ -0,0 +1,50 @@
+import { ApiResource, 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: StockItemType;
+};
+type StockLocationRel = ResourceRel & {
+    type: StockLocationType;
+};
+type SkuRel = ResourceRel & {
+    type: SkuType;
+};
+interface StockItem extends Resource {
+    readonly type: StockItemType;
+    sku_code?: string;
+    quantity?: number;
+    stock_location?: StockLocation;
+    sku?: Sku;
+    attachments?: Attachment[];
+}
+interface StockItemCreate extends ResourceCreate {
+    sku_code?: string;
+    quantity: number;
+    stock_location: StockLocationRel;
+    sku?: SkuRel;
+}
+interface StockItemUpdate extends ResourceUpdate {
+    sku_code?: string;
+    quantity?: number;
+    stock_location?: StockLocationRel;
+    sku?: SkuRel;
+}
+declare class StockItems extends ApiResource<StockItem> {
+    static readonly TYPE: StockItemType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockItem>>;
+    create(resource: StockItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockItem>;
+    update(resource: StockItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockItem>;
+    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(): StockItemType;
+}
+export default StockItems;
+export type { StockItem, StockItemCreate, StockItemUpdate, StockItemType };

package/lib/cjs/resources/stock_items.js

@@ -0,0 +1,41 @@
+"use strict";
+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 update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: StockItems.TYPE }), params, options);
+    }
+    async delete(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;
+        return this.resources.fetch({ type: 'stock_locations' }, `stock_items/${_stockItemId}/stock_location`, params, options);
+    }
+    async sku(stockItemId, params, options) {
+        const _stockItemId = stockItemId.id || stockItemId;
+        return this.resources.fetch({ type: 'skus' }, `stock_items/${_stockItemId}/sku`, params, options);
+    }
+    async attachments(stockItemId, params, options) {
+        const _stockItemId = stockItemId.id || stockItemId;
+        return this.resources.fetch({ type: 'attachments' }, `stock_items/${_stockItemId}/attachments`, params, options);
+    }
+    isStockItem(resource) {
+        return resource.type && (resource.type === StockItems.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: StockItems.TYPE } : { id: id.id, type: StockItems.TYPE };
+    }
+    type() {
+        return StockItems.TYPE;
+    }
+}
+StockItems.TYPE = 'stock_items';
+exports.default = StockItems;

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

@@ -0,0 +1,30 @@
+import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } 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: StockLineItemType;
+};
+interface StockLineItem extends Resource {
+    readonly type: StockLineItemType;
+    sku_code?: string;
+    bundle_code?: string;
+    quantity?: number;
+    shipment?: Shipment;
+    line_item?: LineItem;
+    stock_item?: StockItem;
+}
+declare class StockLineItems extends ApiResource<StockLineItem> {
+    static readonly TYPE: StockLineItemType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockLineItem>>;
+    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(): StockLineItemType;
+}
+export default StockLineItems;
+export type { StockLineItem, StockLineItemType };

package/lib/cjs/resources/stock_line_items.js

@@ -0,0 +1,32 @@
+"use strict";
+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 shipment(stockLineItemId, params, options) {
+        const _stockLineItemId = stockLineItemId.id || stockLineItemId;
+        return this.resources.fetch({ type: 'shipments' }, `stock_line_items/${_stockLineItemId}/shipment`, params, options);
+    }
+    async line_item(stockLineItemId, params, options) {
+        const _stockLineItemId = stockLineItemId.id || stockLineItemId;
+        return this.resources.fetch({ type: 'line_items' }, `stock_line_items/${_stockLineItemId}/line_item`, params, options);
+    }
+    async stock_item(stockLineItemId, params, options) {
+        const _stockLineItemId = stockLineItemId.id || stockLineItemId;
+        return this.resources.fetch({ type: 'stock_items' }, `stock_line_items/${_stockLineItemId}/stock_item`, params, options);
+    }
+    isStockLineItem(resource) {
+        return resource.type && (resource.type === StockLineItems.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: StockLineItems.TYPE } : { id: id.id, type: StockLineItems.TYPE };
+    }
+    type() {
+        return StockLineItems.TYPE;
+    }
+}
+StockLineItems.TYPE = 'stock_line_items';
+exports.default = StockLineItems;

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

@@ -0,0 +1,58 @@
+import { ApiResource, 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: StockLocationType;
+};
+type AddressRel = ResourceRel & {
+    type: AddressType;
+};
+interface StockLocation extends Resource {
+    readonly type: StockLocationType;
+    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[];
+}
+interface StockLocationCreate extends ResourceCreate {
+    name: string;
+    label_format?: string;
+    suppress_etd?: boolean;
+    address: AddressRel;
+}
+interface StockLocationUpdate extends ResourceUpdate {
+    name?: string;
+    label_format?: string;
+    suppress_etd?: boolean;
+    address?: AddressRel;
+}
+declare class StockLocations extends ApiResource<StockLocation> {
+    static readonly TYPE: StockLocationType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockLocation>>;
+    create(resource: StockLocationCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
+    update(resource: StockLocationUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
+    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>>;
+    stock_items(stockLocationId: string | StockLocation, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockItem>>;
+    stock_transfers(stockLocationId: string | StockLocation, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockTransfer>>;
+    attachments(stockLocationId: string | StockLocation, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isStockLocation(resource: any): resource is StockLocation;
+    relationship(id: string | ResourceId | null): StockLocationRel;
+    type(): StockLocationType;
+}
+export default StockLocations;
+export type { StockLocation, StockLocationCreate, StockLocationUpdate, StockLocationType };

package/lib/cjs/resources/stock_locations.js

@@ -0,0 +1,53 @@
+"use strict";
+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 update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: StockLocations.TYPE }), params, options);
+    }
+    async delete(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;
+        return this.resources.fetch({ type: 'addresses' }, `stock_locations/${_stockLocationId}/address`, params, options);
+    }
+    async inventory_stock_locations(stockLocationId, params, options) {
+        const _stockLocationId = stockLocationId.id || stockLocationId;
+        return this.resources.fetch({ type: 'inventory_stock_locations' }, `stock_locations/${_stockLocationId}/inventory_stock_locations`, params, options);
+    }
+    async inventory_return_locations(stockLocationId, params, options) {
+        const _stockLocationId = stockLocationId.id || stockLocationId;
+        return this.resources.fetch({ type: 'inventory_return_locations' }, `stock_locations/${_stockLocationId}/inventory_return_locations`, params, options);
+    }
+    async stock_items(stockLocationId, params, options) {
+        const _stockLocationId = stockLocationId.id || stockLocationId;
+        return this.resources.fetch({ type: 'stock_items' }, `stock_locations/${_stockLocationId}/stock_items`, params, options);
+    }
+    async stock_transfers(stockLocationId, params, options) {
+        const _stockLocationId = stockLocationId.id || stockLocationId;
+        return this.resources.fetch({ type: 'stock_transfers' }, `stock_locations/${_stockLocationId}/stock_transfers`, params, options);
+    }
+    async attachments(stockLocationId, params, options) {
+        const _stockLocationId = stockLocationId.id || stockLocationId;
+        return this.resources.fetch({ type: 'attachments' }, `stock_locations/${_stockLocationId}/attachments`, params, options);
+    }
+    isStockLocation(resource) {
+        return resource.type && (resource.type === StockLocations.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: StockLocations.TYPE } : { id: id.id, type: StockLocations.TYPE };
+    }
+    type() {
+        return StockLocations.TYPE;
+    }
+}
+StockLocations.TYPE = 'stock_locations';
+exports.default = StockLocations;

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

@@ -0,0 +1,75 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Sku, SkuType } from './skus';
+import type { StockLocation, StockLocationType } from './stock_locations';
+import type { Shipment, ShipmentType } from './shipments';
+import type { LineItem, LineItemType } from './line_items';
+import type { Event } from './events';
+type StockTransferType = 'stock_transfers';
+type StockTransferRel = ResourceRel & {
+    type: StockTransferType;
+};
+type SkuRel = ResourceRel & {
+    type: SkuType;
+};
+type StockLocationRel = ResourceRel & {
+    type: StockLocationType;
+};
+type ShipmentRel = ResourceRel & {
+    type: ShipmentType;
+};
+type LineItemRel = ResourceRel & {
+    type: LineItemType;
+};
+interface StockTransfer extends Resource {
+    readonly type: StockTransferType;
+    sku_code?: string;
+    status?: 'draft' | 'upcoming' | 'picking' | 'in_transit' | 'completed' | 'cancelled';
+    quantity?: number;
+    completed_at?: string;
+    cancelled_at?: string;
+    sku?: Sku;
+    origin_stock_location?: StockLocation;
+    destination_stock_location?: StockLocation;
+    shipment?: Shipment;
+    line_item?: LineItem;
+    events?: Event[];
+}
+interface StockTransferCreate extends ResourceCreate {
+    sku_code?: string;
+    quantity: number;
+    sku: SkuRel;
+    origin_stock_location: StockLocationRel;
+    destination_stock_location: StockLocationRel;
+    shipment?: ShipmentRel;
+    line_item?: LineItemRel;
+}
+interface StockTransferUpdate extends ResourceUpdate {
+    sku_code?: string;
+    _upcoming?: boolean;
+    _picking?: boolean;
+    _in_transit?: boolean;
+    _complete?: boolean;
+    _cancel?: boolean;
+    sku?: SkuRel;
+    origin_stock_location?: StockLocationRel;
+    destination_stock_location?: StockLocationRel;
+}
+declare class StockTransfers extends ApiResource<StockTransfer> {
+    static readonly TYPE: StockTransferType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockTransfer>>;
+    create(resource: StockTransferCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockTransfer>;
+    update(resource: StockTransferUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockTransfer>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    sku(stockTransferId: string | StockTransfer, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Sku>;
+    origin_stock_location(stockTransferId: string | StockTransfer, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
+    destination_stock_location(stockTransferId: string | StockTransfer, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
+    shipment(stockTransferId: string | StockTransfer, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    line_item(stockTransferId: string | StockTransfer, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<LineItem>;
+    events(stockTransferId: string | StockTransfer, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isStockTransfer(resource: any): resource is StockTransfer;
+    relationship(id: string | ResourceId | null): StockTransferRel;
+    type(): StockTransferType;
+}
+export default StockTransfers;
+export type { StockTransfer, StockTransferCreate, StockTransferUpdate, StockTransferType };

package/lib/cjs/resources/stock_transfers.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class StockTransfers extends resource_1.ApiResource {
+    // static readonly PATH = 'stock_transfers'
+    async list(params, options) {
+        return this.resources.list({ type: StockTransfers.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: StockTransfers.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: StockTransfers.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: StockTransfers.TYPE } : id, options);
+    }
+    async sku(stockTransferId, params, options) {
+        const _stockTransferId = stockTransferId.id || stockTransferId;
+        return this.resources.fetch({ type: 'skus' }, `stock_transfers/${_stockTransferId}/sku`, params, options);
+    }
+    async origin_stock_location(stockTransferId, params, options) {
+        const _stockTransferId = stockTransferId.id || stockTransferId;
+        return this.resources.fetch({ type: 'stock_locations' }, `stock_transfers/${_stockTransferId}/origin_stock_location`, params, options);
+    }
+    async destination_stock_location(stockTransferId, params, options) {
+        const _stockTransferId = stockTransferId.id || stockTransferId;
+        return this.resources.fetch({ type: 'stock_locations' }, `stock_transfers/${_stockTransferId}/destination_stock_location`, params, options);
+    }
+    async shipment(stockTransferId, params, options) {
+        const _stockTransferId = stockTransferId.id || stockTransferId;
+        return this.resources.fetch({ type: 'shipments' }, `stock_transfers/${_stockTransferId}/shipment`, params, options);
+    }
+    async line_item(stockTransferId, params, options) {
+        const _stockTransferId = stockTransferId.id || stockTransferId;
+        return this.resources.fetch({ type: 'line_items' }, `stock_transfers/${_stockTransferId}/line_item`, params, options);
+    }
+    async events(stockTransferId, params, options) {
+        const _stockTransferId = stockTransferId.id || stockTransferId;
+        return this.resources.fetch({ type: 'events' }, `stock_transfers/${_stockTransferId}/events`, params, options);
+    }
+    isStockTransfer(resource) {
+        return resource.type && (resource.type === StockTransfers.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: StockTransfers.TYPE } : { id: id.id, type: StockTransfers.TYPE };
+    }
+    type() {
+        return StockTransfers.TYPE;
+    }
+}
+StockTransfers.TYPE = 'stock_transfers';
+exports.default = StockTransfers;