@commercelayer/sdk 4.35.0 → 4.37.0

package/lib/cjs/resources/checkout_com_gateways.js

@@ -2,21 +2,14 @@
 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 retrieve(id, params, options) {
-        return this.resources.retrieve({ type: CheckoutComGateways.TYPE, id }, params, options);
+        return this.resources.create({ ...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);
+        return this.resources.update({ ...resource, type: CheckoutComGateways.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: CheckoutComGateways.TYPE, 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;
@@ -30,7 +23,6 @@ class CheckoutComGateways extends resource_1.ApiResource {
         const _checkoutComGatewayId = checkoutComGatewayId.id || checkoutComGatewayId;
         return this.resources.fetch({ type: 'checkout_com_payments' }, `checkout_com_gateways/${_checkoutComGatewayId}/checkout_com_payments`, params, options);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isCheckoutComGateway(resource) {
         return resource.type && (resource.type === CheckoutComGateways.TYPE);
     }

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

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

package/lib/cjs/resources/checkout_com_payments.js

@@ -2,21 +2,14 @@
 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 retrieve(id, params, options) {
-        return this.resources.retrieve({ type: CheckoutComPayments.TYPE, id }, params, options);
+        return this.resources.create({ ...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);
+        return this.resources.update({ ...resource, type: CheckoutComPayments.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: CheckoutComPayments.TYPE, 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;
@@ -30,7 +23,12 @@ class CheckoutComPayments extends resource_1.ApiResource {
         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
+    async _details(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: CheckoutComPayments.TYPE, _details: true }, params, options);
+    }
+    async _refresh(id, params, options) {
+        return this.resources.update({ id: (typeof id === 'string') ? id : id.id, type: CheckoutComPayments.TYPE, _refresh: true }, params, options);
+    }
     isCheckoutComPayment(resource) {
         return resource.type && (resource.type === CheckoutComPayments.TYPE);
     }

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

@@ -1,39 +1,40 @@
-import { ApiResource, Resource, ResourceCreate, ResourcesConfig, ResourceId, ResourceRel, ListResponse } from '../resource';
-import type { QueryParamsList, QueryParamsRetrieve } from '../query';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Event } from './events';
 import type { Version } from './versions';
+type CleanupType = 'cleanups';
 type CleanupRel = ResourceRel & {
-    type: typeof Cleanups.TYPE;
+    type: CleanupType;
 };
 interface Cleanup extends Resource {
-    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[];
+    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;
+    versions?: Version[] | null;
 }
 interface CleanupCreate extends ResourceCreate {
     resource_type: string;
-    filters?: object;
+    filters?: Record<string, any> | null;
 }
-declare class Cleanups extends ApiResource {
-    static readonly TYPE: 'cleanups';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Cleanup>>;
+declare class Cleanups extends ApiResource<Cleanup> {
+    static readonly TYPE: CleanupType;
     create(resource: CleanupCreate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Cleanup>;
-    retrieve(id: string, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Cleanup>;
-    delete(id: string, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, 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(): string;
+    type(): CleanupType;
 }
 export default Cleanups;
-export { Cleanup, CleanupCreate };
+export type { Cleanup, CleanupCreate, CleanupType };

package/lib/cjs/resources/cleanups.js

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

package/lib/cjs/resources/coupon_codes_promotion_rules.js

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

package/lib/cjs/resources/coupon_recipients.js

@@ -2,21 +2,14 @@
 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 retrieve(id, params, options) {
-        return this.resources.retrieve({ type: CouponRecipients.TYPE, id }, params, options);
+        return this.resources.create({ ...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);
+        return this.resources.update({ ...resource, type: CouponRecipients.TYPE }, params, options);
     }
     async delete(id, options) {
-        await this.resources.delete({ type: CouponRecipients.TYPE, 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;
@@ -30,7 +23,6 @@ class CouponRecipients extends resource_1.ApiResource {
         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,59 +1,60 @@
-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 { 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 type { CouponRecipient, CouponRecipientType } from './coupon_recipients';
 import type { Event } from './events';
-import type { Tag } from './tags';
+import type { Tag, TagType } from './tags';
 import type { Version } from './versions';
+type CouponType = 'coupons';
 type CouponRel = ResourceRel & {
-    type: typeof Coupons.TYPE;
+    type: CouponType;
 };
 type CouponCodesPromotionRuleRel = ResourceRel & {
-    type: 'coupon_codes_promotion_rules';
+    type: CouponCodesPromotionRuleType;
 };
 type CouponRecipientRel = ResourceRel & {
-    type: 'coupon_recipients';
+    type: CouponRecipientType;
 };
 type TagRel = ResourceRel & {
-    type: 'tags';
+    type: TagType;
 };
 interface Coupon extends Resource {
-    code?: string;
-    customer_single_use?: boolean;
-    usage_limit?: number;
-    usage_count?: number;
-    recipient_email?: string;
-    promotion_rule?: CouponCodesPromotionRule;
-    coupon_recipient?: CouponRecipient;
-    events?: Event[];
-    tags?: Tag[];
-    versions?: Version[];
+    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;
+    coupon_recipient?: CouponRecipient | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
+    versions?: Version[] | null;
 }
 interface CouponCreate extends ResourceCreate {
     code: string;
-    customer_single_use?: boolean;
-    usage_limit?: number;
-    recipient_email?: string;
+    customer_single_use?: boolean | null;
+    usage_limit?: number | null;
+    recipient_email?: string | null;
     promotion_rule: CouponCodesPromotionRuleRel;
-    coupon_recipient?: CouponRecipientRel;
-    tags?: TagRel[];
+    coupon_recipient?: CouponRecipientRel | null;
+    tags?: TagRel[] | null;
 }
 interface CouponUpdate extends ResourceUpdate {
-    code?: string;
-    customer_single_use?: boolean;
-    usage_limit?: number;
-    recipient_email?: string;
-    promotion_rule?: CouponCodesPromotionRuleRel;
-    coupon_recipient?: CouponRecipientRel;
-    tags?: TagRel[];
+    code?: string | null;
+    customer_single_use?: boolean | null;
+    usage_limit?: number | null;
+    recipient_email?: string | null;
+    promotion_rule?: CouponCodesPromotionRuleRel | null;
+    coupon_recipient?: CouponRecipientRel | null;
+    tags?: TagRel[] | null;
 }
-declare class Coupons extends ApiResource {
-    static readonly TYPE: 'coupons';
-    list(params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Coupon>>;
+declare class Coupons extends ApiResource<Coupon> {
+    static readonly TYPE: CouponType;
     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, options?: ResourcesConfig): Promise<void>;
+    delete(id: string | ResourceId, 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>>;
@@ -61,7 +62,7 @@ declare class Coupons extends ApiResource {
     versions(couponId: string | Coupon, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Version>>;
     isCoupon(resource: any): resource is Coupon;
     relationship(id: string | ResourceId | null): CouponRel;
-    type(): string;
+    type(): CouponType;
 }
 export default Coupons;
-export { Coupon, CouponCreate, CouponUpdate };
+export type { Coupon, CouponCreate, CouponUpdate, CouponType };