Class: Samsara::WebhooksClient
- Inherits:
-
Object
- Object
- Samsara::WebhooksClient
- Defined in:
- lib/samsara_api/webhooks/client.rb
Instance Attribute Summary collapse
Instance Method Summary collapse
-
#create(custom_headers: nil, event_types: nil, name:, url:, version: nil, request_options: nil) ⇒ Object
api.webhooks.create(name: “Webhook-123”, url: “www.Webhook-123.com/webhook/listener”).
-
#delete(id:, request_options: nil) ⇒ Object
api.webhooks.delete(id: “id”).
-
#get(id:, request_options: nil) ⇒ Object
api.webhooks.get(id: “id”).
- #initialize(request_client:) ⇒ Samsara::WebhooksClient constructor
-
#list(ids: nil, limit: nil, after: nil, request_options: nil) ⇒ Object
api.webhooks.list.
-
#patch(id:, custom_headers: nil, name: nil, url: nil, version: nil, request_options: nil) ⇒ Object
api.webhooks.patch(id: “id”).
Constructor Details
#initialize(request_client:) ⇒ Samsara::WebhooksClient
26 27 28 |
# File 'lib/samsara_api/webhooks/client.rb', line 26 def initialize(request_client:) @request_client = request_client end |
Instance Attribute Details
#request_client ⇒ Samsara::RequestClient (readonly)
21 22 23 |
# File 'lib/samsara_api/webhooks/client.rb', line 21 def request_client @request_client end |
Instance Method Details
#create(custom_headers: nil, event_types: nil, name:, url:, version: nil, request_options: nil) ⇒ Object
api.webhooks.create(name: “Webhook-123”, url: “www.Webhook-123.com/webhook/listener”)
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/samsara_api/webhooks/client.rb', line 113 def create(custom_headers: nil, event_types: nil, name:, url:, version: nil, request_options: nil) response = @request_client.conn.post do | req | unless &.timeout_in_seconds.nil? req..timeout = .timeout_in_seconds end unless &.token.nil? req.headers["Authorization"] = .token end req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact unless .nil? || &.additional_query_parameters.nil? req.params = { **(&.additional_query_parameters || {}) }.compact end req.body = { **(&.additional_body_parameters || {}), customHeaders: custom_headers, eventTypes: event_types, name: name, url: url, version: version }.compact req.url "#{@request_client.get_url(request_options: )}/webhooks" end Samsara::Types::WebhooksPostWebhooksResponseBody.from_json(json_object: response.body) end |
#delete(id:, request_options: nil) ⇒ Object
api.webhooks.delete(id: “id”)
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/samsara_api/webhooks/client.rb', line 199 def delete(id:, request_options: nil) response = @request_client.conn.delete do | req | unless &.timeout_in_seconds.nil? req..timeout = .timeout_in_seconds end unless &.token.nil? req.headers["Authorization"] = .token end req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact unless .nil? || &.additional_query_parameters.nil? req.params = { **(&.additional_query_parameters || {}) }.compact end unless .nil? || &.additional_body_parameters.nil? req.body = { **(&.additional_body_parameters || {}) }.compact end req.url "#{@request_client.get_url(request_options: )}/webhooks/#{id}" end end |
#get(id:, request_options: nil) ⇒ Object
api.webhooks.get(id: “id”)
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/samsara_api/webhooks/client.rb', line 155 def get(id:, request_options: nil) response = @request_client.conn.get do | req | unless &.timeout_in_seconds.nil? req..timeout = .timeout_in_seconds end unless &.token.nil? req.headers["Authorization"] = .token end req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact unless .nil? || &.additional_query_parameters.nil? req.params = { **(&.additional_query_parameters || {}) }.compact end unless .nil? || &.additional_body_parameters.nil? req.body = { **(&.additional_body_parameters || {}) }.compact end req.url "#{@request_client.get_url(request_options: )}/webhooks/#{id}" end Samsara::Types::WebhooksGetWebhookResponseBody.from_json(json_object: response.body) end |
#list(ids: nil, limit: nil, after: nil, request_options: nil) ⇒ Object
api.webhooks.list
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/samsara_api/webhooks/client.rb', line 60 def list(ids: nil, limit: nil, after: nil, request_options: nil) response = @request_client.conn.get do | req | unless &.timeout_in_seconds.nil? req..timeout = .timeout_in_seconds end unless &.token.nil? req.headers["Authorization"] = .token end req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact req.params = { **(&.additional_query_parameters || {}), "ids": ids, "limit": limit, "after": after }.compact unless .nil? || &.additional_body_parameters.nil? req.body = { **(&.additional_body_parameters || {}) }.compact end req.url "#{@request_client.get_url(request_options: )}/webhooks" end Samsara::Types::WebhooksListWebhooksResponseBody.from_json(json_object: response.body) end |
#patch(id:, custom_headers: nil, name: nil, url: nil, version: nil, request_options: nil) ⇒ Object
api.webhooks.patch(id: “id”)
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/samsara_api/webhooks/client.rb', line 259 def patch(id:, custom_headers: nil, name: nil, url: nil, version: nil, request_options: nil) response = @request_client.conn.patch do | req | unless &.timeout_in_seconds.nil? req..timeout = .timeout_in_seconds end unless &.token.nil? req.headers["Authorization"] = .token end req.headers = { **(req.headers || {}), **@request_client.get_headers, **(&.additional_headers || {}) }.compact unless .nil? || &.additional_query_parameters.nil? req.params = { **(&.additional_query_parameters || {}) }.compact end req.body = { **(&.additional_body_parameters || {}), customHeaders: custom_headers, name: name, url: url, version: version }.compact req.url "#{@request_client.get_url(request_options: )}/webhooks/#{id}" end Samsara::Types::WebhooksPatchWebhookResponseBody.from_json(json_object: response.body) end |