Class: Algolia::Analytics::OrderBy

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/analytics/order_by.rb

Constant Summary collapse

SEARCH_COUNT = 
"searchCount".freeze
CLICK_THROUGH_RATE = 
"clickThroughRate".freeze
CONVERSION_RATE = 
"conversionRate".freeze
AVERAGE_CLICK_POSITION = 
"averageClickPosition".freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.all_vars ⇒ Object 



14
15
16
 
# File 'lib/algolia/models/analytics/order_by.rb', line 14

def self.all_vars
  @all_vars ||= [SEARCH_COUNT, CLICK_THROUGH_RATE, CONVERSION_RATE, AVERAGE_CLICK_POSITION].freeze
end

.build_from_hash(value) ⇒ String

Builds the enum from string

Parameters:

  • The (String) —

    enum value in the form of the string

Returns:

  • (String) —

    The enum value



21
22
23
 
# File 'lib/algolia/models/analytics/order_by.rb', line 21

def self.build_from_hash(value)
  new.build_from_hash(value)
end

Instance Method Details

#build_from_hash(value) ⇒ String

Builds the enum from string

Parameters:

  • The (String) —

    enum value in the form of the string

Returns:

  • (String) —

    The enum value



28
29
30
31
 
# File 'lib/algolia/models/analytics/order_by.rb', line 28

def build_from_hash(value)
  return value if OrderBy.all_vars.include?(value)
  raise "Invalid ENUM value #{value} for class #OrderBy"
end