Class: GOBL::Envelope

Inherits:
Object show all
Includes:
GOBLExtensions::EnvelopeHelper
Defined in:
lib/gobl/envelope.rb

Overview

Envelope wraps around a gobl document and provides support for digest creation and digital signatures.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Envelope structure

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

Constants included from Hashme

Hashme::Boolean

Instance Attribute Summary collapse

Method Summary

Methods included from GOBLExtensions::EnvelopeHelper

#extract, included

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#$schema($schema) ⇒ String (readonly)

Schema identifies the schema that should be used to understand this document

Returns:

  • (String) 


18
 
# File 'lib/gobl/envelope.rb', line 18

property :$schema, String

#doc ⇒ Document (readonly)

The data inside the envelope

Returns:



30
 
# File 'lib/gobl/envelope.rb', line 30

property :doc, Document

#head ⇒ Header (readonly)

Details on what the contents are

Returns:



24
 
# File 'lib/gobl/envelope.rb', line 24

property :head, Header

#sigs ⇒ Array<GOBL::DSig::Signature> (readonly)

JSON Web Signatures of the header

Returns:



36
 
# File 'lib/gobl/envelope.rb', line 36

property :sigs, [GOBL::DSig::Signature]