chargebee 3.12.0 → 3.14.0

package/types/resources/CreditNoteEstimate.d.ts

@@ -12,11 +12,11 @@ declare module 'chargebee' {
     amount_allocated: number;
     amount_available: number;
     line_items?: CreditNoteEstimate.LineItem[];
+    line_item_tiers?: CreditNoteEstimate.LineItemTier[];
+    line_item_discounts?: CreditNoteEstimate.LineItemDiscount[];
+    line_item_taxes?: CreditNoteEstimate.LineItemTax[];
     discounts?: CreditNoteEstimate.Discount[];
     taxes?: CreditNoteEstimate.Tax[];
-    line_item_taxes?: CreditNoteEstimate.LineItemTax[];
-    line_item_discounts?: CreditNoteEstimate.LineItemDiscount[];
-    line_item_tiers?: CreditNoteEstimate.LineItemTier[];
     round_off_amount?: number;
     customer_id?: string;
   }
@@ -71,24 +71,31 @@ declare module 'chargebee' {
       entity_id?: string;
       customer_id?: string;
     }
-    export interface Discount {
-      amount: number;
-      description?: string;
-      entity_type:
+    export interface LineItemTier {
+      line_item_id?: string;
+      starting_unit: number;
+      ending_unit?: number;
+      quantity_used: number;
+      unit_amount: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      quantity_used_in_decimal?: string;
+      unit_amount_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
+    }
+    export interface LineItemDiscount {
+      line_item_id: string;
+      discount_type:
         | 'item_level_coupon'
         | 'document_level_coupon'
         | 'promotional_credits'
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
-      discount_type?: 'fixed_amount' | 'percentage';
+      coupon_id?: string;
       entity_id?: string;
-      coupon_set_code?: string;
-    }
-    export interface Tax {
-      name: string;
-      amount: number;
-      description?: string;
+      discount_amount: number;
     }
     export interface LineItemTax {
       line_item_id?: string;
@@ -115,31 +122,24 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
-    export interface LineItemDiscount {
-      line_item_id: string;
-      discount_type:
+    export interface Discount {
+      amount: number;
+      description?: string;
+      entity_type:
         | 'item_level_coupon'
         | 'document_level_coupon'
         | 'promotional_credits'
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
-      coupon_id?: string;
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
-      discount_amount: number;
+      coupon_set_code?: string;
     }
-    export interface LineItemTier {
-      line_item_id?: string;
-      starting_unit: number;
-      ending_unit?: number;
-      quantity_used: number;
-      unit_amount: number;
-      starting_unit_in_decimal?: string;
-      ending_unit_in_decimal?: string;
-      quantity_used_in_decimal?: string;
-      unit_amount_in_decimal?: string;
-      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
-      package_size?: number;
+    export interface Tax {
+      name: string;
+      amount: number;
+      description?: string;
     }
     // REQUEST PARAMS
     //---------------

package/types/resources/Currency.d.ts

@@ -1,19 +1,20 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Currency {
-    id?: string;
+    id: string;
     enabled: boolean;
     forex_type?: 'manual' | 'auto';
-    currency_code?: string;
-    is_base_currency?: boolean;
+    currency_code: string;
+    is_base_currency: boolean;
     manual_exchange_rate?: string;
   }
 
   export namespace Currency {
     export class CurrencyResource {
       list(
+        input?: ListInputParam,
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<ListResponse>>;
 
@@ -46,7 +47,8 @@ declare module 'chargebee' {
     }
 
     export interface ListResponse {
-      currency: Currency;
+      list: { currency: Currency }[];
+      next_offset?: string;
     }
 
     export interface RetrieveResponse {
@@ -74,6 +76,10 @@ declare module 'chargebee' {
     // REQUEST PARAMS
     //---------------
 
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+    }
     export interface CreateInputParam {
       currency_code: string;
       forex_type: 'manual' | 'auto';

package/types/resources/Customer.d.ts

@@ -412,6 +412,7 @@ declare module 'chargebee' {
       unbilled_charges: number;
       currency_code: string;
       balance_currency_code: string;
+      business_entity_id?: string;
     }
     export interface EntityIdentifier {
       id: string;

package/types/resources/Estimate.d.ts

@@ -593,6 +593,7 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       coupon?: string;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       free_period?: number;
       free_period_unit?: FreePeriodUnitEnum;
       contract_term_billing_cycle_on_renewal?: number;
@@ -734,6 +735,7 @@ declare module 'chargebee' {
        */
       setup_fee?: number;
       start_date?: number;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       free_period?: number;
       free_period_unit?: FreePeriodUnitEnum;
       contract_term_billing_cycle_on_renewal?: number;

package/types/resources/Event.d.ts

@@ -20,7 +20,214 @@ declare module 'chargebee' {
     webhooks?: Event.Webhook[];
     event_type?: EventTypeEnum;
     api_version?: ApiVersionEnum;
-    content: any;
+    content: SubscriptionPauseScheduledContent &
+      CustomerBusinessEntityChangedContent &
+      SubscriptionAdvanceInvoiceScheduleAddedContent &
+      GiftExpiredContent &
+      TaxWithheldDeletedContent &
+      UnbilledChargesDeletedContent &
+      CouponUpdatedContent &
+      OmnichannelSubscriptionItemReactivatedContent &
+      OmnichannelSubscriptionItemRenewedContent &
+      UnbilledChargesCreatedContent &
+      SubscriptionResumedContent &
+      OmnichannelOneTimeOrderItemCancelledContent &
+      SubscriptionCancelledContent &
+      ItemEntitlementsRemovedContent &
+      BusinessEntityCreatedContent &
+      CouponSetUpdatedContent &
+      DifferentialPriceUpdatedContent &
+      OmnichannelSubscriptionItemPausedContent &
+      EntitlementOverridesRemovedContent &
+      SubscriptionActivatedWithBackdatingContent &
+      SubscriptionTrialEndReminderContent &
+      SubscriptionShippingAddressUpdatedContent &
+      VoucherCreateFailedContent &
+      GiftClaimedContent &
+      CustomerDeletedContent &
+      RefundInitiatedContent &
+      InvoiceGeneratedWithBackdatingContent &
+      AddUsagesReminderContent &
+      VoucherCreatedContent &
+      RuleUpdatedContent &
+      PaymentSchedulesCreatedContent &
+      FeatureActivatedContent &
+      PaymentSourceLocallyDeletedContent &
+      InvoiceGeneratedContent &
+      VoucherExpiredContent &
+      AuthorizationSucceededContent &
+      GiftScheduledContent &
+      SubscriptionChangesScheduledContent &
+      SubscriptionChangedWithBackdatingContent &
+      OmnichannelSubscriptionItemChangedContent &
+      GiftUnclaimedContent &
+      VirtualBankAccountAddedContent &
+      PaymentIntentCreatedContent &
+      CreditNoteCreatedWithBackdatingContent &
+      ContractTermTerminatedContent &
+      ItemFamilyUpdatedContent &
+      OrderCreatedContent &
+      PriceVariantDeletedContent &
+      SubscriptionMovementFailedContent &
+      CustomerMovedInContent &
+      SubscriptionAdvanceInvoiceScheduleUpdatedContent &
+      ItemDeletedContent &
+      SubscriptionRampDraftedContent &
+      DunningUpdatedContent &
+      ItemEntitlementsUpdatedContent &
+      TokenConsumedContent &
+      HierarchyDeletedContent &
+      SubscriptionCancellationScheduledContent &
+      SubscriptionRenewedContent &
+      FeatureUpdatedContent &
+      FeatureDeletedContent &
+      ItemFamilyCreatedContent &
+      OmnichannelSubscriptionItemScheduledChangeRemovedContent &
+      OmnichannelSubscriptionItemResumedContent &
+      PurchaseCreatedContent &
+      EntitlementOverridesUpdatedContent &
+      ItemFamilyDeletedContent &
+      SubscriptionResumptionScheduledContent &
+      FeatureReactivatedContent &
+      CouponCodesDeletedContent &
+      CardExpiredContent &
+      CreditNoteUpdatedContent &
+      OmnichannelSubscriptionItemDowngradedContent &
+      PriceVariantUpdatedContent &
+      PromotionalCreditsDeductedContent &
+      SubscriptionRampAppliedContent &
+      SubscriptionPausedContent &
+      OrderReadyToProcessContent &
+      FeatureCreatedContent &
+      TransactionDeletedContent &
+      CreditNoteCreatedContent &
+      OmnichannelSubscriptionItemResubscribedContent &
+      RecordPurchaseFailedContent &
+      ItemCreatedContent &
+      TransactionUpdatedContent &
+      MrrUpdatedContent &
+      UnbilledChargesInvoicedContent &
+      ItemPriceUpdatedContent &
+      CouponCodesUpdatedContent &
+      VirtualBankAccountUpdatedContent &
+      ContractTermCreatedContent &
+      SubscriptionChangedContent &
+      PaymentFailedContent &
+      CreditNoteDeletedContent &
+      TaxWithheldRefundedContent &
+      ContractTermCompletedContent &
+      PaymentSchedulesUpdatedContent &
+      OmnichannelSubscriptionItemExpiredContent &
+      CardUpdatedContent &
+      CustomerCreatedContent &
+      SubscriptionRenewalReminderContent &
+      OrderDeliveredContent &
+      OmnichannelSubscriptionItemCancellationScheduledContent &
+      OmnichannelSubscriptionItemGracePeriodExpiredContent &
+      CouponCodesAddedContent &
+      GiftCancelledContent &
+      OrderCancelledContent &
+      CouponDeletedContent &
+      SubscriptionScheduledChangesRemovedContent &
+      PendingInvoiceCreatedContent &
+      EntitlementOverridesAutoRemovedContent &
+      OmnichannelSubscriptionItemUpgradedContent &
+      SubscriptionBusinessEntityChangedContent &
+      OmnichannelOneTimeOrderCreatedContent &
+      PaymentSourceDeletedContent &
+      OmnichannelSubscriptionItemCancelledContent &
+      QuoteDeletedContent &
+      InvoiceUpdatedContent &
+      SubscriptionAdvanceInvoiceScheduleRemovedContent &
+      CardDeletedContent &
+      OrderReadyToShipContent &
+      SubscriptionMovedOutContent &
+      PaymentScheduleSchemeCreatedContent &
+      BusinessEntityUpdatedContent &
+      SubscriptionScheduledResumptionRemovedContent &
+      PaymentInitiatedContent &
+      FeatureArchivedContent &
+      SubscriptionReactivatedWithBackdatingContent &
+      OmnichannelSubscriptionImportedContent &
+      TokenExpiredContent &
+      CardAddedContent &
+      CouponCreatedContent &
+      RuleDeletedContent &
+      ItemPriceEntitlementsUpdatedContent &
+      ItemPriceDeletedContent &
+      VirtualBankAccountDeletedContent &
+      PaymentScheduleSchemeDeletedContent &
+      SubscriptionCreatedContent &
+      SubscriptionEntitlementsCreatedContent &
+      OrderReturnedContent &
+      SubscriptionDeletedContent &
+      PaymentSourceAddedContent &
+      SubscriptionMovedInContent &
+      ItemPriceCreatedContent &
+      SubscriptionScheduledCancellationRemovedContent &
+      PaymentRefundedContent &
+      UsageFileIngestedContent &
+      OmnichannelSubscriptionMovedInContent &
+      DifferentialPriceCreatedContent &
+      TransactionCreatedContent &
+      PaymentSucceededContent &
+      SubscriptionCanceledWithBackdatingContent &
+      UnbilledChargesVoidedContent &
+      QuoteCreatedContent &
+      CouponSetDeletedContent &
+      AttachedItemCreatedContent &
+      SalesOrderCreatedContent &
+      CustomerChangedContent &
+      SubscriptionStartedContent &
+      SubscriptionActivatedContent &
+      PaymentSourceExpiringContent &
+      SubscriptionReactivatedContent &
+      OrderUpdatedContent &
+      SubscriptionScheduledPauseRemovedContent &
+      SubscriptionCancellationReminderContent &
+      SubscriptionCreatedWithBackdatingContent &
+      SubscriptionRampCreatedContent &
+      OrderDeletedContent &
+      OmnichannelSubscriptionItemPauseScheduledContent &
+      GiftUpdatedContent &
+      SubscriptionTrialExtendedContent &
+      OmnichannelSubscriptionItemGracePeriodStartedContent &
+      CardExpiryReminderContent &
+      TokenCreatedContent &
+      PromotionalCreditsAddedContent &
+      SubscriptionRampUpdatedContent &
+      CustomerEntitlementsUpdatedContent &
+      PaymentSourceExpiredContent &
+      CustomerMovedOutContent &
+      SubscriptionEntitlementsUpdatedContent &
+      OmnichannelSubscriptionItemDunningExpiredContent &
+      HierarchyCreatedContent &
+      AttachedItemDeletedContent &
+      OmnichannelSubscriptionItemScheduledCancellationRemovedContent &
+      ItemUpdatedContent &
+      CouponSetCreatedContent &
+      PaymentIntentUpdatedContent &
+      OrderResentContent &
+      OmnichannelSubscriptionCreatedContent &
+      TaxWithheldRecordedContent &
+      PriceVariantCreatedContent &
+      DifferentialPriceDeletedContent &
+      SubscriptionItemsRenewedContent &
+      RuleCreatedContent &
+      ContractTermCancelledContent &
+      ContractTermRenewedContent &
+      InvoiceDeletedContent &
+      ItemPriceEntitlementsRemovedContent &
+      SalesOrderUpdatedContent &
+      OmnichannelSubscriptionItemDunningStartedContent &
+      OmnichannelSubscriptionItemChangeScheduledContent &
+      PendingInvoiceUpdatedContent &
+      QuoteUpdatedContent &
+      AttachedItemUpdatedContent &
+      PaymentSourceUpdatedContent &
+      BusinessEntityDeletedContent &
+      AuthorizationVoidedContent &
+      SubscriptionRampDeletedContent;
     origin_user?: string;
   }
 

package/types/resources/GatewayErrorDetail.d.ts

@@ -17,5 +17,6 @@ declare module 'chargebee' {
     processor_error_code?: string;
     processor_error_message?: string;
     error_cause_id?: string;
+    processor_advice_code?: string;
   }
 }

package/types/resources/HostedPage.d.ts

@@ -14,6 +14,7 @@ declare module 'chargebee' {
       | 'checkout_one_time'
       | 'pre_cancel'
       | 'view_voucher'
+      | 'accept_quote'
       | 'checkout_gift'
       | 'claim_gift';
     url?: string;
@@ -28,7 +29,7 @@ declare module 'chargebee' {
     embed: boolean;
     created_at?: number;
     expires_at?: number;
-    content: any;
+    content: Content;
     updated_at?: number;
     resource_version?: number;
     checkout_info?: any;
@@ -813,6 +814,7 @@ declare module 'chargebee' {
       start_date?: number;
       coupon?: string;
       auto_collection?: AutoCollectionEnum;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       invoice_notes?: string;
       po_number?: string;
       contract_term_billing_cycle_on_renewal?: number;

package/types/resources/Invoice.d.ts

@@ -3,6 +3,7 @@
 ///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Invoice {
+    [key: string]: unknown;
     id: string;
     customer_id: string;
     payment_owner?: string;
@@ -776,7 +777,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface BillingAddress {
       first_name?: string;
@@ -880,6 +880,7 @@ declare module 'chargebee' {
       notes_to_remove?: NotesToRemoveCreateForChargeItemsAndChargesInputParam[];
       tax_providers_fields?: TaxProvidersFieldsCreateForChargeItemsAndChargesInputParam[];
       discounts?: DiscountsCreateForChargeItemsAndChargesInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface ChargeInputParam {
       customer_id?: string;
@@ -985,6 +986,7 @@ declare module 'chargebee' {
       payments?: PaymentsImportInvoiceInputParam[];
       notes?: NotesImportInvoiceInputParam[];
       line_item_addresses?: LineItemAddressesImportInvoiceInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface ApplyPaymentsInputParam {
       comment?: string;
@@ -1083,6 +1085,7 @@ declare module 'chargebee' {
       remove_general_note?: boolean;
       invoice_date?: number;
       notes_to_remove?: NotesToRemoveCloseInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface CollectPaymentInputParam {
       amount?: number;
@@ -1137,6 +1140,7 @@ declare module 'chargebee' {
       billing_address?: BillingAddressUpdateDetailsInputParam;
       shipping_address?: ShippingAddressUpdateDetailsInputParam;
       statement_descriptor?: StatementDescriptorUpdateDetailsInputParam;
+      [key: `cf_${string}`]: unknown;
     }
     export interface ApplyPaymentScheduleSchemeInputParam {
       scheme_id: string;

package/types/resources/InvoiceEstimate.d.ts

@@ -12,15 +12,15 @@ declare module 'chargebee' {
     amount_paid?: number;
     amount_due?: number;
     line_items?: InvoiceEstimate.LineItem[];
-    discounts?: InvoiceEstimate.Discount[];
-    taxes?: InvoiceEstimate.Tax[];
-    line_item_taxes?: InvoiceEstimate.LineItemTax[];
     line_item_tiers?: InvoiceEstimate.LineItemTier[];
-    line_item_credits?: InvoiceEstimate.LineItemCredit[];
     line_item_discounts?: InvoiceEstimate.LineItemDiscount[];
+    line_item_taxes?: InvoiceEstimate.LineItemTax[];
+    line_item_credits?: InvoiceEstimate.LineItemCredit[];
+    line_item_addresses?: InvoiceEstimate.LineItemAddress[];
+    discounts?: InvoiceEstimate.Discount[];
+    taxes?: InvoiceEstimate.Tax[];
     round_off_amount?: number;
     customer_id?: string;
-    line_item_addresses?: InvoiceEstimate.LineItemAddress[];
   }
 
   export namespace InvoiceEstimate {
@@ -73,24 +73,31 @@ declare module 'chargebee' {
       entity_id?: string;
       customer_id?: string;
     }
-    export interface Discount {
-      amount: number;
-      description?: string;
-      entity_type:
+    export interface LineItemTier {
+      line_item_id?: string;
+      starting_unit: number;
+      ending_unit?: number;
+      quantity_used: number;
+      unit_amount: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      quantity_used_in_decimal?: string;
+      unit_amount_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
+    }
+    export interface LineItemDiscount {
+      line_item_id: string;
+      discount_type:
         | 'item_level_coupon'
         | 'document_level_coupon'
         | 'promotional_credits'
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
-      discount_type?: 'fixed_amount' | 'percentage';
+      coupon_id?: string;
       entity_id?: string;
-      coupon_set_code?: string;
-    }
-    export interface Tax {
-      name: string;
-      amount: number;
-      description?: string;
+      discount_amount: number;
     }
     export interface LineItemTax {
       line_item_id?: string;
@@ -117,37 +124,11 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
-    export interface LineItemTier {
-      line_item_id?: string;
-      starting_unit: number;
-      ending_unit?: number;
-      quantity_used: number;
-      unit_amount: number;
-      starting_unit_in_decimal?: string;
-      ending_unit_in_decimal?: string;
-      quantity_used_in_decimal?: string;
-      unit_amount_in_decimal?: string;
-      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
-      package_size?: number;
-    }
     export interface LineItemCredit {
       cn_id: string;
       applied_amount: number;
       line_item_id?: string;
     }
-    export interface LineItemDiscount {
-      line_item_id: string;
-      discount_type:
-        | 'item_level_coupon'
-        | 'document_level_coupon'
-        | 'promotional_credits'
-        | 'prorated_credits'
-        | 'item_level_discount'
-        | 'document_level_discount';
-      coupon_id?: string;
-      entity_id?: string;
-      discount_amount: number;
-    }
     export interface LineItemAddress {
       line_item_id?: string;
       first_name?: string;
@@ -169,6 +150,25 @@ declare module 'chargebee' {
         | 'partially_valid'
         | 'invalid';
     }
+    export interface Discount {
+      amount: number;
+      description?: string;
+      entity_type:
+        | 'item_level_coupon'
+        | 'document_level_coupon'
+        | 'promotional_credits'
+        | 'prorated_credits'
+        | 'item_level_discount'
+        | 'document_level_discount';
+      discount_type?: 'fixed_amount' | 'percentage';
+      entity_id?: string;
+      coupon_set_code?: string;
+    }
+    export interface Tax {
+      name: string;
+      amount: number;
+      description?: string;
+    }
     // REQUEST PARAMS
     //---------------
   }

package/types/resources/OfferEvent.d.ts

@@ -0,0 +1,25 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface OfferEvent {}
+
+  export namespace OfferEvent {
+    export class OfferEventResource {
+      offerEvents(
+        input: OfferEventsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<OfferEventsResponse>>;
+    }
+
+    export interface OfferEventsResponse {}
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface OfferEventsInputParam {
+      personalized_offer_id: string;
+      type: 'viewed' | 'dismissed';
+    }
+  }
+}