@nutanix-scratch/networking-js-client 4.0.1-beta.1 → 4.0.2-beta.1

package/dist/es/apis/{uplinkbond-endpoints.d.ts → uplinkbonds-endpoints.d.ts}

@@ -1,17 +1,17 @@
 /**
- * UplinkBond service.
- * @version 4.0.1-beta-1
- * @class UplinkBondApi
+ * UplinkBonds service.
+ * @version 4.0.2-beta-1
+ * @class UplinkBondsApi
  */
-export class UplinkBondApi {
+export class UplinkBondsApi {
     /**
     * 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 UplinkBondApi.
-     * @alias module:api/UplinkBondApi
+     * Constructs a new UplinkBondsApi.
+     * @alias module:api/UplinkBondsApi
      * @class
      * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
      * default to {@link module:ApiClient#instance} if unspecified.
@@ -20,38 +20,38 @@ export class UplinkBondApi {
     apiClient: any;
     /**
      * Get uplink bond
-     * Get the uplink bond for the given extId. Requires Prism Central >= pc.2023.3.
+     * Get the uplink bond for the given extId.
      * @param { String } extId UUID of the bond
      * @param {Object} args Additional Arguments
-     * @return {Promise<UplinkBondApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UplinkBondApiResponse } and HTTP response
+     * @return {Promise<GetUplinkBondApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetUplinkBondApiResponse } and HTTP response
      */
-    getUplinkBond(extId: string, ...args: any): Promise<UplinkBondApiResponse>;
+    getUplinkBondById(extId: string, ...args: any): Promise<GetUplinkBondApiResponse>;
     /**
      * List uplink bonds
-     * List uplink bonds. Requires Prism Central &gt;&#x3D; pc.2023.3.
+     * List uplink bonds.
      * @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.  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.
+     * @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 { 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 URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter 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 on the following fields:<br>
+     * @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>
      * - hostReference
-     * @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 desc order.<br>
+     * @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>
      * - name
      * @param {Object} args Additional Arguments
-     * @return {Promise<UplinkBondListApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UplinkBondListApiResponse } and HTTP response
+     * @return {Promise<ListUplinkBondsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListUplinkBondsApiResponse } and HTTP response
      */
     listUplinkBonds(opts: {
         $page: number;
         $limit: number;
         $filter: string;
         $orderby: string;
-    }, ...args: any): Promise<UplinkBondListApiResponse>;
+    }, ...args: any): Promise<ListUplinkBondsApiResponse>;
     #private;
 }
-import UplinkBondApiResponse from "../models/networking/v4/config/UplinkBondApiResponse";
-import UplinkBondListApiResponse from "../models/networking/v4/config/UplinkBondListApiResponse";
+import GetUplinkBondApiResponse from "../models/networking/v4/config/GetUplinkBondApiResponse";
+import ListUplinkBondsApiResponse from "../models/networking/v4/config/ListUplinkBondsApiResponse";
 import { ApiClient } from "../ApiClient";

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

@@ -0,0 +1,155 @@
+"use strict";
+
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.UplinkBondsApi = void 0;
+var _ApiClient = require("../ApiClient");
+var _ListUplinkBondsApiResponse = _interopRequireDefault(require("../models/networking/v4/config/ListUplinkBondsApiResponse"));
+var _GetUplinkBondApiResponse = _interopRequireDefault(require("../models/networking/v4/config/GetUplinkBondApiResponse"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
+function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
+function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
+function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); } /*
+ * Nutanix Networking Versioned APIs
+ *
+ * OpenAPI spec version: 4.0.2-beta-1
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 16.8.0.7344-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * UplinkBonds service.
+ * @version 4.0.2-beta-1
+ * @class UplinkBondsApi
+ */
+var _headersToSkip = /*#__PURE__*/new WeakMap();
+var UplinkBondsApi = exports.UplinkBondsApi = /*#__PURE__*/function () {
+  /**
+   * Constructs a new UplinkBondsApi. 
+   * @alias module:api/UplinkBondsApi
+   * @class
+   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+   * default to {@link module:ApiClient#instance} if unspecified.
+   */
+  function UplinkBondsApi(apiClient) {
+    _classCallCheck(this, UplinkBondsApi);
+    _classPrivateFieldInitSpec(this, _headersToSkip, void 0);
+    this.apiClient = apiClient || _ApiClient.ApiClient.instance;
+    _classPrivateFieldSet(_headersToSkip, this, new Set());
+    _classPrivateFieldGet(_headersToSkip, this).add('authorization');
+    _classPrivateFieldGet(_headersToSkip, this).add('cookie');
+    _classPrivateFieldGet(_headersToSkip, this).add('host');
+    _classPrivateFieldGet(_headersToSkip, this).add('user-agent');
+  }
+
+  /**
+   * Get uplink bond
+   * Get the uplink bond for the given extId.
+   * @param { String } extId UUID of the bond
+   * @param {Object} args Additional Arguments
+   * @return {Promise<GetUplinkBondApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetUplinkBondApiResponse } and HTTP response
+   */
+  return _createClass(UplinkBondsApi, [{
+    key: "getUplinkBondById",
+    value: function getUplinkBondById(extId) {
+      var _this = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      var 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 getUplinkBondById");
+      }
+      var pathParams = {
+        'extId': extId
+      };
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _GetUplinkBondApiResponse["default"];
+      return this.apiClient.callApi('/api/networking/v4.0.b1/config/uplink-bonds/{extId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * List uplink bonds
+     * List uplink bonds.
+     * @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'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - hostReference
+     * @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>
+     * - name
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListUplinkBondsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListUplinkBondsApiResponse } and HTTP response
+     */
+  }, {
+    key: "listUplinkBonds",
+    value: function listUplinkBonds(opts) {
+      var _this2 = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      opts = opts || {};
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, opts.hasOwnProperty('$page') ? {
+        '$page': opts['$page']
+      } : {}), opts.hasOwnProperty('$limit') ? {
+        '$limit': opts['$limit']
+      } : {}), opts.hasOwnProperty('$filter') ? {
+        '$filter': opts['$filter']
+      } : {}), opts.hasOwnProperty('$orderby') ? {
+        '$orderby': opts['$orderby']
+      } : {});
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this2).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _ListUplinkBondsApiResponse["default"];
+      return this.apiClient.callApi('/api/networking/v4.0.b1/config/uplink-bonds', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+  }], [{
+    key: "ApiClient",
+    get:
+    /**
+    * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
+    * their own fetch methods into the SDK
+    */
+    function get() {
+      return _ApiClient.ApiClient;
+    }
+  }]);
+}();

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

@@ -0,0 +1,92 @@
+/**
+ * VirtualSwitches service.
+ * @version 4.0.2-beta-1
+ * @class VirtualSwitchesApi
+ */
+export class VirtualSwitchesApi {
+    /**
+    * 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 VirtualSwitchesApi.
+     * @alias module:api/VirtualSwitchesApi
+     * @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 a Virtual Switch
+     * Create a Virtual Switch.
+     * @param { Required<Pick<VirtualSwitch, 'name' | 'bondMode' | 'clusters'>> & Partial<VirtualSwitch> } body specification
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { String } opts.xClusterId Prism Element cluster reference. This header can be optionally supplied for Virtual Switch list requests, but is deprecated for all other Virtual Switch fetch/create/update/delete requests.
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ConfigTaskReferenceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ConfigTaskReferenceApiResponse } and HTTP response
+     */
+    createVirtualSwitch(body: Required<Pick<VirtualSwitch, 'name' | 'bondMode' | 'clusters'>> & Partial<VirtualSwitch>, opts: {
+        xClusterId: string;
+    }, ...args: any): Promise<ConfigTaskReferenceApiResponse>;
+    /**
+     * Delete a Virtual Switch
+     * Delete a Virtual Switch.
+     * @param { String } extId UUID of Virtual Switch
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { String } opts.xClusterId Prism Element cluster reference. This header can be optionally supplied for Virtual Switch list requests, but is deprecated for all other Virtual Switch fetch/create/update/delete requests.
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ConfigTaskReferenceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ConfigTaskReferenceApiResponse } and HTTP response
+     */
+    deleteVirtualSwitchById(extId: string, opts: {
+        xClusterId: string;
+    }, ...args: any): Promise<ConfigTaskReferenceApiResponse>;
+    /**
+     * Get single Virtual Switch given its UUID
+     * Get single Virtual Switch given its UUID.
+     * @param { String } extId UUID of Virtual Switch
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { String } opts.xClusterId Prism Element cluster reference. This header can be optionally supplied for Virtual Switch list requests, but is deprecated for all other Virtual Switch fetch/create/update/delete requests.
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetVirtualSwitchApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetVirtualSwitchApiResponse } and HTTP response
+     */
+    getVirtualSwitchById(extId: string, opts: {
+        xClusterId: string;
+    }, ...args: any): Promise<GetVirtualSwitchApiResponse>;
+    /**
+     * Get list of Virtual Switches
+     * Get list of Virtual Switches.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { String } opts.xClusterId Prism Element cluster reference. This header can be optionally supplied for Virtual Switch list requests, but is deprecated for all other Virtual Switch fetch/create/update/delete requests.
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListVirtualSwitchesApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListVirtualSwitchesApiResponse } and HTTP response
+     */
+    listVirtualSwitches(opts: {
+        xClusterId: string;
+    }, ...args: any): Promise<ListVirtualSwitchesApiResponse>;
+    /**
+     * Update a Virtual Switch
+     * Update a Virtual Switch.
+     * @param { Required<Pick<VirtualSwitch, 'name' | 'bondMode' | 'clusters'>> & Partial<VirtualSwitch> } body specification
+     * @param { String } extId UUID of Virtual Switch
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { String } opts.xClusterId Prism Element cluster reference. This header can be optionally supplied for Virtual Switch list requests, but is deprecated for all other Virtual Switch fetch/create/update/delete requests.
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ConfigTaskReferenceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ConfigTaskReferenceApiResponse } and HTTP response
+     */
+    updateVirtualSwitchById(extId: string, body: Required<Pick<VirtualSwitch, 'name' | 'bondMode' | 'clusters'>> & Partial<VirtualSwitch>, opts: {
+        xClusterId: string;
+    }, ...args: any): Promise<ConfigTaskReferenceApiResponse>;
+    #private;
+}
+import VirtualSwitch from "../models/networking/v4/config/VirtualSwitch";
+import ConfigTaskReferenceApiResponse from "../models/networking/v4/config/TaskReferenceApiResponse";
+import GetVirtualSwitchApiResponse from "../models/networking/v4/config/GetVirtualSwitchApiResponse";
+import ListVirtualSwitchesApiResponse from "../models/networking/v4/config/ListVirtualSwitchesApiResponse";
+import { ApiClient } from "../ApiClient";