hanzoai 8.5.156

data/lib/hanzoai/api/index_api.rb

@@ -0,0 +1,1135 @@
+=begin
+#Hanzo Cloud API
+
+#The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module Hanzoai
+  class IndexApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Deletes an index and everything in it.
+    # Deletes an index and everything in it.  Drops the index and every document in it from the caller's own org, and answers the dialect's EnqueuedTask. This is the only way to retire an index; without it a mistaken uid is permanent. Deleting an index that is not there succeeds, so a cleanup pass is safe to re-run.  The 202 and its `enqueued` task are DIALECT COMPATIBILITY, not a promise of later work: the documents are already gone when this answers.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [IndexEnqueued]
+    def delete_index_indexes_by_uid(uid, opts = {})
+      data, _status_code, _headers = delete_index_indexes_by_uid_with_http_info(uid, opts)
+      data
+    end
+
+    # Deletes an index and everything in it.
+    # Deletes an index and everything in it.  Drops the index and every document in it from the caller's own org, and answers the dialect's EnqueuedTask. This is the only way to retire an index; without it a mistaken uid is permanent. Deleting an index that is not there succeeds, so a cleanup pass is safe to re-run.  The 202 and its `enqueued` task are DIALECT COMPATIBILITY, not a promise of later work: the documents are already gone when this answers.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexEnqueued, Integer, Hash)>] IndexEnqueued data, response status code and response headers
+    def delete_index_indexes_by_uid_with_http_info(uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.delete_index_indexes_by_uid ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.delete_index_indexes_by_uid"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexEnqueued'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.delete_index_indexes_by_uid",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#delete_index_indexes_by_uid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Deletes one document by its primary key.
+    # Deletes one document by its primary key.  Removes the document from the caller's own org and answers the dialect's EnqueuedTask. Deleting a key that is not there succeeds, so a client reconciling its own corpus can delete without checking first.  The 202 and its `enqueued` task are DIALECT COMPATIBILITY, not a promise of later work: the document is already gone when this answers.
+    # @param uid [String] 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [IndexEnqueued]
+    def delete_index_indexes_by_uid_documents_by_id(uid, id, opts = {})
+      data, _status_code, _headers = delete_index_indexes_by_uid_documents_by_id_with_http_info(uid, id, opts)
+      data
+    end
+
+    # Deletes one document by its primary key.
+    # Deletes one document by its primary key.  Removes the document from the caller&#39;s own org and answers the dialect&#39;s EnqueuedTask. Deleting a key that is not there succeeds, so a client reconciling its own corpus can delete without checking first.  The 202 and its &#x60;enqueued&#x60; task are DIALECT COMPATIBILITY, not a promise of later work: the document is already gone when this answers.
+    # @param uid [String] 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexEnqueued, Integer, Hash)>] IndexEnqueued data, response status code and response headers
+    def delete_index_indexes_by_uid_documents_by_id_with_http_info(uid, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.delete_index_indexes_by_uid_documents_by_id ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.delete_index_indexes_by_uid_documents_by_id"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling IndexApi.delete_index_indexes_by_uid_documents_by_id"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}/documents/{id}'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexEnqueued'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.delete_index_indexes_by_uid_documents_by_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#delete_index_indexes_by_uid_documents_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reports whether the search plane can serve.
+    # Reports whether the search plane can serve.  Answers the dialect's `{\"status\":\"available\"}` when the index store is readable. It FAILS CLOSED — an unreadable store answers 503 with `{\"status\":\"unavailable\"}` rather than an empty result set, because a Meilisearch client probes this before it will use a server at all and a cheerful 200 over a broken volume turns \"search is down\" into \"nothing matched\". It requires no principal and reads no tenant data.
+    # @param [Hash] opts the optional parameters
+    # @return [IndexHealth]
+    def get_index_health(opts = {})
+      data, _status_code, _headers = get_index_health_with_http_info(opts)
+      data
+    end
+
+    # Reports whether the search plane can serve.
+    # Reports whether the search plane can serve.  Answers the dialect&#39;s &#x60;{\&quot;status\&quot;:\&quot;available\&quot;}&#x60; when the index store is readable. It FAILS CLOSED — an unreadable store answers 503 with &#x60;{\&quot;status\&quot;:\&quot;unavailable\&quot;}&#x60; rather than an empty result set, because a Meilisearch client probes this before it will use a server at all and a cheerful 200 over a broken volume turns \&quot;search is down\&quot; into \&quot;nothing matched\&quot;. It requires no principal and reads no tenant data.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexHealth, Integer, Hash)>] IndexHealth data, response status code and response headers
+    def get_index_health_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_health ...'
+      end
+      # resource path
+      local_var_path = '/v1/index/health'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexHealth'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.get_index_health",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_health\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists the indexes your org holds.
+    # Lists the indexes your org holds.  Answers every index in the caller's own org with its primary key and timestamps. Without it an index whose uid a caller has forgotten is unreachable — there is no other way to enumerate what an org holds. The page is the whole set: an org's index count is small by construction, so `limit` and `total` both report it.  The tenant is the org minted from the VALIDATED bearer's owner claim, never a client-supplied header, and two orgs may both hold an index named \"messages\" without either seeing the other. Without a validated principal the answer is 403 carrying the dialect's `invalid_api_key` body.
+    # @param [Hash] opts the optional parameters
+    # @return [IndexList]
+    def get_index_indexes(opts = {})
+      data, _status_code, _headers = get_index_indexes_with_http_info(opts)
+      data
+    end
+
+    # Lists the indexes your org holds.
+    # Lists the indexes your org holds.  Answers every index in the caller&#39;s own org with its primary key and timestamps. Without it an index whose uid a caller has forgotten is unreachable — there is no other way to enumerate what an org holds. The page is the whole set: an org&#39;s index count is small by construction, so &#x60;limit&#x60; and &#x60;total&#x60; both report it.  The tenant is the org minted from the VALIDATED bearer&#39;s owner claim, never a client-supplied header, and two orgs may both hold an index named \&quot;messages\&quot; without either seeing the other. Without a validated principal the answer is 403 carrying the dialect&#39;s &#x60;invalid_api_key&#x60; body.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexList, Integer, Hash)>] IndexList data, response status code and response headers
+    def get_index_indexes_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_indexes ...'
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.get_index_indexes",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_indexes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads one index's definition.
+    # Reads one index's definition.  Answers the index's uid, primary key and timestamps. An index this org does not hold answers 404 carrying the dialect's `index_not_found` — the code a Meilisearch client reads as permission to create it, which is why this is a refusal rather than an empty object.  The uid is scoped to the caller's own org, so another tenant's index is indistinguishable from one that never existed: this surface is not an existence oracle.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [IndexView]
+    def get_index_indexes_by_uid(uid, opts = {})
+      data, _status_code, _headers = get_index_indexes_by_uid_with_http_info(uid, opts)
+      data
+    end
+
+    # Reads one index&#39;s definition.
+    # Reads one index&#39;s definition.  Answers the index&#39;s uid, primary key and timestamps. An index this org does not hold answers 404 carrying the dialect&#39;s &#x60;index_not_found&#x60; — the code a Meilisearch client reads as permission to create it, which is why this is a refusal rather than an empty object.  The uid is scoped to the caller&#39;s own org, so another tenant&#39;s index is indistinguishable from one that never existed: this surface is not an existence oracle.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexView, Integer, Hash)>] IndexView data, response status code and response headers
+    def get_index_indexes_by_uid_with_http_info(uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_indexes_by_uid ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.get_index_indexes_by_uid"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexView'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.get_index_indexes_by_uid",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_indexes_by_uid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Pages through the documents in an index.
+    # Pages through the documents in an index.  Answers the org's stored documents in insertion order, whole, with the page's bounds and the index's total. It is the enumeration surface — search ranks by relevance and cannot walk a corpus — so a caller reconciling what it has written reads it here.  An index this org does not hold answers 404 carrying the dialect's `index_not_found`.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :limit 
+    # @option opts [String] :offset 
+    # @return [IndexDocuments]
+    def get_index_indexes_by_uid_documents(uid, opts = {})
+      data, _status_code, _headers = get_index_indexes_by_uid_documents_with_http_info(uid, opts)
+      data
+    end
+
+    # Pages through the documents in an index.
+    # Pages through the documents in an index.  Answers the org&#39;s stored documents in insertion order, whole, with the page&#39;s bounds and the index&#39;s total. It is the enumeration surface — search ranks by relevance and cannot walk a corpus — so a caller reconciling what it has written reads it here.  An index this org does not hold answers 404 carrying the dialect&#39;s &#x60;index_not_found&#x60;.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :limit 
+    # @option opts [String] :offset 
+    # @return [Array<(IndexDocuments, Integer, Hash)>] IndexDocuments data, response status code and response headers
+    def get_index_indexes_by_uid_documents_with_http_info(uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_indexes_by_uid_documents ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.get_index_indexes_by_uid_documents"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}/documents'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexDocuments'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.get_index_indexes_by_uid_documents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_indexes_by_uid_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads one document by its primary key.
+    # Reads one document by its primary key.  Answers the stored document exactly as it was written — this surface keeps documents whole rather than projecting them, so what comes back is what went in. A primary key this index does not hold answers 404 carrying the dialect's `document_not_found`; an index this org does not hold answers `index_not_found`, and the two are different facts a client acts on differently.
+    # @param uid [String] 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def get_index_indexes_by_uid_documents_by_id(uid, id, opts = {})
+      data, _status_code, _headers = get_index_indexes_by_uid_documents_by_id_with_http_info(uid, id, opts)
+      data
+    end
+
+    # Reads one document by its primary key.
+    # Reads one document by its primary key.  Answers the stored document exactly as it was written — this surface keeps documents whole rather than projecting them, so what comes back is what went in. A primary key this index does not hold answers 404 carrying the dialect&#39;s &#x60;document_not_found&#x60;; an index this org does not hold answers &#x60;index_not_found&#x60;, and the two are different facts a client acts on differently.
+    # @param uid [String] 
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_index_indexes_by_uid_documents_by_id_with_http_info(uid, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_indexes_by_uid_documents_by_id ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.get_index_indexes_by_uid_documents_by_id"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling IndexApi.get_index_indexes_by_uid_documents_by_id"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}/documents/{id}'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.get_index_indexes_by_uid_documents_by_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_indexes_by_uid_documents_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads an index's filterable attributes.
+    # Reads an index's filterable attributes.  Answers the settings subset this surface implements: the attributes a search `filter` may constrain. An index this org does not hold answers 404 carrying the dialect's `index_not_found`.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [IndexSettings]
+    def get_index_indexes_by_uid_settings(uid, opts = {})
+      data, _status_code, _headers = get_index_indexes_by_uid_settings_with_http_info(uid, opts)
+      data
+    end
+
+    # Reads an index&#39;s filterable attributes.
+    # Reads an index&#39;s filterable attributes.  Answers the settings subset this surface implements: the attributes a search &#x60;filter&#x60; may constrain. An index this org does not hold answers 404 carrying the dialect&#39;s &#x60;index_not_found&#x60;.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexSettings, Integer, Hash)>] IndexSettings data, response status code and response headers
+    def get_index_indexes_by_uid_settings_with_http_info(uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_indexes_by_uid_settings ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.get_index_indexes_by_uid_settings"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}/settings'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexSettings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.get_index_indexes_by_uid_settings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_indexes_by_uid_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Counts the documents in each of your indexes.
+    # Counts the documents in each of your indexes.  Reports every index the caller's own org holds with its document count, plus the org's total. `isIndexing` is always false because writes here are applied before their response — there is never a background pass to wait on.  The tenant is the org minted from the VALIDATED bearer's owner claim, never a client-supplied header, so this counts the caller's own documents and no other tenant's. Without a validated principal the answer is 403 carrying the dialect's `invalid_api_key` body.
+    # @param [Hash] opts the optional parameters
+    # @return [IndexStats]
+    def get_index_stats(opts = {})
+      data, _status_code, _headers = get_index_stats_with_http_info(opts)
+      data
+    end
+
+    # Counts the documents in each of your indexes.
+    # Counts the documents in each of your indexes.  Reports every index the caller&#39;s own org holds with its document count, plus the org&#39;s total. &#x60;isIndexing&#x60; is always false because writes here are applied before their response — there is never a background pass to wait on.  The tenant is the org minted from the VALIDATED bearer&#39;s owner claim, never a client-supplied header, so this counts the caller&#39;s own documents and no other tenant&#39;s. Without a validated principal the answer is 403 carrying the dialect&#39;s &#x60;invalid_api_key&#x60; body.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexStats, Integer, Hash)>] IndexStats data, response status code and response headers
+    def get_index_stats_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_stats ...'
+      end
+      # resource path
+      local_var_path = '/v1/index/stats'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexStats'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.get_index_stats",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Checks a write task, which has already finished.
+    # Checks a write task, which has already finished.  Always reports `succeeded`. Writes here are applied to SQLite before their EnqueuedTask is returned, so a client polling waitForTask resolves on its first call rather than waiting for a queue that was never there. The three timestamps are the same instant for the same reason.  It requires a validated principal but reads no tenant data: the task id it echoes was minted by this process and names nothing about any org.
+    # @param uid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [IndexTask]
+    def get_index_tasks_by_uid(uid, opts = {})
+      data, _status_code, _headers = get_index_tasks_by_uid_with_http_info(uid, opts)
+      data
+    end
+
+    # Checks a write task, which has already finished.
+    # Checks a write task, which has already finished.  Always reports &#x60;succeeded&#x60;. Writes here are applied to SQLite before their EnqueuedTask is returned, so a client polling waitForTask resolves on its first call rather than waiting for a queue that was never there. The three timestamps are the same instant for the same reason.  It requires a validated principal but reads no tenant data: the task id it echoes was minted by this process and names nothing about any org.
+    # @param uid [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexTask, Integer, Hash)>] IndexTask data, response status code and response headers
+    def get_index_tasks_by_uid_with_http_info(uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_tasks_by_uid ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.get_index_tasks_by_uid"
+      end
+      # resource path
+      local_var_path = '/v1/index/tasks/{uid}'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexTask'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.get_index_tasks_by_uid",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_tasks_by_uid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Identifies the search implementation answering.
+    # Identifies the search implementation answering.  Reports the dialect's version shape with `commitSha` naming this implementation rather than a Meilisearch build, so a client that logs the version records which server answered instead of implying a release of software this is not. It requires no principal and reads no tenant data.
+    # @param [Hash] opts the optional parameters
+    # @return [IndexVersion]
+    def get_index_version(opts = {})
+      data, _status_code, _headers = get_index_version_with_http_info(opts)
+      data
+    end
+
+    # Identifies the search implementation answering.
+    # Identifies the search implementation answering.  Reports the dialect&#39;s version shape with &#x60;commitSha&#x60; naming this implementation rather than a Meilisearch build, so a client that logs the version records which server answered instead of implying a release of software this is not. It requires no principal and reads no tenant data.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexVersion, Integer, Hash)>] IndexVersion data, response status code and response headers
+    def get_index_version_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_version ...'
+      end
+      # resource path
+      local_var_path = '/v1/index/version'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexVersion'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.get_index_version",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Sets which attributes an index can be filtered on.
+    # Sets which attributes an index can be filtered on.  Replaces the whole filterable set. An attribute not listed here cannot be used in a search `filter`, so this is what makes a per-user or per-tag narrowing possible at all.  It CREATES the index when it is missing rather than answering 404, because a Meilisearch client configures settings on an index it has just asked for and a refusal there leaves the client with no index at all.  The 202 and its `enqueued` task are DIALECT COMPATIBILITY, not a promise of later work: the setting is already applied when this answers.
+    # @param uid [String] 
+    # @param index_filter [IndexFilter] 
+    # @param [Hash] opts the optional parameters
+    # @return [IndexEnqueued]
+    def patch_index_indexes_by_uid_settings(uid, index_filter, opts = {})
+      data, _status_code, _headers = patch_index_indexes_by_uid_settings_with_http_info(uid, index_filter, opts)
+      data
+    end
+
+    # Sets which attributes an index can be filtered on.
+    # Sets which attributes an index can be filtered on.  Replaces the whole filterable set. An attribute not listed here cannot be used in a search &#x60;filter&#x60;, so this is what makes a per-user or per-tag narrowing possible at all.  It CREATES the index when it is missing rather than answering 404, because a Meilisearch client configures settings on an index it has just asked for and a refusal there leaves the client with no index at all.  The 202 and its &#x60;enqueued&#x60; task are DIALECT COMPATIBILITY, not a promise of later work: the setting is already applied when this answers.
+    # @param uid [String] 
+    # @param index_filter [IndexFilter] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexEnqueued, Integer, Hash)>] IndexEnqueued data, response status code and response headers
+    def patch_index_indexes_by_uid_settings_with_http_info(uid, index_filter, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.patch_index_indexes_by_uid_settings ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.patch_index_indexes_by_uid_settings"
+      end
+      # verify the required parameter 'index_filter' is set
+      if @api_client.config.client_side_validation && index_filter.nil?
+        fail ArgumentError, "Missing the required parameter 'index_filter' when calling IndexApi.patch_index_indexes_by_uid_settings"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}/settings'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(index_filter)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexEnqueued'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.patch_index_indexes_by_uid_settings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#patch_index_indexes_by_uid_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Creates an index.
+    # Creates an index.  Registers a named index in the caller's own org and answers the dialect's EnqueuedTask. It is idempotent: creating an index that already exists returns the same receipt and changes nothing, which is what lets a client create on startup without checking first.  `primaryKey` is optional — the first write establishes one when it is omitted. An index is a ROW here rather than a table, so an unusual uid is stored verbatim instead of being sanitised into a schema name.  The 202 and its `enqueued` task are DIALECT COMPATIBILITY, not a promise of later work: the write is already applied when this answers. A client that polls waitForTask resolves immediately.
+    # @param index_new [IndexNew] 
+    # @param [Hash] opts the optional parameters
+    # @return [IndexEnqueued]
+    def post_index_indexes(index_new, opts = {})
+      data, _status_code, _headers = post_index_indexes_with_http_info(index_new, opts)
+      data
+    end
+
+    # Creates an index.
+    # Creates an index.  Registers a named index in the caller&#39;s own org and answers the dialect&#39;s EnqueuedTask. It is idempotent: creating an index that already exists returns the same receipt and changes nothing, which is what lets a client create on startup without checking first.  &#x60;primaryKey&#x60; is optional — the first write establishes one when it is omitted. An index is a ROW here rather than a table, so an unusual uid is stored verbatim instead of being sanitised into a schema name.  The 202 and its &#x60;enqueued&#x60; task are DIALECT COMPATIBILITY, not a promise of later work: the write is already applied when this answers. A client that polls waitForTask resolves immediately.
+    # @param index_new [IndexNew] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexEnqueued, Integer, Hash)>] IndexEnqueued data, response status code and response headers
+    def post_index_indexes_with_http_info(index_new, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.post_index_indexes ...'
+      end
+      # verify the required parameter 'index_new' is set
+      if @api_client.config.client_side_validation && index_new.nil?
+        fail ArgumentError, "Missing the required parameter 'index_new' when calling IndexApi.post_index_indexes"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(index_new)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexEnqueued'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.post_index_indexes",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#post_index_indexes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Add or replace documents in an index
+    # Writes documents into the caller's own index, keyed by the index's primary key: a document whose key is already present is REPLACED whole. The body is the dialect's own — an array of documents, or a single document — and each is stored verbatim, so a read gives back exactly what was written.  The index is CREATED when it is missing rather than refused, because a Meilisearch client writes before it configures.  The tenant is the org minted from the VALIDATED bearer's owner claim, never a client-supplied header, so two orgs may both hold an index named \"messages\" and neither can see the other's documents. Without a validated principal the answer is 403 carrying the dialect's `invalid_api_key` body.  The 202 and its `enqueued` task are DIALECT COMPATIBILITY, not a promise of later work: the documents are searchable when this answers, and a client that polls waitForTask resolves immediately.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<Object>] :request_body 
+    # @return [IndexEnqueued]
+    def post_index_indexes_by_uid_documents(uid, opts = {})
+      data, _status_code, _headers = post_index_indexes_by_uid_documents_with_http_info(uid, opts)
+      data
+    end
+
+    # Add or replace documents in an index
+    # Writes documents into the caller&#39;s own index, keyed by the index&#39;s primary key: a document whose key is already present is REPLACED whole. The body is the dialect&#39;s own — an array of documents, or a single document — and each is stored verbatim, so a read gives back exactly what was written.  The index is CREATED when it is missing rather than refused, because a Meilisearch client writes before it configures.  The tenant is the org minted from the VALIDATED bearer&#39;s owner claim, never a client-supplied header, so two orgs may both hold an index named \&quot;messages\&quot; and neither can see the other&#39;s documents. Without a validated principal the answer is 403 carrying the dialect&#39;s &#x60;invalid_api_key&#x60; body.  The 202 and its &#x60;enqueued&#x60; task are DIALECT COMPATIBILITY, not a promise of later work: the documents are searchable when this answers, and a client that polls waitForTask resolves immediately.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<Object>] :request_body 
+    # @return [Array<(IndexEnqueued, Integer, Hash)>] IndexEnqueued data, response status code and response headers
+    def post_index_indexes_by_uid_documents_with_http_info(uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.post_index_indexes_by_uid_documents ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.post_index_indexes_by_uid_documents"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}/documents'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'request_body'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexEnqueued'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.post_index_indexes_by_uid_documents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#post_index_indexes_by_uid_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete many documents by primary key in one call
+    # Removes every named document from the caller's own index. The body is the dialect's own: a bare array of primary keys, which may be strings or numbers. A key that is not there is not an error, so a client reconciling its own corpus can send one list rather than checking each key first.  The tenant is the org minted from the VALIDATED bearer's owner claim, never a client-supplied header. Without a validated principal the answer is 403 carrying the dialect's `invalid_api_key` body.  The 202 and its `enqueued` task are DIALECT COMPATIBILITY, not a promise of later work: the documents are already gone when this answers.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<Object>] :request_body 
+    # @return [IndexEnqueued]
+    def post_index_indexes_by_uid_documents_delete_batch(uid, opts = {})
+      data, _status_code, _headers = post_index_indexes_by_uid_documents_delete_batch_with_http_info(uid, opts)
+      data
+    end
+
+    # Delete many documents by primary key in one call
+    # Removes every named document from the caller&#39;s own index. The body is the dialect&#39;s own: a bare array of primary keys, which may be strings or numbers. A key that is not there is not an error, so a client reconciling its own corpus can send one list rather than checking each key first.  The tenant is the org minted from the VALIDATED bearer&#39;s owner claim, never a client-supplied header. Without a validated principal the answer is 403 carrying the dialect&#39;s &#x60;invalid_api_key&#x60; body.  The 202 and its &#x60;enqueued&#x60; task are DIALECT COMPATIBILITY, not a promise of later work: the documents are already gone when this answers.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<Object>] :request_body 
+    # @return [Array<(IndexEnqueued, Integer, Hash)>] IndexEnqueued data, response status code and response headers
+    def post_index_indexes_by_uid_documents_delete_batch_with_http_info(uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.post_index_indexes_by_uid_documents_delete_batch ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.post_index_indexes_by_uid_documents_delete_batch"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}/documents/delete-batch'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'request_body'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexEnqueued'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.post_index_indexes_by_uid_documents_delete_batch",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#post_index_indexes_by_uid_documents_delete_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Searches an index, forgiving typos.
+    # Searches an index, forgiving typos.  Ranks the org's documents in one index against `q` and answers the matching documents whole, most relevant first. A prefix matches, so a partial word finds the documents containing it, and `filter` narrows the result to documents whose filterable attributes match — which is how a caller scopes results to one end user within its own org.  `estimatedTotalHits` is the dialect's name for the count; every hit is materialised here, so for this page it is exact. An index this org does not hold answers 404 carrying the dialect's `index_not_found`.
+    # @param uid [String] 
+    # @param index_query [IndexQuery] 
+    # @param [Hash] opts the optional parameters
+    # @return [IndexHits]
+    def post_index_indexes_by_uid_search(uid, index_query, opts = {})
+      data, _status_code, _headers = post_index_indexes_by_uid_search_with_http_info(uid, index_query, opts)
+      data
+    end
+
+    # Searches an index, forgiving typos.
+    # Searches an index, forgiving typos.  Ranks the org&#39;s documents in one index against &#x60;q&#x60; and answers the matching documents whole, most relevant first. A prefix matches, so a partial word finds the documents containing it, and &#x60;filter&#x60; narrows the result to documents whose filterable attributes match — which is how a caller scopes results to one end user within its own org.  &#x60;estimatedTotalHits&#x60; is the dialect&#39;s name for the count; every hit is materialised here, so for this page it is exact. An index this org does not hold answers 404 carrying the dialect&#39;s &#x60;index_not_found&#x60;.
+    # @param uid [String] 
+    # @param index_query [IndexQuery] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IndexHits, Integer, Hash)>] IndexHits data, response status code and response headers
+    def post_index_indexes_by_uid_search_with_http_info(uid, index_query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.post_index_indexes_by_uid_search ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.post_index_indexes_by_uid_search"
+      end
+      # verify the required parameter 'index_query' is set
+      if @api_client.config.client_side_validation && index_query.nil?
+        fail ArgumentError, "Missing the required parameter 'index_query' when calling IndexApi.post_index_indexes_by_uid_search"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}/search'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(index_query)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexHits'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.post_index_indexes_by_uid_search",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#post_index_indexes_by_uid_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Add or update documents in an index
+    # The dialect's update spelling of the write above, and the same act: an upsert keyed by the index's primary key. The JS client's addDocuments and updateDocuments both reduce to this for whole documents, so both spellings are served and both behave identically.  The tenant is the org minted from the VALIDATED bearer's owner claim, never a client-supplied header. Without a validated principal the answer is 403 carrying the dialect's `invalid_api_key` body.  The 202 and its `enqueued` task are DIALECT COMPATIBILITY, not a promise of later work: the write is already applied when this answers.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<Object>] :request_body 
+    # @return [IndexEnqueued]
+    def put_index_indexes_by_uid_documents(uid, opts = {})
+      data, _status_code, _headers = put_index_indexes_by_uid_documents_with_http_info(uid, opts)
+      data
+    end
+
+    # Add or update documents in an index
+    # The dialect&#39;s update spelling of the write above, and the same act: an upsert keyed by the index&#39;s primary key. The JS client&#39;s addDocuments and updateDocuments both reduce to this for whole documents, so both spellings are served and both behave identically.  The tenant is the org minted from the VALIDATED bearer&#39;s owner claim, never a client-supplied header. Without a validated principal the answer is 403 carrying the dialect&#39;s &#x60;invalid_api_key&#x60; body.  The 202 and its &#x60;enqueued&#x60; task are DIALECT COMPATIBILITY, not a promise of later work: the write is already applied when this answers.
+    # @param uid [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<Object>] :request_body 
+    # @return [Array<(IndexEnqueued, Integer, Hash)>] IndexEnqueued data, response status code and response headers
+    def put_index_indexes_by_uid_documents_with_http_info(uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.put_index_indexes_by_uid_documents ...'
+      end
+      # verify the required parameter 'uid' is set
+      if @api_client.config.client_side_validation && uid.nil?
+        fail ArgumentError, "Missing the required parameter 'uid' when calling IndexApi.put_index_indexes_by_uid_documents"
+      end
+      # resource path
+      local_var_path = '/v1/index/indexes/{uid}/documents'.sub('{' + 'uid' + '}', CGI.escape(uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'request_body'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IndexEnqueued'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"IndexApi.put_index_indexes_by_uid_documents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#put_index_indexes_by_uid_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end