Class: Nfe::Address::City

Inherits:
Data
  • Object
show all
Defined in:
lib/nfe/resources/dto/addresses/address_lookup_response.rb,
sig/nfe/resources/dto/addresses/address_lookup_response.rbs

Overview

Nested value object for the IBGE city code/name pair returned inside an address item. Both members are optional and nil-tolerant.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ City

Returns a new instance of City.

Parameters:

  • code: (String, nil)
  • name: (String, nil) 


9
 
# File 'sig/nfe/resources/dto/addresses/address_lookup_response.rbs', line 9

def initialize: (code: String?, name: String?) -> void

Instance Attribute Details

#code ⇒ String? (readonly)

Returns the value of attribute code.

Returns:

  • (String, nil) 


4
5
6
 
# File 'sig/nfe/resources/dto/addresses/address_lookup_response.rbs', line 4

def code
  @code
end

#name ⇒ String? (readonly)

Returns the value of attribute name.

Returns:

  • (String, nil) 


5
6
7
 
# File 'sig/nfe/resources/dto/addresses/address_lookup_response.rbs', line 5

def name
  @name
end

Class Method Details

.from_api(payload) ⇒ Nfe::Address::City?

Returns nil when payload is nil.

Parameters:

  • payload (Hash, nil) —

    the city sub-object.

Returns:



30
31
32
33
34
35
36
37
 
# File 'lib/nfe/resources/dto/addresses/address_lookup_response.rb', line 30

def self.from_api(payload)
  return nil if payload.nil?

  new(
    code: payload["code"]&.to_s,
    name: payload["name"]
  )
end

.new ⇒ instance

Parameters:

  • code: (String, nil)
  • name: (String, nil)

Returns:

  • (instance) 


8
 
# File 'sig/nfe/resources/dto/addresses/address_lookup_response.rbs', line 8

def self.new: (code: String?, name: String?) -> instance