Class: Samsara::Client

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url: nil, environment: Samsara::Environment::PRODUCTION_API, max_retries: nil, timeout_in_seconds: nil, token: ENV["SAMSARA_API_KEY"]) ⇒ Samsara::Client

Parameters:

  • base_url (String) (defaults to: nil)
  • environment (Samsara::Environment) (defaults to: Samsara::Environment::PRODUCTION_API)
  • max_retries (Long) (defaults to: nil) —

    The number of times to retry a failed request, defaults to 2.

  • timeout_in_seconds (Long) (defaults to: nil)
  • token (String) (defaults to: ENV["SAMSARA_API_KEY"]) 


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/samsara_api.rb', line 173

def initialize(base_url: nil, environment: Samsara::Environment::PRODUCTION_API, max_retries: nil, timeout_in_seconds: nil, token: ENV["SAMSARA_API_KEY"])
  @request_client = Samsara::RequestClient.new(
  base_url: base_url,
  environment: environment,
  max_retries: max_retries,
  timeout_in_seconds: timeout_in_seconds,
  token: token
)
  @addresses = Samsara::AddressesClient.new(request_client: @request_client)
  @assets = Samsara::AssetsClient.new(request_client: @request_client)
  @inputs = Samsara::InputsClient.new(request_client: @request_client)
  @attributes = Samsara::AttributesClient.new(request_client: @request_client)
  @contacts = Samsara::ContactsClient.new(request_client: @request_client)
  @defect_types = Samsara::DefectTypesClient.new(request_client: @request_client)
  @defects = Samsara::DefectsClient.new(request_client: @request_client)
  @devices = Samsara::DevicesClient.new(request_client: @request_client)
  @driver_trailer_assignments = Samsara::DriverTrailerAssignmentsClient.new(request_client: @request_client)
  @dvirs = Samsara::DvirsClient.new(request_client: @request_client)
  @carrier_proposed_assignments = Samsara::CarrierProposedAssignmentsClient.new(request_client: @request_client)
  @document_types = Samsara::DocumentTypesClient.new(request_client: @request_client)
  @documents = Samsara::DocumentsClient.new(request_client: @request_client)
  @driver_vehicle_assignments = Samsara::DriverVehicleAssignmentsClient.new(request_client: @request_client)
  @drivers = Samsara::DriversClient.new(request_client: @request_client)
  @equipment = Samsara::EquipmentClient.new(request_client: @request_client)
  @hos = Samsara::HosClient.new(request_client: @request_client)
  @routes = Samsara::RoutesClient.new(request_client: @request_client)
  @safety_events = Samsara::SafetyEventsClient.new(request_client: @request_client)
  @trailers = Samsara::TrailersClient.new(request_client: @request_client)
  @vehicles = Samsara::VehiclesClient.new(request_client: @request_client)
  @legacy = Samsara::LegacyClient.new(request_client: @request_client)
  @form_submissions = Samsara::FormSubmissionsClient.new(request_client: @request_client)
  @forms = Samsara::FormsClient.new(request_client: @request_client)
  @fuel_purchases = Samsara::FuelPurchasesClient.new(request_client: @request_client)
  @gateways = Samsara::GatewaysClient.new(request_client: @request_client)
  @idling = Samsara::IdlingClient.new(request_client: @request_client)
  @issues = Samsara::IssuesClient.new(request_client: @request_client)
  @live_shares = Samsara::LiveSharesClient.new(request_client: @request_client)
  @me = Samsara::MeClient.new(request_client: @request_client)
  @readings = Samsara::ReadingsClient.new(request_client: @request_client)
  @speeding_intervals = Samsara::SpeedingIntervalsClient.new(request_client: @request_client)
  @tags = Samsara::TagsClient.new(request_client: @request_client)
  @training_assignments = Samsara::TrainingAssignmentsClient.new(request_client: @request_client)
  @training_courses = Samsara::TrainingCoursesClient.new(request_client: @request_client)
  @trips = Samsara::TripsClient.new(request_client: @request_client)
  @user_roles = Samsara::UserRolesClient.new(request_client: @request_client)
  @users = Samsara::UsersClient.new(request_client: @request_client)
  @v_1_messages = Samsara::V1MessagesClient.new(request_client: @request_client)
  @webhooks = Samsara::WebhooksClient.new(request_client: @request_client)
  @alerts = Samsara::Alerts::Client.new(request_client: @request_client)
  @auth = Samsara::Auth::Client.new(request_client: @request_client)
  @cameras = Samsara::Cameras::Client.new(request_client: @request_client)
  @coaching = Samsara::Coaching::Client.new(request_client: @request_client)
  @ifta = Samsara::Ifta::Client.new(request_client: @request_client)
  @maintenance = Samsara::Maintenance::Client.new(request_client: @request_client)
  @reports = Samsara::Reports::Client.new(request_client: @request_client)
  @settings = Samsara::Settings::Client.new(request_client: @request_client)
  @tachograph = Samsara::Tachograph::Client.new(request_client: @request_client)
end

Instance Attribute Details

#addresses ⇒ Samsara::AddressesClient (readonly)

Returns:



68
69
70
 
# File 'lib/samsara_api.rb', line 68

def addresses
  @addresses
end

#alerts ⇒ Samsara::Alerts::Client (readonly)

Returns:



148
149
150
 
# File 'lib/samsara_api.rb', line 148

def alerts
  @alerts
end

#assets ⇒ Samsara::AssetsClient (readonly)

Returns:



70
71
72
 
# File 'lib/samsara_api.rb', line 70

def assets
  @assets
end

#attributes ⇒ Samsara::AttributesClient (readonly)

Returns:



74
75
76
 
# File 'lib/samsara_api.rb', line 74

def attributes
  @attributes
end

#auth ⇒ Samsara::Auth::Client (readonly)

Returns:



150
151
152
 
# File 'lib/samsara_api.rb', line 150

def auth
  @auth
end

#cameras ⇒ Samsara::Cameras::Client (readonly)

Returns:



152
153
154
 
# File 'lib/samsara_api.rb', line 152

def cameras
  @cameras
end

#carrier_proposed_assignments ⇒ Samsara::CarrierProposedAssignmentsClient (readonly)

Returns:



88
89
90
 
# File 'lib/samsara_api.rb', line 88

def carrier_proposed_assignments
  @carrier_proposed_assignments
end

#coaching ⇒ Samsara::Coaching::Client (readonly)

Returns:



154
155
156
 
# File 'lib/samsara_api.rb', line 154

def coaching
  @coaching
end

#contacts ⇒ Samsara::ContactsClient (readonly)

Returns:



76
77
78
 
# File 'lib/samsara_api.rb', line 76

def contacts
  @contacts
end

#defect_types ⇒ Samsara::DefectTypesClient (readonly)

Returns:



78
79
80
 
# File 'lib/samsara_api.rb', line 78

def defect_types
  @defect_types
end

#defects ⇒ Samsara::DefectsClient (readonly)

Returns:



80
81
82
 
# File 'lib/samsara_api.rb', line 80

def defects
  @defects
end

#devices ⇒ Samsara::DevicesClient (readonly)

Returns:



82
83
84
 
# File 'lib/samsara_api.rb', line 82

def devices
  @devices
end

#document_types ⇒ Samsara::DocumentTypesClient (readonly)

Returns:



90
91
92
 
# File 'lib/samsara_api.rb', line 90

def document_types
  @document_types
end

#documents ⇒ Samsara::DocumentsClient (readonly)

Returns:



92
93
94
 
# File 'lib/samsara_api.rb', line 92

def documents
  @documents
end

#driver_trailer_assignments ⇒ Samsara::DriverTrailerAssignmentsClient (readonly)

Returns:



84
85
86
 
# File 'lib/samsara_api.rb', line 84

def driver_trailer_assignments
  @driver_trailer_assignments
end

#driver_vehicle_assignments ⇒ Samsara::DriverVehicleAssignmentsClient (readonly)

Returns:



94
95
96
 
# File 'lib/samsara_api.rb', line 94

def driver_vehicle_assignments
  @driver_vehicle_assignments
end

#drivers ⇒ Samsara::DriversClient (readonly)

Returns:



96
97
98
 
# File 'lib/samsara_api.rb', line 96

def drivers
  @drivers
end

#dvirs ⇒ Samsara::DvirsClient (readonly)

Returns:



86
87
88
 
# File 'lib/samsara_api.rb', line 86

def dvirs
  @dvirs
end

#equipment ⇒ Samsara::EquipmentClient (readonly)

Returns:



98
99
100
 
# File 'lib/samsara_api.rb', line 98

def equipment
  @equipment
end

#form_submissions ⇒ Samsara::FormSubmissionsClient (readonly)

Returns:



112
113
114
 
# File 'lib/samsara_api.rb', line 112

def form_submissions
  @form_submissions
end

#forms ⇒ Samsara::FormsClient (readonly)

Returns:



114
115
116
 
# File 'lib/samsara_api.rb', line 114

def forms
  @forms
end

#fuel_purchases ⇒ Samsara::FuelPurchasesClient (readonly)

Returns:



116
117
118
 
# File 'lib/samsara_api.rb', line 116

def fuel_purchases
  @fuel_purchases
end

#gateways ⇒ Samsara::GatewaysClient (readonly)

Returns:



118
119
120
 
# File 'lib/samsara_api.rb', line 118

def gateways
  @gateways
end

#hos ⇒ Samsara::HosClient (readonly)

Returns:



100
101
102
 
# File 'lib/samsara_api.rb', line 100

def hos
  @hos
end

#idling ⇒ Samsara::IdlingClient (readonly)

Returns:



120
121
122
 
# File 'lib/samsara_api.rb', line 120

def idling
  @idling
end

#ifta ⇒ Samsara::Ifta::Client (readonly)

Returns:



156
157
158
 
# File 'lib/samsara_api.rb', line 156

def ifta
  @ifta
end

#inputs ⇒ Samsara::InputsClient (readonly)

Returns:



72
73
74
 
# File 'lib/samsara_api.rb', line 72

def inputs
  @inputs
end

#issues ⇒ Samsara::IssuesClient (readonly)

Returns:



122
123
124
 
# File 'lib/samsara_api.rb', line 122

def issues
  @issues
end

#legacy ⇒ Samsara::LegacyClient (readonly)

Returns:



110
111
112
 
# File 'lib/samsara_api.rb', line 110

def legacy
  @legacy
end

#live_shares ⇒ Samsara::LiveSharesClient (readonly)

Returns:



124
125
126
 
# File 'lib/samsara_api.rb', line 124

def live_shares
  @live_shares
end

#maintenance ⇒ Samsara::Maintenance::Client (readonly)

Returns:



158
159
160
 
# File 'lib/samsara_api.rb', line 158

def maintenance
  @maintenance
end

#me ⇒ Samsara::MeClient (readonly)

Returns:



126
127
128
 
# File 'lib/samsara_api.rb', line 126

def me
  @me
end

#readings ⇒ Samsara::ReadingsClient (readonly)

Returns:



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

def readings
  @readings
end

#reports ⇒ Samsara::Reports::Client (readonly)

Returns:



160
161
162
 
# File 'lib/samsara_api.rb', line 160

def reports
  @reports
end

#routes ⇒ Samsara::RoutesClient (readonly)

Returns:



102
103
104
 
# File 'lib/samsara_api.rb', line 102

def routes
  @routes
end

#safety_events ⇒ Samsara::SafetyEventsClient (readonly)

Returns:



104
105
106
 
# File 'lib/samsara_api.rb', line 104

def safety_events
  @safety_events
end

#settings ⇒ Samsara::Settings::Client (readonly)

Returns:



162
163
164
 
# File 'lib/samsara_api.rb', line 162

def settings
  @settings
end

#speeding_intervals ⇒ Samsara::SpeedingIntervalsClient (readonly)

Returns:



130
131
132
 
# File 'lib/samsara_api.rb', line 130

def speeding_intervals
  @speeding_intervals
end

#tachograph ⇒ Samsara::Tachograph::Client (readonly)

Returns:



164
165
166
 
# File 'lib/samsara_api.rb', line 164

def tachograph
  @tachograph
end

#tags ⇒ Samsara::TagsClient (readonly)

Returns:



132
133
134
 
# File 'lib/samsara_api.rb', line 132

def tags
  @tags
end

#trailers ⇒ Samsara::TrailersClient (readonly)

Returns:



106
107
108
 
# File 'lib/samsara_api.rb', line 106

def trailers
  @trailers
end

#training_assignments ⇒ Samsara::TrainingAssignmentsClient (readonly)

Returns:



134
135
136
 
# File 'lib/samsara_api.rb', line 134

def training_assignments
  @training_assignments
end

#training_courses ⇒ Samsara::TrainingCoursesClient (readonly)

Returns:



136
137
138
 
# File 'lib/samsara_api.rb', line 136

def training_courses
  @training_courses
end

#trips ⇒ Samsara::TripsClient (readonly)

Returns:



138
139
140
 
# File 'lib/samsara_api.rb', line 138

def trips
  @trips
end

#user_roles ⇒ Samsara::UserRolesClient (readonly)

Returns:



140
141
142
 
# File 'lib/samsara_api.rb', line 140

def user_roles
  @user_roles
end

#users ⇒ Samsara::UsersClient (readonly)

Returns:



142
143
144
 
# File 'lib/samsara_api.rb', line 142

def users
  @users
end

#v_1_messages ⇒ Samsara::V1MessagesClient (readonly)

Returns:



144
145
146
 
# File 'lib/samsara_api.rb', line 144

def v_1_messages
  @v_1_messages
end

#vehicles ⇒ Samsara::VehiclesClient (readonly)

Returns:



108
109
110
 
# File 'lib/samsara_api.rb', line 108

def vehicles
  @vehicles
end

#webhooks ⇒ Samsara::WebhooksClient (readonly)

Returns:



146
147
148
 
# File 'lib/samsara_api.rb', line 146

def webhooks
  @webhooks
end