chargebee 3.28.1 → 3.29.0

package/types/resources/Meter.d.ts

@@ -0,0 +1,42 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Meter {
+    id: string;
+    name: string;
+    description?: string;
+    type: 'simple' | 'compound';
+    status?: 'active' | 'archived' | 'deleted';
+    query: string;
+    created_at: number;
+    updated_at?: number;
+    column_definitions?: ColumnDefinition[];
+    features?: Feature[];
+  }
+
+  export namespace Meter {
+    export class MeterResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { meter: Meter }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      name?: filter.String;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+  }
+}

package/types/resources/MeteredFeature.d.ts

@@ -0,0 +1,70 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface MeteredFeature {
+    id: string;
+    name?: string;
+    description?: string;
+    type?: TypeEnum;
+    status?: StatusEnum;
+    query?: string;
+    column_definitions?: ColumnDefinition[];
+    features?: Feature[];
+  }
+
+  export namespace MeteredFeature {
+    export class MeteredFeatureResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      archive(
+        metered_feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ArchiveResponse>>;
+
+      reactivate(
+        metered_feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ReactivateResponse>>;
+
+      delete(
+        metered_feature_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+    }
+
+    export interface CreateResponse {
+      meter: Meter;
+    }
+
+    export interface ArchiveResponse {
+      meter: Meter;
+    }
+
+    export interface ReactivateResponse {
+      meter: Meter;
+    }
+
+    export interface DeleteResponse {
+      meter: Meter;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      name: string;
+      description?: string;
+      feature_unit: string;
+      query: string;
+      column_definitions?: ColumnDefinitionsCreateInputParam[];
+    }
+    export interface ColumnDefinitionsCreateInputParam {
+      column_name: string;
+      data_type: 'number' | 'string';
+    }
+  }
+}

package/types/resources/PaymentIntent.d.ts

@@ -55,7 +55,10 @@ declare module 'chargebee' {
       | 'alipay_hk'
       | 'paypay'
       | 'gcash'
-      | 'south_korean_cards';
+      | 'south_korean_cards'
+      | 'paynow'
+      | 'bizum'
+      | 'promptpay';
     success_url?: string;
     failure_url?: string;
     created_at: number;
@@ -66,6 +69,7 @@ declare module 'chargebee' {
     gateway?: string;
     active_payment_attempt?: PaymentIntent.PaymentAttempt;
     payment_attempts?: PaymentIntent.PaymentAttempt[];
+    payment_intent_metadata?: PaymentIntent.PaymentIntentMetadata;
     business_entity_id?: string;
   }
 
@@ -155,7 +159,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -219,7 +226,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -228,6 +238,22 @@ declare module 'chargebee' {
       modified_at: number;
       error_detail?: GatewayErrorDetail;
     }
+    export interface PaymentIntentMetadata {
+      source:
+        | 'cb_js'
+        | 'components_fields'
+        | 'checkout_v3'
+        | 'paynow_v3'
+        | 'portal_v3'
+        | 'gift_v3'
+        | 'checkout_v4'
+        | 'payment_component'
+        | 'pc_inapp_v4'
+        | 'pc_fpc_v4';
+      client_ip_address?: string;
+      user_agent?: string;
+      created_at?: number;
+    }
     // REQUEST PARAMS
     //---------------
 
@@ -284,7 +310,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       success_url?: string;
       failure_url?: string;
     }
@@ -337,7 +366,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       success_url?: string;
       failure_url?: string;
     }

package/types/resources/PaymentSource.d.ts

@@ -479,7 +479,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/PromotionalGrant.d.ts

@@ -7,7 +7,7 @@ declare module 'chargebee' {
     unit_id: string;
     amount: string;
     expires_at: number;
-    metadata?: string;
+    metadata?: any;
   }
 
   export namespace PromotionalGrant {

package/types/resources/Purchase.d.ts

@@ -122,7 +122,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/Quote.d.ts

@@ -429,6 +429,11 @@ declare module 'chargebee' {
         | 'tax_not_configured_external_provider';
       entity_id?: string;
       customer_id?: string;
+      proration_mode?:
+        | 'reset'
+        | 'delta'
+        | 'service_period_revision'
+        | 'adjusted_term';
     }
     export interface LineItemTier {
       line_item_id?: string;

package/types/resources/QuoteLineGroup.d.ts

@@ -74,6 +74,11 @@ declare module 'chargebee' {
         | 'tax_not_configured_external_provider';
       entity_id?: string;
       customer_id?: string;
+      proration_mode?:
+        | 'reset'
+        | 'delta'
+        | 'service_period_revision'
+        | 'adjusted_term';
     }
     export interface LineItemDiscount {
       line_item_id: string;

package/types/resources/QuotedCharge.d.ts

@@ -16,6 +16,7 @@ declare module 'chargebee' {
       amount?: number;
       amount_in_decimal?: string;
       description?: string;
+      entity_description?: string;
       service_period_in_days?: number;
       avalara_sale_type?: 'wholesale' | 'retail' | 'consumed' | 'vendor_use';
       avalara_transaction_type?: number;
@@ -36,6 +37,8 @@ declare module 'chargebee' {
       quantity_in_decimal?: string;
       unit_price?: number;
       unit_price_in_decimal?: string;
+      description?: string;
+      entity_description?: string;
       service_period_days?: number;
     }
     export interface ItemTier {

package/types/resources/Ramp.d.ts

@@ -126,9 +126,10 @@ declare module 'chargebee' {
     export interface DiscountsToAdd {
       id: string;
       invoice_name?: string;
-      type: 'fixed_amount' | 'percentage';
+      type: 'fixed_amount' | 'percentage' | 'offer_quantity';
       percentage?: number;
       amount?: number;
+      quantity?: number;
       duration_type: 'one_time' | 'forever' | 'limited_period';
       period?: number;
       period_unit?: 'day' | 'week' | 'month' | 'year';
@@ -248,6 +249,7 @@ declare module 'chargebee' {
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
+      quantity?: number;
       period?: number;
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;
@@ -303,6 +305,7 @@ declare module 'chargebee' {
       duration_type: DurationTypeEnum;
       percentage?: number;
       amount?: number;
+      quantity?: number;
       period?: number;
       period_unit?: PeriodUnitEnum;
       included_in_mrr?: boolean;

package/types/resources/RecordedPurchase.d.ts

@@ -59,6 +59,9 @@ declare module 'chargebee' {
     }
     export interface CustomerCreateInputParam {
       id: string;
+      email?: string;
+      first_name?: string;
+      last_name?: string;
     }
     export interface GooglePlayStoreCreateInputParam {
       purchase_token?: string;

package/types/resources/Subscription.d.ts

@@ -882,6 +882,7 @@ declare module 'chargebee' {
       override_relationship?: filter.Boolean;
       business_entity_id?: filter.String;
       channel?: filter.Enum;
+      decommissioned?: filter.Boolean;
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
       [key: `cf_${string}`]: unknown;
@@ -1431,7 +1432,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1583,7 +1587,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1702,7 +1709,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1876,7 +1886,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -2064,7 +2077,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -2208,7 +2224,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -2658,7 +2677,10 @@ declare module 'chargebee' {
         | 'alipay_hk'
         | 'paypay'
         | 'gcash'
-        | 'south_korean_cards';
+        | 'south_korean_cards'
+        | 'paynow'
+        | 'bizum'
+        | 'promptpay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/WebhookEvent.d.ts

@@ -183,6 +183,7 @@ declare module 'chargebee' {
     OmnichannelSubscriptionItemGracePeriodStarted = 'omnichannel_subscription_item_grace_period_started',
     CardExpiryReminder = 'card_expiry_reminder',
     TokenCreated = 'token_created',
+    PaymentSourceBusinessEntityChanged = 'payment_source_business_entity_changed',
     PromotionalCreditsAdded = 'promotional_credits_added',
     SubscriptionRampUpdated = 'subscription_ramp_updated',
     CustomerEntitlementsUpdated = 'customer_entitlements_updated',
@@ -410,6 +411,7 @@ declare module 'chargebee' {
     [WebhookEventType.OmnichannelSubscriptionItemGracePeriodStarted]: OmnichannelSubscriptionItemGracePeriodStartedContent;
     [WebhookEventType.CardExpiryReminder]: CardExpiryReminderContent;
     [WebhookEventType.TokenCreated]: TokenCreatedContent;
+    [WebhookEventType.PaymentSourceBusinessEntityChanged]: PaymentSourceBusinessEntityChangedContent;
     [WebhookEventType.PromotionalCreditsAdded]: PromotionalCreditsAddedContent;
     [WebhookEventType.SubscriptionRampUpdated]: SubscriptionRampUpdatedContent;
     [WebhookEventType.CustomerEntitlementsUpdated]: CustomerEntitlementsUpdatedContent;
@@ -1504,6 +1506,11 @@ declare module 'chargebee' {
   export type TokenCreatedContent = {
     token: Token;
   };
+  export type PaymentSourceBusinessEntityChangedContent = {
+    business_entity_transfer: BusinessEntityTransfer;
+
+    payment_source: PaymentSource;
+  };
   export type PromotionalCreditsAddedContent = {
     customer: Customer;