recombee_api_client 0.1.0

data/lib/recombee_api_client/api/delete_cart_addition.rb

@@ -0,0 +1,61 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes an existing cart addition uniquely specified by `userId`, `itemId`, and `timestamp`.
+  #
+  class DeleteCartAddition < ApiRequest
+    attr_reader :user_id, :item_id, :timestamp
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user who made the cart addition.
+  #   - +item_id+ -> ID of the item of which was added to cart.
+  #   - +timestamp+ -> Unix timestamp of the cart addition.
+  #
+    def initialize(user_id, item_id, timestamp)
+      @user_id = user_id
+      @item_id = item_id
+      @timestamp = timestamp
+      @timeout = 1000
+    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 path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params['userId'] = @user_id
+      params['itemId'] = @item_id
+      params['timestamp'] = @timestamp
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/cartadditions/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/cartadditions/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_detail_view.rb

@@ -0,0 +1,61 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes an existing detail view uniquely specified by (`userId`, `itemId`, and `timestamp`).
+  #
+  class DeleteDetailView < ApiRequest
+    attr_reader :user_id, :item_id, :timestamp
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user who made the detail view.
+  #   - +item_id+ -> ID of the item of which the details were viewed.
+  #   - +timestamp+ -> Unix timestamp of the detail view.
+  #
+    def initialize(user_id, item_id, timestamp)
+      @user_id = user_id
+      @item_id = item_id
+      @timestamp = timestamp
+      @timeout = 1000
+    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 path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params['userId'] = @user_id
+      params['itemId'] = @item_id
+      params['timestamp'] = @timestamp
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/detailviews/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/detailviews/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_group.rb

@@ -0,0 +1,56 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes the group of given `groupId` from the database.
+  #
+  #Deleting a group will only delete assignment of items to it, not the items themselves!
+  #
+  class DeleteGroup < ApiRequest
+    attr_reader :group_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +group_id+ -> ID of the group to be deleted.
+  #
+    def initialize(group_id)
+      @group_id = group_id
+      @timeout = 1000
+    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 path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/groups/#{@group_id}"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/groups/#{@group_id}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_item.rb

@@ -0,0 +1,58 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes an item of 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 an item becomes obsolete/no longer available, it is often 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.html) instead of deleting the item completely.
+  #
+  class DeleteItem < ApiRequest
+    attr_reader :item_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +item_id+ -> ID of the item to be deleted.
+  #
+    def initialize(item_id)
+      @item_id = item_id
+      @timeout = 1000
+    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 path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/items/#{@item_id}"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/items/#{@item_id}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_item_property.rb

@@ -0,0 +1,54 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #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
+  
+  ##
+  # * *Required arguments*
+  #   - +property_name+ -> Name of the property to be deleted.
+  #
+    def initialize(property_name)
+      @property_name = property_name
+      @timeout = 1000
+    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 path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/items/properties/#{@property_name}"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/items/properties/#{@property_name}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_purchase.rb

@@ -0,0 +1,61 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes an existing purchase uniquely specified by `userId`, `itemId`, and `timestamp`.
+  #
+  class DeletePurchase < ApiRequest
+    attr_reader :user_id, :item_id, :timestamp
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user who made the purchase.
+  #   - +item_id+ -> ID of the item of which was purchased.
+  #   - +timestamp+ -> Unix timestamp of the purchase.
+  #
+    def initialize(user_id, item_id, timestamp)
+      @user_id = user_id
+      @item_id = item_id
+      @timestamp = timestamp
+      @timeout = 1000
+    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 path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params['userId'] = @user_id
+      params['itemId'] = @item_id
+      params['timestamp'] = @timestamp
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/purchases/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/purchases/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_rating.rb

@@ -0,0 +1,61 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes an existing rating specified by (`userId`, `itemId`, `timestamp`) from the database.
+  #
+  class DeleteRating < ApiRequest
+    attr_reader :user_id, :item_id, :timestamp
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +user_id+ -> ID of the user who rated the item.
+  #   - +item_id+ -> ID of the item which was rated.
+  #   - +timestamp+ -> Unix timestamp of the rating.
+  #
+    def initialize(user_id, item_id, timestamp)
+      @user_id = user_id
+      @item_id = item_id
+      @timestamp = timestamp
+      @timeout = 1000
+    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 path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params['userId'] = @user_id
+      params['itemId'] = @item_id
+      params['timestamp'] = @timestamp
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/ratings/"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/ratings/?userId=#{@user_id}&itemId=#{@item_id}&timestamp=#{@timestamp}"
+      p
+    end
+  end
+end

data/lib/recombee_api_client/api/delete_series.rb

@@ -0,0 +1,56 @@
+#
+# This file is auto-generated, do not edit
+#
+
+module RecombeeApiClient
+  require_relative 'request'
+  require_relative '../errors'
+  
+  ##
+  #Deletes the series of given `seriesId` from the database.
+  #
+  #Deleting a series will only delete assignment of items to it, not the items themselves!
+  #
+  class DeleteSeries < ApiRequest
+    attr_reader :series_id
+    attr_accessor :timeout
+  
+  ##
+  # * *Required arguments*
+  #   - +series_id+ -> ID of the series to be deleted.
+  #
+    def initialize(series_id)
+      @series_id = series_id
+      @timeout = 1000
+    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 path parameters as a Hash.
+    # name of parameter => value of the parameter
+    def query_parameters
+      params = {}
+      params
+    end
+  
+    # Relative path to the endpoint
+    def basic_path
+      "/{databaseId}/series/#{@series_id}"
+    end
+  
+    # Relative path to the endpoint including query parameters
+    def path
+      p = "/{databaseId}/series/#{@series_id}"
+      p
+    end
+  end
+end