recombee_api_client 3.2.0 → 4.1.0

data/lib/recombee_api_client/api/delete_purchase.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes an existing purchase uniquely specified by `userId`, `itemId`, and `timestamp` or all the purchases with given `userId` and `itemId` if `timestamp` is omitted.
+  #Deletes an existing purchase uniquely specified by `userId`, `itemId`, and `timestamp` or all the purchases with the given `userId` and `itemId` if `timestamp` is omitted.
   #
   class DeletePurchase < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
@@ -17,10 +17,10 @@ module RecombeeApiClient
   ##
   # * *Required arguments*
   #   - +user_id+ -> ID of the user who made the purchase.
-  #   - +item_id+ -> ID of the item of which was purchased.
+  #   - +item_id+ -> ID of the item which was purchased.
   #
   # * *Optional arguments (given as hash optional)*
-  #   - +timestamp+ -> Unix timestamp of the purchase. If the `timestamp` is omitted, then all the purchases with given `userId` and `itemId` are deleted.
+  #   - +timestamp+ -> Unix timestamp of the purchase. If the `timestamp` is omitted, then all the purchases with the given `userId` and `itemId` are deleted.
   #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id

data/lib/recombee_api_client/api/delete_rating.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes an existing rating specified by (`userId`, `itemId`, `timestamp`) from the database or all the ratings with given `userId` and `itemId` if `timestamp` is omitted.
+  #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.
   #
   class DeleteRating < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
@@ -20,7 +20,7 @@ module RecombeeApiClient
   #   - +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 given `userId` and `itemId` are deleted.
+  #   - +timestamp+ -> Unix timestamp of the rating. If the `timestamp` is omitted, then all the ratings with the given `userId` and `itemId` are deleted.
   #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id

data/lib/recombee_api_client/api/delete_search_synonym.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes synonym of given `id` and this synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
+  #Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api.html#search-items).
   #
   class DeleteSearchSynonym < ApiRequest
     attr_reader :id

data/lib/recombee_api_client/api/delete_segmentation.rb

@@ -0,0 +1,50 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Delete existing Segmentation.
+  #
+  class DeleteSegmentation < ApiRequest
+    attr_reader :segmentation_id
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +segmentation_id+ -> ID of the Segmentation that should be deleted
+  #
+    def initialize(segmentation_id)
+      @segmentation_id = segmentation_id
+      @timeout = 10000
+      @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}/segmentations/#{@segmentation_id}"
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_series.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes the series of given `seriesId` from the database.
+  #Deletes the series of the given `seriesId` from the database.
   #
   #Deleting a series will only delete assignment of items to it, not the items themselves!
   #

data/lib/recombee_api_client/api/delete_user.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deletes a user of given *userId* from the database.
+  #Deletes a user of the given *userId* from the database.
   #
   #If there are any purchases, ratings, bookmarks, cart additions or detail views made by the user present in the database, they will be deleted in cascade as well.
   #
@@ -18,7 +18,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +user_id+ -> ID of the user to be added.
+  #   - +user_id+ -> ID of the user to be deleted.
   #
     def initialize(user_id)
       @user_id = user_id

data/lib/recombee_api_client/api/delete_user_property.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Deleting an user property is roughly equivalent to removing a column from the table of users.
+  #Deleting a user property is roughly equivalent to removing a column from the table of users.
   #
   class DeleteUserProperty < ApiRequest
     attr_reader :property_name

data/lib/recombee_api_client/api/get_item_values.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Get all the current property values of a given item.
+  #Gets all the current property values of the given item.
   #
   class GetItemValues < ApiRequest
     attr_reader :item_id
@@ -16,7 +16,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +item_id+ -> ID of the item properties of which are to be obtained.
+  #   - +item_id+ -> ID of the item whose properties are to be obtained.
   #
   #
     def initialize(item_id)

data/lib/recombee_api_client/api/get_segmentation.rb

@@ -0,0 +1,50 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Get existing Segmentation.
+  #
+  class GetSegmentation < ApiRequest
+    attr_reader :segmentation_id
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +segmentation_id+ -> ID of the Segmentation that should be returned
+  #
+    def initialize(segmentation_id)
+      @segmentation_id = segmentation_id
+      @timeout = 10000
+      @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}/segmentations/list/#{@segmentation_id}"
+    end
+  end
+end

data/lib/recombee_api_client/api/get_user_values.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Get all the current property values of a given user.
+  #Gets all the current property values of the given user.
   #
   class GetUserValues < ApiRequest
     attr_reader :user_id
@@ -16,7 +16,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +user_id+ -> ID of the user properties of which are to be obtained.
+  #   - +user_id+ -> ID of the user whose properties are to be obtained.
   #
   #
     def initialize(user_id)

data/lib/recombee_api_client/api/insert_to_group.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Inserts an existing item/group into group of given `groupId`.
+  #Inserts an existing item/group into a group of the given `groupId`.
   #
   class InsertToGroup < ApiRequest
     attr_reader :group_id, :item_type, :item_id, :cascade_create
@@ -21,7 +21,7 @@ module RecombeeApiClient
   #   - +item_id+ -> ID of the item iff `itemType` is `item`. ID of the group iff `itemType` is `group`.
   #
   # * *Optional arguments (given as hash optional)*
-  #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.
+  #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `groupId` and the `groupId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. Either items or group may be created if not present in the database.
   #
     def initialize(group_id, item_type, item_id, optional = {})
       @group_id = group_id

data/lib/recombee_api_client/api/insert_to_series.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Inserts an existing item/series into series of given seriesId at position determined by time.
+  #Inserts an existing item/series into a series of the given seriesId at a position determined by time.
   #
   class InsertToSeries < ApiRequest
     attr_reader :series_id, :item_type, :item_id, :time, :cascade_create
@@ -22,7 +22,7 @@ module RecombeeApiClient
   #   - +time+ -> Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.
   #
   # * *Optional arguments (given as hash optional)*
-  #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as is corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.
+  #   - +cascadeCreate+ -> Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the `seriesId` and the `itemId`. If `cascadeCreate` is set to true, the behavior also depends on the `itemType`. Either item or series may be created if not present in the database.
   #
     def initialize(series_id, item_type, item_id, time, optional = {})
       @series_id = series_id

data/lib/recombee_api_client/api/list_group_items.rb

@@ -15,7 +15,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +group_id+ -> ID of the group items of which are to be listed.
+  #   - +group_id+ -> ID of the group whose items are to be listed.
   #
     def initialize(group_id)
       @group_id = group_id

data/lib/recombee_api_client/api/list_item_bookmarks.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the ever-made bookmarks of a given item.
+  #Lists all the ever-made bookmarks of the given item.
   class ListItemBookmarks < ApiRequest
     attr_reader :item_id
     attr_accessor :timeout
@@ -15,7 +15,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +item_id+ -> ID of the item of which the bookmarks are to be listed.
+  #   - +item_id+ -> ID of the item whose bookmarks are to be listed.
   #
   #
     def initialize(item_id)

data/lib/recombee_api_client/api/list_item_cart_additions.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the ever-made cart addition of a given item.
+  #Lists all the ever-made cart additions of the given item.
   class ListItemCartAdditions < ApiRequest
     attr_reader :item_id
     attr_accessor :timeout
@@ -15,7 +15,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +item_id+ -> ID of the item of which the cart addition are to be listed.
+  #   - +item_id+ -> ID of the item whose cart additions are to be listed.
   #
   #
     def initialize(item_id)

data/lib/recombee_api_client/api/list_item_detail_views.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the detail views of a given item ever made by different users.
+  #Lists all the detail views of the given item ever made by different users.
   class ListItemDetailViews < ApiRequest
     attr_reader :item_id
     attr_accessor :timeout
@@ -15,7 +15,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +item_id+ -> ID of the item of which the detail views are to be listed.
+  #   - +item_id+ -> ID of the item whose detail views are to be listed.
   #
   #
     def initialize(item_id)

data/lib/recombee_api_client/api/list_item_purchases.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the ever-made purchases of a given item.
+  #Lists all the ever-made purchases of the given item.
   class ListItemPurchases < ApiRequest
     attr_reader :item_id
     attr_accessor :timeout
@@ -15,7 +15,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +item_id+ -> ID of the item of which the pucrhases are to be listed.
+  #   - +item_id+ -> ID of the item whose purchases are to be listed.
   #
   #
     def initialize(item_id)

data/lib/recombee_api_client/api/list_item_ratings.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the ratings of an item ever submitted by different users.
+  #Lists all the ratings of an item ever submitted by different users.
   class ListItemRatings < ApiRequest
     attr_reader :item_id
     attr_accessor :timeout
@@ -15,7 +15,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +item_id+ -> ID of the item of which the ratings are to be listed.
+  #   - +item_id+ -> ID of the item whose ratings are to be listed.
   #
   #
     def initialize(item_id)

data/lib/recombee_api_client/api/list_item_view_portions.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the view portions of an item ever submitted by different users.
+  #Lists all the view portions of an item ever submitted by different users.
   #
   class ListItemViewPortions < ApiRequest
     attr_reader :item_id
@@ -16,7 +16,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +item_id+ -> ID of the item of which the view portions are to be listed.
+  #   - +item_id+ -> ID of the item whose view portions are to be listed.
   #
   #
     def initialize(item_id)

data/lib/recombee_api_client/api/list_items.rb

@@ -41,7 +41,7 @@ module RecombeeApiClient
   #  ]
   #```
   #
-  #   - +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
+  #   - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
   #
   #Example response for `includedProperties=description,price`:
   #```

data/lib/recombee_api_client/api/list_segmentations.rb

@@ -0,0 +1,51 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Return all existing items Segmentations.
+  #
+  class ListSegmentations < ApiRequest
+    attr_reader :source_type
+    attr_accessor :timeout
+    attr_accessor :ensure_https
+  
+  ##
+  # * *Required arguments*
+  #   - +source_type+ -> List Segmentations based on a particular type of data. Currently only `items` are supported.
+  #
+    def initialize(source_type)
+      @source_type = source_type
+      @timeout = 10000
+      @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['sourceType'] = @source_type
+      params
+    end
+  
+    # Relative path to the endpoint
+    def path
+      "/{databaseId}/segmentations/list/"
+    end
+  end
+end

data/lib/recombee_api_client/api/list_series_items.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the items present in the given series, sorted according to their time index values.
+  #Lists all the items present in the given series, sorted according to their time index values.
   class ListSeriesItems < ApiRequest
     attr_reader :series_id
     attr_accessor :timeout
@@ -15,7 +15,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +series_id+ -> ID of the series items of which are to be listed.
+  #   - +series_id+ -> ID of the series whose items are to be listed.
   #
     def initialize(series_id)
       @series_id = series_id

data/lib/recombee_api_client/api/list_user_bookmarks.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the bookmarks ever made by a given user.
+  #Lists all the bookmarks ever made by the given user.
   class ListUserBookmarks < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout

data/lib/recombee_api_client/api/list_user_cart_additions.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the cart additions ever made by a given user.
+  #Lists all the cart additions ever made by the given user.
   class ListUserCartAdditions < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout

data/lib/recombee_api_client/api/list_user_detail_views.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Lists all the detail views of different items ever made by a given user.
+  #Lists all the detail views of different items ever made by the given user.
   class ListUserDetailViews < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout

data/lib/recombee_api_client/api/list_user_purchases.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the purchases ever made by a given user.
+  #Lists all the purchases ever made by the given user.
   class ListUserPurchases < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout

data/lib/recombee_api_client/api/list_user_ratings.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the ratings ever submitted by a given user.
+  #Lists all the ratings ever submitted by the given user.
   class ListUserRatings < ApiRequest
     attr_reader :user_id
     attr_accessor :timeout

data/lib/recombee_api_client/api/list_user_view_portions.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #List all the view portions ever submitted by a given user.
+  #Lists all the view portions ever submitted by the given user.
   #
   class ListUserViewPortions < ApiRequest
     attr_reader :user_id

data/lib/recombee_api_client/api/list_users.rb

@@ -37,7 +37,7 @@ module RecombeeApiClient
   #  ]
   #```
   #
-  #   - +includedProperties+ -> Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. 
+  #   - +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
   #
   #Example response for `includedProperties=country`:
   #```

data/lib/recombee_api_client/api/merge_users.rb

@@ -7,7 +7,7 @@ module RecombeeApiClient
   require_relative '../errors'
   
   ##
-  #Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.
+  #Merges interactions (purchases, ratings, bookmarks, detail views ...) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two becomes desirable.
   #
   #
   #Merging happens between two users referred to as the *target* and the *source*. After the merge, all the interactions of the source user are attributed to the target user, and the source user is **deleted**.
@@ -19,7 +19,7 @@ module RecombeeApiClient
   
   ##
   # * *Required arguments*
-  #   - +target_user_id+ -> ID of the targer user.
+  #   - +target_user_id+ -> ID of the target user.
   #   - +source_user_id+ -> ID of the source user.
   #
   # * *Optional arguments (given as hash optional)*