Class: Samsara::LiveSharesClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Samsara::LiveSharesClient

Parameters:



25
26
27
 
# File 'lib/samsara_api/live_shares/client.rb', line 25

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Samsara::RequestClient (readonly)

Returns:



20
21
22
 
# File 'lib/samsara_api/live_shares/client.rb', line 20

def request_client
  @request_client
end

Instance Method Details

#create(assets_location_link_config: nil, assets_near_location_link_config: nil, assets_on_route_link_config: nil, description: nil, expires_at_time: nil, name:, type:, request_options: nil) ⇒ Object

api.live_shares.create(name: “Example Live Sharing Link name”, type: ASSETS_LOCATION)



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/samsara_api/live_shares/client.rb', line 119

def create(assets_location_link_config: nil, assets_near_location_link_config: nil, assets_on_route_link_config: nil, description: nil, expires_at_time: nil, name:, type:, request_options: nil)
  response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), assetsLocationLinkConfig: assets_location_link_config, assetsNearLocationLinkConfig: assets_near_location_link_config, assetsOnRouteLinkConfig: assets_on_route_link_config, description: description, expiresAtTime: expires_at_time, name: name, type: type }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/live-shares"
end
  Samsara::Types::LiveSharingLinksCreateLiveSharingLinkResponseBody.from_json(json_object: response.body)
end

#delete(id:, request_options: nil) ⇒ Object

api.live_shares.delete(id: “id”)



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/samsara_api/live_shares/client.rb', line 161

def delete(id:, request_options: nil)
  response = @request_client.conn.delete do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "id": id }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/live-shares"
end
end

#list(ids: nil, type: nil, limit: nil, after: nil, request_options: nil) ⇒ Object

api.live_shares.list



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/samsara_api/live_shares/client.rb', line 60

def list(ids: nil, type: nil, limit: nil, after: nil, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "ids": ids, "type": type, "limit": limit, "after": after }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(request_options: request_options)}/live-shares"
end
  Samsara::Types::LiveSharingLinksGetLiveSharingLinksResponseBody.from_json(json_object: response.body)
end

#update(id:, description: nil, expires_at_time: nil, name:, request_options: nil) ⇒ Object

api.live_shares.update(id: “id”, name: “Example Live Sharing Link name”)



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/samsara_api/live_shares/client.rb', line 206

def update(id:, description: nil, expires_at_time: nil, name:, request_options: nil)
  response = @request_client.conn.patch do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.token.nil?
req.headers["Authorization"] = request_options.token
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "id": id }.compact
  req.body = { **(request_options&.additional_body_parameters || {}), description: description, expiresAtTime: expires_at_time, name: name }.compact
  req.url "#{@request_client.get_url(request_options: request_options)}/live-shares"
end
  Samsara::Types::LiveSharingLinksUpdateLiveSharingLinkResponseBody.from_json(json_object: response.body)
end