@gobodo/gobodo-api 0.1.213 → 0.1.215

package/dist/api/GraphActionsApi.js

@@ -10,7 +10,9 @@ var _BulkUpsertActionPayload = _interopRequireDefault(require("../model/BulkUpse
 var _CacheInvalidation = _interopRequireDefault(require("../model/CacheInvalidation"));
 var _GraphActionPayload = _interopRequireDefault(require("../model/GraphActionPayload"));
 var _GraphActionResponse = _interopRequireDefault(require("../model/GraphActionResponse"));
+var _GraphTraversalInput = _interopRequireDefault(require("../model/GraphTraversalInput"));
 var _InputPart = _interopRequireDefault(require("../model/InputPart"));
+var _TraversalRelationResponse = _interopRequireDefault(require("../model/TraversalRelationResponse"));
 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"); }
@@ -21,7 +23,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.213
+ * The version of the OpenAPI document: 0.1.215
  * Contact: info@gobodo.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,7 +34,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * GraphActions service.
 * @module api/GraphActionsApi
-* @version 0.1.213
+* @version 0.1.215
 */
 var GraphActionsApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -205,7 +207,7 @@ var GraphActionsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} [objectSections] Comma-separated object response sections to include. Allowed values: objectType, data, mainPhoto, geocodes. If omitted, the default object response shape is returned.
      * @param {String} [relationshipSections] Comma-separated relationship response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default relationship response shape is returned.
      * @param {String} [actionSections] Comma-separated action response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default action response shape is returned.
-     * @param {String} [dataFields] Comma-separated exact property keys to include inside any returned data object. If present, only those keys are returned for object, relationship, and action data, and data is implicitly included.
+     * @param {String} [dataFields] Comma-separated property selectors to include inside any returned data object. Supports exact root keys like acceptor and nested selectors like acceptor.name, acceptor.age, or topics.relatedObject.label. If present, only those selected keys are returned for object, relationship, and action data, and data is implicitly included.
      * @param {module:api/GraphActionsApi~getActionByIdCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/GraphActionResponse}
      */
@@ -403,7 +405,7 @@ var GraphActionsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} [objectSections] Comma-separated object response sections to include. Allowed values: objectType, data, mainPhoto, geocodes. If omitted, the default object response shape is returned.
      * @param {String} [relationshipSections] Comma-separated relationship response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default relationship response shape is returned.
      * @param {String} [actionSections] Comma-separated action response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default action response shape is returned.
-     * @param {String} [dataFields] Comma-separated exact property keys to include inside any returned data object. If present, only those keys are returned for object, relationship, and action data, and data is implicitly included.
+     * @param {String} [dataFields] Comma-separated property selectors to include inside any returned data object. Supports exact root keys like acceptor and nested selectors like acceptor.name, acceptor.age, or topics.relatedObject.label. If present, only those selected keys are returned for object, relationship, and action data, and data is implicitly included.
      * @param {module:api/GraphActionsApi~getActionsCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/GraphActionResponse>}
      */
@@ -476,7 +478,7 @@ var GraphActionsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} [objectSections] Comma-separated object response sections to include. Allowed values: objectType, data, mainPhoto, geocodes. If omitted, the default object response shape is returned.
      * @param {String} [relationshipSections] Comma-separated relationship response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default relationship response shape is returned.
      * @param {String} [actionSections] Comma-separated action response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default action response shape is returned.
-     * @param {String} [dataFields] Comma-separated exact property keys to include inside any returned data object. If present, only those keys are returned for object, relationship, and action data, and data is implicitly included.
+     * @param {String} [dataFields] Comma-separated property selectors to include inside any returned data object. Supports exact root keys like acceptor and nested selectors like acceptor.name, acceptor.age, or topics.relatedObject.label. If present, only those selected keys are returned for object, relationship, and action data, and data is implicitly included.
      * @param {module:api/GraphActionsApi~getActionsByTypeCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/GraphActionResponse>}
      */
@@ -555,7 +557,7 @@ var GraphActionsApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} [objectSections] Comma-separated object response sections to include. Allowed values: objectType, data, mainPhoto, geocodes. If omitted, the default object response shape is returned.
      * @param {String} [relationshipSections] Comma-separated relationship response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default relationship response shape is returned.
      * @param {String} [actionSections] Comma-separated action response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default action response shape is returned.
-     * @param {String} [dataFields] Comma-separated exact property keys to include inside any returned data object. If present, only those keys are returned for object, relationship, and action data, and data is implicitly included.
+     * @param {String} [dataFields] Comma-separated property selectors to include inside any returned data object. Supports exact root keys like acceptor and nested selectors like acceptor.name, acceptor.age, or topics.relatedObject.label. If present, only those selected keys are returned for object, relationship, and action data, and data is implicitly included.
      * @param {String} [searchtype] Search type: category, graph
      * @param {Number} [lat] Latitude for geo search
      * @param {Number} [_long] Longitude for geo search
@@ -912,6 +914,164 @@ var GraphActionsApi = exports["default"] = /*#__PURE__*/function () {
       return this.apiClient.callApi('/action/{key}/properties/{prop}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
 
+    /**
+     * Callback function to receive the result of the traverseFromFindRelationships operation.
+     * @callback module:api/GraphActionsApi~traverseFromFindRelationshipsCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/TraversalRelationResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * 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 {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
+     * @param {String} [objectSections] Comma-separated object response sections to include. Allowed values: objectType, data, mainPhoto, geocodes. If omitted, the default object response shape is returned.
+     * @param {String} [relationshipSections] Comma-separated relationship response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default relationship response shape is returned.
+     * @param {String} [actionSections] Comma-separated action response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default action response shape is returned.
+     * @param {String} [dataFields] Comma-separated property selectors to include inside any returned data object. Supports exact root keys like acceptor and nested selectors like acceptor.name, acceptor.age, or topics.relatedObject.label. If present, only those selected keys are returned for object, relationship, and action data, and data is implicitly included.
+     * @param {Number} [maxObjectTypeFields = 0)] If > 0, include up to this many fields on each object's objectType; 0 = omit fields
+     * @param {Boolean} [includeExpandedFieldData] When false, skips expanded relationship, traversal, and function field materialization inside returned data objects.
+     * @param {Boolean} [includeRelatedMedia] When false, skips related media lookups such as mainPhoto and geocodes.
+     * @param {module:api/GraphActionsApi~traverseFromFindRelationshipsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/TraversalRelationResponse}
+     */
+  }, {
+    key: "traverseFromFindRelationships",
+    value: function traverseFromFindRelationships(id, graphTraversalInput, opts, callback) {
+      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 = {
+        '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'),
+        'objectSections': opts['objectSections'],
+        'relationshipSections': opts['relationshipSections'],
+        'actionSections': opts['actionSections'],
+        'dataFields': opts['dataFields'],
+        'maxObjectTypeFields': opts['maxObjectTypeFields'],
+        'includeExpandedFieldData': opts['includeExpandedFieldData'],
+        'includeRelatedMedia': opts['includeRelatedMedia']
+      };
+      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 = _TraversalRelationResponse["default"];
+      return this.apiClient.callApi('/traverse/{id}/traverserelationships', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the traverseRelationships operation.
+     * @callback module:api/GraphActionsApi~traverseRelationshipsCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/TraversalRelationResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * 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 {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
+     * @param {String} [objectSections] Comma-separated object response sections to include. Allowed values: objectType, data, mainPhoto, geocodes. If omitted, the default object response shape is returned.
+     * @param {String} [relationshipSections] Comma-separated relationship response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default relationship response shape is returned.
+     * @param {String} [actionSections] Comma-separated action response sections to include. Allowed values: startObject, endObject, data, urls. If omitted, the default action response shape is returned.
+     * @param {String} [dataFields] Comma-separated property selectors to include inside any returned data object. Supports exact root keys like acceptor and nested selectors like acceptor.name, acceptor.age, or topics.relatedObject.label. If present, only those selected keys are returned for object, relationship, and action data, and data is implicitly included.
+     * @param {Number} [maxObjectTypeFields = 0)] If > 0, include up to this many fields on each object's objectType; 0 = omit fields
+     * @param {Boolean} [includeExpandedFieldData] When false, skips expanded relationship, traversal, and function field materialization inside returned data objects.
+     * @param {Boolean} [includeRelatedMedia] When false, skips related media lookups such as mainPhoto and geocodes.
+     * @param {module:api/GraphActionsApi~traverseRelationshipsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/TraversalRelationResponse}
+     */
+  }, {
+    key: "traverseRelationships",
+    value: function traverseRelationships(graphTraversalInput, opts, callback) {
+      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 = {
+        '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'),
+        'objectSections': opts['objectSections'],
+        'relationshipSections': opts['relationshipSections'],
+        'actionSections': opts['actionSections'],
+        'dataFields': opts['dataFields'],
+        'maxObjectTypeFields': opts['maxObjectTypeFields'],
+        'includeExpandedFieldData': opts['includeExpandedFieldData'],
+        'includeRelatedMedia': opts['includeRelatedMedia']
+      };
+      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 = _TraversalRelationResponse["default"];
+      return this.apiClient.callApi('/traverse/relationships', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
     /**
      * Callback function to receive the result of the updateAction operation.
      * @callback module:api/GraphActionsApi~updateActionCallback

package/dist/api/GraphObjectPermissionsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * GraphObjectPermissions service.
 * @module api/GraphObjectPermissionsApi
-* @version 0.1.213
+* @version 0.1.215
 */
 export default class GraphObjectPermissionsApi {
     /**

package/dist/api/GraphObjectPermissionsApi.js

@@ -20,7 +20,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.213
+ * The version of the OpenAPI document: 0.1.215
  * Contact: info@gobodo.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * GraphObjectPermissions service.
 * @module api/GraphObjectPermissionsApi
-* @version 0.1.213
+* @version 0.1.215
 */
 var GraphObjectPermissionsApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/api/GraphObjectTypesApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * GraphObjectTypes service.
 * @module api/GraphObjectTypesApi
-* @version 0.1.213
+* @version 0.1.215
 */
 export default class GraphObjectTypesApi {
     /**

package/dist/api/GraphObjectTypesApi.js

@@ -26,7 +26,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.213
+ * The version of the OpenAPI document: 0.1.215
  * Contact: info@gobodo.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -37,7 +37,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * GraphObjectTypes service.
 * @module api/GraphObjectTypesApi
-* @version 0.1.213
+* @version 0.1.215
 */
 var GraphObjectTypesApi = exports["default"] = /*#__PURE__*/function () {
   /**