@nutanix-scratch/licensing-js-client 4.0.1 → 4.2.1

package/README.md

@@ -1,14 +1,14 @@
 # Javascript Client For Nutanix Licensing APIs
 
-The Javascript client for Nutanix Licensing APIs is designed for Javascript client application developers offering them simple and flexible access to APIs that licensing desc placeholder.
+The Javascript client for Nutanix Licensing APIs is designed for Javascript client application developers offering them simple and flexible access to APIs that manage licenses for your clusters and Prism Central, get information on applied licenses, license compliance details and feature entitlements.
 ## Features
 - Invoke Nutanix APIs with a simple interface.
 - Handle Authentication seamlessly.
 - Reduce boilerplate code implementation.
 - Use standard methods for installation.
 ## Version
-- API version: v4.0
-- Package version: 4.0.1
+- API version: v4.2
+- Package version: 4.2.1
 
 ## Requirements.
 Node.JS 14, 15, 16, 17 and 18 are fully supported and tested.
@@ -26,21 +26,22 @@ $ npm install @nutanix-api/licensing-js-client
 ## Configuration
 The javascript client for Nutanix Licensing APIs can be configured with the following parameters
 
-| Parameter | Description                                                                  | Required  | Default Value|
-|-----------|------------------------------------------------------------------------------|---------- |--------------|
-| scheme    | URI scheme for connecting to the cluster (HTTP or HTTPS using SSL/TLS)       | No        | https        |
-| host      | IPv4/IPv6 address or FQDN of the cluster to which the client will connect to | Yes       | N/A          |
-| port      | Port on the cluster to which the client will connect to                      | No        | 9440         |
-| username  | Username to connect to a cluster                                             | Yes       | N/A          |
-| password  | Password to connect to a cluster                                             | Yes       | N/A          |
-| debug     | Runs the client in debug mode if specified                                   | No        | False        |
-| verifySsl | Verify SSL certificate of cluster, the client will connect to                | No        | True         |
-| maxRetryAttempts| Maximum number of retry attempts while connecting to the cluster       | No        | 5            |
-| retryInterval| Interval in milliseconds at which retry attempts are made                 | No        | 3000         |
-| maxRedirects | Maximum number of redirects to follow                                     | No        | 10           |
-| loggerFile | File location to which debug logs are written to                            | No        | N/A          |
-| connectTimeout | Connection timeout in milliseconds for all operations                   | No        | 30000        |
-| readTimeout | Read timeout in milliseconds for all operations                            | No        | 30000        |
+| Parameter | Description                                                                     | Required  | Default Value|
+|-----------|---------------------------------------------------------------------------------|---------- |--------------|
+| scheme    | URI scheme for connecting to the cluster (HTTP or HTTPS using SSL/TLS)          | No        | https        |
+| host      | IPv4/IPv6 address or FQDN of the cluster to which the client will connect to    | Yes       | N/A          |
+| port      | Port on the cluster to which the client will connect to                         | No        | 9440         |
+| username  | Username to connect to a cluster                                                | Yes       | N/A          |
+| password  | Password to connect to a cluster                                                | Yes       | N/A          |
+| debug     | Runs the client in debug mode if specified                                      | No        | False        |
+| verifySsl | Verify SSL certificate of cluster, the client will connect to                   | No        | True         |
+| maxRetryAttempts| Maximum number of retry attempts while connecting to the cluster          | No        | 5            |
+| retryInterval| Interval in milliseconds at which retry attempts are made                    | No        | 3000         |
+| maxRedirects | Maximum number of redirects to follow                                        | No        | 10           |
+| loggerFile | File location to which debug logs are written to                               | No        | N/A          |
+| connectTimeout | Connection timeout in milliseconds for all operations                      | No        | 30000        |
+| readTimeout | Read timeout in milliseconds for all operations                               | No        | 30000        |
+| withCredentials | Cross-site Access-Control requests should be made using auth credentials  | No        | False        |
 
 This module can be used in the CommonJS (CJS) , ECMAScript6(ES6) and  Universal Module Definition(UMD) syntax
 While using the module in browser frameworks like React or Vue.JS , you can use import/export. Older Node.js versions can continue to use the require ().
@@ -205,7 +206,7 @@ The list of filterable and sortable fields with expansion keys can be found in t
 
 ## API Reference
 
-This library has a full set of [API Reference Documentation](https://developers.nutanix.com/sdk-reference?namespace=licensing&version=v4.0&language=javascript). This documentation is auto-generated, and the location may change.
+This library has a full set of [API Reference Documentation](https://developers.nutanix.com/sdk-reference?namespace=licensing&version=v4.2&language=javascript). This documentation is auto-generated, and the location may change.
 
 ## License
 This library is licensed under Apache 2.0 license. Full license text is available in [LICENSE](https://www.apache.org/licenses/LICENSE-2.0.txt).