chargebee 2.25.3 → 2.26.1

package/CHANGELOG.md

@@ -1,3 +1,38 @@
+### v2.26.1 (2023-08-11)
+* * *
+* Support Descriptions for the attributes and actions has been added.
+
+### v2.26.0 (2023-07-31)
+* * *
+
+#### New Attributes:
+* tax_category has been added to the CreditNote, Quote and Invoice resource. 
+* proration_type has been added in Addon resource.
+
+#### New Enum values:
+* tax has been added to EntityType enum in Invoice resource.
+* payment_source_locally_deleted has been added to EventType.
+
+#### New Input parameters:
+
+* CouponId and CouponApplyTill has been added to Subscritpion#CreateRequest in Subscritpion resource. 
+* CouponId and CouponApplyTill has been added to Subscritpion#CreateForCustomerRequest in Subscritpion resource. 
+* CouponId and CouponApplyTill has been added to Subscritpion#CreateWithItemsRequest in Subscritpion resource. 
+* CouponId and CouponApplyTill has been added to Subscritpion#UpdateRequest in Subscritpion resource. 
+* CouponId and CouponApplyTill has been added to Subscritpion#UpdateForItemsRequest in Subscritpion resource. 
+* CouponId and CouponApplyTill has been added to Subscritpion#ImportSubscriptionRequest in Subscritpion resource. 
+* CouponId and CouponApplyTill has been added to Subscritpion#ImportForCustomerRequest in Subscritpion resource. 
+* CouponId and CouponApplyTill has been added to Subscritpion#ImportForItemsRequest in Subscritpion resource. 
+* cancel_reason_code has been added to Subscritpion#ImportForItemsRequest in Subscritpion resource.
+* proration_type has been added in addon#createRequest and addon#UpdateRequest in Addon resource.
+* addons[proration_type] has been added in Estimate#UpdateSubscriptionRequest in Estimate resource.
+* addons[proration_type]  has been added in Subscription#UpdateRequest in Subscritpion resource.
+
+#### New Enum Class:
+* ProrationType enum has been added to addon resource.
+* ProrationType enum has been added.
+
+
 ### v2.25.3 (2023-07-24)
 * * *
 * Add Request Config Type

package/README.md

@@ -1,4 +1,4 @@
-# Chargebee Node Client Library - API V2
+# Chargebee Node.js Client Library
 
 [![npm](https://img.shields.io/npm/v/chargebee.svg?maxAge=3)](https://www.npmjs.com/package/chargebee)
 [![npm](https://img.shields.io/npm/dt/chargebee.svg?maxAge=3)](https://www.npmjs.com/package/chargebee)
@@ -6,7 +6,7 @@
 This is the [node.js](http://nodejs.org/) library for integrating with Chargebee. Sign up for a Chargebee account [here](https://www.chargebee.com).
 
 > **Note**
-> Chargebee now supports two API versions - [V1](https://apidocs.chargebee.com/docs/api/v1) and [V2](https://apidocs.chargebee.com/docs/api), of which V2 is the latest release and all future developments will happen in V2. This library is for <b>API version V2</b>. If you’re looking for V1, head to [chargebee-v1 branch](https://github.com/chargebee/chargebee-node/tree/chargebee-v1).
+> If you’re using [API V1](https://apidocs.chargebee.com/docs/api/v1), head to [chargebee-v1 branch](https://github.com/chargebee/chargebee-node/tree/chargebee-v1).
 
 ## Requirements
 
@@ -26,15 +26,30 @@ pnpm install chargebee
 
 ## Usage
 
-The package needs to be configured with your site's API key, which is available under Configure Chargebee Section. Refer [here](https://www.chargebee.com/docs/2.0/api_keys.html) for more details.
+The package needs to be configured with your site's API key, which is available under Configure Chargebee Section. Refer [here](https://www.chargebee.com/docs/2.0/api_keys.html) for more details. 
+
+The full documentation can be found on the Chargebee API Docs: [https://apidocs.chargebee.com/docs/api?lang=node](https://apidocs.chargebee.com/docs/api?lang=node)
+
+
+```js
+const chargebee = require('chargebee');
+
+chargebee.configure({
+  site: '<YOUR_SITE_NAME>',
+  api_key: '<YOUR_API_KEY>',
+});
+```
+
+Or using ES modules,
 
 ```js
-var chargebee = require('chargebee');
+import chargebee from 'chargebee';
 
 chargebee.configure({
-  site: 'YOUR_SITE_NAME',
-  api_key: 'YOUR_API_KEY',
+  site: '<YOUR_SITE_NAME>',
+  api_key: '<YOUR_API_KEY>',
 });
+
 ```
 
 ### Using Async / Await
@@ -89,49 +104,33 @@ chargebee.customer
   });
 ```
 
-### Accessing the response object
-
-The response object returned by the `request()` method is generic response wrapper. You need to access the resource from it. For example,
-
-- To access customer object.
-
-```js
-const result = await chargebee.customer.create({ email: 'john@test.com' }).request();
-console.log(result.customer);
-```
-
-Other resources can be accessed by the same approach. For subscription, it will be `result.subscription`
+### Usage with TypeScript
 
-- To access list response.
+You can import the types as shown below.
 
-```js
-const result = await chargebee.subscription
-  .list({
-    /* params */
-  })
-  .request();
+```ts
+import chargebee, { Customer } from 'chargebee';
 
-// A list of Subscription objects
-console.log(result.list.map((obj) => obj.subscription));
-```
+chargebee.configure({
+  site: '<YOUR_SITE_NAME>',
+  api_key: '<YOUR_API_KEY>',
+});
 
-**Note**
+const createCustomer = async () => {
+  const inputParams: Customer.CreateInputParam = {
+    email: 'john@test.com',
+    first_name: 'John',
+    last_name: 'Doe',
+  };
 
-If you have a `result` (or children further down the line) and are unsure what properties are available, you can use `Object.keys` to get a list of available accessor properties. Using `Object.keys` in the previous example would yield
+  const { customer } = await chargebee.customer.create(inputParams).request();
+  console.log(customer);
+};
 
-```js
-// ['list', 'next_offset']
-console.log(Object.keys(result));
-// ['1', '2', '3'], e.g. `result.list` is an array with 3 entries
-console.log(Object.keys(result.list));
-// ['activated_at', 'base_currency_code', ...]
-// ['activated_at', 'base_currency_code', ...]
-// ['activated_at', 'base_currency_code', ...]
-// Which means we've reached the bottom and should have all the information available from this request
-console.log(result.list.map((obj) => obj.subscription));
+createCustomer();
 ```
 
-#### Using filters in the List API
+### Using filters in the List API
 
 For pagination: `offset` is the parameter that is being used. The value used for this parameter must be the value returned for `next_offset` parameter in the previous API call.
 
@@ -162,7 +161,7 @@ const fetchCustomers = async (offset) => {
   });
 ```
 
-#### Using custom headers and custom fields:
+### Using custom headers and custom fields:
 
 ```js
 const result = await chargebee.customer
@@ -178,7 +177,7 @@ const customer = result.customer;
 console.log(customer.cf_host_url);
 ```
 
-### Create an idempotent request
+### Creating an idempotent request
 
 [Idempotency keys](https://apidocs.chargebee.com/docs/api/idempotency?prod_cat_ver=2) are passed along with request headers to allow a safe retry of POST requests.
 
@@ -208,15 +207,22 @@ chargebee.customer.create({ email: 'john@test.com', cf_host_url: 'http://xyz.com
 });
 ```
 
-### Processing Webhooks - API Version Check
-
-An attribute, <b>api_version</b>, is added to the [Event](https://apidocs.chargebee.com/docs/api/events) resource, which indicates the API version based on which the event content is structured. In your webhook servers, ensure this \_api_version* is the same as the [API version](https://apidocs.chargebee.com/docs/api#versions) used by your webhook server's client library.
+### Passing API Keys at request level
 
-## Documentation
+```js
+const newCust = await chargebee.customer.create({
+  email: 'john@test.com',
+  first_name: 'John',
+  last_name: 'Doe'
+}).request({
+  site: '<YOUR_SITE_NAME>',
+  api_key: '<YOUR_API_KEY>',
+});
+```
 
-The full documentation can be found on the Chargebee API Docs:
+### Processing Webhooks - API Version Check
 
-[https://apidocs.chargebee.com/docs/api?lang=node](https://apidocs.chargebee.com/docs/api?lang=node)
+An attribute, <b>api_version</b>, is added to the [Event](https://apidocs.chargebee.com/docs/api/events) resource, which indicates the API version based on which the event content is structured. In your webhook servers, ensure this \_api_version* is the same as the [API version](https://apidocs.chargebee.com/docs/api#versions) used by your webhook server's client library.
 
 ## License
 

package/lib/chargebee.js

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

package/package.json

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

package/types/core.d.ts

@@ -57,6 +57,7 @@ declare module 'chargebee' {
   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' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
   type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'wechat_pay' | 'card'
   type PaymentVoucherType = 'boleto'

package/types/resources/Address.d.ts

@@ -1,54 +1,294 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface Address {
+    
+    /**
+      * @description Label to identify the address. This is unique for all the address for a subscription.
+
+      */
+    
     label:string;
+    
+    /**
+      * @description First name
+
+      */
+    
     first_name?:string;
+    
+    /**
+      * @description Last name
+
+      */
+    
     last_name?:string;
+    
+    /**
+      * @description Email
+
+      */
+    
     email?:string;
+    
+    /**
+      * @description Company name
+
+      */
+    
     company?:string;
+    
+    /**
+      * @description Phone number
+
+      */
+    
     phone?:string;
+    
+    /**
+      * @description Address line 1
+
+      */
+    
     addr?:string;
+    
+    /**
+      * @description Address line 2
+
+      */
+    
     extended_addr?:string;
+    
+    /**
+      * @description Address line 3
+
+      */
+    
     extended_addr2?:string;
+    
+    /**
+      * @description Name of the city
+
+      */
+    
     city?:string;
+    
+    /**
+      * @description The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search) without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set &#x60;state_code&#x60; as &#x60;AZ&#x60; (not &#x60;US-AZ&#x60;). For Tamil Nadu (India), set as &#x60;TN&#x60; (not &#x60;IN-TN&#x60;). For British Columbia (Canada), set as &#x60;BC&#x60; (not &#x60;CA-BC&#x60;).
+
+      */
+    
     state_code?:string;
+    
+    /**
+      * @description State or Province
+
+      */
+    
     state?:string;
+    
+    /**
+      * @description The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).   
+
+**Note** : If you enter an invalid country code, the system will return an error.  
+
+**Brexit**
+
+
+If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then &#x60;XI&#x60; (the code for **United Kingdom -- Northern Ireland**) is available as an option.
+
+      */
+    
     country?:string;
+    
+    /**
+      * @description Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address).
+
+      */
+    
     zip?:string;
+    
+    /**
+      * @description The address verification status. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* not_validated - Address is not yet validated. \* invalid - Address is invalid. \* valid - Address was validated successfully.
+
+      */
+    
     validation_status?:ValidationStatus;
+    
+    /**
+      * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
+
+      */
+    
     subscription_id:string;
   }
   export namespace Address {
-    export class AddressResource {
+    export class AddressResource {  
+      /**
+        * @description Retrieves an address resource for a subscription and the specified label.
+
+        */
+      
       retrieve(input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
+       
+      /**
+        * @description Adds or replaces the address for a subscription. If an address is already present for the specified label, it will be replaced otherwise new address is added with that label.
+
+        */
+      
       update(input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
     }
-    export interface RetrieveResponse {
-      address:Address;
+    export interface RetrieveResponse {  
+      /**
+        * @description Retrieves an address resource for a subscription and the specified label.
+
+        */
+       
+       address:Address;
     }
     export interface RetrieveInputParam {
+       
+      /**
+        * @description Retrieves an address resource for a subscription and the specified label.
+
+        */
+        
       subscription_id:string;
+       
+      /**
+        * @description Retrieves an address resource for a subscription and the specified label.
+
+        */
+        
       label:string;
     }
-    export interface UpdateResponse {
-      address:Address;
+    export interface UpdateResponse {  
+      /**
+        * @description Adds or replaces the address for a subscription. If an address is already present for the specified label, it will be replaced otherwise new address is added with that label.
+
+        */
+       
+       address:Address;
     }
     export interface UpdateInputParam {
+       
+      /**
+        * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
+
+        */
+       
       subscription_id:string;
+       
+      /**
+        * @description Label to identify the address. This is unique for all the address for a subscription.
+
+        */
+       
       label:string;
+       
+      /**
+        * @description First name.
+
+        */
+       
       first_name?:string;
+       
+      /**
+        * @description Last name.
+
+        */
+       
       last_name?:string;
+       
+      /**
+        * @description Email.
+
+        */
+       
       email?:string;
+       
+      /**
+        * @description Company name.
+
+        */
+       
       company?:string;
+       
+      /**
+        * @description Phone number.
+
+        */
+       
       phone?:string;
+       
+      /**
+        * @description Address line 1.
+
+        */
+       
       addr?:string;
+       
+      /**
+        * @description Address line 2.
+
+        */
+       
       extended_addr?:string;
+       
+      /**
+        * @description Address line 3.
+
+        */
+       
       extended_addr2?:string;
+       
+      /**
+        * @description Name of the city.
+
+        */
+       
       city?:string;
+       
+      /**
+        * @description The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code) without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set &#x60;state_code&#x60; as &#x60;AZ&#x60; (not &#x60;US-AZ&#x60;). For Tamil Nadu (India), set as &#x60;TN&#x60; (not &#x60;IN-TN&#x60;). For British Columbia (Canada), set as &#x60;BC&#x60; (not &#x60;CA-BC&#x60;).
+
+        */
+       
       state_code?:string;
+       
+      /**
+        * @description The state/province name. Is set by Chargebee automatically for US, Canada and India If &#x60;state_code&#x60; is provided.
+
+        */
+       
       state?:string;
+       
+      /**
+        * @description Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address).
+
+        */
+       
       zip?:string;
+       
+      /**
+        * @description The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).   
+
+**Note** : If you enter an invalid country code, the system will return an error.  
+
+**Brexit**
+
+
+If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then &#x60;XI&#x60; (the code for **United Kingdom -- Northern Ireland**) is available as an option.
+.
+
+        */
+       
       country?:string;
+       
+      /**
+        * @description The address verification status. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* not_validated - Address is not yet validated. \* invalid - Address is invalid. \* valid - Address was validated successfully.
+
+        */
+       
       validation_status?:ValidationStatus;
     }
     

package/types/resources/AdvanceInvoiceSchedule.d.ts

@@ -1,25 +1,101 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface AdvanceInvoiceSchedule {
+    
+    /**
+      * @description System-generated and immutable unique Id for the &#x60;advance_invoice_schedule&#x60;.
+
+      */
+    
     id:string;
+    
+    /**
+      * @description The type of advance invoice or advance invoicing schedule. \* specific_dates - The advance charges occur on specific dates. For each date, [a fixed number of billing cycles](advance_invoice_schedules#advance_invoice_schedule_specific_dates_schedule_terms_to_charge) is charged for. There can be up to 5 dates configured. \* fixed_intervals - The advance charges occur at [fixed intervals of time](advance_invoice_schedules#advance_invoice_schedule_fixed_interval_schedule_terms_to_charge).
+
+      */
+    
     schedule_type?:'specific_dates' | 'fixed_intervals';
+    
+    /**
+      * @description When the &#x60;schedule_type&#x60; is &#x60;fixed_intervals&#x60;, this object gives further details of the schedule.
+
+      */
+    
     fixed_interval_schedule?:AdvanceInvoiceSchedule.FixedIntervalSchedule;
+    
+    /**
+      * @description The advance charges occur on specific dates. For each date, [a fixed number of billing cycles](advance_invoice_schedules#advance_invoice_schedule_specific_dates_schedule_terms_to_charge) is charged for. There can be up to 5 dates configured.
+
+      */
+    
     specific_dates_schedule?:AdvanceInvoiceSchedule.SpecificDatesSchedule;
   }
   export namespace AdvanceInvoiceSchedule {
     
     
-    export interface FixedIntervalSchedule {
+    export interface FixedIntervalSchedule {  
+         /**
+          * @description Specifies when the schedule should end. \* after_number_of_intervals - Advance invoices are generated a &#x60;specified number of times&#x60; \* subscription_end - Advance invoices are generated for as long as the subscription is active. \* specific_date - End the advance invoicing schedule on a &#x60;specific date&#x60;.
+
+          */
+       
       end_schedule_on?:EndScheduleOn;
+       
+         /**
+          * @description The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the [&#x60;remaining_billing_cycles&#x60;](subscriptions#subscription_remaining_billing_cycles) of the subscription. This parameter is applicable only when [&#x60;fixed_interval_schedule[end_schedule_on]&#x60;](advance_invoice_schedules#advance_invoice_schedule_fixed_interval_schedule_end_schedule_on) &#x3D; &#x60;after_number_of_intervals&#x60;
+
+          */
+       
       number_of_occurrences?:number;
+       
+         /**
+          * @description The number of days before each interval that advance invoices are generated.
+
+          */
+       
       days_before_renewal?:number;
+       
+         /**
+          * @description The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when [&#x60;fixed_interval_schedule[end_schedule_on]&#x60;](advance_invoice_schedules#advance_invoice_schedule_fixed_interval_schedule_end_schedule_on) &#x3D; &#x60;specific_date&#x60;.
+
+          */
+       
       end_date?:number;
+       
+         /**
+          * @description The date when this advance invoicing schedule was created.
+
+          */
+       
       created_at?:number;
+       
+         /**
+          * @description The number of billing cycles in one interval.
+
+          */
+       
       terms_to_charge?:number;
     }
-    export interface SpecificDatesSchedule {
+    export interface SpecificDatesSchedule {  
+         /**
+          * @description The number of billing cycles to charge for, on the date specified. Applicable only when [&#x60;schedule_type&#x60;](advance_invoice_schedules#advance_invoice_schedule_schedule_type) is specific_dates.
+
+          */
+       
       terms_to_charge?:number;
+       
+         /**
+          * @description The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when [&#x60;schedule_type&#x60;](advance_invoice_schedules#advance_invoice_schedule_schedule_type) is &#x60;specific_dates&#x60;.
+
+          */
+       
       date?:number;
+       
+         /**
+          * @description The date when this advance invoicing schedule was created.
+
+          */
+       
       created_at?:number;
     }
   }