class RecombeeApiClient::AddPurchase
Adds a purchase of the given item made by the given user.
Attributes
Public Class Methods
Source
# File lib/recombee_api_client/api/add_purchase.rb, line 31 def initialize(user_id, item_id, optional = {}) @user_id = user_id @item_id = item_id optional = normalize_optional(optional) @timestamp = optional['timestamp'] @cascade_create = optional['cascadeCreate'] @amount = optional['amount'] @price = optional['price'] @profit = optional['profit'] @recomm_id = optional['recommId'] @additional_data = optional['additionalData'] @optional = optional @timeout = 3000 @ensure_https = false @optional.each do |par, _| fail UnknownOptionalParameter.new(par) unless ["timestamp","cascadeCreate","amount","price","profit","recommId","additionalData"].include? par end end
-
*Required arguments*
-
*Optional arguments (given as hash optional)*
-
timestamp
-> UTC timestamp of the purchase 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. -
amount
-> Amount (number) of purchased items. The default is 1. For example, if ‘user-x` purchases two `item-y` during a single order (session…), the `amount` should equal 2. -
price
-> Price paid by the user for the item. If ‘amount` is greater than 1, the sum of prices of all the items should be given. -
profit
-> Your profit from the purchased item. The profit is natural in the e-commerce domain (for example, if ‘user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30) but is also applicable in other domains (for example, at a news company it may be income from a displayed advertisement on article page). If `amount` is greater than 1, the sum of profit of all the items should be given. -
recommId
-> If this purchase is based on a recommendation request, ‘recommId` is the id of the clicked recommendation. -
additionalData
-> A dictionary of additional data for the interaction.
-
Public Instance Methods
Source
# File lib/recombee_api_client/api/add_purchase.rb, line 56 def body_parameters p = Hash.new p['userId'] = @user_id p['itemId'] = @item_id p['timestamp'] = @optional['timestamp'] if @optional.include? 'timestamp' p['cascadeCreate'] = @optional['cascadeCreate'] if @optional.include? 'cascadeCreate' p['amount'] = @optional['amount'] if @optional.include? 'amount' p['price'] = @optional['price'] if @optional.include? 'price' p['profit'] = @optional['profit'] if @optional.include? 'profit' p['recommId'] = @optional['recommId'] if @optional.include? 'recommId' p['additionalData'] = @optional['additionalData'] if @optional.include? 'additionalData' p end
Values of body parameters as a Hash
Source
# File lib/recombee_api_client/api/add_purchase.rb, line 51 def method :post end
HTTP method
Source
# File lib/recombee_api_client/api/add_purchase.rb, line 78 def path "/{databaseId}/purchases/" end
Relative path to the endpoint
Source
# File lib/recombee_api_client/api/add_purchase.rb, line 72 def query_parameters params = {} params end
Values of query parameters as a Hash. name of parameter => value of the parameter