recombee_api_client 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f21bfcff0358bddbb67867f07587e6debb8ae94
-  data.tar.gz: 4117139086e3e3f515a692f39d42df273e9cb1be
+  metadata.gz: f352c6ef8fe7deec30fcbe75a95f6fca0973d332
+  data.tar.gz: 99dc6053c007b41e86ebf06cf688740a8beeb5d9
 SHA512:
-  metadata.gz: c124f71c954aaada1ce7832713dcab6538dde62d35a8802e448cef1d3f9ac0c1cfe7276c5932b1341c8f26a0a5153c68e669d0c2c84f66161fdc2b2571de410f
-  data.tar.gz: e0aafaeb3454dfe99f2d3084baff1878d581c4c06192638ebaee5b758b1cf62ffd264f614efc342b29524b668ff7f933c193b133f30344a0fce5f51129107905
+  metadata.gz: d39f7acd6fffaa2a2de295959845b5444a240d31f5639314c05e6e23b4752fbe7d57bba46236e7e47b3dd8f17498cf748d54df3a88f6438158b96415d383bdbc
+  data.tar.gz: a57d0ca06bced0c0b5ccfcb384c308d0323e27637011e37d0a60824fab90ac4a26a4f550ddf1c273e0690cbb070a3070a294ec6593d7dbc5b099d9a1ced0b27a

data/lib/recombee_api_client.rb

@@ -18,7 +18,7 @@ module RecombeeApiClient
     include HTTParty
 
     BATCH_MAX_SIZE = 10000
-    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/1.4.0'}
+    USER_AGENT = {'User-Agent' => 'recombee-ruby-api-client/1.5.0'}
 
     ##
     #   - +account+ -> Name of your account at Recombee

data/lib/recombee_api_client/api/delete_view_portion.rb

@@ -0,0 +1,65 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #The view portions feature is currently experimental.
+  #
+  #Deletes an existing view portion specified by (`userId`, `itemId`, `sessionId`) from the database.
+  #
+  class DeleteViewPortion < ApiRequest
+    attr_reader :user_id, :item_id, :session_id
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user who rated the item.
+  #   - +item_id+ -> ID of the item which was rated.
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +sessionId+ -> Identifier of a session.
+  #
+    def initialize(user_id, item_id, optional = {})
+      @user_id = user_id
+      @item_id = item_id
+      @session_id = optional['sessionId']
+      @optional = optional
+      @timeout = 1000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["sessionId"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :delete
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params['userId'] = @user_id
+      params['itemId'] = @item_id
+      params['sessionId'] = @optional['sessionId'] if @optional['sessionId']
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/viewportions/"
+    end
+  end
+end

data/lib/recombee_api_client/api/list_item_view_portions.rb

@@ -0,0 +1,53 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #The view portions feature is currently experimental.
+  #
+  #List all the view portions of an item ever submitted by different users.
+  #
+  class ListItemViewPortions < ApiRequest
+    attr_reader :item_id
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +item_id+ -> ID of the item of which the view portions are to be listed.
+  #
+  #
+    def initialize(item_id)
+      @item_id = item_id
+      @timeout = 100000
+      @ensure_https = false
+    end
+  
+    # HTTP method
+    def method
+      :get
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/items/#{@item_id}/viewportions/"
+    end
+  end
+end

data/lib/recombee_api_client/api/list_user_view_portions.rb

@@ -0,0 +1,52 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #The view portions feature is currently experimental.
+  #
+  #List all the view portions ever submitted by a given user.
+  #
+  class ListUserViewPortions < ApiRequest
+    attr_reader :user_id
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user whose view portions are to be listed.
+  #
+    def initialize(user_id)
+      @user_id = user_id
+      @timeout = 100000
+      @ensure_https = false
+    end
+  
+    # HTTP method
+    def method
+      :get
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/users/#{@user_id}/viewportions/"
+    end
+  end
+end

data/lib/recombee_api_client/api/set_view_portion.rb

@@ -0,0 +1,75 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #The view portions feature is currently experimental.
+  #
+  #Sets viewed portion of an item (for example a video or article) by a user (at a session).
+  #If you send new request with the same (`userId`, `itemId`, `sessionId`), the portion gets updated.
+  #
+  class SetViewPortion < ApiRequest
+    attr_reader :user_id, :item_id, :session_id, :timestamp, :portion, :cascade_create
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> User who viewed a portion of the item
+  #   - +item_id+ -> Viewed item
+  #   - +portion+ -> Viewed portion of the item (number between 0.0 (viewed nothing) and 1.0 (viewed full item) ).
+  #
+  # * *Optional arguments (given as hash optional)*
+  #   - +sessionId+ -> Id of session in which the user viewed the item
+  #   - +timestamp+ -> UTC timestamp of the rating as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
+  #   - +cascadeCreate+ -> Sets whether the given user/item should be created if not present in the database.
+  #
+    def initialize(user_id, item_id, portion, optional = {})
+      @user_id = user_id
+      @item_id = item_id
+      @portion = portion
+      @session_id = optional['sessionId']
+      @timestamp = optional['timestamp']
+      @cascade_create = optional['cascadeCreate']
+      @optional = optional
+      @timeout = 1000
+      @ensure_https = false
+      @optional.each do |par, _|
+        fail UnknownOptionalParameter.new(par) unless ["sessionId","timestamp","cascadeCreate"].include? par
+      end
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p['userId'] = @user_id
+      p['itemId'] = @item_id
+      p['portion'] = @portion
+      p['sessionId'] = @optional['sessionId'] if @optional.include? 'sessionId'
+      p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
+      p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
+      p
+    end
+  
+    # Values of query parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/viewportions/"
+    end
+  end
+end

data/lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recombee_api_client
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Ondřej Fiedler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-25 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -115,6 +115,7 @@ files:
 - lib/recombee_api_client/api/delete_series.rb
 - lib/recombee_api_client/api/delete_user.rb
 - lib/recombee_api_client/api/delete_user_property.rb
+- lib/recombee_api_client/api/delete_view_portion.rb
 - lib/recombee_api_client/api/get_item_property_info.rb
 - lib/recombee_api_client/api/get_item_values.rb
 - lib/recombee_api_client/api/get_user_property_info.rb
@@ -130,6 +131,7 @@ files:
 - lib/recombee_api_client/api/list_item_properties.rb
 - lib/recombee_api_client/api/list_item_purchases.rb
 - lib/recombee_api_client/api/list_item_ratings.rb
+- lib/recombee_api_client/api/list_item_view_portions.rb
 - lib/recombee_api_client/api/list_items.rb
 - lib/recombee_api_client/api/list_series.rb
 - lib/recombee_api_client/api/list_series_items.rb
@@ -139,6 +141,7 @@ files:
 - lib/recombee_api_client/api/list_user_properties.rb
 - lib/recombee_api_client/api/list_user_purchases.rb
 - lib/recombee_api_client/api/list_user_ratings.rb
+- lib/recombee_api_client/api/list_user_view_portions.rb
 - lib/recombee_api_client/api/list_users.rb
 - lib/recombee_api_client/api/merge_users.rb
 - lib/recombee_api_client/api/remove_from_group.rb
@@ -148,6 +151,7 @@ files:
 - lib/recombee_api_client/api/set_item_values.rb
 - lib/recombee_api_client/api/set_user_values.rb
 - lib/recombee_api_client/api/set_values.rb
+- lib/recombee_api_client/api/set_view_portion.rb
 - lib/recombee_api_client/api/user_based_recommendation.rb
 - lib/recombee_api_client/errors.rb
 - lib/recombee_api_client/version.rb