@hubbleprotocol/carpool-typescript-client
Version:
OpenAPI TypeScript client for Carpool
85 lines (82 loc) • 2.11 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* Carpool Query
* The Carpool Query API
*
* OpenAPI spec version: 1.0
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
/**
*
* @export
* @interface InstructionSearchRequest
*/
export interface InstructionSearchRequest {
/**
* Number of entries to return. Default is 10.
* @type {number}
* @memberof InstructionSearchRequest
*/
size?: number;
/**
* Pagination starting point.
* @type {number}
* @memberof InstructionSearchRequest
*/
from?: number;
/**
* A starting slot for the search (inclusive)
* @type {number}
* @memberof InstructionSearchRequest
*/
start?: number;
/**
* An ending slot for the search (exclusive)
* @type {number}
* @memberof InstructionSearchRequest
*/
end?: number;
/**
* Slot sort order for results. Defaults to \"desc\".
* @type {string}
* @memberof InstructionSearchRequest
*/
sort?: InstructionSearchRequestSortEnum;
/**
* A specific instruction name to search though.
* @type {string}
* @memberof InstructionSearchRequest
*/
instructionName?: string;
/**
* AND queries - An array of elasticsearch conditions which must ALL match. Supports nesting.
* @type {Array<Array>}
* @memberof InstructionSearchRequest
*/
must?: Array<object>;
/**
* NOR queries - An array of elasticsearch conditions which must ALL NOT match. Supports nesting.
* @type {Array<Array>}
* @memberof InstructionSearchRequest
*/
mustNot?: Array<object>;
/**
* OR querires - An array of elasticsearch conditions of which, at least ONE must match. Supports nesting.
* @type {Array<Array>}
* @memberof InstructionSearchRequest
*/
should?: Array<object>;
}
/**
* @export
* @enum {string}
*/
export enum InstructionSearchRequestSortEnum {
Asc = 'asc',
Desc = 'desc'
}