class RecombeeApiClient::ListSearchSynonyms

Gives the list of synonyms defined in the database.

Attributes

count[R]
ensure_https[RW]
offset[R]
timeout[RW]

Public Class Methods

new(optional = {}) click to toggle source
  • *Optional arguments (given as hash optional)*

    • count -> The number of synonyms to be listed.

    • offset -> Specifies the number of synonyms to skip (ordered by `term`).

# File lib/recombee_api_client/api/list_search_synonyms.rb, line 22
def initialize(optional = {})
  optional = normalize_optional(optional)
  @count = optional['count']
  @offset = optional['offset']
  @optional = optional
  @timeout = 100000
  @ensure_https = false
  @optional.each do |par, _|
    fail UnknownOptionalParameter.new(par) unless ["count","offset"].include? par
  end
end

Public Instance Methods

body_parameters() click to toggle source

Values of body parameters as a Hash

# File lib/recombee_api_client/api/list_search_synonyms.rb, line 40
def body_parameters
  p = Hash.new
  p
end
method() click to toggle source

HTTP method

# File lib/recombee_api_client/api/list_search_synonyms.rb, line 35
def method
  :get
end
path() click to toggle source

Relative path to the endpoint

# File lib/recombee_api_client/api/list_search_synonyms.rb, line 55
def path
  "/{databaseId}/synonyms/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/list_search_synonyms.rb, line 47
def query_parameters
  params = {}
  params['count'] = @optional['count'] if @optional['count']
  params['offset'] = @optional['offset'] if @optional['offset']
  params
end