@commercelayer/sdk 4.41.0 → 4.42.0

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

@@ -1,116 +1,117 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Shipment } from './shipments';
-import type { Package } from './packages';
+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: typeof Parcels.TYPE;
+    type: ParcelType;
 };
 type ShipmentRel = ResourceRel & {
-    type: 'shipments';
+    type: ShipmentType;
 };
 type PackageRel = ResourceRel & {
-    type: 'packages';
+    type: PackageType;
 };
 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?: object;
-    carrier_weight_oz?: string;
-    signed_by?: string;
-    incoterm?: string;
-    delivery_confirmation?: string;
-    shipment?: Shipment;
-    package?: Package;
-    parcel_line_items?: ParcelLineItem[];
-    attachments?: Attachment[];
-    events?: Event[];
-    versions?: Version[];
+    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;
-    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?: object;
-    carrier_weight_oz?: string;
-    signed_by?: string;
-    incoterm?: string;
-    delivery_confirmation?: 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;
-    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?: object;
-    carrier_weight_oz?: string;
-    signed_by?: string;
-    incoterm?: string;
-    delivery_confirmation?: string;
-    shipment?: ShipmentRel;
-    package?: PackageRel;
+    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 {
-    static readonly TYPE: 'parcels';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Parcel>>;
+declare class Parcels extends ApiResource<Parcel> {
+    static readonly TYPE: ParcelType;
     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>;
+    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>>;
@@ -119,7 +120,7 @@ declare class Parcels extends ApiResource {
     versions(parcelId: string | Parcel, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isParcel(resource: any): resource is Parcel;
     relationship(id: string | ResourceId | null): ParcelRel;
-    type(): string;
+    type(): ParcelType;
 }
 export default Parcels;
-export { Parcel, ParcelCreate, ParcelUpdate };
+export type { Parcel, ParcelCreate, ParcelUpdate, ParcelType };

package/lib/cjs/resources/parcels.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Parcels extends resource_1.ApiResource {
-    // static readonly PATH = 'parcels'
-    async list(params, options) {
-        return this.resources.list({ type: Parcels.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Parcels.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: Parcels.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: Parcels.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Parcels.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: Parcels.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: Parcels.TYPE, 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;
@@ -42,7 +35,6 @@ class Parcels extends resource_1.ApiResource {
         const _parcelId = parcelId.id || parcelId;
         return this.resources.fetch({ type: 'versions' }, `parcels/${_parcelId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isParcel(resource) {
         return resource.type && (resource.type === Parcels.TYPE);
     }

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

@@ -1,24 +1,25 @@
-import { ApiResource, Resource, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList } from '../query';
 import type { PaymentMethod } from './payment_methods';
 import type { Version } from './versions';
+type PaymentGatewayType = 'payment_gateways';
 type PaymentGatewayRel = ResourceRel & {
-    type: typeof PaymentGateways.TYPE;
+    type: PaymentGatewayType;
 };
 interface PaymentGateway extends Resource {
-    name?: string;
-    payment_methods?: PaymentMethod[];
-    versions?: Version[];
+    readonly type: PaymentGatewayType;
+    name: string;
+    payment_methods?: PaymentMethod[] | null;
+    versions?: Version[] | null;
 }
-declare class PaymentGateways extends ApiResource {
-    static readonly TYPE: 'payment_gateways';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentGateway>>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
+declare class PaymentGateways extends ApiResource<PaymentGateway> {
+    static readonly TYPE: PaymentGatewayType;
     payment_methods(paymentGatewayId: string | PaymentGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
     versions(paymentGatewayId: string | PaymentGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isPaymentGateway(resource: any): resource is PaymentGateway;
     relationship(id: string | ResourceId | null): PaymentGatewayRel;
-    type(): string;
+    type(): PaymentGatewayType;
 }
 export default PaymentGateways;
-export { PaymentGateway };
+export type { PaymentGateway, PaymentGatewayType };

package/lib/cjs/resources/payment_gateways.js

@@ -2,13 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class PaymentGateways extends resource_1.ApiResource {
-    // static readonly PATH = 'payment_gateways'
-    async list(params, options) {
-        return this.resources.list({ type: PaymentGateways.TYPE }, params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: PaymentGateways.TYPE, id }, params, options);
-    }
     async payment_methods(paymentGatewayId, params, options) {
         const _paymentGatewayId = paymentGatewayId.id || paymentGatewayId;
         return this.resources.fetch({ type: 'payment_methods' }, `payment_gateways/${_paymentGatewayId}/payment_methods`, params, options);
@@ -17,7 +10,6 @@ class PaymentGateways extends resource_1.ApiResource {
         const _paymentGatewayId = paymentGatewayId.id || paymentGatewayId;
         return this.resources.fetch({ type: 'versions' }, `payment_gateways/${_paymentGatewayId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isPaymentGateway(resource) {
         return resource.type && (resource.type === PaymentGateways.TYPE);
     }

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

@@ -1,77 +1,80 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Market } from './markets';
-import type { PaymentGateway } from './payment_gateways';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Market, MarketType } from './markets';
+import type { PaymentGateway, PaymentGatewayType } from './payment_gateways';
 import type { Attachment } from './attachments';
 import type { Version } from './versions';
+type PaymentMethodType = 'payment_methods';
 type PaymentMethodRel = ResourceRel & {
-    type: typeof PaymentMethods.TYPE;
+    type: PaymentMethodType;
 };
 type MarketRel = ResourceRel & {
-    type: 'markets';
+    type: MarketType;
 };
 type PaymentGatewayRel = ResourceRel & {
-    type: 'payment_gateways';
+    type: PaymentGatewayType;
 };
 interface PaymentMethod extends Resource {
-    name?: string;
-    payment_source_type?: string;
-    currency_code?: string;
-    moto?: boolean;
-    require_capture?: boolean;
-    auto_capture?: boolean;
-    disabled_at?: string;
-    price_amount_cents?: number;
-    price_amount_float?: number;
-    formatted_price_amount?: string;
-    auto_capture_max_amount_cents?: number;
-    auto_capture_max_amount_float?: number;
-    formatted_auto_capture_max_amount?: string;
-    market?: Market;
-    payment_gateway?: PaymentGateway;
-    attachments?: Attachment[];
-    versions?: Version[];
+    readonly type: PaymentMethodType;
+    name?: string | null;
+    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
+    currency_code?: string | null;
+    moto?: boolean | null;
+    require_capture?: boolean | null;
+    auto_capture?: boolean | null;
+    disabled_at?: string | null;
+    price_amount_cents: number;
+    price_amount_float?: number | null;
+    formatted_price_amount?: string | null;
+    auto_capture_max_amount_cents?: number | null;
+    auto_capture_max_amount_float?: number | null;
+    formatted_auto_capture_max_amount?: string | null;
+    market?: Market | null;
+    payment_gateway?: PaymentGateway | null;
+    attachments?: Attachment[] | null;
+    versions?: Version[] | null;
 }
 interface PaymentMethodCreate extends ResourceCreate {
-    payment_source_type: string;
-    currency_code?: string;
-    moto?: boolean;
-    require_capture?: boolean;
-    auto_capture?: boolean;
-    _disable?: boolean;
-    _enable?: boolean;
+    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
+    currency_code?: string | null;
+    moto?: boolean | null;
+    require_capture?: boolean | null;
+    auto_capture?: boolean | null;
+    _disable?: boolean | null;
+    _enable?: boolean | null;
     price_amount_cents: number;
-    auto_capture_max_amount_cents?: number;
-    market?: MarketRel;
+    auto_capture_max_amount_cents?: number | null;
+    market?: MarketRel | null;
     payment_gateway: PaymentGatewayRel;
 }
 interface PaymentMethodUpdate extends ResourceUpdate {
-    payment_source_type?: string;
-    currency_code?: string;
-    moto?: boolean;
-    require_capture?: boolean;
-    auto_capture?: boolean;
-    _disable?: boolean;
-    _enable?: boolean;
-    price_amount_cents?: number;
-    auto_capture_max_amount_cents?: number;
-    market?: MarketRel;
-    payment_gateway?: PaymentGatewayRel;
+    payment_source_type?: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers' | null;
+    currency_code?: string | null;
+    moto?: boolean | null;
+    require_capture?: boolean | null;
+    auto_capture?: boolean | null;
+    _disable?: boolean | null;
+    _enable?: boolean | null;
+    price_amount_cents?: number | null;
+    auto_capture_max_amount_cents?: number | null;
+    market?: MarketRel | null;
+    payment_gateway?: PaymentGatewayRel | null;
 }
-declare class PaymentMethods extends ApiResource {
-    static readonly TYPE: 'payment_methods';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
+declare class PaymentMethods extends ApiResource<PaymentMethod> {
+    static readonly TYPE: PaymentMethodType;
     create(resource: PaymentMethodCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
     update(resource: PaymentMethodUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     market(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
     payment_gateway(paymentMethodId: string | PaymentMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
     attachments(paymentMethodId: string | PaymentMethod, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     versions(paymentMethodId: string | PaymentMethod, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    _disable(id: string | PaymentMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
+    _enable(id: string | PaymentMethod, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
     isPaymentMethod(resource: any): resource is PaymentMethod;
     relationship(id: string | ResourceId | null): PaymentMethodRel;
-    type(): string;
+    type(): PaymentMethodType;
 }
 export default PaymentMethods;
-export { PaymentMethod, PaymentMethodCreate, PaymentMethodUpdate };
+export type { PaymentMethod, PaymentMethodCreate, PaymentMethodUpdate, PaymentMethodType };

package/lib/cjs/resources/payment_methods.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class PaymentMethods extends resource_1.ApiResource {
-    // static readonly PATH = 'payment_methods'
-    async list(params, options) {
-        return this.resources.list({ type: PaymentMethods.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: PaymentMethods.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: PaymentMethods.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: PaymentMethods.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: PaymentMethods.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: PaymentMethods.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: PaymentMethods.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: PaymentMethods.TYPE } : id, options);
     }
     async market(paymentMethodId, params, options) {
         const _paymentMethodId = paymentMethodId.id || paymentMethodId;
@@ -34,7 +27,12 @@ class PaymentMethods extends resource_1.ApiResource {
         const _paymentMethodId = paymentMethodId.id || paymentMethodId;
         return this.resources.fetch({ type: 'versions' }, `payment_methods/${_paymentMethodId}/versions`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    async _disable(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: PaymentMethods.TYPE, _disable: true }, params, options);
+    }
+    async _enable(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: PaymentMethods.TYPE, _enable: true }, params, options);
+    }
     isPaymentMethod(resource) {
         return resource.type && (resource.type === PaymentMethods.TYPE);
     }

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

@@ -1,43 +1,44 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
-import type { Order } from './orders';
+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 { Attachment } from './attachments';
+type PaymentOptionType = 'payment_options';
 type PaymentOptionRel = ResourceRel & {
-    type: typeof PaymentOptions.TYPE;
+    type: PaymentOptionType;
 };
 type OrderRel = ResourceRel & {
-    type: 'orders';
+    type: OrderType;
 };
 interface PaymentOption extends Resource {
-    name?: string;
-    payment_source_type?: string;
-    data?: object;
-    order?: Order;
-    attachments?: Attachment[];
+    readonly type: PaymentOptionType;
+    name?: string | null;
+    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
+    data: Record<string, any>;
+    order?: Order | null;
+    attachments?: Attachment[] | null;
 }
 interface PaymentOptionCreate extends ResourceCreate {
-    name?: string;
-    payment_source_type: string;
-    data: object;
+    name?: string | null;
+    payment_source_type: 'adyen_payments' | 'axerve_payments' | 'braintree_payments' | 'checkout_com_payments' | 'credit_cards' | 'external_payments' | 'klarna_payments' | 'paypal_payments' | 'satispay_payments' | 'stripe_payments' | 'wire_transfers';
+    data: Record<string, any>;
     order: OrderRel;
 }
 interface PaymentOptionUpdate extends ResourceUpdate {
-    name?: string;
-    data?: object;
-    order?: OrderRel;
+    name?: string | null;
+    data?: Record<string, any> | null;
+    order?: OrderRel | null;
 }
-declare class PaymentOptions extends ApiResource {
-    static readonly TYPE: 'payment_options';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentOption>>;
+declare class PaymentOptions extends ApiResource<PaymentOption> {
+    static readonly TYPE: PaymentOptionType;
     create(resource: PaymentOptionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentOption>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentOption>;
     update(resource: PaymentOptionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentOption>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     order(paymentOptionId: string | PaymentOption, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
     attachments(paymentOptionId: string | PaymentOption, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
     isPaymentOption(resource: any): resource is PaymentOption;
     relationship(id: string | ResourceId | null): PaymentOptionRel;
-    type(): string;
+    type(): PaymentOptionType;
 }
 export default PaymentOptions;
-export { PaymentOption, PaymentOptionCreate, PaymentOptionUpdate };
+export type { PaymentOption, PaymentOptionCreate, PaymentOptionUpdate, PaymentOptionType };

package/lib/cjs/resources/payment_options.js

@@ -2,21 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class PaymentOptions extends resource_1.ApiResource {
-    // static readonly PATH = 'payment_options'
-    async list(params, options) {
-        return this.resources.list({ type: PaymentOptions.TYPE }, params, options);
-    }
     async create(resource, params, options) {
-        return this.resources.create(Object.assign(Object.assign({}, resource), { type: PaymentOptions.TYPE }), params, options);
-    }
-    async retrieve(id, params, options) {
-        return this.resources.retrieve({ type: PaymentOptions.TYPE, id }, params, options);
+        return this.resources.create({ ...resource, type: PaymentOptions.TYPE }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update(Object.assign(Object.assign({}, resource), { type: PaymentOptions.TYPE }), params, options);
+        return this.resources.update({ ...resource, type: PaymentOptions.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: PaymentOptions.TYPE, id }, options);
+        await this.resources.delete((typeof id === 'string') ? { id, type: PaymentOptions.TYPE } : id, options);
     }
     async order(paymentOptionId, params, options) {
         const _paymentOptionId = paymentOptionId.id || paymentOptionId;
@@ -26,7 +19,6 @@ class PaymentOptions extends resource_1.ApiResource {
         const _paymentOptionId = paymentOptionId.id || paymentOptionId;
         return this.resources.fetch({ type: 'attachments' }, `payment_options/${_paymentOptionId}/attachments`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isPaymentOption(resource) {
         return resource.type && (resource.type === PaymentOptions.TYPE);
     }