indexea_client 0.0.9

data/spec/api/recommend_api_spec.rb

@@ -0,0 +1,125 @@
+=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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for IndexeaClient::RecommendApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RecommendApi' do
+  before do
+    # run before each test
+    @instance = IndexeaClient::RecommendApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RecommendApi' do
+    it 'should create an instance of RecommendApi' do
+      expect(@instance).to be_instance_of(IndexeaClient::RecommendApi)
+    end
+  end
+
+  # unit tests for recommend_click
+  # 推荐结果点击行为收集
+  # 该接口主要用于记录用户对推荐结果的点击行为
+  # @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]
+  describe 'recommend_click test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for recommend_create
+  # 创建新的推荐
+  # @param body 推荐信息
+  # @param app 应用标识
+  # @param [Hash] opts the optional parameters
+  # @return [RecommendBean]
+  describe 'recommend_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for recommend_delete
+  # 删除推荐
+  # @param app 应用标识
+  # @param id 推荐编号
+  # @param [Hash] opts the optional parameters
+  # @return [BOOLEAN]
+  describe 'recommend_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for recommend_detail
+  # 获取推荐的记录列表
+  # @param ident 推荐定义的标识
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+  # @return [RecommendBean]
+  describe 'recommend_detail test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for recommend_fetch
+  # 获取推荐的记录列表
+  # @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 [Object]
+  describe 'recommend_fetch test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for recommend_list
+  # 获取已定义的推荐列表
+  # @param app 应用标识
+  # @param [Hash] opts the optional parameters
+  # @return [Array<RecommendBean>]
+  describe 'recommend_list test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for recommend_update
+  # 更新推荐信息
+  # @param body 推荐信息
+  # @param app 应用标识
+  # @param [Hash] opts the optional parameters
+  # @return [BOOLEAN]
+  describe 'recommend_update test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/records_api_spec.rb

@@ -0,0 +1,107 @@
+=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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for IndexeaClient::RecordsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RecordsApi' do
+  before do
+    # run before each test
+    @instance = IndexeaClient::RecordsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RecordsApi' do
+    it 'should create an instance of RecordsApi' do
+      expect(@instance).to be_instance_of(IndexeaClient::RecordsApi)
+    end
+  end
+
+  # unit tests for record_delete
+  # 删除记录数据
+  # @param app 应用标识
+  # @param index 索引编号
+  # @param _id 主键字段值
+  # @param [Hash] opts the optional parameters
+  # @return [BOOLEAN]
+  describe 'record_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for record_get
+  # 获取单条记录详情
+  # @param app 应用标识
+  # @param index 索引编号
+  # @param _id 记录 _id 值
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'record_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for record_list
+  # 获取索引记录列表
+  # @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<Object>]
+  describe 'record_list test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for record_push
+  # 插入或者更新索引数据
+  # @param body 
+  # @param app 应用标识
+  # @param index 索引编号
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :combine 更新策略：合并还是替换，combine&#x3D;true 为合并模式
+  # @return [BOOLEAN]
+  describe 'record_push test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for record_upload
+  # 上传记录
+  # @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 [Object]
+  describe 'record_upload test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/search_api_spec.rb

@@ -0,0 +1,220 @@
+=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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for IndexeaClient::SearchApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SearchApi' do
+  before do
+    # run before each test
+    @instance = IndexeaClient::SearchApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SearchApi' do
+    it 'should create an instance of SearchApi' do
+      expect(@instance).to be_instance_of(IndexeaClient::SearchApi)
+    end
+  end
+
+  # unit tests for search_click
+  # 搜索结果点击行为收集
+  # 该接口主要用于记录用户对搜索结果的点击行为
+  # @param widget 组件唯一标识
+  # @param action_id 对应搜索行为编号
+  # @param doc_id 对应索引中的内部记录编号
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+  # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+  # @return [BOOLEAN]
+  describe 'search_click test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_histories
+  # 获取当前搜索用户的最新搜索记录
+  # @param widget 组件唯一标识
+  # @param strategy 搜索记录策略
+  # @param query 指定关联查询的编号
+  # @param size 数量
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+  # @option opts [String] :x_token 如果要使用非公开的组件，需要组件作者授权
+  # @return [Array<String>]
+  describe 'search_histories test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_logs
+  # 获取搜索日志
+  # 该接口主要用于获取搜索明细
+  # @param app 应用标识
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<Integer>] :indices 只看指定索引
+  # @option opts [String] :scope 搜索范围
+  # @option opts [Integer] :widget 搜索组件
+  # @option opts [Integer] :query 指定查询
+  # @option opts [Integer] :recomm 推荐组件
+  # @option opts [Date] :start_date 统计起始日期
+  # @option opts [Date] :end_date 统计结束日期
+  # @option opts [Integer] :from 起始位置
+  # @option opts [Integer] :size 每页记录数量
+  # @return [Array<QueryActionBean>]
+  describe 'search_logs test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_query_histories
+  # 获取当前搜索用户的最新搜索记录
+  # @param query 查询唯一标识
+  # @param strategy 搜索记录策略
+  # @param size 数量
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+  # @option opts [String] :x_token 如果要使用非公开查询，需要组件作者授权
+  # @return [Array<String>]
+  describe 'search_query_histories test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_query_hot_words
+  # 获取查询相关热词
+  # @param query 查询标识
+  # @param scope 时间范围
+  # @param count 获取热词数量
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+  # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+  # @return [Array<SearchWord>]
+  describe 'search_query_hot_words test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_query_repeat_scroll
+  # 读取滚动搜索结果
+  # 先调用 search.queryScroll 获取 scroll_id 值以及第一批结果记录，然后使用 scroll_id 值调用该接口获取下一批结果记录，请注意该值的有效期是 1 分钟
+  # @param query 查询标识
+  # @param id scroll_id 值，该值的有效期是 1 分钟
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+  # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+  # @return [Object]
+  describe 'search_query_repeat_scroll test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_query_scroll
+  # 基于查询的滚动搜索
+  # 用于读取超过 10000 条记录的搜索结果，当需要读取大批量查询结果时请采用此接口获得 scroll_id 值，然后再用 POST 方法 queryRepeatScroll 读取剩余的其他结果，每批次的读取间隔不能超过 1 分钟
+  # @param query 查询标识
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+  # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+  # @option opts [Integer] :size 单次滚动的记录数
+  # @option opts [String] :q 搜索关键字
+  # @option opts [Hash<String, String>] :params 聚合参数
+  # @return [Object]
+  describe 'search_query_scroll test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_query_search
+  # 基于查询的公开搜索
+  # 该接口主要用于公开搜索，如果查询是公开的就不需要授权
+  # @param query 查询标识
+  # @param from 起始记录
+  # @param size 每页记录数量
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+  # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+  # @option opts [String] :q 搜索关键字
+  # @option opts [Hash<String, String>] :params 聚合参数
+  # @return [Object]
+  describe 'search_query_search test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_widget_auto_complete
+  # 基于组件的搜索词自动完成
+  # 该接口主要为搜索输入框提供自动完成的功能
+  # @param widget 组件唯一标识
+  # @param query 查询编号
+  # @param q 搜索关键字
+  # @param size 数量
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+  # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+  # @return [Array<AutoCompleteItem>]
+  describe 'search_widget_auto_complete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_widget_hot_words
+  # 获取组件搜索的相关热词
+  # @param widget 组件唯一标识
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+  # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+  # @option opts [Integer] :query 查询编号
+  # @option opts [String] :scope 时间范围
+  # @option opts [Integer] :count 获取热词数量
+  # @return [Array<SearchWord>]
+  describe 'search_widget_hot_words test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for search_widget_search
+  # 基于组件的公开搜索
+  # 该接口主要为UI组件提供公开搜索
+  # @param widget 组件唯一标识
+  # @param query 查询编号
+  # @param from 起始记录
+  # @param size 每页记录数量, 如果值小于0则使用预设值的记录数
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :userid 搜索者的唯一标识，该标识由搜索前端生成，长度不超过64
+  # @option opts [String] :x_token 如果要使用非发布的组件，需要组件作者授权
+  # @option opts [String] :original 搜索动作的延续，在 Web 组件中一边输入即时搜索时，使用的是同一个 original，original 值等于第一个搜索动作产生结果中的 action 值
+  # @option opts [String] :q 搜索关键字
+  # @option opts [Hash<String, String>] :params 聚合参数
+  # @return [Object]
+  describe 'search_widget_search test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/stats_api_spec.rb

@@ -0,0 +1,99 @@
+=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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for IndexeaClient::StatsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'StatsApi' do
+  before do
+    # run before each test
+    @instance = IndexeaClient::StatsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of StatsApi' do
+    it 'should create an instance of StatsApi' do
+      expect(@instance).to be_instance_of(IndexeaClient::StatsApi)
+    end
+  end
+
+  # unit tests for stats_recomms
+  # 获取推荐日志的汇总信息
+  # @param app 应用标识
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :recomm 统计指定推荐
+  # @option opts [Date] :start_date 统计起始日期
+  # @option opts [Date] :end_date 统计结束日期
+  # @option opts [String] :interval 统计间隔 - 日、周、月、季度、年
+  # @return [Object]
+  describe 'stats_recomms test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for stats_searchs
+  # 获取搜索日志的汇总信息
+  # @param app 应用标识
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :index 统计指定索引
+  # @option opts [Integer] :query 统计指定查询
+  # @option opts [Integer] :widget 统计指定组件
+  # @option opts [Date] :start_date 统计起始日期
+  # @option opts [Date] :end_date 统计结束日期
+  # @option opts [String] :interval 统计间隔 - 日、周、月、季度、年
+  # @return [Object]
+  describe 'stats_searchs test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for stats_top_clicks
+  # 获取点击排行榜
+  # @param app 应用标识
+  # @param size 排行榜大小
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :index 统计指定索引
+  # @option opts [Integer] :query 统计指定查询
+  # @option opts [Integer] :recomm 统计指定推荐组件
+  # @option opts [Integer] :widget 统计指定组件
+  # @option opts [Date] :start_date 统计起始日期
+  # @option opts [Date] :end_date 统计结束日期
+  # @return [Array<Object>]
+  describe 'stats_top_clicks test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for stats_widgets
+  # 获取模板与组件的统计信息
+  # @param app 应用标识
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :widget 统计指定模板或组件
+  # @option opts [Date] :start_date 统计起始日期
+  # @option opts [Date] :end_date 统计结束日期
+  # @option opts [String] :interval 统计间隔 - 日、周、月、季度、年
+  # @return [Object]
+  describe 'stats_widgets test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end