Class: Samsara::Types::FieldObjectResponseBody

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(label:, type:, value:, additional_properties: nil) ⇒ Samsara::Types::FieldObjectResponseBody

Parameters:



31
32
33
34
35
36
37
 
# File 'lib/samsara_api/types/field_object_response_body.rb', line 31

def initialize(label:, type:, value:, additional_properties: nil)
  @label = label
  @type = type
  @value = value
  @additional_properties = additional_properties
  @_field_set = { "label": label, "type": type, "value": value }
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



18
19
20
 
# File 'lib/samsara_api/types/field_object_response_body.rb', line 18

def additional_properties
  @additional_properties
end

#label ⇒ String (readonly)

Returns The name of the field.

Returns:

  • (String) —

    The name of the field.



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

def label
  @label
end

#type ⇒ Object (readonly)

‘signature`, `dateTime`, `scannedDocument`, `barcode`



14
15
16
 
# File 'lib/samsara_api/types/field_object_response_body.rb', line 14

def type
  @type
end

#value ⇒ Samsara::Types::FieldObjectValueResponseBody (readonly)

Returns:



16
17
18
 
# File 'lib/samsara_api/types/field_object_response_body.rb', line 16

def value
  @value
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/samsara_api/types/field_object_response_body.rb', line 42

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  label = parsed_json["label"]
  type = parsed_json["type"]
  unless parsed_json["value"].nil?
    value = parsed_json["value"].to_json
    value = Samsara::Types::FieldObjectValueResponseBody.from_json(json_object: value)
  else
    value = nil
  end
  new(
    label: label,
    type: type,
    value: value,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


72
73
74
75
76
 
# File 'lib/samsara_api/types/field_object_response_body.rb', line 72

def self.validate_raw(obj:)
  obj.label.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
  obj.type.is_a?(Samsara::Types::FieldObjectResponseBodyType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
  Samsara::Types::FieldObjectValueResponseBody.validate_raw(obj: obj.value)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


63
64
65
 
# File 'lib/samsara_api/types/field_object_response_body.rb', line 63

def to_json
  @_field_set&.to_json
end