class RecombeeApiClient::AddDetailView

Adds a detail view of a given item made by a given user.

Attributes

cascade_create[R]
duration[R]
ensure_https[RW]
item_id[R]
recomm_id[R]
timeout[RW]
timestamp[R]
user_id[R]

Public Class Methods

new(user_id, item_id, optional = {}) click to toggle source
  • *Required arguments*

    • user_id -> User who viewed the item

    • item_id -> Viewed item

  • *Optional arguments (given as hash optional)*

    • timestamp -> UTC timestamp of the view as ISO8601-1 pattern or UTC epoch time. The default value is the current time.

    • duration -> Duration of the view

    • cascadeCreate -> Sets whether the given user/item should be created if not present in the database.

    • recommId -> If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.

# File lib/recombee_api_client/api/add_detail_view.rb, line 28
def initialize(user_id, item_id, optional = {})
  @user_id = user_id
  @item_id = item_id
  optional = normalize_optional(optional)
  @timestamp = optional['timestamp']
  @duration = optional['duration']
  @cascade_create = optional['cascadeCreate']
  @recomm_id = optional['recommId']
  @optional = optional
  @timeout = 1000
  @ensure_https = false
  @optional.each do |par, _|
    fail UnknownOptionalParameter.new(par) unless ["timestamp","duration","cascadeCreate","recommId"].include? par
  end
end

Public Instance Methods

body_parameters() click to toggle source

Values of body parameters as a Hash

# File lib/recombee_api_client/api/add_detail_view.rb, line 50
def body_parameters
  p = Hash.new
  p['userId'] = @user_id
  p['itemId'] = @item_id
  p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp'
  p['duration'] = @optional['duration'] if @optional.include? 'duration'
  p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate'
  p['recommId'] = @optional['recommId'] if @optional.include? 'recommId'
  p
end
method() click to toggle source

HTTP method

# File lib/recombee_api_client/api/add_detail_view.rb, line 45
def method
  :post
end
path() click to toggle source

Relative path to the endpoint

# File lib/recombee_api_client/api/add_detail_view.rb, line 69
def path
  "/{databaseId}/detailviews/"
end
query_parameters() click to toggle source

Values of query parameters as a Hash. name of parameter => value of the parameter

# File lib/recombee_api_client/api/add_detail_view.rb, line 63
def query_parameters
  params = {}
  params
end