Class: RecombeeApiClient::DeleteRating

Inherits:
ApiRequest
  • Object
show all
Defined in:
lib/recombee_api_client/api/delete_rating.rb

Overview

Deletes an existing rating specified by (userId, itemId, timestamp) from the database or all the ratings with the given userId and itemId if timestamp is omitted.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_hash_to_camel_case

Constructor Details

#initialize(user_id, item_id, optional = {}) ⇒ DeleteRating

  • *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)*

    • timestamp -> Unix timestamp of the rating. If the timestamp is omitted, then all the ratings with the given userId and itemId are deleted.



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/recombee_api_client/api/delete_rating.rb', line 24

def initialize(user_id, item_id, optional = {})
  @user_id = user_id
  @item_id = item_id
  optional = normalize_hash_to_camel_case(optional)
  @timestamp = optional['timestamp']
  @optional = optional
  @timeout = 3000
  @ensure_https = false
  @optional.each do |par, _|
    raise UnknownOptionalParameter.new(par) unless ['timestamp'].include? par
  end
end

Instance Attribute Details

#ensure_https ⇒ Object

Returns the value of attribute ensure_https.



14
15
16
 
# File 'lib/recombee_api_client/api/delete_rating.rb', line 14

def ensure_https
  @ensure_https
end

#item_id ⇒ Object (readonly)

Returns the value of attribute item_id.



13
14
15
 
# File 'lib/recombee_api_client/api/delete_rating.rb', line 13

def item_id
  @item_id
end

#timeout ⇒ Object

Returns the value of attribute timeout.



14
15
16
 
# File 'lib/recombee_api_client/api/delete_rating.rb', line 14

def timeout
  @timeout
end

#timestamp ⇒ Object (readonly)

Returns the value of attribute timestamp.



13
14
15
 
# File 'lib/recombee_api_client/api/delete_rating.rb', line 13

def timestamp
  @timestamp
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



13
14
15
 
# File 'lib/recombee_api_client/api/delete_rating.rb', line 13

def user_id
  @user_id
end

Instance Method Details

#body_parameters ⇒ Object

Values of body parameters as a Hash



43
44
45
 
# File 'lib/recombee_api_client/api/delete_rating.rb', line 43

def body_parameters
  {}
end

#method ⇒ Object

HTTP method



38
39
40
 
# File 'lib/recombee_api_client/api/delete_rating.rb', line 38

def method
  :delete
end

#path ⇒ Object

Relative path to the endpoint



59
60
61
 
# File 'lib/recombee_api_client/api/delete_rating.rb', line 59

def path
  '/{databaseId}/ratings/'
end

#query_parameters ⇒ Object

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



49
50
51
52
53
54
55
56
 
# File 'lib/recombee_api_client/api/delete_rating.rb', line 49

def query_parameters
  params = {}
  params['userId'] = @user_id
  params['itemId'] = @item_id
  params['timestamp'] = @optional['timestamp'] if @optional['timestamp']

  params
end