Class: RecombeeApiClient::DeleteSeries

Inherits:
ApiRequest
  • Object
show all
Defined in:
lib/recombee_api_client/api/delete_series.rb

Overview

Deletes the series of given ‘seriesId` from the database.

Deleting a series will only delete assignment of items to it, not the items themselves!

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_optional

Constructor Details

#initialize(series_id) ⇒ DeleteSeries

  • *Required arguments*

    • series_id -> ID of the series to be deleted.



23
24
25
26
27
 
# File 'lib/recombee_api_client/api/delete_series.rb', line 23

def initialize(series_id)
  @series_id = series_id
  @timeout = 1000
  @ensure_https = false
end

Instance Attribute Details

#ensure_https ⇒ Object

Returns the value of attribute ensure_https.



17
18
19
 
# File 'lib/recombee_api_client/api/delete_series.rb', line 17

def ensure_https
  @ensure_https
end

#series_id ⇒ Object (readonly)

Returns the value of attribute series_id.



15
16
17
 
# File 'lib/recombee_api_client/api/delete_series.rb', line 15

def series_id
  @series_id
end

#timeout ⇒ Object

Returns the value of attribute timeout.



16
17
18
 
# File 'lib/recombee_api_client/api/delete_series.rb', line 16

def timeout
  @timeout
end

Instance Method Details

#body_parameters ⇒ Object

Values of body parameters as a Hash



35
36
37
38
 
# File 'lib/recombee_api_client/api/delete_series.rb', line 35

def body_parameters
  p = Hash.new
  p
end

#method ⇒ Object

HTTP method



30
31
32
 
# File 'lib/recombee_api_client/api/delete_series.rb', line 30

def method
  :delete
end

#path ⇒ Object

Relative path to the endpoint



48
49
50
 
# File 'lib/recombee_api_client/api/delete_series.rb', line 48

def path
  "/{databaseId}/series/#{@series_id}"
end

#query_parameters ⇒ Object

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



42
43
44
45
 
# File 'lib/recombee_api_client/api/delete_series.rb', line 42

def query_parameters
  params = {}
  params
end