Class: Io::Flow::V0::Models::Province

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

A subdivision/province/state within a country. These conform to the ISO 3166-2 standard for country subdivisions. See api.flow.io/reference/provinces

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Province

Returns a new instance of Province.



24270
24271
24272
24273
24274
24275
24276
24277
24278
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24270

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :iso_3166_2, :name, :country, :province_type], 'Province')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @iso_3166_2 = HttpClient::Preconditions.assert_class('iso_3166_2', opts.delete(:iso_3166_2), String)
  @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
  @country = HttpClient::Preconditions.assert_class('country', opts.delete(:country), String)
  @province_type = (x = opts.delete(:province_type); x.is_a?(::Io::Flow::V0::Models::ProvinceType) ? x : ::Io::Flow::V0::Models::ProvinceType.apply(x))
end

Instance Attribute Details

#country ⇒ Object (readonly)

Returns the value of attribute country.



24268
24269
24270
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24268

def country
  @country
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



24268
24269
24270
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24268

def id
  @id
end

#iso_3166_2 ⇒ Object (readonly)

Returns the value of attribute iso_3166_2.



24268
24269
24270
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24268

def iso_3166_2
  @iso_3166_2
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



24268
24269
24270
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24268

def name
  @name
end

#province_type ⇒ Object (readonly)

Returns the value of attribute province_type.



24268
24269
24270
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24268

def province_type
  @province_type
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



24284
24285
24286
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24284

def copy(incoming={})
  Province.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object 



24288
24289
24290
24291
24292
24293
24294
24295
24296
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24288

def to_hash
  {
    :id => id,
    :iso_3166_2 => iso_3166_2,
    :name => name,
    :country => country,
    :province_type => province_type.value
  }
end

#to_json ⇒ Object 



24280
24281
24282
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 24280

def to_json
  JSON.dump(to_hash)
end