Added support for user properties

Author: OndraFiedler

lib/recombee_api_client/api/add_user_property.rb

@@ -0,0 +1,55 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Adding an user property is somehow equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
+  #
+  class AddUserProperty < ApiRequest
+    attr_reader :property_name, :type
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *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`
+  #
+  #
+    def initialize(property_name, type)
+      @property_name = property_name
+      @type = type
+      @timeout = 1000
+      @ensure_https = false
+    end
+  
+    # HTTP method
+    def method
+      :put
+    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['type'] = @type
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/users/properties/#{@property_name}"
+    end
+  end
+end

lib/recombee_api_client/api/delete_user_property.rb

@@ -0,0 +1,50 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deleting an user property is roughly equivalent to removing a column from the table of users.
+  #
+  class DeleteUserProperty < ApiRequest
+    attr_reader :property_name
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +property_name+ -> Name of the property to be deleted.
+  #
+    def initialize(property_name)
+      @property_name = property_name
+      @timeout = 1000
+      @ensure_https = false
+    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
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/users/properties/#{@property_name}"
+    end
+  end
+end

lib/recombee_api_client/api/get_user_property_info.rb

@@ -0,0 +1,50 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Gets information about specified user property.
+  #
+  class GetUserPropertyInfo < ApiRequest
+    attr_reader :property_name
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +property_name+ -> Name of the property about which the information is to be retrieved.
+  #
+    def initialize(property_name)
+      @property_name = property_name
+      @timeout = 1000
+      @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/properties/#{@property_name}"
+    end
+  end
+end

lib/recombee_api_client/api/get_user_values.rb

@@ -0,0 +1,51 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Get all the current property values of a given user.
+  #
+  class GetUserValues < ApiRequest
+    attr_reader :user_id
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user properties of which are to be obtained.
+  #
+  #
+    def initialize(user_id)
+      @user_id = user_id
+      @timeout = 1000
+      @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}"
+    end
+  end
+end

lib/recombee_api_client/api/list_user_properties.rb

@@ -0,0 +1,47 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Gets the list of all the user properties in your database.
+  #
+  class ListUserProperties < ApiRequest
+  
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  #
+    def initialize()
+      @timeout = 1000
+      @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/properties/list/"
+    end
+  end
+end

lib/recombee_api_client/api/set_user_values.rb

@@ -0,0 +1,66 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Set/update (some) property values of a given user. The properties (columns) must be previously created by [Add user property](https://docs.recombee.com/api.html#add-user-property).
+  #
+  class SetUserValues < ApiRequest
+    attr_reader :user_id, :values
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user which will be modified.
+  #
+  #   - +values+ -> The values for the individual properties.
+  #
+  #Example of body:
+  #```
+  #  {
+  #    "country": "US",
+  #    "sex": "F",
+  #    "!cascadeCreate": true
+  #  }
+  #```
+  #
+  #Special parameter `!cascadeCreate` may be used. It indicates that the user of the given userId should be created if it does not exist in the database, as if the corresponding PUT method was used. Note the exclamation mark (!) at the beginning of the parameter's name to distinguish it from user property names.
+  #
+  #
+    def initialize(user_id, values)
+      @user_id = user_id
+      @values = values
+      @timeout = 1000
+      @ensure_https = false
+    end
+  
+    # HTTP method
+    def method
+      :post
+    end
+  
+    # Values of body parameters as a Hash
+    def body_parameters
+      p = Hash.new
+      p = p.merge(@values)
+      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}"
+    end
+  end
+end

lib/recombee_api_client/version.rb

@@ -1,3 +1,3 @@
 module RecombeeApiClient
-  VERSION = '1.2.5'
+  VERSION = '1.3'
 end

spec/api/add_user_property_spec.rb

@@ -0,0 +1,10 @@
+#
+# This file is auto-generated, do not edit
+#
+
+require 'spec_helper'
+require_relative "add_property"
+
+describe RecombeeApiClient::AddUserProperty do
+  it_behaves_like "add property"
+end

spec/api/delete_user_property_spec.rb

@@ -0,0 +1,10 @@
+#
+# This file is auto-generated, do not edit
+#
+
+require 'spec_helper'
+require_relative "delete_property"
+
+describe RecombeeApiClient::DeleteUserProperty do
+  it_behaves_like "delete property"
+end

spec/api/get_user_property_info_spec.rb

@@ -0,0 +1,10 @@
+#
+# This file is auto-generated, do not edit
+#
+
+require 'spec_helper'
+require_relative "get_property_info"
+
+describe RecombeeApiClient::GetUserPropertyInfo do
+  it_behaves_like "get property info"
+end