Class: LockstepSdk::StateModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/state_model.rb

Overview

State model for ISO-3166-2

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ StateModel

Initialize the StateModel using the provided prototype



25
26
27
28
29
 
# File 'lib/lockstep_sdk/models/state_model.rb', line 25

def initialize(params = {})
    @name = params.dig(:name)
    @alpha2 = params.dig(:alpha2)
    @aliases = params.dig(:aliases)
end

Instance Attribute Details

#aliases ⇒ String

Returns A different name for a state.

Returns:

  • (String) —

    A different name for a state



41
42
43
 
# File 'lib/lockstep_sdk/models/state_model.rb', line 41

def aliases
  @aliases
end

#alpha2 ⇒ String

Returns 2 letter alphabetic code for the given state.

Returns:

  • (String) —

    2 letter alphabetic code for the given state



37
38
39
 
# File 'lib/lockstep_sdk/models/state_model.rb', line 37

def alpha2
  @alpha2
end

#name ⇒ String

Returns Name of the state.

Returns:

  • (String) —

    Name of the state



33
34
35
 
# File 'lib/lockstep_sdk/models/state_model.rb', line 33

def name
  @name
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



45
46
47
48
49
50
51
 
# File 'lib/lockstep_sdk/models/state_model.rb', line 45

def as_json(options={})
    {
        'name' => @name,
        'alpha2' => @alpha2,
        'aliases' => @aliases,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



55
56
57
 
# File 'lib/lockstep_sdk/models/state_model.rb', line 55

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end