Class: Nfe::Resources::ConsumerInvoiceIssued

Inherits:
Data
  • Object
show all
Defined in:
lib/nfe/resources/responses/consumer_invoice_issued.rb,
sig/nfe/resources/consumer_invoice_issued.rbs

Overview

Discriminated result of a synchronous NFC-e emission (HTTP 201/200): the document was materialized immediately. resource is the hydrated ConsumerInvoice value object.

Discriminate against ConsumerInvoicePending with the +pending?+/+issued?+ predicates or +case+/+in+ pattern matching.

Examples:

result = client.consumer_invoices.create(company_id: id, data: payload)
result.resource if result.issued?

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(resource:) ⇒ void #initialize(resource) ⇒ void

Returns a new instance of ConsumerInvoiceIssued.

Overloads:



9
10
 
# File 'sig/nfe/resources/consumer_invoice_issued.rbs', line 9

def initialize: (resource: Nfe::ConsumerInvoice?) -> void
| (Nfe::ConsumerInvoice? resource) -> void

Instance Attribute Details

#resource ⇒ Nfe::ConsumerInvoice? (readonly)

Returns the value of attribute resource.

Returns:



4
5
6
 
# File 'sig/nfe/resources/consumer_invoice_issued.rbs', line 4

def resource
  @resource
end

Class Method Details

.new(resource:) ⇒ instance .new(resource) ⇒ instance

Overloads:



6
7
 
# File 'sig/nfe/resources/consumer_invoice_issued.rbs', line 6

def self.new: (resource: Nfe::ConsumerInvoice?) -> instance
| (Nfe::ConsumerInvoice? resource) -> instance

Instance Method Details

#issued? ⇒ Boolean

Returns always true for an issued result.

Returns:

  • (Boolean) —

    always true for an issued result.



22
23
24
 
# File 'lib/nfe/resources/responses/consumer_invoice_issued.rb', line 22

def issued?
  true
end

#pending? ⇒ Boolean

Returns always false for an issued result.

Returns:

  • (Boolean) —

    always false for an issued result.



17
18
19
 
# File 'lib/nfe/resources/responses/consumer_invoice_issued.rb', line 17

def pending?
  false
end