Class: Gusto::GeneratedDocument

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_uuid: OMIT, status: OMIT, document_urls: OMIT, additional_properties: nil) ⇒ Gusto::GeneratedDocument

Parameters:

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

    A unique identifier of the Generated Document request

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

    Current status of the Generated Document

  • document_urls (Array<String>) (defaults to: OMIT) —

    The array of urls to access the documents.

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

    Additional properties unmapped to the current class definition



26
27
28
29
30
31
32
33
34
 
# File 'lib/fern_gusto/types/generated_document.rb', line 26

def initialize(request_uuid: OMIT, status: OMIT, document_urls: OMIT, additional_properties: nil)
  @request_uuid = request_uuid if request_uuid != OMIT
  @status = status if status != OMIT
  @document_urls = document_urls if document_urls != OMIT
  @additional_properties = additional_properties
  @_field_set = { "request_uuid": request_uuid, "status": status, "document_urls": document_urls }.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



14
15
16
 
# File 'lib/fern_gusto/types/generated_document.rb', line 14

def additional_properties
  @additional_properties
end

#document_urls ⇒ Array<String> (readonly)

Returns The array of urls to access the documents.

Returns:

  • (Array<String>) —

    The array of urls to access the documents.



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

def document_urls
  @document_urls
end

#request_uuid ⇒ String (readonly)

Returns A unique identifier of the Generated Document request.

Returns:

  • (String) —

    A unique identifier of the Generated Document request



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

def request_uuid
  @request_uuid
end

#status ⇒ String (readonly)

Returns Current status of the Generated Document.

Returns:

  • (String) —

    Current status of the Generated Document



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

def status
  @status
end

Class Method Details

.from_json(json_object:) ⇒ Gusto::GeneratedDocument

Parameters:

  • json_object (String)

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/fern_gusto/types/generated_document.rb', line 39

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


64
65
66
67
68
 
# File 'lib/fern_gusto/types/generated_document.rb', line 64

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


55
56
57
 
# File 'lib/fern_gusto/types/generated_document.rb', line 55

def to_json
  @_field_set&.to_json
end