Class: GOBL::Org::Inbox

Inherits:
GOBL::Object show all
Defined in:
lib/generated/gobl/org/inbox.rb

Overview

Inbox is used to store data about a connection with a service that is responsible for potentially receiving copies of GOBL envelopes or other document formats defined locally.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Inbox structure

'https://gobl.org/draft-0/org/inbox'

Instance Attribute Summary collapse

Method Summary

Methods inherited from GOBL::Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#code ⇒ String (readonly)

Actual Code or ID that identifies the Inbox.

Returns:

  • (String) 


39
 
# File 'lib/generated/gobl/org/inbox.rb', line 39

property :code, String

#key ⇒ GOBL::CBC::Key (readonly)

Type of inbox being defined.

Returns:



23
 
# File 'lib/generated/gobl/org/inbox.rb', line 23

property :key, GOBL::CBC::Key

#name ⇒ String (readonly)

Human name for the inbox.

Returns:

  • (String) 


34
 
# File 'lib/generated/gobl/org/inbox.rb', line 34

property :name, String

#role ⇒ GOBL::CBC::Key (readonly)

Role assigned to this inbox that may be relevant for the consumer.

Returns:



29
 
# File 'lib/generated/gobl/org/inbox.rb', line 29

property :role, GOBL::CBC::Key

#uuid ⇒ String (readonly)

Universally Unique Identifier.

Returns:

  • (String) 


18
 
# File 'lib/generated/gobl/org/inbox.rb', line 18

property :uuid, String