chargebee 3.32.0 → 3.34.0

package/types/core.d.ts

@@ -162,9 +162,10 @@ declare module 'chargebee' {
     | 'omnichannel_one_time_order_item'
     | 'usage_file'
     | 'business_rule'
-    | 'ruleset'
+    | 'business_ruleset'
     | 'alert_status'
-    | 'omnichannel_subscription_item_metric';
+    | 'omnichannel_subscription_item_metric'
+    | 'price_ramp';
   type EventNameEnum = 'cancellation_page_loaded';
   type EventTypeEnum =
     | 'coupon_created'
@@ -225,6 +226,8 @@ declare module 'chargebee' {
     | 'credit_note_created_with_backdating'
     | 'credit_note_updated'
     | 'credit_note_deleted'
+    | 'einvoice_created'
+    | 'einvoice_updated'
     | 'payment_schedules_created'
     | 'payment_schedules_updated'
     | 'payment_schedule_scheme_created'
@@ -386,9 +389,21 @@ declare module 'chargebee' {
     | 'grant_blocks_created'
     | 'grant_blocks_updated'
     | 'ledger_updated'
+    | 'business_rule_created'
+    | 'business_rule_updated'
+    | 'business_rule_activated'
+    | 'business_rule_deactivated'
+    | 'business_rule_deleted'
+    | 'business_rule_released'
     | 'vault_token_created'
     | 'vault_token_updated'
     | 'vault_token_deleted'
+    | 'business_rules_applied'
+    | 'business_ruleset_created'
+    | 'business_ruleset_updated'
+    | 'business_ruleset_activated'
+    | 'business_ruleset_deactivated'
+    | 'business_ruleset_deleted'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'
@@ -459,6 +474,7 @@ declare module 'chargebee' {
     | 'tempus'
     | 'moyasar'
     | 'payway'
+    | 'payu'
     | 'gocardless'
     | 'not_applicable';
   type GatewayNameEnum =
@@ -522,6 +538,7 @@ declare module 'chargebee' {
     | 'tempus'
     | 'moyasar'
     | 'payway'
+    | 'payu'
     | 'not_applicable';
   type HierarchyOperationTypeEnum =
     | 'complete_hierarchy'
@@ -570,10 +587,12 @@ declare module 'chargebee' {
     | 'bank_transfer'
     | 'other'
     | 'custom'
-    | 'dana'
-    | 'touch_n_go'
     | 'tamara'
     | 'qpay'
+    | 'blik'
+    | 'fpx'
+    | 'wero'
+    | 'p24'
     | 'chargeback'
     | 'card'
     | 'amazon_payments'
@@ -626,7 +645,18 @@ declare module 'chargebee' {
     | 'south_korean_cards'
     | 'paynow'
     | 'bizum'
-    | 'promptpay';
+    | 'promptpay'
+    | 'dana'
+    | 'touch_n_go'
+    | 'ovo'
+    | 'momo'
+    | 'mercado_pago'
+    | 'nequi'
+    | 'nupay'
+    | 'picpay'
+    | 'thai_qr'
+    | 'affirm_pay'
+    | 'rakuten_pay';
   type PaymentMethodSavePolicyEnum = 'always' | 'ask' | 'never';
   type PaymentMethodTypeEnum =
     | 'card'
@@ -682,7 +712,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';
   type PaymentVoucherTypeEnum = 'boleto';
   type PeriodUnitEnum = 'day' | 'week' | 'month' | 'year';
   type PriceTypeEnum = 'tax_exclusive' | 'tax_inclusive';
@@ -723,12 +766,20 @@ declare module 'chargebee' {
     | 'migration'
     | 'external_service';
   type StatusEnum =
+    | 'scheduled'
+    | 'rescheduled'
+    | 'succeeded'
+    | 'failed'
+    | 'deferred'
+    | 'delivered'
+    | 'opened'
+    | 'bounced'
+    | 'dropped'
     | 'active'
     | 'archived'
     | 'deleted'
     | 'available'
     | 'exhausted'
-    | 'scheduled'
     | 'in_grace_period';
   type TaxExemptReasonEnum =
     | 'tax_not_configured'
@@ -760,7 +811,7 @@ declare module 'chargebee' {
     | 'high_value_physical_goods'
     | 'zero_value_item'
     | 'tax_not_configured_external_provider';
-  type TaxabilityEnum = 'taxable' | 'exempt';
+  type TaxabilityEnum = 'taxable' | 'exempt' | 'zero_rated';
   type TaxjarExemptionCategoryEnum = 'wholesale' | 'government' | 'other';
   type TrialEndActionEnum =
     | 'site_default'
@@ -822,6 +873,19 @@ declare module 'chargebee' {
     | 'touch_n_go'
     | 'tamara'
     | 'qpay'
+    | 'ovo'
+    | 'momo'
+    | 'mercado_pago'
+    | 'nequi'
+    | 'nupay'
+    | 'picpay'
+    | 'thai_qr'
+    | 'blik'
+    | 'fpx'
+    | 'wero'
+    | 'p24'
+    | 'affirm_pay'
+    | 'rakuten_pay'
     | 'free_trial'
     | 'pay_up_front'
     | 'pay_as_you_go'
@@ -907,6 +971,8 @@ declare module 'chargebee' {
     | 'credit_note_created_with_backdating'
     | 'credit_note_updated'
     | 'credit_note_deleted'
+    | 'einvoice_created'
+    | 'einvoice_updated'
     | 'payment_schedules_created'
     | 'payment_schedules_updated'
     | 'payment_schedule_scheme_created'
@@ -1068,9 +1134,21 @@ declare module 'chargebee' {
     | 'grant_blocks_created'
     | 'grant_blocks_updated'
     | 'ledger_updated'
+    | 'business_rule_created'
+    | 'business_rule_updated'
+    | 'business_rule_activated'
+    | 'business_rule_deactivated'
+    | 'business_rule_deleted'
+    | 'business_rule_released'
     | 'vault_token_created'
     | 'vault_token_updated'
     | 'vault_token_deleted'
+    | 'business_rules_applied'
+    | 'business_ruleset_created'
+    | 'business_ruleset_updated'
+    | 'business_ruleset_activated'
+    | 'business_ruleset_deactivated'
+    | 'business_ruleset_deleted'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'

package/types/index.d.ts

@@ -3,6 +3,9 @@
 ///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
 ///<reference path='./resources/Alert.d.ts' />
 ///<reference path='./resources/AlertStatus.d.ts' />
+///<reference path='./resources/AppliedBusinessRule.d.ts' />
+///<reference path='./resources/AppliedRule.d.ts' />
+///<reference path='./resources/ApplyRule.d.ts' />
 ///<reference path='./resources/AsyncResponse.d.ts' />
 ///<reference path='./resources/AsyncResponseList.d.ts' />
 ///<reference path='./resources/AttachedItem.d.ts' />
@@ -11,6 +14,9 @@
 ///<reference path='./resources/Brand.d.ts' />
 ///<reference path='./resources/BusinessEntity.d.ts' />
 ///<reference path='./resources/BusinessEntityTransfer.d.ts' />
+///<reference path='./resources/BusinessRule.d.ts' />
+///<reference path='./resources/BusinessRuleset.d.ts' />
+///<reference path='./resources/BusinessRulesetRule.d.ts' />
 ///<reference path='./resources/Card.d.ts' />
 ///<reference path='./resources/ColumnDefinition.d.ts' />
 ///<reference path='./resources/Comment.d.ts' />
@@ -25,12 +31,15 @@
 ///<reference path='./resources/CreditNoteEstimate.d.ts' />
 ///<reference path='./resources/CreditUnit.d.ts' />
 ///<reference path='./resources/Currency.d.ts' />
+///<reference path='./resources/CustomDataSchema.d.ts' />
 ///<reference path='./resources/Customer.d.ts' />
 ///<reference path='./resources/CustomerEntitlement.d.ts' />
 ///<reference path='./resources/DifferentialPrice.d.ts' />
 ///<reference path='./resources/Discount.d.ts' />
+///<reference path='./resources/Dispute.d.ts' />
 ///<reference path='./resources/Download.d.ts' />
 ///<reference path='./resources/Einvoice.d.ts' />
+///<reference path='./resources/EmailLog.d.ts' />
 ///<reference path='./resources/Entitlement.d.ts' />
 ///<reference path='./resources/EntitlementOverride.d.ts' />
 ///<reference path='./resources/Estimate.d.ts' />
@@ -284,6 +293,8 @@ declare module 'chargebee' {
     alertStatu: AlertStatus.AlertStatusResource;
     attachedItem: AttachedItem.AttachedItemResource;
     businessEntity: BusinessEntity.BusinessEntityResource;
+    businessRule: BusinessRule.BusinessRuleResource;
+    businessRuleset: BusinessRuleset.BusinessRulesetResource;
     card: Card.CardResource;
     comment: Comment.CommentResource;
     configuration: Configuration.ConfigurationResource;
@@ -296,6 +307,9 @@ declare module 'chargebee' {
     customer: Customer.CustomerResource;
     customerEntitlement: CustomerEntitlement.CustomerEntitlementResource;
     differentialPrice: DifferentialPrice.DifferentialPriceResource;
+    dispute: Dispute.DisputeResource;
+    einvoice: Einvoice.EinvoiceResource;
+    emailLog: EmailLog.EmailLogResource;
     entitlement: Entitlement.EntitlementResource;
     entitlementOverride: EntitlementOverride.EntitlementOverrideResource;
     estimate: Estimate.EstimateResource;
@@ -323,6 +337,7 @@ declare module 'chargebee' {
     omnichannelSubscriptionItem: OmnichannelSubscriptionItem.OmnichannelSubscriptionItemResource;
     order: Order.OrderResource;
     paymentIntent: PaymentIntent.PaymentIntentResource;
+    paymentSchedule: PaymentSchedule.PaymentScheduleResource;
     paymentScheduleScheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
     paymentSource: PaymentSource.PaymentSourceResource;
     paymentVoucher: PaymentVoucher.PaymentVoucherResource;

package/types/resources/AppliedBusinessRule.d.ts

@@ -0,0 +1,15 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface AppliedBusinessRule {
+    handle: string;
+    entity_type: 'cpq_quote';
+    entity_id: number;
+    entity_version?: number;
+    rule_id: string;
+    version: number;
+    created_at: number;
+    modified_at: number;
+  }
+}

package/types/resources/AppliedRule.d.ts

@@ -0,0 +1,14 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface AppliedRule {
+    id: string;
+    version?: number;
+    name?: string;
+    description?: string;
+    evaluation_result?: boolean;
+    error_message?: string;
+    actions?: any;
+  }
+}

package/types/resources/ApplyRule.d.ts

@@ -0,0 +1,28 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface ApplyRule {
+    evaluate?: boolean;
+    rule_id?: string;
+    ruleset_id?: string;
+    skip_failed_rules?: boolean;
+    structured_expression?: any;
+    context?: any;
+    rules?: ApplyRule.Rule[];
+  }
+
+  export namespace ApplyRule {
+    export interface Rule {
+      id: string;
+      version?: number;
+      name?: string;
+      description?: string;
+      evaluation_result?: boolean;
+      error_message?: string;
+      actions?: any[];
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/BusinessRule.d.ts

@@ -0,0 +1,161 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface BusinessRule {
+    id: string;
+    name: string;
+    description?: string;
+    latest_version?: number;
+    active: boolean;
+    released_at?: number;
+    released_by?: string;
+    updated_at: number;
+    updated_by?: string;
+    created_by: string;
+    created_at: number;
+    tags?: any;
+    structured_expression?: any;
+    actions_on_success?: any;
+    resource_version?: number;
+  }
+
+  export namespace BusinessRule {
+    export class BusinessRuleResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      delete(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      updateDraft(
+        business_rule_id: string,
+        input: UpdateDraftInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateDraftResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      retrieveDraft(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveDraftResponse>>;
+
+      deleteDraft(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteDraftResponse>>;
+
+      activateRule(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ActivateRuleResponse>>;
+
+      deactivateRule(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeactivateRuleResponse>>;
+
+      releaseRule(
+        business_rule_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ReleaseRuleResponse>>;
+
+      applyRules(
+        input?: ApplyRulesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ApplyRulesResponse>>;
+    }
+
+    export interface CreateResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface DeleteResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface UpdateDraftResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface ListResponse {
+      list: { business_rule: BusinessRule }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface RetrieveDraftResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface DeleteDraftResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface ActivateRuleResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface DeactivateRuleResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface ReleaseRuleResponse {
+      business_rule: BusinessRule;
+    }
+
+    export interface ApplyRulesResponse {
+      apply_rule: ApplyRule;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      id?: string;
+      name: string;
+      description?: string;
+      tags?: any;
+      structured_expression: any;
+      actions_on_success?: any;
+    }
+    export interface UpdateDraftInputParam {
+      name: string;
+      description?: string;
+      tags?: any;
+      structured_expression: any;
+      actions_on_success?: any;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      draft?: filter.Boolean;
+      active?: filter.Boolean;
+    }
+    export interface ApplyRulesInputParam {
+      evaluate?: boolean;
+      rule_id?: string;
+      ruleset_id?: string;
+      skip_failed_rules?: boolean;
+      structured_expression?: any;
+      context?: any;
+    }
+  }
+}

package/types/resources/BusinessRuleset.d.ts

@@ -0,0 +1,165 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface BusinessRuleset {
+    id: string;
+    name: string;
+    description?: string;
+    active: boolean;
+    execute_mode:
+      | 'stop_on_first_true'
+      | 'stop_on_first_false'
+      | 'execute_all'
+      | 'execute_all_true';
+    updated_at: number;
+    updated_by?: string;
+    created_by: string;
+    created_at: number;
+    rules?: any;
+    resource_version?: number;
+  }
+
+  export namespace BusinessRuleset {
+    export class BusinessRulesetResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        business_ruleset_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      delete(
+        business_ruleset_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      activate(
+        business_ruleset_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ActivateResponse>>;
+
+      deactivate(
+        business_ruleset_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeactivateResponse>>;
+
+      addRules(
+        business_ruleset_id: string,
+        input?: AddRulesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AddRulesResponse>>;
+
+      removeRules(
+        business_ruleset_id: string,
+        input?: RemoveRulesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RemoveRulesResponse>>;
+
+      listRules(
+        business_ruleset_id: string,
+        input?: ListRulesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListRulesResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        business_ruleset_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+    }
+
+    export interface CreateResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface UpdateResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface DeleteResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface ActivateResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface DeactivateResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface AddRulesResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface RemoveRulesResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    export interface ListRulesResponse {
+      business_ruleset_rule: BusinessRulesetRule;
+    }
+
+    export interface ListResponse {
+      list: { business_ruleset: BusinessRuleset }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      business_ruleset: BusinessRuleset;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      id?: string;
+      name: string;
+      description?: string;
+      execute_mode?:
+        | 'stop_on_first_true'
+        | 'stop_on_first_false'
+        | 'execute_all'
+        | 'execute_all_true';
+      rules?: any;
+    }
+    export interface UpdateInputParam {
+      name: string;
+      description?: string;
+      execute_mode?:
+        | 'stop_on_first_true'
+        | 'stop_on_first_false'
+        | 'execute_all'
+        | 'execute_all_true';
+      rules?: any;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface AddRulesInputParam {
+      rules?: any;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface RemoveRulesInputParam {
+      rules?: any;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface ListRulesInputParam {
+      limit?: number;
+      offset?: string;
+      active?: filter.Boolean;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      active?: filter.Boolean;
+    }
+  }
+}

package/types/resources/BusinessRulesetRule.d.ts

@@ -0,0 +1,9 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface BusinessRulesetRule {
+    rule_id: string;
+    priority: number;
+  }
+}

package/types/resources/Card.d.ts

@@ -139,7 +139,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;

package/types/resources/Content.d.ts

@@ -8,6 +8,9 @@ declare module 'chargebee' {
     advance_invoice_schedule: AdvanceInvoiceSchedule;
     alert: Alert;
     alert_status: AlertStatus;
+    applied_business_rule: AppliedBusinessRule;
+    applied_rule: AppliedRule;
+    apply_rule: ApplyRule;
     async_response: AsyncResponse;
     async_response_list: AsyncResponseList;
     attached_item: AttachedItem;
@@ -16,6 +19,9 @@ declare module 'chargebee' {
     brand: Brand;
     business_entity: BusinessEntity;
     business_entity_transfer: BusinessEntityTransfer;
+    business_rule: BusinessRule;
+    business_ruleset: BusinessRuleset;
+    business_ruleset_rule: BusinessRulesetRule;
     card: Card;
     column_definition: ColumnDefinition;
     comment: Comment;
@@ -30,12 +36,15 @@ declare module 'chargebee' {
     credit_note_estimate: CreditNoteEstimate;
     credit_unit: CreditUnit;
     currency: Currency;
+    custom_data_schema: CustomDataSchema;
     customer: Customer;
     customer_entitlement: CustomerEntitlement;
     differential_price: DifferentialPrice;
     discount: Discount;
+    dispute: Dispute;
     download: Download;
     einvoice: Einvoice;
+    email_log: EmailLog;
     entitlement: Entitlement;
     entitlement_override: EntitlementOverride;
     estimate: Estimate;