chargebee 2.30.0 → 2.31.0

package/CHANGELOG.md

@@ -1,3 +1,58 @@
+### v2.31.0 (2024-01-04)
+* * *
+
+#### New resources:
+* Entitlements has been added.
+
+#### New attributes:
+* date_to, date_from, prorated_taxable_amount has been added to quote_line_group.
+* date_to, date_from, prorated_taxable_amount has been added to quote.
+* date_to, date_from, prorated_taxable_amount has been added to credit_note_estimate.
+* date_to, date_from, prorated_taxable_amount has been added to credit_note.
+* date_to, date_from, prorated_taxable_amount has been added to invoice_estimate.
+* date_to, date_from, prorated_taxable_amount has been added to order.
+* date_to, date_from, prorated_taxable_amount has been added to invoice.
+* 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.
+
+
+#### New Enum values:
+* 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.
+* Dlocal has been added to GatewayEnum.
+* UsAutomatedBankTransfer, UkAutomatedBankTransfer, EuAutomatedBankTransfer, JpAutomatedBankTransfer, MxAutomatedBankTransfer, Custom has been added to OfflinePaymentMethodEnum.
+* AutomatedBankTransfer has been added to PaymentMethodEnum.
+* AutomatedBankTransfer has been added to PaymentMethodTypeEnum.
+
+#### New Input parameters:
+* custom_payment_method_name has been added to Transactions#RecordRefundRequest.
+* proration_type has been added to Subscription#UpdateForItemsRequest.
+* 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.
+
 ### v2.30.0 (2023-11-30)
 * * *
 

package/lib/chargebee.js

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

package/lib/resources/api_endpoints.js

@@ -2578,6 +2578,22 @@ var _endpoints = {
       true
     ]
   ],
+  "entitlement": [
+    [
+      "list",
+      "GET",
+      "/entitlements",
+      null,
+      false
+    ],
+    [
+      "create",
+      "POST",
+      "/entitlements",
+      null,
+      false
+    ]
+  ],
   "in_app_subscription": [
     [
       "process_receipt",

package/package.json

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

package/types/core.d.ts

@@ -46,24 +46,25 @@ declare module 'chargebee' {
   type ExportType = 'data' | 'import_friendly_data'
   type FreePeriodUnit = 'week' | 'month' | 'year' | 'day'
   type FriendOfferType = 'coupon_code' | 'coupon' | 'none'
-  type Gateway = 'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com'
+  type Gateway = 'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'ebanx' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'dlocal' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay' | 'pay_com'
   type HierarchyOperationType = 'complete_hierarchy' | 'subordinates' | 'path_to_root'
   type InvoiceDunningHandling = 'stop' | 'continue'
   type ItemType = 'charge' | 'addon' | 'plan'
   type Layout = 'in_app' | 'full_page'
   type NotifyReferralSystem = 'all_invoices' | 'none' | 'first_paid_conversion'
-  type OfflinePaymentMethod = 'bank_transfer' | 'no_preference' | 'ach_credit' | 'boleto' | 'check' | 'sepa_credit' | 'cash'
+  type OfflinePaymentMethod = 'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash'
   type OnEvent = 'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation'
   type Operation = 'create' | 'update' | 'delete'
   type OperationType = 'add' | 'remove'
   type PauseOption = 'end_of_term' | 'billing_cycles' | 'immediately' | 'specific_date'
   type PaymentInitiator = 'merchant' | 'customer'
-  type PaymentMethod = 'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
-  type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
+  type PaymentMethod = 'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
+  type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'automated_bank_transfer' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
   type PaymentVoucherType = 'boleto'
   type PeriodUnit = 'week' | 'month' | 'year' | 'day'
   type PriceType = 'tax_exclusive' | 'tax_inclusive'
   type PricingModel = 'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep'
+  type ProrationType = 'partial_term' | 'full_term' | 'none'
   type ReferralSystem = 'referral_candy' | 'friendbuy' | 'referral_saasquatch'
   type ReferrerRewardType = 'custom_promotional_credit' | 'referral_direct_reward' | 'custom_revenue_percent_based' | 'none'
   type RefundableCreditsHandling = 'schedule_refund' | 'no_action'
@@ -78,7 +79,7 @@ declare module 'chargebee' {
   type Taxability = 'taxable' | 'exempt'
   type TaxjarExemptionCategory = 'other' | 'wholesale' | 'government'
   type TrialEndAction = 'activate_subscription' | 'plan_default' | 'cancel_subscription' | 'site_default'
-  type Type = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
+  type Type = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'automated_bank_transfer' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
   type UnbilledChargesHandling = 'invoice' | 'no_action'
   type UnbilledChargesOption = 'invoice' | 'delete'
   type UnpaidInvoicesHandling = 'schedule_payment_collection' | 'no_action'

package/types/index.d.ts

@@ -14,6 +14,7 @@
 ///<reference path='./resources/DifferentialPrice.d.ts' />
 ///<reference path='./resources/Discount.d.ts' />
 ///<reference path='./resources/Download.d.ts' />
+///<reference path='./resources/Entitlement.d.ts' />
 ///<reference path='./resources/EntitlementOverride.d.ts' />
 ///<reference path='./resources/Estimate.d.ts' />
 ///<reference path='./resources/Event.d.ts' />
@@ -72,6 +73,7 @@ declare module 'chargebee' {
     static credit_note: CreditNote.CreditNoteResource;
     static customer: Customer.CustomerResource;
     static differential_price: DifferentialPrice.DifferentialPriceResource;
+    static entitlement: Entitlement.EntitlementResource;
     static entitlement_override: EntitlementOverride.EntitlementOverrideResource;
     static estimate: Estimate.EstimateResource;
     static event: Event.EventResource;

package/types/resources/Card.d.ts

@@ -17,7 +17,7 @@ declare module 'chargebee' {
     status:'valid' | 'expiring' | 'expired';
     
     /**
-      * @description Name of the gateway this payment source is stored with. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* stripe - Stripe is a payment gateway. \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* amazon_payments - Amazon Payments is a payment service provider. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* bank_of_america - Bank of America Gateway \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway
+      * @description Name of the gateway this payment source is stored with. \* bluesnap - BlueSnap is a payment gateway. \* tco - 2Checkout is a payment gateway. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* global_payments - Global Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* stripe - Stripe is a payment gateway. \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* eway - eWAY Account is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* amazon_payments - Amazon Payments is a payment service provider. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* bank_of_america - Bank of America Gateway \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.
 
       */
     
@@ -70,7 +70,7 @@ declare module 'chargebee' {
 
       */
     
-    card_type?:'discover' | 'bancontact' | 'other' | 'visa' | 'jcb' | 'diners_club' | 'mastercard' | 'not_applicable' | 'american_express';
+    card_type?:'discover' | 'other' | 'argencard' | 'jcb' | 'mastercard' | 'elo' | 'cencosud' | 'cmr_falabella' | 'american_express' | 'cabal' | 'nativa' | 'bancontact' | 'tarjeta_naranja' | 'carnet' | 'visa' | 'diners_club' | 'rupay' | 'not_applicable' | 'hipercard' | 'maestro';
     
     /**
       * @description Card Funding type \* credit - A credit card. \* prepaid - A prepaid card. \* debit - A debit card. \* not_applicable - Used for ACH. Not applicable for cards \* not_known - An unknown card.

package/types/resources/CreditNote.d.ts

@@ -375,7 +375,7 @@ If the `credit_note` [type](/docs/api/credit_notes#create_credit_note_
 
         */
       
-      record_refund(credit_note_id:string, input?:RecordRefundInputParam):ChargebeeRequest<RecordRefundResponse>;
+      record_refund(credit_note_id:string, input:RecordRefundInputParam):ChargebeeRequest<RecordRefundResponse>;
        
       /**
         * @description Use this API to [void a credit note.](https://www.chargebee.com/docs/credit-notes.html#voiding-or-deleting-a-credit-note) A voided credit is a null entity and cannot be used again. A credit note which has already been voided or refunded cannot be voided. An error message will be displayed when you render such credit notes void.
@@ -587,7 +587,7 @@ This endpoint schedules e-invoices manually. This operation is not allowed when
 
         */
        
-      transaction?:{amount?:number,date:number,payment_method:PaymentMethod,reference_number?:string};
+      transaction:{amount?:number,custom_payment_method_id?:string,date:number,payment_method:PaymentMethod,reference_number?:string};
     }
     export interface VoidCreditNoteResponse {  
        credit_note:CreditNote;
@@ -1351,6 +1351,27 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
        
       tax_rate:number;
        
+         /**
+          * @description Indicates the service period end of the tax rate for the line item.
+
+          */
+       
+      date_to?:number;
+       
+         /**
+          * @description Indicates the service period start of the tax rate for the line item.
+
+          */
+       
+      date_from?:number;
+       
+         /**
+          * @description Indicates the prorated line item amount in cents.
+
+          */
+       
+      prorated_taxable_amount?:number;
+       
          /**
           * @description Indicates if tax is applied only on a portion of the line item amount.
 

package/types/resources/CreditNoteEstimate.d.ts

@@ -42,9 +42,9 @@ declare module 'chargebee' {
        
       subscription_id?:string;
        
-      date_from?:number;
+      date_from:number;
        
-      date_to?:number;
+      date_to:number;
        
       unit_amount?:number;