Class: Lockally::WebhooksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/lockally/api/webhooks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebhooksApi

Returns a new instance of WebhooksApi.



19
20
21
 
# File 'lib/lockally/api/webhooks_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/lockally/api/webhooks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_webhooks_get(opts = {}) ⇒ V1WebhooksGet200Response

List webhooks Returns the calling tenant's webhook subscriptions. Never returns the signing secret — only metadata.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/lockally/api/webhooks_api.rb', line 26

def v1_webhooks_get(opts = {})
  data, _status_code, _headers = v1_webhooks_get_with_http_info(opts)
  data
end

#v1_webhooks_get_with_http_info(opts = {}) ⇒ Array<(V1WebhooksGet200Response, Integer, Hash)>

List webhooks Returns the calling tenant's webhook subscriptions. Never returns the signing secret — only metadata.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(V1WebhooksGet200Response, Integer, Hash)>) —

    V1WebhooksGet200Response data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/lockally/api/webhooks_api.rb', line 35

def v1_webhooks_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.v1_webhooks_get ...'
  end
  # resource path
  local_var_path = '/v1/webhooks'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V1WebhooksGet200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.v1_webhooks_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#v1_webhooks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_webhooks_id_delete(id, opts = {}) ⇒ nil

Delete a webhook Hard-delete; cascades to webhook_deliveries history.

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


84
85
86
87
 
# File 'lib/lockally/api/webhooks_api.rb', line 84

def v1_webhooks_id_delete(id, opts = {})
  v1_webhooks_id_delete_with_http_info(id, opts)
  nil
end

#v1_webhooks_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a webhook Hard-delete; cascades to `webhook_deliveries` history.

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/lockally/api/webhooks_api.rb', line 94

def v1_webhooks_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.v1_webhooks_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.v1_webhooks_id_delete"
  end
  # resource path
  local_var_path = '/v1/webhooks/{id}'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.v1_webhooks_id_delete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#v1_webhooks_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_webhooks_id_patch(id, v1_webhooks_id_patch_request, opts = {}) ⇒ Webhook

Update a webhook Supply at least one of url, events, paused. Setting paused to false ALSO resets consecutive_failures to 0 — re-arms the 50-failure auto-pause counter.

Parameters:

  • id (String)
  • v1_webhooks_id_patch_request (V1WebhooksIdPatchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



148
149
150
151
 
# File 'lib/lockally/api/webhooks_api.rb', line 148

def v1_webhooks_id_patch(id, v1_webhooks_id_patch_request, opts = {})
  data, _status_code, _headers = v1_webhooks_id_patch_with_http_info(id, v1_webhooks_id_patch_request, opts)
  data
end

#v1_webhooks_id_patch_with_http_info(id, v1_webhooks_id_patch_request, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>

Update a webhook Supply at least one of `url`, `events`, `paused`. Setting `paused` to `false` ALSO resets `consecutive_failures` to 0 — re-arms the 50-failure auto-pause counter.

Parameters:

  • id (String)
  • v1_webhooks_id_patch_request (V1WebhooksIdPatchRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Webhook, Integer, Hash)>) —

    Webhook data, response status code and response headers



159
160
161
162
163
164
165
166
167
168
169
170
171
172
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
 
# File 'lib/lockally/api/webhooks_api.rb', line 159

def v1_webhooks_id_patch_with_http_info(id, v1_webhooks_id_patch_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.v1_webhooks_id_patch ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.v1_webhooks_id_patch"
  end
  # verify the required parameter 'v1_webhooks_id_patch_request' is set
  if @api_client.config.client_side_validation && v1_webhooks_id_patch_request.nil?
    fail ArgumentError, "Missing the required parameter 'v1_webhooks_id_patch_request' when calling WebhooksApi.v1_webhooks_id_patch"
  end
  # resource path
  local_var_path = '/v1/webhooks/{id}'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(v1_webhooks_id_patch_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Webhook'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.v1_webhooks_id_patch",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#v1_webhooks_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_webhooks_post(v1_webhooks_post_request, opts = {}) ⇒ Webhook

Create a webhook Subscribes a URL to one or more event types. Returns the signing_secret ONCE in the response — store it immediately. The dispatcher signs every outbound POST per design L3: X-Lockally-Signature: t=,v1=<hex(hmac_sha256(secret, t + "." + body))> Verify on your end using HMAC-SHA256 with a 5-minute timestamp window (replay protection). A reference verifier ships in internal/webhook. Event names: see the event catalogue.

Parameters:

  • v1_webhooks_post_request (V1WebhooksPostRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



221
222
223
224
 
# File 'lib/lockally/api/webhooks_api.rb', line 221

def v1_webhooks_post(v1_webhooks_post_request, opts = {})
  data, _status_code, _headers = v1_webhooks_post_with_http_info(v1_webhooks_post_request, opts)
  data
end

#v1_webhooks_post_with_http_info(v1_webhooks_post_request, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>

Create a webhook Subscribes a URL to one or more event types. Returns the `signing_secret` ONCE in the response — store it immediately. The dispatcher signs every outbound POST per design L3: X-Lockally-Signature: t=<unix>,v1=<hex(hmac_sha256(secret, t + &quot;.&quot; + body))> Verify on your end using HMAC-SHA256 with a 5-minute timestamp window (replay protection). A reference verifier ships in internal/webhook. Event names: see the event catalogue.

Parameters:

  • v1_webhooks_post_request (V1WebhooksPostRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Webhook, Integer, Hash)>) —

    Webhook data, response status code and response headers



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/lockally/api/webhooks_api.rb', line 231

def v1_webhooks_post_with_http_info(v1_webhooks_post_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksApi.v1_webhooks_post ...'
  end
  # verify the required parameter 'v1_webhooks_post_request' is set
  if @api_client.config.client_side_validation && v1_webhooks_post_request.nil?
    fail ArgumentError, "Missing the required parameter 'v1_webhooks_post_request' when calling WebhooksApi.v1_webhooks_post"
  end
  # resource path
  local_var_path = '/v1/webhooks'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(v1_webhooks_post_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Webhook'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"WebhooksApi.v1_webhooks_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WebhooksApi#v1_webhooks_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end