Class: RecombeeApiClient::DeleteSearchSynonym

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

Overview

Deletes synonym of the given ‘id`. This synonym is no longer taken into account in the [Search items](docs.recombee.com/api#search-items).

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HashNormalizer

#camelize, #normalize_hash_to_camel_case

Constructor Details

#initialize(id) ⇒ DeleteSearchSynonym

  • *Required arguments*

    • id -> ID of the synonym that should be deleted.



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

def initialize(id)
  @id = id
  @timeout = 10_000
  @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/delete_search_synonym.rb', line 14

def ensure_https
  @ensure_https
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#timeout ⇒ Object

Returns the value of attribute timeout.



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

def timeout
  @timeout
end

Instance Method Details

#body_parameters ⇒ Object

Values of body parameters as a Hash



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

def body_parameters
  {}
end

#method ⇒ Object

HTTP method



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

def method
  :delete
end

#path ⇒ Object

Relative path to the endpoint



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

def path
  "/{databaseId}/synonyms/items/#{@id}"
end

#query_parameters ⇒ Object

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



38
39
40
 
# File 'lib/recombee_api_client/api/delete_search_synonym.rb', line 38

def query_parameters
  {}
end