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

package/lib/cjs/resources/parcel_line_items.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class ParcelLineItems extends resource_1.ApiResource {
+    // static readonly PATH = 'parcel_line_items'
+    async list(params, options) {
+        return this.resources.list({ type: ParcelLineItems.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: ParcelLineItems.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: ParcelLineItems.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((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,120 @@
+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;
+    weight: number;
+    unit_of_weight: string;
+    eel_pfc?: string;
+    contents_type?: string;
+    contents_explanation?: string;
+    customs_certify?: boolean;
+    customs_signer?: string;
+    non_delivery_option?: string;
+    restriction_type?: string;
+    restriction_comments?: string;
+    customs_info_required?: boolean;
+    shipping_label_url?: string;
+    shipping_label_file_type?: string;
+    shipping_label_size?: string;
+    shipping_label_resolution?: string;
+    tracking_number?: string;
+    tracking_status?: string;
+    tracking_status_detail?: string;
+    tracking_status_updated_at?: string;
+    tracking_details?: string;
+    carrier_weight_oz?: string;
+    signed_by?: string;
+    incoterm?: string;
+    shipment?: Shipment;
+    package?: Package;
+    parcel_line_items?: ParcelLineItem[];
+    attachments?: Attachment[];
+    events?: Event[];
+}
+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?: string;
+    carrier_weight_oz?: string;
+    signed_by?: string;
+    incoterm?: string;
+    shipment: ShipmentRel;
+    package: PackageRel;
+}
+interface ParcelUpdate extends ResourceUpdate {
+    weight: number;
+    unit_of_weight: string;
+    eel_pfc?: string;
+    contents_type?: string;
+    contents_explanation?: string;
+    customs_certify?: boolean;
+    customs_signer?: string;
+    non_delivery_option?: string;
+    restriction_type?: string;
+    restriction_comments?: string;
+    customs_info_required?: boolean;
+    shipping_label_url?: string;
+    shipping_label_file_type?: string;
+    shipping_label_size?: string;
+    shipping_label_resolution?: string;
+    tracking_number?: string;
+    tracking_status?: string;
+    tracking_status_detail?: string;
+    tracking_status_updated_at?: string;
+    tracking_details?: string;
+    carrier_weight_oz?: string;
+    signed_by?: string;
+    incoterm?: string;
+    shipment?: ShipmentRel;
+    package?: PackageRel;
+}
+declare class Parcels extends ApiResource<Parcel> {
+    static readonly TYPE: ParcelType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Parcel>>;
+    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,49 @@
+"use strict";
+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 update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, 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,22 @@
+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[];
+}
+declare class PaymentGateways extends ApiResource<PaymentGateway> {
+    static readonly TYPE: PaymentGatewayType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentGateway>>;
+    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,24 @@
+"use strict";
+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 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,73 @@
+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;
+    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[];
+}
+interface PaymentMethodCreate extends ResourceCreate {
+    payment_source_type: string;
+    currency_code?: string;
+    moto?: boolean;
+    require_capture?: boolean;
+    auto_capture?: boolean;
+    price_amount_cents: number;
+    auto_capture_max_amount_cents?: number;
+    market?: MarketRel;
+    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;
+}
+declare class PaymentMethods extends ApiResource<PaymentMethod> {
+    static readonly TYPE: PaymentMethodType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
+    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,41 @@
+"use strict";
+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 update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, 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;

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

@@ -0,0 +1,38 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { PaymentMethod } from './payment_methods';
+import type { PaypalPayment } from './paypal_payments';
+type PaypalGatewayType = 'paypal_gateways';
+type PaypalGatewayRel = ResourceRel & {
+    type: PaypalGatewayType;
+};
+interface PaypalGateway extends Resource {
+    readonly type: PaypalGatewayType;
+    name: string;
+    payment_methods?: PaymentMethod[];
+    paypal_payments?: PaypalPayment[];
+}
+interface PaypalGatewayCreate extends ResourceCreate {
+    name: string;
+    client_id: string;
+    client_secret: string;
+}
+interface PaypalGatewayUpdate extends ResourceUpdate {
+    name: string;
+    client_id?: string;
+    client_secret?: string;
+}
+declare class PaypalGateways extends ApiResource<PaypalGateway> {
+    static readonly TYPE: PaypalGatewayType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaypalGateway>>;
+    create(resource: PaypalGatewayCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaypalGateway>;
+    update(resource: PaypalGatewayUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaypalGateway>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    payment_methods(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
+    paypal_payments(paypalGatewayId: string | PaypalGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaypalPayment>>;
+    isPaypalGateway(resource: any): resource is PaypalGateway;
+    relationship(id: string | ResourceId | null): PaypalGatewayRel;
+    type(): PaypalGatewayType;
+}
+export default PaypalGateways;
+export type { PaypalGateway, PaypalGatewayCreate, PaypalGatewayUpdate, PaypalGatewayType };

package/lib/cjs/resources/paypal_gateways.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class PaypalGateways extends resource_1.ApiResource {
+    // static readonly PATH = 'paypal_gateways'
+    async list(params, options) {
+        return this.resources.list({ type: PaypalGateways.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: PaypalGateways.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: PaypalGateways.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: PaypalGateways.TYPE } : id, options);
+    }
+    async payment_methods(paypalGatewayId, params, options) {
+        const _paypalGatewayId = paypalGatewayId.id || paypalGatewayId;
+        return this.resources.fetch({ type: 'payment_methods' }, `paypal_gateways/${_paypalGatewayId}/payment_methods`, params, options);
+    }
+    async paypal_payments(paypalGatewayId, params, options) {
+        const _paypalGatewayId = paypalGatewayId.id || paypalGatewayId;
+        return this.resources.fetch({ type: 'paypal_payments' }, `paypal_gateways/${_paypalGatewayId}/paypal_payments`, params, options);
+    }
+    isPaypalGateway(resource) {
+        return resource.type && (resource.type === PaypalGateways.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: PaypalGateways.TYPE } : { id: id.id, type: PaypalGateways.TYPE };
+    }
+    type() {
+        return PaypalGateways.TYPE;
+    }
+}
+PaypalGateways.TYPE = 'paypal_gateways';
+exports.default = PaypalGateways;

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

@@ -0,0 +1,53 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order, OrderType } from './orders';
+import type { PaymentGateway } from './payment_gateways';
+type PaypalPaymentType = 'paypal_payments';
+type PaypalPaymentRel = ResourceRel & {
+    type: PaypalPaymentType;
+};
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+interface PaypalPayment extends Resource {
+    readonly type: PaypalPaymentType;
+    return_url: string;
+    cancel_url: string;
+    note_to_payer?: string;
+    paypal_payer_id?: string;
+    name?: string;
+    paypal_id?: string;
+    status?: 'created' | 'approved';
+    approval_url?: string;
+    mismatched_amounts?: boolean;
+    intent_amount_cents: number;
+    intent_amount_float?: number;
+    formatted_intent_amount?: string;
+    payment_instrument?: object;
+    order?: Order;
+    payment_gateway?: PaymentGateway;
+}
+interface PaypalPaymentCreate extends ResourceCreate {
+    return_url: string;
+    cancel_url: string;
+    note_to_payer?: string;
+    order: OrderRel;
+}
+interface PaypalPaymentUpdate extends ResourceUpdate {
+    paypal_payer_id?: string;
+    order?: OrderRel;
+}
+declare class PaypalPayments extends ApiResource<PaypalPayment> {
+    static readonly TYPE: PaypalPaymentType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaypalPayment>>;
+    create(resource: PaypalPaymentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaypalPayment>;
+    update(resource: PaypalPaymentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaypalPayment>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    order(paypalPaymentId: string | PaypalPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    payment_gateway(paypalPaymentId: string | PaypalPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
+    isPaypalPayment(resource: any): resource is PaypalPayment;
+    relationship(id: string | ResourceId | null): PaypalPaymentRel;
+    type(): PaypalPaymentType;
+}
+export default PaypalPayments;
+export type { PaypalPayment, PaypalPaymentCreate, PaypalPaymentUpdate, PaypalPaymentType };

package/lib/cjs/resources/paypal_payments.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class PaypalPayments extends resource_1.ApiResource {
+    // static readonly PATH = 'paypal_payments'
+    async list(params, options) {
+        return this.resources.list({ type: PaypalPayments.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: PaypalPayments.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: PaypalPayments.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: PaypalPayments.TYPE } : id, options);
+    }
+    async order(paypalPaymentId, params, options) {
+        const _paypalPaymentId = paypalPaymentId.id || paypalPaymentId;
+        return this.resources.fetch({ type: 'orders' }, `paypal_payments/${_paypalPaymentId}/order`, params, options);
+    }
+    async payment_gateway(paypalPaymentId, params, options) {
+        const _paypalPaymentId = paypalPaymentId.id || paypalPaymentId;
+        return this.resources.fetch({ type: 'payment_gateways' }, `paypal_payments/${_paypalPaymentId}/payment_gateway`, params, options);
+    }
+    isPaypalPayment(resource) {
+        return resource.type && (resource.type === PaypalPayments.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: PaypalPayments.TYPE } : { id: id.id, type: PaypalPayments.TYPE };
+    }
+    type() {
+        return PaypalPayments.TYPE;
+    }
+}
+PaypalPayments.TYPE = 'paypal_payments';
+exports.default = PaypalPayments;

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

@@ -0,0 +1,101 @@
+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 { PromotionRule, PromotionRuleType } from './promotion_rules';
+import type { OrderAmountPromotionRule, OrderAmountPromotionRuleType } from './order_amount_promotion_rules';
+import type { SkuListPromotionRule, SkuListPromotionRuleType } from './sku_list_promotion_rules';
+import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
+import type { Attachment } from './attachments';
+import type { SkuList, SkuListType } from './sku_lists';
+import type { Sku } from './skus';
+import type { Event } from './events';
+type PercentageDiscountPromotionType = 'percentage_discount_promotions';
+type PercentageDiscountPromotionRel = ResourceRel & {
+    type: PercentageDiscountPromotionType;
+};
+type MarketRel = ResourceRel & {
+    type: MarketType;
+};
+type PromotionRuleRel = ResourceRel & {
+    type: PromotionRuleType;
+};
+type OrderAmountPromotionRuleRel = ResourceRel & {
+    type: OrderAmountPromotionRuleType;
+};
+type SkuListPromotionRuleRel = ResourceRel & {
+    type: SkuListPromotionRuleType;
+};
+type CouponCodesPromotionRuleRel = ResourceRel & {
+    type: CouponCodesPromotionRuleType;
+};
+type SkuListRel = ResourceRel & {
+    type: SkuListType;
+};
+interface PercentageDiscountPromotion extends Resource {
+    readonly type: PercentageDiscountPromotionType;
+    name: string;
+    currency_code?: string;
+    starts_at: string;
+    expires_at: string;
+    total_usage_limit: number;
+    total_usage_count?: number;
+    active?: boolean;
+    percentage: number;
+    market?: Market;
+    promotion_rules?: PromotionRule[];
+    order_amount_promotion_rule?: OrderAmountPromotionRule;
+    sku_list_promotion_rule?: SkuListPromotionRule;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRule;
+    attachments?: Attachment[];
+    sku_list?: SkuList;
+    skus?: Sku[];
+    events?: Event[];
+}
+interface PercentageDiscountPromotionCreate extends ResourceCreate {
+    name: string;
+    currency_code?: string;
+    starts_at: string;
+    expires_at: string;
+    total_usage_limit: number;
+    percentage: number;
+    market?: MarketRel;
+    promotion_rules?: PromotionRuleRel[];
+    order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
+    sku_list_promotion_rule?: SkuListPromotionRuleRel;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
+    sku_list?: SkuListRel;
+}
+interface PercentageDiscountPromotionUpdate extends ResourceUpdate {
+    name: string;
+    currency_code?: string;
+    starts_at: string;
+    expires_at: string;
+    total_usage_limit: number;
+    percentage: number;
+    market?: MarketRel;
+    promotion_rules?: PromotionRuleRel[];
+    order_amount_promotion_rule?: OrderAmountPromotionRuleRel;
+    sku_list_promotion_rule?: SkuListPromotionRuleRel;
+    coupon_codes_promotion_rule?: CouponCodesPromotionRuleRel;
+    sku_list?: SkuListRel;
+}
+declare class PercentageDiscountPromotions extends ApiResource<PercentageDiscountPromotion> {
+    static readonly TYPE: PercentageDiscountPromotionType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PercentageDiscountPromotion>>;
+    create(resource: PercentageDiscountPromotionCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PercentageDiscountPromotion>;
+    update(resource: PercentageDiscountPromotionUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PercentageDiscountPromotion>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    market(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
+    order_amount_promotion_rule(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<OrderAmountPromotionRule>;
+    sku_list_promotion_rule(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuListPromotionRule>;
+    coupon_codes_promotion_rule(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
+    attachments(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    sku_list(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
+    skus(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
+    events(percentageDiscountPromotionId: string | PercentageDiscountPromotion, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isPercentageDiscountPromotion(resource: any): resource is PercentageDiscountPromotion;
+    relationship(id: string | ResourceId | null): PercentageDiscountPromotionRel;
+    type(): PercentageDiscountPromotionType;
+}
+export default PercentageDiscountPromotions;
+export type { PercentageDiscountPromotion, PercentageDiscountPromotionCreate, PercentageDiscountPromotionUpdate, PercentageDiscountPromotionType };