Class: Samsara::Types::IftaJurisdictionSummaryObjectResponseBody

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

Overview

A summary of this jurisdiction’s IFTA data.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(jurisdiction:, tax_paid_liters: OMIT, taxable_meters:, total_meters:, additional_properties: nil) ⇒ Samsara::Types::IftaJurisdictionSummaryObjectResponseBody

Parameters:

  • jurisdiction (String) —

    Jurisdiction code.

  • tax_paid_liters (Float) (defaults to: OMIT) —

    Liters purchased for all qualified vehicles.

  • taxable_meters (Float) —

    Distance in meters traveled on public roads in an IFTA jurisdiction.

  • total_meters (Float) —

    Total meters driven in this jurisdiction, taxable and non-taxable.

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

    Additional properties unmapped to the current class definition



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/samsara_api/types/ifta_jurisdiction_summary_object_response_body.rb', line 31

def initialize(jurisdiction:, tax_paid_liters: OMIT, taxable_meters:, total_meters:, additional_properties: nil)
  @jurisdiction = jurisdiction
  @tax_paid_liters = tax_paid_liters if tax_paid_liters != OMIT
  @taxable_meters = taxable_meters
  @total_meters = total_meters
  @additional_properties = additional_properties
  @_field_set = { "jurisdiction": jurisdiction, "taxPaidLiters": tax_paid_liters, "taxableMeters": taxable_meters, "totalMeters": total_meters }.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



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

def additional_properties
  @additional_properties
end

#jurisdiction ⇒ String (readonly)

Returns Jurisdiction code.

Returns:

  • (String) —

    Jurisdiction code.



10
11
12
 
# File 'lib/samsara_api/types/ifta_jurisdiction_summary_object_response_body.rb', line 10

def jurisdiction
  @jurisdiction
end

#tax_paid_liters ⇒ Float (readonly)

Returns Liters purchased for all qualified vehicles.

Returns:

  • (Float) —

    Liters purchased for all qualified vehicles.



12
13
14
 
# File 'lib/samsara_api/types/ifta_jurisdiction_summary_object_response_body.rb', line 12

def tax_paid_liters
  @tax_paid_liters
end

#taxable_meters ⇒ Float (readonly)

Returns Distance in meters traveled on public roads in an IFTA jurisdiction.

Returns:

  • (Float) —

    Distance in meters traveled on public roads in an IFTA jurisdiction.



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

def taxable_meters
  @taxable_meters
end

#total_meters ⇒ Float (readonly)

Returns Total meters driven in this jurisdiction, taxable and non-taxable.

Returns:

  • (Float) —

    Total meters driven in this jurisdiction, taxable and non-taxable.



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

def total_meters
  @total_meters
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/samsara_api/types/ifta_jurisdiction_summary_object_response_body.rb', line 46

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  jurisdiction = parsed_json["jurisdiction"]
  tax_paid_liters = parsed_json["taxPaidLiters"]
  taxable_meters = parsed_json["taxableMeters"]
  total_meters = parsed_json["totalMeters"]
  new(
    jurisdiction: jurisdiction,
    tax_paid_liters: tax_paid_liters,
    taxable_meters: taxable_meters,
    total_meters: total_meters,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


74
75
76
77
78
79
 
# File 'lib/samsara_api/types/ifta_jurisdiction_summary_object_response_body.rb', line 74

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


65
66
67
 
# File 'lib/samsara_api/types/ifta_jurisdiction_summary_object_response_body.rb', line 65

def to_json
  @_field_set&.to_json
end