@commercelayer/sdk 2.3.3-beta.1 → 2.3.3-beta.2

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

@@ -0,0 +1,58 @@
+/**
+ * ©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 { PriceList } from './price_lists';
+import { Sku } from './skus';
+import { Attachment } from './attachments';
+declare type PriceRel = ResourceId & {
+    type: typeof Prices.TYPE;
+};
+declare type PriceListRel = ResourceId & {
+    type: 'price_lists';
+};
+declare type SkuRel = ResourceId & {
+    type: 'skus';
+};
+interface Price extends Resource {
+    currency_code?: string;
+    sku_code?: string;
+    amount_cents?: number;
+    amount_float?: number;
+    formatted_amount?: string;
+    compare_at_amount_cents?: number;
+    compare_at_amount_float?: number;
+    formatted_compare_at_amount?: string;
+    price_list?: PriceList;
+    sku?: Sku;
+    attachments?: Attachment[];
+}
+interface PriceCreate extends ResourceCreate {
+    sku_code?: string;
+    amount_cents: number;
+    compare_at_amount_cents: number;
+    price_list?: PriceListRel;
+    sku?: SkuRel;
+}
+interface PriceUpdate extends ResourceUpdate {
+    sku_code?: string;
+    amount_cents?: number;
+    compare_at_amount_cents?: number;
+    price_list?: PriceListRel;
+    sku?: SkuRel;
+}
+declare class Prices extends ApiResource {
+    static readonly TYPE: 'prices';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Price>>;
+    create(resource: PriceCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Price>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Price>;
+    update(resource: PriceUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Price>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    isPrice(resource: any): resource is Price;
+    relationship(id: string | ResourceId): PriceRel;
+    type(): string;
+}
+export default Prices;
+export { Price, PriceCreate, PriceUpdate };

package/lib/esm/resources/prices.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 Prices extends ApiResource {
+    // static readonly PATH = 'prices'
+    async list(params, options) {
+        return this.resources.list({ type: Prices.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Prices.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Prices.TYPE, id }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Prices.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete({ type: Prices.TYPE, id }, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isPrice(resource) {
+        return resource.type && (resource.type === Prices.TYPE);
+    }
+    /*
+    filter(): QueryBuilderRetrieve {
+        return new QueryBuilderRetrieve(Prices.TYPE)
+    }
+    */
+    /*
+    filterList(): QueryBuilderList {
+        return new QueryBuilderList(Prices.TYPE)
+    }
+    */
+    relationship(id) {
+        return (typeof id === 'string') ? { id, type: Prices.TYPE } : { id: id.id, type: Prices.TYPE };
+    }
+    type() {
+        return Prices.TYPE;
+    }
+}
+Prices.TYPE = 'prices';
+export default Prices;

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

@@ -0,0 +1,27 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource, Resource, ResourcesConfig, ResourceId, ListResponse } from '../resource';
+import { /* QueryBuilderRetrieve, QueryBuilderList, */ QueryParamsList } from '../query';
+import { PercentageDiscountPromotion } from './percentage_discount_promotions';
+import { FreeShippingPromotion } from './free_shipping_promotions';
+import { FixedAmountPromotion } from './fixed_amount_promotions';
+import { FreeGiftPromotion } from './free_gift_promotions';
+import { FixedPricePromotion } from './fixed_price_promotions';
+import { ExternalPromotion } from './external_promotions';
+declare type PromotionRuleRel = ResourceId & {
+    type: typeof PromotionRules.TYPE;
+};
+interface PromotionRule extends Resource {
+    promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FixedAmountPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion;
+}
+declare class PromotionRules extends ApiResource {
+    static readonly TYPE: 'promotion_rules';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PromotionRule>>;
+    isPromotionRule(resource: any): resource is PromotionRule;
+    relationship(id: string | ResourceId): PromotionRuleRel;
+    type(): string;
+}
+export default PromotionRules;
+export { PromotionRule };

package/lib/esm/resources/promotion_rules.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 PromotionRules extends ApiResource {
+    // static readonly PATH = 'promotion_rules'
+    async list(params, options) {
+        return this.resources.list({ type: PromotionRules.TYPE }, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isPromotionRule(resource) {
+        return resource.type && (resource.type === PromotionRules.TYPE);
+    }
+    /*
+    filter(): QueryBuilderRetrieve {
+        return new QueryBuilderRetrieve(PromotionRules.TYPE)
+    }
+    */
+    /*
+    filterList(): QueryBuilderList {
+        return new QueryBuilderList(PromotionRules.TYPE)
+    }
+    */
+    relationship(id) {
+        return (typeof id === 'string') ? { id, type: PromotionRules.TYPE } : { id: id.id, type: PromotionRules.TYPE };
+    }
+    type() {
+        return PromotionRules.TYPE;
+    }
+}
+PromotionRules.TYPE = 'promotion_rules';
+export default PromotionRules;

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

@@ -0,0 +1,38 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource, Resource, ResourcesConfig, ResourceId, ListResponse } from '../resource';
+import { /* QueryBuilderRetrieve, QueryBuilderList, */ QueryParamsList } from '../query';
+import { Market } from './markets';
+import { PromotionRule } from './promotion_rules';
+import { OrderAmountPromotionRule } from './order_amount_promotion_rules';
+import { SkuListPromotionRule } from './sku_list_promotion_rules';
+import { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
+import { Attachment } from './attachments';
+declare type PromotionRel = ResourceId & {
+    type: typeof Promotions.TYPE;
+};
+interface Promotion extends Resource {
+    name?: string;
+    starts_at?: string;
+    expires_at?: string;
+    total_usage_limit?: number;
+    total_usage_count?: number;
+    active?: boolean;
+    market?: Market;
+    promotion_rules?: PromotionRule[];
+    order_amount_promotion_rule?: OrderAmountPromotionRule;
+    sku_list_promotion_rule?: SkuListPromotionRule;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRule;
+    attachments?: Attachment[];
+}
+declare class Promotions extends ApiResource {
+    static readonly TYPE: 'promotions';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Promotion>>;
+    isPromotion(resource: any): resource is Promotion;
+    relationship(id: string | ResourceId): PromotionRel;
+    type(): string;
+}
+export default Promotions;
+export { Promotion };

package/lib/esm/resources/promotions.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 Promotions extends ApiResource {
+    // static readonly PATH = 'promotions'
+    async list(params, options) {
+        return this.resources.list({ type: Promotions.TYPE }, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isPromotion(resource) {
+        return resource.type && (resource.type === Promotions.TYPE);
+    }
+    /*
+    filter(): QueryBuilderRetrieve {
+        return new QueryBuilderRetrieve(Promotions.TYPE)
+    }
+    */
+    /*
+    filterList(): QueryBuilderList {
+        return new QueryBuilderList(Promotions.TYPE)
+    }
+    */
+    relationship(id) {
+        return (typeof id === 'string') ? { id, type: Promotions.TYPE } : { id: id.id, type: Promotions.TYPE };
+    }
+    type() {
+        return Promotions.TYPE;
+    }
+}
+Promotions.TYPE = 'promotions';
+export default Promotions;

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

@@ -0,0 +1,36 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource, Resource, ResourcesConfig, ResourceId, ListResponse } from '../resource';
+import { /* QueryBuilderRetrieve, QueryBuilderList, */ QueryParamsList, QueryParamsRetrieve } from '../query';
+import { Order } from './orders';
+import { Capture } from './captures';
+declare type RefundRel = ResourceId & {
+    type: typeof Refunds.TYPE;
+};
+interface Refund extends Resource {
+    number?: string;
+    currency_code?: string;
+    amount_cents?: number;
+    amount_float?: number;
+    formatted_amount?: string;
+    succeeded?: boolean;
+    message?: string;
+    error_code?: string;
+    error_detail?: string;
+    token?: string;
+    gateway_transaction_id?: string;
+    order?: Order;
+    reference_capture?: Capture;
+}
+declare class Refunds extends ApiResource {
+    static readonly TYPE: 'refunds';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Refund>>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Refund>;
+    isRefund(resource: any): resource is Refund;
+    relationship(id: string | ResourceId): RefundRel;
+    type(): string;
+}
+export default Refunds;
+export { Refund };

package/lib/esm/resources/refunds.js

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

package/lib/esm/resources/return_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 { Return } from './returns';
+import { LineItem } from './line_items';
+declare type ReturnLineItemRel = ResourceId & {
+    type: typeof ReturnLineItems.TYPE;
+};
+declare type ReturnRel = ResourceId & {
+    type: 'returns';
+};
+declare type LineItemRel = ResourceId & {
+    type: 'line_items';
+};
+interface ReturnLineItem extends Resource {
+    sku_code?: string;
+    bundle_code?: string;
+    name?: string;
+    quantity?: number;
+    return_reason?: object;
+    restocked_at?: string;
+    return?: Return;
+    line_item?: LineItem;
+}
+interface ReturnLineItemCreate extends ResourceCreate {
+    quantity: number;
+    return_reason?: object;
+    return?: ReturnRel;
+    line_item?: LineItemRel;
+}
+interface ReturnLineItemUpdate extends ResourceUpdate {
+    quantity?: number;
+    _restock?: boolean;
+    return_reason?: object;
+}
+declare class ReturnLineItems extends ApiResource {
+    static readonly TYPE: 'return_line_items';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ReturnLineItem>>;
+    create(resource: ReturnLineItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ReturnLineItem>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ReturnLineItem>;
+    update(resource: ReturnLineItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ReturnLineItem>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    isReturnLineItem(resource: any): resource is ReturnLineItem;
+    relationship(id: string | ResourceId): ReturnLineItemRel;
+    type(): string;
+}
+export default ReturnLineItems;
+export { ReturnLineItem, ReturnLineItemCreate, ReturnLineItemUpdate };

package/lib/esm/resources/return_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 ReturnLineItems extends 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 retrieve(id, params, options) {
+        return this.resources.retrieve({ type: ReturnLineItems.TYPE, id }, 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({ type: ReturnLineItems.TYPE, id }, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isReturnLineItem(resource) {
+        return resource.type && (resource.type === ReturnLineItems.TYPE);
+    }
+    /*
+    filter(): QueryBuilderRetrieve {
+        return new QueryBuilderRetrieve(ReturnLineItems.TYPE)
+    }
+    */
+    /*
+    filterList(): QueryBuilderList {
+        return new QueryBuilderList(ReturnLineItems.TYPE)
+    }
+    */
+    relationship(id) {
+        return (typeof id === 'string') ? { id, type: ReturnLineItems.TYPE } : { id: id.id, type: ReturnLineItems.TYPE };
+    }
+    type() {
+        return ReturnLineItems.TYPE;
+    }
+}
+ReturnLineItems.TYPE = 'return_line_items';
+export default ReturnLineItems;

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

@@ -0,0 +1,69 @@
+/**
+ * ©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 { Order } from './orders';
+import { Customer } from './customers';
+import { StockLocation } from './stock_locations';
+import { Address } from './addresses';
+import { ReturnLineItem } from './return_line_items';
+import { Attachment } from './attachments';
+declare type ReturnRel = ResourceId & {
+    type: typeof Returns.TYPE;
+};
+declare type OrderRel = ResourceId & {
+    type: 'orders';
+};
+declare type StockLocationRel = ResourceId & {
+    type: 'stock_locations';
+};
+interface Return extends Resource {
+    number?: string;
+    status?: string;
+    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[];
+}
+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 {
+    static readonly TYPE: 'returns';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Return>>;
+    create(resource: ReturnCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Return>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Return>;
+    update(resource: ReturnUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Return>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    isReturn(resource: any): resource is Return;
+    relationship(id: string | ResourceId): ReturnRel;
+    type(): string;
+}
+export default Returns;
+export { Return, ReturnCreate, ReturnUpdate };

package/lib/esm/resources/returns.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 Returns extends 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 retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Returns.TYPE, id }, 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({ type: Returns.TYPE, id }, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isReturn(resource) {
+        return resource.type && (resource.type === Returns.TYPE);
+    }
+    /*
+    filter(): QueryBuilderRetrieve {
+        return new QueryBuilderRetrieve(Returns.TYPE)
+    }
+    */
+    /*
+    filterList(): QueryBuilderList {
+        return new QueryBuilderList(Returns.TYPE)
+    }
+    */
+    relationship(id) {
+        return (typeof id === 'string') ? { id, type: Returns.TYPE } : { id: id.id, type: Returns.TYPE };
+    }
+    type() {
+        return Returns.TYPE;
+    }
+}
+Returns.TYPE = 'returns';
+export default Returns;

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

@@ -0,0 +1,80 @@
+/**
+ * ©2021 Commerce Layer Inc.
+ * Source code generated automatically by SDK codegen from OpenAPI schema 2.7.3
+ **/
+import { ApiResource, Resource, ResourceUpdate, ResourcesConfig, ResourceId, ListResponse } from '../resource';
+import { /* QueryBuilderRetrieve, QueryBuilderList, */ QueryParamsList, QueryParamsRetrieve } from '../query';
+import { Order } from './orders';
+import { ShippingCategory } from './shipping_categories';
+import { StockLocation } from './stock_locations';
+import { Address } from './addresses';
+import { ShippingMethod } from './shipping_methods';
+import { DeliveryLeadTime } from './delivery_lead_times';
+import { StockLineItem } from './stock_line_items';
+import { StockTransfer } from './stock_transfers';
+import { CarrierAccount } from './carrier_accounts';
+import { Parcel } from './parcels';
+import { Attachment } from './attachments';
+declare type ShipmentRel = ResourceId & {
+    type: typeof Shipments.TYPE;
+};
+declare type ShippingMethodRel = ResourceId & {
+    type: 'shipping_methods';
+};
+interface Shipment extends Resource {
+    number?: string;
+    status?: string;
+    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_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[];
+}
+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 {
+    static readonly TYPE: 'shipments';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Shipment>>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    update(resource: ShipmentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Shipment>;
+    isShipment(resource: any): resource is Shipment;
+    relationship(id: string | ResourceId): ShipmentRel;
+    type(): string;
+}
+export default Shipments;
+export { Shipment, ShipmentUpdate };

package/lib/esm/resources/shipments.js

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