chargebee 3.33.0 → 3.35.0

package/types/resources/LedgerOperation.d.ts

@@ -4,9 +4,9 @@
 declare module 'chargebee' {
   export interface LedgerOperation {
     id: string;
-    subscription_id?: string;
-    unit_id?: string;
-    unit_type?: 'credit_unit';
+    subscription_id: string;
+    unit_id: string;
+    unit_type: 'credit_unit';
     type:
       | 'allocation'
       | 'capture'
@@ -16,7 +16,8 @@ declare module 'chargebee' {
       | 'expiry'
       | 'void'
       | 'rollover'
-      | 'adjustment';
+      | 'adjustment'
+      | 'overdraft_settlement';
     amount: string;
     provisioned_start_balance: string;
     provisioned_end_balance: string;
@@ -78,28 +79,32 @@ declare module 'chargebee' {
     }
 
     export interface CaptureResponse {
-      ledger_operation: LedgerOperation;
+      ledger_operation?: LedgerOperation;
+      ledger_operations: LedgerOperation[];
       ledger_account_balance: LedgerAccountBalance;
       grant_blocks: GrantBlock[];
       ledger_entries: LedgerEntry[];
     }
 
     export interface AuthorizeResponse {
-      ledger_operation: LedgerOperation;
+      ledger_operation?: LedgerOperation;
+      ledger_operations: LedgerOperation[];
       ledger_account_balance: LedgerAccountBalance;
       grant_blocks: GrantBlock[];
       ledger_entries: LedgerEntry[];
     }
 
     export interface CaptureAuthorizationResponse {
-      ledger_operation: LedgerOperation;
+      ledger_operation?: LedgerOperation;
+      ledger_operations: LedgerOperation[];
       ledger_account_balance: LedgerAccountBalance;
       grant_blocks: GrantBlock[];
       ledger_entries: LedgerEntry[];
     }
 
     export interface ReleaseAuthorizationResponse {
-      ledger_operation: LedgerOperation;
+      ledger_operation?: LedgerOperation;
+      ledger_operations: LedgerOperation[];
       ledger_account_balance: LedgerAccountBalance;
       grant_blocks: GrantBlock[];
       ledger_entries: LedgerEntry[];
@@ -158,7 +163,9 @@ declare module 'chargebee' {
     export interface AllocateInputParam {
       subscription_id: string;
       unit_id: string;
+      id?: string;
       amount: string;
+      effective_from?: number;
       expires_at: number;
       metadata?: any;
     }

package/types/resources/Meter.d.ts

@@ -13,6 +13,7 @@ declare module 'chargebee' {
     updated_at?: number;
     column_definitions?: ColumnDefinition[];
     features?: Feature[];
+    group_by?: string[];
   }
 
   export namespace Meter {

package/types/resources/MeteredFeature.d.ts

@@ -10,6 +10,7 @@ declare module 'chargebee' {
     status?: StatusEnum;
     query?: string;
     column_definitions?: ColumnDefinition[];
+    group_by?: string[];
     features?: Feature[];
   }
 

package/types/resources/OmnichannelOneTimeOrder.d.ts

@@ -8,7 +8,11 @@ declare module 'chargebee' {
     customer_id?: string;
     id_at_source: string;
     origin?: string;
-    source: 'apple_app_store' | 'google_play_store';
+    source:
+      | 'apple_app_store'
+      | 'google_play_store'
+      | 'roku'
+      | 'amazon_app_store';
     created_at: number;
     resource_version?: number;
     omnichannel_one_time_order_items: OmnichannelOneTimeOrderItem[];

package/types/resources/OmnichannelSubscription.d.ts

@@ -6,8 +6,13 @@ declare module 'chargebee' {
     id: string;
     id_at_source: string;
     app_id: string;
-    source: 'apple_app_store' | 'google_play_store';
+    source:
+      | 'apple_app_store'
+      | 'google_play_store'
+      | 'roku'
+      | 'amazon_app_store';
     customer_id?: string;
+    origin?: string;
     created_at: number;
     purchased_at?: number;
     updated_at: number;

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -17,14 +17,21 @@ declare module 'chargebee' {
     current_term_start?: number;
     current_term_end?: number;
     expired_at?: number;
-    expiration_reason?: 'billing_error' | 'product_not_available' | 'other';
+    expiration_reason?:
+      | 'billing_error'
+      | 'product_not_available'
+      | 'other'
+      | 'subscription_not_found_in_source';
+    expiration_reason_at_source?: string;
     cancelled_at?: number;
     cancellation_reason?:
       | 'customer_cancelled'
       | 'customer_did_not_consent_to_price_increase'
       | 'refunded_due_to_app_issue'
       | 'refunded_for_other_reason'
-      | 'merchant_revoked';
+      | 'merchant_revoked'
+      | 'other';
+    cancellation_reason_at_source?: string;
     grace_period_expires_at?: number;
     resumes_at?: number;
     has_scheduled_changes: boolean;

package/types/resources/PaymentIntent.d.ts

@@ -62,7 +62,20 @@ declare module 'chargebee' {
       | 'dana'
       | 'touch_n_go'
       | 'tamara'
-      | 'qpay';
+      | 'qpay'
+      | 'ovo'
+      | 'momo'
+      | 'mercado_pago'
+      | 'nequi'
+      | 'nupay'
+      | 'picpay'
+      | 'thai_qr'
+      | 'blik'
+      | 'fpx'
+      | 'wero'
+      | 'p24'
+      | 'affirm_pay'
+      | 'rakuten_pay';
     success_url?: string;
     failure_url?: string;
     created_at: number;
@@ -76,6 +89,7 @@ declare module 'chargebee' {
     payment_attempts?: PaymentIntent.PaymentAttempt[];
     payment_intent_metadata?: PaymentIntent.PaymentIntentMetadata;
     business_entity_id?: string;
+    brand_id?: string;
   }
 
   export namespace PaymentIntent {
@@ -171,7 +185,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -244,7 +271,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -272,6 +312,7 @@ declare module 'chargebee' {
 
     export interface CreateInputParam {
       business_entity_id?: string;
+      brand_id?: string;
       customer_id?: string;
       amount: number;
       currency_code: string;
@@ -330,7 +371,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       success_url?: string;
       failure_url?: string;
       payment_method_options?: any;
@@ -391,7 +445,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       success_url?: string;
       failure_url?: string;
       payment_method_options?: any;

package/types/resources/PaymentSchedule.d.ts

@@ -1,6 +1,6 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface PaymentSchedule {
     id: string;
@@ -13,16 +13,53 @@ declare module 'chargebee' {
     updated_at?: number;
     currency_code?: string;
     schedule_entries?: PaymentSchedule.ScheduleEntry[];
+    reference_transactions?: PaymentSchedule.ReferenceTransaction[];
   }
 
   export namespace PaymentSchedule {
+    export class PaymentScheduleResource {
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface ListResponse {
+      list: { payment_schedule: PaymentSchedule }[];
+      next_offset?: string;
+    }
+
     export interface ScheduleEntry {
       id: string;
       date: number;
       amount: number;
-      status: 'posted' | 'payment_due' | 'paid';
+      scheduled_amount: number;
+      status: 'posted' | 'payment_due' | 'paid' | 'voided';
+    }
+    export interface ReferenceTransaction {
+      schedule_entry_id: string;
+      applied_amount?: number;
+      txn_id: string;
+      txn_status?:
+        | 'in_progress'
+        | 'success'
+        | 'voided'
+        | 'failure'
+        | 'timeout'
+        | 'needs_attention'
+        | 'late_failure';
+      txn_date?: number;
+      txn_amount?: number;
     }
     // REQUEST PARAMS
     //---------------
+
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      invoice_id?: filter.String;
+      id?: filter.String;
+      updated_at?: filter.Timestamp;
+    }
   }
 }

package/types/resources/PaymentScheduleEstimate.d.ts

@@ -17,7 +17,8 @@ declare module 'chargebee' {
       id: string;
       date: number;
       amount: number;
-      status: 'posted' | 'payment_due' | 'paid';
+      scheduled_amount: number;
+      status: 'posted' | 'payment_due' | 'paid' | 'voided';
     }
     // REQUEST PARAMS
     //---------------

package/types/resources/PaymentScheduleScheme.d.ts

@@ -1,6 +1,6 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface PaymentScheduleScheme {
     id: string;
@@ -27,6 +27,11 @@ declare module 'chargebee' {
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<RetrieveResponse>>;
 
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
       delete(
         payment_schedule_scheme_id: string,
         headers?: ChargebeeRequestHeader,
@@ -41,6 +46,11 @@ declare module 'chargebee' {
       payment_schedule_scheme: PaymentScheduleScheme;
     }
 
+    export interface ListResponse {
+      list: { payment_schedule_scheme: PaymentScheduleScheme }[];
+      next_offset?: string;
+    }
+
     export interface DeleteResponse {
       payment_schedule_scheme: PaymentScheduleScheme;
     }
@@ -59,6 +69,12 @@ declare module 'chargebee' {
       name: string;
       flexible_schedules?: FlexibleSchedulesCreateInputParam[];
     }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      updated_at?: filter.Timestamp;
+    }
     export interface FlexibleSchedulesCreateInputParam {
       period?: number;
       amount_percentage?: number;

package/types/resources/PaymentSource.d.ts

@@ -31,8 +31,10 @@ declare module 'chargebee' {
     klarna_pay_now?: PaymentSource.KlarnaPayNow;
     mandates?: PaymentSource.Mandate[];
     vault_token?: any;
+    network_transaction_reference?: PaymentSource.NetworkTransactionReference;
     deleted: boolean;
     business_entity_id?: string;
+    brand_id?: string;
   }
 
   export namespace PaymentSource {
@@ -314,6 +316,10 @@ declare module 'chargebee' {
       subscription_id: string;
       created_at: number;
     }
+    export interface NetworkTransactionReference {
+      original_network_transaction_id?: string;
+      transaction_link_id?: string;
+    }
     // REQUEST PARAMS
     //---------------
 
@@ -323,11 +329,13 @@ declare module 'chargebee' {
       type: TypeEnum;
       tmp_token: string;
       issuing_country?: string;
+      brand_id?: string;
       replace_primary_payment_source?: boolean;
       additional_information?: any;
     }
     export interface CreateUsingPermanentTokenInputParam {
       customer_id: string;
+      brand_id?: string;
       type: TypeEnum;
       gateway_account_id?: string;
       reference_id?: string;
@@ -340,29 +348,35 @@ declare module 'chargebee' {
       skip_retrieval?: boolean;
       additional_information?: any;
       card?: CardCreateUsingPermanentTokenInputParam;
+      bank_account?: BankAccountCreateUsingPermanentTokenInputParam;
       billing_address?: BillingAddressCreateUsingPermanentTokenInputParam;
     }
     export interface CreateUsingTokenInputParam {
       customer_id: string;
+      brand_id?: string;
       replace_primary_payment_source?: boolean;
       token_id: string;
     }
     export interface CreateUsingPaymentIntentInputParam {
       customer_id: string;
+      brand_id?: string;
       replace_primary_payment_source?: boolean;
       payment_intent?: PaymentIntentCreateUsingPaymentIntentInputParam;
     }
     export interface CreateVoucherPaymentSourceInputParam {
       customer_id: string;
+      brand_id?: string;
       voucher_payment_source?: VoucherPaymentSourceCreateVoucherPaymentSourceInputParam;
     }
     export interface CreateCardInputParam {
       customer_id: string;
+      brand_id?: string;
       replace_primary_payment_source?: boolean;
       card?: CardCreateCardInputParam;
     }
     export interface CreateBankAccountInputParam {
       customer_id: string;
+      brand_id?: string;
       issuing_country?: string;
       replace_primary_payment_source?: boolean;
       bank_account?: BankAccountCreateBankAccountInputParam;
@@ -371,6 +385,7 @@ declare module 'chargebee' {
       gateway_meta_data?: any;
       reference_transaction?: string;
       card?: CardUpdateCardInputParam;
+      network_transaction_reference?: NetworkTransactionReferenceUpdateCardInputParam;
     }
     export interface UpdateBankAccountInputParam {
       bank_account?: BankAccountUpdateBankAccountInputParam;
@@ -416,6 +431,23 @@ declare module 'chargebee' {
       zip?: string;
       country?: string;
     }
+    export interface BankAccountCreateUsingPermanentTokenInputParam {
+      account_type?: AccountTypeEnum;
+      account_holder_type?: AccountHolderTypeEnum;
+      first_name?: string;
+      last_name?: string;
+      company?: string;
+      scheme?:
+        | 'ach'
+        | 'bacs'
+        | 'sepa_core'
+        | 'autogiro'
+        | 'becs'
+        | 'becs_nz'
+        | 'pad';
+      last4?: string;
+      echeck_type?: EcheckTypeEnum;
+    }
     export interface CardCreateUsingPermanentTokenInputParam {
       last4?: string;
       iin?: string;
@@ -503,7 +535,20 @@ declare module 'chargebee' {
         | 'dana'
         | 'touch_n_go'
         | 'tamara'
-        | 'qpay';
+        | 'qpay'
+        | 'ovo'
+        | 'momo'
+        | 'mercado_pago'
+        | 'nequi'
+        | 'nupay'
+        | 'picpay'
+        | 'thai_qr'
+        | 'blik'
+        | 'fpx'
+        | 'wero'
+        | 'p24'
+        | 'affirm_pay'
+        | 'rakuten_pay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -528,7 +573,7 @@ declare module 'chargebee' {
       expiry_month: number;
       expiry_year: number;
       cvv?: string;
-      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa';
+      preferred_scheme?: 'cartes_bancaires' | 'mastercard' | 'visa' | 'dankort';
       billing_addr1?: string;
       billing_addr2?: string;
       billing_city?: string;
@@ -558,6 +603,9 @@ declare module 'chargebee' {
       billing_address?: any;
     }
 
+    export interface NetworkTransactionReferenceUpdateCardInputParam {
+      original_network_transaction_id?: string;
+    }
     export interface CardUpdateCardInputParam {
       first_name?: string;
       last_name?: string;

package/types/resources/PreferenceVariant.d.ts

@@ -0,0 +1,10 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PreferenceVariant {
+    value: string;
+    allow_override_in_interface?: boolean;
+    allow_override_in_api?: boolean;
+  }
+}

package/types/resources/PriceRamp.d.ts

@@ -0,0 +1,113 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface PriceRamp {
+    id: string;
+    item_price_id: string;
+    status: 'active' | 'archived' | 'deleted';
+    created_at: number;
+    resource_version?: number;
+    updated_at?: number;
+    archived_at?: number;
+    ramp_intervals?: PriceRamp.RampInterval[];
+    business_entity_id?: string;
+  }
+
+  export namespace PriceRamp {
+    export class PriceRampResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      retrieve(
+        price_ramp_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      update(
+        price_ramp_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        price_ramp_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+    }
+
+    export interface CreateResponse {
+      price_ramp: PriceRamp;
+    }
+
+    export interface RetrieveResponse {
+      price_ramp: PriceRamp;
+    }
+
+    export interface UpdateResponse {
+      price_ramp: PriceRamp;
+    }
+
+    export interface DeleteResponse {
+      price_ramp: PriceRamp;
+    }
+
+    export interface ListResponse {
+      list: { price_ramp: PriceRamp }[];
+      next_offset?: string;
+    }
+
+    export interface RampInterval {
+      starting_billing_cycle: number;
+      ending_billing_cycle?: number;
+      apply_catalog_price?: boolean;
+      price?: number;
+      price_in_decimal?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      item_price_id: string;
+      business_entity_id?: string;
+      ramp_intervals?: RampIntervalsCreateInputParam[];
+    }
+    export interface UpdateInputParam {
+      status?: 'active' | 'archived';
+      ramp_intervals?: RampIntervalsUpdateInputParam[];
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      item_price_id?: filter.String;
+      status?: filter.Enum;
+      updated_at?: filter.Timestamp;
+      business_entity_id?: filter.String;
+      include_site_level_resources?: filter.Boolean;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+    export interface RampIntervalsCreateInputParam {
+      starting_billing_cycle: number;
+      ending_billing_cycle?: number;
+      apply_catalog_price?: boolean;
+      price?: number;
+      price_in_decimal?: string;
+    }
+    export interface RampIntervalsUpdateInputParam {
+      starting_billing_cycle: number;
+      ending_billing_cycle?: number;
+      apply_catalog_price?: boolean;
+      price?: number;
+      price_in_decimal?: string;
+    }
+  }
+}

package/types/resources/PricingPageSession.d.ts

@@ -36,6 +36,7 @@ declare module 'chargebee' {
     export interface CreateForNewSubscriptionInputParam {
       redirect_url?: string;
       business_entity_id?: string;
+      brand_id?: string;
       auto_select_local_currency?: boolean;
       custom?: any;
       pricing_page?: PricingPageCreateForNewSubscriptionInputParam;

package/types/resources/PrivateNote.d.ts

@@ -0,0 +1,18 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PrivateNote {
+    id: string;
+    email_conversation_id: string;
+    author_type?: 'site_user' | 'agent' | 'other';
+    author_id?: string;
+    author_name?: string;
+    content_html: string;
+    content_text?: string;
+    meta_data?: string;
+    created_at: number;
+    resource_version?: number;
+    updated_at: number;
+  }
+}

package/types/resources/PromotionalGrant.d.ts

@@ -29,7 +29,9 @@ declare module 'chargebee' {
     export interface PromotionalGrantsInputParam {
       subscription_id: string;
       unit_id: string;
+      id?: string;
       amount: string;
+      effective_from?: number;
       expires_at: number;
       metadata?: any;
     }