@commercelayer/sdk 6.0.0-alfa.8 → 6.0.0-beta.1

package/lib/esm/resources/orders.js

@@ -1,237 +0,0 @@
-import { ApiResource } from '../resource';
-class Orders extends ApiResource {
-    static TYPE = 'orders';
-    async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: Orders.TYPE }, params, options);
-    }
-    async update(resource, params, options) {
-        return this.resources.update({ ...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 line_item_options(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'line_item_options' }, `orders/${_orderId}/line_item_options`, params, options);
-    }
-    async stock_reservations(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'stock_reservations' }, `orders/${_orderId}/stock_reservations`, params, options);
-    }
-    async stock_line_items(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'stock_line_items' }, `orders/${_orderId}/stock_line_items`, params, options);
-    }
-    async stock_transfers(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'stock_transfers' }, `orders/${_orderId}/stock_transfers`, params, options);
-    }
-    async shipments(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'shipments' }, `orders/${_orderId}/shipments`, params, options);
-    }
-    async payment_options(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'payment_options' }, `orders/${_orderId}/payment_options`, 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_subscription(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'order_subscriptions' }, `orders/${_orderId}/order_subscription`, params, options);
-    }
-    async order_subscriptions(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'order_subscriptions' }, `orders/${_orderId}/order_subscriptions`, params, options);
-    }
-    async order_factories(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'order_factories' }, `orders/${_orderId}/order_factories`, 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 recurring_order_copies(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'recurring_order_copies' }, `orders/${_orderId}/recurring_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 resource_errors(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'resource_errors' }, `orders/${_orderId}/resource_errors`, params, options);
-    }
-    async events(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'events' }, `orders/${_orderId}/events`, params, options);
-    }
-    async tags(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'tags' }, `orders/${_orderId}/tags`, params, options);
-    }
-    async versions(orderId, params, options) {
-        const _orderId = orderId.id || orderId;
-        return this.resources.fetch({ type: 'versions' }, `orders/${_orderId}/versions`, params, options);
-    }
-    async _archive(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _archive: true }, params, options);
-    }
-    async _unarchive(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _unarchive: true }, params, options);
-    }
-    async _pending(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _pending: true }, params, options);
-    }
-    async _place(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _place: true }, params, options);
-    }
-    async _cancel(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _cancel: true }, params, options);
-    }
-    async _approve(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _approve: true }, params, options);
-    }
-    async _approve_and_capture(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _approve_and_capture: true }, params, options);
-    }
-    async _authorize(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _authorize: true }, params, options);
-    }
-    async _authorization_amount_cents(id, triggerValue, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _authorization_amount_cents: triggerValue }, params, options);
-    }
-    async _capture(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _capture: true }, params, options);
-    }
-    async _refund(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _refund: true }, params, options);
-    }
-    async _update_taxes(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _update_taxes: true }, params, options);
-    }
-    async _nullify_payment_source(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _nullify_payment_source: true }, params, options);
-    }
-    async _billing_address_clone_id(id, triggerValue, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _billing_address_clone_id: triggerValue }, params, options);
-    }
-    async _shipping_address_clone_id(id, triggerValue, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _shipping_address_clone_id: triggerValue }, params, options);
-    }
-    async _customer_payment_source_id(id, triggerValue, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _customer_payment_source_id: triggerValue }, params, options);
-    }
-    async _shipping_address_same_as_billing(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _shipping_address_same_as_billing: true }, params, options);
-    }
-    async _billing_address_same_as_shipping(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _billing_address_same_as_shipping: true }, params, options);
-    }
-    async _commit_invoice(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _commit_invoice: true }, params, options);
-    }
-    async _refund_invoice(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _refund_invoice: true }, params, options);
-    }
-    async _save_payment_source_to_customer_wallet(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _save_payment_source_to_customer_wallet: true }, params, options);
-    }
-    async _save_shipping_address_to_customer_address_book(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _save_shipping_address_to_customer_address_book: true }, params, options);
-    }
-    async _save_billing_address_to_customer_address_book(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _save_billing_address_to_customer_address_book: true }, params, options);
-    }
-    async _refresh(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _refresh: true }, params, options);
-    }
-    async _validate(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _validate: true }, params, options);
-    }
-    async _create_subscriptions(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _create_subscriptions: true }, params, options);
-    }
-    async _start_editing(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _start_editing: true }, params, options);
-    }
-    async _stop_editing(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _stop_editing: true }, params, options);
-    }
-    async _reset_circuit(id, params, options) {
-        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: Orders.TYPE, _reset_circuit: true }, params, options);
-    }
-    isOrder(resource) {
-        return resource.type && (resource.type === Orders.TYPE);
-    }
-    relationship(id) {
-        return super.relationshipOneToOne(id);
-    }
-    relationshipToMany(...ids) {
-        return super.relationshipOneToMany(...ids);
-    }
-    type() {
-        return Orders.TYPE;
-    }
-}
-export default Orders;

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

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

package/lib/esm/resources/organization.js

@@ -1,17 +0,0 @@
-import { ApiSingleton } from '../resource';
-class Organizations extends ApiSingleton {
-    static TYPE = 'organization';
-    isOrganization(resource) {
-        return resource.type && (resource.type === Organizations.TYPE);
-    }
-    relationship(id) {
-        return super.relationshipOneToOne(id);
-    }
-    relationshipToMany(...ids) {
-        return super.relationshipOneToMany(...ids);
-    }
-    type() {
-        return Organizations.TYPE;
-    }
-}
-export default Organizations;

package/lib/esm/resources/packages.d.ts

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

package/lib/esm/resources/packages.js

@@ -1,42 +0,0 @@
-import { ApiResource } from '../resource';
-class Packages extends ApiResource {
-    static TYPE = 'packages';
-    async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: Packages.TYPE }, params, options);
-    }
-    async update(resource, params, options) {
-        return this.resources.update({ ...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);
-    }
-    async versions(packageId, params, options) {
-        const _packageId = packageId.id || packageId;
-        return this.resources.fetch({ type: 'versions' }, `packages/${_packageId}/versions`, params, options);
-    }
-    isPackage(resource) {
-        return resource.type && (resource.type === Packages.TYPE);
-    }
-    relationship(id) {
-        return super.relationshipOneToOne(id);
-    }
-    relationshipToMany(...ids) {
-        return super.relationshipOneToMany(...ids);
-    }
-    type() {
-        return Packages.TYPE;
-    }
-}
-export default Packages;

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

@@ -1,48 +0,0 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
-import type { Parcel, ParcelType } from './parcels';
-import type { StockLineItem, StockLineItemType } from './stock_line_items';
-import type { Version } from './versions';
-type ParcelLineItemType = 'parcel_line_items';
-type ParcelLineItemRel = ResourceRel & {
-    type: ParcelLineItemType;
-};
-type ParcelRel = ResourceRel & {
-    type: ParcelType;
-};
-type StockLineItemRel = ResourceRel & {
-    type: StockLineItemType;
-};
-interface ParcelLineItem extends Resource {
-    readonly type: ParcelLineItemType;
-    sku_code?: string | null;
-    bundle_code?: string | null;
-    quantity: number;
-    name: string;
-    image_url?: string | null;
-    parcel?: Parcel | null;
-    stock_line_item?: StockLineItem | null;
-    versions?: Version[] | null;
-}
-interface ParcelLineItemCreate extends ResourceCreate {
-    quantity: number;
-    parcel: ParcelRel;
-    stock_line_item: StockLineItemRel;
-}
-type ParcelLineItemUpdate = ResourceUpdate;
-declare class ParcelLineItems extends ApiResource<ParcelLineItem> {
-    static readonly TYPE: ParcelLineItemType;
-    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>;
-    versions(parcelLineItemId: string | ParcelLineItem, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
-    isParcelLineItem(resource: any): resource is ParcelLineItem;
-    relationship(id: string | ResourceId | null): ParcelLineItemRel;
-    relationshipToMany(...ids: string[]): ParcelLineItemRel[];
-    type(): ParcelLineItemType;
-}
-export default ParcelLineItems;
-export type { ParcelLineItem, ParcelLineItemCreate, ParcelLineItemUpdate, ParcelLineItemType };

package/lib/esm/resources/parcel_line_items.js

@@ -1,38 +0,0 @@
-import { ApiResource } from '../resource';
-class ParcelLineItems extends ApiResource {
-    static TYPE = 'parcel_line_items';
-    async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: ParcelLineItems.TYPE }, params, options);
-    }
-    async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: ParcelLineItems.TYPE }, params, options);
-    }
-    async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: ParcelLineItems.TYPE } : id, options);
-    }
-    async parcel(parcelLineItemId, params, options) {
-        const _parcelLineItemId = parcelLineItemId.id || parcelLineItemId;
-        return this.resources.fetch({ type: 'parcels' }, `parcel_line_items/${_parcelLineItemId}/parcel`, params, options);
-    }
-    async stock_line_item(parcelLineItemId, params, options) {
-        const _parcelLineItemId = parcelLineItemId.id || parcelLineItemId;
-        return this.resources.fetch({ type: 'stock_line_items' }, `parcel_line_items/${_parcelLineItemId}/stock_line_item`, params, options);
-    }
-    async versions(parcelLineItemId, params, options) {
-        const _parcelLineItemId = parcelLineItemId.id || parcelLineItemId;
-        return this.resources.fetch({ type: 'versions' }, `parcel_line_items/${_parcelLineItemId}/versions`, params, options);
-    }
-    isParcelLineItem(resource) {
-        return resource.type && (resource.type === ParcelLineItems.TYPE);
-    }
-    relationship(id) {
-        return super.relationshipOneToOne(id);
-    }
-    relationshipToMany(...ids) {
-        return super.relationshipOneToMany(...ids);
-    }
-    type() {
-        return ParcelLineItems.TYPE;
-    }
-}
-export default ParcelLineItems;

package/lib/esm/resources/parcels.d.ts

@@ -1,127 +0,0 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
-import type { Shipment, ShipmentType } from './shipments';
-import type { Package, PackageType } from './packages';
-import type { ParcelLineItem } from './parcel_line_items';
-import type { Attachment } from './attachments';
-import type { Event } from './events';
-import type { Version } from './versions';
-type ParcelType = 'parcels';
-type ParcelRel = ResourceRel & {
-    type: ParcelType;
-};
-type ShipmentRel = ResourceRel & {
-    type: ShipmentType;
-};
-type PackageRel = ResourceRel & {
-    type: PackageType;
-};
-interface Parcel extends Resource {
-    readonly type: ParcelType;
-    number?: string | null;
-    weight: number;
-    unit_of_weight: string;
-    eel_pfc?: string | null;
-    contents_type?: string | null;
-    contents_explanation?: string | null;
-    customs_certify?: boolean | null;
-    customs_signer?: string | null;
-    non_delivery_option?: string | null;
-    restriction_type?: string | null;
-    restriction_comments?: string | null;
-    customs_info_required?: boolean | null;
-    shipping_label_url?: string | null;
-    shipping_label_file_type?: string | null;
-    shipping_label_size?: string | null;
-    shipping_label_resolution?: string | null;
-    tracking_number?: string | null;
-    tracking_status?: string | null;
-    tracking_status_detail?: string | null;
-    tracking_status_updated_at?: string | null;
-    tracking_details?: Record<string, any> | null;
-    carrier_weight_oz?: string | null;
-    signed_by?: string | null;
-    incoterm?: string | null;
-    delivery_confirmation?: string | null;
-    shipment?: Shipment | null;
-    package?: Package | null;
-    parcel_line_items?: ParcelLineItem[] | null;
-    attachments?: Attachment[] | null;
-    events?: Event[] | null;
-    versions?: Version[] | null;
-}
-interface ParcelCreate extends ResourceCreate {
-    weight: number;
-    unit_of_weight: string;
-    eel_pfc?: string | null;
-    contents_type?: string | null;
-    contents_explanation?: string | null;
-    customs_certify?: boolean | null;
-    customs_signer?: string | null;
-    non_delivery_option?: string | null;
-    restriction_type?: string | null;
-    restriction_comments?: string | null;
-    customs_info_required?: boolean | null;
-    shipping_label_url?: string | null;
-    shipping_label_file_type?: string | null;
-    shipping_label_size?: string | null;
-    shipping_label_resolution?: string | null;
-    tracking_number?: string | null;
-    tracking_status?: string | null;
-    tracking_status_detail?: string | null;
-    tracking_status_updated_at?: string | null;
-    tracking_details?: Record<string, any> | null;
-    carrier_weight_oz?: string | null;
-    signed_by?: string | null;
-    incoterm?: string | null;
-    delivery_confirmation?: string | null;
-    shipment: ShipmentRel;
-    package: PackageRel;
-}
-interface ParcelUpdate extends ResourceUpdate {
-    weight?: number | null;
-    unit_of_weight?: string | null;
-    eel_pfc?: string | null;
-    contents_type?: string | null;
-    contents_explanation?: string | null;
-    customs_certify?: boolean | null;
-    customs_signer?: string | null;
-    non_delivery_option?: string | null;
-    restriction_type?: string | null;
-    restriction_comments?: string | null;
-    customs_info_required?: boolean | null;
-    shipping_label_url?: string | null;
-    shipping_label_file_type?: string | null;
-    shipping_label_size?: string | null;
-    shipping_label_resolution?: string | null;
-    tracking_number?: string | null;
-    tracking_status?: string | null;
-    tracking_status_detail?: string | null;
-    tracking_status_updated_at?: string | null;
-    tracking_details?: Record<string, any> | null;
-    carrier_weight_oz?: string | null;
-    signed_by?: string | null;
-    incoterm?: string | null;
-    delivery_confirmation?: string | null;
-    shipment?: ShipmentRel | null;
-    package?: PackageRel | null;
-}
-declare class Parcels extends ApiResource<Parcel> {
-    static readonly TYPE: ParcelType;
-    create(resource: ParcelCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
-    update(resource: ParcelUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
-    shipment(parcelId: string | Parcel, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
-    package(parcelId: string | Parcel, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
-    parcel_line_items(parcelId: string | Parcel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ParcelLineItem>>;
-    attachments(parcelId: string | Parcel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
-    events(parcelId: string | Parcel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
-    versions(parcelId: string | Parcel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
-    isParcel(resource: any): resource is Parcel;
-    relationship(id: string | ResourceId | null): ParcelRel;
-    relationshipToMany(...ids: string[]): ParcelRel[];
-    type(): ParcelType;
-}
-export default Parcels;
-export type { Parcel, ParcelCreate, ParcelUpdate, ParcelType };

package/lib/esm/resources/parcels.js

@@ -1,50 +0,0 @@
-import { ApiResource } from '../resource';
-class Parcels extends ApiResource {
-    static TYPE = 'parcels';
-    async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: Parcels.TYPE }, params, options);
-    }
-    async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: Parcels.TYPE }, params, options);
-    }
-    async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: Parcels.TYPE } : id, options);
-    }
-    async shipment(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'shipments' }, `parcels/${_parcelId}/shipment`, params, options);
-    }
-    async package(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'packages' }, `parcels/${_parcelId}/package`, params, options);
-    }
-    async parcel_line_items(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'parcel_line_items' }, `parcels/${_parcelId}/parcel_line_items`, params, options);
-    }
-    async attachments(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'attachments' }, `parcels/${_parcelId}/attachments`, params, options);
-    }
-    async events(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'events' }, `parcels/${_parcelId}/events`, params, options);
-    }
-    async versions(parcelId, params, options) {
-        const _parcelId = parcelId.id || parcelId;
-        return this.resources.fetch({ type: 'versions' }, `parcels/${_parcelId}/versions`, params, options);
-    }
-    isParcel(resource) {
-        return resource.type && (resource.type === Parcels.TYPE);
-    }
-    relationship(id) {
-        return super.relationshipOneToOne(id);
-    }
-    relationshipToMany(...ids) {
-        return super.relationshipOneToMany(...ids);
-    }
-    type() {
-        return Parcels.TYPE;
-    }
-}
-export default Parcels;