Class: GOBL::Org::Inbox

Inherits:

GOBL::Object

• Object
• Struct
• GOBL::Object
• GOBL::Org::Inbox

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

SCHEMA_ID =

The Schema ID of the GOBL Inbox structure

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

Instance Attribute Summary

• #code ⇒ String readonly

  Actual Code or ID that identifies the Inbox.

• #key ⇒ GOBL::CBC::Key readonly

  Type of inbox being defined.

• #name ⇒ String readonly

  Human name for the inbox.

• #role ⇒ GOBL::CBC::Key readonly

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

• #uuid ⇒ GOBL::UUID::UUID readonly

  Unique ID.

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)

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

property :code, String

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

Type of inbox being defined.

Returns:

• (GOBL::CBC::Key)

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

property :key, GOBL::CBC::Key

#name ⇒ String (readonly)

Human name for the inbox.

Returns:

• (String)

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

property :name, String

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

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

Returns:

• (GOBL::CBC::Key)

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

property :role, GOBL::CBC::Key

#uuid ⇒ GOBL::UUID::UUID (readonly)

Unique ID. Useful if inbox is stored in a database.

Returns:

• (GOBL::UUID::UUID)

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

property :uuid, GOBL::UUID::UUID