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

package/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,217 @@
+# Javascript Client For Nutanix Security APIs
+
+The Javascript client for Nutanix Security APIs is designed for Javascript client application developers offering them simple and flexible access to APIs that manage security features, such as encryption, certificates, or platform hardening.
+## 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.b1
+- Package version: 4.0.1-beta.1
+
+## Requirements.
+Node.JS 14, 15, 16, 17 and 18 are fully supported and tested.
+
+## Installation & Usage
+
+### Installation
+
+This library is distributed on npm. In order to add it as a dependency, run the following command:
+
+```shell
+$ 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        |
+
+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 ().
+
+For CommonJs:
+```javascript
+const sdk = require("@nutanix-api/security-js-client");
+let client = new sdk.ApiClient();
+```
+
+For ES6 modules:
+```javascript
+import ApiClient from "@nutanix-api/security-js-client";
+```
+
+### Sample Configuration
+```javascript
+import ApiClient from "@nutanix-api/security-js-client";
+
+let client = new ApiClient();
+client.host = '10.19.50.27'; // IPv4/IPv6 address or FQDN of the cluster
+client.port = 9440; // Port to which to connect to
+client.username = 'admin'; // UserName to connect to the cluster
+client.password = 'password'; // Password to connect to the cluster
+```
+
+### Authentication
+Nutanix APIs currently support two type of authentication schemes:
+
+- **HTTP Basic Authentication**
+      - The Javascript client can be configured using the username and password parameters to send Basic headers along with every request.
+- **API Key Authentication**
+      - The Javascript client can be configured to set an API key to send "**X-ntnx-api-key**" header with every request.
+  ```javascript
+  import ApiClient from "@nutanix-api/security-js-client";
+
+  let client = new ApiClient();
+  client.setApiKey('abcde12345');
+  ```
+
+
+
+### Retry Mechanism
+The client can be configured to retry requests that fail with the following status codes. The numbers of seconds before which the next retry is attempted is determined by the retryInterval:
+
+- [408 - Request Timeout](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408)
+- [429 - Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429)
+- [502 - Bad Gateway](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502)
+- [503 - Service Unavailable](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503)
+
+The client will also redirect requests that fail with [302 - Found](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302) to the new location specified in the response header `Location`.
+```javascript
+import ApiClient from "@nutanix-api/security-js-client";
+
+let client = new ApiClient();
+client.maxRetryAttempts = 5 // Max retry attempts while reconnecting on a loss of connection
+client.retryInterval = 5000 // Interval in ms to use during retry attempts
+client.maxRedirects = 3  // Max number of redirects to follow
+```
+
+## Usage
+
+### Invoking an operation
+```javascript
+// this sample code is not usable directly for real use-case
+
+import { ApiClient, SampleApi }  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}) => {
+    console.log(`API returned the following status code: ${response.status}`);
+}).catch((err) =>  {
+    console.log(`Error is: ${err}`);
+});
+```
+
+### Request Options
+The library provides the ability to specify additional options that can be applied directly on the 'ApiClient' object used to make network calls to the API. The library also provides a mechanism to specify operation specific headers.
+#### Client headers
+The 'ApiClient' can be configured to send additional headers on each request.
+
+```javascript
+import ApiClient from "@nutanix-api/security-js-client";
+
+let client = new ApiClient();
+client.addDefaultHeader('Accept-Encoding','gzip, deflate, br');
+```
+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";
+// 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}) => {
+console.log(`API returned the following status code: ${response.status}`);
+// Extract E-Tag Header
+let etagValue = ApiClient.getEtag(data)
+let body = data.getData();
+// initialize/change parameters for update
+// 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}`);
+});
+```
+
+### List Operations
+List Operations for Nutanix APIs support pagination, filtering, sorting and projections. The table below details the parameters that can be used to set the options for pagination etc.
+
+| Parameter | Description
+|-----------|----------------------------------------------------------------------------------|
+| $page     | specifies the page number of the result set. Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned.|
+| $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 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, SampleApi } from "@nutanix-api/security-js-client";
+// Configure the client
+// ...
+let client = new ApiClient();
+// Initialize the API
+let sampleApi = new SampleApi(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}) => {
+    console.log(`API returned the following status code: ${response.status}`);
+}).catch((err) =>  {
+    console.log(`Error is: ${err}`);
+});
+
+```
+
+The list of filterable and sortable fields with expansion keys can be found in the documentation [here](https://developers.nutanix.com/).
+
+## 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.
+
+## 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).
+
+## Contact us
+In case of issues please reach out to us at the [mailing list](mailto:sdk@nutanix.com)