@nutanix-scratch/dataprotection-js-client 4.2.1 → 4.3.1

package/README.md

@@ -7,8 +7,8 @@ The Javascript client for Nutanix Data Protection APIs is designed for Javascrip
 - Reduce boilerplate code implementation.
 - Use standard methods for installation.
 ## Version
-- API version: v4.2
-- Package version: 4.2.1
+- API version: v4.3
+- Package version: 4.3.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:
@@ -20,7 +20,7 @@ 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.2).
+When version negotiation is disabled, the client will use the SDK's default API version (v4.3).
 
 ## Requirements.
 Node.JS 14, 15, 16, 17 and 18 are fully supported and tested.
@@ -118,15 +118,18 @@ client.maxRedirects = 3  // Max number of redirects to follow
 
 ### Invoking an operation
 ```javascript
-import { ApiClient, ConsistencyGroupsApi }  from "@nutanix-api/dataprotection-js-client";
+// this sample code is not usable directly for real use-case
+
+import { ApiClient, SampleApi }  from "@nutanix-api/dataprotection-js-client";
 // Configure the client
 // ...
 let client = new ApiClient();
 // Initialize the API
-let consistencyGroupsApi = new ConsistencyGroupsApi(client);
-let extId = "Bb3bfA9a-bd8e-b0dd-Cb80-07Eee21bDd14";
+let sampleApi = new SampleApi(client);
+const extId = '66673023168b486898d76bc27e5ce9c2'
+// Get a sample group by UUID.
 
-consistencyGroupsApi.getConsistencyGroupById(extId).then(({data, response}) => {
+sampleApi.getSampleByExtId(extId).then(({data, response}) => {
     console.log(`API returned the following status code: ${response.status}`);
 }).catch((err) =>  {
     console.log(`Error is: ${err}`);
@@ -149,25 +152,24 @@ 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
-import { ApiClient, ConsistencyGroupsApi }  from "@nutanix-api/dataprotection-js-client";
+// this sample code is not usable directly for real use-case
+
+import { ApiClient, SampleApi } from "@nutanix-api/dataprotection-js-client";
 // Configure the client
 // ...
 let client = new ApiClient();
 // Initialize the API
-let consistencyGroupsApi = new ConsistencyGroupsApi(client);
-let extId = "Bb3bfA9a-bd8e-b0dd-Cb80-07Eee21bDd14";
-
-// Perform Get call
-consistencyGroupsApi.getConsistencyGroupById(extId).then(({data, response}) => {
+let sampleApi = new SampleApi(client);
+const extId = '66673023168b486898d76bc27e5ce9c2'
+// Get a sample group by UUID.
+sampleApi.getSampleByExtId(extId).then(({data, response}) => {
 console.log(`API returned the following status code: ${response.status}`);
 // Extract E-Tag Header
 let etagValue = ApiClient.getEtag(data)
-// ...
-let consistencyGroup = data.data;
+let body = data.getData();
 // initialize/change parameters for update
-
-// Perform Update
-consistencyGroupsApi.updateConsistencyGroupById(consistencyGroup, extId, {"If-Match" : etagValue}).then(({data, response}) => {
+// Update a given sample by UUID.
+sampleApi.updateSampleByExtId(extId, body, {"If-Match" : etagValue}).then(({data, response}) => {
     console.log(`API returned the following status code: ${response.status}`);
 }).catch((err) => {
     console.log(`Error is: ${err}`);
@@ -215,7 +217,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=dataprotection&version=v4.2&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=dataprotection&version=v4.3&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).