@nutanix-scratch/security-js-client 4.0.1-beta.1 → 4.1.1

package/README.md

@@ -7,8 +7,20 @@ The Javascript client for Nutanix Security APIs is designed for Javascript clien
 - Reduce boilerplate code implementation.
 - Use standard methods for installation.
 ## Version
-- API version: v4.0.b1
-- Package version: 4.0.1-beta.1
+- API version: v4.1
+- Package version: 4.1.1
+
+## Version Negotiation
+By default, the client negotiates the API version with the server to ensure compatibility. Version negotiation is **enabled by default**. To disable version negotiation and use a fixed API version, set the `allowVersionNegotiation` property to `false` in the client configuration:
+
+```javascript
+import ApiClient from "@nutanix-api/security-js-client";
+
+let client = new ApiClient();
+client.allowVersionNegotiation = false; // Disables automatic version negotiation
+```
+
+When version negotiation is disabled, the client will use the SDK's default API version (v4.1).
 
 ## Requirements.
 Node.JS 14, 15, 16, 17 and 18 are fully supported and tested.
@@ -26,21 +38,22 @@ $ npm install @nutanix-api/security-js-client
 ## Configuration
 The javascript client for Nutanix Security 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 ().
@@ -105,18 +118,15 @@ client.maxRedirects = 3  // Max number of redirects to follow
 
 ### Invoking an operation
 ```javascript
-// this sample code is not usable directly for real use-case
-
-import { ApiClient, SampleApi }  from "@nutanix-api/security-js-client";
+import { ApiClient, CredentialsApi }  from "@nutanix-api/security-js-client";
 // Configure the client
 // ...
 let client = new ApiClient();
 // Initialize the API
-let sampleApi = new SampleApi(client);
-const extId = '66673023168b486898d76bc27e5ce9c2'
-// Get a sample group by UUID.
+let credentialsApi = new CredentialsApi(client);
+let extId = "5AD95Fac-a835-BbDe-8e6d-EbcECBfDAE23";
 
-sampleApi.getSampleByExtId(extId).then(({data, response}) => {
+credentialsApi.getCredentialById(extId).then(({data, response}) => {
     console.log(`API returned the following status code: ${response.status}`);
 }).catch((err) =>  {
     console.log(`Error is: ${err}`);
@@ -139,24 +149,25 @@ You can also modify the headers sent with each individual operation:
 #### Operation specific headers
 Nutanix APIs require that concurrent updates are protected using [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) headers. This would mean that the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header received in the response of a fetch (GET) operation should be used as an [If-Match](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match) header for the modification (PUT) operation.
 ```javascript
-// this sample code is not usable directly for real use-case
-
-import { ApiClient, SampleApi } from "@nutanix-api/security-js-client";
+import { ApiClient, CredentialsApi }  from "@nutanix-api/security-js-client";
 // Configure the client
 // ...
 let client = new ApiClient();
 // Initialize the API
-let sampleApi = new SampleApi(client);
-const extId = '66673023168b486898d76bc27e5ce9c2'
-// Get a sample group by UUID.
-sampleApi.getSampleByExtId(extId).then(({data, response}) => {
+let credentialsApi = new CredentialsApi(client);
+let extId = "5AD95Fac-a835-BbDe-8e6d-EbcECBfDAE23";
+
+// Perform Get call
+credentialsApi.getCredentialById(extId).then(({data, response}) => {
 console.log(`API returned the following status code: ${response.status}`);
 // Extract E-Tag Header
 let etagValue = ApiClient.getEtag(data)
-let body = data.getData();
+// ...
+let credential = data.data;
 // initialize/change parameters for update
-// Update a given sample by UUID.
-sampleApi.updateSampleByExtId(extId, body, {"If-Match" : etagValue}).then(({data, response}) => {
+
+// Perform Update
+credentialsApi.updateCredentialById(credential, extId, {"If-Match" : etagValue}).then(({data, response}) => {
     console.log(`API returned the following status code: ${response.status}`);
 }).catch((err) => {
     console.log(`Error is: ${err}`);
@@ -177,26 +188,22 @@ List Operations for Nutanix APIs support pagination, filtering, sorting and proj
 
 List Options can be passed to list operations in order to perform pagination, filtering etc.
 ```javascript
-// this sample code is not usable directly for real use-case
-
-import { ApiClient, SampleApi } from "@nutanix-api/security-js-client";
+import { ApiClient, CredentialsApi }  from "@nutanix-api/security-js-client";
 // Configure the client
 // ...
 let client = new ApiClient();
 // Initialize the API
-let sampleApi = new SampleApi(client);
+let credentialsApi = new CredentialsApi(client);
 
 //Construct List Options
 var listOptions = new Object();
-listOptions.$page    = pageValue;
-listOptions.$limit   = limitValue;
-listOptions.$filter  = filterValue;
-listOptions.$orderby = orderByValue;
-listOptions.$select  = selectValue;
-listOptions.$expand  = expandValue;
-
-//Gets a list of sample groups.
-sampleApi.listSample(listOptions).then(({data, response}) => {
+listOptions.$page = 0;
+listOptions.$limit = 50;
+listOptions.$filter = "string_sample_data";
+listOptions.$orderby = "string_sample_data";
+listOptions.$select = "string_sample_data";
+
+credentialsApi.listCredentials(listOptions).then(({data, response}) => {
     console.log(`API returned the following status code: ${response.status}`);
 }).catch((err) =>  {
     console.log(`Error is: ${err}`);
@@ -208,7 +215,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=security&version=v4.0.b1&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=security&version=v4.1&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).