Class: SynsbasenApi::WatchedVehicle

Inherits:
Resource show all
Defined in:
lib/synsbasen_api/resources/watched_vehicle.rb

Overview

The WatchedVehicle class provides methods for interacting with watched vehicle related endpoints in the Synsbasen API.

Constant Summary

Constants inherited from Client

Client::DEFAULT_BASE_URL

Class Method Summary collapse

Methods inherited from Client

delete, get, post

Class Method Details

.all ⇒ ApiResponse

Retrieves all watched vehicles.

Returns:

  • (ApiResponse) —

    An instance of ApiResponse containing details of all watched vehicles.



12
13
14
 
# File 'lib/synsbasen_api/resources/watched_vehicle.rb', line 12

def all
  get("/v1/#{resource_name}")
end

.subscribe(vehicle_id) ⇒ ApiResponse

Creates a new watched vehicle.

Parameters:

  • vehicle_id (Integer) —

    The ID of the vehicle to be watched.

Returns:

  • (ApiResponse) —

    An instance of ApiResponse containing details of the newly created watched vehicle.



21
22
23
24
25
26
 
# File 'lib/synsbasen_api/resources/watched_vehicle.rb', line 21

def subscribe(vehicle_id)
  post("/v1/#{resource_name}", body: { vehicle_id: vehicle_id })
rescue SynsbasenApi::ClientError => e
  raise VehicleAlreadySubscribedError.new(e.message, e.status, e.data) if e.status == "409"
  raise e
end

.unsubscribe(vehicle_id) ⇒ ApiResponse

Deletes a watched vehicle.

Parameters:

  • vehicle_id (Integer) —

    The ID of the vehicle to be unwatched.

Returns:

  • (ApiResponse) —

    An instance of ApiResponse indicating the success of the unwatch operation.



33
34
35
 
# File 'lib/synsbasen_api/resources/watched_vehicle.rb', line 33

def unsubscribe(vehicle_id)
  delete("/v1/#{resource_name}/#{vehicle_id}")
end