Class: RecombeeApiClient::ListSeriesItems

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

Overview

Lists all the items present in the given series, sorted according to their time index values.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_optional

Constructor Details

#initialize(series_id) ⇒ ListSeriesItems

  • *Required arguments*

    • series_id -> ID of the series whose items are to be listed.



20
21
22
23
24
 
# File 'lib/recombee_api_client/api/list_series_items.rb', line 20

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

Instance Attribute Details

#ensure_https ⇒ Object

Returns the value of attribute ensure_https.



14
15
16
 
# File 'lib/recombee_api_client/api/list_series_items.rb', line 14

def ensure_https
  @ensure_https
end

#series_id ⇒ Object (readonly)

Returns the value of attribute series_id.



12
13
14
 
# File 'lib/recombee_api_client/api/list_series_items.rb', line 12

def series_id
  @series_id
end

#timeout ⇒ Object

Returns the value of attribute timeout.



13
14
15
 
# File 'lib/recombee_api_client/api/list_series_items.rb', line 13

def timeout
  @timeout
end

Instance Method Details

#body_parameters ⇒ Object

Values of body parameters as a Hash



32
33
34
35
 
# File 'lib/recombee_api_client/api/list_series_items.rb', line 32

def body_parameters
  p = Hash.new
  p
end

#method ⇒ Object

HTTP method



27
28
29
 
# File 'lib/recombee_api_client/api/list_series_items.rb', line 27

def method
  :get
end

#path ⇒ Object

Relative path to the endpoint



45
46
47
 
# File 'lib/recombee_api_client/api/list_series_items.rb', line 45

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

#query_parameters ⇒ Object

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



39
40
41
42
 
# File 'lib/recombee_api_client/api/list_series_items.rb', line 39

def query_parameters
  params = {}
  params
end