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

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

@@ -0,0 +1,24 @@
+import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Market } from './markets';
+import type { Attachment } from './attachments';
+type OrderValidationRuleType = 'order_validation_rules';
+type OrderValidationRuleRel = ResourceRel & {
+    type: OrderValidationRuleType;
+};
+interface OrderValidationRule extends Resource {
+    readonly type: OrderValidationRuleType;
+    market?: Market;
+    attachments?: Attachment[];
+}
+declare class OrderValidationRules extends ApiResource<OrderValidationRule> {
+    static readonly TYPE: OrderValidationRuleType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderValidationRule>>;
+    market(orderValidationRuleId: string | OrderValidationRule, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
+    attachments(orderValidationRuleId: string | OrderValidationRule, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isOrderValidationRule(resource: any): resource is OrderValidationRule;
+    relationship(id: string | ResourceId | null): OrderValidationRuleRel;
+    type(): OrderValidationRuleType;
+}
+export default OrderValidationRules;
+export type { OrderValidationRule, OrderValidationRuleType };

package/lib/cjs/resources/order_validation_rules.js

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

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

@@ -0,0 +1,297 @@
+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 { Customer, CustomerType } from './customers';
+import type { Address, AddressType } from './addresses';
+import type { PaymentMethod, PaymentMethodType } from './payment_methods';
+import type { CustomerPaymentSource } from './customer_payment_sources';
+import type { Sku } from './skus';
+import type { Bundle } from './bundles';
+import type { AdyenPayment, AdyenPaymentType } from './adyen_payments';
+import type { AxervePayment, AxervePaymentType } from './axerve_payments';
+import type { BraintreePayment, BraintreePaymentType } from './braintree_payments';
+import type { CheckoutComPayment, CheckoutComPaymentType } from './checkout_com_payments';
+import type { ExternalPayment, ExternalPaymentType } from './external_payments';
+import type { KlarnaPayment, KlarnaPaymentType } from './klarna_payments';
+import type { PaypalPayment, PaypalPaymentType } from './paypal_payments';
+import type { SatispayPayment, SatispayPaymentType } from './satispay_payments';
+import type { StripePayment, StripePaymentType } from './stripe_payments';
+import type { WireTransfer, WireTransferType } from './wire_transfers';
+import type { LineItem } from './line_items';
+import type { Shipment } from './shipments';
+import type { Authorization } from './authorizations';
+import type { Void } from './voids';
+import type { Capture } from './captures';
+import type { Refund } from './refunds';
+import type { Return } from './returns';
+import type { OrderSubscription } from './order_subscriptions';
+import type { OrderCopy } from './order_copies';
+import type { Attachment } from './attachments';
+import type { Event } from './events';
+type OrderType = 'orders';
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+type MarketRel = ResourceRel & {
+    type: MarketType;
+};
+type CustomerRel = ResourceRel & {
+    type: CustomerType;
+};
+type AddressRel = ResourceRel & {
+    type: AddressType;
+};
+type PaymentMethodRel = ResourceRel & {
+    type: PaymentMethodType;
+};
+type AdyenPaymentRel = ResourceRel & {
+    type: AdyenPaymentType;
+};
+type AxervePaymentRel = ResourceRel & {
+    type: AxervePaymentType;
+};
+type BraintreePaymentRel = ResourceRel & {
+    type: BraintreePaymentType;
+};
+type CheckoutComPaymentRel = ResourceRel & {
+    type: CheckoutComPaymentType;
+};
+type ExternalPaymentRel = ResourceRel & {
+    type: ExternalPaymentType;
+};
+type KlarnaPaymentRel = ResourceRel & {
+    type: KlarnaPaymentType;
+};
+type PaypalPaymentRel = ResourceRel & {
+    type: PaypalPaymentType;
+};
+type SatispayPaymentRel = ResourceRel & {
+    type: SatispayPaymentType;
+};
+type StripePaymentRel = ResourceRel & {
+    type: StripePaymentType;
+};
+type WireTransferRel = ResourceRel & {
+    type: WireTransferType;
+};
+interface Order extends Resource {
+    readonly type: OrderType;
+    number?: number;
+    autorefresh?: boolean;
+    status?: 'draft' | 'pending' | 'placed' | 'approved' | 'cancelled';
+    payment_status?: 'unpaid' | 'authorized' | 'paid' | 'voided' | 'refunded';
+    fulfillment_status?: 'unfulfilled' | 'in_progress' | 'fulfilled';
+    guest?: boolean;
+    editable?: boolean;
+    customer_email?: string;
+    language_code?: string;
+    currency_code?: string;
+    tax_included?: boolean;
+    tax_rate?: number;
+    freight_taxable?: boolean;
+    requires_billing_info?: boolean;
+    country_code?: string;
+    shipping_country_code_lock?: string;
+    coupon_code?: string;
+    gift_card_code?: string;
+    gift_card_or_coupon_code?: string;
+    subtotal_amount_cents?: number;
+    subtotal_amount_float?: number;
+    formatted_subtotal_amount?: string;
+    shipping_amount_cents?: number;
+    shipping_amount_float?: number;
+    formatted_shipping_amount?: string;
+    payment_method_amount_cents?: number;
+    payment_method_amount_float?: number;
+    formatted_payment_method_amount?: string;
+    discount_amount_cents?: number;
+    discount_amount_float?: number;
+    formatted_discount_amount?: string;
+    adjustment_amount_cents?: number;
+    adjustment_amount_float?: number;
+    formatted_adjustment_amount?: string;
+    gift_card_amount_cents?: number;
+    gift_card_amount_float?: number;
+    formatted_gift_card_amount?: string;
+    total_tax_amount_cents?: number;
+    total_tax_amount_float?: number;
+    formatted_total_tax_amount?: string;
+    subtotal_tax_amount_cents?: number;
+    subtotal_tax_amount_float?: number;
+    formatted_subtotal_tax_amount?: string;
+    shipping_tax_amount_cents?: number;
+    shipping_tax_amount_float?: number;
+    formatted_shipping_tax_amount?: string;
+    payment_method_tax_amount_cents?: number;
+    payment_method_tax_amount_float?: number;
+    formatted_payment_method_tax_amount?: string;
+    adjustment_tax_amount_cents?: number;
+    adjustment_tax_amount_float?: number;
+    formatted_adjustment_tax_amount?: string;
+    total_amount_cents?: number;
+    total_amount_float?: number;
+    formatted_total_amount?: string;
+    total_taxable_amount_cents?: number;
+    total_taxable_amount_float?: number;
+    formatted_total_taxable_amount?: string;
+    subtotal_taxable_amount_cents?: number;
+    subtotal_taxable_amount_float?: number;
+    formatted_subtotal_taxable_amount?: string;
+    shipping_taxable_amount_cents?: number;
+    shipping_taxable_amount_float?: number;
+    formatted_shipping_taxable_amount?: string;
+    payment_method_taxable_amount_cents?: number;
+    payment_method_taxable_amount_float?: number;
+    formatted_payment_method_taxable_amount?: string;
+    adjustment_taxable_amount_cents?: number;
+    adjustment_taxable_amount_float?: number;
+    formatted_adjustment_taxable_amount?: string;
+    total_amount_with_taxes_cents?: number;
+    total_amount_with_taxes_float?: number;
+    formatted_total_amount_with_taxes?: string;
+    fees_amount_cents?: number;
+    fees_amount_float?: number;
+    formatted_fees_amount?: string;
+    duty_amount_cents?: number;
+    duty_amount_float?: number;
+    formatted_duty_amount?: string;
+    skus_count?: number;
+    line_item_options_count?: number;
+    shipments_count?: number;
+    tax_calculations_count?: number;
+    payment_source_details?: object;
+    token?: string;
+    cart_url?: string;
+    return_url?: string;
+    terms_url?: string;
+    privacy_url?: string;
+    checkout_url?: string;
+    placed_at?: string;
+    approved_at?: string;
+    cancelled_at?: string;
+    payment_updated_at?: string;
+    fulfillment_updated_at?: string;
+    refreshed_at?: string;
+    archived_at?: string;
+    expires_at?: string;
+    market?: Market;
+    customer?: Customer;
+    shipping_address?: Address;
+    billing_address?: Address;
+    available_payment_methods?: PaymentMethod[];
+    available_customer_payment_sources?: CustomerPaymentSource[];
+    available_free_skus?: Sku[];
+    available_free_bundles?: Bundle[];
+    payment_method?: PaymentMethod;
+    payment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer;
+    line_items?: LineItem[];
+    shipments?: Shipment[];
+    transactions?: Array<Authorization | Void | Capture | Refund>;
+    authorizations?: Authorization[];
+    captures?: Capture[];
+    voids?: Void[];
+    refunds?: Refund[];
+    returns?: Return[];
+    order_subscriptions?: OrderSubscription[];
+    order_copies?: OrderCopy[];
+    attachments?: Attachment[];
+    events?: Event[];
+}
+interface OrderCreate extends ResourceCreate {
+    autorefresh?: boolean;
+    guest?: boolean;
+    customer_email?: string;
+    customer_password?: string;
+    language_code?: string;
+    shipping_country_code_lock?: string;
+    coupon_code?: string;
+    gift_card_code?: string;
+    gift_card_or_coupon_code?: string;
+    cart_url?: string;
+    return_url?: string;
+    terms_url?: string;
+    privacy_url?: string;
+    market?: MarketRel;
+    customer?: CustomerRel;
+    shipping_address?: AddressRel;
+    billing_address?: AddressRel;
+    payment_method?: PaymentMethodRel;
+    payment_source?: AdyenPaymentRel | AxervePaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | SatispayPaymentRel | StripePaymentRel | WireTransferRel;
+}
+interface OrderUpdate extends ResourceUpdate {
+    autorefresh?: boolean;
+    guest?: boolean;
+    customer_email?: string;
+    customer_password?: string;
+    language_code?: string;
+    shipping_country_code_lock?: string;
+    coupon_code?: string;
+    gift_card_code?: string;
+    gift_card_or_coupon_code?: string;
+    cart_url?: string;
+    return_url?: string;
+    terms_url?: string;
+    privacy_url?: string;
+    _archive?: boolean;
+    _unarchive?: boolean;
+    _place?: boolean;
+    _cancel?: boolean;
+    _approve?: boolean;
+    _approve_and_capture?: boolean;
+    _authorize?: boolean;
+    _authorization_amount_cents?: number;
+    _capture?: boolean;
+    _refund?: boolean;
+    _update_taxes?: boolean;
+    _nullify_payment_source?: boolean;
+    _billing_address_clone_id?: string;
+    _shipping_address_clone_id?: string;
+    _customer_payment_source_id?: string;
+    _shipping_address_same_as_billing?: boolean;
+    _billing_address_same_as_shipping?: boolean;
+    _commit_invoice?: boolean;
+    _refund_invoice?: boolean;
+    _save_payment_source_to_customer_wallet?: boolean;
+    _save_shipping_address_to_customer_address_book?: boolean;
+    _save_billing_address_to_customer_address_book?: boolean;
+    _refresh?: boolean;
+    _validate?: boolean;
+    market?: MarketRel;
+    customer?: CustomerRel;
+    shipping_address?: AddressRel;
+    billing_address?: AddressRel;
+    payment_method?: PaymentMethodRel;
+    payment_source?: AdyenPaymentRel | AxervePaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | KlarnaPaymentRel | PaypalPaymentRel | SatispayPaymentRel | StripePaymentRel | WireTransferRel;
+}
+declare class Orders extends ApiResource<Order> {
+    static readonly TYPE: OrderType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Order>>;
+    create(resource: OrderCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    update(resource: OrderUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    market(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
+    customer(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
+    shipping_address(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    billing_address(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Address>;
+    available_payment_methods(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
+    available_customer_payment_sources(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CustomerPaymentSource>>;
+    available_free_skus(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
+    available_free_bundles(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Bundle>>;
+    payment_method(orderId: string | Order, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
+    line_items(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<LineItem>>;
+    shipments(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Shipment>>;
+    authorizations(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Authorization>>;
+    captures(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Capture>>;
+    voids(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Void>>;
+    refunds(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Refund>>;
+    returns(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Return>>;
+    order_subscriptions(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderSubscription>>;
+    order_copies(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<OrderCopy>>;
+    attachments(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(orderId: string | Order, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isOrder(resource: any): resource is Order;
+    relationship(id: string | ResourceId | null): OrderRel;
+    type(): OrderType;
+}
+export default Orders;
+export type { Order, OrderCreate, OrderUpdate, OrderType };

package/lib/cjs/resources/orders.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Orders extends resource_1.ApiResource {
+    // static readonly PATH = 'orders'
+    async list(params, options) {
+        return this.resources.list({ type: Orders.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Orders.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Orders.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Orders.TYPE } : id, options);
+    }
+    async market(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'markets' }, `orders/${_orderId}/market`, params, options);
+    }
+    async customer(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'customers' }, `orders/${_orderId}/customer`, params, options);
+    }
+    async shipping_address(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'addresses' }, `orders/${_orderId}/shipping_address`, params, options);
+    }
+    async billing_address(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'addresses' }, `orders/${_orderId}/billing_address`, params, options);
+    }
+    async available_payment_methods(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'payment_methods' }, `orders/${_orderId}/available_payment_methods`, params, options);
+    }
+    async available_customer_payment_sources(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'customer_payment_sources' }, `orders/${_orderId}/available_customer_payment_sources`, params, options);
+    }
+    async available_free_skus(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'skus' }, `orders/${_orderId}/available_free_skus`, params, options);
+    }
+    async available_free_bundles(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'bundles' }, `orders/${_orderId}/available_free_bundles`, params, options);
+    }
+    async payment_method(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'payment_methods' }, `orders/${_orderId}/payment_method`, params, options);
+    }
+    async line_items(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'line_items' }, `orders/${_orderId}/line_items`, params, options);
+    }
+    async shipments(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'shipments' }, `orders/${_orderId}/shipments`, params, options);
+    }
+    async authorizations(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'authorizations' }, `orders/${_orderId}/authorizations`, params, options);
+    }
+    async captures(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'captures' }, `orders/${_orderId}/captures`, params, options);
+    }
+    async voids(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'voids' }, `orders/${_orderId}/voids`, params, options);
+    }
+    async refunds(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'refunds' }, `orders/${_orderId}/refunds`, params, options);
+    }
+    async returns(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'returns' }, `orders/${_orderId}/returns`, params, options);
+    }
+    async order_subscriptions(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'order_subscriptions' }, `orders/${_orderId}/order_subscriptions`, params, options);
+    }
+    async order_copies(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'order_copies' }, `orders/${_orderId}/order_copies`, params, options);
+    }
+    async attachments(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'attachments' }, `orders/${_orderId}/attachments`, params, options);
+    }
+    async events(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'events' }, `orders/${_orderId}/events`, params, options);
+    }
+    isOrder(resource) {
+        return resource.type && (resource.type === Orders.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Orders.TYPE } : { id: id.id, type: Orders.TYPE };
+    }
+    type() {
+        return Orders.TYPE;
+    }
+}
+Orders.TYPE = 'orders';
+exports.default = Orders;

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

@@ -0,0 +1,32 @@
+import { ApiSingleton, Resource, ResourceId, ResourceRel } from '../resource';
+type OrganizationType = 'organization';
+type OrganizationRel = ResourceRel & {
+    type: OrganizationType;
+};
+interface Organization extends Resource {
+    readonly type: OrganizationType;
+    name?: string;
+    slug?: string;
+    domain?: string;
+    support_phone?: string;
+    support_email?: string;
+    logo_url?: string;
+    favicon_url?: string;
+    primary_color?: string;
+    contrast_color?: string;
+    gtm_id?: string;
+    gtm_id_test?: string;
+    discount_disabled?: boolean;
+    account_disabled?: boolean;
+    acceptance_disabled?: boolean;
+    max_concurrent_promotions?: number;
+    max_concurrent_imports?: number;
+}
+declare class Organizations extends ApiSingleton<Organization> {
+    static readonly TYPE: OrganizationType;
+    isOrganization(resource: any): resource is Organization;
+    relationship(id: string | ResourceId | null): OrganizationRel;
+    type(): OrganizationType;
+}
+export default Organizations;
+export type { Organization, OrganizationType };

package/lib/cjs/resources/organization.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Organizations extends resource_1.ApiSingleton {
+    // static readonly PATH = 'organization'
+    isOrganization(resource) {
+        return resource.type && (resource.type === Organizations.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Organizations.TYPE } : { id: id.id, type: Organizations.TYPE };
+    }
+    type() {
+        return Organizations.TYPE;
+    }
+}
+Organizations.TYPE = 'organization';
+exports.default = Organizations;

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

package/lib/cjs/resources/packages.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Packages extends resource_1.ApiResource {
+    // static readonly PATH = 'packages'
+    async list(params, options) {
+        return this.resources.list({ type: Packages.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Packages.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Packages.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Packages.TYPE } : id, options);
+    }
+    async stock_location(packageId, params, options) {
+        const _packageId = packageId.id || packageId;
+        return this.resources.fetch({ type: 'stock_locations' }, `packages/${_packageId}/stock_location`, params, options);
+    }
+    async parcels(packageId, params, options) {
+        const _packageId = packageId.id || packageId;
+        return this.resources.fetch({ type: 'parcels' }, `packages/${_packageId}/parcels`, params, options);
+    }
+    async attachments(packageId, params, options) {
+        const _packageId = packageId.id || packageId;
+        return this.resources.fetch({ type: 'attachments' }, `packages/${_packageId}/attachments`, params, options);
+    }
+    isPackage(resource) {
+        return resource.type && (resource.type === Packages.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Packages.TYPE } : { id: id.id, type: Packages.TYPE };
+    }
+    type() {
+        return Packages.TYPE;
+    }
+}
+Packages.TYPE = 'packages';
+exports.default = Packages;

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

@@ -0,0 +1,52 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Parcel, ParcelType } from './parcels';
+import type { StockLineItem, StockLineItemType } from './stock_line_items';
+type ParcelLineItemType = 'parcel_line_items';
+type ParcelLineItemRel = ResourceRel & {
+    type: ParcelLineItemType;
+};
+type ParcelRel = ResourceRel & {
+    type: ParcelType;
+};
+type StockLineItemRel = ResourceRel & {
+    type: StockLineItemType;
+};
+interface ParcelLineItem extends Resource {
+    readonly type: ParcelLineItemType;
+    sku_code?: string;
+    quantity?: number;
+    name?: string;
+    image_url?: string;
+    parcel?: Parcel;
+    stock_line_item?: StockLineItem;
+    /**
+    * @deprecated This field should not be used as it may be removed in the future without notice
+    */
+    shipment_line_item?: object;
+}
+interface ParcelLineItemCreate extends ResourceCreate {
+    sku_code?: string;
+    quantity: number;
+    parcel: ParcelRel;
+    stock_line_item: StockLineItemRel;
+    /**
+    * @deprecated This field should not be used as it may be removed in the future without notice
+    */
+    shipment_line_item?: object;
+}
+type ParcelLineItemUpdate = ResourceUpdate;
+declare class ParcelLineItems extends ApiResource<ParcelLineItem> {
+    static readonly TYPE: ParcelLineItemType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ParcelLineItem>>;
+    create(resource: ParcelLineItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
+    update(resource: ParcelLineItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    parcel(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
+    stock_line_item(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<StockLineItem>;
+    isParcelLineItem(resource: any): resource is ParcelLineItem;
+    relationship(id: string | ResourceId | null): ParcelLineItemRel;
+    type(): ParcelLineItemType;
+}
+export default ParcelLineItems;
+export type { ParcelLineItem, ParcelLineItemCreate, ParcelLineItemUpdate, ParcelLineItemType };