Class: Nfe::Generated::ConsultaDfeDistribuicaoV2::MetadataResource

Inherits:
Data
  • Object
show all
Defined in:
lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb,
sig/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rbs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MetadataResource

Returns a new instance of MetadataResource.

Parameters:

  • access_key: (String)
  • company: (InboundCompanyResource)
  • created_on: (String)
  • description: (String)
  • id: (String)
  • nsu: (Integer)
  • parent_access_key: (String)
  • type: (String)
  • xml_url: (String) 


19
 
# File 'sig/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rbs', line 19

def initialize: (?access_key: String, ?company: InboundCompanyResource, ?created_on: String, ?description: String, ?id: String, ?nsu: Integer, ?parent_access_key: String, ?type: String, ?xml_url: String) -> void

Instance Attribute Details

#access_key ⇒ Object (readonly)

Returns the value of attribute access_key

Returns:

  • (Object) —

    the current value of access_key



9
10
11
 
# File 'lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb', line 9

def access_key
  @access_key
end

#company ⇒ Object (readonly)

Returns the value of attribute company

Returns:

  • (Object) —

    the current value of company



9
10
11
 
# File 'lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb', line 9

def company
  @company
end

#created_on ⇒ Object (readonly)

Returns the value of attribute created_on

Returns:

  • (Object) —

    the current value of created_on



9
10
11
 
# File 'lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb', line 9

def created_on
  @created_on
end

#description ⇒ Object (readonly)

Returns the value of attribute description

Returns:

  • (Object) —

    the current value of description



9
10
11
 
# File 'lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb', line 9

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id

Returns:

  • (Object) —

    the current value of id



9
10
11
 
# File 'lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb', line 9

def id
  @id
end

#nsu ⇒ Object (readonly)

Returns the value of attribute nsu

Returns:

  • (Object) —

    the current value of nsu



9
10
11
 
# File 'lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb', line 9

def nsu
  @nsu
end

#parent_access_key ⇒ Object (readonly)

Returns the value of attribute parent_access_key

Returns:

  • (Object) —

    the current value of parent_access_key



9
10
11
 
# File 'lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb', line 9

def parent_access_key
  @parent_access_key
end

#type ⇒ Object (readonly)

Returns the value of attribute type

Returns:

  • (Object) —

    the current value of type



9
10
11
 
# File 'lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb', line 9

def type
  @type
end

#xml_url ⇒ Object (readonly)

Returns the value of attribute xml_url

Returns:

  • (Object) —

    the current value of xml_url



9
10
11
 
# File 'lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb', line 9

def xml_url
  @xml_url
end

Class Method Details

.from_api(payload) ⇒ instance?

Parameters:

  • payload (Hash[String, untyped], nil)

Returns:

  • (instance, nil) 


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rb', line 10

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

  new(
    access_key: payload["accessKey"],
    company: InboundCompanyResource.from_api(payload["company"]),
    created_on: payload["createdOn"],
    description: payload["description"],
    id: payload["id"],
    nsu: payload["nsu"],
    parent_access_key: payload["parentAccessKey"],
    type: payload["type"],
    xml_url: payload["xmlUrl"],
  )
end

.new ⇒ instance

Parameters:

  • access_key: (String)
  • company: (InboundCompanyResource)
  • created_on: (String)
  • description: (String)
  • id: (String)
  • nsu: (Integer)
  • parent_access_key: (String)
  • type: (String)
  • xml_url: (String)

Returns:

  • (instance) 


18
 
# File 'sig/nfe/generated/consulta_dfe_distribuicao_v2/metadata_resource.rbs', line 18

def self.new: (?access_key: String, ?company: InboundCompanyResource, ?created_on: String, ?description: String, ?id: String, ?nsu: Integer, ?parent_access_key: String, ?type: String, ?xml_url: String) -> instance