Class: GOBL::Head::Header

Inherits:
Object show all
Defined in:
lib/generated/gobl/head/header.rb

Overview

Header defines the metadata of the body.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Header structure

'https://gobl.org/draft-0/head/header'

Instance Attribute Summary collapse

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#dig ⇒ GOBL::DSig::Digest (readonly)

Digest of the canonical JSON body.

Returns:



25
 
# File 'lib/generated/gobl/head/header.rb', line 25

property :dig, GOBL::DSig::Digest

#draft ⇒ Boolean (readonly)

When true, implies that this document should not be considered final. Digital signatures are optional.

Returns:

  • (Boolean) 


51
 
# File 'lib/generated/gobl/head/header.rb', line 51

property :draft, Boolean

#meta ⇒ GOBL::CBC::Meta (readonly)

Additional semi-structured information about this envelope.

Returns:



41
 
# File 'lib/generated/gobl/head/header.rb', line 41

property :meta, GOBL::CBC::Meta

#notes ⇒ String (readonly)

Any information that may be relevant to other humans about this envelope

Returns:

  • (String) 


46
 
# File 'lib/generated/gobl/head/header.rb', line 46

property :notes, String

#stamps ⇒ Array<GOBL::Head::Stamp> (readonly)

Seals of approval from other organisations that can only be added to non-draft envelopes.

Returns:



31
 
# File 'lib/generated/gobl/head/header.rb', line 31

property :stamps, [GOBL::Head::Stamp]

#tags ⇒ Array<String> (readonly)

Set of labels that describe but have no influence on the data.

Returns:

  • (Array<String>) 


36
 
# File 'lib/generated/gobl/head/header.rb', line 36

property :tags, [String]

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

Unique UUIDv1 identifier for the envelope.

Returns:



19
 
# File 'lib/generated/gobl/head/header.rb', line 19

property :uuid, GOBL::UUID::UUID