class RecombeeApiClient::RemoveFromSeries

Removes an existing series item from the series.

Attributes

ensure_https[RW]
item_id[R]
item_type[R]
series_id[R]
time[R]
timeout[RW]

Public Class Methods

new(series_id, item_type, item_id, time) click to toggle source
  • *Required arguments*

    • series_id -> ID of the series from which a series item is to be removed.

    • item_type -> Type of the item to be removed.

    • item_id -> ID of the item iff `itemType` is `item`. ID of the series iff `itemType` is `series`.

    • time -> Time index of the item to be removed.

# File lib/recombee_api_client/api/remove_from_series.rb, line 23
def initialize(series_id, item_type, item_id, time)
  @series_id = series_id
  @item_type = item_type
  @item_id = item_id
  @time = time
  @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/remove_from_series.rb, line 38
def body_parameters
  p = Hash.new
  p
end
method() click to toggle source

HTTP method

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

Relative path to the endpoint

# File lib/recombee_api_client/api/remove_from_series.rb, line 54
def path
  "/{databaseId}/series/#{@series_id}/items/"
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/remove_from_series.rb, line 45
def query_parameters
  params = {}
  params['itemType'] = @item_type
  params['itemId'] = @item_id
  params['time'] = @time
  params
end