chargebee 3.25.0-beta.1 → 3.26.0

package/types/resources/Invoice.d.ts

@@ -1074,7 +1074,6 @@ declare module 'chargebee' {
       channel?: filter.Enum;
       voided_at?: filter.Timestamp;
       void_reason_code?: filter.String;
-      exclude?: filter.String;
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
     }
@@ -1283,14 +1282,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1449,14 +1453,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/LedgerAccountBalance.d.ts

@@ -0,0 +1,50 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface LedgerAccountBalance {
+    subscription_id: string;
+    unit_id: string;
+    unit_type: 'credit_unit';
+    modified_at?: number;
+    provisioned_balance?: LedgerAccountBalance.ProvisionedBalance;
+    overdraft_balance?: LedgerAccountBalance.OverdraftBalance;
+  }
+
+  export namespace LedgerAccountBalance {
+    export class LedgerAccountBalanceResource {
+      listLedgerAccountBalances(
+        input: ListLedgerAccountBalancesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListLedgerAccountBalancesResponse>>;
+    }
+
+    export interface ListLedgerAccountBalancesResponse {
+      list: { ledger_account_balance: LedgerAccountBalance }[];
+      next_offset?: string;
+    }
+
+    export interface ProvisionedBalance {
+      total_balance: string;
+      usable_balance: string;
+      hold_amount: string;
+    }
+    export interface OverdraftBalance {
+      is_unlimited: boolean;
+      limit?: string;
+      total_balance?: string;
+      usable_balance?: string;
+      used_amount: string;
+      hold_amount: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListLedgerAccountBalancesInputParam {
+      limit?: number;
+      offset?: string;
+      subscription_id: filter.String;
+      unit_id?: filter.String;
+    }
+  }
+}

package/types/resources/LedgerOperation.d.ts

@@ -0,0 +1,141 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface LedgerOperation {
+    id: string;
+    type:
+      | 'allocation'
+      | 'capture'
+      | 'authorize'
+      | 'release_authorization'
+      | 'capture_authorization'
+      | 'expiry'
+      | 'void'
+      | 'rollover'
+      | 'adjustment';
+    amount: string;
+    start_balance: string;
+    end_balance: string;
+    provisioned_start_balance: string;
+    provisioned_end_balance: string;
+    overdraft_start_balance: string;
+    overdraft_end_balance: string;
+    parent_ledger_operation_id?: string;
+    ledger_operation_timestamp?: number;
+    auto_release_timestamp?: number;
+    metadata?: string;
+    created_at?: number;
+    modified_at?: number;
+    subscription_id?: string;
+    unit_id?: string;
+    unit_type?: 'credit_unit';
+  }
+
+  export namespace LedgerOperation {
+    export class LedgerOperationResource {
+      retrieveLedgerOperation(
+        ledger_operation_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveLedgerOperationResponse>>;
+
+      listLedgerOperations(
+        input: ListLedgerOperationsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListLedgerOperationsResponse>>;
+
+      capture(
+        input: CaptureInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CaptureResponse>>;
+
+      authorize(
+        input: AuthorizeInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AuthorizeResponse>>;
+
+      captureAuthorization(
+        input: CaptureAuthorizationInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CaptureAuthorizationResponse>>;
+
+      releaseAuthorization(
+        input: ReleaseAuthorizationInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ReleaseAuthorizationResponse>>;
+    }
+
+    export interface RetrieveLedgerOperationResponse {
+      ledger_operation: LedgerOperation;
+    }
+
+    export interface ListLedgerOperationsResponse {
+      list: { ledger_operation: LedgerOperation }[];
+      next_offset?: string;
+    }
+
+    export interface CaptureResponse {
+      ledger_operation: LedgerOperation;
+      ledger_account_balance: LedgerAccountBalance;
+    }
+
+    export interface AuthorizeResponse {
+      ledger_operation: LedgerOperation;
+      ledger_account_balance: LedgerAccountBalance;
+    }
+
+    export interface CaptureAuthorizationResponse {
+      ledger_operation: LedgerOperation;
+      ledger_account_balance: LedgerAccountBalance;
+    }
+
+    export interface ReleaseAuthorizationResponse {
+      ledger_operation: LedgerOperation;
+      ledger_account_balance: LedgerAccountBalance;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListLedgerOperationsInputParam {
+      limit?: number;
+      offset?: string;
+      subscription_id: filter.String;
+      unit_id?: filter.String;
+      created_at?: filter.Timestamp;
+      type?: filter.Enum;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+    export interface CaptureInputParam {
+      id?: string;
+      subscription_id: string;
+      unit_id: string;
+      amount: string;
+      ledger_operation_timestamp: number;
+      metadata?: any;
+    }
+    export interface AuthorizeInputParam {
+      id?: string;
+      subscription_id: string;
+      unit_id: string;
+      amount: string;
+      ledger_operation_timestamp: number;
+      auto_release_timestamp?: number;
+      metadata?: any;
+    }
+    export interface CaptureAuthorizationInputParam {
+      authorization_id: string;
+      id?: string;
+      amount: string;
+      ledger_operation_timestamp: number;
+      metadata?: any;
+    }
+    export interface ReleaseAuthorizationInputParam {
+      authorization_id: string;
+      id?: string;
+      ledger_operation_timestamp: number;
+      metadata?: any;
+    }
+  }
+}

package/types/resources/OmnichannelSubscription.d.ts

@@ -9,6 +9,8 @@ declare module 'chargebee' {
     source: 'apple_app_store' | 'google_play_store';
     customer_id?: string;
     created_at: number;
+    purchased_at?: number;
+    updated_at: number;
     resource_version?: number;
     omnichannel_subscription_items: OmnichannelSubscriptionItem[];
     initial_purchase_transaction?: OmnichannelTransaction;
@@ -68,6 +70,12 @@ declare module 'chargebee' {
       omnichannel_subscription_item?: OmnichannelSubscriptionItemOmnichannelSubscriptionListInputParam;
       source?: filter.Enum;
       customer_id?: filter.String;
+      id?: filter.String;
+      id_at_source?: filter.String;
+      updated_at?: filter.Timestamp;
+      purchased_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
     }
     export interface OmnichannelTransactionsForOmnichannelSubscriptionInputParam {
       limit?: number;

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -28,6 +28,7 @@ declare module 'chargebee' {
     grace_period_expires_at?: number;
     resumes_at?: number;
     has_scheduled_changes: boolean;
+    updated_at: number;
     resource_version?: number;
     omnichannel_subscription_item_offers?: OmnichannelSubscriptionItemOffer[];
     upcoming_renewal?: OmnichannelSubscriptionItem.UpcomingRenewal;

package/types/resources/PaymentIntent.d.ts

@@ -43,14 +43,19 @@ declare module 'chargebee' {
       | 'cash_app_pay'
       | 'wechat_pay'
       | 'alipay'
-      | 'pix'
       | 'twint'
       | 'go_pay'
       | 'grab_pay'
       | 'pay_co'
       | 'after_pay'
       | 'swish'
-      | 'payme';
+      | 'payme'
+      | 'pix'
+      | 'klarna'
+      | 'alipay_hk'
+      | 'paypay'
+      | 'gcash'
+      | 'south_korean_cards';
     success_url?: string;
     failure_url?: string;
     created_at: number;
@@ -138,14 +143,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -197,14 +207,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -257,14 +272,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       success_url?: string;
       failure_url?: string;
     }
@@ -305,14 +325,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       success_url?: string;
       failure_url?: string;
     }

package/types/resources/PaymentSource.d.ts

@@ -467,14 +467,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/PromotionalGrant.d.ts

@@ -0,0 +1,37 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface PromotionalGrant {
+    subscription_id: string;
+    unit_id: string;
+    amount: string;
+    expires_at: number;
+    metadata?: string;
+  }
+
+  export namespace PromotionalGrant {
+    export class PromotionalGrantResource {
+      promotionalGrants(
+        input: PromotionalGrantsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<PromotionalGrantsResponse>>;
+    }
+
+    export interface PromotionalGrantsResponse {
+      ledger_operations: LedgerOperation[];
+      grant_blocks: GrantBlock[];
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface PromotionalGrantsInputParam {
+      subscription_id: string;
+      unit_id: string;
+      amount: string;
+      expires_at: number;
+      metadata?: any;
+    }
+  }
+}

package/types/resources/Purchase.d.ts

@@ -110,14 +110,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/Subscription.d.ts

@@ -1419,14 +1419,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1566,14 +1571,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1680,14 +1690,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1849,14 +1864,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -2032,14 +2052,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -2171,14 +2196,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -2616,14 +2646,19 @@ declare module 'chargebee' {
         | 'cash_app_pay'
         | 'wechat_pay'
         | 'alipay'
-        | 'pix'
         | 'twint'
         | 'go_pay'
         | 'grab_pay'
         | 'pay_co'
         | 'after_pay'
         | 'swish'
-        | 'payme';
+        | 'payme'
+        | 'pix'
+        | 'klarna'
+        | 'alipay_hk'
+        | 'paypay'
+        | 'gcash'
+        | 'south_korean_cards';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes