Class: Samsara::Types::DocumentPdfGenerationResponseData

Inherits:
Object
  • Object
show all
Defined in:
lib/samsara_api/types/document_pdf_generation_response_data.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document_id: OMIT, id: OMIT, additional_properties: nil) ⇒ Samsara::Types::DocumentPdfGenerationResponseData

Parameters:

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

    ID of the document.

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

    ID of the PDF file generated or being generated for the document.

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

    Additional properties unmapped to the current class definition



24
25
26
27
28
29
30
31
 
# File 'lib/samsara_api/types/document_pdf_generation_response_data.rb', line 24

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



13
14
15
 
# File 'lib/samsara_api/types/document_pdf_generation_response_data.rb', line 13

def additional_properties
  @additional_properties
end

#document_id ⇒ String (readonly)

Returns ID of the document.

Returns:

  • (String) —

    ID of the document.



9
10
11
 
# File 'lib/samsara_api/types/document_pdf_generation_response_data.rb', line 9

def document_id
  @document_id
end

#id ⇒ String (readonly)

Returns ID of the PDF file generated or being generated for the document.

Returns:

  • (String) —

    ID of the PDF file generated or being generated for the document.



11
12
13
 
# File 'lib/samsara_api/types/document_pdf_generation_response_data.rb', line 11

def id
  @id
end

Class Method Details

.from_json(json_object:) ⇒ Samsara::Types::DocumentPdfGenerationResponseData

Parameters:

  • json_object (String)

Returns:



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/samsara_api/types/document_pdf_generation_response_data.rb', line 36

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


59
60
61
62
 
# File 'lib/samsara_api/types/document_pdf_generation_response_data.rb', line 59

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


50
51
52
 
# File 'lib/samsara_api/types/document_pdf_generation_response_data.rb', line 50

def to_json
  @_field_set&.to_json
end