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

package/lib/cjs/resources/return_line_items.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class ReturnLineItems extends resource_1.ApiResource {
+    // static readonly PATH = 'return_line_items'
+    async list(params, options) {
+        return this.resources.list({ type: ReturnLineItems.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ReturnLineItems.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ReturnLineItems.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: ReturnLineItems.TYPE } : id, options);
+    }
+    async return(returnLineItemId, params, options) {
+        const _returnLineItemId = returnLineItemId.id || returnLineItemId;
+        return this.resources.fetch({ type: 'returns' }, `return_line_items/${_returnLineItemId}/return`, params, options);
+    }
+    async line_item(returnLineItemId, params, options) {
+        const _returnLineItemId = returnLineItemId.id || returnLineItemId;
+        return this.resources.fetch({ type: 'line_items' }, `return_line_items/${_returnLineItemId}/line_item`, params, options);
+    }
+    isReturnLineItem(resource) {
+        return resource.type && (resource.type === ReturnLineItems.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: ReturnLineItems.TYPE } : { id: id.id, type: ReturnLineItems.TYPE };
+    }
+    type() {
+        return ReturnLineItems.TYPE;
+    }
+}
+ReturnLineItems.TYPE = 'return_line_items';
+exports.default = ReturnLineItems;

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

@@ -0,0 +1,76 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order, OrderType } from './orders';
+import type { Customer } from './customers';
+import type { StockLocation, StockLocationType } from './stock_locations';
+import type { Address } from './addresses';
+import type { ReturnLineItem } from './return_line_items';
+import type { Attachment } from './attachments';
+import type { Event } from './events';
+type ReturnType = 'returns';
+type ReturnRel = ResourceRel & {
+    type: ReturnType;
+};
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+type StockLocationRel = ResourceRel & {
+    type: StockLocationType;
+};
+interface Return extends Resource {
+    readonly type: ReturnType;
+    number?: string;
+    status?: 'draft' | 'requested' | 'approved' | 'cancelled' | 'shipped' | 'rejected' | 'received';
+    customer_email?: string;
+    skus_count?: number;
+    approved_at?: string;
+    cancelled_at?: string;
+    shipped_at?: string;
+    rejected_at?: string;
+    received_at?: string;
+    archived_at?: string;
+    order?: Order;
+    customer?: Customer;
+    stock_location?: StockLocation;
+    origin_address?: Address;
+    destination_address?: Address;
+    return_line_items?: ReturnLineItem[];
+    attachments?: Attachment[];
+    events?: Event[];
+}
+interface ReturnCreate extends ResourceCreate {
+    order: OrderRel;
+    stock_location?: StockLocationRel;
+}
+interface ReturnUpdate extends ResourceUpdate {
+    _request?: boolean;
+    _approve?: boolean;
+    _cancel?: boolean;
+    _ship?: boolean;
+    _reject?: boolean;
+    _receive?: boolean;
+    _restock?: boolean;
+    _archive?: boolean;
+    _unarchive?: boolean;
+    stock_location?: StockLocationRel;
+}
+declare class Returns extends ApiResource<Return> {
+    static readonly TYPE: ReturnType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Return>>;
+    create(resource: ReturnCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Return>;
+    update(resource: ReturnUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Return>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    order(returnId: string | Return, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    customer(returnId: string | Return, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
+    stock_location(returnId: string | Return, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
+    origin_address(returnId: string | Return, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    destination_address(returnId: string | Return, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    return_line_items(returnId: string | Return, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ReturnLineItem>>;
+    attachments(returnId: string | Return, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(returnId: string | Return, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isReturn(resource: any): resource is Return;
+    relationship(id: string | ResourceId | null): ReturnRel;
+    type(): ReturnType;
+}
+export default Returns;
+export type { Return, ReturnCreate, ReturnUpdate, ReturnType };

package/lib/cjs/resources/returns.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Returns extends resource_1.ApiResource {
+    // static readonly PATH = 'returns'
+    async list(params, options) {
+        return this.resources.list({ type: Returns.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Returns.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Returns.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Returns.TYPE } : id, options);
+    }
+    async order(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'orders' }, `returns/${_returnId}/order`, params, options);
+    }
+    async customer(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'customers' }, `returns/${_returnId}/customer`, params, options);
+    }
+    async stock_location(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'stock_locations' }, `returns/${_returnId}/stock_location`, params, options);
+    }
+    async origin_address(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'addresses' }, `returns/${_returnId}/origin_address`, params, options);
+    }
+    async destination_address(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'addresses' }, `returns/${_returnId}/destination_address`, params, options);
+    }
+    async return_line_items(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'return_line_items' }, `returns/${_returnId}/return_line_items`, params, options);
+    }
+    async attachments(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'attachments' }, `returns/${_returnId}/attachments`, params, options);
+    }
+    async events(returnId, params, options) {
+        const _returnId = returnId.id || returnId;
+        return this.resources.fetch({ type: 'events' }, `returns/${_returnId}/events`, params, options);
+    }
+    isReturn(resource) {
+        return resource.type && (resource.type === Returns.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Returns.TYPE } : { id: id.id, type: Returns.TYPE };
+    }
+    type() {
+        return Returns.TYPE;
+    }
+}
+Returns.TYPE = 'returns';
+exports.default = Returns;

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

@@ -0,0 +1,40 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { PaymentMethod } from './payment_methods';
+import type { SatispayPayment, SatispayPaymentType } from './satispay_payments';
+type SatispayGatewayType = 'satispay_gateways';
+type SatispayGatewayRel = ResourceRel & {
+    type: SatispayGatewayType;
+};
+type SatispayPaymentRel = ResourceRel & {
+    type: SatispayPaymentType;
+};
+interface SatispayGateway extends Resource {
+    readonly type: SatispayGatewayType;
+    name: string;
+    webhook_endpoint_url?: string;
+    payment_methods?: PaymentMethod[];
+    satispay_payments?: SatispayPayment[];
+}
+interface SatispayGatewayCreate extends ResourceCreate {
+    name: string;
+    satispay_payments?: SatispayPaymentRel[];
+}
+interface SatispayGatewayUpdate extends ResourceUpdate {
+    name: string;
+    satispay_payments?: SatispayPaymentRel[];
+}
+declare class SatispayGateways extends ApiResource<SatispayGateway> {
+    static readonly TYPE: SatispayGatewayType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SatispayGateway>>;
+    create(resource: SatispayGatewayCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayGateway>;
+    update(resource: SatispayGatewayUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayGateway>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    payment_methods(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
+    satispay_payments(satispayGatewayId: string | SatispayGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SatispayPayment>>;
+    isSatispayGateway(resource: any): resource is SatispayGateway;
+    relationship(id: string | ResourceId | null): SatispayGatewayRel;
+    type(): SatispayGatewayType;
+}
+export default SatispayGateways;
+export type { SatispayGateway, SatispayGatewayCreate, SatispayGatewayUpdate, SatispayGatewayType };

package/lib/cjs/resources/satispay_gateways.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class SatispayGateways extends resource_1.ApiResource {
+    // static readonly PATH = 'satispay_gateways'
+    async list(params, options) {
+        return this.resources.list({ type: SatispayGateways.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: SatispayGateways.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: SatispayGateways.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: SatispayGateways.TYPE } : id, options);
+    }
+    async payment_methods(satispayGatewayId, params, options) {
+        const _satispayGatewayId = satispayGatewayId.id || satispayGatewayId;
+        return this.resources.fetch({ type: 'payment_methods' }, `satispay_gateways/${_satispayGatewayId}/payment_methods`, params, options);
+    }
+    async satispay_payments(satispayGatewayId, params, options) {
+        const _satispayGatewayId = satispayGatewayId.id || satispayGatewayId;
+        return this.resources.fetch({ type: 'satispay_payments' }, `satispay_gateways/${_satispayGatewayId}/satispay_payments`, params, options);
+    }
+    isSatispayGateway(resource) {
+        return resource.type && (resource.type === SatispayGateways.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: SatispayGateways.TYPE } : { id: id.id, type: SatispayGateways.TYPE };
+    }
+    type() {
+        return SatispayGateways.TYPE;
+    }
+}
+SatispayGateways.TYPE = 'satispay_gateways';
+exports.default = SatispayGateways;

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

@@ -0,0 +1,44 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order, OrderType } from './orders';
+import type { PaymentGateway } from './payment_gateways';
+type SatispayPaymentType = 'satispay_payments';
+type SatispayPaymentRel = ResourceRel & {
+    type: SatispayPaymentType;
+};
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+interface SatispayPayment extends Resource {
+    readonly type: SatispayPaymentType;
+    token?: string;
+    key_id: string;
+    payment_id?: string;
+    redirect_url?: string;
+    order?: Order;
+    payment_gateway?: PaymentGateway;
+}
+interface SatispayPaymentCreate extends ResourceCreate {
+    token?: string;
+    redirect_url?: string;
+    order: OrderRel;
+}
+interface SatispayPaymentUpdate extends ResourceUpdate {
+    redirect_url?: string;
+    _refresh?: boolean;
+    order?: OrderRel;
+}
+declare class SatispayPayments extends ApiResource<SatispayPayment> {
+    static readonly TYPE: SatispayPaymentType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<SatispayPayment>>;
+    create(resource: SatispayPaymentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayPayment>;
+    update(resource: SatispayPaymentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SatispayPayment>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    order(satispayPaymentId: string | SatispayPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    payment_gateway(satispayPaymentId: string | SatispayPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
+    isSatispayPayment(resource: any): resource is SatispayPayment;
+    relationship(id: string | ResourceId | null): SatispayPaymentRel;
+    type(): SatispayPaymentType;
+}
+export default SatispayPayments;
+export type { SatispayPayment, SatispayPaymentCreate, SatispayPaymentUpdate, SatispayPaymentType };

package/lib/cjs/resources/satispay_payments.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class SatispayPayments extends resource_1.ApiResource {
+    // static readonly PATH = 'satispay_payments'
+    async list(params, options) {
+        return this.resources.list({ type: SatispayPayments.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: SatispayPayments.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: SatispayPayments.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: SatispayPayments.TYPE } : id, options);
+    }
+    async order(satispayPaymentId, params, options) {
+        const _satispayPaymentId = satispayPaymentId.id || satispayPaymentId;
+        return this.resources.fetch({ type: 'orders' }, `satispay_payments/${_satispayPaymentId}/order`, params, options);
+    }
+    async payment_gateway(satispayPaymentId, params, options) {
+        const _satispayPaymentId = satispayPaymentId.id || satispayPaymentId;
+        return this.resources.fetch({ type: 'payment_gateways' }, `satispay_payments/${_satispayPaymentId}/payment_gateway`, params, options);
+    }
+    isSatispayPayment(resource) {
+        return resource.type && (resource.type === SatispayPayments.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: SatispayPayments.TYPE } : { id: id.id, type: SatispayPayments.TYPE };
+    }
+    type() {
+        return SatispayPayments.TYPE;
+    }
+}
+SatispayPayments.TYPE = 'satispay_payments';
+exports.default = SatispayPayments;

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

@@ -0,0 +1,94 @@
+import { ApiResource, Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order } from './orders';
+import type { ShippingCategory } from './shipping_categories';
+import type { StockLocation } from './stock_locations';
+import type { Address } from './addresses';
+import type { ShippingMethod, ShippingMethodType } from './shipping_methods';
+import type { DeliveryLeadTime } from './delivery_lead_times';
+import type { StockLineItem } from './stock_line_items';
+import type { StockTransfer } from './stock_transfers';
+import type { CarrierAccount } from './carrier_accounts';
+import type { Parcel } from './parcels';
+import type { Attachment } from './attachments';
+import type { Event } from './events';
+type ShipmentType = 'shipments';
+type ShipmentRel = ResourceRel & {
+    type: ShipmentType;
+};
+type ShippingMethodRel = ResourceRel & {
+    type: ShippingMethodType;
+};
+interface Shipment extends Resource {
+    readonly type: ShipmentType;
+    number?: string;
+    status?: 'draft' | 'upcoming' | 'cancelled' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'shipped';
+    currency_code?: string;
+    cost_amount_cents?: number;
+    cost_amount_float?: number;
+    formatted_cost_amount?: string;
+    skus_count?: number;
+    selected_rate_id?: string;
+    rates?: object[];
+    purchase_error_code?: string;
+    purchase_error_message?: string;
+    get_rates_errors?: object[];
+    get_rates_started_at?: string;
+    get_rates_completed_at?: string;
+    purchase_started_at?: string;
+    purchase_completed_at?: string;
+    purchase_failed_at?: string;
+    order?: Order;
+    shipping_category?: ShippingCategory;
+    stock_location?: StockLocation;
+    origin_address?: Address;
+    shipping_address?: Address;
+    shipping_method?: ShippingMethod;
+    delivery_lead_time?: DeliveryLeadTime;
+    /**
+    * @deprecated This field should not be used as it may be removed in the future without notice
+    */
+    shipment_line_items?: object[];
+    stock_line_items?: StockLineItem[];
+    stock_transfers?: StockTransfer[];
+    available_shipping_methods?: ShippingMethod[];
+    carrier_accounts?: CarrierAccount[];
+    parcels?: Parcel[];
+    attachments?: Attachment[];
+    events?: Event[];
+}
+interface ShipmentUpdate extends ResourceUpdate {
+    _on_hold?: boolean;
+    _picking?: boolean;
+    _packing?: boolean;
+    _ready_to_ship?: boolean;
+    _ship?: boolean;
+    _get_rates?: boolean;
+    selected_rate_id?: string;
+    _purchase?: boolean;
+    shipping_method?: ShippingMethodRel;
+}
+declare class Shipments extends ApiResource<Shipment> {
+    static readonly TYPE: ShipmentType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Shipment>>;
+    update(resource: ShipmentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    order(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    shipping_category(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingCategory>;
+    stock_location(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLocation>;
+    origin_address(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    shipping_address(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    shipping_method(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
+    delivery_lead_time(shipmentId: string | Shipment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<DeliveryLeadTime>;
+    stock_line_items(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockLineItem>>;
+    stock_transfers(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<StockTransfer>>;
+    available_shipping_methods(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ShippingMethod>>;
+    carrier_accounts(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CarrierAccount>>;
+    parcels(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Parcel>>;
+    attachments(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(shipmentId: string | Shipment, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isShipment(resource: any): resource is Shipment;
+    relationship(id: string | ResourceId | null): ShipmentRel;
+    type(): ShipmentType;
+}
+export default Shipments;
+export type { Shipment, ShipmentUpdate, ShipmentType };

package/lib/cjs/resources/shipments.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Shipments extends resource_1.ApiResource {
+    // static readonly PATH = 'shipments'
+    async list(params, options) {
+        return this.resources.list({ type: Shipments.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Shipments.TYPE }), params, options);
+    }
+    async order(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'orders' }, `shipments/${_shipmentId}/order`, params, options);
+    }
+    async shipping_category(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'shipping_categories' }, `shipments/${_shipmentId}/shipping_category`, params, options);
+    }
+    async stock_location(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'stock_locations' }, `shipments/${_shipmentId}/stock_location`, params, options);
+    }
+    async origin_address(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'addresses' }, `shipments/${_shipmentId}/origin_address`, params, options);
+    }
+    async shipping_address(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'addresses' }, `shipments/${_shipmentId}/shipping_address`, params, options);
+    }
+    async shipping_method(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'shipping_methods' }, `shipments/${_shipmentId}/shipping_method`, params, options);
+    }
+    async delivery_lead_time(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'delivery_lead_times' }, `shipments/${_shipmentId}/delivery_lead_time`, params, options);
+    }
+    async stock_line_items(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'stock_line_items' }, `shipments/${_shipmentId}/stock_line_items`, params, options);
+    }
+    async stock_transfers(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'stock_transfers' }, `shipments/${_shipmentId}/stock_transfers`, params, options);
+    }
+    async available_shipping_methods(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'shipping_methods' }, `shipments/${_shipmentId}/available_shipping_methods`, params, options);
+    }
+    async carrier_accounts(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'carrier_accounts' }, `shipments/${_shipmentId}/carrier_accounts`, params, options);
+    }
+    async parcels(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'parcels' }, `shipments/${_shipmentId}/parcels`, params, options);
+    }
+    async attachments(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'attachments' }, `shipments/${_shipmentId}/attachments`, params, options);
+    }
+    async events(shipmentId, params, options) {
+        const _shipmentId = shipmentId.id || shipmentId;
+        return this.resources.fetch({ type: 'events' }, `shipments/${_shipmentId}/events`, params, options);
+    }
+    isShipment(resource) {
+        return resource.type && (resource.type === Shipments.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Shipments.TYPE } : { id: id.id, type: Shipments.TYPE };
+    }
+    type() {
+        return Shipments.TYPE;
+    }
+}
+Shipments.TYPE = 'shipments';
+exports.default = Shipments;

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

@@ -0,0 +1,34 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Sku } from './skus';
+import type { Attachment } from './attachments';
+type ShippingCategoryType = 'shipping_categories';
+type ShippingCategoryRel = ResourceRel & {
+    type: ShippingCategoryType;
+};
+interface ShippingCategory extends Resource {
+    readonly type: ShippingCategoryType;
+    name: string;
+    skus?: Sku[];
+    attachments?: Attachment[];
+}
+interface ShippingCategoryCreate extends ResourceCreate {
+    name: string;
+}
+interface ShippingCategoryUpdate extends ResourceUpdate {
+    name: string;
+}
+declare class ShippingCategories extends ApiResource<ShippingCategory> {
+    static readonly TYPE: ShippingCategoryType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ShippingCategory>>;
+    create(resource: ShippingCategoryCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingCategory>;
+    update(resource: ShippingCategoryUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingCategory>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    skus(shippingCategoryId: string | ShippingCategory, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
+    attachments(shippingCategoryId: string | ShippingCategory, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isShippingCategory(resource: any): resource is ShippingCategory;
+    relationship(id: string | ResourceId | null): ShippingCategoryRel;
+    type(): ShippingCategoryType;
+}
+export default ShippingCategories;
+export type { ShippingCategory, ShippingCategoryCreate, ShippingCategoryUpdate, ShippingCategoryType };

package/lib/cjs/resources/shipping_categories.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class ShippingCategories extends resource_1.ApiResource {
+    // static readonly PATH = 'shipping_categories'
+    async list(params, options) {
+        return this.resources.list({ type: ShippingCategories.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ShippingCategories.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ShippingCategories.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: ShippingCategories.TYPE } : id, options);
+    }
+    async skus(shippingCategoryId, params, options) {
+        const _shippingCategoryId = shippingCategoryId.id || shippingCategoryId;
+        return this.resources.fetch({ type: 'skus' }, `shipping_categories/${_shippingCategoryId}/skus`, params, options);
+    }
+    async attachments(shippingCategoryId, params, options) {
+        const _shippingCategoryId = shippingCategoryId.id || shippingCategoryId;
+        return this.resources.fetch({ type: 'attachments' }, `shipping_categories/${_shippingCategoryId}/attachments`, params, options);
+    }
+    isShippingCategory(resource) {
+        return resource.type && (resource.type === ShippingCategories.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: ShippingCategories.TYPE } : { id: id.id, type: ShippingCategories.TYPE };
+    }
+    type() {
+        return ShippingCategories.TYPE;
+    }
+}
+ShippingCategories.TYPE = 'shipping_categories';
+exports.default = ShippingCategories;

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

@@ -0,0 +1,29 @@
+import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { ShippingMethod } from './shipping_methods';
+import type { Attachment } from './attachments';
+type ShippingMethodTierType = 'shipping_method_tiers';
+type ShippingMethodTierRel = ResourceRel & {
+    type: ShippingMethodTierType;
+};
+interface ShippingMethodTier extends Resource {
+    readonly type: ShippingMethodTierType;
+    name: string;
+    up_to?: number;
+    price_amount_cents: number;
+    price_amount_float?: number;
+    formatted_price_amount?: string;
+    shipping_method?: ShippingMethod;
+    attachments?: Attachment[];
+}
+declare class ShippingMethodTiers extends ApiResource<ShippingMethodTier> {
+    static readonly TYPE: ShippingMethodTierType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ShippingMethodTier>>;
+    shipping_method(shippingMethodTierId: string | ShippingMethodTier, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ShippingMethod>;
+    attachments(shippingMethodTierId: string | ShippingMethodTier, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isShippingMethodTier(resource: any): resource is ShippingMethodTier;
+    relationship(id: string | ResourceId | null): ShippingMethodTierRel;
+    type(): ShippingMethodTierType;
+}
+export default ShippingMethodTiers;
+export type { ShippingMethodTier, ShippingMethodTierType };

package/lib/cjs/resources/shipping_method_tiers.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class ShippingMethodTiers extends resource_1.ApiResource {
+    // static readonly PATH = 'shipping_method_tiers'
+    async list(params, options) {
+        return this.resources.list({ type: ShippingMethodTiers.TYPE }, params, options);
+    }
+    async shipping_method(shippingMethodTierId, params, options) {
+        const _shippingMethodTierId = shippingMethodTierId.id || shippingMethodTierId;
+        return this.resources.fetch({ type: 'shipping_methods' }, `shipping_method_tiers/${_shippingMethodTierId}/shipping_method`, params, options);
+    }
+    async attachments(shippingMethodTierId, params, options) {
+        const _shippingMethodTierId = shippingMethodTierId.id || shippingMethodTierId;
+        return this.resources.fetch({ type: 'attachments' }, `shipping_method_tiers/${_shippingMethodTierId}/attachments`, params, options);
+    }
+    isShippingMethodTier(resource) {
+        return resource.type && (resource.type === ShippingMethodTiers.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: ShippingMethodTiers.TYPE } : { id: id.id, type: ShippingMethodTiers.TYPE };
+    }
+    type() {
+        return ShippingMethodTiers.TYPE;
+    }
+}
+ShippingMethodTiers.TYPE = 'shipping_method_tiers';
+exports.default = ShippingMethodTiers;