chargebee 2.31.0 → 2.33.0

package/CHANGELOG.md

@@ -1,3 +1,35 @@
+### v2.33.0 (2024-02-29)
+* * *
+
+#### New attributes:
+* usage_percentage has been added to QuoteLineGroup resource.
+* usage_percentage has been added to Quote resource.
+* usage_percentage has been added to CreditNoteEstimate resource.
+* usage_percentage has been added to CreditNote resource.
+* usage_percentage has been added to InvoiceEstimate resource.
+* usage_percentage has been added to Invoice resource.
+* error_detail of type GatewayErrorDetail has been added to PaymentIntent#PaymentAttempt subResource.
+* origin_user has been added to Event resource.
+* proration_type has been added to QuotedSubscription#SubscriptionItem and Subscription#SubscriptionItem subResources
+* network_error_message, recommendation_message, processor_error_code, processor_error_message has been added to Transaction#GatewayErrorDetail subResource.
+
+#### New Enum values:
+* TAX_NOT_CONFIGURED_EXTERNAL_PROVIDER has been added to TaxExemptReasonEnum.
+
+#### New Input parameters:
+* billing_address has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
+* transactions[amount] has been added to Invoice#ApplyPaymentsRequest.
+
+### v2.32.0 (2024-01-31)
+* * *
+
+#### New Enum values:
+* item_price_entitlements_updated has been added to EventTypeEnum.
+* item_price_entitlements_removed has been added to EventTypeEnum.
+
+#### New Input parameters:
+* layout has been added to HostedPage#AcceptQuoteRequest in HostedPage resource.
+
 ### v2.31.0 (2024-01-04)
 * * *
 
@@ -15,7 +47,6 @@
 * active_id has been added to customers.
 * active_id has been added to subscriptions.
 * reference_id has been made optional for payment_sources/create_using_permanent_token
-* payment_method_token, customer_profile_token, network_transaction_id, mandate_id, skip_retrieval, card, billing_address has been added to payment_sources.
 * custom_payment_method_id has been added to transactions.
 * custom_payment_method_name has been added to transactions.
 * error_detail has been added to transactions.
@@ -25,9 +56,6 @@
 * CMR_FALABELLA, TARJETA_NARANJA, NATIVA, CENCOSUD, CABAL, ARGENCARD, ELO, HIPERCARD, CARNET, RUPAY, MAESTRO has been added to Card#CardTypeEnum
 * Transferred has been added to Subscription#StatusEnum.
 * Transferred has been added to SubscriptionEstimate#StatusEnum.
-* proration_type has been added to Subscription#UpdateForItemsRequest.
-* proration_type has been added to ItemPrice.
-* payment_initiator has been added to Invoice.
 * AutomatedBankTransfer has been added to PaymentMethodEnum.
 * UsAutomatedBankTransfer, GbAutomatedBankTransfer, EuAutomatedBankTransfer, JpAutomatedBankTransfer, MxAutomatedBankTransfer has been added to VirtualBankAccount#SchemeEnum.
 * CustomerBusinessEntityChanged, SubscriptionBusinessEntityChanged has been added to EventTypeEnum.
@@ -39,16 +67,9 @@
 #### New Input parameters:
 * custom_payment_method_name has been added to Transactions#RecordRefundRequest.
 * proration_type has been added to Subscription#UpdateForItemsRequest.
+* proration_type has been added to ItemPrice.
+* payment_initiator has been added to Invoice.
 * payment_method_token, customer_profile_token, network_transaction_id, mandate_id, skip_retrieval, card, billing_address has been added to PaymentSource#CreateUsingPermanentTokenRequest.
-* date_to, date_from, prorated_taxable_amount has been added to QuoteLineGroup#LineItemTax.
-* date_to, date_from, prorated_taxable_amount has been added to Quote#LineItemTax.
-* date_to, date_from, prorated_taxable_amount has been added to CreditNoteEstimate#LineItemTax.
-* date_to, date_from, prorated_taxable_amount has been added to CreditNote#LineItemTax.
-* date_to, date_from, prorated_taxable_amount has been added to InvoiceEstimate#LineItemTax.
-* date_to, date_from, prorated_taxable_amount has been added to Order#LineItemTax.
-* date_to, date_from, prorated_taxable_amount has been added to Invoice#LineItemTax.
-* active_id has been added to Customer.
-* active_id has been added to Subscription.
 * subscription_items[proration_type] has been added to Estimate#UpdateSubscriptionForItemsRequest.
 * transaction[custom_payment_method_id] has been added to Customer#RecordExcessPaymentRequest.
 * transaction[custom_payment_method_id] has been added to CreditNote#RecordRefundRequest.

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011-2023 ChargeBee, Inc.
+Copyright (c) 2011-2024 ChargeBee, Inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

package/lib/chargebee.js

@@ -11,7 +11,7 @@ ChargeBee._env = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: 80000,
-    clientVersion: 'v2.31.0',
+    clientVersion: 'v2.33.0',
     port: 443,
     timemachineWaitInMillis: 3000,
     exportWaitInMillis: 3000

package/lib/resources/api_endpoints.js

@@ -2092,20 +2092,24 @@ var _endpoints = {
       true
     ]
   ],
-  "site_migration_detail": [[
-    "list",
-    "GET",
-    "/site_migration_details",
-    null,
-    false
-  ]],
-  "resource_migration": [[
-    "retrieve_latest",
-    "GET",
-    "/resource_migrations",
-    "/retrieve_latest",
-    false
-  ]],
+  "site_migration_detail": [
+    [
+      "list",
+      "GET",
+      "/site_migration_details",
+      null,
+      false
+    ]
+  ],
+  "resource_migration": [
+    [
+      "retrieve_latest",
+      "GET",
+      "/resource_migrations",
+      "/retrieve_latest",
+      false
+    ]
+  ],
   "time_machine": [
     [
       "retrieve",
@@ -2273,6 +2277,7 @@ var _endpoints = {
       true
     ]
   ],
+  "gateway_error_detail": [],
   "item_family": [
     [
       "create",
@@ -2685,6 +2690,6 @@ var _endpoints = {
       "/payment_vouchers",
       true
     ]
-  ],
+  ]
 };
 module.exports = _endpoints;

package/package.json

@@ -1,6 +1,6 @@
 {
    "name":"chargebee",
-   "version":"2.31.0",
+   "version":"2.33.0",
    "description":"A library for integrating with ChargeBee.",
    "keywords":[
       "payments",

package/types/core.d.ts

@@ -42,7 +42,7 @@ declare module 'chargebee' {
   type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med2' | 'med1'
   type EntityType = 'item' | 'product' | 'coupon' | 'addon' | 'item_price' | 'business_entity' | 'subscription' | 'item_family' | 'credit_note' | 'quote' | 'variant' | 'invoice' | 'plan' | 'transaction' | 'customer' | 'order'
   type EventName = 'cancellation_page_loaded'
-  type EventType = 'subscription_pause_scheduled' | 'order_delivered' | 'subscription_advance_invoice_schedule_added' | 'gift_expired' | 'tax_withheld_deleted' | 'coupon_codes_added' | 'unbilled_charges_deleted' | 'gift_cancelled' | 'coupon_updated' | 'order_cancelled' | 'coupon_deleted' | 'product_updated' | 'subscription_scheduled_changes_removed' | 'pending_invoice_created' | 'product_deleted' | 'entitlement_overrides_auto_removed' | 'unbilled_charges_created' | 'subscription_resumed' | 'subscription_cancelled' | 'item_entitlements_removed' | 'business_entity_created' | 'payment_source_deleted' | 'quote_deleted' | 'invoice_updated' | 'coupon_set_updated' | 'differential_price_updated' | 'subscription_advance_invoice_schedule_removed' | 'entitlement_overrides_removed' | 'subscription_activated_with_backdating' | 'card_deleted' | 'order_ready_to_ship' | 'subscription_trial_end_reminder' | 'subscription_shipping_address_updated' | 'variant_updated' | 'voucher_create_failed' | 'gift_claimed' | 'business_entity_updated' | 'subscription_scheduled_resumption_removed' | 'payment_initiated' | 'feature_archived' | 'subscription_reactivated_with_backdating' | 'customer_deleted' | 'token_expired' | 'card_added' | 'coupon_created' | 'refund_initiated' | 'invoice_generated_with_backdating' | 'add_usages_reminder' | 'item_price_deleted' | 'virtual_bank_account_deleted' | 'subscription_created' | 'voucher_created' | 'feature_activated' | 'subscription_entitlements_created' | 'payment_source_locally_deleted' | 'order_returned' | 'subscription_deleted' | 'invoice_generated' | 'voucher_expired' | 'authorization_succeeded' | 'payment_source_added' | 'gift_scheduled' | 'item_price_created' | 'subscription_changes_scheduled' | 'subscription_changed_with_backdating' | 'variant_created' | 'subscription_scheduled_cancellation_removed' | 'payment_refunded' | 'gift_unclaimed' | 'product_created' | 'differential_price_created' | 'virtual_bank_account_added' | 'payment_intent_created' | 'transaction_created' | 'credit_note_created_with_backdating' | 'contract_term_terminated' | 'item_family_updated' | 'order_created' | 'payment_succeeded' | 'plan_deleted' | 'subscription_canceled_with_backdating' | 'unbilled_charges_voided' | 'quote_created' | 'customer_moved_in' | 'coupon_set_deleted' | 'subscription_advance_invoice_schedule_updated' | 'attached_item_created' | 'customer_changed' | 'subscription_started' | 'item_deleted' | 'subscription_activated' | 'payment_source_expiring' | 'subscription_reactivated' | 'order_updated' | 'subscription_scheduled_pause_removed' | 'subscription_cancellation_reminder' | 'addon_deleted' | 'subscription_created_with_backdating' | 'order_deleted' | 'item_entitlements_updated' | 'token_consumed' | 'addon_updated' | 'hierarchy_deleted' | 'subscription_cancellation_scheduled' | 'gift_updated' | 'subscription_trial_extended' | 'subscription_renewed' | 'feature_updated' | 'addon_created' | 'feature_deleted' | 'item_family_created' | 'card_expiry_reminder' | 'token_created' | 'purchase_created' | 'plan_created' | 'entitlement_overrides_updated' | 'plan_updated' | 'promotional_credits_added' | 'item_family_deleted' | 'subscription_resumption_scheduled' | 'feature_reactivated' | 'coupon_codes_deleted' | 'card_expired' | 'credit_note_updated' | 'promotional_credits_deducted' | 'payment_source_expired' | 'customer_moved_out' | 'subscription_paused' | 'order_ready_to_process' | 'feature_created' | 'hierarchy_created' | 'attached_item_deleted' | 'transaction_deleted' | 'credit_note_created' | 'item_updated' | 'item_created' | 'coupon_set_created' | 'transaction_updated' | 'payment_intent_updated' | 'variant_deleted' | 'mrr_updated' | 'order_resent' | 'unbilled_charges_invoiced' | 'tax_withheld_recorded' | 'item_price_updated' | 'differential_price_deleted' | 'coupon_codes_updated' | 'virtual_bank_account_updated' | 'contract_term_created' | 'subscription_changed' | 'contract_term_cancelled' | 'contract_term_renewed' | 'invoice_deleted' | 'payment_failed' | 'credit_note_deleted' | 'tax_withheld_refunded' | 'contract_term_completed' | 'card_updated' | 'customer_created' | 'pending_invoice_updated' | 'quote_updated' | 'subscription_renewal_reminder' | 'attached_item_updated' | 'payment_source_updated' | 'business_entity_deleted' | 'authorization_voided'
+  type EventType = 'subscription_pause_scheduled' | 'order_delivered' | 'customer_business_entity_changed' | 'subscription_advance_invoice_schedule_added' | 'gift_expired' | 'tax_withheld_deleted' | 'coupon_codes_added' | 'unbilled_charges_deleted' | 'gift_cancelled' | 'coupon_updated' | 'order_cancelled' | 'coupon_deleted' | 'product_updated' | 'subscription_scheduled_changes_removed' | 'pending_invoice_created' | 'product_deleted' | 'entitlement_overrides_auto_removed' | 'unbilled_charges_created' | 'subscription_resumed' | 'subscription_business_entity_changed' | 'subscription_cancelled' | 'item_entitlements_removed' | 'business_entity_created' | 'payment_source_deleted' | 'quote_deleted' | 'invoice_updated' | 'coupon_set_updated' | 'differential_price_updated' | 'subscription_advance_invoice_schedule_removed' | 'entitlement_overrides_removed' | 'subscription_activated_with_backdating' | 'card_deleted' | 'order_ready_to_ship' | 'subscription_trial_end_reminder' | 'subscription_shipping_address_updated' | 'variant_updated' | 'voucher_create_failed' | 'gift_claimed' | 'business_entity_updated' | 'subscription_scheduled_resumption_removed' | 'payment_initiated' | 'feature_archived' | 'subscription_reactivated_with_backdating' | 'customer_deleted' | 'token_expired' | 'card_added' | 'coupon_created' | 'refund_initiated' | 'invoice_generated_with_backdating' | 'add_usages_reminder' | 'item_price_entitlements_updated' | 'item_price_deleted' | 'virtual_bank_account_deleted' | 'subscription_created' | 'voucher_created' | 'feature_activated' | 'subscription_entitlements_created' | 'payment_source_locally_deleted' | 'order_returned' | 'subscription_deleted' | 'invoice_generated' | 'voucher_expired' | 'authorization_succeeded' | 'payment_source_added' | 'gift_scheduled' | 'item_price_created' | 'subscription_changes_scheduled' | 'subscription_changed_with_backdating' | 'variant_created' | 'subscription_scheduled_cancellation_removed' | 'payment_refunded' | 'gift_unclaimed' | 'product_created' | 'differential_price_created' | 'virtual_bank_account_added' | 'payment_intent_created' | 'transaction_created' | 'credit_note_created_with_backdating' | 'contract_term_terminated' | 'item_family_updated' | 'order_created' | 'payment_succeeded' | 'subscription_canceled_with_backdating' | 'unbilled_charges_voided' | 'quote_created' | 'customer_moved_in' | 'coupon_set_deleted' | 'subscription_advance_invoice_schedule_updated' | 'attached_item_created' | 'customer_changed' | 'subscription_started' | 'item_deleted' | 'subscription_activated' | 'payment_source_expiring' | 'subscription_reactivated' | 'order_updated' | 'subscription_scheduled_pause_removed' | 'subscription_cancellation_reminder' | 'subscription_created_with_backdating' | 'order_deleted' | 'item_entitlements_updated' | 'token_consumed' | 'hierarchy_deleted' | 'subscription_cancellation_scheduled' | 'gift_updated' | 'subscription_trial_extended' | 'subscription_renewed' | 'feature_updated' | 'feature_deleted' | 'item_family_created' | 'card_expiry_reminder' | 'token_created' | 'purchase_created' | 'entitlement_overrides_updated' | 'promotional_credits_added' | 'item_family_deleted' | 'subscription_resumption_scheduled' | 'feature_reactivated' | 'coupon_codes_deleted' | 'card_expired' | 'credit_note_updated' | 'promotional_credits_deducted' | 'payment_source_expired' | 'customer_moved_out' | 'subscription_paused' | 'order_ready_to_process' | 'feature_created' | 'hierarchy_created' | 'attached_item_deleted' | 'transaction_deleted' | 'credit_note_created' | 'item_updated' | 'item_created' | 'coupon_set_created' | 'transaction_updated' | 'payment_intent_updated' | 'variant_deleted' | 'mrr_updated' | 'order_resent' | 'unbilled_charges_invoiced' | 'tax_withheld_recorded' | 'item_price_updated' | 'differential_price_deleted' | 'coupon_codes_updated' | 'virtual_bank_account_updated' | 'contract_term_created' | 'subscription_changed' | 'contract_term_cancelled' | 'contract_term_renewed' | 'invoice_deleted' | 'payment_failed' | 'credit_note_deleted' | 'tax_withheld_refunded' | 'contract_term_completed' | 'item_price_entitlements_removed' | 'card_updated' | 'customer_created' | 'pending_invoice_updated' | 'quote_updated' | 'subscription_renewal_reminder' | 'attached_item_updated' | 'payment_source_updated' | 'business_entity_deleted' | 'authorization_voided' | 'plan_deleted' | 'addon_deleted' | 'addon_updated' | 'addon_created' | 'plan_created' | 'entitlement_overrides_updated' | 'plan_updated'
   type ExportType = 'data' | 'import_friendly_data'
   type FreePeriodUnit = 'week' | 'month' | 'year' | 'day'
   type FriendOfferType = 'coupon_code' | 'coupon' | 'none'
@@ -73,7 +73,7 @@ declare module 'chargebee' {
   type Role = 'backup' | 'none' | 'primary'
   type ScheduleType = 'immediate' | 'specific_dates' | 'fixed_intervals'
   type Source = 'admin_console' | 'system' | 'scheduled_job' | 'js_api' | 'bulk_operation' | 'hosted_page' | 'migration' | 'api' | 'none' | 'portal' | 'external_service'
-  type TaxExemptReason = 'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt'
+  type TaxExemptReason = 'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'tax_not_configured_external_provider' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt'
   type TaxJurisType = 'special' | 'country' | 'unincorporated' | 'other' | 'city' | 'federal' | 'county' | 'state'
   type TaxOverrideReason = 'id_exempt' | 'customer_exempt' | 'export'
   type Taxability = 'taxable' | 'exempt'

package/types/index.d.ts

@@ -20,6 +20,7 @@
 ///<reference path='./resources/Event.d.ts' />
 ///<reference path='./resources/Export.d.ts' />
 ///<reference path='./resources/Feature.d.ts' />
+///<reference path='./resources/GatewayErrorDetail.d.ts' />
 ///<reference path='./resources/Gift.d.ts' />
 ///<reference path='./resources/Hierarchy.d.ts' />
 ///<reference path='./resources/HostedPage.d.ts' />

package/types/resources/CreditNote.d.ts

@@ -511,7 +511,7 @@ This endpoint schedules e-invoices manually. This operation is not allowed when
 
         */
        
-      line_items?:{amount?:number,date_from?:number,date_to?:number,description?:string,quantity?:number,quantity_in_decimal?:string,reference_line_item_id:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
+      line_items:{amount?:number,date_from?:number,date_to?:number,description?:string,quantity?:number,quantity_in_decimal?:string,reference_line_item_id:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
     }
     export interface RetrieveResponse {  
        credit_note:CreditNote;
@@ -794,7 +794,7 @@ This endpoint schedules e-invoices manually. This operation is not allowed when
 
         */
        
-      tax_withheld?:{id:string};
+      tax_withheld:{id:string};
     }
     export interface ResendEinvoiceResponse {  
        credit_note:CreditNote;
@@ -931,42 +931,42 @@ Ireland** . The first two characters of the VAT number in such a case is `X
 
         */
        
-      line_items?:{amount?:number,amount_in_decimal?:string,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,reference_line_item_id?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
+      line_items:{amount?:number,amount_in_decimal?:string,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,reference_line_item_id?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
        
       /**
         * @description Parameters for line_item_tiers
 
         */
        
-      line_item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,line_item_id:string,quantity_used?:number,quantity_used_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
+      line_item_tiers:{ending_unit?:number,ending_unit_in_decimal?:string,line_item_id:string,quantity_used?:number,quantity_used_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
        
       /**
         * @description Parameters for discounts
 
         */
        
-      discounts?:{amount:number,description?:string,entity_id?:string,entity_type:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'document_level_discount' | 'document_level_coupon',line_item_id?:string}[];
+      discounts:{amount:number,description?:string,entity_id?:string,entity_type:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'document_level_discount' | 'document_level_coupon',line_item_id?:string}[];
        
       /**
         * @description Parameters for taxes
 
         */
        
-      taxes?:{amount?:number,description?:string,juris_code?:string,juris_name?:string,juris_type?:'special' | 'country' | 'unincorporated' | 'other' | 'city' | 'federal' | 'county' | 'state',name:string,rate:number}[];
+      taxes:{amount?:number,description?:string,juris_code?:string,juris_name?:string,juris_type?:'special' | 'country' | 'unincorporated' | 'other' | 'city' | 'federal' | 'county' | 'state',name:string,rate:number}[];
        
       /**
         * @description Parameters for allocations
 
         */
        
-      allocations?:{allocated_amount:number,allocated_at:number,invoice_id:string}[];
+      allocations:{allocated_amount:number,allocated_at:number,invoice_id:string}[];
        
       /**
         * @description Parameters for linked_refunds
 
         */
        
-      linked_refunds?:{amount:number,date:number,payment_method:PaymentMethod,reference_number?:string}[];
+      linked_refunds:{amount:number,date:number,payment_method:PaymentMethod,reference_number?:string}[];
     }
     export interface Einvoice {  
          /**
@@ -1146,7 +1146,7 @@ Ireland** . The first two characters of the VAT number in such a case is `X
 
           */
        
-      tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
+      tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'tax_not_configured_external_provider' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
        
          /**
           * @description The identifier of the modelled entity this line item is based on. Will be null for 'adhoc' entity type

package/types/resources/CreditNoteEstimate.d.ts

@@ -46,7 +46,7 @@ declare module 'chargebee' {
        
       date_to:number;
        
-      unit_amount?:number;
+      unit_amount:number;
        
       quantity?:number;
        
@@ -54,7 +54,7 @@ declare module 'chargebee' {
        
       pricing_model?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep';
        
-      is_taxed?:boolean;
+      is_taxed:boolean;
        
       tax_amount?:number;
        
@@ -69,29 +69,31 @@ declare module 'chargebee' {
       discount_amount?:number;
        
       item_level_discount_amount?:number;
+              
+      usage_percentage?:string;
        
       reference_line_item_id?:string;
        
-      description?:string;
+      description:string;
        
       entity_description?:string;
        
-      entity_type?:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc';
+      entity_type:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc';
        
-      tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
+      tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'tax_not_configured_external_provider' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
        
       entity_id?:string;
        
       customer_id?:string;
     }
     export interface Discount {  
-      amount?:number;
+      amount:number;
        
       description?:string;
        
       line_item_id?:string;
        
-      entity_type?:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
+      entity_type:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
        
       discount_type?:'fixed_amount' | 'percentage';
        
@@ -100,26 +102,32 @@ declare module 'chargebee' {
       coupon_set_code?:string;
     }
     export interface Tax {  
-      name?:string;
+      name:string;
        
-      amount?:number;
+      amount:number;
        
       description?:string;
     }
     export interface LineItemTax {  
       line_item_id?:string;
        
-      tax_name?:string;
+      tax_name:string;
        
-      tax_rate?:number;
+      tax_rate:number;
+       
+      date_to?:number;
+       
+      date_from?:number;
+       
+      prorated_taxable_amount?:number;
        
       is_partial_tax_applied?:boolean;
        
       is_non_compliance_tax?:boolean;
        
-      taxable_amount?:number;
+      taxable_amount:number;
        
-      tax_amount?:number;
+      tax_amount:number;
        
       tax_juris_type?:'special' | 'country' | 'unincorporated' | 'other' | 'city' | 'federal' | 'county' | 'state';
        
@@ -132,26 +140,26 @@ declare module 'chargebee' {
       local_currency_code?:string;
     }
     export interface LineItemDiscount {  
-      line_item_id?:string;
+      line_item_id:string;
        
-      discount_type?:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
+      discount_type:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
        
       coupon_id?:string;
        
       entity_id?:string;
        
-      discount_amount?:number;
+      discount_amount:number;
     }
     export interface LineItemTier {  
       line_item_id?:string;
        
-      starting_unit?:number;
+      starting_unit:number;
        
       ending_unit?:number;
        
-      quantity_used?:number;
+      quantity_used:number;
        
-      unit_amount?:number;
+      unit_amount:number;
        
       starting_unit_in_decimal?:string;
        

package/types/resources/Entitlement.d.ts

@@ -2,63 +2,150 @@
 declare module 'chargebee' {
   export interface Entitlement {
     
+    /**
+      * @description A unique identifier for the entitlement. This is auto-generated.
+
+      */
+    
     id:string;
     
+    /**
+      * @description The unique identifier of the entity being granted entitlement to a specific `feature`.
+
+      */
+    
     entity_id?:string;
     
+    /**
+      * @description The type of the entity that holds this entitlement. \* plan -
+
+Indicates that the entity is an `item` with [type](items?prod_cat_ver=2#item_type) set to `plan`.
+\* addon -
+
+Indicates that the entity is an `item` with [type](items?prod_cat_ver=2#item_type) set to `addon`.
+\* addon_price -
+
+Indicates that the entity is an `item_price` associated with an `item` with [type](items?prod_cat_ver=2#item_type) set to `addon`.
+\* charge -
+
+Indicates that the entity is an `item` with [type](items?prod_cat_ver=2#item_type) set to `charge`.
+\* plan_price -
+
+Indicates that the entity is an `item_price` associated with an `item` of [type](items?prod_cat_ver=2#item_type) `plan`.
+
+      */
+    
     entity_type?:'charge' | 'addon' | 'addon_price' | 'plan_price' | 'plan';
     
+    /**
+      * @description The unique identifier of the `feature` to which the entity gains entitlement.
+
+      */
+    
     feature_id?:string;
     
+    /**
+      * @description The `name` of the feature associated with this entitlement.
+
+      */
+    
     feature_name?:string;
     
+    /**
+      * @description The level of entitlement that the entity has towards the feature. The possible values depend on the value of `feature.type`:
+
+* When `feature.type` is `quantity` and:
+  * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any one of `feature.levels[value][]`.
+  * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:
+    * any one of `feature.levels[value][]`
+    * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
+* When `type` is `range` and:
+  * If `feature.levels[is_unlimited]` is not `true` for any one of `feature.levels[]`, then the value can be any whole number between `levels[value][0]` and `levels[value][1]` (inclusive).
+  * If `feature.levels[is_unlimited]` is `true` for one of the `feature.levels[]`, then the value can be:
+    * any whole number equal to or greater than `levels[value][0]`
+    * or it can be `unlimited` (case-insensitive), indicating unlimited entitlement.
+* When `type` is `custom`, then the value can be any one of `feature.levels[value][]`.
+* When `type` is `switch`, then the value is set as `available` or `true`.
+
+      */
+    
     value?:string;
     
+    /**
+      * @description The display name for the entitlement level. The value is automatically generated based on `feature.type`:
+
+* When `feature.type` is `quantity` or `range`, the `name` is the space-separated concatenation of `value` and the plural form of `feature.unit`. For instance, if `value` is `20` and `feature.unit` is `user`, the `name` will be `20 users`.
+* When `feature.type` is `custom`, the `name` matches the `value`.
+
+      */
+    
     name?:string;
   }
   export namespace Entitlement {
     export class EntitlementResource {  
+      /**
+        * @description Retrieves a list of all the `entitlement`s associated with the specified `feature`.
+
+        */
+      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
+      /**
+        * @description Create, update, or remove a set of &#x60;entitlement&#x60;s for a feature.
+
+The behavior depends on the specified &#x60;action&#x60;. It tries to create, update, or delete &#x60;entitlement&#x60; objects. If any of the entitlement objects fail to process, the entire operation stops with an error, and no entitlements are processed. In essence, the request processes either all the provided entitlements or none of them.
+
+        */
+      
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
     }
     export interface ListResponse {  
+      /**
+        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
+
+        */
+       
        list:{entitlement:Entitlement}[];
        
+      /**
+        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
+
+        */
+       
        next_offset?:string;
     }
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
 
         */
         
       limit?:number;
        
       /**
-        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
+        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
 
         */
         
       offset?:string;
        
       /**
-        * @description The &#x60;id&#x60; of the feature towards which this entitlement has been granted.
+        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
 
         */
         
       feature_id?:{in?:string,is?:string};
        
       /**
-        * @description The &#x60;type&#x60; of the &#x60;entity&#x60; to which this entitlement belongs.
+        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
 
         */
         
       entity_type?:{in?:string,is?:'charge' | 'addon' | 'addon_price' | 'plan_price' | 'plan'};
        
       /**
-        * @description The &#x60;id&#x60; of the &#x60;entity&#x60; to which this entitlement belongs.
+        * @description Retrieves a list of all the &#x60;entitlement&#x60;s associated with the specified &#x60;feature&#x60;.
 
         */
         
@@ -69,8 +156,18 @@ declare module 'chargebee' {
     }
     export interface CreateInputParam {
        
+      /**
+        * @description The specific action to be performed for each &#x60;entitlement&#x60; specified. \* upsert - If the &#x60;entitlement&#x60; already exists for the &#x60;feature_id&#x60; and &#x60;entity_id&#x60; combination, the &#x60;value&#x60; of the &#x60;entitlement&#x60; is updated. If it doesn&#x27;t exist, a new &#x60;entitlement&#x60; is created. \* remove - Deletes the &#x60;entitlement&#x60; for the &#x60;feature_id&#x60; and &#x60;entity_id&#x60; combination, if it exists.
+
+        */
+       
       action:Action;
        
+      /**
+        * @description Parameters for entitlements
+
+        */
+       
       entitlements:{entity_id:string,entity_type?:'charge' | 'addon' | 'addon_price' | 'plan_price' | 'plan',feature_id:string,value?:string}[];
     }