@commercelayer/sdk 5.0.0-beta.9 → 5.1.0

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
 import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { PaymentMethod } from './payment_methods';
 import type { BraintreePayment, BraintreePaymentType } from './braintree_payments';
@@ -12,12 +13,12 @@ type BraintreePaymentRel = ResourceRel & {
 interface BraintreeGateway extends Resource {
     readonly type: BraintreeGatewayType;
     name: string;
-    descriptor_name?: string;
-    descriptor_phone?: string;
-    descriptor_url?: string;
-    webhook_endpoint_url?: string;
-    payment_methods?: PaymentMethod[];
-    braintree_payments?: BraintreePayment[];
+    descriptor_name?: string | null;
+    descriptor_phone?: string | null;
+    descriptor_url?: string | null;
+    webhook_endpoint_url?: string | null;
+    payment_methods?: PaymentMethod[] | null;
+    braintree_payments?: BraintreePayment[] | null;
 }
 interface BraintreeGatewayCreate extends ResourceCreate {
     name: string;
@@ -25,21 +26,21 @@ interface BraintreeGatewayCreate extends ResourceCreate {
     merchant_id: string;
     public_key: string;
     private_key: string;
-    descriptor_name?: string;
-    descriptor_phone?: string;
-    descriptor_url?: string;
-    braintree_payments?: BraintreePaymentRel[];
+    descriptor_name?: string | null;
+    descriptor_phone?: string | null;
+    descriptor_url?: string | null;
+    braintree_payments?: BraintreePaymentRel[] | null;
 }
 interface BraintreeGatewayUpdate extends ResourceUpdate {
-    name: string;
-    merchant_account_id?: string;
-    merchant_id?: string;
-    public_key?: string;
-    private_key?: string;
-    descriptor_name?: string;
-    descriptor_phone?: string;
-    descriptor_url?: string;
-    braintree_payments?: BraintreePaymentRel[];
+    name?: string | null;
+    merchant_account_id?: string | null;
+    merchant_id?: string | null;
+    public_key?: string | null;
+    private_key?: string | null;
+    descriptor_name?: string | null;
+    descriptor_phone?: string | null;
+    descriptor_url?: string | null;
+    braintree_payments?: BraintreePaymentRel[] | null;
 }
 declare class BraintreeGateways extends ApiResource<BraintreeGateway> {
     static readonly TYPE: BraintreeGatewayType;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
 import type { QueryParamsRetrieve } from '../query';
 import type { Order, OrderType } from './orders';
 import type { PaymentGateway } from './payment_gateways';
@@ -12,26 +13,26 @@ type OrderRel = ResourceRel & {
 interface BraintreePayment extends Resource {
     readonly type: BraintreePaymentType;
     client_token: string;
-    payment_method_nonce?: string;
-    payment_id?: string;
-    local?: boolean;
-    options?: object;
-    payment_instrument?: object;
-    order?: Order;
-    payment_gateway?: PaymentGateway;
+    payment_method_nonce?: string | null;
+    payment_id?: string | null;
+    local?: boolean | null;
+    options?: Record<string, any> | null;
+    payment_instrument?: Record<string, any> | null;
+    order?: Order | null;
+    payment_gateway?: PaymentGateway | null;
 }
 interface BraintreePaymentCreate extends ResourceCreate {
-    payment_id?: string;
-    local?: boolean;
-    options?: object;
+    payment_id?: string | null;
+    local?: boolean | null;
+    options?: Record<string, any> | null;
     order: OrderRel;
 }
 interface BraintreePaymentUpdate extends ResourceUpdate {
-    payment_method_nonce?: string;
-    payment_id?: string;
-    local?: boolean;
-    options?: object;
-    order?: OrderRel;
+    payment_method_nonce?: string | null;
+    payment_id?: string | null;
+    local?: boolean | null;
+    options?: Record<string, any> | null;
+    order?: OrderRel | null;
 }
 declare class BraintreePayments extends ApiResource<BraintreePayment> {
     static readonly TYPE: BraintreePaymentType;

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

@@ -1,9 +1,12 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
 import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Market, MarketType } from './markets';
 import type { SkuList, SkuListType } from './sku_lists';
 import type { Sku } from './skus';
 import type { Attachment } from './attachments';
+import type { Event } from './events';
+import type { Tag, TagType } from './tags';
 type BundleType = 'bundles';
 type BundleRel = ResourceRel & {
     type: BundleType;
@@ -14,50 +17,57 @@ type MarketRel = ResourceRel & {
 type SkuListRel = ResourceRel & {
     type: SkuListType;
 };
+type TagRel = ResourceRel & {
+    type: TagType;
+};
 interface Bundle extends Resource {
     readonly type: BundleType;
     code: string;
     name: string;
-    currency_code?: string;
-    description?: string;
-    image_url?: string;
-    do_not_ship?: boolean;
-    do_not_track?: boolean;
+    currency_code?: string | null;
+    description?: string | null;
+    image_url?: string | null;
+    do_not_ship?: boolean | null;
+    do_not_track?: boolean | null;
     price_amount_cents: number;
     price_amount_float: number;
     formatted_price_amount: string;
     compare_at_amount_cents: number;
     compare_at_amount_float: number;
     formatted_compare_at_amount: string;
-    skus_count?: number;
-    market?: Market;
-    sku_list?: SkuList;
-    skus?: Sku[];
-    attachments?: Attachment[];
+    skus_count?: number | null;
+    market?: Market | null;
+    sku_list?: SkuList | null;
+    skus?: Sku[] | null;
+    attachments?: Attachment[] | null;
+    events?: Event[] | null;
+    tags?: Tag[] | null;
 }
 interface BundleCreate extends ResourceCreate {
     code: string;
     name: string;
-    currency_code?: string;
-    description?: string;
-    image_url?: string;
+    currency_code?: string | null;
+    description?: string | null;
+    image_url?: string | null;
     price_amount_cents: number;
     compare_at_amount_cents: number;
-    _compute_price_amount?: boolean;
-    _compute_compare_at_amount?: boolean;
-    market?: MarketRel;
+    _compute_price_amount?: boolean | null;
+    _compute_compare_at_amount?: boolean | null;
+    market?: MarketRel | null;
     sku_list: SkuListRel;
+    tags?: TagRel[] | null;
 }
 interface BundleUpdate extends ResourceUpdate {
-    code: string;
-    name: string;
-    currency_code?: string;
-    description?: string;
-    image_url?: string;
-    price_amount_cents: number;
-    compare_at_amount_cents: number;
-    _compute_price_amount?: boolean;
-    _compute_compare_at_amount?: boolean;
+    code?: string | null;
+    name?: string | null;
+    currency_code?: string | null;
+    description?: string | null;
+    image_url?: string | null;
+    price_amount_cents?: number | null;
+    compare_at_amount_cents?: number | null;
+    _compute_price_amount?: boolean | null;
+    _compute_compare_at_amount?: boolean | null;
+    tags?: TagRel[] | null;
 }
 declare class Bundles extends ApiResource<Bundle> {
     static readonly TYPE: BundleType;
@@ -68,6 +78,8 @@ declare class Bundles extends ApiResource<Bundle> {
     sku_list(bundleId: string | Bundle, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<SkuList>;
     skus(bundleId: string | Bundle, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Sku>>;
     attachments(bundleId: string | Bundle, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Attachment>>;
+    events(bundleId: string | Bundle, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    tags(bundleId: string | Bundle, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     isBundle(resource: any): resource is Bundle;
     relationship(id: string | ResourceId | null): BundleRel;
     type(): BundleType;

package/lib/cjs/resources/bundles.js

@@ -27,6 +27,14 @@ class Bundles extends resource_1.ApiResource {
         const _bundleId = bundleId.id || bundleId;
         return this.resources.fetch({ type: 'attachments' }, `bundles/${_bundleId}/attachments`, params, options);
     }
+    async events(bundleId, params, options) {
+        const _bundleId = bundleId.id || bundleId;
+        return this.resources.fetch({ type: 'events' }, `bundles/${_bundleId}/events`, params, options);
+    }
+    async tags(bundleId, params, options) {
+        const _bundleId = bundleId.id || bundleId;
+        return this.resources.fetch({ type: 'tags' }, `bundles/${_bundleId}/tags`, params, options);
+    }
     isBundle(resource) {
         return resource.type && (resource.type === Bundles.TYPE);
     }

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
 import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Order } from './orders';
 import type { Authorization } from './authorizations';
@@ -16,25 +17,25 @@ interface Capture extends Resource {
     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[];
+    message?: string | null;
+    error_code?: string | null;
+    error_detail?: string | null;
+    token?: string | null;
+    gateway_transaction_id?: string | null;
+    refund_amount_cents?: number | null;
+    refund_amount_float?: number | null;
+    formatted_refund_amount?: string | null;
+    refund_balance_cents?: number | null;
+    refund_balance_float?: number | null;
+    formatted_refund_balance?: string | null;
+    order?: Order | null;
+    reference_authorization?: Authorization | null;
+    refunds?: Refund[] | null;
+    events?: Event[] | null;
 }
 interface CaptureUpdate extends ResourceUpdate {
-    _refund?: boolean;
-    _refund_amount_cents?: number;
+    _refund?: boolean | null;
+    _refund_amount_cents?: number | null;
 }
 declare class Captures extends ApiResource<Capture> {
     static readonly TYPE: CaptureType;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
 import type { QueryParamsRetrieve, QueryParamsList } from '../query';
 import type { Market } from './markets';
 import type { Attachment } from './attachments';
@@ -8,11 +9,11 @@ type CarrierAccountRel = ResourceRel & {
 };
 interface CarrierAccount extends Resource {
     readonly type: CarrierAccountType;
-    name?: string;
-    easypost_type?: string;
-    easypost_id?: string;
-    market?: Market;
-    attachments?: Attachment[];
+    name?: string | null;
+    easypost_type?: string | null;
+    easypost_id?: string | null;
+    market?: Market | null;
+    attachments?: Attachment[] | null;
 }
 declare class CarrierAccounts extends ApiResource<CarrierAccount> {
     static readonly TYPE: CarrierAccountType;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+import { ApiResource } from '../resource';
+import type { 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';
@@ -12,23 +13,23 @@ type CheckoutComPaymentRel = ResourceRel & {
 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[];
+    webhook_endpoint_id?: string | null;
+    webhook_endpoint_secret?: string | null;
+    webhook_endpoint_url?: string | null;
+    payment_methods?: PaymentMethod[] | null;
+    checkout_com_payments?: CheckoutComPayment[] | null;
 }
 interface CheckoutComGatewayCreate extends ResourceCreate {
     name: string;
     secret_key: string;
     public_key: string;
-    checkout_com_payments?: CheckoutComPaymentRel[];
+    checkout_com_payments?: CheckoutComPaymentRel[] | null;
 }
 interface CheckoutComGatewayUpdate extends ResourceUpdate {
-    name: string;
-    secret_key?: string;
-    public_key?: string;
-    checkout_com_payments?: CheckoutComPaymentRel[];
+    name?: string | null;
+    secret_key?: string | null;
+    public_key?: string | null;
+    checkout_com_payments?: CheckoutComPaymentRel[] | null;
 }
 declare class CheckoutComGateways extends ApiResource<CheckoutComGateway> {
     static readonly TYPE: CheckoutComGatewayType;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
+import { ApiResource } from '../resource';
+import type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
 import type { QueryParamsRetrieve } from '../query';
 import type { Order, OrderType } from './orders';
 import type { PaymentGateway } from './payment_gateways';
@@ -11,38 +12,38 @@ type OrderRel = ResourceRel & {
 };
 interface CheckoutComPayment extends Resource {
     readonly type: CheckoutComPaymentType;
-    public_key?: string;
+    public_key?: string | null;
     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;
+    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;
 }
 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<CheckoutComPayment> {
     static readonly TYPE: CheckoutComPaymentType;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceCreate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+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';
 type CleanupType = 'cleanups';
@@ -8,20 +9,20 @@ type CleanupRel = ResourceRel & {
 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[];
+    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;
 }
 interface CleanupCreate extends ResourceCreate {
     resource_type: string;
-    filters?: object;
+    filters?: Record<string, any> | null;
 }
 declare class Cleanups extends ApiResource<Cleanup> {
     static readonly TYPE: CleanupType;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+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';
@@ -34,16 +35,16 @@ type CouponRel = ResourceRel & {
 };
 interface CouponCodesPromotionRule extends Resource {
     readonly type: CouponCodesPromotionRuleType;
-    promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion;
-    coupons?: Coupon[];
+    promotion?: PercentageDiscountPromotion | FreeShippingPromotion | FreeGiftPromotion | FixedPricePromotion | ExternalPromotion | FixedAmountPromotion | 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<CouponCodesPromotionRule> {
     static readonly TYPE: CouponCodesPromotionRuleType;

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+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';
@@ -12,22 +13,22 @@ type CustomerRel = ResourceRel & {
 interface CouponRecipient extends Resource {
     readonly type: CouponRecipientType;
     email: string;
-    first_name?: string;
-    last_name?: string;
-    customer?: Customer;
-    attachments?: Attachment[];
+    first_name?: string | null;
+    last_name?: string | null;
+    customer?: Customer | null;
+    attachments?: Attachment[] | 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<CouponRecipient> {
     static readonly TYPE: CouponRecipientType;

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

@@ -1,6 +1,9 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel } from '../resource';
-import type { QueryParamsRetrieve } from '../query';
+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 { Event } from './events';
+import type { Tag, TagType } from './tags';
 type CouponType = 'coupons';
 type CouponRel = ResourceRel & {
     type: CouponType;
@@ -8,28 +11,35 @@ type CouponRel = ResourceRel & {
 type CouponCodesPromotionRuleRel = ResourceRel & {
     type: CouponCodesPromotionRuleType;
 };
+type TagRel = ResourceRel & {
+    type: TagType;
+};
 interface Coupon extends Resource {
     readonly type: CouponType;
     code: string;
-    customer_single_use?: boolean;
-    usage_limit: number;
-    usage_count?: number;
-    recipient_email?: string;
-    promotion_rule?: CouponCodesPromotionRule;
+    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;
 }
 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;
+    tags?: TagRel[] | null;
 }
 interface CouponUpdate extends ResourceUpdate {
-    code: string;
-    customer_single_use?: boolean;
-    usage_limit: number;
-    recipient_email?: string;
-    promotion_rule?: CouponCodesPromotionRuleRel;
+    code?: string | null;
+    customer_single_use?: boolean | null;
+    usage_limit?: number | null;
+    recipient_email?: string | null;
+    promotion_rule?: CouponCodesPromotionRuleRel | null;
+    tags?: TagRel[] | null;
 }
 declare class Coupons extends ApiResource<Coupon> {
     static readonly TYPE: CouponType;
@@ -37,6 +47,8 @@ declare class Coupons extends ApiResource<Coupon> {
     update(resource: CouponUpdate, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<Coupon>;
     delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void>;
     promotion_rule(couponId: string | Coupon, params?: QueryParamsRetrieve, options?: ResourcesConfig): Promise<CouponCodesPromotionRule>;
+    events(couponId: string | Coupon, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Event>>;
+    tags(couponId: string | Coupon, params?: QueryParamsList, options?: ResourcesConfig): Promise<ListResponse<Tag>>;
     isCoupon(resource: any): resource is Coupon;
     relationship(id: string | ResourceId | null): CouponRel;
     type(): CouponType;

package/lib/cjs/resources/coupons.js

@@ -15,6 +15,14 @@ class Coupons extends resource_1.ApiResource {
         const _couponId = couponId.id || couponId;
         return this.resources.fetch({ type: 'coupon_codes_promotion_rules' }, `coupons/${_couponId}/promotion_rule`, params, options);
     }
+    async events(couponId, params, options) {
+        const _couponId = couponId.id || couponId;
+        return this.resources.fetch({ type: 'events' }, `coupons/${_couponId}/events`, params, options);
+    }
+    async tags(couponId, params, options) {
+        const _couponId = couponId.id || couponId;
+        return this.resources.fetch({ type: 'tags' }, `coupons/${_couponId}/tags`, params, options);
+    }
     isCoupon(resource) {
         return resource.type && (resource.type === Coupons.TYPE);
     }

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

@@ -1,4 +1,5 @@
-import { ApiResource, Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse } from '../resource';
+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 { Address, AddressType } from './addresses';
@@ -15,18 +16,18 @@ type AddressRel = ResourceRel & {
 };
 interface CustomerAddress extends Resource {
     readonly type: CustomerAddressType;
-    name?: string;
-    customer?: Customer;
-    address?: Address;
-    events?: Event[];
+    name?: string | null;
+    customer?: Customer | null;
+    address?: Address | null;
+    events?: Event[] | null;
 }
 interface CustomerAddressCreate extends ResourceCreate {
     customer: CustomerRel;
     address: AddressRel;
 }
 interface CustomerAddressUpdate extends ResourceUpdate {
-    customer?: CustomerRel;
-    address?: AddressRel;
+    customer?: CustomerRel | null;
+    address?: AddressRel | null;
 }
 declare class CustomerAddresses extends ApiResource<CustomerAddress> {
     static readonly TYPE: CustomerAddressType;