Class: RecombeeApiClient::AddItem

Inherits:
ApiRequest show all
Defined in:
lib/recombee_api_client/api/add_item.rb

Overview

Adds new item of the given itemId to the items catalog.

All the item properties for the newly created items are set to null.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_hash_to_camel_case

Constructor Details

#initialize(item_id) ⇒ AddItem

  • *Required arguments*

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



22
23
24
25
26
# File 'lib/recombee_api_client/api/add_item.rb', line 22

def initialize(item_id)
  @item_id = item_id
  @timeout = 3000
  @ensure_https = false
end

Instance Attribute Details

#ensure_httpsObject

Returns the value of attribute ensure_https.



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

def ensure_https
  @ensure_https
end

#item_idObject (readonly)

Returns the value of attribute item_id.



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

def item_id
  @item_id
end

#timeoutObject

Returns the value of attribute timeout.



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

def timeout
  @timeout
end

Instance Method Details

#body_parametersObject

Values of body parameters as a Hash



34
35
36
# File 'lib/recombee_api_client/api/add_item.rb', line 34

def body_parameters
  {}
end

#methodObject

HTTP method



29
30
31
# File 'lib/recombee_api_client/api/add_item.rb', line 29

def method
  :put
end

#pathObject

Relative path to the endpoint



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

def path
  "/{databaseId}/items/#{@item_id}"
end

#query_parametersObject

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



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

def query_parameters
  {}
end