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

package/dist/es/apis/consistencygroups-endpoints.js

@@ -0,0 +1,267 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ConsistencyGroupsApi = void 0;
+var _ApiClient = require("../ApiClient");
+var _ConsistencyGroup = _interopRequireDefault(require("../models/dataprotection/v4/config/ConsistencyGroup"));
+var _GetConsistencyGroupApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/GetConsistencyGroupApiResponse"));
+var _UpdateConsistencyGroupApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/UpdateConsistencyGroupApiResponse"));
+var _CreateConsistencyGroupApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/CreateConsistencyGroupApiResponse"));
+var _DeleteConsistencyGroupApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/DeleteConsistencyGroupApiResponse"));
+var _ListConsistencyGroupsApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/ListConsistencyGroupsApiResponse"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/*
+ * Nutanix Data Protection APIs
+ *
+ * OpenAPI spec version: 4.2.1
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 17.5.0.10128-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+/**
+ * ConsistencyGroups service.
+ * @version 4.2.1
+ * @class ConsistencyGroupsApi
+ */
+class ConsistencyGroupsApi {
+  #headersToSkip;
+
+  /**
+  * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
+  * their own fetch methods into the SDK
+  */
+  static get ApiClient() {
+    return _ApiClient.ApiClient;
+  }
+
+  /**
+   * Constructs a new ConsistencyGroupsApi. 
+   * @alias module:api/ConsistencyGroupsApi
+   * @class
+   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+   * default to {@link module:ApiClient#instance} if unspecified.
+   */
+  constructor(apiClient) {
+    this.apiClient = apiClient || _ApiClient.ApiClient.instance;
+    this.#headersToSkip = new Set();
+    this.#headersToSkip.add('authorization');
+    this.#headersToSkip.add('cookie');
+    this.#headersToSkip.add('host');
+    this.#headersToSkip.add('user-agent');
+  }
+
+  /**
+   * Create a consistency group
+   * Create a new consistency group with provided specification.
+   * @param { Required<Pick<ConsistencyGroup, 'name' | 'members'>> & Partial<ConsistencyGroup> } body specification
+   * @param {Object} args Additional Arguments
+   * @return {Promise<CreateConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateConsistencyGroupApiResponse } and HTTP response
+   */
+  createConsistencyGroup(body, ...args) {
+    let argMap = args.length > 0 ? args[0] : {};
+    let postBody = null;
+    if (body instanceof _ConsistencyGroup.default && typeof body.toJson === 'function') {
+      postBody = body.toJson();
+    } else {
+      postBody = body;
+    }
+    // verify the required parameter 'body' is set
+    if (typeof postBody === 'undefined' || postBody === null) {
+      throw new Error("Invalid body when calling createConsistencyGroup");
+    }
+    const pathParams = {};
+    const queryParams = {};
+    let headersToInclude = {};
+    Object.keys(argMap).forEach(header => {
+      if (!this.#headersToSkip.has(header.toLowerCase())) {
+        headersToInclude[header] = argMap[header];
+      }
+    });
+    const headerParams = {
+      ...headersToInclude
+    };
+    const formParams = {};
+    _ApiClient.ApiClient.addEtagReferenceToHeader(body, headerParams);
+    const authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+    const contentTypes = ['application/json'];
+    const accepts = ['application/json'];
+    const returnType = _CreateConsistencyGroupApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/consistency-groups', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+
+  /**
+   * Delete a consistency group
+   * Deletes a consistency group for the provided external identifier.
+   * @param { String } extId The external identifier used to retrieve the consistency group.
+   * @param {Object} args Additional Arguments
+   * @return {Promise<DeleteConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteConsistencyGroupApiResponse } and HTTP response
+   */
+  deleteConsistencyGroupById(extId, ...args) {
+    let argMap = args.length > 0 ? args[0] : {};
+    const postBody = null;
+    // verify the required parameter 'extId' is set
+    if (typeof extId === 'undefined' || extId === null) {
+      throw new Error("Missing the required parameter 'extId' when calling deleteConsistencyGroupById");
+    }
+    const pathParams = {
+      'extId': extId
+    };
+    const queryParams = {};
+    let headersToInclude = {};
+    Object.keys(argMap).forEach(header => {
+      if (!this.#headersToSkip.has(header.toLowerCase())) {
+        headersToInclude[header] = argMap[header];
+      }
+    });
+    const headerParams = {
+      ...headersToInclude
+    };
+    const formParams = {};
+    const authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+    const contentTypes = [];
+    const accepts = ['application/json'];
+    const returnType = _DeleteConsistencyGroupApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/consistency-groups/{extId}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+
+  /**
+   * Get details of a consistency group
+   * Fetches the details of the consistency group for the provided external identifier.
+   * @param { String } extId The external identifier used to retrieve the consistency group.
+   * @param {Object} args Additional Arguments
+   * @return {Promise<GetConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetConsistencyGroupApiResponse } and HTTP response
+   */
+  getConsistencyGroupById(extId, ...args) {
+    let argMap = args.length > 0 ? args[0] : {};
+    const postBody = null;
+    // verify the required parameter 'extId' is set
+    if (typeof extId === 'undefined' || extId === null) {
+      throw new Error("Missing the required parameter 'extId' when calling getConsistencyGroupById");
+    }
+    const pathParams = {
+      'extId': extId
+    };
+    const queryParams = {};
+    let headersToInclude = {};
+    Object.keys(argMap).forEach(header => {
+      if (!this.#headersToSkip.has(header.toLowerCase())) {
+        headersToInclude[header] = argMap[header];
+      }
+    });
+    const headerParams = {
+      ...headersToInclude
+    };
+    const formParams = {};
+    const authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+    const contentTypes = [];
+    const accepts = ['application/json'];
+    const returnType = _GetConsistencyGroupApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/consistency-groups/{extId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+
+  /**
+   * List consistency groups
+   * Lists the consistency groups defined on the system. List of consistency groups can be further filtered out using various filtering options.
+   * @param {Object} opts Optional parameters defined for the operation
+   * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It 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 might lead to no results.
+    * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 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.
+    * @param { String } opts.$filter A URL query parameter that 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+   * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.
+   * @param { String } opts.$orderby A URL query parameter that 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 descending order.
+   * @param { String } opts.$select A URL query parameter that 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) 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.
+   * @param {Object} args Additional Arguments
+   * @return {Promise<ListConsistencyGroupsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListConsistencyGroupsApiResponse } and HTTP response
+   */
+  listConsistencyGroups(opts, ...args) {
+    let argMap = args.length > 0 ? args[0] : {};
+    opts = opts || {};
+    const postBody = null;
+    const pathParams = {};
+    const queryParams = {
+      ...(opts.hasOwnProperty('$page') ? {
+        '$page': opts['$page']
+      } : {}),
+      ...(opts.hasOwnProperty('$limit') ? {
+        '$limit': opts['$limit']
+      } : {}),
+      ...(opts.hasOwnProperty('$filter') ? {
+        '$filter': opts['$filter']
+      } : {}),
+      ...(opts.hasOwnProperty('$orderby') ? {
+        '$orderby': opts['$orderby']
+      } : {}),
+      ...(opts.hasOwnProperty('$select') ? {
+        '$select': opts['$select']
+      } : {})
+    };
+    let headersToInclude = {};
+    Object.keys(argMap).forEach(header => {
+      if (!this.#headersToSkip.has(header.toLowerCase())) {
+        headersToInclude[header] = argMap[header];
+      }
+    });
+    const headerParams = {
+      ...headersToInclude
+    };
+    const formParams = {};
+    const authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+    const contentTypes = [];
+    const accepts = ['application/json'];
+    const returnType = _ListConsistencyGroupsApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/consistency-groups', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+
+  /**
+   * Update a consistency group
+   * Updates the details of a consistency group for the provided external identifier.
+   * @param { Required<Pick<ConsistencyGroup, 'name' | 'members'>> & Partial<ConsistencyGroup> } body specification
+   * @param { String } extId The external identifier used to retrieve the consistency group.
+   * @param {Object} args Additional Arguments
+   * @return {Promise<UpdateConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateConsistencyGroupApiResponse } and HTTP response
+   */
+  updateConsistencyGroupById(extId, body, ...args) {
+    let argMap = args.length > 0 ? args[0] : {};
+    let postBody = null;
+    if (body instanceof _ConsistencyGroup.default && typeof body.toJson === 'function') {
+      postBody = body.toJson();
+    } else {
+      postBody = body;
+    }
+    // verify the required parameter 'extId' is set
+    if (typeof extId === 'undefined' || extId === null) {
+      throw new Error("Missing the required parameter 'extId' when calling updateConsistencyGroupById");
+    }
+    // verify the required parameter 'body' is set
+    if (typeof postBody === 'undefined' || postBody === null) {
+      throw new Error("Invalid body when calling updateConsistencyGroupById");
+    }
+    const pathParams = {
+      'extId': extId
+    };
+    const queryParams = {};
+    let headersToInclude = {};
+    Object.keys(argMap).forEach(header => {
+      if (!this.#headersToSkip.has(header.toLowerCase())) {
+        headersToInclude[header] = argMap[header];
+      }
+    });
+    const headerParams = {
+      ...headersToInclude
+    };
+    const formParams = {};
+    _ApiClient.ApiClient.addEtagReferenceToHeader(body, headerParams);
+    const authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+    const contentTypes = ['application/json'];
+    const accepts = ['application/json'];
+    const returnType = _UpdateConsistencyGroupApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/consistency-groups/{extId}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+}
+exports.ConsistencyGroupsApi = ConsistencyGroupsApi;

package/dist/es/apis/dataprotectionclustercapabilities-endpoints.d.ts

@@ -0,0 +1,46 @@
+/**
+ * DataProtectionClusterCapabilities service.
+ * @version 4.2.1
+ * @class DataProtectionClusterCapabilitiesApi
+ */
+export class DataProtectionClusterCapabilitiesApi {
+    /**
+    * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
+    * their own fetch methods into the SDK
+    */
+    static get ApiClient(): typeof ApiClient;
+    /**
+     * Constructs a new DataProtectionClusterCapabilitiesApi.
+     * @alias module:api/DataProtectionClusterCapabilitiesApi
+     * @class
+     * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+     * default to {@link module:ApiClient#instance} if unspecified.
+     */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Get data protection cluster capabilities
+     * List the data protection capabilities for all the underlying clusters.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It 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 might lead to no results.
+
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 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.
+
+     * @param { String } opts.$filter A URL query parameter that 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.
+     * @param { String } opts.$orderby A URL query parameter that 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 descending order.
+     * @param { String } opts.$select A URL query parameter that 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) 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.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListDPClusterCapabilitiesApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListDPClusterCapabilitiesApiResponse } and HTTP response
+     */
+    listDataProtectionClusterCapabilities(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ListDPClusterCapabilitiesApiResponse>;
+    #private;
+}
+import ListDPClusterCapabilitiesApiResponse from "../models/dataprotection/v4/config/ListDPClusterCapabilitiesApiResponse";
+import { ApiClient } from "../ApiClient";

package/dist/es/apis/dataprotectionclustercapabilities-endpoints.js

@@ -0,0 +1,107 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DataProtectionClusterCapabilitiesApi = void 0;
+var _ApiClient = require("../ApiClient");
+var _ListDPClusterCapabilitiesApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/ListDPClusterCapabilitiesApiResponse"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/*
+ * Nutanix Data Protection APIs
+ *
+ * OpenAPI spec version: 4.2.1
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 17.5.0.10128-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+
+/**
+ * DataProtectionClusterCapabilities service.
+ * @version 4.2.1
+ * @class DataProtectionClusterCapabilitiesApi
+ */
+class DataProtectionClusterCapabilitiesApi {
+  #headersToSkip;
+
+  /**
+  * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
+  * their own fetch methods into the SDK
+  */
+  static get ApiClient() {
+    return _ApiClient.ApiClient;
+  }
+
+  /**
+   * Constructs a new DataProtectionClusterCapabilitiesApi. 
+   * @alias module:api/DataProtectionClusterCapabilitiesApi
+   * @class
+   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+   * default to {@link module:ApiClient#instance} if unspecified.
+   */
+  constructor(apiClient) {
+    this.apiClient = apiClient || _ApiClient.ApiClient.instance;
+    this.#headersToSkip = new Set();
+    this.#headersToSkip.add('authorization');
+    this.#headersToSkip.add('cookie');
+    this.#headersToSkip.add('host');
+    this.#headersToSkip.add('user-agent');
+  }
+
+  /**
+   * Get data protection cluster capabilities
+   * List the data protection capabilities for all the underlying clusters.
+   * @param {Object} opts Optional parameters defined for the operation
+   * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It 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 might lead to no results.
+    * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 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.
+    * @param { String } opts.$filter A URL query parameter that 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+   * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.
+   * @param { String } opts.$orderby A URL query parameter that 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 descending order.
+   * @param { String } opts.$select A URL query parameter that 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](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) 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.
+   * @param {Object} args Additional Arguments
+   * @return {Promise<ListDPClusterCapabilitiesApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListDPClusterCapabilitiesApiResponse } and HTTP response
+   */
+  listDataProtectionClusterCapabilities(opts, ...args) {
+    let argMap = args.length > 0 ? args[0] : {};
+    opts = opts || {};
+    const postBody = null;
+    const pathParams = {};
+    const queryParams = {
+      ...(opts.hasOwnProperty('$page') ? {
+        '$page': opts['$page']
+      } : {}),
+      ...(opts.hasOwnProperty('$limit') ? {
+        '$limit': opts['$limit']
+      } : {}),
+      ...(opts.hasOwnProperty('$filter') ? {
+        '$filter': opts['$filter']
+      } : {}),
+      ...(opts.hasOwnProperty('$orderby') ? {
+        '$orderby': opts['$orderby']
+      } : {}),
+      ...(opts.hasOwnProperty('$select') ? {
+        '$select': opts['$select']
+      } : {})
+    };
+    let headersToInclude = {};
+    Object.keys(argMap).forEach(header => {
+      if (!this.#headersToSkip.has(header.toLowerCase())) {
+        headersToInclude[header] = argMap[header];
+      }
+    });
+    const headerParams = {
+      ...headersToInclude
+    };
+    const formParams = {};
+    const authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+    const contentTypes = [];
+    const accepts = ['application/json'];
+    const returnType = _ListDPClusterCapabilitiesApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/cluster-capabilities', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+}
+exports.DataProtectionClusterCapabilitiesApi = DataProtectionClusterCapabilitiesApi;

package/dist/es/apis/protectedresources-endpoints.d.ts

@@ -1,6 +1,6 @@
 /**
  * ProtectedResources service.
- * @version 4.1.1
+ * @version 4.2.1
  * @class ProtectedResourcesApi
  */
 export class ProtectedResourcesApi {