@commercelayer/sdk 5.0.0-alpha.5 → 5.0.0-beta.10

package/lib/cjs/resources/orders.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Orders extends resource_1.ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: Orders.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: Orders.TYPE }, params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Orders.TYPE } : id, options);
+    }
+    async market(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'markets' }, `orders/${_orderId}/market`, params, options);
+    }
+    async customer(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'customers' }, `orders/${_orderId}/customer`, params, options);
+    }
+    async shipping_address(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'addresses' }, `orders/${_orderId}/shipping_address`, params, options);
+    }
+    async billing_address(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'addresses' }, `orders/${_orderId}/billing_address`, params, options);
+    }
+    async available_payment_methods(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'payment_methods' }, `orders/${_orderId}/available_payment_methods`, params, options);
+    }
+    async available_customer_payment_sources(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'customer_payment_sources' }, `orders/${_orderId}/available_customer_payment_sources`, params, options);
+    }
+    async available_free_skus(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'skus' }, `orders/${_orderId}/available_free_skus`, params, options);
+    }
+    async available_free_bundles(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'bundles' }, `orders/${_orderId}/available_free_bundles`, params, options);
+    }
+    async payment_method(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'payment_methods' }, `orders/${_orderId}/payment_method`, params, options);
+    }
+    async line_items(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'line_items' }, `orders/${_orderId}/line_items`, params, options);
+    }
+    async shipments(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'shipments' }, `orders/${_orderId}/shipments`, params, options);
+    }
+    async authorizations(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'authorizations' }, `orders/${_orderId}/authorizations`, params, options);
+    }
+    async captures(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'captures' }, `orders/${_orderId}/captures`, params, options);
+    }
+    async voids(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'voids' }, `orders/${_orderId}/voids`, params, options);
+    }
+    async refunds(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'refunds' }, `orders/${_orderId}/refunds`, params, options);
+    }
+    async returns(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'returns' }, `orders/${_orderId}/returns`, params, options);
+    }
+    async order_subscriptions(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'order_subscriptions' }, `orders/${_orderId}/order_subscriptions`, params, options);
+    }
+    async order_copies(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'order_copies' }, `orders/${_orderId}/order_copies`, params, options);
+    }
+    async attachments(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'attachments' }, `orders/${_orderId}/attachments`, params, options);
+    }
+    async events(orderId, params, options) {
+        const _orderId = orderId.id || orderId;
+        return this.resources.fetch({ type: 'events' }, `orders/${_orderId}/events`, params, options);
+    }
+    isOrder(resource) {
+        return resource.type && (resource.type === Orders.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Orders.TYPE } : { id: id.id, type: Orders.TYPE };
+    }
+    type() {
+        return Orders.TYPE;
+    }
+}
+Orders.TYPE = 'orders';
+exports.default = Orders;

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

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

package/lib/cjs/resources/organization.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Organizations extends resource_1.ApiSingleton {
+    isOrganization(resource) {
+        return resource.type && (resource.type === Organizations.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Organizations.TYPE } : { id: id.id, type: Organizations.TYPE };
+    }
+    type() {
+        return Organizations.TYPE;
+    }
+}
+Organizations.TYPE = 'organization';
+exports.default = Organizations;

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

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

package/lib/cjs/resources/packages.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Packages extends resource_1.ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: Packages.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: Packages.TYPE }, params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Packages.TYPE } : id, options);
+    }
+    async stock_location(packageId, params, options) {
+        const _packageId = packageId.id || packageId;
+        return this.resources.fetch({ type: 'stock_locations' }, `packages/${_packageId}/stock_location`, params, options);
+    }
+    async parcels(packageId, params, options) {
+        const _packageId = packageId.id || packageId;
+        return this.resources.fetch({ type: 'parcels' }, `packages/${_packageId}/parcels`, params, options);
+    }
+    async attachments(packageId, params, options) {
+        const _packageId = packageId.id || packageId;
+        return this.resources.fetch({ type: 'attachments' }, `packages/${_packageId}/attachments`, params, options);
+    }
+    isPackage(resource) {
+        return resource.type && (resource.type === Packages.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Packages.TYPE } : { id: id.id, type: Packages.TYPE };
+    }
+    type() {
+        return Packages.TYPE;
+    }
+}
+Packages.TYPE = 'packages';
+exports.default = Packages;

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

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

package/lib/cjs/resources/parcel_line_items.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class ParcelLineItems extends resource_1.ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: ParcelLineItems.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: ParcelLineItems.TYPE }, params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: ParcelLineItems.TYPE } : id, options);
+    }
+    async parcel(parcelLineItemId, params, options) {
+        const _parcelLineItemId = parcelLineItemId.id || parcelLineItemId;
+        return this.resources.fetch({ type: 'parcels' }, `parcel_line_items/${_parcelLineItemId}/parcel`, params, options);
+    }
+    async stock_line_item(parcelLineItemId, params, options) {
+        const _parcelLineItemId = parcelLineItemId.id || parcelLineItemId;
+        return this.resources.fetch({ type: 'stock_line_items' }, `parcel_line_items/${_parcelLineItemId}/stock_line_item`, params, options);
+    }
+    isParcelLineItem(resource) {
+        return resource.type && (resource.type === ParcelLineItems.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: ParcelLineItems.TYPE } : { id: id.id, type: ParcelLineItems.TYPE };
+    }
+    type() {
+        return ParcelLineItems.TYPE;
+    }
+}
+ParcelLineItems.TYPE = 'parcel_line_items';
+exports.default = ParcelLineItems;

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

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

package/lib/cjs/resources/parcels.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Parcels extends resource_1.ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: Parcels.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: Parcels.TYPE }, params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Parcels.TYPE } : id, options);
+    }
+    async shipment(parcelId, params, options) {
+        const _parcelId = parcelId.id || parcelId;
+        return this.resources.fetch({ type: 'shipments' }, `parcels/${_parcelId}/shipment`, params, options);
+    }
+    async package(parcelId, params, options) {
+        const _parcelId = parcelId.id || parcelId;
+        return this.resources.fetch({ type: 'packages' }, `parcels/${_parcelId}/package`, params, options);
+    }
+    async parcel_line_items(parcelId, params, options) {
+        const _parcelId = parcelId.id || parcelId;
+        return this.resources.fetch({ type: 'parcel_line_items' }, `parcels/${_parcelId}/parcel_line_items`, params, options);
+    }
+    async attachments(parcelId, params, options) {
+        const _parcelId = parcelId.id || parcelId;
+        return this.resources.fetch({ type: 'attachments' }, `parcels/${_parcelId}/attachments`, params, options);
+    }
+    async events(parcelId, params, options) {
+        const _parcelId = parcelId.id || parcelId;
+        return this.resources.fetch({ type: 'events' }, `parcels/${_parcelId}/events`, params, options);
+    }
+    isParcel(resource) {
+        return resource.type && (resource.type === Parcels.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Parcels.TYPE } : { id: id.id, type: Parcels.TYPE };
+    }
+    type() {
+        return Parcels.TYPE;
+    }
+}
+Parcels.TYPE = 'parcels';
+exports.default = Parcels;

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

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

package/lib/cjs/resources/payment_gateways.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class PaymentGateways extends resource_1.ApiResource {
+    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);
+    }
+    isPaymentGateway(resource) {
+        return resource.type && (resource.type === PaymentGateways.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: PaymentGateways.TYPE } : { id: id.id, type: PaymentGateways.TYPE };
+    }
+    type() {
+        return PaymentGateways.TYPE;
+    }
+}
+PaymentGateways.TYPE = 'payment_gateways';
+exports.default = PaymentGateways;

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

@@ -0,0 +1,72 @@
+import { ApiResource, 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';
+type PaymentMethodType = 'payment_methods';
+type PaymentMethodRel = ResourceRel & {
+    type: PaymentMethodType;
+};
+type MarketRel = ResourceRel & {
+    type: MarketType;
+};
+type PaymentGatewayRel = ResourceRel & {
+    type: PaymentGatewayType;
+};
+interface PaymentMethod extends Resource {
+    readonly type: PaymentMethodType;
+    payment_source_type: string;
+    name?: string | null;
+    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;
+}
+interface PaymentMethodCreate extends ResourceCreate {
+    payment_source_type: string;
+    currency_code?: string | null;
+    moto?: boolean | null;
+    require_capture?: boolean | null;
+    auto_capture?: boolean | null;
+    price_amount_cents: number;
+    auto_capture_max_amount_cents?: number | null;
+    market?: MarketRel | null;
+    payment_gateway: PaymentGatewayRel;
+}
+interface PaymentMethodUpdate extends ResourceUpdate {
+    payment_source_type?: string | 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<PaymentMethod> {
+    static readonly TYPE: PaymentMethodType;
+    create(resource: PaymentMethodCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
+    update(resource: PaymentMethodUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentMethod>;
+    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>>;
+    isPaymentMethod(resource: any): resource is PaymentMethod;
+    relationship(id: string | ResourceId | null): PaymentMethodRel;
+    type(): PaymentMethodType;
+}
+export default PaymentMethods;
+export type { PaymentMethod, PaymentMethodCreate, PaymentMethodUpdate, PaymentMethodType };

package/lib/cjs/resources/payment_methods.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class PaymentMethods extends resource_1.ApiResource {
+    async create(resource, params, options) {
+        return this.resources.create({ ...resource, type: PaymentMethods.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update({ ...resource, type: PaymentMethods.TYPE }, params, options);
+    }
+    async delete(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;
+        return this.resources.fetch({ type: 'markets' }, `payment_methods/${_paymentMethodId}/market`, params, options);
+    }
+    async payment_gateway(paymentMethodId, params, options) {
+        const _paymentMethodId = paymentMethodId.id || paymentMethodId;
+        return this.resources.fetch({ type: 'payment_gateways' }, `payment_methods/${_paymentMethodId}/payment_gateway`, params, options);
+    }
+    async attachments(paymentMethodId, params, options) {
+        const _paymentMethodId = paymentMethodId.id || paymentMethodId;
+        return this.resources.fetch({ type: 'attachments' }, `payment_methods/${_paymentMethodId}/attachments`, params, options);
+    }
+    isPaymentMethod(resource) {
+        return resource.type && (resource.type === PaymentMethods.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: PaymentMethods.TYPE } : { id: id.id, type: PaymentMethods.TYPE };
+    }
+    type() {
+        return PaymentMethods.TYPE;
+    }
+}
+PaymentMethods.TYPE = 'payment_methods';
+exports.default = PaymentMethods;