Class: Gusto::Documents::DocumentPagesItem

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(image_url: OMIT, page_number: OMIT, additional_properties: nil) ⇒ Gusto::Documents::DocumentPagesItem

Parameters:

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

    Image URL for the page

  • page_number (Integer) (defaults to: OMIT) —

    Page number

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

    Additional properties unmapped to the current class definition



24
25
26
27
28
29
30
31
 
# File 'lib/fern_gusto/documents/types/document_pages_item.rb', line 24

def initialize(image_url: OMIT, page_number: OMIT, additional_properties: nil)
  @image_url = image_url if image_url != OMIT
  @page_number = page_number if page_number != OMIT
  @additional_properties = additional_properties
  @_field_set = { "image_url": image_url, "page_number": page_number }.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/fern_gusto/documents/types/document_pages_item.rb', line 13

def additional_properties
  @additional_properties
end

#image_url ⇒ String (readonly)

Returns Image URL for the page.

Returns:

  • (String) —

    Image URL for the page



9
10
11
 
# File 'lib/fern_gusto/documents/types/document_pages_item.rb', line 9

def image_url
  @image_url
end

#page_number ⇒ Integer (readonly)

Returns Page number.

Returns:

  • (Integer) —

    Page number



11
12
13
 
# File 'lib/fern_gusto/documents/types/document_pages_item.rb', line 11

def page_number
  @page_number
end

Class Method Details

.from_json(json_object:) ⇒ Gusto::Documents::DocumentPagesItem

Parameters:

  • json_object (String)

Returns:



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

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


59
60
61
62
 
# File 'lib/fern_gusto/documents/types/document_pages_item.rb', line 59

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


50
51
52
 
# File 'lib/fern_gusto/documents/types/document_pages_item.rb', line 50

def to_json
  @_field_set&.to_json
end