Class: Nfe::Resources::ServiceInvoices::StatusResult

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

Overview

Derived status snapshot returned by #get_status without issuing an extra HTTP call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ StatusResult

Returns a new instance of StatusResult.

Parameters:



14
 
# File 'sig/nfe/resources/service_invoices.rbs', line 14

def initialize: (status: String, invoice: Nfe::ServiceInvoice?, complete: bool, failed: bool) -> void

Instance Attribute Details

#complete ⇒ Boolean (readonly)

Returns the value of attribute complete.

Returns:

  • (Boolean) 


7
8
9
 
# File 'sig/nfe/resources/service_invoices.rbs', line 7

def complete
  @complete
end

#failed ⇒ Boolean (readonly)

Returns the value of attribute failed.

Returns:

  • (Boolean) 


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

def failed
  @failed
end

#invoice ⇒ Nfe::ServiceInvoice? (readonly)

Returns the value of attribute invoice.

Returns:



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

def invoice
  @invoice
end

#status ⇒ String (readonly)

Returns the value of attribute status.

Returns:

  • (String) 


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

def status
  @status
end

Class Method Details

.new ⇒ instance

Parameters:

Returns:

  • (instance) 


13
 
# File 'sig/nfe/resources/service_invoices.rbs', line 13

def self.new: (status: String, invoice: Nfe::ServiceInvoice?, complete: bool, failed: bool) -> instance

Instance Method Details

#complete? ⇒ Boolean

Returns true when the flow status is terminal.

Returns:

  • (Boolean) —

    true when the flow status is terminal.



36
37
38
 
# File 'lib/nfe/resources/service_invoices.rb', line 36

def complete?
  complete
end

#failed? ⇒ Boolean

Returns true when the flow status is IssueFailed/CancelFailed.

Returns:

  • (Boolean) —

    true when the flow status is IssueFailed/CancelFailed.



41
42
43
 
# File 'lib/nfe/resources/service_invoices.rb', line 41

def failed?
  failed
end