@gobodo/gobodo-api-promise 0.1.87 → 0.1.89

package/dist/api/GraphTraversalApi.d.ts

@@ -0,0 +1,345 @@
+/**
+* GraphTraversal service.
+* @module api/GraphTraversalApi
+* @version 0.1.89
+*/
+export default class GraphTraversalApi {
+    /**
+    * 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.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * 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} [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 {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
+     */
+    traverseWithHttpInfo(graphTraversalInput: any, opts: any): Promise<any>;
+    /**
+     * 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.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 {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>}
+     */
+    traverse(graphTraversalInput: any, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * 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} [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 {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
+     */
+    traverseFromWithHttpInfo(id: number, graphTraversalInput: any, opts: any): Promise<any>;
+    /**
+     * 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.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 {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>}
+     */
+    traverseFrom(id: number, graphTraversalInput: any, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * 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} [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 {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
+     */
+    traverseFromFindObjectsWithHttpInfo(id: number, graphTraversalInput: any, opts: any): Promise<any>;
+    /**
+     * 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.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 {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>}
+     */
+    traverseFromFindObjects(id: number, graphTraversalInput: any, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * 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} [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 {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
+     */
+    traverseFromFindRelationshipsWithHttpInfo(id: number, graphTraversalInput: any, opts: any): Promise<any>;
+    /**
+     * 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.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 {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}
+     */
+    traverseFromFindRelationships(id: number, graphTraversalInput: any, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * 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} [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 {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
+     */
+    traverseObjectsWithHttpInfo(graphTraversalInput: any, opts: any): Promise<any>;
+    /**
+     * 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.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 {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>}
+     */
+    traverseObjects(graphTraversalInput: any, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * Traverses the graph based on the traversal query provided and returns a count of 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} [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 {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 Number} and HTTP response
+     */
+    traverseObjectsCountWithHttpInfo(graphTraversalInput: any, opts: any): Promise<any>;
+    /**
+     * Traverses the graph based on the traversal query provided and returns a count of 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.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 {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 Number}
+     */
+    traverseObjectsCount(graphTraversalInput: any, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * 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} [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 {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
+     */
+    traverseRelationshipsWithHttpInfo(graphTraversalInput: any, opts: any): Promise<any>;
+    /**
+     * 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.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 {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}
+     */
+    traverseRelationships(graphTraversalInput: any, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+}

package/dist/api/GraphTraversalApi.js

@@ -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.87
+ * The version of the OpenAPI document: 0.1.89
  * 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
 /**
 * GraphTraversal service.
 * @module api/GraphTraversalApi
-* @version 0.1.87
+* @version 0.1.89
 */
 var GraphTraversalApi = exports["default"] = /*#__PURE__*/function () {
   /**