chargebee 2.25.3 → 2.26.0

package/CHANGELOG.md

@@ -1,3 +1,34 @@
+### 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.0',
     port: 443,
     timemachineWaitInMillis: 3000,
     exportWaitInMillis: 3000

package/package.json

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