Class: Nfe::Resources::ProductInvoicePending

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

Overview

Result of an asynchronous (HTTP 202) product-invoice (NF-e) emission: the API enqueued the request and is processing it. Completion is notified via webhook.

invoice_id is parsed from the Location header's final path segment; location is the raw header value. Discriminate against ProductInvoiceIssued with +pending?+/+issued?+ or case pattern matching, then poll FlowStatus.terminal? until settled.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ProductInvoicePending

Returns a new instance of ProductInvoicePending.

Parameters:

  • invoice_id: (String)
  • location: (String) 


11
 
# File 'sig/nfe/resources/responses/product_invoice_pending.rbs', line 11

def initialize: (invoice_id: String, location: String) -> void

Instance Attribute Details

#invoice_id ⇒ String (readonly)

Returns the value of attribute invoice_id.

Returns:

  • (String) 


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

def invoice_id
  @invoice_id
end

#location ⇒ String (readonly)

Returns the value of attribute location.

Returns:

  • (String) 


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

def location
  @location
end

Class Method Details

.new ⇒ instance

Parameters:

  • invoice_id: (String)
  • location: (String)

Returns:

  • (instance) 


10
 
# File 'sig/nfe/resources/responses/product_invoice_pending.rbs', line 10

def self.new: (invoice_id: String, location: String) -> instance

Instance Method Details

#issued? ⇒ false

Returns this is not an immediate (issued) result.

Returns:

  • (false) —

    this is not an immediate (issued) result.



20
21
22
 
# File 'lib/nfe/resources/responses/product_invoice_pending.rb', line 20

def issued?
  false
end

#pending? ⇒ true

Returns this is an async (pending) result.

Returns:

  • (true) —

    this is an async (pending) result.



15
16
17
 
# File 'lib/nfe/resources/responses/product_invoice_pending.rb', line 15

def pending?
  true
end