@gobodo/gobodo-api-promise 0.1.174 → 0.1.176

package/dist/api/TabDefinitionsApi.js

@@ -0,0 +1,379 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _CacheInvalidation = _interopRequireDefault(require("../model/CacheInvalidation"));
+var _TabItemDefinitionInput = _interopRequireDefault(require("../model/TabItemDefinitionInput"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+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); }
+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 : String(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); } /**
+ * gobodo-api
+ * REST Interface for Gobodo API
+ *
+ * The version of the OpenAPI document: 0.1.176
+ * Contact: info@gobodo.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+* TabDefinitions service.
+* @module api/TabDefinitionsApi
+* @version 0.1.176
+*/
+var TabDefinitionsApi = exports["default"] = /*#__PURE__*/function () {
+  /**
+  * Constructs a new TabDefinitionsApi. 
+  * @alias module:api/TabDefinitionsApi
+  * @class
+  * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+  * default to {@link module:ApiClient#instance} if unspecified.
+  */
+  function TabDefinitionsApi(apiClient) {
+    _classCallCheck(this, TabDefinitionsApi);
+    this.apiClient = apiClient || _ApiClient["default"].instance;
+  }
+
+  /**
+   * Create Tab Definition
+   * @param {Number} schemaId 
+   * @param {module:model/TabItemDefinitionInput} tabItemDefinitionInput 
+   * @param {Object} opts Optional parameters
+   * @param {String} [authorization] The authorization token of the logged in user
+   * @param {Number} [cacheduration] The how long the cache entry should persist
+   * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+   * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+   * @param {module:model/String} [cachescope] The scope of storage of the cache item
+   * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+   * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+   * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+   * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+   * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+   * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+   * @param {String} [transactionid] The id of the transaction this operation is being run in
+   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+   */
+  _createClass(TabDefinitionsApi, [{
+    key: "createTabDefinitionWithHttpInfo",
+    value: function createTabDefinitionWithHttpInfo(schemaId, tabItemDefinitionInput, opts) {
+      opts = opts || {};
+      var postBody = tabItemDefinitionInput;
+      // verify the required parameter 'schemaId' is set
+      if (schemaId === undefined || schemaId === null) {
+        throw new Error("Missing the required parameter 'schemaId' when calling createTabDefinition");
+      }
+      // verify the required parameter 'tabItemDefinitionInput' is set
+      if (tabItemDefinitionInput === undefined || tabItemDefinitionInput === null) {
+        throw new Error("Missing the required parameter 'tabItemDefinitionInput' when calling createTabDefinition");
+      }
+      var pathParams = {
+        'schemaId': schemaId
+      };
+      var queryParams = {
+        'cacheduration': opts['cacheduration'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
+        'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
+        'cachescope': opts['cachescope'],
+        'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
+        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
+      };
+      var headerParams = {
+        'Authorization': opts['authorization'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        'zeusportal-postas-org': opts['zeusportalPostasOrg'],
+        'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-site': opts['zeusportalPostasSite'],
+        'transactionid': opts['transactionid']
+      };
+      var formParams = {};
+      var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
+      var contentTypes = ['application/json'];
+      var accepts = [];
+      var returnType = null;
+      return this.apiClient.callApi('/tabs/definitions/schema/{schemaId}', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Create Tab Definition
+     * @param {Number} schemaId 
+     * @param {module:model/TabItemDefinitionInput} tabItemDefinitionInput 
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.zeusportalPostasOrg The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} opts.zeusportalPostas The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+  }, {
+    key: "createTabDefinition",
+    value: function createTabDefinition(schemaId, tabItemDefinitionInput, opts) {
+      return this.createTabDefinitionWithHttpInfo(schemaId, tabItemDefinitionInput, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Delete Tab Definition
+     * @param {Number} id 
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     */
+  }, {
+    key: "deleteTabDefinitionWithHttpInfo",
+    value: function deleteTabDefinitionWithHttpInfo(id, opts) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling deleteTabDefinition");
+      }
+      var pathParams = {
+        'id': id
+      };
+      var queryParams = {
+        'cacheduration': opts['cacheduration'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
+        'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
+        'cachescope': opts['cachescope'],
+        'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
+        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
+      };
+      var headerParams = {
+        'Authorization': opts['authorization'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        'zeusportal-postas-org': opts['zeusportalPostasOrg'],
+        'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-site': opts['zeusportalPostasSite'],
+        'transactionid': opts['transactionid']
+      };
+      var formParams = {};
+      var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
+      var contentTypes = [];
+      var accepts = [];
+      var returnType = null;
+      return this.apiClient.callApi('/tabs/definitions/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Delete Tab Definition
+     * @param {Number} id 
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.zeusportalPostasOrg The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} opts.zeusportalPostas The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+  }, {
+    key: "deleteTabDefinition",
+    value: function deleteTabDefinition(id, opts) {
+      return this.deleteTabDefinitionWithHttpInfo(id, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * List Tab Definitions for Schema
+     * @param {Number} schemaId 
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     */
+  }, {
+    key: "listTabDefinitionsWithHttpInfo",
+    value: function listTabDefinitionsWithHttpInfo(schemaId, opts) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'schemaId' is set
+      if (schemaId === undefined || schemaId === null) {
+        throw new Error("Missing the required parameter 'schemaId' when calling listTabDefinitions");
+      }
+      var pathParams = {
+        'schemaId': schemaId
+      };
+      var queryParams = {
+        'cacheduration': opts['cacheduration'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
+        'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
+        'cachescope': opts['cachescope'],
+        'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
+        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
+      };
+      var headerParams = {
+        'Authorization': opts['authorization'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        'zeusportal-postas-org': opts['zeusportalPostasOrg'],
+        'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-site': opts['zeusportalPostasSite'],
+        'transactionid': opts['transactionid']
+      };
+      var formParams = {};
+      var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
+      var contentTypes = [];
+      var accepts = [];
+      var returnType = null;
+      return this.apiClient.callApi('/tabs/definitions/schema/{schemaId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * List Tab Definitions for Schema
+     * @param {Number} schemaId 
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.zeusportalPostasOrg The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} opts.zeusportalPostas The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+  }, {
+    key: "listTabDefinitions",
+    value: function listTabDefinitions(schemaId, opts) {
+      return this.listTabDefinitionsWithHttpInfo(schemaId, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Update Tab Definition
+     * @param {Number} id 
+     * @param {module:model/TabItemDefinitionInput} tabItemDefinitionInput 
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     */
+  }, {
+    key: "updateTabDefinitionWithHttpInfo",
+    value: function updateTabDefinitionWithHttpInfo(id, tabItemDefinitionInput, opts) {
+      opts = opts || {};
+      var postBody = tabItemDefinitionInput;
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling updateTabDefinition");
+      }
+      // verify the required parameter 'tabItemDefinitionInput' is set
+      if (tabItemDefinitionInput === undefined || tabItemDefinitionInput === null) {
+        throw new Error("Missing the required parameter 'tabItemDefinitionInput' when calling updateTabDefinition");
+      }
+      var pathParams = {
+        'id': id
+      };
+      var queryParams = {
+        'cacheduration': opts['cacheduration'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
+        'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
+        'cachescope': opts['cachescope'],
+        'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
+        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
+      };
+      var headerParams = {
+        'Authorization': opts['authorization'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        'zeusportal-postas-org': opts['zeusportalPostasOrg'],
+        'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-site': opts['zeusportalPostasSite'],
+        'transactionid': opts['transactionid']
+      };
+      var formParams = {};
+      var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
+      var contentTypes = ['application/json'];
+      var accepts = [];
+      var returnType = null;
+      return this.apiClient.callApi('/tabs/definitions/{id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Update Tab Definition
+     * @param {Number} id 
+     * @param {module:model/TabItemDefinitionInput} tabItemDefinitionInput 
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Array.<module:model/CacheInvalidation>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.zeusportalPostasOrg The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} opts.zeusportalPostas The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+  }, {
+    key: "updateTabDefinition",
+    value: function updateTabDefinition(id, tabItemDefinitionInput, opts) {
+      return this.updateTabDefinitionWithHttpInfo(id, tabItemDefinitionInput, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+  }]);
+  return TabDefinitionsApi;
+}();