@commercelayer/sdk 2.3.1 → 2.3.3-beta.2

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

@@ -0,0 +1,255 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ListResponse } from '../resource';
+import { /* QueryBuilderRetrieve, QueryBuilderList, */ QueryParamsList, QueryParamsRetrieve } from '../query';
+import { Market } from './markets';
+import { Customer } from './customers';
+import { Address } from './addresses';
+import { PaymentMethod } from './payment_methods';
+import { CustomerPaymentSource } from './customer_payment_sources';
+import { AdyenPayment } from './adyen_payments';
+import { BraintreePayment } from './braintree_payments';
+import { CheckoutComPayment } from './checkout_com_payments';
+import { ExternalPayment } from './external_payments';
+import { PaypalPayment } from './paypal_payments';
+import { StripePayment } from './stripe_payments';
+import { WireTransfer } from './wire_transfers';
+import { LineItem } from './line_items';
+import { Shipment } from './shipments';
+import { Authorization } from './authorizations';
+import { Void } from './voids';
+import { Capture } from './captures';
+import { Refund } from './refunds';
+import { OrderSubscription } from './order_subscriptions';
+import { OrderCopy } from './order_copies';
+import { Attachment } from './attachments';
+declare type OrderRel = ResourceId & {
+    type: typeof Orders.TYPE;
+};
+declare type MarketRel = ResourceId & {
+    type: 'markets';
+};
+declare type CustomerRel = ResourceId & {
+    type: 'customers';
+};
+declare type AddressRel = ResourceId & {
+    type: 'addresses';
+};
+declare type PaymentMethodRel = ResourceId & {
+    type: 'payment_methods';
+};
+declare type AdyenPaymentRel = ResourceId & {
+    type: 'adyen_payments';
+};
+declare type BraintreePaymentRel = ResourceId & {
+    type: 'braintree_payments';
+};
+declare type CheckoutComPaymentRel = ResourceId & {
+    type: 'checkout_com_payments';
+};
+declare type ExternalPaymentRel = ResourceId & {
+    type: 'external_payments';
+};
+declare type PaypalPaymentRel = ResourceId & {
+    type: 'paypal_payments';
+};
+declare type StripePaymentRel = ResourceId & {
+    type: 'stripe_payments';
+};
+declare type WireTransferRel = ResourceId & {
+    type: 'wire_transfers';
+};
+interface Order extends Resource {
+    number?: number;
+    autorefresh?: boolean;
+    status?: string;
+    payment_status?: string;
+    fulfillment_status?: string;
+    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;
+    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[];
+    payment_method?: PaymentMethod;
+    payment_source?: AdyenPayment | BraintreePayment | CheckoutComPayment | ExternalPayment | PaypalPayment | StripePayment | WireTransfer;
+    line_items?: LineItem[];
+    shipments?: Shipment[];
+    transactions?: (Authorization | Void | Capture | Refund)[];
+    authorizations?: Authorization[];
+    captures?: Capture[];
+    voids?: Void[];
+    refunds?: Refund[];
+    order_subscriptions?: OrderSubscription[];
+    order_copies?: OrderCopy[];
+    attachments?: Attachment[];
+}
+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 | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | PaypalPaymentRel | 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;
+    _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;
+    _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;
+    market?: MarketRel;
+    customer?: CustomerRel;
+    shipping_address?: AddressRel;
+    billing_address?: AddressRel;
+    payment_method?: PaymentMethodRel;
+    payment_source?: AdyenPaymentRel | BraintreePaymentRel | CheckoutComPaymentRel | ExternalPaymentRel | PaypalPaymentRel | StripePaymentRel | WireTransferRel;
+}
+declare class Orders extends ApiResource {
+    static readonly TYPE: 'orders';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Order>>;
+    create(resource: OrderCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    update(resource: OrderUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    isOrder(resource: any): resource is Order;
+    relationship(id: string | ResourceId): OrderRel;
+    type(): string;
+}
+export default Orders;
+export { Order, OrderCreate, OrderUpdate };

package/lib/esm/resources/orders.js

@@ -0,0 +1,45 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource } from '../resource';
+class Orders extends 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 retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Orders.TYPE, id }, 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({ type: Orders.TYPE, id }, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isOrder(resource) {
+        return resource.type && (resource.type === Orders.TYPE);
+    }
+    /*
+    filter(): QueryBuilderRetrieve {
+        return new QueryBuilderRetrieve(Orders.TYPE)
+    }
+    */
+    /*
+    filterList(): QueryBuilderList {
+        return new QueryBuilderList(Orders.TYPE)
+    }
+    */
+    relationship(id) {
+        return (typeof id === 'string') ? { id, type: Orders.TYPE } : { id: id.id, type: Orders.TYPE };
+    }
+    type() {
+        return Orders.TYPE;
+    }
+}
+Orders.TYPE = 'orders';
+export default Orders;

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

@@ -0,0 +1,34 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource, Resource, ResourcesConfig, ResourceId } from '../resource';
+import { /* QueryBuilderRetrieve, QueryBuilderList, */ QueryParamsRetrieve } from '../query';
+declare type OrganizationRel = ResourceId & {
+    type: typeof Organizations.TYPE;
+};
+interface Organization extends Resource {
+    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;
+}
+declare class Organizations extends ApiResource {
+    static readonly TYPE: 'organization';
+    retrieve(params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Organization>;
+    isOrganization(resource: any): resource is Organization;
+    relationship(id: string | ResourceId): OrganizationRel;
+    type(): string;
+}
+export default Organizations;
+export { Organization };

package/lib/esm/resources/organization.js

@@ -0,0 +1,33 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource } from '../resource';
+class Organizations extends ApiResource {
+    // static readonly PATH = 'organization'
+    async retrieve(params, options) {
+        return this.resources.singleton({ type: Organizations.TYPE }, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isOrganization(resource) {
+        return resource.type && (resource.type === Organizations.TYPE);
+    }
+    /*
+    filter(): QueryBuilderRetrieve {
+        return new QueryBuilderRetrieve(Organizations.TYPE)
+    }
+    */
+    /*
+    filterList(): QueryBuilderList {
+        return new QueryBuilderList(Organizations.TYPE)
+    }
+    */
+    relationship(id) {
+        return (typeof id === 'string') ? { id, type: Organizations.TYPE } : { id: id.id, type: Organizations.TYPE };
+    }
+    type() {
+        return Organizations.TYPE;
+    }
+}
+Organizations.TYPE = 'organization';
+export default Organizations;

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

@@ -0,0 +1,57 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ListResponse } from '../resource';
+import { /* QueryBuilderRetrieve, QueryBuilderList, */ QueryParamsList, QueryParamsRetrieve } from '../query';
+import { StockLocation } from './stock_locations';
+import { Parcel } from './parcels';
+import { Attachment } from './attachments';
+declare type PackageRel = ResourceId & {
+    type: typeof Packages.TYPE;
+};
+declare type StockLocationRel = ResourceId & {
+    type: 'stock_locations';
+};
+interface Package extends Resource {
+    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 {
+    static readonly TYPE: 'packages';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Package>>;
+    create(resource: PackageCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
+    update(resource: PackageUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Package>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    isPackage(resource: any): resource is Package;
+    relationship(id: string | ResourceId): PackageRel;
+    type(): string;
+}
+export default Packages;
+export { Package, PackageCreate, PackageUpdate };

package/lib/esm/resources/packages.js

@@ -0,0 +1,45 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource } from '../resource';
+class Packages extends 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 retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Packages.TYPE, id }, 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({ type: Packages.TYPE, id }, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isPackage(resource) {
+        return resource.type && (resource.type === Packages.TYPE);
+    }
+    /*
+    filter(): QueryBuilderRetrieve {
+        return new QueryBuilderRetrieve(Packages.TYPE)
+    }
+    */
+    /*
+    filterList(): QueryBuilderList {
+        return new QueryBuilderList(Packages.TYPE)
+    }
+    */
+    relationship(id) {
+        return (typeof id === 'string') ? { id, type: Packages.TYPE } : { id: id.id, type: Packages.TYPE };
+    }
+    type() {
+        return Packages.TYPE;
+    }
+}
+Packages.TYPE = 'packages';
+export default Packages;

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

@@ -0,0 +1,51 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ListResponse } from '../resource';
+import { /* QueryBuilderRetrieve, QueryBuilderList, */ QueryParamsList, QueryParamsRetrieve } from '../query';
+import { Parcel } from './parcels';
+import { StockLineItem } from './stock_line_items';
+declare type ParcelLineItemRel = ResourceId & {
+    type: typeof ParcelLineItems.TYPE;
+};
+declare type ParcelRel = ResourceId & {
+    type: 'parcels';
+};
+declare type StockLineItemRel = ResourceId & {
+    type: 'stock_line_items';
+};
+interface ParcelLineItem extends Resource {
+    sku_code?: string;
+    quantity?: number;
+    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;
+}
+declare type ParcelLineItemUpdate = ResourceUpdate;
+declare class ParcelLineItems extends ApiResource {
+    static readonly TYPE: 'parcel_line_items';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ParcelLineItem>>;
+    create(resource: ParcelLineItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
+    update(resource: ParcelLineItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ParcelLineItem>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    isParcelLineItem(resource: any): resource is ParcelLineItem;
+    relationship(id: string | ResourceId): ParcelLineItemRel;
+    type(): string;
+}
+export default ParcelLineItems;
+export { ParcelLineItem, ParcelLineItemCreate, ParcelLineItemUpdate };

package/lib/esm/resources/parcel_line_items.js

@@ -0,0 +1,45 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource } from '../resource';
+class ParcelLineItems extends ApiResource {
+    // static readonly PATH = 'parcel_line_items'
+    async list(params, options) {
+        return this.resources.list({ type: ParcelLineItems.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ParcelLineItems.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: ParcelLineItems.TYPE, id }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ParcelLineItems.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete({ type: ParcelLineItems.TYPE, id }, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isParcelLineItem(resource) {
+        return resource.type && (resource.type === ParcelLineItems.TYPE);
+    }
+    /*
+    filter(): QueryBuilderRetrieve {
+        return new QueryBuilderRetrieve(ParcelLineItems.TYPE)
+    }
+    */
+    /*
+    filterList(): QueryBuilderList {
+        return new QueryBuilderList(ParcelLineItems.TYPE)
+    }
+    */
+    relationship(id) {
+        return (typeof id === 'string') ? { id, type: ParcelLineItems.TYPE } : { id: id.id, type: ParcelLineItems.TYPE };
+    }
+    type() {
+        return ParcelLineItems.TYPE;
+    }
+}
+ParcelLineItems.TYPE = 'parcel_line_items';
+export default ParcelLineItems;

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

@@ -0,0 +1,108 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ListResponse } from '../resource';
+import { /* QueryBuilderRetrieve, QueryBuilderList, */ QueryParamsList, QueryParamsRetrieve } from '../query';
+import { Shipment } from './shipments';
+import { Package } from './packages';
+import { ParcelLineItem } from './parcel_line_items';
+import { Attachment } from './attachments';
+declare type ParcelRel = ResourceId & {
+    type: typeof Parcels.TYPE;
+};
+declare type ShipmentRel = ResourceId & {
+    type: 'shipments';
+};
+declare type PackageRel = ResourceId & {
+    type: 'packages';
+};
+interface Parcel extends Resource {
+    number?: string;
+    weight?: number;
+    unit_of_weight?: string;
+    eel_pfc?: string;
+    contents_type?: string;
+    contents_explanation?: string;
+    customs_certify?: boolean;
+    customs_signer?: string;
+    non_delivery_option?: string;
+    restriction_type?: string;
+    restriction_comments?: string;
+    customs_info_required?: boolean;
+    shipping_label_url?: string;
+    shipping_label_file_type?: string;
+    shipping_label_size?: string;
+    shipping_label_resolution?: string;
+    tracking_number?: string;
+    tracking_status?: string;
+    tracking_status_detail?: string;
+    tracking_status_updated_at?: string;
+    tracking_details?: string;
+    carrier_weight_oz?: string;
+    signed_by?: string;
+    incoterm?: string;
+    shipment?: Shipment;
+    package?: Package;
+    parcel_line_items?: ParcelLineItem[];
+    attachments?: Attachment[];
+}
+interface ParcelCreate extends ResourceCreate {
+    weight?: number;
+    unit_of_weight?: string;
+    eel_pfc?: string;
+    contents_type?: string;
+    contents_explanation?: string;
+    customs_certify?: boolean;
+    customs_signer?: string;
+    non_delivery_option?: string;
+    restriction_type?: string;
+    restriction_comments?: string;
+    customs_info_required?: boolean;
+    tracking_number?: string;
+    tracking_status?: string;
+    tracking_status_detail?: string;
+    tracking_status_updated_at?: string;
+    tracking_details?: string;
+    carrier_weight_oz?: string;
+    signed_by?: string;
+    incoterm?: string;
+    shipment?: ShipmentRel;
+    package?: PackageRel;
+}
+interface ParcelUpdate extends ResourceUpdate {
+    weight?: number;
+    unit_of_weight?: string;
+    eel_pfc?: string;
+    contents_type?: string;
+    contents_explanation?: string;
+    customs_certify?: boolean;
+    customs_signer?: string;
+    non_delivery_option?: string;
+    restriction_type?: string;
+    restriction_comments?: string;
+    customs_info_required?: boolean;
+    tracking_number?: string;
+    tracking_status?: string;
+    tracking_status_detail?: string;
+    tracking_status_updated_at?: string;
+    tracking_details?: string;
+    carrier_weight_oz?: string;
+    signed_by?: string;
+    incoterm?: string;
+    shipment?: ShipmentRel;
+    package?: PackageRel;
+}
+declare class Parcels extends ApiResource {
+    static readonly TYPE: 'parcels';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Parcel>>;
+    create(resource: ParcelCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
+    update(resource: ParcelUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Parcel>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    isParcel(resource: any): resource is Parcel;
+    relationship(id: string | ResourceId): ParcelRel;
+    type(): string;
+}
+export default Parcels;
+export { Parcel, ParcelCreate, ParcelUpdate };