@antfly/sdk 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,1725 @@
+import { Client } from 'openapi-fetch';
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+interface paths {
+    "/query": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Perform a global query
+         * @description Executes a query across all relevant tables and shards based on the query content.
+         */
+        post: operations["globalQuery"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/table": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List all tables */
+        get: operations["listTables"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/table/{tableName}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        /** Get table details */
+        get: operations["getTable"];
+        put?: never;
+        /** Create a new table */
+        post: operations["createTable"];
+        /** Drop a table */
+        delete: operations["dropTable"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/table/{tableName}/query": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table to query */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Query a specific table */
+        post: operations["queryTable"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/table/{tableName}/batch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table for batch operation */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Perform batch inserts and deletes on a table */
+        post: operations["batchTableOperations"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/table/{tableName}/backup": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table to backup */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Backup a table */
+        post: operations["backupTable"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/table/{tableName}/restore": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table to restore into */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Restore a table from backup */
+        post: operations["restoreTable"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/table/{tableName}/key/{key}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+                /** @description Key of the record to lookup */
+                key: string;
+            };
+            cookie?: never;
+        };
+        /** Lookup a key in a table */
+        get: operations["lookupKey"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/table/{tableName}/index": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        /** List all indexes for a table */
+        get: operations["listIndexes"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/table/{tableName}/index/{indexName}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+                /** @description Name of the index */
+                indexName: string;
+            };
+            cookie?: never;
+        };
+        /** Get index details */
+        get: operations["getIndex"];
+        put?: never;
+        /** Add an index to a table */
+        post: operations["createIndex"];
+        /** Drop an index from a table */
+        delete: operations["dropIndex"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/user/{userName}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The username. */
+                userName: components["parameters"]["UserNamePathParameter"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Get user details
+         * @description Retrieves details for a specific user.
+         */
+        get: operations["getUserByName"];
+        put?: never;
+        /**
+         * Create a new user
+         * @description Creates a new user with the given username and password. Username in path takes precedence.
+         */
+        post: operations["createUser"];
+        /**
+         * Delete a user
+         * @description Deletes a specific user.
+         */
+        delete: operations["deleteUser"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/user/{userName}/password": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The username. */
+                userName: components["parameters"]["UserNamePathParameter"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        /**
+         * Update user password
+         * @description Updates the password for a specific user.
+         */
+        put: operations["updateUserPassword"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/user/{userName}/permission": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The username. */
+                userName: components["parameters"]["UserNamePathParameter"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Get user permissions
+         * @description Retrieves all permissions for a specific user.
+         */
+        get: operations["getUserPermissions"];
+        put?: never;
+        /**
+         * Add permission to user
+         * @description Adds a new permission to a specific user.
+         */
+        post: operations["addPermissionToUser"];
+        /**
+         * Remove permission from user
+         * @description Removes a specific permission rule from a user based on resource name and type.
+         */
+        delete: operations["removePermissionFromUser"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+interface components {
+    schemas: {
+        Error: {
+            /** @example An error message */
+            error: string;
+        };
+        ByteRange: string[];
+        ShardConfig: {
+            byte_range: components["schemas"]["ByteRange"];
+        };
+        CreateTableRequest: {
+            /** Format: uint */
+            num_shards?: number;
+            indexes?: {
+                [key: string]: components["schemas"]["CreateIndexRequest"];
+            };
+            schema?: components["schemas"]["TableSchema"];
+        };
+        Table: {
+            name: string;
+            indexes: {
+                [key: string]: components["schemas"]["IndexConfig"];
+            };
+            shards: {
+                [key: string]: components["schemas"]["ShardConfig"];
+            };
+            schema?: components["schemas"]["TableSchema"];
+        };
+        ValueSchema: {
+            type: components["schemas"]["ValueType"];
+            /** @description For object types, this schema defines the structure of the content.
+             *     For other types, this field is ignored.
+             *      */
+            schema?: components["schemas"]["DocumentSchema"];
+        };
+        DocumentSchema: {
+            /** @description A map of field names to their value schema (type, defaults, configuration etc.).
+             *     This allows for flexible content types per field.
+             *     The key is the field name, and the value is the value type schema.
+             *      */
+            fields?: {
+                [key: string]: components["schemas"]["ValueSchema"];
+            };
+        };
+        TableSchema: {
+            key?: string;
+            /** @description Default type to use from the document_types.
+             *      */
+            default_type?: string;
+            document_types?: {
+                [key: string]: components["schemas"]["DocumentSchema"];
+            };
+        };
+        DateRange: {
+            name: string;
+            from?: string;
+            to?: string;
+        };
+        NumericRange: {
+            name: string;
+            /** Format: float */
+            from?: number;
+            /** Format: float */
+            to?: number;
+        };
+        TermFacetResult: {
+            term: string;
+            count: number;
+        };
+        DateRangeResult: unknown;
+        NumericRangeResult: unknown;
+        FacetOption: {
+            field?: string;
+            size?: number;
+            date_ranges?: components["schemas"]["DateRange"][];
+            numeric_ranges?: components["schemas"]["NumericRange"][];
+        };
+        FacetResult: {
+            field?: string;
+            total?: number;
+            missing?: number;
+            terms?: components["schemas"]["TermFacetResult"][];
+            date_ranges?: components["schemas"]["DateRangeResult"][];
+            numeric_ranges?: components["schemas"]["NumericRangeResult"][];
+        };
+        /**
+         * @description Field type (e.g., string, int, float)
+         * @enum {string}
+         */
+        ValueType: "float" | "uint" | "int" | "bool" | "time" | "geopoint" | "geoshape" | "string" | "keyword" | "array" | "object" | "embedding" | "link" | "blob";
+        IndexConfig: {
+            name: string;
+            type: string;
+            config: {
+                [key: string]: unknown;
+            };
+        };
+        IndexStatus: unknown;
+        StorageStatus: {
+            /**
+             * Format: uint64
+             * @description Disk usage in bytes.
+             */
+            disk_usage?: number;
+            /** @description Whether the table has received data. */
+            empty?: boolean;
+        };
+        TableStatus: unknown;
+        EmbedderConfig: {
+            provider: string;
+            model: string;
+            model_provider?: string;
+            /** Format: uri */
+            url?: string;
+        };
+        SummarizerConfig: {
+            provider: string;
+            model: string;
+            model_provider?: string;
+            /** Format: uri */
+            url?: string;
+        };
+        CreateIndexRequest: {
+            field?: string;
+            template?: string;
+            mem_only?: boolean;
+            dimension: number;
+            summarizer_config?: components["schemas"]["SummarizerConfig"];
+            embedder_config: components["schemas"]["EmbedderConfig"];
+        };
+        /** @example {
+         *       "inserts": {
+         *         "user:123": {
+         *           "name": "John Doe",
+         *           "email": "john@example.com",
+         *           "age": 30,
+         *           "tags": [
+         *             "customer",
+         *             "premium"
+         *           ]
+         *         },
+         *         "user:456": {
+         *           "name": "Jane Smith",
+         *           "email": "jane@example.com",
+         *           "age": 25,
+         *           "tags": [
+         *             "customer"
+         *           ]
+         *         }
+         *       },
+         *       "deletes": [
+         *         "user:789",
+         *         "user:old_account"
+         *       ]
+         *     } */
+        BatchRequest: {
+            inserts?: {
+                [key: string]: Record<string, never>;
+            };
+            /** @description List of keys to delete. */
+            deletes?: string[];
+        };
+        BackupRequest: {
+            backup_id: string;
+            /** @description Location for the backup (e.g., file:///path/to/backup, s3://bucket/path) */
+            location: string;
+        };
+        RestoreRequest: components["schemas"]["BackupRequest"];
+        QueryRequest: {
+            table?: string;
+            /** @description Full JSON Bleve search queries */
+            full_text_search?: {
+                [key: string]: unknown;
+            };
+            semantic_search?: string;
+            indexes?: string[];
+            /** Format: byte */
+            filter_prefix?: string;
+            /** @description Full JSON Bleve search queries */
+            filter_query?: {
+                [key: string]: unknown;
+            };
+            /** @description Full JSON Bleve search queries */
+            exclusion_query?: {
+                [key: string]: unknown;
+            };
+            facets?: {
+                [key: string]: components["schemas"]["FacetOption"];
+            };
+            embeddings?: {
+                [key: string]: number[];
+            };
+            fields?: string[];
+            /** @description Maximum number of results to return or topk for semantic_search. */
+            limit?: number;
+            /** @description Number of results to skip for pagination, only available for full_text_search queries. */
+            offset?: number;
+            order_by?: {
+                [key: string]: boolean;
+            };
+            /**
+             * Format: float
+             * @description Maximum distance for semantic similarity search.
+             */
+            distance_under?: number;
+            /**
+             * Format: float
+             * @description Minimum distance for semantic similarity search.
+             */
+            distance_over?: number;
+            count?: boolean;
+            reranker?: components["schemas"]["Reranker"];
+        };
+        Reranker: {
+            field?: string;
+            template?: string;
+            model: string;
+            provider: string;
+            model_provider?: string;
+            /** Format: uri */
+            url?: string;
+        };
+        QueryHit: {
+            /** @description ID of the record. */
+            _id?: string;
+            /**
+             * Format: float
+             * @description Relevance score of the hit.
+             */
+            _score?: number;
+            /** @description Scores partitioned by index when using RRF search. */
+            _index_scores?: {
+                [key: string]: unknown;
+            };
+            _source?: {
+                [key: string]: unknown;
+            };
+        };
+        /** @description A list of query hits. */
+        QueryHits: {
+            /**
+             * Format: uint64
+             * @description Total number of hits available.
+             */
+            total?: number;
+            hits?: components["schemas"]["QueryHit"][];
+            /**
+             * Format: float
+             * @description Maximum score of the results.
+             */
+            max_score?: number;
+        };
+        /** @description Responses from multiple query operations. */
+        QueryResponses: {
+            responses?: components["schemas"]["QueryResult"][];
+        };
+        /** @description Result of a query operation as an array of results and a count. */
+        QueryResult: {
+            hits?: components["schemas"]["QueryHits"];
+            facets?: {
+                [key: string]: components["schemas"]["FacetResult"];
+            };
+            /**
+             * Format: int64
+             * @description Duration of the query in milliseconds.
+             */
+            took: number;
+            /**
+             * Format: int32
+             * @description HTTP status code of the query operation.
+             */
+            status: number;
+            /** @description Error message if the query failed. */
+            error?: string;
+        };
+        User: {
+            /** @example johndoe */
+            username: string;
+            /**
+             * Format: byte
+             * @description Base64 encoded password hash. Exposing this is a security risk.
+             * @example JGFyZ29uMm...
+             */
+            password_hash: string;
+        };
+        /**
+         * @description Type of the resource, e.g., table, user, or global ('*').
+         * @example table
+         * @enum {string}
+         */
+        ResourceType: "table" | "user" | "*";
+        /**
+         * @description Type of permission.
+         * @example read
+         * @enum {string}
+         */
+        PermissionType: "read" | "write" | "admin";
+        Permission: {
+            /**
+             * @description Resource name (e.g., table name, target username, or '*' for global).
+             * @example orders_table
+             */
+            resource: string;
+            resource_type: components["schemas"]["ResourceType"];
+            type: components["schemas"]["PermissionType"];
+        };
+        CreateUserRequest: {
+            /**
+             * @description Username for the new user. If provided in the path, this field can be omitted or must match the path parameter.
+             * @example johndoe
+             */
+            username?: string;
+            /**
+             * Format: password
+             * @example s3cr3tP@sswOrd
+             */
+            password: string;
+            /** @description Optional list of initial permissions for the user. */
+            initial_policies?: components["schemas"]["Permission"][] | null;
+        };
+        UpdatePasswordRequest: {
+            /**
+             * Format: password
+             * @example newS3cr3tP@sswOrd
+             */
+            new_password: string;
+        };
+        SuccessMessage: {
+            /** @example Operation completed successfully */
+            message?: string;
+        };
+    };
+    responses: {
+        /** @description Bad request */
+        BadRequest: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description Resource not found */
+        NotFound: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description Internal server error */
+        InternalServerError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description Unauthorized */
+        Unauthorized: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description Forbidden */
+        Forbidden: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+    };
+    parameters: {
+        /** @description The username. */
+        UserNamePathParameter: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+interface operations {
+    globalQuery: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["QueryRequest"];
+                /** @description IMPORTANT: The final line of data must end with a newline character \n.
+                 *     Each newline character may be preceded by a carriage return \r.
+                 *     When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson.
+                 *      */
+                "application/x-ndjson": components["schemas"]["QueryRequest"];
+            };
+        };
+        responses: {
+            /** @description Query successful */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["QueryResponses"];
+                };
+            };
+            /** @description Invalid query request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Internal server error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    listTables: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description A list of tables */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Table"][];
+                };
+            };
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    getTable: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Table details */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TableStatus"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+        };
+    };
+    createTable: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateTableRequest"];
+            };
+        };
+        responses: {
+            /** @description Table created successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Table"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+        };
+    };
+    dropTable: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Table dropped successfully */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: components["responses"]["BadRequest"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    queryTable: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table to query */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["QueryRequest"];
+            };
+        };
+        responses: {
+            /** @description Query successful */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["QueryResult"];
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    batchTableOperations: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table for batch operation */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["BatchRequest"];
+            };
+        };
+        responses: {
+            /** @description Batch operation successful */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example successful */
+                        batch?: string;
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    backupTable: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table to backup */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["BackupRequest"];
+            };
+        };
+        responses: {
+            /** @description Backup process initiated successfully */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example successful */
+                        backup?: string;
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    restoreTable: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table to restore into */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RestoreRequest"];
+            };
+        };
+        responses: {
+            /** @description Restore process triggered successfully */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @example triggered */
+                        restore?: string;
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    lookupKey: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+                /** @description Key of the record to lookup */
+                key: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Record found */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            400: components["responses"]["BadRequest"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    listIndexes: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description A list of indexes for the table */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["IndexStatus"][];
+                };
+            };
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    getIndex: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+                /** @description Name of the index */
+                indexName: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Index details */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["IndexStatus"];
+                };
+            };
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    createIndex: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+                /** @description Name of the index */
+                indexName: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateIndexRequest"];
+            };
+        };
+        responses: {
+            /** @description Index added successfully */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            400: components["responses"]["BadRequest"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    dropIndex: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Name of the table */
+                tableName: string;
+                /** @description Name of the index */
+                indexName: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Index dropped successfully */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    getUserByName: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The username. */
+                userName: components["parameters"]["UserNamePathParameter"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful operation */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["User"];
+                };
+            };
+            /** @description Bad Request (e.g., username is required) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description User not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    createUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The username. */
+                userName: components["parameters"]["UserNamePathParameter"];
+            };
+            cookie?: never;
+        };
+        /** @description User creation details */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateUserRequest"];
+            };
+        };
+        responses: {
+            /** @description User created successfully */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["User"];
+                };
+            };
+            /** @description Bad Request (e.g., invalid input, username/password mismatch) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Conflict (e.g., user already exists) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    deleteUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The username. */
+                userName: components["parameters"]["UserNamePathParameter"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description User deleted successfully */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Bad Request (e.g., username is required) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description User not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    updateUserPassword: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The username. */
+                userName: components["parameters"]["UserNamePathParameter"];
+            };
+            cookie?: never;
+        };
+        /** @description New password details */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdatePasswordRequest"];
+            };
+        };
+        responses: {
+            /** @description Password updated successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SuccessMessage"];
+                };
+            };
+            /** @description Bad Request (e.g., new password empty, username required) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description User not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    getUserPermissions: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The username. */
+                userName: components["parameters"]["UserNamePathParameter"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful operation */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Permission"][];
+                };
+            };
+            /** @description Bad Request (e.g., username is required) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description User not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    addPermissionToUser: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The username. */
+                userName: components["parameters"]["UserNamePathParameter"];
+            };
+            cookie?: never;
+        };
+        /** @description Permission details to add */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["Permission"];
+            };
+        };
+        responses: {
+            /** @description Permission added successfully */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SuccessMessage"];
+                };
+            };
+            /** @description Bad Request (e.g., invalid input, username required) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description User not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    removePermissionFromUser: {
+        parameters: {
+            query: {
+                /** @description The name of the resource for the permission to be removed. */
+                resource: string;
+                /** @description The type of the resource for the permission to be removed. */
+                resourceType: components["schemas"]["ResourceType"];
+            };
+            header?: never;
+            path: {
+                /** @description The username. */
+                userName: components["parameters"]["UserNamePathParameter"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Permission removed successfully */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Bad Request (e.g., missing query parameters, invalid resourceType, username required) */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description User not found or Role not found for the given resource */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+}
+
+/**
+ * Type exports and utilities for the Antfly SDK
+ * Re-exports commonly used types from the generated OpenAPI types
+ */
+
+type QueryRequest = components["schemas"]["QueryRequest"];
+type QueryResult = components["schemas"]["QueryResult"];
+type QueryHit = components["schemas"]["QueryHit"];
+interface BatchRequest {
+    inserts?: Record<string, unknown>;
+    deletes?: string[];
+}
+type Table = components["schemas"]["Table"];
+type CreateTableRequest = components["schemas"]["CreateTableRequest"];
+type TableSchema = components["schemas"]["TableSchema"];
+type TableStatus = components["schemas"]["TableStatus"];
+type IndexConfig = components["schemas"]["IndexConfig"];
+type IndexStatus = components["schemas"]["IndexStatus"];
+type CreateIndexRequest = components["schemas"]["CreateIndexRequest"];
+type User = components["schemas"]["User"];
+type CreateUserRequest = components["schemas"]["CreateUserRequest"];
+type UpdatePasswordRequest = components["schemas"]["UpdatePasswordRequest"];
+type Permission = components["schemas"]["Permission"];
+type ResourceType = components["schemas"]["ResourceType"];
+type PermissionType = components["schemas"]["PermissionType"];
+type BackupRequest = components["schemas"]["BackupRequest"];
+type RestoreRequest = components["schemas"]["RestoreRequest"];
+type ValueType = components["schemas"]["ValueType"];
+type ValueSchema = components["schemas"]["ValueSchema"];
+type DocumentSchema = components["schemas"]["DocumentSchema"];
+type FacetOption = components["schemas"]["FacetOption"];
+type FacetResult = components["schemas"]["FacetResult"];
+type Reranker = components["schemas"]["Reranker"];
+type AntflyError = components["schemas"]["Error"];
+type ResponseData<T extends keyof operations> = operations[T]["responses"] extends {
+    200: infer R;
+} ? R extends {
+    content: {
+        "application/json": infer D;
+    };
+} ? D : never : never;
+interface AntflyConfig {
+    baseUrl: string;
+    headers?: Record<string, string>;
+    auth?: {
+        username: string;
+        password: string;
+    };
+}
+interface QueryOptions {
+    table?: string;
+    fullTextSearch?: Record<string, unknown>;
+    semanticSearch?: string;
+    limit?: number;
+    offset?: number;
+    fields?: string[];
+    orderBy?: Record<string, boolean>;
+    facets?: Record<string, FacetOption>;
+}
+
+declare class AntflyClient {
+    private client;
+    private config;
+    constructor(config: AntflyConfig);
+    /**
+     * Update authentication credentials
+     */
+    setAuth(username: string, password: string): void;
+    /**
+     * Global query operations
+     */
+    query(request: QueryRequest): Promise<QueryResult | undefined>;
+    /**
+     * Table operations
+     */
+    tables: {
+        /**
+         * List all tables
+         */
+        list: () => Promise<{
+            name: string;
+            indexes: {
+                [key: string]: components["schemas"]["IndexConfig"];
+            };
+            shards: {
+                [key: string]: 
+                /**
+                 * Get the underlying OpenAPI client for advanced use cases
+                 */
+                components["schemas"]["ShardConfig"];
+            };
+            schema?: components["schemas"]["TableSchema"];
+        }[]>;
+        /**
+         * Get table details and status
+         */
+        get: (tableName: string) => Promise<unknown>;
+        /**
+         * Create a new table
+         */
+        create: (tableName: string, config?: CreateTableRequest) => Promise<{
+            name: string;
+            indexes: {
+                [key: string]: components["schemas"]["IndexConfig"];
+            };
+            shards: {
+                [key: string]: 
+                /**
+                 * Get the underlying OpenAPI client for advanced use cases
+                 */
+                components["schemas"]["ShardConfig"];
+            };
+            schema?: components["schemas"]["TableSchema"];
+        }>;
+        /**
+         * Drop a table
+         */
+        drop: (tableName: string) => Promise<boolean>;
+        /**
+         * Query a specific table
+         */
+        query: (tableName: string, request: QueryRequest) => Promise<{
+            hits?: components["schemas"]["QueryHits"];
+            facets?: {
+                [key: string]: components["schemas"]["FacetResult"];
+            };
+            took: number;
+            status: number;
+            error?: string;
+        }>;
+        /**
+         * Perform batch operations on a table
+         */
+        batch: (tableName: string, request: BatchRequest) => Promise<{
+            batch?: string;
+        }>;
+        /**
+         * Backup a table
+         */
+        backup: (tableName: string, request: BackupRequest) => Promise<{
+            backup?: string;
+        }>;
+        /**
+         * Restore a table from backup
+         */
+        restore: (tableName: string, request: RestoreRequest) => Promise<{
+            restore?: string;
+        }>;
+        /**
+         * Lookup a specific key in a table
+         */
+        lookup: (tableName: string, key: string) => Promise<{
+            [key: string]: unknown;
+        }>;
+    };
+    /**
+     * Index operations
+     */
+    indexes: {
+        /**
+         * List all indexes for a table
+         */
+        list: (tableName: string) => Promise<unknown[]>;
+        /**
+         * Get index details
+         */
+        get: (tableName: string, indexName: string) => Promise<unknown>;
+        /**
+         * Create a new index
+         */
+        create: (tableName: string, indexName: string, config: CreateIndexRequest) => Promise<boolean>;
+        /**
+         * Drop an index
+         */
+        drop: (tableName: string, indexName: string) => Promise<boolean>;
+    };
+    /**
+     * User management operations
+     */
+    users: {
+        /**
+         * Get user details
+         */
+        get: (userName: string) => Promise<{
+            username: string;
+            password_hash: string;
+        }>;
+        /**
+         * Create a new user
+         */
+        create: (userName: string, request: CreateUserRequest) => Promise<{
+            username: string;
+            password_hash: string;
+        }>;
+        /**
+         * Delete a user
+         */
+        delete: (userName: string) => Promise<boolean>;
+        /**
+         * Update user password
+         */
+        updatePassword: (userName: string, newPassword: string) => Promise<{
+            message?: string;
+        }>;
+        /**
+         * Get user permissions
+         */
+        getPermissions: (userName: string) => Promise<{
+            resource: string;
+            resource_type: components["schemas"]["ResourceType"];
+            type: components["schemas"]["PermissionType"];
+        }[]>;
+        /**
+         * Add permission to user
+         */
+        addPermission: (userName: string, permission: Permission) => Promise<{
+            message?: string;
+        }>;
+        /**
+         * Remove permission from user
+         */
+        removePermission: (userName: string, resource: string, resourceType: ResourceType) => Promise<boolean>;
+    };
+    /**
+     * Get the underlying OpenAPI client for advanced use cases
+     */
+    getRawClient(): Client<paths, `${string}/${string}`>;
+}
+
+/**
+ * Antfly SDK for TypeScript
+ *
+ * A TypeScript SDK for interacting with the Antfly API, suitable for both
+ * frontend and backend applications.
+ *
+ * @example
+ * ```typescript
+ * import { AntflyClient } from '@antfly/sdk';
+ *
+ * const client = new AntflyClient({
+ *   baseUrl: 'http://localhost:8080',
+ *   auth: {
+ *     username: 'admin',
+ *     password: 'password'
+ *   }
+ * });
+ *
+ * // Query data
+ * const results = await client.query({
+ *   table: 'products',
+ *   limit: 10
+ * });
+ *
+ * // Create a table
+ * await client.tables.create('products', {
+ *   num_shards: 3,
+ *   schema: {
+ *     key: 'id',
+ *     default_type: 'product'
+ *   }
+ * });
+ * ```
+ */
+
+export { AntflyClient, type AntflyConfig, type AntflyError, type BackupRequest, type BatchRequest, type CreateIndexRequest, type CreateTableRequest, type CreateUserRequest, type DocumentSchema, type FacetOption, type FacetResult, type IndexConfig, type IndexStatus, type Permission, type PermissionType, type QueryHit, type QueryOptions, type QueryRequest, type QueryResult, type Reranker, type ResourceType, type ResponseData, type RestoreRequest, type Table, type TableSchema, type TableStatus, type UpdatePasswordRequest, type User, type ValueSchema, type ValueType, type components, AntflyClient as default, type operations, type paths };