class RecombeeApiClient::DeleteItem

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](docs.recombee.com/reql.html) instead of deleting the item completely.

Attributes

ensure_https[RW]
item_id[R]
timeout[RW]

Public Class Methods

new(item_id) click to toggle source
  • *Required arguments*

    • item_id -> ID of the item to be deleted.

# File lib/recombee_api_client/api/delete_item.rb, line 25
def initialize(item_id)
  @item_id = item_id
  @timeout = 1000
  @ensure_https = false
end

Public Instance Methods

body_parameters() click to toggle source

Values of body parameters as a Hash

# File lib/recombee_api_client/api/delete_item.rb, line 37
def body_parameters
  p = Hash.new
  p
end
method() click to toggle source

HTTP method

# File lib/recombee_api_client/api/delete_item.rb, line 32
def method
  :delete
end
path() click to toggle source

Relative path to the endpoint

# File lib/recombee_api_client/api/delete_item.rb, line 50
def path
  "/{databaseId}/items/#{@item_id}"
end
query_parameters() click to toggle source

Values of query parameters as a Hash. name of parameter => value of the parameter

# File lib/recombee_api_client/api/delete_item.rb, line 44
def query_parameters
  params = {}
  params
end