Class: Gusto::DocumentPdf

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/types/document_pdf.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uuid: OMIT, document_url: OMIT, additional_properties: nil) ⇒ Gusto::DocumentPdf

Parameters:

  • uuid (String) (defaults to: OMIT) —

    the UUID of the document

  • document_url (String) (defaults to: OMIT) —

    the URL of the document

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



23
24
25
26
27
28
29
30
 
# File 'lib/fern_gusto/types/document_pdf.rb', line 23

def initialize(uuid: OMIT, document_url: OMIT, additional_properties: nil)
  @uuid = uuid if uuid != OMIT
  @document_url = document_url if document_url != OMIT
  @additional_properties = additional_properties
  @_field_set = { "uuid": uuid, "document_url": document_url }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



12
13
14
 
# File 'lib/fern_gusto/types/document_pdf.rb', line 12

def additional_properties
  @additional_properties
end

#document_url ⇒ String (readonly)

Returns the URL of the document.

Returns:

  • (String) —

    the URL of the document



10
11
12
 
# File 'lib/fern_gusto/types/document_pdf.rb', line 10

def document_url
  @document_url
end

#uuid ⇒ String (readonly)

Returns the UUID of the document.

Returns:

  • (String) —

    the UUID of the document



8
9
10
 
# File 'lib/fern_gusto/types/document_pdf.rb', line 8

def uuid
  @uuid
end

Class Method Details

.from_json(json_object:) ⇒ Gusto::DocumentPdf

Parameters:

  • json_object (String)

Returns:



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/fern_gusto/types/document_pdf.rb', line 35

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  uuid = parsed_json["uuid"]
  document_url = parsed_json["document_url"]
  new(
    uuid: uuid,
    document_url: document_url,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


58
59
60
61
 
# File 'lib/fern_gusto/types/document_pdf.rb', line 58

def self.validate_raw(obj:)
  obj.uuid&.is_a?(String) != false || raise("Passed value for field obj.uuid is not the expected type, validation failed.")
  obj.document_url&.is_a?(String) != false || raise("Passed value for field obj.document_url is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


49
50
51
 
# File 'lib/fern_gusto/types/document_pdf.rb', line 49

def to_json
  @_field_set&.to_json
end