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 automatically receiving copies of GOBL envelopes or other document formats.

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 ⇒ GOBL::CBC::Code (readonly)

Code or ID that identifies the Inbox. Mutually exclusive with URL and Email.

Returns:



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

property :code, GOBL::CBC::Code

#email ⇒ String (readonly)

Email address for the inbox. Mutually exclusive with Code and URL.

Returns:

  • (String) 


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

property :email, String

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

Type of inbox being defined if required for clarification between multiple inboxes.

Returns:



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

property :key, GOBL::CBC::Key

#label ⇒ String (readonly)

Label for the inbox.

Returns:

  • (String) 


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

property :label, String

#scheme ⇒ GOBL::CBC::Code (readonly)

Scheme ID of the code used to identify the inbox. This is context specific and usually an ISO 6523 code or CEF (Connecting Europe Facility) code.

Returns:



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

property :scheme, GOBL::CBC::Code

#url ⇒ String (readonly)

URL of the inbox that includes the protocol, server, and path. May be used instead of the Code to identify the inbox. Mutually exclusive with Code and Email.

Returns:

  • (String) 


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

property :url, String

#uuid ⇒ String (readonly)

Universally Unique Identifier.

Returns:

  • (String) 


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

property :uuid, String