@gobodo/gobodo-api-promise 0.1.215 → 0.1.217

package/dist/model/GraphTraversalInput.d.ts

@@ -2,7 +2,7 @@ export default GraphTraversalInput;
 /**
  * The GraphTraversalInput model module.
  * @module model/GraphTraversalInput
- * @version 0.1.215
+ * @version 0.1.217
  */
 declare class GraphTraversalInput {
     /**
@@ -26,218 +26,266 @@ declare class GraphTraversalInput {
      */
     static validateJSON(data: any): boolean;
     /**
+         * 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[];
@@ -260,101 +308,123 @@ declare class GraphTraversalInput {
     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/GraphTraversalInput.DirectionEnum}
          */
     getDirection(): any;
     /**
-     * @param {module:model/GraphTraversalInput.DirectionEnum} direction
+     * Sets Traversal direction to follow for relationship and action edges: INCOMING, OUTGOING, or BOTH.
+     * @param {module:model/GraphTraversalInput.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/GraphTraversalInput.StartObjectHasRelationshipDirectionEnum}
          */
     getStartObjectHasRelationshipDirection(): any;
     /**
-     * @param {module:model/GraphTraversalInput.StartObjectHasRelationshipDirectionEnum} startObjectHasRelationshipDirection
+     * Sets Direction to use when evaluating startObjectHasRelationships and startObjectHasActions.
+     * @param {module:model/GraphTraversalInput.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/GraphTraversalInput.EndObjectHasRelationshipDirectionEnum}
          */
     getEndObjectHasRelationshipDirection(): any;
     /**
-     * @param {module:model/GraphTraversalInput.EndObjectHasRelationshipDirectionEnum} endObjectHasRelationshipDirection
+     * Sets Direction to use when evaluating endObjectHasRelationships and endObjectHasActions.
+     * @param {module:model/GraphTraversalInput.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/GraphTraversalInput.StartObjectNotHasRelationshipDirectionEnum}
          */
     getStartObjectNotHasRelationshipDirection(): any;
     /**
-     * @param {module:model/GraphTraversalInput.StartObjectNotHasRelationshipDirectionEnum} startObjectNotHasRelationshipDirection
+     * Sets Direction to use when evaluating startObjectNotHasRelationships and startObjectNotHasActions.
+     * @param {module:model/GraphTraversalInput.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/GraphTraversalInput.EndObjectNotHasRelationshipDirectionEnum}
          */
     getEndObjectNotHasRelationshipDirection(): any;
     /**
-     * @param {module:model/GraphTraversalInput.EndObjectNotHasRelationshipDirectionEnum} endObjectNotHasRelationshipDirection
+     * Sets Direction to use when evaluating endObjectNotHasRelationships and endObjectNotHasActions.
+     * @param {module:model/GraphTraversalInput.EndObjectNotHasRelationshipDirectionEnum} endObjectNotHasRelationshipDirection Direction to use when evaluating endObjectNotHasRelationships and endObjectNotHasActions.
      */
     setEndObjectNotHasRelationshipDirection(endObjectNotHasRelationshipDirection: any): void;
     endObjectNotHasRelationshipDirection: any;
@@ -386,65 +456,79 @@ declare class GraphTraversalInput {
     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;
@@ -471,47 +555,46 @@ declare class GraphTraversalInput {
     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;
@@ -525,20 +608,24 @@ declare class GraphTraversalInput {
     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;

package/dist/model/GraphTraversalInput.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GraphTraversalInput.d.ts","sourceRoot":"","sources":["../../src/model/GraphTraversalInput.js"],"names":[],"mappings":";AAkBA;;;;GAIG;AACH;IAUI;;;;OAIG;IACH,kCACC;IAED;;;;;;OAMG;IACH,2CAHW,GAAgC,GAC/B,GAAgC,CAmL3C;IAED;;;;OAIG;IACH,gCAFY,OAAO,CAiNlB;IAEL;;WAEO;IACH,qBAEC;IAED;;OAEG;IACH,kCAEC;IADG,gBAAyB;IAEjC;;WAEO;IACH,2BAEC;IAED;;OAEG;IACH,8CAEC;IADG,sBAAqC;IAE7C;;WAEO;IACH,qBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,kCAFW,KAAK,QAAS,QAIxB;IADG,yBAAuC;IAE/C;;WAEO;IACH,4BAEC;IAED;;OAEG;IACH,gDAEC;IADG,uBAAuC;IAE/C;;WAEO;IACH,sBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,oCAFW,KAAK,QAAS,QAIxB;IADG,0BAAyC;IAEjD;;WAEO;IACH,yBAEC;IAED;;OAEG;IACH,0CAEC;IADG,oBAAiC;IAEzC;;WAEO;IACH,mBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,8BAFW,KAAK,QAAS,QAIxB;IADG,uBAAmC;IAE3C;;WAEO;IACH,0BAEC;IAED;;OAEG;IACH,4CAEC;IADG,qBAAmC;IAE3C;;WAEO;IACH,oBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,gCAFW,KAAK,QAAS,QAIxB;IADG,wBAAqC;IAE7C;;WAEO;IACH,uBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,sCAFW,KAAK,QAAS,QAIxB;IADG,2BAA2C;IAEnD;;WAEO;IACH,qBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,kCAFW,KAAK,QAAS,QAIxB;IADG,yBAAuC;IAE/C;;WAEO;IACH,yBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,0CAFW,KAAK,QAAS,QAIxB;IADG,6BAA+C;IAEvD;;WAEO;IACH,wBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,wCAFW,KAAK,QAAS,QAIxB;IADG,4BAA6C;IAErD;;WAEO;IACH,+BAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,sDAFW,KAAK,QAAS,QAIxB;IADG,mCAA2D;IAEnE;;WAEO;IACH,kBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,4BAFW,KAAK,QAAS,QAIxB;IADG,sBAAiC;IAEzC;;WAEO;IACH,yBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,0CAFW,KAAK,QAAS,QAIxB;IADG,6BAA+C;IAEvD;;WAEO;IACH,kCAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,4DAFW,KAAK,QAAS,QAIxB;IADG,sCAAiE;IAEzE;;WAEO;IACH,gCAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,wDAFW,KAAK,QAAS,QAIxB;IADG,oCAA6D;IAErE;;WAEO;IACH,qCAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,kEAFW,KAAK,QAAS,QAIxB;IADG,yCAAuE;IAE/E;;WAEO;IACH,mCAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,8DAFW,KAAK,QAAS,QAIxB;IADG,uCAAmE;IAE3E;;WAEO;IACH,4BAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,gDAFW,KAAK,QAAS,QAIxB;IADG,gCAAqD;IAE7D;;WAEO;IACH,0BAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,4CAFW,KAAK,QAAS,QAIxB;IADG,8BAAiD;IAEzD;;WAEO;IACH,+BAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,sDAFW,KAAK,QAAS,QAIxB;IADG,mCAA2D;IAEnE;;WAEO;IACH,6BAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,kDAFW,KAAK,QAAS,QAIxB;IADG,iCAAuD;IAE/D;;WAEO;IACH,uBAFY,GAA6B,CAIxC;IAED;;OAEG;IACH,sCAFW,GAA6B,QAIvC;IADG,sBAA2C;IAEnD;;WAEO;IACH,qBAFY,GAA6B,CAIxC;IAED;;OAEG;IACH,kCAFW,GAA6B,QAIvC;IADG,oBAAuC;IAE/C;;WAEO;IACH,kBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,4BAFW,KAAK,QAAS,QAIxB;IADG,sBAAiC;IAEzC;;WAEO;IACH,kBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,4BAFW,KAAK,QAAS,QAIxB;IADG,sBAAiC;IAEzC;;WAEO;IACH,qBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,kCAFW,KAAK,QAAS,QAIxB;IADG,yBAAuC;IAE/C;;WAEO;IACH,gBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,wBAFW,KAAK,QAAS,QAIxB;IADG,oBAA6B;IAErC;;WAEO;IACH,gBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,wBAFW,KAAK,QAAS,QAIxB;IADG,oBAA6B;IAErC;;WAEO;IACH,mBAFY,KAAK,QAAS,CAIzB;IAED;;OAEG;IACH,8BAFW,KAAK,QAAS,QAIxB;IADG,uBAAmC;IAE3C;;WAEO;IACH,gBAFY,GAA8C,CAIzD;IAED;;OAEG;IACH,wBAFW,GAA8C,QAIxD;IADG,eAA6B;IAErC;;WAEO;IACH,0CAFY,GAAwE,CAInF;IAED;;OAEG;IACH,4EAFW,GAAwE,QAIlF;IADG,yCAAiF;IAEzF;;WAEO;IACH,wCAFY,GAAsE,CAIjF;IAED;;OAEG;IACH,wEAFW,GAAsE,QAIhF;IADG,uCAA6E;IAErF;;WAEO;IACH,6CAFY,GAA2E,CAItF;IAED;;OAEG;IACH,kFAFW,GAA2E,QAIrF;IADG,4CAAuF;IAE/F;;WAEO;IACH,2CAFY,GAAyE,CAIpF;IAED;;OAEG;IACH,8EAFW,GAAyE,QAInF;IADG,0CAAmF;IAE3F;;WAEO;IACH,eAFY,GAAgC,CAI3C;IAED;;OAEG;IACH,sBAFW,GAAgC,QAI1C;IADG,cAA2B;IAEnC;;WAEO;IACH,gBAFY,GAAgC,CAI3C;IAED;;OAEG;IACH,wBAFW,GAAgC,QAI1C;IADG,eAA6B;IAErC;;WAEO;IACH,uBAFY,GAAgC,CAI3C;IAED;;OAEG;IACH,sCAFW,GAAgC,QAI1C;IADG,sBAA2C;IAEnD;;WAEO;IACH,2BAEC;IAED;;OAEG;IACH,6CAEC;IADG,sBAAmC;IAE3C;;WAEO;IACH,2BAEC;IAED;;OAEG;IACH,8CAEC;IADG,sBAAqC;IAE7C;;WAEO;IACH,2BAEC;IAED;;OAEG;IACH,8CAEC;IADG,sBAAqC;IAE7C;;WAEO;IACH,wBAEC;IAED;;OAEG;IACH,wCAEC;IADG,mBAA+B;IAEvC;;WAEO;IACH,mBAEC;IAED;;OAEG;IACH,8BAEC;IADG,cAAqB;IAE7B;;WAEO;IACH,uBAEC;IAED;;OAEG;IACH,sCAEC;IADG,kBAA6B;IAErC;;WAEO;IACH,uBAEC;IAED;;OAEG;IACH,sCAEC;IADG,kBAA6B;IAErC;;;WAGO;IACH,kCAEC;IAED;;;OAGG;IACH,4DAEC;IADG,6BAAmD;IAE3D;;;WAGO;IACH,6BAEC;IAED;;;OAGG;IACH,qDAEC;IADG,wBAA+C;IAEvD;;WAEO;IACH,oCAEC;IAED;;OAEG;IACH,+DAEC;IADG,+BAAqD;IAE7D;;WAEO;IACH,yBAFY,KAAK,eAAQ,CAIxB;IAED;;OAEG;IACH,qDAEC;IADG,wBAA+C;IAEvD;;WAEO;IACH,4BAFY,KAAK,eAAQ,CAIxB;IAED;;OAEG;IACH,2DAEC;IADG,2BAAqD;IAE7D;;WAEO;IACH,+BAFY,KAAK,eAAQ,CAIxB;IAED;;OAEG;IACH,iEAEC;IADG,8BAA2D;IAEnE;;WAEO;IACH,8BAFY,KAAK,eAAQ,CAIxB;IAED;;OAEG;IACH,+DAEC;IADG,6BAAyD;IAEjE;;WAEO;IACH,yBAFY,GAAoC,CAI/C;IAED;;OAEG;IACH,0CAFW,GAAoC,QAI9C;IADG,wBAA+C;IAEvD;;WAEO;IACH,yBAEC;IAED;;OAEG;IACH,0CAEC;IADG,oBAAiC;IAEzC;;WAEO;IACH,2BAEC;IAED;;OAEG;IACH,8CAEC;IADG,sBAAqC;CAG5C"}
+{"version":3,"file":"GraphTraversalInput.d.ts","sourceRoot":"","sources":["../../src/model/GraphTraversalInput.js"],"names":[],"mappings":";AAkBA;;;;GAIG;AACH;IAWI;;;;OAIG;IACH,kCACC;IAED;;;;;;OAMG;IACH,2CAHW,GAAgC,GAC/B,GAAgC,CAgL3C;IAED;;;;OAIG;IACH,gCAFY,OAAO,CAiNlB;IAEL;;;WAGO;IACH,qBAEC;IAED;;;OAGG;IACH,kCAEC;IADG,gBAAyB;IAEjC;;;WAGO;IACH,2BAEC;IAED;;;OAGG;IACH,8CAEC;IADG,sBAAqC;IAE7C;;;WAGO;IACH,qBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,kCAFW,KAAK,QAAS,QAIxB;IADG,yBAAuC;IAE/C;;;WAGO;IACH,4BAEC;IAED;;;OAGG;IACH,gDAEC;IADG,uBAAuC;IAE/C;;;WAGO;IACH,sBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,oCAFW,KAAK,QAAS,QAIxB;IADG,0BAAyC;IAEjD;;;WAGO;IACH,yBAEC;IAED;;;OAGG;IACH,0CAEC;IADG,oBAAiC;IAEzC;;;WAGO;IACH,mBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,8BAFW,KAAK,QAAS,QAIxB;IADG,uBAAmC;IAE3C;;;WAGO;IACH,0BAEC;IAED;;;OAGG;IACH,4CAEC;IADG,qBAAmC;IAE3C;;;WAGO;IACH,oBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,gCAFW,KAAK,QAAS,QAIxB;IADG,wBAAqC;IAE7C;;;WAGO;IACH,uBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,sCAFW,KAAK,QAAS,QAIxB;IADG,2BAA2C;IAEnD;;;WAGO;IACH,qBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,kCAFW,KAAK,QAAS,QAIxB;IADG,yBAAuC;IAE/C;;;WAGO;IACH,yBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,0CAFW,KAAK,QAAS,QAIxB;IADG,6BAA+C;IAEvD;;;WAGO;IACH,wBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,wCAFW,KAAK,QAAS,QAIxB;IADG,4BAA6C;IAErD;;;WAGO;IACH,+BAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,sDAFW,KAAK,QAAS,QAIxB;IADG,mCAA2D;IAEnE;;;WAGO;IACH,kBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,4BAFW,KAAK,QAAS,QAIxB;IADG,sBAAiC;IAEzC;;;WAGO;IACH,yBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,0CAFW,KAAK,QAAS,QAIxB;IADG,6BAA+C;IAEvD;;;WAGO;IACH,kCAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,4DAFW,KAAK,QAAS,QAIxB;IADG,sCAAiE;IAEzE;;;WAGO;IACH,gCAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,wDAFW,KAAK,QAAS,QAIxB;IADG,oCAA6D;IAErE;;;WAGO;IACH,qCAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,kEAFW,KAAK,QAAS,QAIxB;IADG,yCAAuE;IAE/E;;;WAGO;IACH,mCAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,8DAFW,KAAK,QAAS,QAIxB;IADG,uCAAmE;IAE3E;;;WAGO;IACH,4BAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,gDAFW,KAAK,QAAS,QAIxB;IADG,gCAAqD;IAE7D;;;WAGO;IACH,0BAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,4CAFW,KAAK,QAAS,QAIxB;IADG,8BAAiD;IAEzD;;;WAGO;IACH,+BAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,sDAFW,KAAK,QAAS,QAIxB;IADG,mCAA2D;IAEnE;;;WAGO;IACH,6BAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,kDAFW,KAAK,QAAS,QAIxB;IADG,iCAAuD;IAE/D;;WAEO;IACH,uBAFY,GAA6B,CAIxC;IAED;;OAEG;IACH,sCAFW,GAA6B,QAIvC;IADG,sBAA2C;IAEnD;;WAEO;IACH,qBAFY,GAA6B,CAIxC;IAED;;OAEG;IACH,kCAFW,GAA6B,QAIvC;IADG,oBAAuC;IAE/C;;;WAGO;IACH,kBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,4BAFW,KAAK,QAAS,QAIxB;IADG,sBAAiC;IAEzC;;;WAGO;IACH,kBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,4BAFW,KAAK,QAAS,QAIxB;IADG,sBAAiC;IAEzC;;;WAGO;IACH,qBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,kCAFW,KAAK,QAAS,QAIxB;IADG,yBAAuC;IAE/C;;;WAGO;IACH,gBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,wBAFW,KAAK,QAAS,QAIxB;IADG,oBAA6B;IAErC;;;WAGO;IACH,gBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,wBAFW,KAAK,QAAS,QAIxB;IADG,oBAA6B;IAErC;;;WAGO;IACH,mBAFY,KAAK,QAAS,CAIzB;IAED;;;OAGG;IACH,8BAFW,KAAK,QAAS,QAIxB;IADG,uBAAmC;IAE3C;;;WAGO;IACH,gBAFY,GAA8C,CAIzD;IAED;;;OAGG;IACH,wBAFW,GAA8C,QAIxD;IADG,eAA6B;IAErC;;;WAGO;IACH,0CAFY,GAAwE,CAInF;IAED;;;OAGG;IACH,4EAFW,GAAwE,QAIlF;IADG,yCAAiF;IAEzF;;;WAGO;IACH,wCAFY,GAAsE,CAIjF;IAED;;;OAGG;IACH,wEAFW,GAAsE,QAIhF;IADG,uCAA6E;IAErF;;;WAGO;IACH,6CAFY,GAA2E,CAItF;IAED;;;OAGG;IACH,kFAFW,GAA2E,QAIrF;IADG,4CAAuF;IAE/F;;;WAGO;IACH,2CAFY,GAAyE,CAIpF;IAED;;;OAGG;IACH,8EAFW,GAAyE,QAInF;IADG,0CAAmF;IAE3F;;WAEO;IACH,eAFY,GAAgC,CAI3C;IAED;;OAEG;IACH,sBAFW,GAAgC,QAI1C;IADG,cAA2B;IAEnC;;WAEO;IACH,gBAFY,GAAgC,CAI3C;IAED;;OAEG;IACH,wBAFW,GAAgC,QAI1C;IADG,eAA6B;IAErC;;WAEO;IACH,uBAFY,GAAgC,CAI3C;IAED;;OAEG;IACH,sCAFW,GAAgC,QAI1C;IADG,sBAA2C;IAEnD;;;WAGO;IACH,2BAEC;IAED;;;OAGG;IACH,6CAEC;IADG,sBAAmC;IAE3C;;;WAGO;IACH,2BAEC;IAED;;;OAGG;IACH,8CAEC;IADG,sBAAqC;IAE7C;;;WAGO;IACH,2BAEC;IAED;;;OAGG;IACH,8CAEC;IADG,sBAAqC;IAE7C;;;WAGO;IACH,wBAEC;IAED;;;OAGG;IACH,wCAEC;IADG,mBAA+B;IAEvC;;;WAGO;IACH,mBAEC;IAED;;;OAGG;IACH,8BAEC;IADG,cAAqB;IAE7B;;;WAGO;IACH,uBAEC;IAED;;;OAGG;IACH,sCAEC;IADG,kBAA6B;IAErC;;;WAGO;IACH,uBAEC;IAED;;;OAGG;IACH,sCAEC;IADG,kBAA6B;IAErC;;;WAGO;IACH,kCAEC;IAED;;;OAGG;IACH,4DAEC;IADG,6BAAmD;IAE3D;;;WAGO;IACH,6BAEC;IAED;;;OAGG;IACH,qDAEC;IADG,wBAA+C;IAEvD;;;WAGO;IACH,yBAFY,KAAK,eAAQ,CAIxB;IAED;;;OAGG;IACH,qDAEC;IADG,wBAA+C;IAEvD;;;WAGO;IACH,4BAFY,KAAK,eAAQ,CAIxB;IAED;;;OAGG;IACH,2DAEC;IADG,2BAAqD;IAE7D;;;WAGO;IACH,+BAFY,KAAK,eAAQ,CAIxB;IAED;;;OAGG;IACH,iEAEC;IADG,8BAA2D;IAEnE;;;WAGO;IACH,8BAFY,KAAK,eAAQ,CAIxB;IAED;;;OAGG;IACH,+DAEC;IADG,6BAAyD;IAEjE;;WAEO;IACH,yBAFY,GAAoC,CAI/C;IAED;;OAEG;IACH,0CAFW,GAAoC,QAI9C;IADG,wBAA+C;IAEvD;;;WAGO;IACH,yBAEC;IAED;;;OAGG;IACH,0CAEC;IADG,oBAAiC;IAEzC;;;WAGO;IACH,2BAEC;IAED;;;OAGG;IACH,8CAEC;IADG,sBAAqC;CAG5C"}