Class: Samsara::Types::UpdateRoutesStopRequestObjectRequestBody

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address_id: OMIT, external_ids: OMIT, id: OMIT, name: OMIT, notes: OMIT, ontime_window_after_arrival_ms: OMIT, ontime_window_before_arrival_ms: OMIT, scheduled_arrival_time: OMIT, scheduled_departure_time: OMIT, single_use_location: OMIT, additional_properties: nil) ⇒ Samsara::Types::UpdateRoutesStopRequestObjectRequestBody

Parameters:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 63

def initialize(address_id: OMIT, external_ids: OMIT, id: OMIT, name: OMIT, notes: OMIT, ontime_window_after_arrival_ms: OMIT, ontime_window_before_arrival_ms: OMIT, scheduled_arrival_time: OMIT, scheduled_departure_time: OMIT, single_use_location: OMIT, additional_properties: nil)
  @address_id = address_id if address_id != OMIT
  @external_ids = external_ids if external_ids != OMIT
  @id = id if id != OMIT
  @name = name if name != OMIT
  @notes = notes if notes != OMIT
  @ontime_window_after_arrival_ms = ontime_window_after_arrival_ms if ontime_window_after_arrival_ms != OMIT
  @ontime_window_before_arrival_ms = ontime_window_before_arrival_ms if ontime_window_before_arrival_ms != OMIT
  @scheduled_arrival_time = scheduled_arrival_time if scheduled_arrival_time != OMIT
  @scheduled_departure_time = scheduled_departure_time if scheduled_departure_time != OMIT
  @single_use_location = single_use_location if single_use_location != OMIT
  @additional_properties = additional_properties
  @_field_set = { "addressId": address_id, "externalIds": external_ids, "id": id, "name": name, "notes": notes, "ontimeWindowAfterArrivalMs": ontime_window_after_arrival_ms, "ontimeWindowBeforeArrivalMs": ontime_window_before_arrival_ms, "scheduledArrivalTime": scheduled_arrival_time, "scheduledDepartureTime": scheduled_departure_time, "singleUseLocation": single_use_location }.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



38
39
40
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 38

def additional_properties
  @additional_properties
end

#address_id ⇒ Object (readonly)

can also be used interchangeably here.



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

def address_id
  @address_id
end

#external_ids ⇒ Hash{String => String} (readonly)

Returns A map of external ids.

Returns:

  • (Hash{String => String}) —

    A map of external ids



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

def external_ids
  @external_ids
end

#id ⇒ String (readonly)

Returns ID of the stop.

Returns:

  • (String) —

    ID of the stop



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

def id
  @id
end

#name ⇒ String (readonly)

Returns Name of the stop.

Returns:

  • (String) —

    Name of the stop



20
21
22
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 20

def name
  @name
end

#notes ⇒ String (readonly)

Returns Notes for the stop.

Returns:

  • (String) —

    Notes for the stop



22
23
24
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 22

def notes
  @notes
end

#ontime_window_after_arrival_ms ⇒ Object (readonly)

time during which the stop is considered ‘on-time’.



25
26
27
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 25

def ontime_window_after_arrival_ms
  @ontime_window_after_arrival_ms
end

#ontime_window_before_arrival_ms ⇒ Object (readonly)

time during which the stop is considered ‘on-time’.



28
29
30
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 28

def ontime_window_before_arrival_ms
  @ontime_window_before_arrival_ms
end

#scheduled_arrival_time ⇒ Object (readonly)

start and stop settings selected.



31
32
33
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 31

def scheduled_arrival_time
  @scheduled_arrival_time
end

#scheduled_departure_time ⇒ Object (readonly)

start and stop settings selected.



34
35
36
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 34

def scheduled_departure_time
  @scheduled_departure_time
end

#single_use_location ⇒ Samsara::Types::RoutesSingleUseAddressObjectRequestBody (readonly)

Returns:



36
37
38
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 36

def single_use_location
  @single_use_location
end

Class Method Details

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

Parameters:

  • json_object (String)

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 84

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  address_id = parsed_json["addressId"]
  external_ids = parsed_json["externalIds"]
  id = parsed_json["id"]
  name = parsed_json["name"]
  notes = parsed_json["notes"]
  ontime_window_after_arrival_ms = parsed_json["ontimeWindowAfterArrivalMs"]
  ontime_window_before_arrival_ms = parsed_json["ontimeWindowBeforeArrivalMs"]
  scheduled_arrival_time = unless parsed_json["scheduledArrivalTime"].nil?
  DateTime.parse(parsed_json["scheduledArrivalTime"])
else
  nil
end
  scheduled_departure_time = unless parsed_json["scheduledDepartureTime"].nil?
  DateTime.parse(parsed_json["scheduledDepartureTime"])
else
  nil
end
  unless parsed_json["singleUseLocation"].nil?
    single_use_location = parsed_json["singleUseLocation"].to_json
    single_use_location = Samsara::Types::RoutesSingleUseAddressObjectRequestBody.from_json(json_object: single_use_location)
  else
    single_use_location = nil
  end
  new(
    address_id: address_id,
    external_ids: external_ids,
    id: id,
    name: name,
    notes: notes,
    ontime_window_after_arrival_ms: ontime_window_after_arrival_ms,
    ontime_window_before_arrival_ms: ontime_window_before_arrival_ms,
    scheduled_arrival_time: scheduled_arrival_time,
    scheduled_departure_time: scheduled_departure_time,
    single_use_location: single_use_location,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 137

def self.validate_raw(obj:)
  obj.address_id&.is_a?(String) != false || raise("Passed value for field obj.address_id is not the expected type, validation failed.")
  obj.external_ids&.is_a?(Hash) != false || raise("Passed value for field obj.external_ids 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.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.notes&.is_a?(String) != false || raise("Passed value for field obj.notes is not the expected type, validation failed.")
  obj.ontime_window_after_arrival_ms&.is_a?(Integer) != false || raise("Passed value for field obj.ontime_window_after_arrival_ms is not the expected type, validation failed.")
  obj.ontime_window_before_arrival_ms&.is_a?(Integer) != false || raise("Passed value for field obj.ontime_window_before_arrival_ms is not the expected type, validation failed.")
  obj.scheduled_arrival_time&.is_a?(DateTime) != false || raise("Passed value for field obj.scheduled_arrival_time is not the expected type, validation failed.")
  obj.scheduled_departure_time&.is_a?(DateTime) != false || raise("Passed value for field obj.scheduled_departure_time is not the expected type, validation failed.")
  obj.single_use_location.nil? || Samsara::Types::RoutesSingleUseAddressObjectRequestBody.validate_raw(obj: obj.single_use_location)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


128
129
130
 
# File 'lib/samsara_api/types/update_routes_stop_request_object_request_body.rb', line 128

def to_json
  @_field_set&.to_json
end