@commercelayer/sdk 4.28.0 → 4.28.1

package/lib/cjs/resources/checkout_com_payments.js

@@ -2,14 +2,21 @@
 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({ ...resource, type: CheckoutComPayments.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: CheckoutComPayments.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: CheckoutComPayments.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: CheckoutComPayments.TYPE }, 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);
+        await this.resources.delete({ type: CheckoutComPayments.TYPE, id }, options);
     }
     async order(checkoutComPaymentId, params, options) {
         const _checkoutComPaymentId = checkoutComPaymentId.id || checkoutComPaymentId;
@@ -19,6 +26,11 @@ class CheckoutComPayments extends resource_1.ApiResource {
         const _checkoutComPaymentId = checkoutComPaymentId.id || checkoutComPaymentId;
         return this.resources.fetch({ type: 'payment_gateways' }, `checkout_com_payments/${_checkoutComPaymentId}/payment_gateway`, params, options);
     }
+    async versions(checkoutComPaymentId, params, options) {
+        const _checkoutComPaymentId = checkoutComPaymentId.id || checkoutComPaymentId;
+        return this.resources.fetch({ type: 'versions' }, `checkout_com_payments/${_checkoutComPaymentId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isCheckoutComPayment(resource) {
         return resource.type && (resource.type === CheckoutComPayments.TYPE);
     }

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

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

package/lib/cjs/resources/cleanups.js

@@ -2,16 +2,28 @@
 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({ ...resource, type: Cleanups.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Cleanups.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Cleanups.TYPE, id }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: Cleanups.TYPE } : id, options);
+        await this.resources.delete({ 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);
     }
+    async versions(cleanupId, params, options) {
+        const _cleanupId = cleanupId.id || cleanupId;
+        return this.resources.fetch({ type: 'versions' }, `cleanups/${_cleanupId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isCleanup(resource) {
         return resource.type && (resource.type === Cleanups.TYPE);
     }

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

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

package/lib/cjs/resources/coupon_codes_promotion_rules.js

@@ -2,19 +2,31 @@
 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({ ...resource, type: CouponCodesPromotionRules.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: CouponCodesPromotionRules.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: CouponCodesPromotionRules.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: CouponCodesPromotionRules.TYPE }, 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);
+        await this.resources.delete({ type: CouponCodesPromotionRules.TYPE, id }, options);
+    }
+    async versions(couponCodesPromotionRuleId, params, options) {
+        const _couponCodesPromotionRuleId = couponCodesPromotionRuleId.id || couponCodesPromotionRuleId;
+        return this.resources.fetch({ type: 'versions' }, `coupon_codes_promotion_rules/${_couponCodesPromotionRuleId}/versions`, params, 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);
     }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isCouponCodesPromotionRule(resource) {
         return resource.type && (resource.type === CouponCodesPromotionRules.TYPE);
     }

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

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

package/lib/cjs/resources/coupon_recipients.js

@@ -2,14 +2,21 @@
 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({ ...resource, type: CouponRecipients.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: CouponRecipients.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: CouponRecipients.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: CouponRecipients.TYPE }, 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);
+        await this.resources.delete({ type: CouponRecipients.TYPE, id }, options);
     }
     async customer(couponRecipientId, params, options) {
         const _couponRecipientId = couponRecipientId.id || couponRecipientId;
@@ -19,6 +26,11 @@ class CouponRecipients extends resource_1.ApiResource {
         const _couponRecipientId = couponRecipientId.id || couponRecipientId;
         return this.resources.fetch({ type: 'attachments' }, `coupon_recipients/${_couponRecipientId}/attachments`, params, options);
     }
+    async versions(couponRecipientId, params, options) {
+        const _couponRecipientId = couponRecipientId.id || couponRecipientId;
+        return this.resources.fetch({ type: 'versions' }, `coupon_recipients/${_couponRecipientId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isCouponRecipient(resource) {
         return resource.type && (resource.type === CouponRecipients.TYPE);
     }

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

@@ -1,57 +1,70 @@
-import { ApiResource } from '../resource';
-import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsRetrieve, QueryParamsList } from '../query';
-import type { CouponCodesPromotionRule, CouponCodesPromotionRuleType } from './coupon_codes_promotion_rules';
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import type { CouponCodesPromotionRule } from './coupon_codes_promotion_rules';
+import type { CouponRecipient } from './coupon_recipients';
 import type { Event } from './events';
-import type { Tag, TagType } from './tags';
-type CouponType = 'coupons';
+import type { Tag } from './tags';
+import type { Version } from './versions';
 type CouponRel = ResourceRel & {
-    type: CouponType;
+    type: typeof Coupons.TYPE;
 };
 type CouponCodesPromotionRuleRel = ResourceRel & {
-    type: CouponCodesPromotionRuleType;
+    type: 'coupon_codes_promotion_rules';
+};
+type CouponRecipientRel = ResourceRel & {
+    type: 'coupon_recipients';
 };
 type TagRel = ResourceRel & {
-    type: TagType;
+    type: 'tags';
 };
 interface Coupon extends Resource {
-    readonly type: CouponType;
-    code: string;
-    customer_single_use?: boolean | null;
-    usage_limit?: number | null;
-    usage_count?: number | null;
-    recipient_email?: string | null;
-    promotion_rule?: CouponCodesPromotionRule | null;
-    events?: Event[] | null;
-    tags?: Tag[] | null;
+    code?: string;
+    customer_single_use?: boolean;
+    usage_limit?: number;
+    usage_count?: number;
+    recipient_email?: string;
+    expires_at?: string;
+    promotion_rule?: CouponCodesPromotionRule;
+    coupon_recipient?: CouponRecipient;
+    events?: Event[];
+    tags?: Tag[];
+    versions?: Version[];
 }
 interface CouponCreate extends ResourceCreate {
     code: string;
-    customer_single_use?: boolean | null;
-    usage_limit?: number | null;
-    recipient_email?: string | null;
+    customer_single_use?: boolean;
+    usage_limit?: number;
+    recipient_email?: string;
+    expires_at?: string;
     promotion_rule: CouponCodesPromotionRuleRel;
-    tags?: TagRel[] | null;
+    coupon_recipient?: CouponRecipientRel;
+    tags?: TagRel[];
 }
 interface CouponUpdate extends ResourceUpdate {
-    code?: string | null;
-    customer_single_use?: boolean | null;
-    usage_limit?: number | null;
-    recipient_email?: string | null;
-    promotion_rule?: CouponCodesPromotionRuleRel | null;
-    tags?: TagRel[] | null;
+    code?: string;
+    customer_single_use?: boolean;
+    usage_limit?: number;
+    recipient_email?: string;
+    expires_at?: string;
+    promotion_rule?: CouponCodesPromotionRuleRel;
+    coupon_recipient?: CouponRecipientRel;
+    tags?: TagRel[];
 }
-declare class Coupons extends ApiResource<Coupon> {
-    static readonly TYPE: CouponType;
+declare class Coupons extends ApiResource {
+    static readonly TYPE: 'coupons';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
     create(resource: CouponCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Coupon>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Coupon>;
     update(resource: CouponUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Coupon>;
-    delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
     promotion_rule(couponId: string | Coupon, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
+    coupon_recipient(couponId: string | Coupon, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponRecipient>;
     events(couponId: string | Coupon, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
     tags(couponId: string | Coupon, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
+    versions(couponId: string | Coupon, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isCoupon(resource: any): resource is Coupon;
     relationship(id: string | ResourceId | null): CouponRel;
-    type(): CouponType;
+    type(): string;
 }
 export default Coupons;
-export type { Coupon, CouponCreate, CouponUpdate, CouponType };
+export { Coupon, CouponCreate, CouponUpdate };

package/lib/cjs/resources/coupons.js

@@ -2,19 +2,30 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const resource_1 = require("../resource");
 class Coupons extends resource_1.ApiResource {
+    // static readonly PATH = 'coupons'
+    async list(params, options) {
+        return this.resources.list({ type: Coupons.TYPE }, params, options);
+    }
     async create(resource, params, options) {
-        return this.resources.create({ ...resource, type: Coupons.TYPE }, params, options);
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: Coupons.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: Coupons.TYPE, id }, params, options);
     }
     async update(resource, params, options) {
-        return this.resources.update({ ...resource, type: Coupons.TYPE }, params, options);
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: Coupons.TYPE }), params, options);
     }
     async delete(id, options) {
-        await this.resources.delete((typeof id === 'string') ? { id, type: Coupons.TYPE } : id, options);
+        await this.resources.delete({ type: Coupons.TYPE, id }, options);
     }
     async promotion_rule(couponId, params, options) {
         const _couponId = couponId.id || couponId;
         return this.resources.fetch({ type: 'coupon_codes_promotion_rules' }, `coupons/${_couponId}/promotion_rule`, params, options);
     }
+    async coupon_recipient(couponId, params, options) {
+        const _couponId = couponId.id || couponId;
+        return this.resources.fetch({ type: 'coupon_recipients' }, `coupons/${_couponId}/coupon_recipient`, params, options);
+    }
     async events(couponId, params, options) {
         const _couponId = couponId.id || couponId;
         return this.resources.fetch({ type: 'events' }, `coupons/${_couponId}/events`, params, options);
@@ -23,6 +34,11 @@ class Coupons extends resource_1.ApiResource {
         const _couponId = couponId.id || couponId;
         return this.resources.fetch({ type: 'tags' }, `coupons/${_couponId}/tags`, params, options);
     }
+    async versions(couponId, params, options) {
+        const _couponId = couponId.id || couponId;
+        return this.resources.fetch({ type: 'versions' }, `coupons/${_couponId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isCoupon(resource) {
         return resource.type && (resource.type === Coupons.TYPE);
     }

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

@@ -0,0 +1,61 @@
+import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import type { PercentageDiscountPromotion } from './percentage_discount_promotions';
+import type { FreeShippingPromotion } from './free_shipping_promotions';
+import type { BuyXPayYPromotion } from './buy_x_pay_y_promotions';
+import type { FreeGiftPromotion } from './free_gift_promotions';
+import type { FixedPricePromotion } from './fixed_price_promotions';
+import type { ExternalPromotion } from './external_promotions';
+import type { FixedAmountPromotion } from './fixed_amount_promotions';
+import type { Version } from './versions';
+type CustomPromotionRuleRel = ResourceRel & {
+    type: typeof CustomPromotionRules.TYPE;
+};
+type PercentageDiscountPromotionRel = ResourceRel & {
+    type: 'percentage_discount_promotions';
+};
+type FreeShippingPromotionRel = ResourceRel & {
+    type: 'free_shipping_promotions';
+};
+type BuyXPayYPromotionRel = ResourceRel & {
+    type: 'buy_x_pay_y_promotions';
+};
+type FreeGiftPromotionRel = ResourceRel & {
+    type: 'free_gift_promotions';
+};
+type FixedPricePromotionRel = ResourceRel & {
+    type: 'fixed_price_promotions';
+};
+type ExternalPromotionRel = ResourceRel & {
+    type: 'external_promotions';
+};
+type FixedAmountPromotionRel = ResourceRel & {
+    type: 'fixed_amount_promotions';
+};
+interface CustomPromotionRule extends Resource {
+    filters?: object;
+    promotion?: PercentageDiscountPromotion | FreeShippingPromotion | BuyXPayYPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion;
+    versions?: Version[];
+}
+interface CustomPromotionRuleCreate extends ResourceCreate {
+    filters?: object;
+    promotion: PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
+}
+interface CustomPromotionRuleUpdate extends ResourceUpdate {
+    filters?: object;
+    promotion?: PercentageDiscountPromotionRel | FreeShippingPromotionRel | BuyXPayYPromotionRel | FreeGiftPromotionRel | FixedPricePromotionRel | ExternalPromotionRel | FixedAmountPromotionRel;
+}
+declare class CustomPromotionRules extends ApiResource {
+    static readonly TYPE: 'custom_promotion_rules';
+    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<CustomPromotionRule>>;
+    create(resource: CustomPromotionRuleCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
+    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
+    update(resource: CustomPromotionRuleUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CustomPromotionRule>;
+    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    versions(customPromotionRuleId: string | CustomPromotionRule, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
+    isCustomPromotionRule(resource: any): resource is CustomPromotionRule;
+    relationship(id: string | ResourceId | null): CustomPromotionRuleRel;
+    type(): string;
+}
+export default CustomPromotionRules;
+export { CustomPromotionRule, CustomPromotionRuleCreate, CustomPromotionRuleUpdate };

package/lib/cjs/resources/custom_promotion_rules.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const resource_1 = require("../resource");
+class CustomPromotionRules extends resource_1.ApiResource {
+    // static readonly PATH = 'custom_promotion_rules'
+    async list(params, options) {
+        return this.resources.list({ type: CustomPromotionRules.TYPE }, params, options);
+    }
+    async create(resource, params, options) {
+        return this.resources.create(Object.assign(Object.assign({}, resource), { type: CustomPromotionRules.TYPE }), params, options);
+    }
+    async retrieve(id, params, options) {
+        return this.resources.retrieve({ type: CustomPromotionRules.TYPE, id }, params, options);
+    }
+    async update(resource, params, options) {
+        return this.resources.update(Object.assign(Object.assign({}, resource), { type: CustomPromotionRules.TYPE }), params, options);
+    }
+    async delete(id, options) {
+        await this.resources.delete({ type: CustomPromotionRules.TYPE, id }, options);
+    }
+    async versions(customPromotionRuleId, params, options) {
+        const _customPromotionRuleId = customPromotionRuleId.id || customPromotionRuleId;
+        return this.resources.fetch({ type: 'versions' }, `custom_promotion_rules/${_customPromotionRuleId}/versions`, params, options);
+    }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    isCustomPromotionRule(resource) {
+        return resource.type && (resource.type === CustomPromotionRules.TYPE);
+    }
+    relationship(id) {
+        return ((id === null) || (typeof id === 'string')) ? { id, type: CustomPromotionRules.TYPE } : { id: id.id, type: CustomPromotionRules.TYPE };
+    }
+    type() {
+        return CustomPromotionRules.TYPE;
+    }
+}
+CustomPromotionRules.TYPE = 'custom_promotion_rules';
+exports.default = CustomPromotionRules;