indexea_client 0.0.9

data/lib/indexea_client/api/records_api.rb

@@ -0,0 +1,375 @@
+=begin
+#Indexea OpenAPI
+
+#OpenAPI of Indexea
+
+OpenAPI spec version: 1.0.0
+Contact: indexea.com@gmail.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.54
+=end
+
+module IndexeaClient
+  class RecordsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 删除记录数据
+    # @param app 应用标识
+    # @param index 索引编号
+    # @param _id 主键字段值
+    # @param [Hash] opts the optional parameters
+    # @return [BOOLEAN]
+    def record_delete(app, index, _id, opts = {})
+      data, _status_code, _headers = record_delete_with_http_info(app, index, _id, opts)
+      data
+    end
+
+    # 删除记录数据
+    # @param app 应用标识
+    # @param index 索引编号
+    # @param _id 主键字段值
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BOOLEAN, Integer, Hash)>] BOOLEAN data, response status code and response headers
+    def record_delete_with_http_info(app, index, _id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecordsApi.record_delete ...'
+      end
+      # verify the required parameter 'app' is set
+      if @api_client.config.client_side_validation && app.nil?
+        fail ArgumentError, "Missing the required parameter 'app' when calling RecordsApi.record_delete"
+      end
+      # verify the required parameter 'index' is set
+      if @api_client.config.client_side_validation && index.nil?
+        fail ArgumentError, "Missing the required parameter 'index' when calling RecordsApi.record_delete"
+      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 RecordsApi.record_delete"
+      end
+      # resource path
+      local_var_path = '/records/{app}/{index}'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'index' + '}', index.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_id'] = @api_client.build_collection_param(_id, :multi)
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'BOOLEAN' 
+
+      auth_names = opts[:auth_names] || ['TokenAuth']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecordsApi#record_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 获取单条记录详情
+    # @param app 应用标识
+    # @param index 索引编号
+    # @param _id 记录 _id 值
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def record_get(app, index, _id, opts = {})
+      data, _status_code, _headers = record_get_with_http_info(app, index, _id, opts)
+      data
+    end
+
+    # 获取单条记录详情
+    # @param app 应用标识
+    # @param index 索引编号
+    # @param _id 记录 _id 值
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def record_get_with_http_info(app, index, _id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecordsApi.record_get ...'
+      end
+      # verify the required parameter 'app' is set
+      if @api_client.config.client_side_validation && app.nil?
+        fail ArgumentError, "Missing the required parameter 'app' when calling RecordsApi.record_get"
+      end
+      # verify the required parameter 'index' is set
+      if @api_client.config.client_side_validation && index.nil?
+        fail ArgumentError, "Missing the required parameter 'index' when calling RecordsApi.record_get"
+      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 RecordsApi.record_get"
+      end
+      # resource path
+      local_var_path = '/records/{app}/{index}'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'index' + '}', index.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_id'] = _id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Object' 
+
+      auth_names = opts[:auth_names] || ['TokenAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecordsApi#record_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 获取索引记录列表
+    # @param app 应用标识
+    # @param index 索引编号
+    # @param [Hash] opts the optional parameters
+    # @option opts [RecordFilter] :body 
+    # @option opts [String] :q 搜索关键字
+    # @option opts [String] :field 搜索字段
+    # @option opts [Integer] :from 起始记录 (default to 0)
+    # @option opts [Integer] :size 获取记录数 (default to 20)
+    # @option opts [BOOLEAN] :save_filter 是否保存过滤器信息 (default to false)
+    # @return [Array<Object>]
+    def record_list(app, index, opts = {})
+      data, _status_code, _headers = record_list_with_http_info(app, index, opts)
+      data
+    end
+
+    # 获取索引记录列表
+    # @param app 应用标识
+    # @param index 索引编号
+    # @param [Hash] opts the optional parameters
+    # @option opts [RecordFilter] :body 
+    # @option opts [String] :q 搜索关键字
+    # @option opts [String] :field 搜索字段
+    # @option opts [Integer] :from 起始记录
+    # @option opts [Integer] :size 获取记录数
+    # @option opts [BOOLEAN] :save_filter 是否保存过滤器信息
+    # @return [Array<(Array<Object>, Integer, Hash)>] Array<Object> data, response status code and response headers
+    def record_list_with_http_info(app, index, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecordsApi.record_list ...'
+      end
+      # verify the required parameter 'app' is set
+      if @api_client.config.client_side_validation && app.nil?
+        fail ArgumentError, "Missing the required parameter 'app' when calling RecordsApi.record_list"
+      end
+      # verify the required parameter 'index' is set
+      if @api_client.config.client_side_validation && index.nil?
+        fail ArgumentError, "Missing the required parameter 'index' when calling RecordsApi.record_list"
+      end
+      # resource path
+      local_var_path = '/records/{app}/{index}'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'index' + '}', index.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'field'] = opts[:'field'] if !opts[:'field'].nil?
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'saveFilter'] = opts[:'save_filter'] if !opts[:'save_filter'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+
+      return_type = opts[:return_type] || 'Array<Object>' 
+
+      auth_names = opts[:auth_names] || ['TokenAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecordsApi#record_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 插入或者更新索引数据
+    # @param body 
+    # @param app 应用标识
+    # @param index 索引编号
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :combine 更新策略：合并还是替换，combine&#x3D;true 为合并模式 (default to false)
+    # @return [BOOLEAN]
+    def record_push(body, app, index, opts = {})
+      data, _status_code, _headers = record_push_with_http_info(body, app, index, opts)
+      data
+    end
+
+    # 插入或者更新索引数据
+    # @param body 
+    # @param app 应用标识
+    # @param index 索引编号
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :combine 更新策略：合并还是替换，combine&#x3D;true 为合并模式
+    # @return [Array<(BOOLEAN, Integer, Hash)>] BOOLEAN data, response status code and response headers
+    def record_push_with_http_info(body, app, index, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecordsApi.record_push ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling RecordsApi.record_push"
+      end
+      # verify the required parameter 'app' is set
+      if @api_client.config.client_side_validation && app.nil?
+        fail ArgumentError, "Missing the required parameter 'app' when calling RecordsApi.record_push"
+      end
+      # verify the required parameter 'index' is set
+      if @api_client.config.client_side_validation && index.nil?
+        fail ArgumentError, "Missing the required parameter 'index' when calling RecordsApi.record_push"
+      end
+      # resource path
+      local_var_path = '/records/{app}/{index}'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'index' + '}', index.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'combine'] = opts[:'combine'] if !opts[:'combine'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      return_type = opts[:return_type] || 'BOOLEAN' 
+
+      auth_names = opts[:auth_names] || ['TokenAuth']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecordsApi#record_push\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 上传记录
+    # @param app 应用标识
+    # @param index 索引编号
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :files 
+    # @option opts [BOOLEAN] :combine 更新策略：合并还是替换，combine&#x3D;true 为合并模式 (default to false)
+    # @option opts [BOOLEAN] :use_id_as_id_value 使用数据中的 id 值作为记录 _id, 如果没有 id 字段则自动生成 (default to true)
+    # @return [Object]
+    def record_upload(app, index, opts = {})
+      data, _status_code, _headers = record_upload_with_http_info(app, index, opts)
+      data
+    end
+
+    # 上传记录
+    # @param app 应用标识
+    # @param index 索引编号
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :files 
+    # @option opts [BOOLEAN] :combine 更新策略：合并还是替换，combine&#x3D;true 为合并模式
+    # @option opts [BOOLEAN] :use_id_as_id_value 使用数据中的 id 值作为记录 _id, 如果没有 id 字段则自动生成
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def record_upload_with_http_info(app, index, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecordsApi.record_upload ...'
+      end
+      # verify the required parameter 'app' is set
+      if @api_client.config.client_side_validation && app.nil?
+        fail ArgumentError, "Missing the required parameter 'app' when calling RecordsApi.record_upload"
+      end
+      # verify the required parameter 'index' is set
+      if @api_client.config.client_side_validation && index.nil?
+        fail ArgumentError, "Missing the required parameter 'index' when calling RecordsApi.record_upload"
+      end
+      # resource path
+      local_var_path = '/records/{app}/{index}/upload'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'index' + '}', index.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'combine'] = opts[:'combine'] if !opts[:'combine'].nil?
+      query_params[:'useIdAsIdValue'] = opts[:'use_id_as_id_value'] if !opts[:'use_id_as_id_value'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['files'] = @api_client.build_collection_param(opts[:'files'], :multi) if !opts[:'files'].nil?
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Object' 
+
+      auth_names = opts[:auth_names] || ['TokenAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecordsApi#record_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end