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

package/lib/cjs/resources/bundles.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Bundles extends resource_1.ApiResource {
+    // static readonly PATH = 'bundles'
+    async list(params, options) {
+        return this.resources.list({ type: Bundles.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Bundles.TYPE }), params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Bundles.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Bundles.TYPE } : id, options);
+    }
+    async market(bundleId, params, options) {
+        const _bundleId = bundleId.id || bundleId;
+        return this.resources.fetch({ type: 'markets' }, `bundles/${_bundleId}/market`, params, options);
+    }
+    async sku_list(bundleId, params, options) {
+        const _bundleId = bundleId.id || bundleId;
+        return this.resources.fetch({ type: 'sku_lists' }, `bundles/${_bundleId}/sku_list`, params, options);
+    }
+    async skus(bundleId, params, options) {
+        const _bundleId = bundleId.id || bundleId;
+        return this.resources.fetch({ type: 'skus' }, `bundles/${_bundleId}/skus`, params, options);
+    }
+    async attachments(bundleId, params, options) {
+        const _bundleId = bundleId.id || bundleId;
+        return this.resources.fetch({ type: 'attachments' }, `bundles/${_bundleId}/attachments`, params, options);
+    }
+    isBundle(resource) {
+        return resource.type && (resource.type === Bundles.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Bundles.TYPE } : { id: id.id, type: Bundles.TYPE };
+    }
+    type() {
+        return Bundles.TYPE;
+    }
+}
+Bundles.TYPE = 'bundles';
+exports.default = Bundles;

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

@@ -0,0 +1,52 @@
+import { ApiResource, Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Order } from './orders';
+import type { Authorization } from './authorizations';
+import type { Refund } from './refunds';
+import type { Event } from './events';
+type CaptureType = 'captures';
+type CaptureRel = ResourceRel & {
+    type: CaptureType;
+};
+interface Capture extends Resource {
+    readonly type: CaptureType;
+    number: string;
+    currency_code: string;
+    amount_cents: number;
+    amount_float: number;
+    formatted_amount: string;
+    succeeded: boolean;
+    message?: string;
+    error_code?: string;
+    error_detail?: string;
+    token?: string;
+    gateway_transaction_id?: string;
+    refund_amount_cents?: number;
+    refund_amount_float?: number;
+    formatted_refund_amount?: string;
+    refund_balance_cents?: number;
+    refund_balance_float?: number;
+    formatted_refund_balance?: string;
+    order?: Order;
+    reference_authorization?: Authorization;
+    refunds?: Refund[];
+    events?: Event[];
+}
+interface CaptureUpdate extends ResourceUpdate {
+    _refund?: boolean;
+    _refund_amount_cents?: number;
+}
+declare class Captures extends ApiResource<Capture> {
+    static readonly TYPE: CaptureType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Capture>>;
+    update(resource: CaptureUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Capture>;
+    order(captureId: string | Capture, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    reference_authorization(captureId: string | Capture, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Authorization>;
+    refunds(captureId: string | Capture, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Refund>>;
+    events(captureId: string | Capture, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isCapture(resource: any): resource is Capture;
+    relationship(id: string | ResourceId | null): CaptureRel;
+    type(): CaptureType;
+}
+export default Captures;
+export type { Capture, CaptureUpdate, CaptureType };

package/lib/cjs/resources/captures.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Captures extends resource_1.ApiResource {
+    // static readonly PATH = 'captures'
+    async list(params, options) {
+        return this.resources.list({ type: Captures.TYPE }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Captures.TYPE }), params, options);
+    }
+    async order(captureId, params, options) {
+        const _captureId = captureId.id || captureId;
+        return this.resources.fetch({ type: 'orders' }, `captures/${_captureId}/order`, params, options);
+    }
+    async reference_authorization(captureId, params, options) {
+        const _captureId = captureId.id || captureId;
+        return this.resources.fetch({ type: 'authorizations' }, `captures/${_captureId}/reference_authorization`, params, options);
+    }
+    async refunds(captureId, params, options) {
+        const _captureId = captureId.id || captureId;
+        return this.resources.fetch({ type: 'refunds' }, `captures/${_captureId}/refunds`, params, options);
+    }
+    async events(captureId, params, options) {
+        const _captureId = captureId.id || captureId;
+        return this.resources.fetch({ type: 'events' }, `captures/${_captureId}/events`, params, options);
+    }
+    isCapture(resource) {
+        return resource.type && (resource.type === Captures.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Captures.TYPE } : { id: id.id, type: Captures.TYPE };
+    }
+    type() {
+        return Captures.TYPE;
+    }
+}
+Captures.TYPE = 'captures';
+exports.default = Captures;

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

@@ -0,0 +1,27 @@
+import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Market } from './markets';
+import type { Attachment } from './attachments';
+type CarrierAccountType = 'carrier_accounts';
+type CarrierAccountRel = ResourceRel & {
+    type: CarrierAccountType;
+};
+interface CarrierAccount extends Resource {
+    readonly type: CarrierAccountType;
+    name?: string;
+    easypost_type?: string;
+    easypost_id?: string;
+    market?: Market;
+    attachments?: Attachment[];
+}
+declare class CarrierAccounts extends ApiResource<CarrierAccount> {
+    static readonly TYPE: CarrierAccountType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CarrierAccount>>;
+    market(carrierAccountId: string | CarrierAccount, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Market>;
+    attachments(carrierAccountId: string | CarrierAccount, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isCarrierAccount(resource: any): resource is CarrierAccount;
+    relationship(id: string | ResourceId | null): CarrierAccountRel;
+    type(): CarrierAccountType;
+}
+export default CarrierAccounts;
+export type { CarrierAccount, CarrierAccountType };

package/lib/cjs/resources/carrier_accounts.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class CarrierAccounts extends resource_1.ApiResource {
+    // static readonly PATH = 'carrier_accounts'
+    async list(params, options) {
+        return this.resources.list({ type: CarrierAccounts.TYPE }, params, options);
+    }
+    async market(carrierAccountId, params, options) {
+        const _carrierAccountId = carrierAccountId.id || carrierAccountId;
+        return this.resources.fetch({ type: 'markets' }, `carrier_accounts/${_carrierAccountId}/market`, params, options);
+    }
+    async attachments(carrierAccountId, params, options) {
+        const _carrierAccountId = carrierAccountId.id || carrierAccountId;
+        return this.resources.fetch({ type: 'attachments' }, `carrier_accounts/${_carrierAccountId}/attachments`, params, options);
+    }
+    isCarrierAccount(resource) {
+        return resource.type && (resource.type === CarrierAccounts.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: CarrierAccounts.TYPE } : { id: id.id, type: CarrierAccounts.TYPE };
+    }
+    type() {
+        return CarrierAccounts.TYPE;
+    }
+}
+CarrierAccounts.TYPE = 'carrier_accounts';
+exports.default = CarrierAccounts;

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

@@ -0,0 +1,46 @@
+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 { CheckoutComPayment, CheckoutComPaymentType } from './checkout_com_payments';
+type CheckoutComGatewayType = 'checkout_com_gateways';
+type CheckoutComGatewayRel = ResourceRel & {
+    type: CheckoutComGatewayType;
+};
+type CheckoutComPaymentRel = ResourceRel & {
+    type: CheckoutComPaymentType;
+};
+interface CheckoutComGateway extends Resource {
+    readonly type: CheckoutComGatewayType;
+    name: string;
+    webhook_endpoint_id?: string;
+    webhook_endpoint_secret?: string;
+    webhook_endpoint_url?: string;
+    payment_methods?: PaymentMethod[];
+    checkout_com_payments?: CheckoutComPayment[];
+}
+interface CheckoutComGatewayCreate extends ResourceCreate {
+    name: string;
+    secret_key: string;
+    public_key: string;
+    checkout_com_payments?: CheckoutComPaymentRel[];
+}
+interface CheckoutComGatewayUpdate extends ResourceUpdate {
+    name: string;
+    secret_key?: string;
+    public_key?: string;
+    checkout_com_payments?: CheckoutComPaymentRel[];
+}
+declare class CheckoutComGateways extends ApiResource<CheckoutComGateway> {
+    static readonly TYPE: CheckoutComGatewayType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CheckoutComGateway>>;
+    create(resource: CheckoutComGatewayCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComGateway>;
+    update(resource: CheckoutComGatewayUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComGateway>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    payment_methods(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<PaymentMethod>>;
+    checkout_com_payments(checkoutComGatewayId: string | CheckoutComGateway, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CheckoutComPayment>>;
+    isCheckoutComGateway(resource: any): resource is CheckoutComGateway;
+    relationship(id: string | ResourceId | null): CheckoutComGatewayRel;
+    type(): CheckoutComGatewayType;
+}
+export default CheckoutComGateways;
+export type { CheckoutComGateway, CheckoutComGatewayCreate, CheckoutComGatewayUpdate, CheckoutComGatewayType };

package/lib/cjs/resources/checkout_com_gateways.js

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

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

@@ -0,0 +1,60 @@
+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 CheckoutComPaymentType = 'checkout_com_payments';
+type CheckoutComPaymentRel = ResourceRel & {
+    type: CheckoutComPaymentType;
+};
+type OrderRel = ResourceRel & {
+    type: OrderType;
+};
+interface CheckoutComPayment extends Resource {
+    readonly type: CheckoutComPaymentType;
+    public_key?: string;
+    payment_type: string;
+    token: string;
+    session_id?: string;
+    success_url?: string;
+    failure_url?: string;
+    source_id?: string;
+    customer_token?: string;
+    redirect_uri?: string;
+    payment_response?: object;
+    mismatched_amounts?: boolean;
+    payment_instrument?: object;
+    order?: Order;
+    payment_gateway?: PaymentGateway;
+}
+interface CheckoutComPaymentCreate extends ResourceCreate {
+    payment_type: string;
+    token: string;
+    session_id?: string;
+    success_url?: string;
+    failure_url?: string;
+    order: OrderRel;
+}
+interface CheckoutComPaymentUpdate extends ResourceUpdate {
+    payment_type: string;
+    token: string;
+    session_id?: string;
+    success_url?: string;
+    failure_url?: string;
+    _details?: boolean;
+    _refresh?: boolean;
+    order?: OrderRel;
+}
+declare class CheckoutComPayments extends ApiResource<CheckoutComPayment> {
+    static readonly TYPE: CheckoutComPaymentType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CheckoutComPayment>>;
+    create(resource: CheckoutComPaymentCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComPayment>;
+    update(resource: CheckoutComPaymentUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CheckoutComPayment>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    order(checkoutComPaymentId: string | CheckoutComPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Order>;
+    payment_gateway(checkoutComPaymentId: string | CheckoutComPayment, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<PaymentGateway>;
+    isCheckoutComPayment(resource: any): resource is CheckoutComPayment;
+    relationship(id: string | ResourceId | null): CheckoutComPaymentRel;
+    type(): CheckoutComPaymentType;
+}
+export default CheckoutComPayments;
+export type { CheckoutComPayment, CheckoutComPaymentCreate, CheckoutComPaymentUpdate, CheckoutComPaymentType };

package/lib/cjs/resources/checkout_com_payments.js

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

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

@@ -0,0 +1,37 @@
+import { ApiResource, Resource, ResourceCreate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Event } from './events';
+type CleanupType = 'cleanups';
+type CleanupRel = ResourceRel & {
+    type: CleanupType;
+};
+interface Cleanup extends Resource {
+    readonly type: CleanupType;
+    resource_type: string;
+    status?: 'pending' | 'in_progress' | 'interrupted' | 'completed';
+    started_at?: string;
+    completed_at?: string;
+    interrupted_at?: string;
+    filters?: object;
+    records_count?: number;
+    errors_count?: number;
+    processed_count?: number;
+    errors_log?: object;
+    events?: Event[];
+}
+interface CleanupCreate extends ResourceCreate {
+    resource_type: string;
+    filters?: object;
+}
+declare class Cleanups extends ApiResource<Cleanup> {
+    static readonly TYPE: CleanupType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Cleanup>>;
+    create(resource: CleanupCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Cleanup>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    events(cleanupId: string | Cleanup, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    isCleanup(resource: any): resource is Cleanup;
+    relationship(id: string | ResourceId | null): CleanupRel;
+    type(): CleanupType;
+}
+export default Cleanups;
+export type { Cleanup, CleanupCreate, CleanupType };

package/lib/cjs/resources/cleanups.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class Cleanups extends resource_1.ApiResource {
+    // static readonly PATH = 'cleanups'
+    async list(params, options) {
+        return this.resources.list({ type: Cleanups.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Cleanups.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete((typeof id === 'string') ? { id, type: Cleanups.TYPE } : id, options);
+    }
+    async events(cleanupId, params, options) {
+        const _cleanupId = cleanupId.id || cleanupId;
+        return this.resources.fetch({ type: 'events' }, `cleanups/${_cleanupId}/events`, params, options);
+    }
+    isCleanup(resource) {
+        return resource.type && (resource.type === Cleanups.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: Cleanups.TYPE } : { id: id.id, type: Cleanups.TYPE };
+    }
+    type() {
+        return Cleanups.TYPE;
+    }
+}
+Cleanups.TYPE = 'cleanups';
+exports.default = Cleanups;

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

@@ -0,0 +1,60 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { PercentageDiscountPromotion, PercentageDiscountPromotionType } from './percentage_discount_promotions';
+import type { FreeShippingPromotion, FreeShippingPromotionType } from './free_shipping_promotions';
+import type { FreeGiftPromotion, FreeGiftPromotionType } from './free_gift_promotions';
+import type { FixedPricePromotion, FixedPricePromotionType } from './fixed_price_promotions';
+import type { ExternalPromotion, ExternalPromotionType } from './external_promotions';
+import type { FixedAmountPromotion, FixedAmountPromotionType } from './fixed_amount_promotions';
+import type { Coupon, CouponType } from './coupons';
+type CouponCodesPromotionRuleType = 'coupon_codes_promotion_rules';
+type CouponCodesPromotionRuleRel = ResourceRel & {
+    type: CouponCodesPromotionRuleType;
+};
+type PercentageDiscountPromotionRel = ResourceRel & {
+    type: PercentageDiscountPromotionType;
+};
+type FreeShippingPromotionRel = ResourceRel & {
+    type: FreeShippingPromotionType;
+};
+type FreeGiftPromotionRel = ResourceRel & {
+    type: FreeGiftPromotionType;
+};
+type FixedPricePromotionRel = ResourceRel & {
+    type: FixedPricePromotionType;
+};
+type ExternalPromotionRel = ResourceRel & {
+    type: ExternalPromotionType;
+};
+type FixedAmountPromotionRel = ResourceRel & {
+    type: FixedAmountPromotionType;
+};
+type CouponRel = ResourceRel & {
+    type: CouponType;
+};
+interface CouponCodesPromotionRule extends Resource {
+    readonly type: CouponCodesPromotionRuleType;
+    promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion;
+    coupons?: Coupon[];
+}
+interface CouponCodesPromotionRuleCreate extends ResourceCreate {
+    promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
+    coupons?: CouponRel[];
+}
+interface CouponCodesPromotionRuleUpdate extends ResourceUpdate {
+    promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
+    coupons?: CouponRel[];
+}
+declare class CouponCodesPromotionRules extends ApiResource<CouponCodesPromotionRule> {
+    static readonly TYPE: CouponCodesPromotionRuleType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CouponCodesPromotionRule>>;
+    create(resource: CouponCodesPromotionRuleCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
+    update(resource: CouponCodesPromotionRuleUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    coupons(couponCodesPromotionRuleId: string | CouponCodesPromotionRule, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
+    isCouponCodesPromotionRule(resource: any): resource is CouponCodesPromotionRule;
+    relationship(id: string | ResourceId | null): CouponCodesPromotionRuleRel;
+    type(): CouponCodesPromotionRuleType;
+}
+export default CouponCodesPromotionRules;
+export type { CouponCodesPromotionRule, CouponCodesPromotionRuleCreate, CouponCodesPromotionRuleUpdate, CouponCodesPromotionRuleType };

package/lib/cjs/resources/coupon_codes_promotion_rules.js

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

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

@@ -0,0 +1,45 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
+import type { Customer, CustomerType } from './customers';
+import type { Attachment } from './attachments';
+type CouponRecipientType = 'coupon_recipients';
+type CouponRecipientRel = ResourceRel & {
+    type: CouponRecipientType;
+};
+type CustomerRel = ResourceRel & {
+    type: CustomerType;
+};
+interface CouponRecipient extends Resource {
+    readonly type: CouponRecipientType;
+    email: string;
+    first_name?: string;
+    last_name?: string;
+    customer?: Customer;
+    attachments?: Attachment[];
+}
+interface CouponRecipientCreate extends ResourceCreate {
+    email: string;
+    first_name?: string;
+    last_name?: string;
+    customer?: CustomerRel;
+}
+interface CouponRecipientUpdate extends ResourceUpdate {
+    email: string;
+    first_name?: string;
+    last_name?: string;
+    customer?: CustomerRel;
+}
+declare class CouponRecipients extends ApiResource<CouponRecipient> {
+    static readonly TYPE: CouponRecipientType;
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CouponRecipient>>;
+    create(resource: CouponRecipientCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponRecipient>;
+    update(resource: CouponRecipientUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponRecipient>;
+    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    customer(couponRecipientId: string | CouponRecipient, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Customer>;
+    attachments(couponRecipientId: string | CouponRecipient, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    isCouponRecipient(resource: any): resource is CouponRecipient;
+    relationship(id: string | ResourceId | null): CouponRecipientRel;
+    type(): CouponRecipientType;
+}
+export default CouponRecipients;
+export type { CouponRecipient, CouponRecipientCreate, CouponRecipientUpdate, CouponRecipientType };

package/lib/cjs/resources/coupon_recipients.js

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