@gobodo/gobodo-api-promise 0.1.214 → 0.1.216

package/dist/model/TraversalProjectionInput.d.ts

@@ -2,7 +2,7 @@ export default TraversalProjectionInput;
 /**
  * The TraversalProjectionInput model module.
  * @module model/TraversalProjectionInput
- * @version 0.1.214
+ * @version 0.1.216
  */
 declare class TraversalProjectionInput {
     /**
@@ -27,224 +27,273 @@ declare class TraversalProjectionInput {
     static validateJSON(data: any): boolean;
     /**
      * Constructs a new <code>TraversalProjectionInput</code>.
+     * Traversal query plus projection rules for computed traversal results. Use the normal traversal selectors and filters to find candidate paths, then choose which point on each match to project with target and how to serialize the result with resultMode.
      * @alias module:model/TraversalProjectionInput
-     * @param target {module:model/TraversalProjectionInput.TargetEnum} Traversal target to project from.
-     * @param resultMode {module:model/TraversalProjectionInput.ResultModeEnum} Projection result mode.
+     * @param target {module:model/TraversalProjectionInput.TargetEnum} Which element from each matched traversal to project: START_OBJECT projects the seed object, END_OBJECT projects the discovered end object, and LAST_RELATIONSHIP projects the last relationship or action in the path.
+     * @param resultMode {module:model/TraversalProjectionInput.ResultModeEnum} Projection result mode. OBJECT and OBJECT_LIST return graph objects, USER and USER_LIST return users when the projected node resolves to a user, VALUE and VALUE_LIST return scalar properties, and COUNT returns the total number of distinct projected targets before pagination.
      */
     constructor(target: any, resultMode: any);
     /**
+         * Returns Graph id to traverse. Omit or set to 0 when the graph context is implied by the endpoint or calling code.
          * @return {Number}
          */
     getGraphId(): number;
     /**
-     * @param {Number} graphId
+     * Sets Graph id to traverse. Omit or set to 0 when the graph context is implied by the endpoint or calling code.
+     * @param {Number} graphId Graph id to traverse. Omit or set to 0 when the graph context is implied by the endpoint or calling code.
      */
     setGraphId(graphId: number): void;
     graphId: number;
     /**
+         * Returns Single start object id. Use this when the traversal should begin from one specific graph object.
          * @return {Number}
          */
     getStartObjectId(): number;
     /**
-     * @param {Number} startObjectId
+     * Sets Single start object id. Use this when the traversal should begin from one specific graph object.
+     * @param {Number} startObjectId Single start object id. Use this when the traversal should begin from one specific graph object.
      */
     setStartObjectId(startObjectId: number): void;
     startObjectId: number;
     /**
+         * Returns Multiple start object ids. When provided, the traversal starts from any of these objects.
          * @return {Array.<Number>}
          */
     getStartObjectIds(): Array<number>;
     /**
-     * @param {Array.<Number>} startObjectIds
+     * Sets Multiple start object ids. When provided, the traversal starts from any of these objects.
+     * @param {Array.<Number>} startObjectIds Multiple start object ids. When provided, the traversal starts from any of these objects.
      */
     setStartObjectIds(startObjectIds: Array<number>): void;
     startObjectIds: number[];
     /**
+         * Returns Single start object key. Useful when callers identify objects by stable keys instead of numeric ids.
          * @return {String}
          */
     getStartObjectKey(): string;
     /**
-     * @param {String} startObjectKey
+     * Sets Single start object key. Useful when callers identify objects by stable keys instead of numeric ids.
+     * @param {String} startObjectKey Single start object key. Useful when callers identify objects by stable keys instead of numeric ids.
      */
     setStartObjectKey(startObjectKey: string): void;
     startObjectKey: string;
     /**
+         * Returns Multiple start object keys. When provided, the traversal starts from any matching keyed object.
          * @return {Array.<String>}
          */
     getStartObjectKeys(): Array<string>;
     /**
-     * @param {Array.<String>} startObjectKeys
+     * Sets Multiple start object keys. When provided, the traversal starts from any matching keyed object.
+     * @param {Array.<String>} startObjectKeys Multiple start object keys. When provided, the traversal starts from any matching keyed object.
      */
     setStartObjectKeys(startObjectKeys: Array<string>): void;
     startObjectKeys: string[];
     /**
+         * Returns Single end object id to constrain the traversal destination.
          * @return {Number}
          */
     getEndObjectId(): number;
     /**
-     * @param {Number} endObjectId
+     * Sets Single end object id to constrain the traversal destination.
+     * @param {Number} endObjectId Single end object id to constrain the traversal destination.
      */
     setEndObjectId(endObjectId: number): void;
     endObjectId: number;
     /**
+         * Returns Multiple end object ids to constrain the traversal destination set.
          * @return {Array.<Number>}
          */
     getEndObjectIds(): Array<number>;
     /**
-     * @param {Array.<Number>} endObjectIds
+     * Sets Multiple end object ids to constrain the traversal destination set.
+     * @param {Array.<Number>} endObjectIds Multiple end object ids to constrain the traversal destination set.
      */
     setEndObjectIds(endObjectIds: Array<number>): void;
     endObjectIds: number[];
     /**
+         * Returns Single end object key to constrain the traversal destination.
          * @return {String}
          */
     getEndObjectKey(): string;
     /**
-     * @param {String} endObjectKey
+     * Sets Single end object key to constrain the traversal destination.
+     * @param {String} endObjectKey Single end object key to constrain the traversal destination.
      */
     setEndObjectKey(endObjectKey: string): void;
     endObjectKey: string;
     /**
+         * Returns Multiple end object keys to constrain the traversal destination set.
          * @return {Array.<String>}
          */
     getEndObjectKeys(): Array<string>;
     /**
-     * @param {Array.<String>} endObjectKeys
+     * Sets Multiple end object keys to constrain the traversal destination set.
+     * @param {Array.<String>} endObjectKeys Multiple end object keys to constrain the traversal destination set.
      */
     setEndObjectKeys(endObjectKeys: Array<string>): void;
     endObjectKeys: string[];
     /**
+         * Returns Allowed start-object type keys. The starting objects must belong to one of these object types.
          * @return {Array.<String>}
          */
     getStartObjectTypes(): Array<string>;
     /**
-     * @param {Array.<String>} startObjectTypes
+     * Sets Allowed start-object type keys. The starting objects must belong to one of these object types.
+     * @param {Array.<String>} startObjectTypes Allowed start-object type keys. The starting objects must belong to one of these object types.
      */
     setStartObjectTypes(startObjectTypes: Array<string>): void;
     startObjectTypes: string[];
     /**
+         * Returns Allowed end-object type keys. Only paths whose discovered end object belongs to one of these types are returned.
          * @return {Array.<String>}
          */
     getEndObjectTypes(): Array<string>;
     /**
-     * @param {Array.<String>} endObjectTypes
+     * Sets Allowed end-object type keys. Only paths whose discovered end object belongs to one of these types are returned.
+     * @param {Array.<String>} endObjectTypes Allowed end-object type keys. Only paths whose discovered end object belongs to one of these types are returned.
      */
     setEndObjectTypes(endObjectTypes: Array<string>): void;
     endObjectTypes: string[];
     /**
+         * Returns End-object type keys to exclude from the traversal result set.
          * @return {Array.<String>}
          */
     getExcludeObjectTypes(): Array<string>;
     /**
-     * @param {Array.<String>} excludeObjectTypes
+     * Sets End-object type keys to exclude from the traversal result set.
+     * @param {Array.<String>} excludeObjectTypes End-object type keys to exclude from the traversal result set.
      */
     setExcludeObjectTypes(excludeObjectTypes: Array<string>): void;
     excludeObjectTypes: string[];
     /**
+         * Returns Relationship type keys that may appear in the traversed path.
          * @return {Array.<String>}
          */
     getRelationshipTypes(): Array<string>;
     /**
-     * @param {Array.<String>} relationshipTypes
+     * Sets Relationship type keys that may appear in the traversed path.
+     * @param {Array.<String>} relationshipTypes Relationship type keys that may appear in the traversed path.
      */
     setRelationshipTypes(relationshipTypes: Array<string>): void;
     relationshipTypes: string[];
     /**
+         * Returns Relationship type keys to exclude from the traversed path.
          * @return {Array.<String>}
          */
     getExcludeRelationshipTypes(): Array<string>;
     /**
-     * @param {Array.<String>} excludeRelationshipTypes
+     * Sets Relationship type keys to exclude from the traversed path.
+     * @param {Array.<String>} excludeRelationshipTypes Relationship type keys to exclude from the traversed path.
      */
     setExcludeRelationshipTypes(excludeRelationshipTypes: Array<string>): void;
     excludeRelationshipTypes: string[];
     /**
+         * Returns Action type keys that may appear in the traversed path. Action types are treated as traversable graph relationships for traversal purposes.
          * @return {Array.<String>}
          */
     getActionTypes(): Array<string>;
     /**
-     * @param {Array.<String>} actionTypes
+     * Sets Action type keys that may appear in the traversed path. Action types are treated as traversable graph relationships for traversal purposes.
+     * @param {Array.<String>} actionTypes Action type keys that may appear in the traversed path. Action types are treated as traversable graph relationships for traversal purposes.
      */
     setActionTypes(actionTypes: Array<string>): void;
     actionTypes: string[];
     /**
+         * Returns Action type keys to exclude from the traversed path.
          * @return {Array.<String>}
          */
     getExcludeActionTypes(): Array<string>;
     /**
-     * @param {Array.<String>} excludeActionTypes
+     * Sets Action type keys to exclude from the traversed path.
+     * @param {Array.<String>} excludeActionTypes Action type keys to exclude from the traversed path.
      */
     setExcludeActionTypes(excludeActionTypes: Array<string>): void;
     excludeActionTypes: string[];
     /**
+         * Returns Relationship or action type keys that the start object must have.
          * @return {Array.<String>}
          */
     getStartObjectHasRelationships(): Array<string>;
     /**
-     * @param {Array.<String>} startObjectHasRelationships
+     * Sets Relationship or action type keys that the start object must have.
+     * @param {Array.<String>} startObjectHasRelationships Relationship or action type keys that the start object must have.
      */
     setStartObjectHasRelationships(startObjectHasRelationships: Array<string>): void;
     startObjectHasRelationships: string[];
     /**
+         * Returns Relationship or action type keys that the end object must have.
          * @return {Array.<String>}
          */
     getEndObjectHasRelationships(): Array<string>;
     /**
-     * @param {Array.<String>} endObjectHasRelationships
+     * Sets Relationship or action type keys that the end object must have.
+     * @param {Array.<String>} endObjectHasRelationships Relationship or action type keys that the end object must have.
      */
     setEndObjectHasRelationships(endObjectHasRelationships: Array<string>): void;
     endObjectHasRelationships: string[];
     /**
+         * Returns Relationship or action type keys that the start object must not have.
          * @return {Array.<String>}
          */
     getStartObjectNotHasRelationships(): Array<string>;
     /**
-     * @param {Array.<String>} startObjectNotHasRelationships
+     * Sets Relationship or action type keys that the start object must not have.
+     * @param {Array.<String>} startObjectNotHasRelationships Relationship or action type keys that the start object must not have.
      */
     setStartObjectNotHasRelationships(startObjectNotHasRelationships: Array<string>): void;
     startObjectNotHasRelationships: string[];
     /**
+         * Returns Relationship or action type keys that the end object must not have.
          * @return {Array.<String>}
          */
     getEndObjectNotHasRelationships(): Array<string>;
     /**
-     * @param {Array.<String>} endObjectNotHasRelationships
+     * Sets Relationship or action type keys that the end object must not have.
+     * @param {Array.<String>} endObjectNotHasRelationships Relationship or action type keys that the end object must not have.
      */
     setEndObjectNotHasRelationships(endObjectNotHasRelationships: Array<string>): void;
     endObjectNotHasRelationships: string[];
     /**
+         * Returns Action type keys that the start object must have.
          * @return {Array.<String>}
          */
     getStartObjectHasActions(): Array<string>;
     /**
-     * @param {Array.<String>} startObjectHasActions
+     * Sets Action type keys that the start object must have.
+     * @param {Array.<String>} startObjectHasActions Action type keys that the start object must have.
      */
     setStartObjectHasActions(startObjectHasActions: Array<string>): void;
     startObjectHasActions: string[];
     /**
+         * Returns Action type keys that the end object must have.
          * @return {Array.<String>}
          */
     getEndObjectHasActions(): Array<string>;
     /**
-     * @param {Array.<String>} endObjectHasActions
+     * Sets Action type keys that the end object must have.
+     * @param {Array.<String>} endObjectHasActions Action type keys that the end object must have.
      */
     setEndObjectHasActions(endObjectHasActions: Array<string>): void;
     endObjectHasActions: string[];
     /**
+         * Returns Action type keys that the start object must not have.
          * @return {Array.<String>}
          */
     getStartObjectNotHasActions(): Array<string>;
     /**
-     * @param {Array.<String>} startObjectNotHasActions
+     * Sets Action type keys that the start object must not have.
+     * @param {Array.<String>} startObjectNotHasActions Action type keys that the start object must not have.
      */
     setStartObjectNotHasActions(startObjectNotHasActions: Array<string>): void;
     startObjectNotHasActions: string[];
     /**
+         * Returns Action type keys that the end object must not have.
          * @return {Array.<String>}
          */
     getEndObjectNotHasActions(): Array<string>;
     /**
-     * @param {Array.<String>} endObjectNotHasActions
+     * Sets Action type keys that the end object must not have.
+     * @param {Array.<String>} endObjectNotHasActions Action type keys that the end object must not have.
      */
     setEndObjectNotHasActions(endObjectNotHasActions: Array<string>): void;
     endObjectNotHasActions: string[];
@@ -267,101 +316,123 @@ declare class TraversalProjectionInput {
     setEndGeoLocation(endGeoLocation: any): void;
     endGeoLocation: any;
     /**
+         * Returns Allowed city names for start objects. Matching is OR-based within this list and combines with state and country filters when provided.
          * @return {Array.<String>}
          */
     getStartCities(): Array<string>;
     /**
-     * @param {Array.<String>} startCities
+     * Sets Allowed city names for start objects. Matching is OR-based within this list and combines with state and country filters when provided.
+     * @param {Array.<String>} startCities Allowed city names for start objects. Matching is OR-based within this list and combines with state and country filters when provided.
      */
     setStartCities(startCities: Array<string>): void;
     startCities: string[];
     /**
+         * Returns Allowed state or province names for start objects.
          * @return {Array.<String>}
          */
     getStartStates(): Array<string>;
     /**
-     * @param {Array.<String>} startStates
+     * Sets Allowed state or province names for start objects.
+     * @param {Array.<String>} startStates Allowed state or province names for start objects.
      */
     setStartStates(startStates: Array<string>): void;
     startStates: string[];
     /**
+         * Returns Allowed country names for start objects.
          * @return {Array.<String>}
          */
     getStartCountries(): Array<string>;
     /**
-     * @param {Array.<String>} startCountries
+     * Sets Allowed country names for start objects.
+     * @param {Array.<String>} startCountries Allowed country names for start objects.
      */
     setStartCountries(startCountries: Array<string>): void;
     startCountries: string[];
     /**
+         * Returns Allowed city names for end objects.
          * @return {Array.<String>}
          */
     getEndCities(): Array<string>;
     /**
-     * @param {Array.<String>} endCities
+     * Sets Allowed city names for end objects.
+     * @param {Array.<String>} endCities Allowed city names for end objects.
      */
     setEndCities(endCities: Array<string>): void;
     endCities: string[];
     /**
+         * Returns Allowed state or province names for end objects.
          * @return {Array.<String>}
          */
     getEndStates(): Array<string>;
     /**
-     * @param {Array.<String>} endStates
+     * Sets Allowed state or province names for end objects.
+     * @param {Array.<String>} endStates Allowed state or province names for end objects.
      */
     setEndStates(endStates: Array<string>): void;
     endStates: string[];
     /**
+         * Returns Allowed country names for end objects.
          * @return {Array.<String>}
          */
     getEndCountries(): Array<string>;
     /**
-     * @param {Array.<String>} endCountries
+     * Sets Allowed country names for end objects.
+     * @param {Array.<String>} endCountries Allowed country names for end objects.
      */
     setEndCountries(endCountries: Array<string>): void;
     endCountries: string[];
     /**
+         * Returns Traversal direction to follow for relationship and action edges: INCOMING, OUTGOING, or BOTH.
          * @return {module:model/TraversalProjectionInput.DirectionEnum}
          */
     getDirection(): any;
     /**
-     * @param {module:model/TraversalProjectionInput.DirectionEnum} direction
+     * Sets Traversal direction to follow for relationship and action edges: INCOMING, OUTGOING, or BOTH.
+     * @param {module:model/TraversalProjectionInput.DirectionEnum} direction Traversal direction to follow for relationship and action edges: INCOMING, OUTGOING, or BOTH.
      */
     setDirection(direction: any): void;
     direction: any;
     /**
+         * Returns Direction to use when evaluating startObjectHasRelationships and startObjectHasActions.
          * @return {module:model/TraversalProjectionInput.StartObjectHasRelationshipDirectionEnum}
          */
     getStartObjectHasRelationshipDirection(): any;
     /**
-     * @param {module:model/TraversalProjectionInput.StartObjectHasRelationshipDirectionEnum} startObjectHasRelationshipDirection
+     * Sets Direction to use when evaluating startObjectHasRelationships and startObjectHasActions.
+     * @param {module:model/TraversalProjectionInput.StartObjectHasRelationshipDirectionEnum} startObjectHasRelationshipDirection Direction to use when evaluating startObjectHasRelationships and startObjectHasActions.
      */
     setStartObjectHasRelationshipDirection(startObjectHasRelationshipDirection: any): void;
     startObjectHasRelationshipDirection: any;
     /**
+         * Returns Direction to use when evaluating endObjectHasRelationships and endObjectHasActions.
          * @return {module:model/TraversalProjectionInput.EndObjectHasRelationshipDirectionEnum}
          */
     getEndObjectHasRelationshipDirection(): any;
     /**
-     * @param {module:model/TraversalProjectionInput.EndObjectHasRelationshipDirectionEnum} endObjectHasRelationshipDirection
+     * Sets Direction to use when evaluating endObjectHasRelationships and endObjectHasActions.
+     * @param {module:model/TraversalProjectionInput.EndObjectHasRelationshipDirectionEnum} endObjectHasRelationshipDirection Direction to use when evaluating endObjectHasRelationships and endObjectHasActions.
      */
     setEndObjectHasRelationshipDirection(endObjectHasRelationshipDirection: any): void;
     endObjectHasRelationshipDirection: any;
     /**
+         * Returns Direction to use when evaluating startObjectNotHasRelationships and startObjectNotHasActions.
          * @return {module:model/TraversalProjectionInput.StartObjectNotHasRelationshipDirectionEnum}
          */
     getStartObjectNotHasRelationshipDirection(): any;
     /**
-     * @param {module:model/TraversalProjectionInput.StartObjectNotHasRelationshipDirectionEnum} startObjectNotHasRelationshipDirection
+     * Sets Direction to use when evaluating startObjectNotHasRelationships and startObjectNotHasActions.
+     * @param {module:model/TraversalProjectionInput.StartObjectNotHasRelationshipDirectionEnum} startObjectNotHasRelationshipDirection Direction to use when evaluating startObjectNotHasRelationships and startObjectNotHasActions.
      */
     setStartObjectNotHasRelationshipDirection(startObjectNotHasRelationshipDirection: any): void;
     startObjectNotHasRelationshipDirection: any;
     /**
+         * Returns Direction to use when evaluating endObjectNotHasRelationships and endObjectNotHasActions.
          * @return {module:model/TraversalProjectionInput.EndObjectNotHasRelationshipDirectionEnum}
          */
     getEndObjectNotHasRelationshipDirection(): any;
     /**
-     * @param {module:model/TraversalProjectionInput.EndObjectNotHasRelationshipDirectionEnum} endObjectNotHasRelationshipDirection
+     * Sets Direction to use when evaluating endObjectNotHasRelationships and endObjectNotHasActions.
+     * @param {module:model/TraversalProjectionInput.EndObjectNotHasRelationshipDirectionEnum} endObjectNotHasRelationshipDirection Direction to use when evaluating endObjectNotHasRelationships and endObjectNotHasActions.
      */
     setEndObjectNotHasRelationshipDirection(endObjectNotHasRelationshipDirection: any): void;
     endObjectNotHasRelationshipDirection: any;
@@ -393,65 +464,79 @@ declare class TraversalProjectionInput {
     setIntersectionWith(intersectionWith: any): void;
     intersectionWith: any;
     /**
+         * Returns When true, requests shortest-path semantics for the traversal.
          * @return {Boolean}
          */
     getShortestPath(): boolean;
     /**
-     * @param {Boolean} shortestPath
+     * Sets When true, requests shortest-path semantics for the traversal.
+     * @param {Boolean} shortestPath When true, requests shortest-path semantics for the traversal.
      */
     setShortestPath(shortestPath: boolean): void;
     shortestPath: boolean;
     /**
+         * Returns Minimum number of traversed edges in a matching path. 0 allows the start object itself to satisfy the traversal when other filters permit it.
          * @return {Number}
          */
     getMinPathLength(): number;
     /**
-     * @param {Number} minPathLength
+     * Sets Minimum number of traversed edges in a matching path. 0 allows the start object itself to satisfy the traversal when other filters permit it.
+     * @param {Number} minPathLength Minimum number of traversed edges in a matching path. 0 allows the start object itself to satisfy the traversal when other filters permit it.
      */
     setMinPathLength(minPathLength: number): void;
     minPathLength: number;
     /**
+         * Returns Maximum number of traversed edges in a matching path.
          * @return {Number}
          */
     getMaxPathLength(): number;
     /**
-     * @param {Number} maxPathLength
+     * Sets Maximum number of traversed edges in a matching path.
+     * @param {Number} maxPathLength Maximum number of traversed edges in a matching path.
      */
     setMaxPathLength(maxPathLength: number): void;
     maxPathLength: number;
     /**
+         * Returns Offset for page-based pagination. Ignored when keyset pagination fields pageAfterEndObjectId and pageAfterSortValue are both supplied.
          * @return {Number}
          */
     getStartIndex(): number;
     /**
-     * @param {Number} startIndex
+     * Sets Offset for page-based pagination. Ignored when keyset pagination fields pageAfterEndObjectId and pageAfterSortValue are both supplied.
+     * @param {Number} startIndex Offset for page-based pagination. Ignored when keyset pagination fields pageAfterEndObjectId and pageAfterSortValue are both supplied.
      */
     setStartIndex(startIndex: number): void;
     startIndex: number;
     /**
+         * Returns Maximum number of rows to return.
          * @return {Number}
          */
     getCount(): number;
     /**
-     * @param {Number} count
+     * Sets Maximum number of rows to return.
+     * @param {Number} count Maximum number of rows to return.
      */
     setCount(count: number): void;
     count: number;
     /**
+         * Returns Sort field for end objects. Accepts stored graph property names directly; aliases name and date are also supported by the traversal engine.
          * @return {String}
          */
     getSortField(): string;
     /**
-     * @param {String} sortField
+     * Sets Sort field for end objects. Accepts stored graph property names directly; aliases name and date are also supported by the traversal engine.
+     * @param {String} sortField Sort field for end objects. Accepts stored graph property names directly; aliases name and date are also supported by the traversal engine.
      */
     setSortField(sortField: string): void;
     sortField: string;
     /**
+         * Returns Sort order for sortField. Supported values are ASC and DESC.
          * @return {String}
          */
     getSortOrder(): string;
     /**
-     * @param {String} sortOrder
+     * Sets Sort order for sortField. Supported values are ASC and DESC.
+     * @param {String} sortOrder Sort order for sortField. Supported values are ASC and DESC.
      */
     setSortOrder(sortOrder: string): void;
     sortOrder: string;
@@ -478,47 +563,46 @@ declare class TraversalProjectionInput {
     setPageAfterSortValue(pageAfterSortValue: any): void;
     pageAfterSortValue: any;
     /**
-         * @return {Boolean}
-         */
-    getPageAfterSortValueSet(): boolean;
-    /**
-     * @param {Boolean} pageAfterSortValueSet
-     */
-    setPageAfterSortValueSet(pageAfterSortValueSet: boolean): void;
-    pageAfterSortValueSet: boolean;
-    /**
+         * Returns Legacy alias for endObjectFieldFilters. Applies indexed field filters to the discovered end object.
          * @return {Array.<module:model/IndexFilter>}
          */
     getObjectFieldFilters(): Array<NodeJS.Module>;
     /**
-     * @param {Array.<module:model/IndexFilter>} objectFieldFilters
+     * Sets Legacy alias for endObjectFieldFilters. Applies indexed field filters to the discovered end object.
+     * @param {Array.<module:model/IndexFilter>} objectFieldFilters Legacy alias for endObjectFieldFilters. Applies indexed field filters to the discovered end object.
      */
     setObjectFieldFilters(objectFieldFilters: any): void;
     objectFieldFilters: any;
     /**
+         * Returns Indexed field filters applied to the discovered end object.
          * @return {Array.<module:model/IndexFilter>}
          */
     getEndObjectFieldFilters(): Array<NodeJS.Module>;
     /**
-     * @param {Array.<module:model/IndexFilter>} endObjectFieldFilters
+     * Sets Indexed field filters applied to the discovered end object.
+     * @param {Array.<module:model/IndexFilter>} endObjectFieldFilters Indexed field filters applied to the discovered end object.
      */
     setEndObjectFieldFilters(endObjectFieldFilters: any): void;
     endObjectFieldFilters: any;
     /**
+         * Returns Indexed field filters applied to the last relationship or action in the matched path.
          * @return {Array.<module:model/IndexFilter>}
          */
     getRelationshipFieldFilters(): Array<NodeJS.Module>;
     /**
-     * @param {Array.<module:model/IndexFilter>} relationshipFieldFilters
+     * Sets Indexed field filters applied to the last relationship or action in the matched path.
+     * @param {Array.<module:model/IndexFilter>} relationshipFieldFilters Indexed field filters applied to the last relationship or action in the matched path.
      */
     setRelationshipFieldFilters(relationshipFieldFilters: any): void;
     relationshipFieldFilters: any;
     /**
+         * Returns Indexed field filters applied to the start object seed set.
          * @return {Array.<module:model/IndexFilter>}
          */
     getStartObjectFieldFilters(): Array<NodeJS.Module>;
     /**
-     * @param {Array.<module:model/IndexFilter>} startObjectFieldFilters
+     * Sets Indexed field filters applied to the start object seed set.
+     * @param {Array.<module:model/IndexFilter>} startObjectFieldFilters Indexed field filters applied to the start object seed set.
      */
     setStartObjectFieldFilters(startObjectFieldFilters: any): void;
     startObjectFieldFilters: any;
@@ -532,64 +616,68 @@ declare class TraversalProjectionInput {
     setResponseProjection(responseProjection: any): void;
     responseProjection: any;
     /**
+         * Returns Optional full-text search query applied to the discovered end objects after the structural traversal filters are built.
          * @return {String}
          */
     getSearchQuery(): string;
     /**
-     * @param {String} searchQuery
+     * Sets Optional full-text search query applied to the discovered end objects after the structural traversal filters are built.
+     * @param {String} searchQuery Optional full-text search query applied to the discovered end objects after the structural traversal filters are built.
      */
     setSearchQuery(searchQuery: string): void;
     searchQuery: string;
     /**
+         * Returns Optional graph id used only for the searchQuery filter. If omitted, the traversal graphId is reused.
          * @return {Number}
          */
     getSearchGraphId(): number;
     /**
-     * @param {Number} searchGraphId
+     * Sets Optional graph id used only for the searchQuery filter. If omitted, the traversal graphId is reused.
+     * @param {Number} searchGraphId Optional graph id used only for the searchQuery filter. If omitted, the traversal graphId is reused.
      */
     setSearchGraphId(searchGraphId: number): void;
     searchGraphId: number;
     /**
-         * Returns Traversal target to project from.
+         * Returns Which element from each matched traversal to project: START_OBJECT projects the seed object, END_OBJECT projects the discovered end object, and LAST_RELATIONSHIP projects the last relationship or action in the path.
          * @return {module:model/TraversalProjectionInput.TargetEnum}
          */
     getTarget(): any;
     /**
-     * Sets Traversal target to project from.
-     * @param {module:model/TraversalProjectionInput.TargetEnum} target Traversal target to project from.
+     * Sets Which element from each matched traversal to project: START_OBJECT projects the seed object, END_OBJECT projects the discovered end object, and LAST_RELATIONSHIP projects the last relationship or action in the path.
+     * @param {module:model/TraversalProjectionInput.TargetEnum} target Which element from each matched traversal to project: START_OBJECT projects the seed object, END_OBJECT projects the discovered end object, and LAST_RELATIONSHIP projects the last relationship or action in the path.
      */
     setTarget(target: any): void;
     target: any;
     /**
-         * Returns Projection result mode.
+         * Returns Projection result mode. OBJECT and OBJECT_LIST return graph objects, USER and USER_LIST return users when the projected node resolves to a user, VALUE and VALUE_LIST return scalar properties, and COUNT returns the total number of distinct projected targets before pagination.
          * @return {module:model/TraversalProjectionInput.ResultModeEnum}
          */
     getResultMode(): any;
     /**
-     * Sets Projection result mode.
-     * @param {module:model/TraversalProjectionInput.ResultModeEnum} resultMode Projection result mode.
+     * Sets Projection result mode. OBJECT and OBJECT_LIST return graph objects, USER and USER_LIST return users when the projected node resolves to a user, VALUE and VALUE_LIST return scalar properties, and COUNT returns the total number of distinct projected targets before pagination.
+     * @param {module:model/TraversalProjectionInput.ResultModeEnum} resultMode Projection result mode. OBJECT and OBJECT_LIST return graph objects, USER and USER_LIST return users when the projected node resolves to a user, VALUE and VALUE_LIST return scalar properties, and COUNT returns the total number of distinct projected targets before pagination.
      */
     setResultMode(resultMode: any): void;
     resultMode: any;
     /**
-         * Returns Projected property name for VALUE and VALUE_LIST result modes. Supports stored graph property names and core aliases such as id, key, name, label, creationDate, and modificationDate.
+         * Returns Projected property name for VALUE and VALUE_LIST result modes. Supports stored graph property names and core aliases such as id, key, name, label, creationDate, and modificationDate. Required for VALUE and VALUE_LIST. Ignored for OBJECT, OBJECT_LIST, USER, USER_LIST, and COUNT.
          * @return {String}
          */
     getPropertyName(): string;
     /**
-     * Sets Projected property name for VALUE and VALUE_LIST result modes. Supports stored graph property names and core aliases such as id, key, name, label, creationDate, and modificationDate.
-     * @param {String} propertyName Projected property name for VALUE and VALUE_LIST result modes. Supports stored graph property names and core aliases such as id, key, name, label, creationDate, and modificationDate.
+     * Sets Projected property name for VALUE and VALUE_LIST result modes. Supports stored graph property names and core aliases such as id, key, name, label, creationDate, and modificationDate. Required for VALUE and VALUE_LIST. Ignored for OBJECT, OBJECT_LIST, USER, USER_LIST, and COUNT.
+     * @param {String} propertyName Projected property name for VALUE and VALUE_LIST result modes. Supports stored graph property names and core aliases such as id, key, name, label, creationDate, and modificationDate. Required for VALUE and VALUE_LIST. Ignored for OBJECT, OBJECT_LIST, USER, USER_LIST, and COUNT.
      */
     setPropertyName(propertyName: string): void;
     propertyName: string;
     /**
-         * Returns Maximum nested traversal-object expansion depth for OBJECT and OBJECT_LIST projections. 0 disables nested object/list traversal expansion on returned objects.
+         * Returns Maximum nested traversal-object expansion depth for OBJECT and OBJECT_LIST projections. 0 disables nested object/list traversal expansion on returned objects. This setting is ignored for USER, USER_LIST, VALUE, VALUE_LIST, and COUNT projections.
          * @return {Number}
          */
     getProjectedObjectDepthLimit(): number;
     /**
-     * Sets Maximum nested traversal-object expansion depth for OBJECT and OBJECT_LIST projections. 0 disables nested object/list traversal expansion on returned objects.
-     * @param {Number} projectedObjectDepthLimit Maximum nested traversal-object expansion depth for OBJECT and OBJECT_LIST projections. 0 disables nested object/list traversal expansion on returned objects.
+     * Sets Maximum nested traversal-object expansion depth for OBJECT and OBJECT_LIST projections. 0 disables nested object/list traversal expansion on returned objects. This setting is ignored for USER, USER_LIST, VALUE, VALUE_LIST, and COUNT projections.
+     * @param {Number} projectedObjectDepthLimit Maximum nested traversal-object expansion depth for OBJECT and OBJECT_LIST projections. 0 disables nested object/list traversal expansion on returned objects. This setting is ignored for USER, USER_LIST, VALUE, VALUE_LIST, and COUNT projections.
      */
     setProjectedObjectDepthLimit(projectedObjectDepthLimit: number): void;
     projectedObjectDepthLimit: number;
@@ -641,6 +729,8 @@ declare namespace TraversalProjectionInput {
     namespace ResultModeEnum {
         let OBJECT: string;
         let OBJECT_LIST: string;
+        let USER: string;
+        let USER_LIST: string;
         let VALUE: string;
         let VALUE_LIST: string;
         let COUNT: string;