@gobodo/gobodo-api 0.1.217 → 0.1.219

package/dist/api/AIApi.js

@@ -5,10 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _AIConfigRequest = _interopRequireDefault(require("../model/AIConfigRequest"));
+var _AIConfigResponse = _interopRequireDefault(require("../model/AIConfigResponse"));
 var _AIPromptRequest = _interopRequireDefault(require("../model/AIPromptRequest"));
 var _AIPromptResponse = _interopRequireDefault(require("../model/AIPromptResponse"));
-var _AITenantConfigRequest = _interopRequireDefault(require("../model/AITenantConfigRequest"));
-var _AITenantConfigResponse = _interopRequireDefault(require("../model/AITenantConfigResponse"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 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(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -19,7 +19,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * gobodo-api
  * REST Interface for Gobodo API
  *
- * The version of the OpenAPI document: 0.1.217
+ * The version of the OpenAPI document: 0.1.219
  * Contact: info@gobodo.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,7 +30,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * AI service.
 * @module api/AIApi
-* @version 0.1.217
+* @version 0.1.219
 */
 var AIApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -46,16 +46,17 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
   }
 
   /**
-   * Callback function to receive the result of the getDefaultProvider operation.
-   * @callback module:api/AIApi~getDefaultProviderCallback
+   * Callback function to receive the result of the executeAnalyticsQuery operation.
+   * @callback module:api/AIApi~executeAnalyticsQueryCallback
    * @param {String} error Error message, if any.
    * @param {String} data The data returned by the service call.
    * @param {String} response The complete HTTP response.
    */
 
   /**
-   * Get the default AI provider
-   * Returns the name of the default AI provider
+   * Execute an analytics query
+   * Executes a natural language analytics query on Gobodo data
+   * @param {Object.<String, {String: Object}>} requestBody 
    * @param {Object} opts Optional parameters
    * @param {String} [authorization] The authorization token of the logged in user
    * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
@@ -63,10 +64,114 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
    * @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
-   * @param {module:api/AIApi~getDefaultProviderCallback} callback The callback function, accepting three arguments: error, data, response
+   * @param {module:api/AIApi~executeAnalyticsQueryCallback} callback The callback function, accepting three arguments: error, data, response
    * data is of type: {@link String}
    */
   return _createClass(AIApi, [{
+    key: "executeAnalyticsQuery",
+    value: function executeAnalyticsQuery(requestBody, opts, callback) {
+      opts = opts || {};
+      var postBody = requestBody;
+      // verify the required parameter 'requestBody' is set
+      if (requestBody === undefined || requestBody === null) {
+        throw new Error("Missing the required parameter 'requestBody' when calling executeAnalyticsQuery");
+      }
+      var pathParams = {};
+      var queryParams = {};
+      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 = ['application/json'];
+      var returnType = 'String';
+      return this.apiClient.callApi('/ai/analytics/query', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the executeAnalyticsQueryInConversation operation.
+     * @callback module:api/AIApi~executeAnalyticsQueryInConversationCallback
+     * @param {String} error Error message, if any.
+     * @param {String} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Execute analytics query in conversation context
+     * Executes an analytics query using conversation context
+     * @param {Number} conversationId 
+     * @param {Object.<String, {String: Object}>} requestBody 
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @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
+     * @param {module:api/AIApi~executeAnalyticsQueryInConversationCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link String}
+     */
+  }, {
+    key: "executeAnalyticsQueryInConversation",
+    value: function executeAnalyticsQueryInConversation(conversationId, requestBody, opts, callback) {
+      opts = opts || {};
+      var postBody = requestBody;
+      // verify the required parameter 'conversationId' is set
+      if (conversationId === undefined || conversationId === null) {
+        throw new Error("Missing the required parameter 'conversationId' when calling executeAnalyticsQueryInConversation");
+      }
+      // verify the required parameter 'requestBody' is set
+      if (requestBody === undefined || requestBody === null) {
+        throw new Error("Missing the required parameter 'requestBody' when calling executeAnalyticsQueryInConversation");
+      }
+      var pathParams = {
+        'conversationId': conversationId
+      };
+      var queryParams = {};
+      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 = ['application/json'];
+      var returnType = 'String';
+      return this.apiClient.callApi('/ai/conversations/{conversationId}/analytics', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the getDefaultProvider operation.
+     * @callback module:api/AIApi~getDefaultProviderCallback
+     * @param {String} error Error message, if any.
+     * @param {String} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get the default AI provider
+     * Returns the name of the default AI provider
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @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
+     * @param {module:api/AIApi~getDefaultProviderCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link String}
+     */
+  }, {
     key: "getDefaultProvider",
     value: function getDefaultProvider(opts, callback) {
       opts = opts || {};
@@ -188,7 +293,7 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
      * Callback function to receive the result of the getTenantAIConfig operation.
      * @callback module:api/AIApi~getTenantAIConfigCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/AITenantConfigResponse} data The data returned by the service call.
+     * @param {module:model/AIConfigResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
 
@@ -205,7 +310,7 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Number} [siteId] Optional site id to target. At most one of siteId or restApplicationId may be provided.
      * @param {Number} [restApplicationId] Optional rest application id to target. At most one of siteId or restApplicationId may be provided.
      * @param {module:api/AIApi~getTenantAIConfigCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/AITenantConfigResponse}
+     * data is of type: {@link module:model/AIConfigResponse}
      */
   }, {
     key: "getTenantAIConfig",
@@ -229,7 +334,7 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
       var contentTypes = [];
       var accepts = ['application/json'];
-      var returnType = _AITenantConfigResponse["default"];
+      var returnType = _AIConfigResponse["default"];
       return this.apiClient.callApi('/ai/config', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
 
@@ -237,7 +342,7 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
      * Callback function to receive the result of the getTenantAIProviderConfig operation.
      * @callback module:api/AIApi~getTenantAIProviderConfigCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/AITenantConfigResponse} data The data returned by the service call.
+     * @param {module:model/AIConfigResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
 
@@ -255,7 +360,7 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Number} [siteId] Optional site id to target. At most one of siteId or restApplicationId may be provided.
      * @param {Number} [restApplicationId] Optional rest application id to target. At most one of siteId or restApplicationId may be provided.
      * @param {module:api/AIApi~getTenantAIProviderConfigCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/AITenantConfigResponse}
+     * data is of type: {@link module:model/AIConfigResponse}
      */
   }, {
     key: "getTenantAIProviderConfig",
@@ -285,7 +390,7 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
       var contentTypes = [];
       var accepts = ['application/json'];
-      var returnType = _AITenantConfigResponse["default"];
+      var returnType = _AIConfigResponse["default"];
       return this.apiClient.callApi('/ai/config/{provider}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
 
@@ -449,7 +554,7 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
      * Callback function to receive the result of the testTenantAIProviderConfig operation.
      * @callback module:api/AIApi~testTenantAIProviderConfigCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/AITenantConfigResponse} data The data returned by the service call.
+     * @param {module:model/AIConfigResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
 
@@ -467,7 +572,7 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Number} [siteId] Optional site id to target. At most one of siteId or restApplicationId may be provided.
      * @param {Number} [restApplicationId] Optional rest application id to target. At most one of siteId or restApplicationId may be provided.
      * @param {module:api/AIApi~testTenantAIProviderConfigCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/AITenantConfigResponse}
+     * data is of type: {@link module:model/AIConfigResponse}
      */
   }, {
     key: "testTenantAIProviderConfig",
@@ -497,7 +602,7 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
       var contentTypes = [];
       var accepts = ['application/json'];
-      var returnType = _AITenantConfigResponse["default"];
+      var returnType = _AIConfigResponse["default"];
       return this.apiClient.callApi('/ai/config/{provider}/test', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
 
@@ -610,14 +715,14 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
      * Callback function to receive the result of the updateTenantAIConfig operation.
      * @callback module:api/AIApi~updateTenantAIConfigCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/AITenantConfigResponse} data The data returned by the service call.
+     * @param {module:model/AIConfigResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
 
     /**
      * Update tenant AI configuration
      * Updates scoped AI configuration for a Site or RestApplication. Requires CATEGORY_ADMIN on the target tenant.
-     * @param {module:model/AITenantConfigRequest} aITenantConfigRequest 
+     * @param {module:model/AIConfigRequest} aIConfigRequest 
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
      * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
@@ -628,16 +733,16 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Number} [siteId] Optional site id to target. At most one of siteId or restApplicationId may be provided.
      * @param {Number} [restApplicationId] Optional rest application id to target. At most one of siteId or restApplicationId may be provided.
      * @param {module:api/AIApi~updateTenantAIConfigCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/AITenantConfigResponse}
+     * data is of type: {@link module:model/AIConfigResponse}
      */
   }, {
     key: "updateTenantAIConfig",
-    value: function updateTenantAIConfig(aITenantConfigRequest, opts, callback) {
+    value: function updateTenantAIConfig(aIConfigRequest, opts, callback) {
       opts = opts || {};
-      var postBody = aITenantConfigRequest;
-      // verify the required parameter 'aITenantConfigRequest' is set
-      if (aITenantConfigRequest === undefined || aITenantConfigRequest === null) {
-        throw new Error("Missing the required parameter 'aITenantConfigRequest' when calling updateTenantAIConfig");
+      var postBody = aIConfigRequest;
+      // verify the required parameter 'aIConfigRequest' is set
+      if (aIConfigRequest === undefined || aIConfigRequest === null) {
+        throw new Error("Missing the required parameter 'aIConfigRequest' when calling updateTenantAIConfig");
       }
       var pathParams = {};
       var queryParams = {
@@ -656,7 +761,7 @@ var AIApi = exports["default"] = /*#__PURE__*/function () {
       var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
       var contentTypes = ['application/json'];
       var accepts = ['application/json'];
-      var returnType = _AITenantConfigResponse["default"];
+      var returnType = _AIConfigResponse["default"];
       return this.apiClient.callApi('/ai/config', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
   }]);