@commercelayer/sdk 5.0.0-beta.2 → 5.0.0-beta.21

package/lib/cjs/resources/promotions.js

@@ -2,10 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Promotions extends resource_1.ApiResource {
-    // static readonly PATH = 'promotions'
-    async list(params, options) {
-        return this.resources.list({ type: Promotions.TYPE }, params, options);
-    }
     async market(promotionId, params, options) {
         const _promotionId = promotionId.id || promotionId;
         return this.resources.fetch({ type: 'markets' }, `promotions/${_promotionId}/market`, params, options);
@@ -26,6 +22,10 @@ class Promotions extends resource_1.ApiResource {
         const _promotionId = promotionId.id || promotionId;
         return this.resources.fetch({ type: 'attachments' }, `promotions/${_promotionId}/attachments`, params, options);
     }
+    async events(promotionId, params, options) {
+        const _promotionId = promotionId.id || promotionId;
+        return this.resources.fetch({ type: 'events' }, `promotions/${_promotionId}/events`, params, options);
+    }
     isPromotion(resource) {
         return resource.type && (resource.type === Promotions.TYPE);
     }

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

@@ -0,0 +1,53 @@
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order, OrderType } from './orders';
+import type { Event } from './events';
+import type { OrderSubscription, OrderSubscriptionType } from './order_subscriptions';
+type RecurringOrderCopyType = 'recurring_order_copies';
+type RecurringOrderCopyRel = ResourceRel & {
+    type: RecurringOrderCopyType;
+};
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+type OrderSubscriptionRel = ResourceRel & {
+    type: OrderSubscriptionType;
+};
+interface RecurringOrderCopy extends Resource {
+    readonly type: RecurringOrderCopyType;
+    status: 'pending' | 'in_progress' | 'failed' | 'completed';
+    started_at?: string | null;
+    completed_at?: string | null;
+    failed_at?: string | null;
+    errors_log?: object | null;
+    errors_count?: number | null;
+    place_target_order?: boolean | null;
+    reuse_wallet?: boolean | null;
+    source_order?: Order | null;
+    target_order?: Order | null;
+    events?: Event[] | null;
+    order_subscription?: OrderSubscription | null;
+}
+interface RecurringOrderCopyCreate extends ResourceCreate {
+    place_target_order?: boolean | null;
+    reuse_wallet?: boolean | null;
+    source_order: OrderRel;
+    order_subscription: OrderSubscriptionRel;
+}
+type RecurringOrderCopyUpdate = ResourceUpdate;
+declare class RecurringOrderCopies extends ApiResource<RecurringOrderCopy> {
+    static readonly TYPE: RecurringOrderCopyType;
+    create(resource: RecurringOrderCopyCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<RecurringOrderCopy>;
+    update(resource: RecurringOrderCopyUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<RecurringOrderCopy>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    source_order(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    target_order(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    events(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    order_subscription(recurringOrderCopyId: string | RecurringOrderCopy, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderSubscription>;
+    isRecurringOrderCopy(resource: any): resource is RecurringOrderCopy;
+    relationship(id: string | ResourceId | null): RecurringOrderCopyRel;
+    type(): RecurringOrderCopyType;
+}
+export default RecurringOrderCopies;
+export type { RecurringOrderCopy, RecurringOrderCopyCreate, RecurringOrderCopyUpdate, RecurringOrderCopyType };

package/lib/cjs/resources/recurring_order_copies.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class RecurringOrderCopies extends resource_1.ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: RecurringOrderCopies.TYPE }, params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: RecurringOrderCopies.TYPE } : id, options);
+    }
+    async source_order(recurringOrderCopyId, params, options) {
+        const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
+        return this.resources.fetch({ type: 'orders' }, `recurring_order_copies/${_recurringOrderCopyId}/source_order`, params, options);
+    }
+    async target_order(recurringOrderCopyId, params, options) {
+        const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
+        return this.resources.fetch({ type: 'orders' }, `recurring_order_copies/${_recurringOrderCopyId}/target_order`, params, options);
+    }
+    async events(recurringOrderCopyId, params, options) {
+        const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
+        return this.resources.fetch({ type: 'events' }, `recurring_order_copies/${_recurringOrderCopyId}/events`, params, options);
+    }
+    async order_subscription(recurringOrderCopyId, params, options) {
+        const _recurringOrderCopyId = recurringOrderCopyId.id || recurringOrderCopyId;
+        return this.resources.fetch({ type: 'order_subscriptions' }, `recurring_order_copies/${_recurringOrderCopyId}/order_subscription`, params, options);
+    }
+    isRecurringOrderCopy(resource) {
+        return resource.type && (resource.type === RecurringOrderCopies.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: RecurringOrderCopies.TYPE } : { id: id.id, type: RecurringOrderCopies.TYPE };
+    }
+    type() {
+        return RecurringOrderCopies.TYPE;
+    }
+}
+RecurringOrderCopies.TYPE = 'recurring_order_copies';
+exports.default = RecurringOrderCopies;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
 import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Order } from './orders';
 import type { Capture } from './captures';
@@ -15,18 +16,17 @@ interface Refund extends Resource {
     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;
-    events?: Event[];
+    message?: string | null;
+    error_code?: string | null;
+    error_detail?: string | null;
+    token?: string | null;
+    gateway_transaction_id?: string | null;
+    order?: Order | null;
+    reference_capture?: Capture | null;
+    events?: Event[] | null;
 }
 declare class Refunds extends ApiResource<Refund> {
     static readonly TYPE: RefundType;
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Refund>>;
     order(refundId: string | Refund, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     reference_capture(refundId: string | Refund, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Capture>;
     events(refundId: string | Refund, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;

package/lib/cjs/resources/refunds.js

@@ -2,10 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Refunds extends resource_1.ApiResource {
-    // static readonly PATH = 'refunds'
-    async list(params, options) {
-        return this.resources.list({ type: Refunds.TYPE }, params, options);
-    }
     async order(refundId, params, options) {
         const _refundId = refundId.id || refundId;
         return this.resources.fetch({ type: 'orders' }, `refunds/${_refundId}/order`, params, options);

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

@@ -1,5 +1,6 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import type { QueryParamsRetrieve } from '../query';
 import type { Return, ReturnType } from './returns';
 import type { LineItem, LineItemType } from './line_items';
 type ReturnLineItemType = 'return_line_items';
@@ -14,29 +15,28 @@ type LineItemRel = ResourceRel & {
 };
 interface ReturnLineItem extends Resource {
     readonly type: ReturnLineItemType;
-    sku_code?: string;
-    bundle_code?: string;
-    name?: string;
+    sku_code?: string | null;
+    bundle_code?: string | null;
+    name?: string | null;
     quantity: number;
-    return_reason?: object;
-    restocked_at?: string;
-    return?: Return;
-    line_item?: LineItem;
+    return_reason?: object | null;
+    restocked_at?: string | null;
+    return?: Return | null;
+    line_item?: LineItem | null;
 }
 interface ReturnLineItemCreate extends ResourceCreate {
     quantity: number;
-    return_reason?: object;
+    return_reason?: object | null;
     return: ReturnRel;
     line_item: LineItemRel;
 }
 interface ReturnLineItemUpdate extends ResourceUpdate {
-    quantity: number;
-    _restock?: boolean;
-    return_reason?: object;
+    quantity?: number | null;
+    _restock?: boolean | null;
+    return_reason?: object | null;
 }
 declare class ReturnLineItems extends ApiResource<ReturnLineItem> {
     static readonly TYPE: ReturnLineItemType;
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<ReturnLineItem>>;
     create(resource: ReturnLineItemCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ReturnLineItem>;
     update(resource: ReturnLineItemUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<ReturnLineItem>;
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;

package/lib/cjs/resources/return_line_items.js

@@ -2,15 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class ReturnLineItems extends resource_1.ApiResource {
-    // static readonly PATH = 'return_line_items'
-    async list(params, options) {
-        return this.resources.list({ type: ReturnLineItems.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ReturnLineItems.TYPE }), params, options);
+        return this.resources.create({ ...resource, type: ReturnLineItems.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ReturnLineItems.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: ReturnLineItems.TYPE }, params, options);
     }
     async delete(id, options) {
         await this.resources.delete((typeof id === 'string') ? { id, type: ReturnLineItems.TYPE } : id, options);

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

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

package/lib/cjs/resources/returns.js

@@ -2,15 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Returns extends resource_1.ApiResource {
-    // static readonly PATH = 'returns'
-    async list(params, options) {
-        return this.resources.list({ type: Returns.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Returns.TYPE }), params, options);
+        return this.resources.create({ ...resource, type: Returns.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Returns.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Returns.TYPE }, params, options);
     }
     async delete(id, options) {
         await this.resources.delete((typeof id === 'string') ? { id, type: Returns.TYPE } : id, options);

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

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

package/lib/cjs/resources/satispay_gateways.js

@@ -2,15 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class SatispayGateways extends resource_1.ApiResource {
-    // static readonly PATH = 'satispay_gateways'
-    async list(params, options) {
-        return this.resources.list({ type: SatispayGateways.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: SatispayGateways.TYPE }), params, options);
+        return this.resources.create({ ...resource, type: SatispayGateways.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: SatispayGateways.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: SatispayGateways.TYPE }, params, options);
     }
     async delete(id, options) {
         await this.resources.delete((typeof id === 'string') ? { id, type: SatispayGateways.TYPE } : id, options);

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

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

package/lib/cjs/resources/satispay_payments.js

@@ -2,15 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class SatispayPayments extends resource_1.ApiResource {
-    // static readonly PATH = 'satispay_payments'
-    async list(params, options) {
-        return this.resources.list({ type: SatispayPayments.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: SatispayPayments.TYPE }), params, options);
+        return this.resources.create({ ...resource, type: SatispayPayments.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: SatispayPayments.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: SatispayPayments.TYPE }, params, options);
     }
     async delete(id, options) {
         await this.resources.delete((typeof id === 'string') ? { id, type: SatispayPayments.TYPE } : id, options);

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

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

package/lib/cjs/resources/shipments.js

@@ -2,12 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Shipments extends resource_1.ApiResource {
-    // static readonly PATH = 'shipments'
-    async list(params, options) {
-        return this.resources.list({ type: Shipments.TYPE }, params, options);
-    }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Shipments.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Shipments.TYPE }, params, options);
     }
     async order(shipmentId, params, options) {
         const _shipmentId = shipmentId.id || shipmentId;

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

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

package/lib/cjs/resources/shipping_categories.js

@@ -2,15 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class ShippingCategories extends resource_1.ApiResource {
-    // static readonly PATH = 'shipping_categories'
-    async list(params, options) {
-        return this.resources.list({ type: ShippingCategories.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ShippingCategories.TYPE }), params, options);
+        return this.resources.create({ ...resource, type: ShippingCategories.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ShippingCategories.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: ShippingCategories.TYPE }, params, options);
     }
     async delete(id, options) {
         await this.resources.delete((typeof id === 'string') ? { id, type: ShippingCategories.TYPE } : id, options);