Globus SDK for JavaScript
    Preparing search index...

    Interface paths

    interface paths {
        "/beta/index/{index_id}/field_budget": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                budget?: number;
                                remaining?: number;
                                used?: number;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/beta/index/{index_id}/mapping": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": { mappings?: { [key: string]: unknown } };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/beta/index/{index_id}/mapping/{field_name}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { field_name: string; index_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": { mappings?: { [key: string]: unknown } };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/json": { description: string; display_name: string };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                creation_date?: string;
                                description?: string;
                                display_name?: string;
                                entry_schema?: { [key: string]: unknown };
                                id?: string;
                                is_trial?: boolean;
                                max_size_in_mb?: number;
                                num_entries?: number;
                                num_subjects?: number;
                                size_in_mb?: number;
                                status?: string;
                                subscription_id?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index_list": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: { filter_roles?: ("owner" | "admin" | "writer")[] };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                index_list?: {
                                    creation_date?: string;
                                    description?: string;
                                    display_name?: string;
                                    entry_schema?: { [key: ...]: ... };
                                    id?: string;
                                    is_trial?: boolean;
                                    max_size_in_mb?: number;
                                    num_entries?: number;
                                    num_subjects?: number;
                                    permissions?: (...)[];
                                    size_in_mb?: number;
                                    status?: string;
                                    subscription_id?: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}": {
            delete: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": { acknowledged?: boolean; index_id?: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                creation_date?: string;
                                description?: string;
                                display_name?: string;
                                entry_schema?: { [key: string]: unknown };
                                id?: string;
                                is_trial?: boolean;
                                max_size_in_mb?: number;
                                num_entries?: number;
                                num_subjects?: number;
                                permissions?: ("owner" | "admin" | "writer")[];
                                size_in_mb?: number;
                                status?: string;
                                subscription_id?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}/batch_delete_by_subject": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: { content: { "application/json": { subjects: string[] } } };
                responses: {
                    "200": {
                        content: {
                            "application/json": { acknowledged?: boolean; task_id?: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}/delete_by_query": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/json": | {
                            "@version": "2017-09-01"
                            | "2016-11-09";
                            advanced?: boolean;
                            boosts?: { factor: number; field_name: string }[];
                            bypass_visible_to: boolean;
                            facets?: (
                                | { field_name: ...; name?: ...; size: ...; type: ... }
                                | { field_name: ...; missing?: ...; name?: ...; type: ... }
                                | {
                                    date_interval: ...;
                                    field_name: ...;
                                    histogram_range?: ...;
                                    name?: ...;
                                    type: ...;
                                }
                                | {
                                    field_name: ...;
                                    histogram_range: ...;
                                    name?: ...;
                                    size: ...;
                                    type: ...;
                                }
                            )[];
                            filter_principal_sets?: string[];
                            filters?: (
                                | { field_name: ...; post_filter: ...; type: ...; values: ... }
                                | { field_name: ...; post_filter: ...; type: ...; values: ... }
                                | { field_name: ...; post_filter: ...; type: ...; values: ... }
                                | {
                                    bottom_right: ...;
                                    field_name: ...;
                                    post_filter: ...;
                                    top_left: ...;
                                    type: ...;
                                }
                                | {
                                    field_name: ...;
                                    post_filter: ...;
                                    relation: ...;
                                    shape: ...;
                                    type: ...;
                                }
                                | { field_name: ...; post_filter: ...; type: ... }
                                | { field_name: ...; post_filter: ...; type: ...; value: ... }
                                | { filter: ...; post_filter: ...; type: ... }
                                | { filters: ...; post_filter: ...; type: ... }
                                | { filters: ...; post_filter: ...; type: ... }
                            )[];
                            limit: number;
                            offset?: number;
                            q?: string;
                            sort?: { field_name: string; order: (...) | (...) }[];
                        }
                        | {
                            "@version": "delete_by_query#1.0.0";
                            advanced?: boolean;
                            filters?: (
                                | { field_name: ...; type: ...; values: ... }
                                | { field_name: ...; type: ...; values: ... }
                                | { field_name: ...; type: ...; values: ... }
                                | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                                | { field_name: ...; relation: ...; shape: ...; type: ... }
                                | { field_name: ...; type: ... }
                                | { field_name: ...; type: ...; value: ... }
                                | { filter: ...; type: ... }
                                | { filters: ...; type: ... }
                                | { filters: ...; type: ... }
                            )[];
                            q?: string;
                            q_settings?:
                                | { default_operator: string; mode: "query_string" }
                                | { default_operator: string; mode: "advanced_query_string" };
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": { acknowledged?: boolean; task_id?: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}/entry": {
            delete: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query: { entry_id?: null | string; subject: string };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": { acknowledged?: boolean; task_id?: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query: {
                        bypass_visible_to?: boolean;
                        entry_id?: null | string;
                        subject: string;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                "@version": unknown;
                                entries?: {
                                    content?: { [key: ...]: ... };
                                    entry_id?: string;
                                    matched_principal_sets?: (...)[];
                                }[];
                                subject?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/json": {
                            content: { [key: string]: unknown };
                            id: null | string;
                            principal_sets?: { [key: string]: string[] };
                            subject: string;
                            visible_to: string[];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": { acknowledged?: boolean; task_id?: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/json": {
                            content: { [key: string]: unknown };
                            id: null | string;
                            principal_sets?: { [key: string]: string[] };
                            subject: string;
                            visible_to: string[];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": { acknowledged?: boolean; task_id?: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            trace?: undefined;
        };
        "/v1/index/{index_id}/ingest": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/json": | {
                            field_mapping?: { [key: string]: "geo_shape"
                            | "geo_point" };
                            ingest_data: {
                                content: { [key: string]: unknown };
                                id: null | string;
                                principal_sets?: { [key: string]: (...)[] };
                                subject: string;
                                visible_to: string[];
                            };
                            ingest_type: "GMetaEntry";
                        }
                        | {
                            field_mapping?: { [key: string]: "geo_shape"
                            | "geo_point" };
                            ingest_data: {
                                gmeta: {
                                    content: { [key: ...]: ... };
                                    id: (...) | (...);
                                    principal_sets?: (...) | (...);
                                    subject: string;
                                    visible_to: (...)[];
                                }[];
                            };
                            ingest_type: "GMetaList";
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": { acknowledged?: boolean; task_id?: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}/reopen": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": { acknowledged?: boolean; index_id?: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}/role": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/json": {
                            principal?: string;
                            role_name?: "owner"
                            | "admin"
                            | "writer";
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                creation_date?: string;
                                id?: string;
                                index_id?: string;
                                principal?: string;
                                principal_type?: "identity"
                                | "group";
                                role_name?: "owner" | "admin" | "writer";
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}/role_list": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                role_list?: {
                                    creation_date?: string;
                                    id?: string;
                                    index_id?: string;
                                    principal?: string;
                                    principal_type?: "identity"
                                    | "group";
                                    role_name?: "owner" | "admin" | "writer";
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}/role/{role_id}": {
            delete: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string; role_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                deleted?: {
                                    creation_date?: string;
                                    id?: string;
                                    index_id?: string;
                                    principal?: string;
                                    principal_type?: "identity"
                                    | "group";
                                    role_name?: "owner" | "admin" | "writer";
                                };
                                success?: boolean;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}/scroll": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/json": | {
                            "@version": "2017-09-01";
                            advanced?: boolean;
                            bypass_visible_to: boolean;
                            filter_principal_sets?: string[];
                            filters?: (
                                | { field_name: ...; post_filter: ...; type: ...; values: ... }
                                | { field_name: ...; post_filter: ...; type: ...; values: ... }
                                | { field_name: ...; post_filter: ...; type: ...; values: ... }
                                | {
                                    bottom_right: ...;
                                    field_name: ...;
                                    post_filter: ...;
                                    top_left: ...;
                                    type: ...;
                                }
                                | {
                                    field_name: ...;
                                    post_filter: ...;
                                    relation: ...;
                                    shape: ...;
                                    type: ...;
                                }
                                | { field_name: ...; post_filter: ...; type: ... }
                                | { field_name: ...; post_filter: ...; type: ...; value: ... }
                                | { filter: ...; post_filter: ...; type: ... }
                                | { filters: ...; post_filter: ...; type: ... }
                                | { filters: ...; post_filter: ...; type: ... }
                            )[];
                            limit: number;
                            marker?: unknown;
                            q?: string;
                        }
                        | {
                            "@version": "scroll#1.0.0";
                            advanced?: boolean;
                            bypass_visible_to: boolean;
                            filter_principal_sets?: string[];
                            filters?: (
                                | { field_name: ...; type: ...; values: ... }
                                | { field_name: ...; type: ...; values: ... }
                                | { field_name: ...; type: ...; values: ... }
                                | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                                | { field_name: ...; relation: ...; shape: ...; type: ... }
                                | { field_name: ...; type: ... }
                                | { field_name: ...; type: ...; value: ... }
                                | { filter: ...; type: ... }
                                | { filters: ...; type: ... }
                                | { filters: ...; type: ... }
                            )[];
                            limit: number;
                            marker?: unknown;
                            q?: string;
                            q_settings?:
                                | { default_operator: string; mode: "query_string" }
                                | { default_operator: string; mode: "advanced_query_string" };
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                count?: number;
                                gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                                has_next_page?: boolean;
                                marker?: unknown;
                                total?: number;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}/search": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query: {
                        advanced?: boolean;
                        bypass_visible_to?: boolean;
                        filter_principal_sets?: string[];
                        limit?: number;
                        offset?: number;
                        q: string;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                count?: number;
                                facet_results?: (
                                    | { approximate_value?: (...)
                                    | (...); name?: (...) | (...) }
                                    | { name?: (...) | (...); value?: (...) | (...) }
                                    | { buckets?: (...) | (...); name?: (...) | (...) }
                                )[];
                                gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                                has_next_page?: boolean;
                                offset?: number;
                                total?: number;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/json": | {
                            "@version": "2017-09-01"
                            | "2016-11-09";
                            advanced?: boolean;
                            boosts?: { factor: number; field_name: string }[];
                            bypass_visible_to: boolean;
                            facets?: (
                                | { field_name: ...; name?: ...; size: ...; type: ... }
                                | { field_name: ...; missing?: ...; name?: ...; type: ... }
                                | {
                                    date_interval: ...;
                                    field_name: ...;
                                    histogram_range?: ...;
                                    name?: ...;
                                    type: ...;
                                }
                                | {
                                    field_name: ...;
                                    histogram_range: ...;
                                    name?: ...;
                                    size: ...;
                                    type: ...;
                                }
                            )[];
                            filter_principal_sets?: string[];
                            filters?: (
                                | { field_name: ...; post_filter: ...; type: ...; values: ... }
                                | { field_name: ...; post_filter: ...; type: ...; values: ... }
                                | { field_name: ...; post_filter: ...; type: ...; values: ... }
                                | {
                                    bottom_right: ...;
                                    field_name: ...;
                                    post_filter: ...;
                                    top_left: ...;
                                    type: ...;
                                }
                                | {
                                    field_name: ...;
                                    post_filter: ...;
                                    relation: ...;
                                    shape: ...;
                                    type: ...;
                                }
                                | { field_name: ...; post_filter: ...; type: ... }
                                | { field_name: ...; post_filter: ...; type: ...; value: ... }
                                | { filter: ...; post_filter: ...; type: ... }
                                | { filters: ...; post_filter: ...; type: ... }
                                | { filters: ...; post_filter: ...; type: ... }
                            )[];
                            limit: number;
                            offset?: number;
                            q?: string;
                            sort?: { field_name: string; order: (...) | (...) }[];
                        }
                        | {
                            "@version": "query#1.0.0";
                            advanced?: boolean;
                            boosts?: { factor: number; field_name: string }[];
                            bypass_visible_to: boolean;
                            facets?: (
                                | {
                                    additional_filters?: ...;
                                    field_name: ...;
                                    name?: ...;
                                    size: ...;
                                    type: ...;
                                }
                                | {
                                    additional_filters?: ...;
                                    field_name: ...;
                                    missing?: ...;
                                    name?: ...;
                                    type: ...;
                                }
                                | {
                                    additional_filters?: ...;
                                    field_name: ...;
                                    name?: ...;
                                    type: ...;
                                }
                                | {
                                    additional_filters?: ...;
                                    date_interval: ...;
                                    field_name: ...;
                                    histogram_range?: ...;
                                    name?: ...;
                                    type: ...;
                                }
                                | {
                                    additional_filters?: ...;
                                    field_name: ...;
                                    histogram_range: ...;
                                    name?: ...;
                                    size: ...;
                                    type: ...;
                                }
                            )[];
                            filter_principal_sets?: string[];
                            filters?: (
                                | { field_name: ...; type: ...; values: ... }
                                | { field_name: ...; type: ...; values: ... }
                                | { field_name: ...; type: ...; values: ... }
                                | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                                | { field_name: ...; relation: ...; shape: ...; type: ... }
                                | { field_name: ...; type: ... }
                                | { field_name: ...; type: ...; value: ... }
                                | { filter: ...; type: ... }
                                | { filters: ...; type: ... }
                                | { filters: ...; type: ... }
                            )[];
                            limit: number;
                            offset?: number;
                            post_facet_filters?: (
                                | { field_name: ...; type: ...; values: ... }
                                | { field_name: ...; type: ...; values: ... }
                                | { field_name: ...; type: ...; values: ... }
                                | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                                | { field_name: ...; relation: ...; shape: ...; type: ... }
                                | { field_name: ...; type: ... }
                                | { field_name: ...; type: ...; value: ... }
                                | { filter: ...; type: ... }
                                | { filters: ...; type: ... }
                                | { filters: ...; type: ... }
                            )[];
                            q?: string;
                            q_settings?:
                                | { default_operator: string; mode: "query_string" }
                                | { default_operator: string; mode: "advanced_query_string" };
                            sort?: { field_name: string; order: (...) | (...) }[];
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                count?: number;
                                facet_results?: (
                                    | { approximate_value?: (...)
                                    | (...); name?: (...) | (...) }
                                    | { name?: (...) | (...); value?: (...) | (...) }
                                    | { buckets?: (...) | (...); name?: (...) | (...) }
                                )[];
                                gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                                has_next_page?: boolean;
                                offset?: number;
                                total?: number;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/v1/index/{index_id}/subject": {
            delete: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query: { subject: string };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": { acknowledged?: boolean; task_id?: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query: { bypass_visible_to?: boolean; subject: string };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                "@version": unknown;
                                entries?: {
                                    content?: { [key: ...]: ... };
                                    entry_id?: string;
                                    matched_principal_sets?: (...)[];
                                }[];
                                subject?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v1/task_list/{index_id}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { index_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                index_id?: string;
                                tasks?: {
                                    additional_details?: unknown;
                                    completion_date?: null
                                    | string;
                                    creation_date?: string;
                                    index_id?: string;
                                    message?: string;
                                    state?: "FAILED" | "PENDING" | "PROGRESS" | "SUCCESS" | "CREATING";
                                    state_description?: string;
                                    task_id?: string;
                                    task_type?: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/v1/task/{task_id}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { task_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                additional_details?: unknown;
                                completion_date?: null
                                | string;
                                creation_date?: string;
                                index_id?: string;
                                message?: string;
                                state?: "FAILED" | "PENDING" | "PROGRESS" | "SUCCESS" | "CREATING";
                                state_description?: string;
                                task_id?: string;
                                task_type?: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
    }
    Index

    Properties

    /beta/index/{index_id}/field_budget /beta/index/{index_id}/mapping /beta/index/{index_id}/mapping/{field_name} /v1/index /v1/index_list /v1/index/{index_id} /v1/index/{index_id}/batch_delete_by_subject /v1/index/{index_id}/delete_by_query /v1/index/{index_id}/entry /v1/index/{index_id}/ingest /v1/index/{index_id}/reopen /v1/index/{index_id}/role /v1/index/{index_id}/role_list /v1/index/{index_id}/role/{role_id} /v1/index/{index_id}/scroll /v1/index/{index_id}/search /v1/index/{index_id}/subject /v1/task_list/{index_id} /v1/task/{task_id}

    Properties

    "/beta/index/{index_id}/field_budget": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            budget?: number;
                            remaining?: number;
                            used?: number;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          budget?: number;
                          remaining?: number;
                          used?: number;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      [BETA] Get Field Budget Information

      Requires a writer, admin, or owner role on the index.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        budget?: number;
                        remaining?: number;
                        used?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      budget?: number;
                      remaining?: number;
                      used?: number;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Field budget information, showing an index's usage of fields.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/beta/index/{index_id}/mapping": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": { mappings?: { [key: string]: unknown } };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": { mappings?: { [key: string]: unknown } };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      [BETA] Get Index Mapping

      Lookup the mapped types of all fields in an index.

      Requires a `writer`, `admin`, or `owner` role on the index.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": { mappings?: { [key: string]: unknown } };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { mappings?: { [key: string]: unknown } };
              };
              headers: { [name: string]: unknown };
          }

          Field to type mapping.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/beta/index/{index_id}/mapping/{field_name}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { field_name: string; index_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": { mappings?: { [key: string]: unknown } };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { field_name: string; index_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": { mappings?: { [key: string]: unknown } };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      [BETA] Get Field Mapping

      Lookup the mapped type for a specific field in an index. The mappings object will contain only one field.

      Requires a `writer`, `admin`, or `owner` role on the index.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { field_name: string; index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": { mappings?: { [key: string]: unknown } };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { mappings?: { [key: string]: unknown } };
              };
              headers: { [name: string]: unknown };
          }

          Field to type mapping.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/json": { description: string; display_name: string };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            creation_date?: string;
                            description?: string;
                            display_name?: string;
                            entry_schema?: { [key: string]: unknown };
                            id?: string;
                            is_trial?: boolean;
                            max_size_in_mb?: number;
                            num_entries?: number;
                            num_subjects?: number;
                            size_in_mb?: number;
                            status?: string;
                            subscription_id?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/json": { description: string; display_name: string };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          creation_date?: string;
                          description?: string;
                          display_name?: string;
                          entry_schema?: { [key: string]: unknown };
                          id?: string;
                          is_trial?: boolean;
                          max_size_in_mb?: number;
                          num_entries?: number;
                          num_subjects?: number;
                          size_in_mb?: number;
                          status?: string;
                          subscription_id?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Index Create

      Create a new Index. You will automatically be assigned as an 'owner' on the resulting index.

      New indices have `is_trial=true` when they are created. Users are limited
in the number of trial indices they may own -- so the operation may fail if
you already own a trial index.
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index_list": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: { filter_roles?: ("owner" | "admin" | "writer")[] };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            index_list?: {
                                creation_date?: string;
                                description?: string;
                                display_name?: string;
                                entry_schema?: { [key: ...]: ... };
                                id?: string;
                                is_trial?: boolean;
                                max_size_in_mb?: number;
                                num_entries?: number;
                                num_subjects?: number;
                                permissions?: (...)[];
                                size_in_mb?: number;
                                status?: string;
                                subscription_id?: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: { filter_roles?: ("owner" | "admin" | "writer")[] };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          index_list?: {
                              creation_date?: string;
                              description?: string;
                              display_name?: string;
                              entry_schema?: { [key: ...]: ... };
                              id?: string;
                              is_trial?: boolean;
                              max_size_in_mb?: number;
                              num_entries?: number;
                              num_subjects?: number;
                              permissions?: (...)[];
                              size_in_mb?: number;
                              status?: string;
                              subscription_id?: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Index List

      Lookup descriptive information about all indices on which you have write or admin permissions. Returns a list of at most 100 such indices.

      The indices will be annotated with a list of permissions which the current user has
on the indices.

By default, all indices where the user has a role are included in the results.
To filter to a subset of roles, pass the `filter_roles` query parameter.
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": { acknowledged?: boolean; index_id?: string };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            creation_date?: string;
                            description?: string;
                            display_name?: string;
                            entry_schema?: { [key: string]: unknown };
                            id?: string;
                            is_trial?: boolean;
                            max_size_in_mb?: number;
                            num_entries?: number;
                            num_subjects?: number;
                            permissions?: ("owner" | "admin" | "writer")[];
                            size_in_mb?: number;
                            status?: string;
                            subscription_id?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • delete: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": { acknowledged?: boolean; index_id?: string };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Index Delete

      Delete an Index. This operation is not instantaneous, but marks the index for deletion by putting it into the 'delete-pending' state. Once all active tasks have been cancelled and the index is safe to clean up, it will be deleted.

      If an index is non-trial, the deletion will wait for 30 days.
During that time, the index will not be usable, except for the
`POST /v1/index/<index_id>/reopen` operation, which cancels the deletion.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": { acknowledged?: boolean; index_id?: string };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { acknowledged?: boolean; index_id?: string };
              };
              headers: { [name: string]: unknown };
          }

          An index deletion response

    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          creation_date?: string;
                          description?: string;
                          display_name?: string;
                          entry_schema?: { [key: string]: unknown };
                          id?: string;
                          is_trial?: boolean;
                          max_size_in_mb?: number;
                          num_entries?: number;
                          num_subjects?: number;
                          permissions?: ("owner" | "admin" | "writer")[];
                          size_in_mb?: number;
                          status?: string;
                          subscription_id?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Index Info

      Lookup descriptive information about an index.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}/batch_delete_by_subject": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: { content: { "application/json": { subjects: string[] } } };
            responses: {
                "200": {
                    content: {
                        "application/json": { acknowledged?: boolean; task_id?: string };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: { content: { "application/json": { subjects: string[] } } };
          responses: {
              "200": {
                  content: {
                      "application/json": { acknowledged?: boolean; task_id?: string };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Delete By Subject

      Delete the document with the given Subject(s).

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: { content: { "application/json": { subjects: string[] } } }
      • responses: {
            "200": {
                content: {
                    "application/json": { acknowledged?: boolean; task_id?: string };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { acknowledged?: boolean; task_id?: string };
              };
              headers: { [name: string]: unknown };
          }

          A Task Submission response

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}/delete_by_query": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/json": | {
                        "@version": "2017-09-01"
                        | "2016-11-09";
                        advanced?: boolean;
                        boosts?: { factor: number; field_name: string }[];
                        bypass_visible_to: boolean;
                        facets?: (
                            | { field_name: ...; name?: ...; size: ...; type: ... }
                            | { field_name: ...; missing?: ...; name?: ...; type: ... }
                            | {
                                date_interval: ...;
                                field_name: ...;
                                histogram_range?: ...;
                                name?: ...;
                                type: ...;
                            }
                            | {
                                field_name: ...;
                                histogram_range: ...;
                                name?: ...;
                                size: ...;
                                type: ...;
                            }
                        )[];
                        filter_principal_sets?: string[];
                        filters?: (
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | {
                                bottom_right: ...;
                                field_name: ...;
                                post_filter: ...;
                                top_left: ...;
                                type: ...;
                            }
                            | {
                                field_name: ...;
                                post_filter: ...;
                                relation: ...;
                                shape: ...;
                                type: ...;
                            }
                            | { field_name: ...; post_filter: ...; type: ... }
                            | { field_name: ...; post_filter: ...; type: ...; value: ... }
                            | { filter: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                        )[];
                        limit: number;
                        offset?: number;
                        q?: string;
                        sort?: { field_name: string; order: (...) | (...) }[];
                    }
                    | {
                        "@version": "delete_by_query#1.0.0";
                        advanced?: boolean;
                        filters?: (
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                            | { field_name: ...; relation: ...; shape: ...; type: ... }
                            | { field_name: ...; type: ... }
                            | { field_name: ...; type: ...; value: ... }
                            | { filter: ...; type: ... }
                            | { filters: ...; type: ... }
                            | { filters: ...; type: ... }
                        )[];
                        q?: string;
                        q_settings?:
                            | { default_operator: string; mode: "query_string" }
                            | { default_operator: string; mode: "advanced_query_string" };
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": { acknowledged?: boolean; task_id?: string };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/json": | {
                      "@version": "2017-09-01"
                      | "2016-11-09";
                      advanced?: boolean;
                      boosts?: { factor: number; field_name: string }[];
                      bypass_visible_to: boolean;
                      facets?: (
                          | { field_name: ...; name?: ...; size: ...; type: ... }
                          | { field_name: ...; missing?: ...; name?: ...; type: ... }
                          | {
                              date_interval: ...;
                              field_name: ...;
                              histogram_range?: ...;
                              name?: ...;
                              type: ...;
                          }
                          | {
                              field_name: ...;
                              histogram_range: ...;
                              name?: ...;
                              size: ...;
                              type: ...;
                          }
                      )[];
                      filter_principal_sets?: string[];
                      filters?: (
                          | { field_name: ...; post_filter: ...; type: ...; values: ... }
                          | { field_name: ...; post_filter: ...; type: ...; values: ... }
                          | { field_name: ...; post_filter: ...; type: ...; values: ... }
                          | {
                              bottom_right: ...;
                              field_name: ...;
                              post_filter: ...;
                              top_left: ...;
                              type: ...;
                          }
                          | {
                              field_name: ...;
                              post_filter: ...;
                              relation: ...;
                              shape: ...;
                              type: ...;
                          }
                          | { field_name: ...; post_filter: ...; type: ... }
                          | { field_name: ...; post_filter: ...; type: ...; value: ... }
                          | { filter: ...; post_filter: ...; type: ... }
                          | { filters: ...; post_filter: ...; type: ... }
                          | { filters: ...; post_filter: ...; type: ... }
                      )[];
                      limit: number;
                      offset?: number;
                      q?: string;
                      sort?: { field_name: string; order: (...) | (...) }[];
                  }
                  | {
                      "@version": "delete_by_query#1.0.0";
                      advanced?: boolean;
                      filters?: (
                          | { field_name: ...; type: ...; values: ... }
                          | { field_name: ...; type: ...; values: ... }
                          | { field_name: ...; type: ...; values: ... }
                          | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                          | { field_name: ...; relation: ...; shape: ...; type: ... }
                          | { field_name: ...; type: ... }
                          | { field_name: ...; type: ...; value: ... }
                          | { filter: ...; type: ... }
                          | { filters: ...; type: ... }
                          | { filters: ...; type: ... }
                      )[];
                      q?: string;
                      q_settings?:
                          | { default_operator: string; mode: "query_string" }
                          | { default_operator: string; mode: "advanced_query_string" };
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": { acknowledged?: boolean; task_id?: string };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Delete By Query

      Delete all documents in an index matching a given query. Boost, sort, limit, offset, and facet parameters are allowed but will be ignored.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: {
            content: {
                "application/json":
                    | {
                        "@version": "2017-09-01"
                        | "2016-11-09";
                        advanced?: boolean;
                        boosts?: { factor: number; field_name: string }[];
                        bypass_visible_to: boolean;
                        facets?: (
                            | { field_name: ...; name?: ...; size: ...; type: ... }
                            | { field_name: ...; missing?: ...; name?: ...; type: ... }
                            | {
                                date_interval: ...;
                                field_name: ...;
                                histogram_range?: ...;
                                name?: ...;
                                type: ...;
                            }
                            | {
                                field_name: ...;
                                histogram_range: ...;
                                name?: ...;
                                size: ...;
                                type: ...;
                            }
                        )[];
                        filter_principal_sets?: string[];
                        filters?: (
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | {
                                bottom_right: ...;
                                field_name: ...;
                                post_filter: ...;
                                top_left: ...;
                                type: ...;
                            }
                            | {
                                field_name: ...;
                                post_filter: ...;
                                relation: ...;
                                shape: ...;
                                type: ...;
                            }
                            | { field_name: ...; post_filter: ...; type: ... }
                            | { field_name: ...; post_filter: ...; type: ...; value: ... }
                            | { filter: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                        )[];
                        limit: number;
                        offset?: number;
                        q?: string;
                        sort?: { field_name: string; order: (...) | (...) }[];
                    }
                    | {
                        "@version": "delete_by_query#1.0.0";
                        advanced?: boolean;
                        filters?: (
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                            | { field_name: ...; relation: ...; shape: ...; type: ... }
                            | { field_name: ...; type: ... }
                            | { field_name: ...; type: ...; value: ... }
                            | { filter: ...; type: ... }
                            | { filters: ...; type: ... }
                            | { filters: ...; type: ... }
                        )[];
                        q?: string;
                        q_settings?:
                            | { default_operator: string; mode: "query_string" }
                            | { default_operator: string; mode: "advanced_query_string" };
                    };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": { acknowledged?: boolean; task_id?: string };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { acknowledged?: boolean; task_id?: string };
              };
              headers: { [name: string]: unknown };
          }

          A Task Submission response

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}/entry": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query: { entry_id?: null | string; subject: string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": { acknowledged?: boolean; task_id?: string };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query: {
                    bypass_visible_to?: boolean;
                    entry_id?: null | string;
                    subject: string;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            "@version": unknown;
                            entries?: {
                                content?: { [key: ...]: ... };
                                entry_id?: string;
                                matched_principal_sets?: (...)[];
                            }[];
                            subject?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/json": {
                        content: { [key: string]: unknown };
                        id: null | string;
                        principal_sets?: { [key: string]: string[] };
                        subject: string;
                        visible_to: string[];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": { acknowledged?: boolean; task_id?: string };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/json": {
                        content: { [key: string]: unknown };
                        id: null | string;
                        principal_sets?: { [key: string]: string[] };
                        subject: string;
                        visible_to: string[];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": { acknowledged?: boolean; task_id?: string };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        trace?: undefined;
    }

    Type declaration

    • delete: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query: { entry_id?: null | string; subject: string };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": { acknowledged?: boolean; task_id?: string };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Delete Entry

      Delete a specific entry by ID.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query: { entry_id?: null | string; subject: string };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { index_id: string }
        • query: { entry_id?: null | string; subject: string }
          • Optionalentry_id?: null | string

            The entry ID for this entry. The default entry ID is null

          • subject: string

            The subject for this entry

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": { acknowledged?: boolean; task_id?: string };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { acknowledged?: boolean; task_id?: string };
              };
              headers: { [name: string]: unknown };
          }

          A Task Submission response

    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query: {
                  bypass_visible_to?: boolean;
                  entry_id?: null | string;
                  subject: string;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          "@version": unknown;
                          entries?: {
                              content?: { [key: ...]: ... };
                              entry_id?: string;
                              matched_principal_sets?: (...)[];
                          }[];
                          subject?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Entry

      Lookup a specific entry by ID.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/json": {
                      content: { [key: string]: unknown };
                      id: null | string;
                      principal_sets?: { [key: string]: string[] };
                      subject: string;
                      visible_to: string[];
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": { acknowledged?: boolean; task_id?: string };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Upsert Entry

      Create or update a single entry. This is just a wrapper around Ingest.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: {
            content: {
                "application/json": {
                    content: { [key: string]: unknown };
                    id: null | string;
                    principal_sets?: { [key: string]: string[] };
                    subject: string;
                    visible_to: string[];
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": { acknowledged?: boolean; task_id?: string };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { acknowledged?: boolean; task_id?: string };
              };
              headers: { [name: string]: unknown };
          }

          A Task Submission response

    • put: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/json": {
                      content: { [key: string]: unknown };
                      id: null | string;
                      principal_sets?: { [key: string]: string[] };
                      subject: string;
                      visible_to: string[];
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": { acknowledged?: boolean; task_id?: string };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Upsert Entry

      Create or update a single entry. This is just a wrapper around Ingest.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: {
            content: {
                "application/json": {
                    content: { [key: string]: unknown };
                    id: null | string;
                    principal_sets?: { [key: string]: string[] };
                    subject: string;
                    visible_to: string[];
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": { acknowledged?: boolean; task_id?: string };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { acknowledged?: boolean; task_id?: string };
              };
              headers: { [name: string]: unknown };
          }

          A Task Submission response

    • Optionaltrace?: undefined
    "/v1/index/{index_id}/ingest": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/json": | {
                        field_mapping?: { [key: string]: "geo_shape"
                        | "geo_point" };
                        ingest_data: {
                            content: { [key: string]: unknown };
                            id: null | string;
                            principal_sets?: { [key: string]: (...)[] };
                            subject: string;
                            visible_to: string[];
                        };
                        ingest_type: "GMetaEntry";
                    }
                    | {
                        field_mapping?: { [key: string]: "geo_shape"
                        | "geo_point" };
                        ingest_data: {
                            gmeta: {
                                content: { [key: ...]: ... };
                                id: (...) | (...);
                                principal_sets?: (...) | (...);
                                subject: string;
                                visible_to: (...)[];
                            }[];
                        };
                        ingest_type: "GMetaList";
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": { acknowledged?: boolean; task_id?: string };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/json": | {
                      field_mapping?: { [key: string]: "geo_shape"
                      | "geo_point" };
                      ingest_data: {
                          content: { [key: string]: unknown };
                          id: null | string;
                          principal_sets?: { [key: string]: (...)[] };
                          subject: string;
                          visible_to: string[];
                      };
                      ingest_type: "GMetaEntry";
                  }
                  | {
                      field_mapping?: { [key: string]: "geo_shape"
                      | "geo_point" };
                      ingest_data: {
                          gmeta: {
                              content: { [key: ...]: ... };
                              id: (...) | (...);
                              principal_sets?: (...) | (...);
                              subject: string;
                              visible_to: (...)[];
                          }[];
                      };
                      ingest_type: "GMetaList";
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": { acknowledged?: boolean; task_id?: string };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Ingest

      Create or update a single document or a collection of documents. This submits an asynchronous task and returns the task ID.

      It is possible for ingest to fail immediately with a non-200 response, but a 200 Ok
does not indicate that the task will succeed. It just means it was accepted for
processing. The status of the resulting task will be given by the state of the task.

Use Get Task to monitor tasks after submission.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: {
            content: {
                "application/json":
                    | {
                        field_mapping?: { [key: string]: "geo_shape"
                        | "geo_point" };
                        ingest_data: {
                            content: { [key: string]: unknown };
                            id: null | string;
                            principal_sets?: { [key: string]: (...)[] };
                            subject: string;
                            visible_to: string[];
                        };
                        ingest_type: "GMetaEntry";
                    }
                    | {
                        field_mapping?: { [key: string]: "geo_shape"
                        | "geo_point" };
                        ingest_data: {
                            gmeta: {
                                content: { [key: ...]: ... };
                                id: (...) | (...);
                                principal_sets?: (...) | (...);
                                subject: string;
                                visible_to: (...)[];
                            }[];
                        };
                        ingest_type: "GMetaList";
                    };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": { acknowledged?: boolean; task_id?: string };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { acknowledged?: boolean; task_id?: string };
              };
              headers: { [name: string]: unknown };
          }

          A Task Submission response

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}/reopen": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": { acknowledged?: boolean; index_id?: string };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": { acknowledged?: boolean; index_id?: string };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Index Reopen

      On an index which has a status of delete-pending, reopen that index and change its status to open. This operation is a special case of index update and requires 'owner' permissions on the index.

      Reopening an index is valid on trial and non-trial indices, but trial indices
may be deleted at any time after their deletion.
Therefore, this API is most useful for cancelling the deletion of a non-trial index.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": { acknowledged?: boolean; index_id?: string };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { acknowledged?: boolean; index_id?: string };
              };
              headers: { [name: string]: unknown };
          }

          An index reopen response

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}/role": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/json": {
                        principal?: string;
                        role_name?: "owner"
                        | "admin"
                        | "writer";
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            creation_date?: string;
                            id?: string;
                            index_id?: string;
                            principal?: string;
                            principal_type?: "identity"
                            | "group";
                            role_name?: "owner" | "admin" | "writer";
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/json": {
                      principal?: string;
                      role_name?: "owner"
                      | "admin"
                      | "writer";
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          creation_date?: string;
                          id?: string;
                          index_id?: string;
                          principal?: string;
                          principal_type?: "identity"
                          | "group";
                          role_name?: "owner" | "admin" | "writer";
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Role Create

      Create a new Role on an index. In order to create a role, you must already have the 'admin' or 'owner' role. Only owners can create other owners.

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}/role_list": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            role_list?: {
                                creation_date?: string;
                                id?: string;
                                index_id?: string;
                                principal?: string;
                                principal_type?: "identity"
                                | "group";
                                role_name?: "owner" | "admin" | "writer";
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          role_list?: {
                              creation_date?: string;
                              id?: string;
                              index_id?: string;
                              principal?: string;
                              principal_type?: "identity"
                              | "group";
                              role_name?: "owner" | "admin" | "writer";
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Role List

      List all roles on an index. In order to list roles, you must have the 'admin' or 'owner' role on an index.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}/role/{role_id}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string; role_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            deleted?: {
                                creation_date?: string;
                                id?: string;
                                index_id?: string;
                                principal?: string;
                                principal_type?: "identity"
                                | "group";
                                role_name?: "owner" | "admin" | "writer";
                            };
                            success?: boolean;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • delete: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string; role_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          deleted?: {
                              creation_date?: string;
                              id?: string;
                              index_id?: string;
                              principal?: string;
                              principal_type?: "identity"
                              | "group";
                              role_name?: "owner" | "admin" | "writer";
                          };
                          success?: boolean;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Role Delete

      Delete a Role on an index. In order to delete a role, you must have the 'admin' or 'owner' role. Unlike role creation, admin users can delete owner roles.

      The last owner role on an index cannot be deleted -- there is always at
least one owner.
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}/scroll": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/json": | {
                        "@version": "2017-09-01";
                        advanced?: boolean;
                        bypass_visible_to: boolean;
                        filter_principal_sets?: string[];
                        filters?: (
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | {
                                bottom_right: ...;
                                field_name: ...;
                                post_filter: ...;
                                top_left: ...;
                                type: ...;
                            }
                            | {
                                field_name: ...;
                                post_filter: ...;
                                relation: ...;
                                shape: ...;
                                type: ...;
                            }
                            | { field_name: ...; post_filter: ...; type: ... }
                            | { field_name: ...; post_filter: ...; type: ...; value: ... }
                            | { filter: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                        )[];
                        limit: number;
                        marker?: unknown;
                        q?: string;
                    }
                    | {
                        "@version": "scroll#1.0.0";
                        advanced?: boolean;
                        bypass_visible_to: boolean;
                        filter_principal_sets?: string[];
                        filters?: (
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                            | { field_name: ...; relation: ...; shape: ...; type: ... }
                            | { field_name: ...; type: ... }
                            | { field_name: ...; type: ...; value: ... }
                            | { filter: ...; type: ... }
                            | { filters: ...; type: ... }
                            | { filters: ...; type: ... }
                        )[];
                        limit: number;
                        marker?: unknown;
                        q?: string;
                        q_settings?:
                            | { default_operator: string; mode: "query_string" }
                            | { default_operator: string; mode: "advanced_query_string" };
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            count?: number;
                            gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                            has_next_page?: boolean;
                            marker?: unknown;
                            total?: number;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/json": | {
                      "@version": "2017-09-01";
                      advanced?: boolean;
                      bypass_visible_to: boolean;
                      filter_principal_sets?: string[];
                      filters?: (
                          | { field_name: ...; post_filter: ...; type: ...; values: ... }
                          | { field_name: ...; post_filter: ...; type: ...; values: ... }
                          | { field_name: ...; post_filter: ...; type: ...; values: ... }
                          | {
                              bottom_right: ...;
                              field_name: ...;
                              post_filter: ...;
                              top_left: ...;
                              type: ...;
                          }
                          | {
                              field_name: ...;
                              post_filter: ...;
                              relation: ...;
                              shape: ...;
                              type: ...;
                          }
                          | { field_name: ...; post_filter: ...; type: ... }
                          | { field_name: ...; post_filter: ...; type: ...; value: ... }
                          | { filter: ...; post_filter: ...; type: ... }
                          | { filters: ...; post_filter: ...; type: ... }
                          | { filters: ...; post_filter: ...; type: ... }
                      )[];
                      limit: number;
                      marker?: unknown;
                      q?: string;
                  }
                  | {
                      "@version": "scroll#1.0.0";
                      advanced?: boolean;
                      bypass_visible_to: boolean;
                      filter_principal_sets?: string[];
                      filters?: (
                          | { field_name: ...; type: ...; values: ... }
                          | { field_name: ...; type: ...; values: ... }
                          | { field_name: ...; type: ...; values: ... }
                          | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                          | { field_name: ...; relation: ...; shape: ...; type: ... }
                          | { field_name: ...; type: ... }
                          | { field_name: ...; type: ...; value: ... }
                          | { filter: ...; type: ... }
                          | { filters: ...; type: ... }
                          | { filters: ...; type: ... }
                      )[];
                      limit: number;
                      marker?: unknown;
                      q?: string;
                      q_settings?:
                          | { default_operator: string; mode: "query_string" }
                          | { default_operator: string; mode: "advanced_query_string" };
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          count?: number;
                          gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                          has_next_page?: boolean;
                          marker?: unknown;
                          total?: number;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Scroll Query

      Scrolling is similar to a complex post query, but is intended for collecting all results matching a search.

      Scroll queries use marker+has_next_page for pagination and have no pagination limit.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: {
            content: {
                "application/json":
                    | {
                        "@version": "2017-09-01";
                        advanced?: boolean;
                        bypass_visible_to: boolean;
                        filter_principal_sets?: string[];
                        filters?: (
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | {
                                bottom_right: ...;
                                field_name: ...;
                                post_filter: ...;
                                top_left: ...;
                                type: ...;
                            }
                            | {
                                field_name: ...;
                                post_filter: ...;
                                relation: ...;
                                shape: ...;
                                type: ...;
                            }
                            | { field_name: ...; post_filter: ...; type: ... }
                            | { field_name: ...; post_filter: ...; type: ...; value: ... }
                            | { filter: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                        )[];
                        limit: number;
                        marker?: unknown;
                        q?: string;
                    }
                    | {
                        "@version": "scroll#1.0.0";
                        advanced?: boolean;
                        bypass_visible_to: boolean;
                        filter_principal_sets?: string[];
                        filters?: (
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                            | { field_name: ...; relation: ...; shape: ...; type: ... }
                            | { field_name: ...; type: ... }
                            | { field_name: ...; type: ...; value: ... }
                            | { filter: ...; type: ... }
                            | { filters: ...; type: ... }
                            | { filters: ...; type: ... }
                        )[];
                        limit: number;
                        marker?: unknown;
                        q?: string;
                        q_settings?:
                            | { default_operator: string; mode: "query_string" }
                            | { default_operator: string; mode: "advanced_query_string" };
                    };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        count?: number;
                        gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                        has_next_page?: boolean;
                        marker?: unknown;
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      count?: number;
                      gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                      has_next_page?: boolean;
                      marker?: unknown;
                      total?: number;
                  };
              };
              headers: { [name: string]: unknown };
          }

          A Scroll Result document.

          This is nearly identical to a Search Result, but includes the `marker` parameter.
`marker` is an opaque token which can be used on subsequent requests for pagination.

NOTE: In rare cases, `has_next_page` may be True until an empty page of results is
reached.
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}/search": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query: {
                    advanced?: boolean;
                    bypass_visible_to?: boolean;
                    filter_principal_sets?: string[];
                    limit?: number;
                    offset?: number;
                    q: string;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            count?: number;
                            facet_results?: (
                                | { approximate_value?: (...)
                                | (...); name?: (...) | (...) }
                                | { name?: (...) | (...); value?: (...) | (...) }
                                | { buckets?: (...) | (...); name?: (...) | (...) }
                            )[];
                            gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                            has_next_page?: boolean;
                            offset?: number;
                            total?: number;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/json": | {
                        "@version": "2017-09-01"
                        | "2016-11-09";
                        advanced?: boolean;
                        boosts?: { factor: number; field_name: string }[];
                        bypass_visible_to: boolean;
                        facets?: (
                            | { field_name: ...; name?: ...; size: ...; type: ... }
                            | { field_name: ...; missing?: ...; name?: ...; type: ... }
                            | {
                                date_interval: ...;
                                field_name: ...;
                                histogram_range?: ...;
                                name?: ...;
                                type: ...;
                            }
                            | {
                                field_name: ...;
                                histogram_range: ...;
                                name?: ...;
                                size: ...;
                                type: ...;
                            }
                        )[];
                        filter_principal_sets?: string[];
                        filters?: (
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | {
                                bottom_right: ...;
                                field_name: ...;
                                post_filter: ...;
                                top_left: ...;
                                type: ...;
                            }
                            | {
                                field_name: ...;
                                post_filter: ...;
                                relation: ...;
                                shape: ...;
                                type: ...;
                            }
                            | { field_name: ...; post_filter: ...; type: ... }
                            | { field_name: ...; post_filter: ...; type: ...; value: ... }
                            | { filter: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                        )[];
                        limit: number;
                        offset?: number;
                        q?: string;
                        sort?: { field_name: string; order: (...) | (...) }[];
                    }
                    | {
                        "@version": "query#1.0.0";
                        advanced?: boolean;
                        boosts?: { factor: number; field_name: string }[];
                        bypass_visible_to: boolean;
                        facets?: (
                            | {
                                additional_filters?: ...;
                                field_name: ...;
                                name?: ...;
                                size: ...;
                                type: ...;
                            }
                            | {
                                additional_filters?: ...;
                                field_name: ...;
                                missing?: ...;
                                name?: ...;
                                type: ...;
                            }
                            | { additional_filters?: ...; field_name: ...; name?: ...; type: ... }
                            | {
                                additional_filters?: ...;
                                date_interval: ...;
                                field_name: ...;
                                histogram_range?: ...;
                                name?: ...;
                                type: ...;
                            }
                            | {
                                additional_filters?: ...;
                                field_name: ...;
                                histogram_range: ...;
                                name?: ...;
                                size: ...;
                                type: ...;
                            }
                        )[];
                        filter_principal_sets?: string[];
                        filters?: (
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                            | { field_name: ...; relation: ...; shape: ...; type: ... }
                            | { field_name: ...; type: ... }
                            | { field_name: ...; type: ...; value: ... }
                            | { filter: ...; type: ... }
                            | { filters: ...; type: ... }
                            | { filters: ...; type: ... }
                        )[];
                        limit: number;
                        offset?: number;
                        post_facet_filters?: (
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                            | { field_name: ...; relation: ...; shape: ...; type: ... }
                            | { field_name: ...; type: ... }
                            | { field_name: ...; type: ...; value: ... }
                            | { filter: ...; type: ... }
                            | { filters: ...; type: ... }
                            | { filters: ...; type: ... }
                        )[];
                        q?: string;
                        q_settings?:
                            | { default_operator: string; mode: "query_string" }
                            | { default_operator: string; mode: "advanced_query_string" };
                        sort?: { field_name: string; order: (...) | (...) }[];
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            count?: number;
                            facet_results?: (
                                | { approximate_value?: (...)
                                | (...); name?: (...) | (...) }
                                | { name?: (...) | (...); value?: (...) | (...) }
                                | { buckets?: (...) | (...); name?: (...) | (...) }
                            )[];
                            gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                            has_next_page?: boolean;
                            offset?: number;
                            total?: number;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query: {
                  advanced?: boolean;
                  bypass_visible_to?: boolean;
                  filter_principal_sets?: string[];
                  limit?: number;
                  offset?: number;
                  q: string;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          count?: number;
                          facet_results?: (
                              | { approximate_value?: (...)
                              | (...); name?: (...) | (...) }
                              | { name?: (...) | (...); value?: (...) | (...) }
                              | { buckets?: (...) | (...); name?: (...) | (...) }
                          )[];
                          gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                          has_next_page?: boolean;
                          offset?: number;
                          total?: number;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Search Query

      Takes a GET request and parses the query from (url-encoded) query parameters. Returns query results.

      The results can be paginated with limit+offset up to the boundary of 10,000 results.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query: {
                advanced?: boolean;
                bypass_visible_to?: boolean;
                filter_principal_sets?: string[];
                limit?: number;
                offset?: number;
                q: string;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { index_id: string }
        • query: {
              advanced?: boolean;
              bypass_visible_to?: boolean;
              filter_principal_sets?: string[];
              limit?: number;
              offset?: number;
              q: string;
          }
          • Optionaladvanced?: boolean
          • Optionalbypass_visible_to?: boolean

            Set to true to allow this operation to return data with visibility which does not include the current user. Only allowed for index admins and owners.

          • Optionalfilter_principal_sets?: string[]
          • Optionallimit?: number
          • Optionaloffset?: number
          • q: string
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        count?: number;
                        facet_results?: (
                            | { approximate_value?: (...)
                            | (...); name?: (...) | (...) }
                            | { name?: (...) | (...); value?: (...) | (...) }
                            | { buckets?: (...) | (...); name?: (...) | (...) }
                        )[];
                        gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                        has_next_page?: boolean;
                        offset?: number;
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      count?: number;
                      facet_results?: (
                          | { approximate_value?: (...)
                          | (...); name?: (...) | (...) }
                          | { name?: (...) | (...); value?: (...) | (...) }
                          | { buckets?: (...) | (...); name?: (...) | (...) }
                      )[];
                      gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                      has_next_page?: boolean;
                      offset?: number;
                      total?: number;
                  };
              };
              headers: { [name: string]: unknown };
          }

          A Search Result document.

          The offset, count, total, and has_next_page fields are computed based on the
number of results which were matched and which results were returned by the
search.
As long as `has_next_page` is True, you can add the count of results to the offset
of a prior query to fetch another page of results.
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/json": | {
                      "@version": "2017-09-01"
                      | "2016-11-09";
                      advanced?: boolean;
                      boosts?: { factor: number; field_name: string }[];
                      bypass_visible_to: boolean;
                      facets?: (
                          | { field_name: ...; name?: ...; size: ...; type: ... }
                          | { field_name: ...; missing?: ...; name?: ...; type: ... }
                          | {
                              date_interval: ...;
                              field_name: ...;
                              histogram_range?: ...;
                              name?: ...;
                              type: ...;
                          }
                          | {
                              field_name: ...;
                              histogram_range: ...;
                              name?: ...;
                              size: ...;
                              type: ...;
                          }
                      )[];
                      filter_principal_sets?: string[];
                      filters?: (
                          | { field_name: ...; post_filter: ...; type: ...; values: ... }
                          | { field_name: ...; post_filter: ...; type: ...; values: ... }
                          | { field_name: ...; post_filter: ...; type: ...; values: ... }
                          | {
                              bottom_right: ...;
                              field_name: ...;
                              post_filter: ...;
                              top_left: ...;
                              type: ...;
                          }
                          | {
                              field_name: ...;
                              post_filter: ...;
                              relation: ...;
                              shape: ...;
                              type: ...;
                          }
                          | { field_name: ...; post_filter: ...; type: ... }
                          | { field_name: ...; post_filter: ...; type: ...; value: ... }
                          | { filter: ...; post_filter: ...; type: ... }
                          | { filters: ...; post_filter: ...; type: ... }
                          | { filters: ...; post_filter: ...; type: ... }
                      )[];
                      limit: number;
                      offset?: number;
                      q?: string;
                      sort?: { field_name: string; order: (...) | (...) }[];
                  }
                  | {
                      "@version": "query#1.0.0";
                      advanced?: boolean;
                      boosts?: { factor: number; field_name: string }[];
                      bypass_visible_to: boolean;
                      facets?: (
                          | {
                              additional_filters?: ...;
                              field_name: ...;
                              name?: ...;
                              size: ...;
                              type: ...;
                          }
                          | {
                              additional_filters?: ...;
                              field_name: ...;
                              missing?: ...;
                              name?: ...;
                              type: ...;
                          }
                          | { additional_filters?: ...; field_name: ...; name?: ...; type: ... }
                          | {
                              additional_filters?: ...;
                              date_interval: ...;
                              field_name: ...;
                              histogram_range?: ...;
                              name?: ...;
                              type: ...;
                          }
                          | {
                              additional_filters?: ...;
                              field_name: ...;
                              histogram_range: ...;
                              name?: ...;
                              size: ...;
                              type: ...;
                          }
                      )[];
                      filter_principal_sets?: string[];
                      filters?: (
                          | { field_name: ...; type: ...; values: ... }
                          | { field_name: ...; type: ...; values: ... }
                          | { field_name: ...; type: ...; values: ... }
                          | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                          | { field_name: ...; relation: ...; shape: ...; type: ... }
                          | { field_name: ...; type: ... }
                          | { field_name: ...; type: ...; value: ... }
                          | { filter: ...; type: ... }
                          | { filters: ...; type: ... }
                          | { filters: ...; type: ... }
                      )[];
                      limit: number;
                      offset?: number;
                      post_facet_filters?: (
                          | { field_name: ...; type: ...; values: ... }
                          | { field_name: ...; type: ...; values: ... }
                          | { field_name: ...; type: ...; values: ... }
                          | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                          | { field_name: ...; relation: ...; shape: ...; type: ... }
                          | { field_name: ...; type: ... }
                          | { field_name: ...; type: ...; value: ... }
                          | { filter: ...; type: ... }
                          | { filters: ...; type: ... }
                          | { filters: ...; type: ... }
                      )[];
                      q?: string;
                      q_settings?:
                          | { default_operator: string; mode: "query_string" }
                          | { default_operator: string; mode: "advanced_query_string" };
                      sort?: { field_name: string; order: (...) | (...) }[];
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          count?: number;
                          facet_results?: (
                              | { approximate_value?: (...)
                              | (...); name?: (...) | (...) }
                              | { name?: (...) | (...); value?: (...) | (...) }
                              | { buckets?: (...) | (...); name?: (...) | (...) }
                          )[];
                          gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                          has_next_page?: boolean;
                          offset?: number;
                          total?: number;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Complex Search Query

      Takes a POST request and parses the query from the request body. The search may include advanced filtering criteria, facets (aggregations), field weights (boosts), and sorting criteria.

      The results can be paginated with limit+offset up to the boundary of 10,000 results.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: {
            content: {
                "application/json":
                    | {
                        "@version": "2017-09-01"
                        | "2016-11-09";
                        advanced?: boolean;
                        boosts?: { factor: number; field_name: string }[];
                        bypass_visible_to: boolean;
                        facets?: (
                            | { field_name: ...; name?: ...; size: ...; type: ... }
                            | { field_name: ...; missing?: ...; name?: ...; type: ... }
                            | {
                                date_interval: ...;
                                field_name: ...;
                                histogram_range?: ...;
                                name?: ...;
                                type: ...;
                            }
                            | {
                                field_name: ...;
                                histogram_range: ...;
                                name?: ...;
                                size: ...;
                                type: ...;
                            }
                        )[];
                        filter_principal_sets?: string[];
                        filters?: (
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | { field_name: ...; post_filter: ...; type: ...; values: ... }
                            | {
                                bottom_right: ...;
                                field_name: ...;
                                post_filter: ...;
                                top_left: ...;
                                type: ...;
                            }
                            | {
                                field_name: ...;
                                post_filter: ...;
                                relation: ...;
                                shape: ...;
                                type: ...;
                            }
                            | { field_name: ...; post_filter: ...; type: ... }
                            | { field_name: ...; post_filter: ...; type: ...; value: ... }
                            | { filter: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                            | { filters: ...; post_filter: ...; type: ... }
                        )[];
                        limit: number;
                        offset?: number;
                        q?: string;
                        sort?: { field_name: string; order: (...) | (...) }[];
                    }
                    | {
                        "@version": "query#1.0.0";
                        advanced?: boolean;
                        boosts?: { factor: number; field_name: string }[];
                        bypass_visible_to: boolean;
                        facets?: (
                            | {
                                additional_filters?: ...;
                                field_name: ...;
                                name?: ...;
                                size: ...;
                                type: ...;
                            }
                            | {
                                additional_filters?: ...;
                                field_name: ...;
                                missing?: ...;
                                name?: ...;
                                type: ...;
                            }
                            | { additional_filters?: ...; field_name: ...; name?: ...; type: ... }
                            | {
                                additional_filters?: ...;
                                date_interval: ...;
                                field_name: ...;
                                histogram_range?: ...;
                                name?: ...;
                                type: ...;
                            }
                            | {
                                additional_filters?: ...;
                                field_name: ...;
                                histogram_range: ...;
                                name?: ...;
                                size: ...;
                                type: ...;
                            }
                        )[];
                        filter_principal_sets?: string[];
                        filters?: (
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                            | { field_name: ...; relation: ...; shape: ...; type: ... }
                            | { field_name: ...; type: ... }
                            | { field_name: ...; type: ...; value: ... }
                            | { filter: ...; type: ... }
                            | { filters: ...; type: ... }
                            | { filters: ...; type: ... }
                        )[];
                        limit: number;
                        offset?: number;
                        post_facet_filters?: (
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { field_name: ...; type: ...; values: ... }
                            | { bottom_right: ...; field_name: ...; top_left: ...; type: ... }
                            | { field_name: ...; relation: ...; shape: ...; type: ... }
                            | { field_name: ...; type: ... }
                            | { field_name: ...; type: ...; value: ... }
                            | { filter: ...; type: ... }
                            | { filters: ...; type: ... }
                            | { filters: ...; type: ... }
                        )[];
                        q?: string;
                        q_settings?:
                            | { default_operator: string; mode: "query_string" }
                            | { default_operator: string; mode: "advanced_query_string" };
                        sort?: { field_name: string; order: (...) | (...) }[];
                    };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        count?: number;
                        facet_results?: (
                            | { approximate_value?: (...)
                            | (...); name?: (...) | (...) }
                            | { name?: (...) | (...); value?: (...) | (...) }
                            | { buckets?: (...) | (...); name?: (...) | (...) }
                        )[];
                        gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                        has_next_page?: boolean;
                        offset?: number;
                        total?: number;
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      count?: number;
                      facet_results?: (
                          | { approximate_value?: (...)
                          | (...); name?: (...) | (...) }
                          | { name?: (...) | (...); value?: (...) | (...) }
                          | { buckets?: (...) | (...); name?: (...) | (...) }
                      )[];
                      gmeta?: { "@version": unknown; entries?: (...)[]; subject?: string }[];
                      has_next_page?: boolean;
                      offset?: number;
                      total?: number;
                  };
              };
              headers: { [name: string]: unknown };
          }

          A Search Result document.

          The offset, count, total, and has_next_page fields are computed based on the
number of results which were matched and which results were returned by the
search.
As long as `has_next_page` is True, you can add the count of results to the offset
of a prior query to fetch another page of results.
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/index/{index_id}/subject": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query: { subject: string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": { acknowledged?: boolean; task_id?: string };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query: { bypass_visible_to?: boolean; subject: string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            "@version": unknown;
                            entries?: {
                                content?: { [key: ...]: ... };
                                entry_id?: string;
                                matched_principal_sets?: (...)[];
                            }[];
                            subject?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • delete: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query: { subject: string };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": { acknowledged?: boolean; task_id?: string };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Delete Subject

      Delete the document with the given Subject.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { index_id: string };
            query: { subject: string };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { index_id: string }
        • query: { subject: string }
          • subject: string

            The subject for this operation

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": { acknowledged?: boolean; task_id?: string };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { acknowledged?: boolean; task_id?: string };
              };
              headers: { [name: string]: unknown };
          }

          A Task Submission response

    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query: { bypass_visible_to?: boolean; subject: string };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          "@version": unknown;
                          entries?: {
                              content?: { [key: ...]: ... };
                              entry_id?: string;
                              matched_principal_sets?: (...)[];
                          }[];
                          subject?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Subject

      Lookup the document for a given Subject.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/task_list/{index_id}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { index_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            index_id?: string;
                            tasks?: {
                                additional_details?: unknown;
                                completion_date?: null
                                | string;
                                creation_date?: string;
                                index_id?: string;
                                message?: string;
                                state?: "FAILED" | "PENDING" | "PROGRESS" | "SUCCESS" | "CREATING";
                                state_description?: string;
                                task_id?: string;
                                task_type?: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { index_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          index_id?: string;
                          tasks?: {
                              additional_details?: unknown;
                              completion_date?: null
                              | string;
                              creation_date?: string;
                              index_id?: string;
                              message?: string;
                              state?: "FAILED" | "PENDING" | "PROGRESS" | "SUCCESS" | "CREATING";
                              state_description?: string;
                              task_id?: string;
                              task_type?: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Task List

      List up to 1000 of the most recent tasks for an index.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/v1/task/{task_id}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { task_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            additional_details?: unknown;
                            completion_date?: null
                            | string;
                            creation_date?: string;
                            index_id?: string;
                            message?: string;
                            state?: "FAILED" | "PENDING" | "PROGRESS" | "SUCCESS" | "CREATING";
                            state_description?: string;
                            task_id?: string;
                            task_type?: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { task_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          additional_details?: unknown;
                          completion_date?: null
                          | string;
                          creation_date?: string;
                          index_id?: string;
                          message?: string;
                          state?: "FAILED" | "PENDING" | "PROGRESS" | "SUCCESS" | "CREATING";
                          state_description?: string;
                          task_id?: string;
                          task_type?: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Task

      Lookup a Task by ID.

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined

    Settings

    Member Visibility

    On This Page

    Properties