Class: GOBL::Org::Attachment

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

Overview

An Attachment provides a structure to be used to attach documents inside a GOBL document, either as a reference via a URL, or directly as a base64 encoded string.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Attachment structure

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

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 used to identify the payload of the attachment.

Returns:



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

property :code, GOBL::CBC::Code

#description ⇒ String (readonly)

Details of why the attachment is being included and details on what it contains.

Returns:

  • (String) 


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

property :description, String

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

Digest is used to verify the integrity of the attachment when downloaded from the URL.

Returns:



49
 
# File 'lib/generated/gobl/org/attachment.rb', line 49

property :digest, GOBL::DSig::Digest

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

Key used to identify the attachment inside the document.

Returns:



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

property :key, GOBL::CBC::Key

#mime ⇒ String (readonly)

MIME type of the attachment.

Returns:

  • (String) 


54
 
# File 'lib/generated/gobl/org/attachment.rb', line 54

property :mime, String

#name ⇒ String (readonly)

Filename of the attachment.

Returns:

  • (String) 


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

property :name, String

#url ⇒ String (readonly)

URL of where to find the attachment. Prefer using this field over the Data field.

Returns:

  • (String) 


44
 
# File 'lib/generated/gobl/org/attachment.rb', line 44

property :url, String

#uuid ⇒ String (readonly)

Universally Unique Identifier.

Returns:

  • (String) 


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

property :uuid, String