@nutanix-scratch/multidomain-js-client 4.2.1

package/dist/es/Paginable.d.ts

@@ -0,0 +1,95 @@
+/**
+* A model that represents a paginable response from a list endpoint.
+* @module Paginable
+* @version 4.2.1
+*/
+export default class Paginable {
+    /**
+    * Constructs a <code>Paginable</code> from a plain Javascript object, optionally creating a new instance.
+    * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+    * @param {Object} metadata The plain Javascript object bearing properties of interest.
+    * @param {module:Paginable} obj Optional instance to populate.
+    * @return {module:Paginable} The populated <code>Paginable</code> instance.
+    */
+    static constructFromObject(metadata: any, obj: any): any;
+    /**
+    * Get the first page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+    getFirstPage(): Promise<any>;
+    /**
+    * Get the previous page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+    getPrevPage(): Promise<any>;
+    /**
+    * Get the next page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+    getNextPage(): Promise<any>;
+    /**
+    * Get the last page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+    getLastPage(): Promise<any>;
+    /**
+    * Get the current page number
+    * @return {Number} the current page number, starts at 0
+    */
+    currentPage(): number;
+    /**
+    * Get the total number of pages
+    * @return {Number} the total number of pages available
+    */
+    countPages(): number;
+    /**
+    * Check if current page is first page
+    * @return {Boolean} True if current page is 0, false otherwise
+    */
+    isFirstPage(): boolean;
+    /**
+    * Check if current page is last page
+    * @return {Boolean} True if current page is countPages()-1, false otherwise
+    */
+    isLastPage(): boolean;
+    populatePaginationMetadata(apiClient: any, page: any, resultsPerPage: any): void;
+    apiClient: ApiClient;
+    page: number;
+    resultsPerPage: number;
+    _getLink(path: any): Promise<any>;
+    /**
+    * The link to first page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkFirst: string;
+    /**
+    * The link to previous page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkPrev: string;
+    /**
+    * The link to next page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkNext: string;
+    /**
+    * The link to last page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkLast: string;
+    /**
+    * Number of total results available
+    * @type {Number}
+    * @memberOf Paginable
+    */
+    resultsTotal: number;
+}
+import { ApiClient } from "./ApiClient";

package/dist/es/Paginable.js

@@ -0,0 +1,248 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _ApiClient = require("./ApiClient");
+/*
+ * Nutanix Multidomain Versioned 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.
+ *
+ */
+
+/**
+* A model that represents a paginable response from a list endpoint.
+* @module Paginable
+* @version 4.2.1
+*/
+class Paginable {
+  /**
+  * Constructs a new <code>Paginable</code>.
+  * @alias module:Paginable
+  * @class
+  */
+  constructor() {}
+
+  /**
+  * Constructs a <code>Paginable</code> from a plain Javascript object, optionally creating a new instance.
+  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+  * @param {Object} metadata The plain Javascript object bearing properties of interest.
+  * @param {module:Paginable} obj Optional instance to populate.
+  * @return {module:Paginable} The populated <code>Paginable</code> instance.
+  */
+  static constructFromObject(metadata, obj) {
+    if (metadata) {
+      obj = obj || new Paginable();
+      if (metadata.hasOwnProperty('links') && metadata['links'] !== null && metadata['links'] !== undefined) {
+        for (const link of metadata['links']) {
+          if (link.hasOwnProperty('rel') && link.hasOwnProperty('href')) {
+            switch (link['rel']) {
+              case 'first':
+                obj.linkFirst = link['href'];
+                break;
+              case 'prev':
+                obj.linkPrev = link['href'];
+                break;
+              case 'next':
+                obj.linkNext = link['href'];
+                break;
+              case 'last':
+                obj.linkLast = link['href'];
+                break;
+              default:
+                break;
+            }
+          }
+        }
+      }
+      if (metadata.hasOwnProperty('totalAvailableResults')) {
+        obj.resultsTotal = metadata['totalAvailableResults'];
+      }
+    }
+    return obj;
+  }
+
+  /**
+  * Get the first page of the set, if any
+  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+  *                   or rejects with error message if any issue (link not available, ...)
+  */
+  getFirstPage() {
+    if (this.isFirstPage()) {
+      return Promise.reject('Cannot navigate to first page : already on first page');
+    }
+    if (this.linkFirst === null) {
+      return Promise.reject('No link to first page provided in previous API response');
+    }
+    return this._getLink(this.linkFirst);
+  }
+
+  /**
+  * Get the previous page of the set, if any
+  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+  *                   or rejects with error message if any issue (link not available, ...)
+  */
+  getPrevPage() {
+    if (this.isFirstPage()) {
+      return Promise.reject('Cannot navigate to previous page : already on first page');
+    }
+    if (this.linkPrev === null) {
+      return Promise.reject('No link to previous page provided in previous API response');
+    }
+    return this._getLink(this.linkPrev);
+  }
+
+  /**
+  * Get the next page of the set, if any
+  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+  *                   or rejects with error message if any issue (link not available, ...)
+  */
+  getNextPage() {
+    if (this.isLastPage()) {
+      return Promise.reject('Cannot navigate to next page : already on last page');
+    }
+    if (this.linkNext === null) {
+      return Promise.reject('No link to next page provided in previous API response');
+    }
+    return this._getLink(this.linkNext);
+  }
+
+  /**
+  * Get the last page of the set, if any
+  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+  *                   or rejects with error message if any issue (link not available, ...)
+  */
+  getLastPage() {
+    if (this.isLastPage()) {
+      return Promise.reject('Cannot navigate to last page : already on last page');
+    }
+    if (this.linkLast === null) {
+      return Promise.reject('No link to last page provided in previous API response');
+    }
+    return this._getLink(this.linkLast);
+  }
+
+  /**
+  * Get the current page number
+  * @return {Number} the current page number, starts at 0
+  */
+  currentPage() {
+    if (this.page === null) {
+      return 0;
+    }
+    return this.page;
+  }
+
+  /**
+  * Get the total number of pages
+  * @return {Number} the total number of pages available
+  */
+  countPages() {
+    if (this.resultsPerPage === null || this.resultsTotal === null || this.resultsPerPage === 0) {
+      return 1;
+    }
+    return Math.ceil(this.resultsTotal / this.resultsPerPage);
+  }
+
+  /**
+  * Check if current page is first page
+  * @return {Boolean} True if current page is 0, false otherwise
+  */
+  isFirstPage() {
+    return this.currentPage() === 0;
+  }
+
+  /**
+  * Check if current page is last page
+  * @return {Boolean} True if current page is countPages()-1, false otherwise
+  */
+  isLastPage() {
+    return this.currentPage() === this.countPages() - 1;
+  }
+  populatePaginationMetadata(apiClient, page, resultsPerPage) {
+    this.apiClient = apiClient;
+    this.page = page;
+    this.resultsPerPage = resultsPerPage;
+  }
+  _getLink(path) {
+    // If no ApiClient defined, instantiate default one
+    if (this.apiClient === null) {
+      this.apiClient = _ApiClient.ApiClient.instance;
+    }
+    const postBody = {};
+    const pathParams = {};
+    const queryParams = {};
+    const headerParams = {};
+    const formParams = {};
+    const authNames = [];
+    const contentTypes = [];
+    const accepts = ['application/json'];
+    const returnType = this.constructor;
+    return this.apiClient.callApi(path, 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+}
+
+/**
+* The link to first page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+exports.default = Paginable;
+Paginable.prototype.linkFirst = null;
+
+/**
+* The link to previous page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+Paginable.prototype.linkPrev = null;
+
+/**
+* The link to next page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+Paginable.prototype.linkNext = null;
+
+/**
+* The link to last page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+Paginable.prototype.linkLast = null;
+
+/**
+* The ApiClient instance to use for further query
+* @type {ApiClient}
+* @memberOf Paginable
+*/
+Paginable.prototype.apiClient = null;
+
+/**
+* Current page number
+* @type {Number}
+* @memberOf Paginable
+*/
+Paginable.prototype.page = null;
+
+/**
+* Number of results per page
+* @type {Number}
+* @memberOf Paginable
+*/
+Paginable.prototype.resultsPerPage = null;
+
+/**
+* Number of total results available
+* @type {Number}
+* @memberOf Paginable
+*/
+Paginable.prototype.resultsTotal = null;

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

@@ -0,0 +1,84 @@
+/**
+ * ExternalRepositories service.
+ * @version 4.2.1
+ * @class ExternalRepositoriesApi
+ */
+export class ExternalRepositoriesApi {
+    /**
+    * 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 ExternalRepositoriesApi.
+     * @alias module:api/ExternalRepositoriesApi
+     * @class
+     * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+     * default to {@link module:ApiClient#instance} if unspecified.
+     */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Create an External repository.
+     * Create an External repository.
+     * @param { Required<Pick<ExternalRepository, 'name' | 'location'>> & Partial<ExternalRepository> } body specification
+     * @param {Object} args Additional Arguments
+     * @return {Promise<CreateExternalRepositoryApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateExternalRepositoryApiResponse } and HTTP response
+     */
+    createExternalRepository(body: Required<Pick<ExternalRepository, 'name' | 'location'>> & Partial<ExternalRepository>, ...args: any): Promise<CreateExternalRepositoryApiResponse>;
+    /**
+     * Delete an External repository.
+     * Delete an External repository by id.
+     * @param { String } extId External Repository identifier.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteExternalRepositoryApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteExternalRepositoryApiResponse } and HTTP response
+     */
+    deleteExternalRepositoryById(extId: string, ...args: any): Promise<DeleteExternalRepositoryApiResponse>;
+    /**
+     * Get an External repository by id.
+     * Get an External repository by id.
+     * @param { String } extId External Repository identifier.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetExternalRepositoryApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetExternalRepositoryApiResponse } and HTTP response
+     */
+    getExternalRepositoryById(extId: string, ...args: any): Promise<GetExternalRepositoryApiResponse>;
+    /**
+     * List External repositories.
+     * Get all External repositories.
+     * @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<ListExternalRepositoriesApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListExternalRepositoriesApiResponse } and HTTP response
+     */
+    listExternalRepositories(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ListExternalRepositoriesApiResponse>;
+    /**
+     * Update an External repository.
+     * Task Id corresponding to the External repository update operation.
+     * @param { Required<Pick<ExternalRepository, 'name' | 'location'>> & Partial<ExternalRepository> } body specification
+     * @param { String } extId External Repository identifier.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<UpdateExternalRepositoryApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateExternalRepositoryApiResponse } and HTTP response
+     */
+    updateExternalRepositoryById(extId: string, body: Required<Pick<ExternalRepository, 'name' | 'location'>> & Partial<ExternalRepository>, ...args: any): Promise<UpdateExternalRepositoryApiResponse>;
+    #private;
+}
+import ExternalRepository from "../models/multidomain/v4/config/ExternalRepository";
+import CreateExternalRepositoryApiResponse from "../models/multidomain/v4/config/CreateExternalRepositoryApiResponse";
+import DeleteExternalRepositoryApiResponse from "../models/multidomain/v4/config/DeleteExternalRepositoryApiResponse";
+import GetExternalRepositoryApiResponse from "../models/multidomain/v4/config/GetExternalRepositoryApiResponse";
+import ListExternalRepositoriesApiResponse from "../models/multidomain/v4/config/ListExternalRepositoriesApiResponse";
+import UpdateExternalRepositoryApiResponse from "../models/multidomain/v4/config/UpdateExternalRepositoryApiResponse";
+import { ApiClient } from "../ApiClient";