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

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

@@ -0,0 +1,291 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.RecoveryPlanJobsApi = void 0;
+var _ApiClient = require("../ApiClient");
+var _GetRecoveryPlanJobApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/GetRecoveryPlanJobApiResponse"));
+var _DeleteRecoveryPlanJobApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/DeleteRecoveryPlanJobApiResponse"));
+var _ListRecoveryPlanJobValidationErrorsApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/ListRecoveryPlanJobValidationErrorsApiResponse"));
+var _ListRecoveryPlanJobsApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/ListRecoveryPlanJobsApiResponse"));
+var _ListRecoveryPlanJobExecutionStepsApiResponse = _interopRequireDefault(require("../models/dataprotection/v4/config/ListRecoveryPlanJobExecutionStepsApiResponse"));
+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.
+ *
+ */
+
+/**
+ * RecoveryPlanJobs service.
+ * @version 4.2.1
+ * @class RecoveryPlanJobsApi
+ */
+class RecoveryPlanJobsApi {
+  #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 RecoveryPlanJobsApi. 
+   * @alias module:api/RecoveryPlanJobsApi
+   * @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');
+  }
+
+  /**
+   * Delete Recovery Plan Job
+   * Delete the Recovery Plan Job for the provided {extId}.
+   * @param { String } extId The external identifier of the recovery plan job.
+   * @param {Object} args Additional Arguments
+   * @return {Promise<DeleteRecoveryPlanJobApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteRecoveryPlanJobApiResponse } and HTTP response
+   */
+  deleteRecoveryPlanJobById(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 deleteRecoveryPlanJobById");
+    }
+    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 = _DeleteRecoveryPlanJobApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/recovery-plan-jobs/{extId}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+
+  /**
+   * Get Recovery Plan Job
+   * Get the recovery plan job for the provided {extId}.
+   * @param { String } extId The external identifier of the recovery plan job.
+   * @param {Object} args Additional Arguments
+   * @return {Promise<GetRecoveryPlanJobApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetRecoveryPlanJobApiResponse } and HTTP response
+   */
+  getRecoveryPlanJobById(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 getRecoveryPlanJobById");
+    }
+    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 = _GetRecoveryPlanJobApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/recovery-plan-jobs/{extId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+
+  /**
+   * List Recovery Plan Job Execution Steps
+   * Status of the steps executed in a recovery plan job.
+   * @param { String } recoveryPlanJobExtId The external identifier of the recovery plan job.
+   * @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 {Object} args Additional Arguments
+   * @return {Promise<ListRecoveryPlanJobExecutionStepsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListRecoveryPlanJobExecutionStepsApiResponse } and HTTP response
+   */
+  listExecutionStepsByRecoveryPlanJobId(recoveryPlanJobExtId, opts, ...args) {
+    let argMap = args.length > 0 ? args[0] : {};
+    opts = opts || {};
+    const postBody = null;
+    // verify the required parameter 'recoveryPlanJobExtId' is set
+    if (typeof recoveryPlanJobExtId === 'undefined' || recoveryPlanJobExtId === null) {
+      throw new Error("Missing the required parameter 'recoveryPlanJobExtId' when calling listExecutionStepsByRecoveryPlanJobId");
+    }
+    const pathParams = {
+      'recoveryPlanJobExtId': recoveryPlanJobExtId
+    };
+    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']
+      } : {})
+    };
+    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 = _ListRecoveryPlanJobExecutionStepsApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/recovery-plan-jobs/{recoveryPlanJobExtId}/execution-steps', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+
+  /**
+   * List Recovery Plan Jobs
+   * List recovery plan jobs.
+   * @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<ListRecoveryPlanJobsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListRecoveryPlanJobsApiResponse } and HTTP response
+   */
+  listRecoveryPlanJobs(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 = _ListRecoveryPlanJobsApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/recovery-plan-jobs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+
+  /**
+   * List Recovery Plan Job Validation Errors
+   * Status of the validation errors that occurred in a recovery plan job. It returns the list of validation errors and warnings. Each error includes an error code (e.g., DP-303001) that can be used to identify the specific issue and resolution steps.&lt;br&gt;&lt;br&gt; The error guide is present in the Recovery Plan Validation Errors Guide. For detailed error code descriptions, causes, impacts, and resolution steps, refer to &lt;a href&#x3D;&#x27;https://portal.nutanix.com/page/documents/list?type&#x3D;software&amp;filterKey&#x3D;software&amp;filterVal&#x3D;Nutanix%20Disaster%20Recovery&#x27; target&#x3D;&#x27;_blank&#x27;&gt;Nutanix Disaster Recovery Documentation&lt;/a&gt;.
+   * @param { String } recoveryPlanJobExtId The external identifier of the recovery plan job.
+   * @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 {Object} args Additional Arguments
+   * @return {Promise<ListRecoveryPlanJobValidationErrorsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListRecoveryPlanJobValidationErrorsApiResponse } and HTTP response
+   */
+  listValidationErrorsByRecoveryPlanJobId(recoveryPlanJobExtId, opts, ...args) {
+    let argMap = args.length > 0 ? args[0] : {};
+    opts = opts || {};
+    const postBody = null;
+    // verify the required parameter 'recoveryPlanJobExtId' is set
+    if (typeof recoveryPlanJobExtId === 'undefined' || recoveryPlanJobExtId === null) {
+      throw new Error("Missing the required parameter 'recoveryPlanJobExtId' when calling listValidationErrorsByRecoveryPlanJobId");
+    }
+    const pathParams = {
+      'recoveryPlanJobExtId': recoveryPlanJobExtId
+    };
+    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']
+      } : {})
+    };
+    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 = _ListRecoveryPlanJobValidationErrorsApiResponse.default;
+    return this.apiClient.callApi('/api/dataprotection/v4.2/config/recovery-plan-jobs/{recoveryPlanJobExtId}/validation-errors', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+}
+exports.RecoveryPlanJobsApi = RecoveryPlanJobsApi;

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

@@ -1,6 +1,6 @@
 /**
  * RecoveryPoints service.
- * @version 4.0.1
+ * @version 4.2.1
  * @class RecoveryPointsApi
  */
 export class RecoveryPointsApi {
@@ -35,8 +35,8 @@ export class RecoveryPointsApi {
      */
     deleteRecoveryPointById(extId: string, ...args: any): Promise<DeleteRecoveryPointApiResponse>;
     /**
-     * Discover cluster info for a recovery point
-     * It returns cluster details, where given recovery point resides, and a certificate to access endpoint. The certificate must be set as the NTNX_IGW_SESSION cookie in the header. For example: Cookie: NTNX_IGW_SESSION&#x3D;&#x27;certificate&#x27;
+     * Discover cluster details for a recovery point
+     * It returns cluster details where the given recovery point is located, and a certificate to access the endpoint. The certificate must be set as a NTNX_IGW_SESSION cookie in the header. For example, Cookie: NTNX_IGW_SESSION&#x3D;&#x27;certificate&#x27;
      * @param { Required<Pick<ClusterDiscoverSpec, 'operation' | 'spec'>> & Partial<ClusterDiscoverSpec> } body specification
      * @param { String } extId The external identifier that can be used to retrieve the recovery point using its URL.
      * @param {Object} args Additional Arguments
@@ -62,7 +62,7 @@ export class RecoveryPointsApi {
     getVmRecoveryPointById(recoveryPointExtId: string, extId: string, ...args: any): Promise<GetVmRecoveryPointApiResponse>;
     /**
      * Get VSS metadata by VM recovery point ID
-     * The metadata documents of Volume Shadow Copy Service(VSS) writers and requesters are called VSS metadata. During a VSS backup operation, the VSS metadata is compressed into a cabinet file, which is in a .cab file format designed for storing compressed files. This cabinet file must be saved to the backup media during a backup operation, as required during a restore operation. This API returns the VSS metadata (data of the cabinet file) of a VM recovery point under a composite recovery point identified by an external identifier, which was saved during the create recovery point operation.
+     * The metadata documents of Volume Shadow Copy Service (VSS) writers and requesters are called VSS metadata. During a VSS backup operation, the VSS metadata is compressed into a cabinet file, which is in a .cab file format designed to store compressed files. This cabinet file must be saved to the backup media during a backup operation, as it is required during a restore operation. This API returns the VSS metadata (cabinet file) of a VM recovery point under a composite recovery point that is identified by an external identifier. This external identifier was saved during the recovery point creation operation.
      * @param { String } recoveryPointExtId The external identifier that can be used to retrieve the recovery point using its URL.
      * @param { String } vmRecoveryPointExtId The external identifier that can be used to identify a VM recovery point.
      * @param {Object} args Additional Arguments
@@ -71,7 +71,7 @@ export class RecoveryPointsApi {
     getVssMetadataByVmRecoveryPointId(recoveryPointExtId: string, vmRecoveryPointExtId: string, ...args: any): Promise<GetVssMetadataApiResponse>;
     /**
      * List recovery points
-     * List of recovery point.
+     * List of recovery points.
      * @param {Object} opts Optional parameters defined for the operation
      * @param { String } opts.xClusterId Cluster type from which recovery points must be fetched. Valid values: [AOS, MST]
      * @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.
@@ -79,29 +79,9 @@ export class RecoveryPointsApi {
      * @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'.<br>
-     * The filter can be applied to the following fields:<br>
-     * - creationTime<br>
-     * - extId<br>
-     * - locationAgnosticId<br>
-     * - name<br>
-     * - ownerExtId<br>
-     * - recoveryPointType<br>
-     * - vmRecoveryPoints<br>
-     * - volumeGroupRecoveryPoints
-     * @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.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - creationTime<br>
-     * - expirationTime<br>
-     * - name<br>
-     * - ownerExtId
+     * 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.
-- creationTime
-- expirationTime
-- extId
-- name
-- recoveryPointType
-
      * @param {Object} args Additional Arguments
      * @return {Promise<ListRecoveryPointsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListRecoveryPointsApiResponse } and HTTP response
      */