@gobodo/gobodo-api-promise 0.1.34

package/dist/api/GraphTraversalApi.js

@@ -0,0 +1,415 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _GraphObjectSchema = _interopRequireDefault(require("../model/GraphObjectSchema"));
+var _GraphTraversalInput = _interopRequireDefault(require("../model/GraphTraversalInput"));
+var _Path = _interopRequireDefault(require("../model/Path"));
+var _TraversalRelationResponse = _interopRequireDefault(require("../model/TraversalRelationResponse"));
+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.34
+ * 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.
+ *
+ */
+/**
+* GraphTraversal service.
+* @module api/GraphTraversalApi
+* @version 0.1.34
+*/
+var GraphTraversalApi = exports["default"] = /*#__PURE__*/function () {
+  /**
+  * Constructs a new GraphTraversalApi. 
+  * @alias module:api/GraphTraversalApi
+  * @class
+  * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+  * default to {@link module:ApiClient#instance} if unspecified.
+  */
+  function GraphTraversalApi(apiClient) {
+    _classCallCheck(this, GraphTraversalApi);
+    this.apiClient = apiClient || _ApiClient["default"].instance;
+  }
+
+  /**
+   * Traverses the graph and returns a list of discovered paths
+   * Traverses the graph based on the traversal query provided
+   * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+   * @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} [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 data of type {@link Array.<module:model/Path>} and HTTP response
+   */
+  _createClass(GraphTraversalApi, [{
+    key: "traverseWithHttpInfo",
+    value: function traverseWithHttpInfo(graphTraversalInput, opts) {
+      opts = opts || {};
+      var postBody = graphTraversalInput;
+      // verify the required parameter 'graphTraversalInput' is set
+      if (graphTraversalInput === undefined || graphTraversalInput === null) {
+        throw new Error("Missing the required parameter 'graphTraversalInput' when calling traverse");
+      }
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {
+        'Authorization': opts['authorization'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        '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 = [_Path["default"]];
+      return this.apiClient.callApi('/graph/data/traverse', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Traverses the graph and returns a list of discovered paths
+     * Traverses the graph based on the traversal query provided
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @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.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}, with data of type {@link Array.<module:model/Path>}
+     */
+  }, {
+    key: "traverse",
+    value: function traverse(graphTraversalInput, opts) {
+      return this.traverseWithHttpInfo(graphTraversalInput, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Traverses the graph from this object and returns a list of discovered paths
+     * @param {Number} id The id of the object being traversed from
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @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} [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 data of type {@link Array.<module:model/Path>} and HTTP response
+     */
+  }, {
+    key: "traverseFromWithHttpInfo",
+    value: function traverseFromWithHttpInfo(id, graphTraversalInput, opts) {
+      opts = opts || {};
+      var postBody = graphTraversalInput;
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling traverseFrom");
+      }
+      // verify the required parameter 'graphTraversalInput' is set
+      if (graphTraversalInput === undefined || graphTraversalInput === null) {
+        throw new Error("Missing the required parameter 'graphTraversalInput' when calling traverseFrom");
+      }
+      var pathParams = {
+        'id': id
+      };
+      var queryParams = {};
+      var headerParams = {
+        'Authorization': opts['authorization'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        '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 = [_Path["default"]];
+      return this.apiClient.callApi('/graph/data/traverse/{id}/traverse', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Traverses the graph from this object and returns a list of discovered paths
+     * @param {Number} id The id of the object being traversed from
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @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.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}, with data of type {@link Array.<module:model/Path>}
+     */
+  }, {
+    key: "traverseFrom",
+    value: function traverseFrom(id, graphTraversalInput, opts) {
+      return this.traverseFromWithHttpInfo(id, graphTraversalInput, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Traverses the graph from this object and returns a list of discovered objects
+     * @param {Number} id The id of the object being traversed from
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @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} [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 data of type {@link Array.<module:model/GraphObjectSchema>} and HTTP response
+     */
+  }, {
+    key: "traverseFromFindObjectsWithHttpInfo",
+    value: function traverseFromFindObjectsWithHttpInfo(id, graphTraversalInput, opts) {
+      opts = opts || {};
+      var postBody = graphTraversalInput;
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling traverseFromFindObjects");
+      }
+      // verify the required parameter 'graphTraversalInput' is set
+      if (graphTraversalInput === undefined || graphTraversalInput === null) {
+        throw new Error("Missing the required parameter 'graphTraversalInput' when calling traverseFromFindObjects");
+      }
+      var pathParams = {
+        'id': id
+      };
+      var queryParams = {};
+      var headerParams = {
+        'Authorization': opts['authorization'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        '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 = [_GraphObjectSchema["default"]];
+      return this.apiClient.callApi('/graph/data/traverse/{id}/traverseobjects', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Traverses the graph from this object and returns a list of discovered objects
+     * @param {Number} id The id of the object being traversed from
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @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.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}, with data of type {@link Array.<module:model/GraphObjectSchema>}
+     */
+  }, {
+    key: "traverseFromFindObjects",
+    value: function traverseFromFindObjects(id, graphTraversalInput, opts) {
+      return this.traverseFromFindObjectsWithHttpInfo(id, graphTraversalInput, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Traverses the graph from this object and returns a list of discovered relationships
+     * @param {Number} id The id of the object being traversed from
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @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} [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 data of type {@link module:model/TraversalRelationResponse} and HTTP response
+     */
+  }, {
+    key: "traverseFromFindRelationshipsWithHttpInfo",
+    value: function traverseFromFindRelationshipsWithHttpInfo(id, graphTraversalInput, opts) {
+      opts = opts || {};
+      var postBody = graphTraversalInput;
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling traverseFromFindRelationships");
+      }
+      // verify the required parameter 'graphTraversalInput' is set
+      if (graphTraversalInput === undefined || graphTraversalInput === null) {
+        throw new Error("Missing the required parameter 'graphTraversalInput' when calling traverseFromFindRelationships");
+      }
+      var pathParams = {
+        'id': id
+      };
+      var queryParams = {};
+      var headerParams = {
+        'Authorization': opts['authorization'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        '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 = _TraversalRelationResponse["default"];
+      return this.apiClient.callApi('/graph/data/traverse/{id}/traverserelationships', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Traverses the graph from this object and returns a list of discovered relationships
+     * @param {Number} id The id of the object being traversed from
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @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.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}, with data of type {@link module:model/TraversalRelationResponse}
+     */
+  }, {
+    key: "traverseFromFindRelationships",
+    value: function traverseFromFindRelationships(id, graphTraversalInput, opts) {
+      return this.traverseFromFindRelationshipsWithHttpInfo(id, graphTraversalInput, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Traverses the graph based on the traversal query provided and returns the discovered objects
+     * Traverses the graph based on the traversal query provided
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @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} [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 data of type {@link Array.<module:model/GraphObjectSchema>} and HTTP response
+     */
+  }, {
+    key: "traverseObjectsWithHttpInfo",
+    value: function traverseObjectsWithHttpInfo(graphTraversalInput, opts) {
+      opts = opts || {};
+      var postBody = graphTraversalInput;
+      // verify the required parameter 'graphTraversalInput' is set
+      if (graphTraversalInput === undefined || graphTraversalInput === null) {
+        throw new Error("Missing the required parameter 'graphTraversalInput' when calling traverseObjects");
+      }
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {
+        'Authorization': opts['authorization'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        '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 = [_GraphObjectSchema["default"]];
+      return this.apiClient.callApi('/graph/data/traverse/objects', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Traverses the graph based on the traversal query provided and returns the discovered objects
+     * Traverses the graph based on the traversal query provided
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @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.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}, with data of type {@link Array.<module:model/GraphObjectSchema>}
+     */
+  }, {
+    key: "traverseObjects",
+    value: function traverseObjects(graphTraversalInput, opts) {
+      return this.traverseObjectsWithHttpInfo(graphTraversalInput, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Traverses the graph based on the traversal query provided and returns the discovered relationships
+     * Traverses the graph based on the traversal query provided
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @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} [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 data of type {@link module:model/TraversalRelationResponse} and HTTP response
+     */
+  }, {
+    key: "traverseRelationshipsWithHttpInfo",
+    value: function traverseRelationshipsWithHttpInfo(graphTraversalInput, opts) {
+      opts = opts || {};
+      var postBody = graphTraversalInput;
+      // verify the required parameter 'graphTraversalInput' is set
+      if (graphTraversalInput === undefined || graphTraversalInput === null) {
+        throw new Error("Missing the required parameter 'graphTraversalInput' when calling traverseRelationships");
+      }
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {
+        'Authorization': opts['authorization'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        '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 = _TraversalRelationResponse["default"];
+      return this.apiClient.callApi('/graph/data/traverse/relationships', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Traverses the graph based on the traversal query provided and returns the discovered relationships
+     * Traverses the graph based on the traversal query provided
+     * @param {module:model/GraphTraversalInput} graphTraversalInput The traversal query to execute
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @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.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}, with data of type {@link module:model/TraversalRelationResponse}
+     */
+  }, {
+    key: "traverseRelationships",
+    value: function traverseRelationships(graphTraversalInput, opts) {
+      return this.traverseRelationshipsWithHttpInfo(graphTraversalInput, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+  }]);
+  return GraphTraversalApi;
+}();