class RecombeeApiClient::AddUserProperty
Adding a user property is somewhat equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
Attributes
Public Class Methods
Source
# File lib/recombee_api_client/api/add_user_property.rb, line 36 def initialize(property_name, type) @property_name = property_name @type = type @timeout = 100000 @ensure_https = false end
* *Required arguments* - +property_name+ -> Name of the user property to be created. Currently, the following names are reserved: `id`, `userid`, case-insensitively. Also, the length of the property name must not exceed 63 characters. - +type+ -> Value type of the user property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`.
-
‘int` - Signed integer number.
-
‘double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
-
‘string` - UTF-8 string.
-
‘boolean` - true / false
-
‘timestamp` - Value representing date and time.
-
‘set` - Set of strings.
Public Instance Methods
Source
# File lib/recombee_api_client/api/add_user_property.rb, line 49 def body_parameters p = Hash.new p end
Values of body parameters as a Hash
Source
# File lib/recombee_api_client/api/add_user_property.rb, line 44 def method :put end
HTTP method
Source
# File lib/recombee_api_client/api/add_user_property.rb, line 63 def path "/{databaseId}/users/properties/#{@property_name}" end
Relative path to the endpoint
Source
# File lib/recombee_api_client/api/add_user_property.rb, line 56 def query_parameters params = {} params['type'] = @type params end
Values of query parameters as a Hash. name of parameter => value of the parameter