@nutanix-scratch/dataprotection-js-client 4.0.1-alpha.4 → 4.0.1-beta.1

package/README.md

@@ -7,8 +7,8 @@ The Javascript client for Nutanix Dataprotection Versioned APIs is designed for
 - Reduce boilerplate code implementation.
 - Use standard methods for installation.
 ## Version
-- API version: v4.0.a4
-- Package version: 4.0.1-alpha.4
+- API version: v4.0.b1
+- Package version: 4.0.1-beta.1
 
 ## Requirements.
 Node.JS 14, 15, 16, 17 and 18 are fully supported and tested.
@@ -86,16 +86,19 @@ client.retryInterval = 5000 // Interval in ms to use during retry attempts
 
 ### Invoking an operation
 ```javascript
+// this sample code is not usable directly for real use-case
+
 import ApiClient from "@nutanix-api/dataprotection-js-client/dist/es/ApiClient";
-import ConsistencyGroupApi from "@nutanix-api/dataprotection-js-client/dist/es/apis/consistencygroup-endpoints";
+import SampleApi from "@nutanix-api/dataprotection-js-client/dist/es/apis/sample-endpoints";
 // Configure the client
 // ...
 let client = new ApiClient();
 // Initialize the API
-let consistencyGroupApi = new ConsistencyGroupApi(client);
-let extId = "edeDEF57-9Fdf-ef33-89da-C2cdb8a98e8a";
+let sampleApi = new SampleApi(client);
+const extId = '66673023168b486898d76bc27e5ce9c2'
+// Get a sample group by UUID.
 
-consistencyGroupApi.getConsistencyGroup(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}`);
@@ -118,26 +121,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 from "@nutanix-api/dataprotection-js-client/dist/es/ApiClient";
-import ConsistencyGroupApi from "@nutanix-api/dataprotection-js-client/dist/es/apis/consistencygroup-endpoints";
+import SampleApi from "@nutanix-api/dataprotection-js-client/dist/es/apis/sample-endpoints";
 // Configure the client
 // ...
 let client = new ApiClient();
 // Initialize the API
-let consistencyGroupApi = new ConsistencyGroupApi(client);
-let extId = "edeDEF57-9Fdf-ef33-89da-C2cdb8a98e8a";
-
-// Perform Get call
-consistencyGroupApi.getConsistencyGroup(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
-consistencyGroupApi.updateConsistencyGroup(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}`);
@@ -153,27 +155,32 @@ List Operations for Nutanix APIs support pagination, filtering, sorting and proj
 | $limit    | specifies the total number of records returned in the result set. Must be a positive integer between 0 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set|
 | $filter   | allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01 URL](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_SystemQueryOptionfilter) conventions. |
 | $orderby  | allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. |
-| $select   | allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e. *), then all properties on the matching resource will be returned. |
-| $expand   | allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expand item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Allowed system query options are $filter,$select, $orderby. |
+| $select   | allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. |
+| $expand   | allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter,$select and $orderby. |
 
 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 from "@nutanix-api/dataprotection-js-client/dist/es/ApiClient";
-import ConsistencyGroupApi from "@nutanix-api/dataprotection-js-client/dist/es/apis/consistencygroup-endpoints";
+import SampleApi from "@nutanix-api/dataprotection-js-client/dist/es/apis/sample-endpoints";
 // Configure the client
 // ...
 let client = new ApiClient();
 // Initialize the API
-let consistencyGroupApi = new ConsistencyGroupApi(client);
+let sampleApi = new SampleApi(client);
 
 //Construct List Options
 var listOptions = new Object();
-listOptions.vmList = [];
-listOptions.volumeGroupList = [];
-listOptions.page = 0;
-listOptions.limit = 50;
-
-consistencyGroupApi.getConsistencyGroups(listOptions).then(({data, response}) => {
+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}) => {
     console.log(`API returned the following status code: ${response.status}`);
 }).catch((err) =>  {
     console.log(`Error is: ${err}`);
@@ -185,7 +192,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.0.a4&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.0.b1&language=javascript). This documentation is auto-generated, and the location may change.
 
 ## License
 This library is licensed under Nutanix proprietary license. Full license text is available in [LICENSE](https://developers.nutanix.com/license).