indexea_client 0.0.9

data/lib/indexea_client/api/recommend_api.rb

@@ -0,0 +1,461 @@
+=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 RecommendApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 推荐结果点击行为收集
+    # 该接口主要用于记录用户对推荐结果的点击行为
+    # @param ident 推荐的唯一标识
+    # @param action_id 对应推荐行为编号
+    # @param doc_id 对应索引中的内部记录编号
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @return [BOOLEAN]
+    def recommend_click(ident, action_id, doc_id, opts = {})
+      data, _status_code, _headers = recommend_click_with_http_info(ident, action_id, doc_id, opts)
+      data
+    end
+
+    # 推荐结果点击行为收集
+    # 该接口主要用于记录用户对推荐结果的点击行为
+    # @param ident 推荐的唯一标识
+    # @param action_id 对应推荐行为编号
+    # @param doc_id 对应索引中的内部记录编号
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @return [Array<(BOOLEAN, Integer, Hash)>] BOOLEAN data, response status code and response headers
+    def recommend_click_with_http_info(ident, action_id, doc_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecommendApi.recommend_click ...'
+      end
+      # verify the required parameter 'ident' is set
+      if @api_client.config.client_side_validation && ident.nil?
+        fail ArgumentError, "Missing the required parameter 'ident' when calling RecommendApi.recommend_click"
+      end
+      # verify the required parameter 'action_id' is set
+      if @api_client.config.client_side_validation && action_id.nil?
+        fail ArgumentError, "Missing the required parameter 'action_id' when calling RecommendApi.recommend_click"
+      end
+      # verify the required parameter 'doc_id' is set
+      if @api_client.config.client_side_validation && doc_id.nil?
+        fail ArgumentError, "Missing the required parameter 'doc_id' when calling RecommendApi.recommend_click"
+      end
+      # resource path
+      local_var_path = '/recommend/{ident}/click'.sub('{' + 'ident' + '}', ident.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'action_id'] = action_id
+      query_params[:'doc_id'] = doc_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+
+      # 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] || []
+      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: RecommendApi#recommend_click\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 创建新的推荐
+    # @param body 推荐信息
+    # @param app 应用标识
+    # @param [Hash] opts the optional parameters
+    # @return [RecommendBean]
+    def recommend_create(body, app, opts = {})
+      data, _status_code, _headers = recommend_create_with_http_info(body, app, opts)
+      data
+    end
+
+    # 创建新的推荐
+    # @param body 推荐信息
+    # @param app 应用标识
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RecommendBean, Integer, Hash)>] RecommendBean data, response status code and response headers
+    def recommend_create_with_http_info(body, app, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecommendApi.recommend_create ...'
+      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 RecommendApi.recommend_create"
+      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 RecommendApi.recommend_create"
+      end
+      # resource path
+      local_var_path = '/recommends/{app}'.sub('{' + 'app' + '}', app.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'])
+      # 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] || 'RecommendBean' 
+
+      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: RecommendApi#recommend_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 删除推荐
+    # @param app 应用标识
+    # @param id 推荐编号
+    # @param [Hash] opts the optional parameters
+    # @return [BOOLEAN]
+    def recommend_delete(app, id, opts = {})
+      data, _status_code, _headers = recommend_delete_with_http_info(app, id, opts)
+      data
+    end
+
+    # 删除推荐
+    # @param app 应用标识
+    # @param id 推荐编号
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BOOLEAN, Integer, Hash)>] BOOLEAN data, response status code and response headers
+    def recommend_delete_with_http_info(app, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecommendApi.recommend_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 RecommendApi.recommend_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 RecommendApi.recommend_delete"
+      end
+      # resource path
+      local_var_path = '/recommends/{app}'.sub('{' + 'app' + '}', app.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] || '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: RecommendApi#recommend_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 获取推荐的记录列表
+    # @param ident 推荐定义的标识
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @return [RecommendBean]
+    def recommend_detail(ident, opts = {})
+      data, _status_code, _headers = recommend_detail_with_http_info(ident, opts)
+      data
+    end
+
+    # 获取推荐的记录列表
+    # @param ident 推荐定义的标识
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @return [Array<(RecommendBean, Integer, Hash)>] RecommendBean data, response status code and response headers
+    def recommend_detail_with_http_info(ident, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecommendApi.recommend_detail ...'
+      end
+      # verify the required parameter 'ident' is set
+      if @api_client.config.client_side_validation && ident.nil?
+        fail ArgumentError, "Missing the required parameter 'ident' when calling RecommendApi.recommend_detail"
+      end
+      # resource path
+      local_var_path = '/recommend/{ident}'.sub('{' + 'ident' + '}', ident.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'])
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'RecommendBean' 
+
+      auth_names = opts[:auth_names] || []
+      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: RecommendApi#recommend_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 获取推荐的记录列表
+    # @param ident 推荐定义的标识
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 访客的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [Hash<String, String>] :condition 获取某个记录的参数,例如 id&#x3D;11223(后端将使用 term query 进行匹配)
+    # @option opts [Integer] :from 起始值 (default to 0)
+    # @option opts [Integer] :count 推荐的记录数 (default to 10)
+    # @return [Object]
+    def recommend_fetch(ident, opts = {})
+      data, _status_code, _headers = recommend_fetch_with_http_info(ident, opts)
+      data
+    end
+
+    # 获取推荐的记录列表
+    # @param ident 推荐定义的标识
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+    # @option opts [String] :userid 访客的唯一标识，该标识由搜索前端生成，长度不超过64
+    # @option opts [Hash<String, String>] :condition 获取某个记录的参数,例如 id&#x3D;11223(后端将使用 term query 进行匹配)
+    # @option opts [Integer] :from 起始值
+    # @option opts [Integer] :count 推荐的记录数
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def recommend_fetch_with_http_info(ident, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecommendApi.recommend_fetch ...'
+      end
+      # verify the required parameter 'ident' is set
+      if @api_client.config.client_side_validation && ident.nil?
+        fail ArgumentError, "Missing the required parameter 'ident' when calling RecommendApi.recommend_fetch"
+      end
+      # resource path
+      local_var_path = '/recommend/{ident}'.sub('{' + 'ident' + '}', ident.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'condition'] = @api_client.build_collection_param(opts[:'condition'], :multi) if !opts[:'condition'].nil?
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'x-token'] = opts[:'x_token'] if !opts[:'x_token'].nil?
+      header_params[:'userid'] = opts[:'userid'] if !opts[:'userid'].nil?
+
+      # 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] || []
+      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: RecommendApi#recommend_fetch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 获取已定义的推荐列表
+    # @param app 应用标识
+    # @param [Hash] opts the optional parameters
+    # @return [Array<RecommendBean>]
+    def recommend_list(app, opts = {})
+      data, _status_code, _headers = recommend_list_with_http_info(app, opts)
+      data
+    end
+
+    # 获取已定义的推荐列表
+    # @param app 应用标识
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<RecommendBean>, Integer, Hash)>] Array<RecommendBean> data, response status code and response headers
+    def recommend_list_with_http_info(app, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecommendApi.recommend_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 RecommendApi.recommend_list"
+      end
+      # resource path
+      local_var_path = '/recommends/{app}'.sub('{' + 'app' + '}', app.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Array<RecommendBean>' 
+
+      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: RecommendApi#recommend_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 更新推荐信息
+    # @param body 推荐信息
+    # @param app 应用标识
+    # @param [Hash] opts the optional parameters
+    # @return [BOOLEAN]
+    def recommend_update(body, app, opts = {})
+      data, _status_code, _headers = recommend_update_with_http_info(body, app, opts)
+      data
+    end
+
+    # 更新推荐信息
+    # @param body 推荐信息
+    # @param app 应用标识
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BOOLEAN, Integer, Hash)>] BOOLEAN data, response status code and response headers
+    def recommend_update_with_http_info(body, app, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecommendApi.recommend_update ...'
+      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 RecommendApi.recommend_update"
+      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 RecommendApi.recommend_update"
+      end
+      # resource path
+      local_var_path = '/recommends/{app}'.sub('{' + 'app' + '}', app.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'])
+      # 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: RecommendApi#recommend_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end