recombee_api_client 5.1.0 → 6.0.0

data/lib/recombee_api_client/api/delete_detail_view.rb

@@ -5,47 +5,45 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deletes an existing detail view uniquely specified by (`userId`, `itemId`, and `timestamp`) or all the detail views with the given `userId` and `itemId` if `timestamp` is omitted.
+  # Deletes an existing detail view uniquely specified by (`userId`, `itemId`, and `timestamp`) or all the detail views with the given `userId` and `itemId` if `timestamp` is omitted.
   #
   class DeleteDetailView < ApiRequest
     attr_reader :user_id, :item_id, :timestamp
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> ID of the user who made the detail view.
-  #   - +item_id+ -> ID of the item whose details were viewed.
-  #
-  # * *Optional arguments (given as hash optional)*
-  #   - +timestamp+ -> Unix timestamp of the detail view. If the `timestamp` is omitted, then all the detail views with the given `userId` and `itemId` are deleted.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user who made the detail view.
+    #   - +item_id+ -> ID of the item whose details were viewed.
+    #
+    # * *Optional arguments (given as hash optional)*
+    #   - +timestamp+ -> Unix timestamp of the detail view. If the `timestamp` is omitted, then all the detail views with the given `userId` and `itemId` are deleted.
+    #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @timestamp = optional['timestamp']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['timestamp'].include? par
       end
     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
@@ -53,12 +51,13 @@ module RecombeeApiClient
       params['userId'] = @user_id
       params['itemId'] = @item_id
       params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/detailviews/"
+      '/{databaseId}/detailviews/'
     end
   end
 end

data/lib/recombee_api_client/api/delete_item.rb

@@ -5,47 +5,44 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deletes an item of the given `itemId` from the catalog.
+  # Deletes an item of the given `itemId` from the catalog.
   #
-  #If there are any *purchases*, *ratings*, *bookmarks*, *cart additions*, or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
+  # If there are any *purchases*, *ratings*, *bookmarks*, *cart additions*, or *detail views* of the item present in the database, they will be deleted in cascade as well. Also, if the item is present in some *series*, it will be removed from all the *series* where present.
   #
-  #If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
+  # If an item becomes obsolete/no longer available, it is meaningful to keep it in the catalog (along with all the interaction data, which are very useful), and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
   #
   class DeleteItem < ApiRequest
     attr_reader :item_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +item_id+ -> ID of the item to be deleted.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +item_id+ -> ID of the item to be deleted.
+    #
     def initialize(item_id)
       @item_id = item_id
       @timeout = 3000
       @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}/items/#{@item_id}"

data/lib/recombee_api_client/api/delete_item_property.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deleting an item property is roughly equivalent to removing a column from the table of items.
+  # Deleting an item property is roughly equivalent to removing a column from the table of items.
   #
   class DeleteItemProperty < ApiRequest
     attr_reader :property_name
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +property_name+ -> Name of the property to be deleted.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +property_name+ -> Name of the property to be deleted.
+    #
     def initialize(property_name)
       @property_name = property_name
-      @timeout = 100000
+      @timeout = 100_000
       @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}/items/properties/#{@property_name}"

data/lib/recombee_api_client/api/delete_manual_reql_segment.rb

@@ -5,45 +5,42 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Delete a Segment from a Manual ReQL Segmentation.
+  # Delete a Segment from a Manual ReQL Segmentation.
   #
   class DeleteManualReqlSegment < ApiRequest
     attr_reader :segmentation_id, :segment_id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +segmentation_id+ -> ID of the Segmentation from which the Segment should be deleted
-  #   - +segment_id+ -> ID of the Segment that should be deleted
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +segmentation_id+ -> ID of the Segmentation from which the Segment should be deleted
+    #   - +segment_id+ -> ID of the Segment that should be deleted
+    #
     def initialize(segmentation_id, segment_id)
       @segmentation_id = segmentation_id
       @segment_id = segment_id
-      @timeout = 10000
+      @timeout = 10_000
       @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/manual-reql/#{@segmentation_id}/segments/#{@segment_id}"

data/lib/recombee_api_client/api/delete_more_items.rb

@@ -5,48 +5,47 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deletes all the items that pass the filter.
+  # Deletes all the items that pass the filter.
   #
-  #If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.
+  # If an item becomes obsolete/no longer available, it is meaningful to **keep it in the catalog** (along with all the interaction data, which are very useful) and **only exclude the item from recommendations**. In such a case, use [ReQL filter](https://docs.recombee.com/reql) instead of deleting the item completely.#
   class DeleteMoreItems < ApiRequest
     attr_reader :filter
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +filter+ -> A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +filter+ -> A [ReQL](https://docs.recombee.com/reql) expression, which returns `true` for the items that shall be updated.
+    #
     def initialize(filter)
       @filter = filter
-      @timeout = 100000
+      @timeout = 100_000
       @ensure_https = false
     end
-  
+
     # HTTP method
     def method
       :delete
     end
-  
+
     # Values of body parameters as a Hash
     def body_parameters
-      p = Hash.new
+      p = {}
       p['filter'] = @filter
+
       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}/more-items/"
+      '/{databaseId}/more-items/'
     end
   end
 end

data/lib/recombee_api_client/api/delete_purchase.rb

@@ -5,47 +5,45 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #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.
+  # 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
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +user_id+ -> ID of the user who made the purchase.
-  #   - +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 the given `userId` and `itemId` are deleted.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +user_id+ -> ID of the user who made the purchase.
+    #   - +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 the given `userId` and `itemId` are deleted.
+    #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @timestamp = optional['timestamp']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['timestamp'].include? par
       end
     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
@@ -53,12 +51,13 @@ module RecombeeApiClient
       params['userId'] = @user_id
       params['itemId'] = @item_id
       params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/purchases/"
+      '/{databaseId}/purchases/'
     end
   end
 end

data/lib/recombee_api_client/api/delete_rating.rb

@@ -5,47 +5,45 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #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.
+  # 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
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *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.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *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.
+    #
     def initialize(user_id, item_id, optional = {})
       @user_id = user_id
       @item_id = item_id
-      optional = normalize_optional(optional)
+      optional = normalize_hash_to_camel_case(optional)
       @timestamp = optional['timestamp']
       @optional = optional
       @timeout = 3000
       @ensure_https = false
       @optional.each do |par, _|
-        fail UnknownOptionalParameter.new(par) unless ["timestamp"].include? par
+        raise UnknownOptionalParameter.new(par) unless ['timestamp'].include? par
       end
     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
@@ -53,12 +51,13 @@ module RecombeeApiClient
       params['userId'] = @user_id
       params['itemId'] = @item_id
       params['timestamp'] = @optional['timestamp'] if @optional['timestamp']
+
       params
     end
-  
+
     # Relative path to the endpoint
     def path
-      "/{databaseId}/ratings/"
+      '/{databaseId}/ratings/'
     end
   end
 end

data/lib/recombee_api_client/api/delete_search_synonym.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Deletes synonym of the given `id`. This synonym is no longer taken into account in the [Search items](https://docs.recombee.com/api#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#search-items).
   #
   class DeleteSearchSynonym < ApiRequest
     attr_reader :id
-    attr_accessor :timeout
-    attr_accessor :ensure_https
-  
-  ##
-  # * *Required arguments*
-  #   - +id+ -> ID of the synonym that should be deleted.
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +id+ -> ID of the synonym that should be deleted.
+    #
     def initialize(id)
       @id = id
-      @timeout = 10000
+      @timeout = 10_000
       @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}/synonyms/items/#{@id}"

data/lib/recombee_api_client/api/delete_segmentation.rb

@@ -5,43 +5,40 @@
 module RecombeeApiClient
   require_relative 'request'
   require_relative '../errors'
-  
+
   ##
-  #Delete existing Segmentation.
+  # 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
-  #
+    attr_accessor :timeout, :ensure_https
+
+    ##
+    # * *Required arguments*
+    #   - +segmentation_id+ -> ID of the Segmentation that should be deleted
+    #
     def initialize(segmentation_id)
       @segmentation_id = segmentation_id
-      @timeout = 10000
+      @timeout = 10_000
       @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}"