svix 0.41.0 → 0.48.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +62 -8
- data/lib/svix/api/application_api.rb +23 -1
- data/lib/svix/api/authentication_api.rb +7 -1
- data/lib/svix/api/endpoint_api.rb +61 -18
- data/lib/svix/api/environment_api.rb +158 -0
- data/lib/svix/api/environment_settings_api.rb +82 -0
- data/lib/svix/api/event_type_api.rb +23 -1
- data/lib/svix/api/health_api.rb +6 -1
- data/lib/svix/api/integration_api.rb +627 -0
- data/lib/svix/api/message_api.rb +31 -3
- data/lib/svix/api/message_attempt_api.rb +359 -5
- data/lib/svix/api/organization_api.rb +152 -0
- data/lib/svix/api/organization_settings_api.rb +7 -7
- data/lib/svix/api/statistics_api.rb +7 -1
- data/lib/svix/api_client.rb +1 -1
- data/lib/svix/api_error.rb +1 -1
- data/lib/svix/configuration.rb +1 -1
- data/lib/svix/endpoint_api.rb +1 -1
- data/lib/svix/integration_api.rb +38 -0
- data/lib/svix/internal.rb +1 -0
- data/lib/svix/message_attempt_api.rb +11 -1
- data/lib/svix/models/application_in.rb +1 -1
- data/lib/svix/models/application_out.rb +1 -1
- data/lib/svix/models/attempt_statistics_data.rb +1 -1
- data/lib/svix/models/attempt_statistics_response.rb +1 -1
- data/lib/svix/models/border_radius_config.rb +1 -1
- data/lib/svix/models/border_radius_enum.rb +1 -1
- data/lib/svix/models/custom_theme_override.rb +1 -1
- data/lib/svix/models/dashboard_access_out.rb +1 -1
- data/lib/svix/models/endpoint_created_event.rb +1 -1
- data/lib/svix/models/endpoint_created_event_data.rb +1 -1
- data/lib/svix/models/endpoint_deleted_event.rb +1 -1
- data/lib/svix/models/endpoint_deleted_event_data.rb +1 -1
- data/lib/svix/models/endpoint_disabled_event.rb +1 -1
- data/lib/svix/models/endpoint_disabled_event_data.rb +1 -1
- data/lib/svix/models/endpoint_headers_in.rb +1 -1
- data/lib/svix/models/endpoint_headers_out.rb +1 -1
- data/lib/svix/models/endpoint_in.rb +38 -2
- data/lib/svix/models/endpoint_message_out.rb +38 -2
- data/lib/svix/models/endpoint_out.rb +38 -2
- data/lib/svix/models/endpoint_secret_out.rb +1 -1
- data/lib/svix/models/endpoint_secret_rotate_in.rb +1 -1
- data/lib/svix/models/endpoint_stats.rb +1 -1
- data/lib/svix/models/endpoint_update.rb +38 -2
- data/lib/svix/models/endpoint_updated_event.rb +1 -1
- data/lib/svix/models/endpoint_updated_event_data.rb +1 -1
- data/lib/svix/models/environment_in.rb +257 -0
- data/lib/svix/models/environment_out.rb +259 -0
- data/lib/svix/models/environment_settings_out.rb +308 -0
- data/lib/svix/models/event_example_in.rb +1 -1
- data/lib/svix/models/event_type_example_out.rb +1 -1
- data/lib/svix/models/event_type_in.rb +1 -1
- data/lib/svix/models/event_type_out.rb +1 -1
- data/lib/svix/models/event_type_schema_in.rb +1 -1
- data/lib/svix/models/event_type_update.rb +1 -1
- data/lib/svix/models/export_organization_out.rb +259 -0
- data/lib/svix/models/font_size_config.rb +1 -1
- data/lib/svix/models/http_error_out.rb +1 -1
- data/lib/svix/models/http_validation_error.rb +1 -1
- data/lib/svix/models/import_organization_in.rb +257 -0
- data/lib/svix/models/integration_in.rb +223 -0
- data/lib/svix/models/integration_key_out.rb +223 -0
- data/lib/svix/models/integration_out.rb +265 -0
- data/lib/svix/models/integration_update.rb +223 -0
- data/lib/svix/models/list_response_application_out.rb +1 -1
- data/lib/svix/models/list_response_endpoint_message_out.rb +1 -1
- data/lib/svix/models/list_response_endpoint_out.rb +1 -1
- data/lib/svix/models/list_response_event_type_out.rb +1 -1
- data/lib/svix/models/list_response_integration_out.rb +248 -0
- data/lib/svix/models/list_response_message_attempt_endpoint_out.rb +1 -1
- data/lib/svix/models/list_response_message_attempt_out.rb +1 -1
- data/lib/svix/models/list_response_message_endpoint_out.rb +1 -1
- data/lib/svix/models/list_response_message_out.rb +1 -1
- data/lib/svix/models/message_attempt_endpoint_out.rb +16 -2
- data/lib/svix/models/message_attempt_exhausted_event.rb +1 -1
- data/lib/svix/models/message_attempt_exhausted_event_data.rb +1 -1
- data/lib/svix/models/message_attempt_failed_event.rb +1 -1
- data/lib/svix/models/message_attempt_out.rb +1 -1
- data/lib/svix/models/message_attempt_trigger_type.rb +1 -1
- data/lib/svix/models/message_endpoint_out.rb +38 -2
- data/lib/svix/models/message_in.rb +38 -2
- data/lib/svix/models/message_out.rb +38 -2
- data/lib/svix/models/message_status.rb +1 -1
- data/lib/svix/models/portal_settings_out.rb +16 -5
- data/lib/svix/models/recover_in.rb +1 -1
- data/lib/svix/models/settings_in.rb +339 -0
- data/lib/svix/models/settings_out.rb +339 -0
- data/lib/svix/models/statistics_period.rb +1 -1
- data/lib/svix/models/validation_error.rb +1 -1
- data/lib/svix/models/webhook_types.rb +1 -1
- data/lib/svix/svix.rb +2 -0
- data/lib/svix/version.rb +1 -1
- data/lib/svix.rb +8 -2
- metadata +23 -6
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Svix API
|
3
3
|
|
4
|
-
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
4
|
+
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.4
|
7
7
|
|
@@ -25,6 +25,7 @@ module Svix
|
|
25
25
|
# @param msg_id [String]
|
26
26
|
# @param app_id [String]
|
27
27
|
# @param [Hash] opts the optional parameters
|
28
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
28
29
|
# @return [MessageAttemptOut]
|
29
30
|
def get_attempt_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_get(attempt_id, msg_id, app_id, opts = {})
|
30
31
|
data, _status_code, _headers = get_attempt_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_get_with_http_info(attempt_id, msg_id, app_id, opts)
|
@@ -37,6 +38,7 @@ module Svix
|
|
37
38
|
# @param msg_id [String]
|
38
39
|
# @param app_id [String]
|
39
40
|
# @param [Hash] opts the optional parameters
|
41
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
40
42
|
# @return [Array<(MessageAttemptOut, Integer, Hash)>] MessageAttemptOut data, response status code and response headers
|
41
43
|
def get_attempt_api_v1_app_app_id_msg_msg_id_attempt_attempt_id_get_with_http_info(attempt_id, msg_id, app_id, opts = {})
|
42
44
|
if @api_client.config.debugging
|
@@ -90,6 +92,7 @@ module Svix
|
|
90
92
|
header_params = opts[:header_params] || {}
|
91
93
|
# HTTP header 'Accept' (if needed)
|
92
94
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
95
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
93
96
|
|
94
97
|
# form parameters
|
95
98
|
form_params = opts[:form_params] || {}
|
@@ -127,6 +130,7 @@ module Svix
|
|
127
130
|
# @param [Hash] opts the optional parameters
|
128
131
|
# @option opts [String] :iterator
|
129
132
|
# @option opts [Integer] :limit (default to 50)
|
133
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
130
134
|
# @return [ListResponseMessageEndpointOut]
|
131
135
|
def list_attempted_destinations_api_v1_app_app_id_msg_msg_id_endpoint_get(msg_id, app_id, opts = {})
|
132
136
|
data, _status_code, _headers = list_attempted_destinations_api_v1_app_app_id_msg_msg_id_endpoint_get_with_http_info(msg_id, app_id, opts)
|
@@ -140,6 +144,7 @@ module Svix
|
|
140
144
|
# @param [Hash] opts the optional parameters
|
141
145
|
# @option opts [String] :iterator
|
142
146
|
# @option opts [Integer] :limit
|
147
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
143
148
|
# @return [Array<(ListResponseMessageEndpointOut, Integer, Hash)>] ListResponseMessageEndpointOut data, response status code and response headers
|
144
149
|
def list_attempted_destinations_api_v1_app_app_id_msg_msg_id_endpoint_get_with_http_info(msg_id, app_id, opts = {})
|
145
150
|
if @api_client.config.debugging
|
@@ -179,6 +184,10 @@ module Svix
|
|
179
184
|
fail ArgumentError, "invalid value for 'app_id' when calling MessageAttemptApi.list_attempted_destinations_api_v1_app_app_id_msg_msg_id_endpoint_get, must conform to the pattern #{pattern}."
|
180
185
|
end
|
181
186
|
|
187
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
|
188
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.list_attempted_destinations_api_v1_app_app_id_msg_msg_id_endpoint_get, must be smaller than or equal to 250.'
|
189
|
+
end
|
190
|
+
|
182
191
|
# resource path
|
183
192
|
local_var_path = '/api/v1/app/{app_id}/msg/{msg_id}/endpoint/'.sub('{' + 'msg_id' + '}', CGI.escape(msg_id.to_s)).sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
|
184
193
|
|
@@ -191,6 +200,7 @@ module Svix
|
|
191
200
|
header_params = opts[:header_params] || {}
|
192
201
|
# HTTP header 'Accept' (if needed)
|
193
202
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
203
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
194
204
|
|
195
205
|
# form parameters
|
196
206
|
form_params = opts[:form_params] || {}
|
@@ -221,6 +231,280 @@ module Svix
|
|
221
231
|
return data, status_code, headers
|
222
232
|
end
|
223
233
|
|
234
|
+
# List Attempted Destinations By Endpoint
|
235
|
+
# List attempts by endpoint id
|
236
|
+
# @param app_id [String]
|
237
|
+
# @param endpoint_id [String]
|
238
|
+
# @param [Hash] opts the optional parameters
|
239
|
+
# @option opts [String] :iterator
|
240
|
+
# @option opts [Integer] :limit (default to 50)
|
241
|
+
# @option opts [MessageStatus] :status
|
242
|
+
# @option opts [Array<String>] :event_types
|
243
|
+
# @option opts [String] :channel
|
244
|
+
# @option opts [Time] :before
|
245
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
246
|
+
# @return [ListResponseMessageAttemptOut]
|
247
|
+
def list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get(app_id, endpoint_id, opts = {})
|
248
|
+
data, _status_code, _headers = list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get_with_http_info(app_id, endpoint_id, opts)
|
249
|
+
data
|
250
|
+
end
|
251
|
+
|
252
|
+
# List Attempted Destinations By Endpoint
|
253
|
+
# List attempts by endpoint id
|
254
|
+
# @param app_id [String]
|
255
|
+
# @param endpoint_id [String]
|
256
|
+
# @param [Hash] opts the optional parameters
|
257
|
+
# @option opts [String] :iterator
|
258
|
+
# @option opts [Integer] :limit
|
259
|
+
# @option opts [MessageStatus] :status
|
260
|
+
# @option opts [Array<String>] :event_types
|
261
|
+
# @option opts [String] :channel
|
262
|
+
# @option opts [Time] :before
|
263
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
264
|
+
# @return [Array<(ListResponseMessageAttemptOut, Integer, Hash)>] ListResponseMessageAttemptOut data, response status code and response headers
|
265
|
+
def list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get_with_http_info(app_id, endpoint_id, opts = {})
|
266
|
+
if @api_client.config.debugging
|
267
|
+
@api_client.config.logger.debug 'Calling API: MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get ...'
|
268
|
+
end
|
269
|
+
# verify the required parameter 'app_id' is set
|
270
|
+
if @api_client.config.client_side_validation && app_id.nil?
|
271
|
+
fail ArgumentError, "Missing the required parameter 'app_id' when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get"
|
272
|
+
end
|
273
|
+
if @api_client.config.client_side_validation && app_id.to_s.length > 256
|
274
|
+
fail ArgumentError, 'invalid value for "app_id" when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get, the character length must be smaller than or equal to 256.'
|
275
|
+
end
|
276
|
+
|
277
|
+
if @api_client.config.client_side_validation && app_id.to_s.length < 1
|
278
|
+
fail ArgumentError, 'invalid value for "app_id" when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get, the character length must be great than or equal to 1.'
|
279
|
+
end
|
280
|
+
|
281
|
+
pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
282
|
+
if @api_client.config.client_side_validation && app_id !~ pattern
|
283
|
+
fail ArgumentError, "invalid value for 'app_id' when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get, must conform to the pattern #{pattern}."
|
284
|
+
end
|
285
|
+
|
286
|
+
# verify the required parameter 'endpoint_id' is set
|
287
|
+
if @api_client.config.client_side_validation && endpoint_id.nil?
|
288
|
+
fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get"
|
289
|
+
end
|
290
|
+
if @api_client.config.client_side_validation && endpoint_id.to_s.length > 256
|
291
|
+
fail ArgumentError, 'invalid value for "endpoint_id" when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get, the character length must be smaller than or equal to 256.'
|
292
|
+
end
|
293
|
+
|
294
|
+
if @api_client.config.client_side_validation && endpoint_id.to_s.length < 1
|
295
|
+
fail ArgumentError, 'invalid value for "endpoint_id" when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get, the character length must be great than or equal to 1.'
|
296
|
+
end
|
297
|
+
|
298
|
+
pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
299
|
+
if @api_client.config.client_side_validation && endpoint_id !~ pattern
|
300
|
+
fail ArgumentError, "invalid value for 'endpoint_id' when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get, must conform to the pattern #{pattern}."
|
301
|
+
end
|
302
|
+
|
303
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
|
304
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get, must be smaller than or equal to 250.'
|
305
|
+
end
|
306
|
+
|
307
|
+
if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
|
308
|
+
fail ArgumentError, 'invalid value for "opts[:"channel"]" when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get, the character length must be smaller than or equal to 128.'
|
309
|
+
end
|
310
|
+
|
311
|
+
pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
312
|
+
if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'] !~ pattern
|
313
|
+
fail ArgumentError, "invalid value for 'opts[:\"channel\"]' when calling MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get, must conform to the pattern #{pattern}."
|
314
|
+
end
|
315
|
+
|
316
|
+
# resource path
|
317
|
+
local_var_path = '/api/v1/app/{app_id}/attempt/endpoint/{endpoint_id}/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'endpoint_id' + '}', CGI.escape(endpoint_id.to_s))
|
318
|
+
|
319
|
+
# query parameters
|
320
|
+
query_params = opts[:query_params] || {}
|
321
|
+
query_params[:'iterator'] = opts[:'iterator'] if !opts[:'iterator'].nil?
|
322
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
323
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
324
|
+
query_params[:'event_types'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
|
325
|
+
query_params[:'channel'] = opts[:'channel'] if !opts[:'channel'].nil?
|
326
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
327
|
+
|
328
|
+
# header parameters
|
329
|
+
header_params = opts[:header_params] || {}
|
330
|
+
# HTTP header 'Accept' (if needed)
|
331
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
332
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
333
|
+
|
334
|
+
# form parameters
|
335
|
+
form_params = opts[:form_params] || {}
|
336
|
+
|
337
|
+
# http body (model)
|
338
|
+
post_body = opts[:debug_body]
|
339
|
+
|
340
|
+
# return_type
|
341
|
+
return_type = opts[:debug_return_type] || 'ListResponseMessageAttemptOut'
|
342
|
+
|
343
|
+
# auth_names
|
344
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
345
|
+
|
346
|
+
new_options = opts.merge(
|
347
|
+
:operation => :"MessageAttemptApi.list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get",
|
348
|
+
:header_params => header_params,
|
349
|
+
:query_params => query_params,
|
350
|
+
:form_params => form_params,
|
351
|
+
:body => post_body,
|
352
|
+
:auth_names => auth_names,
|
353
|
+
:return_type => return_type
|
354
|
+
)
|
355
|
+
|
356
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
357
|
+
if @api_client.config.debugging
|
358
|
+
@api_client.config.logger.debug "API called: MessageAttemptApi#list_attempted_destinations_by_endpoint_api_v1_app_app_id_attempt_endpoint_endpoint_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
359
|
+
end
|
360
|
+
return data, status_code, headers
|
361
|
+
end
|
362
|
+
|
363
|
+
# List Attempted Destinations By Msg
|
364
|
+
# List attempts by message id
|
365
|
+
# @param app_id [String]
|
366
|
+
# @param msg_id [String]
|
367
|
+
# @param [Hash] opts the optional parameters
|
368
|
+
# @option opts [String] :endpoint_id
|
369
|
+
# @option opts [String] :iterator
|
370
|
+
# @option opts [Integer] :limit (default to 50)
|
371
|
+
# @option opts [MessageStatus] :status
|
372
|
+
# @option opts [Array<String>] :event_types
|
373
|
+
# @option opts [String] :channel
|
374
|
+
# @option opts [Time] :before
|
375
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
376
|
+
# @return [ListResponseMessageAttemptOut]
|
377
|
+
def list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get(app_id, msg_id, opts = {})
|
378
|
+
data, _status_code, _headers = list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get_with_http_info(app_id, msg_id, opts)
|
379
|
+
data
|
380
|
+
end
|
381
|
+
|
382
|
+
# List Attempted Destinations By Msg
|
383
|
+
# List attempts by message id
|
384
|
+
# @param app_id [String]
|
385
|
+
# @param msg_id [String]
|
386
|
+
# @param [Hash] opts the optional parameters
|
387
|
+
# @option opts [String] :endpoint_id
|
388
|
+
# @option opts [String] :iterator
|
389
|
+
# @option opts [Integer] :limit
|
390
|
+
# @option opts [MessageStatus] :status
|
391
|
+
# @option opts [Array<String>] :event_types
|
392
|
+
# @option opts [String] :channel
|
393
|
+
# @option opts [Time] :before
|
394
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
395
|
+
# @return [Array<(ListResponseMessageAttemptOut, Integer, Hash)>] ListResponseMessageAttemptOut data, response status code and response headers
|
396
|
+
def list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get_with_http_info(app_id, msg_id, opts = {})
|
397
|
+
if @api_client.config.debugging
|
398
|
+
@api_client.config.logger.debug 'Calling API: MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get ...'
|
399
|
+
end
|
400
|
+
# verify the required parameter 'app_id' is set
|
401
|
+
if @api_client.config.client_side_validation && app_id.nil?
|
402
|
+
fail ArgumentError, "Missing the required parameter 'app_id' when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get"
|
403
|
+
end
|
404
|
+
if @api_client.config.client_side_validation && app_id.to_s.length > 256
|
405
|
+
fail ArgumentError, 'invalid value for "app_id" when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, the character length must be smaller than or equal to 256.'
|
406
|
+
end
|
407
|
+
|
408
|
+
if @api_client.config.client_side_validation && app_id.to_s.length < 1
|
409
|
+
fail ArgumentError, 'invalid value for "app_id" when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, the character length must be great than or equal to 1.'
|
410
|
+
end
|
411
|
+
|
412
|
+
pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
413
|
+
if @api_client.config.client_side_validation && app_id !~ pattern
|
414
|
+
fail ArgumentError, "invalid value for 'app_id' when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, must conform to the pattern #{pattern}."
|
415
|
+
end
|
416
|
+
|
417
|
+
# verify the required parameter 'msg_id' is set
|
418
|
+
if @api_client.config.client_side_validation && msg_id.nil?
|
419
|
+
fail ArgumentError, "Missing the required parameter 'msg_id' when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get"
|
420
|
+
end
|
421
|
+
if @api_client.config.client_side_validation && msg_id.to_s.length > 256
|
422
|
+
fail ArgumentError, 'invalid value for "msg_id" when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, the character length must be smaller than or equal to 256.'
|
423
|
+
end
|
424
|
+
|
425
|
+
if @api_client.config.client_side_validation && msg_id.to_s.length < 1
|
426
|
+
fail ArgumentError, 'invalid value for "msg_id" when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, the character length must be great than or equal to 1.'
|
427
|
+
end
|
428
|
+
|
429
|
+
pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
430
|
+
if @api_client.config.client_side_validation && msg_id !~ pattern
|
431
|
+
fail ArgumentError, "invalid value for 'msg_id' when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, must conform to the pattern #{pattern}."
|
432
|
+
end
|
433
|
+
|
434
|
+
if @api_client.config.client_side_validation && !opts[:'endpoint_id'].nil? && opts[:'endpoint_id'].to_s.length > 256
|
435
|
+
fail ArgumentError, 'invalid value for "opts[:"endpoint_id"]" when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, the character length must be smaller than or equal to 256.'
|
436
|
+
end
|
437
|
+
|
438
|
+
if @api_client.config.client_side_validation && !opts[:'endpoint_id'].nil? && opts[:'endpoint_id'].to_s.length < 1
|
439
|
+
fail ArgumentError, 'invalid value for "opts[:"endpoint_id"]" when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, the character length must be great than or equal to 1.'
|
440
|
+
end
|
441
|
+
|
442
|
+
pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
443
|
+
if @api_client.config.client_side_validation && !opts[:'endpoint_id'].nil? && opts[:'endpoint_id'] !~ pattern
|
444
|
+
fail ArgumentError, "invalid value for 'opts[:\"endpoint_id\"]' when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, must conform to the pattern #{pattern}."
|
445
|
+
end
|
446
|
+
|
447
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
|
448
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, must be smaller than or equal to 250.'
|
449
|
+
end
|
450
|
+
|
451
|
+
if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
|
452
|
+
fail ArgumentError, 'invalid value for "opts[:"channel"]" when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, the character length must be smaller than or equal to 128.'
|
453
|
+
end
|
454
|
+
|
455
|
+
pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
456
|
+
if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'] !~ pattern
|
457
|
+
fail ArgumentError, "invalid value for 'opts[:\"channel\"]' when calling MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get, must conform to the pattern #{pattern}."
|
458
|
+
end
|
459
|
+
|
460
|
+
# resource path
|
461
|
+
local_var_path = '/api/v1/app/{app_id}/attempt/msg/{msg_id}/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'msg_id' + '}', CGI.escape(msg_id.to_s))
|
462
|
+
|
463
|
+
# query parameters
|
464
|
+
query_params = opts[:query_params] || {}
|
465
|
+
query_params[:'endpoint_id'] = opts[:'endpoint_id'] if !opts[:'endpoint_id'].nil?
|
466
|
+
query_params[:'iterator'] = opts[:'iterator'] if !opts[:'iterator'].nil?
|
467
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
468
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
469
|
+
query_params[:'event_types'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
|
470
|
+
query_params[:'channel'] = opts[:'channel'] if !opts[:'channel'].nil?
|
471
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
472
|
+
|
473
|
+
# header parameters
|
474
|
+
header_params = opts[:header_params] || {}
|
475
|
+
# HTTP header 'Accept' (if needed)
|
476
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
477
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
478
|
+
|
479
|
+
# form parameters
|
480
|
+
form_params = opts[:form_params] || {}
|
481
|
+
|
482
|
+
# http body (model)
|
483
|
+
post_body = opts[:debug_body]
|
484
|
+
|
485
|
+
# return_type
|
486
|
+
return_type = opts[:debug_return_type] || 'ListResponseMessageAttemptOut'
|
487
|
+
|
488
|
+
# auth_names
|
489
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
490
|
+
|
491
|
+
new_options = opts.merge(
|
492
|
+
:operation => :"MessageAttemptApi.list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get",
|
493
|
+
:header_params => header_params,
|
494
|
+
:query_params => query_params,
|
495
|
+
:form_params => form_params,
|
496
|
+
:body => post_body,
|
497
|
+
:auth_names => auth_names,
|
498
|
+
:return_type => return_type
|
499
|
+
)
|
500
|
+
|
501
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
502
|
+
if @api_client.config.debugging
|
503
|
+
@api_client.config.logger.debug "API called: MessageAttemptApi#list_attempted_destinations_by_msg_api_v1_app_app_id_attempt_msg_msg_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
504
|
+
end
|
505
|
+
return data, status_code, headers
|
506
|
+
end
|
507
|
+
|
224
508
|
# List Attempted Messages
|
225
509
|
# List messages for a particular endpoint. Additionally includes metadata about the latest message attempt. The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
|
226
510
|
# @param endpoint_id [String]
|
@@ -230,6 +514,7 @@ module Svix
|
|
230
514
|
# @option opts [Integer] :limit (default to 50)
|
231
515
|
# @option opts [MessageStatus] :status
|
232
516
|
# @option opts [Time] :before
|
517
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
233
518
|
# @return [ListResponseEndpointMessageOut]
|
234
519
|
def list_attempted_messages_api_v1_app_app_id_endpoint_endpoint_id_msg_get(endpoint_id, app_id, opts = {})
|
235
520
|
data, _status_code, _headers = list_attempted_messages_api_v1_app_app_id_endpoint_endpoint_id_msg_get_with_http_info(endpoint_id, app_id, opts)
|
@@ -245,6 +530,7 @@ module Svix
|
|
245
530
|
# @option opts [Integer] :limit
|
246
531
|
# @option opts [MessageStatus] :status
|
247
532
|
# @option opts [Time] :before
|
533
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
248
534
|
# @return [Array<(ListResponseEndpointMessageOut, Integer, Hash)>] ListResponseEndpointMessageOut data, response status code and response headers
|
249
535
|
def list_attempted_messages_api_v1_app_app_id_endpoint_endpoint_id_msg_get_with_http_info(endpoint_id, app_id, opts = {})
|
250
536
|
if @api_client.config.debugging
|
@@ -284,6 +570,10 @@ module Svix
|
|
284
570
|
fail ArgumentError, "invalid value for 'app_id' when calling MessageAttemptApi.list_attempted_messages_api_v1_app_app_id_endpoint_endpoint_id_msg_get, must conform to the pattern #{pattern}."
|
285
571
|
end
|
286
572
|
|
573
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
|
574
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.list_attempted_messages_api_v1_app_app_id_endpoint_endpoint_id_msg_get, must be smaller than or equal to 250.'
|
575
|
+
end
|
576
|
+
|
287
577
|
# resource path
|
288
578
|
local_var_path = '/api/v1/app/{app_id}/endpoint/{endpoint_id}/msg/'.sub('{' + 'endpoint_id' + '}', CGI.escape(endpoint_id.to_s)).sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
|
289
579
|
|
@@ -298,6 +588,7 @@ module Svix
|
|
298
588
|
header_params = opts[:header_params] || {}
|
299
589
|
# HTTP header 'Accept' (if needed)
|
300
590
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
591
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
301
592
|
|
302
593
|
# form parameters
|
303
594
|
form_params = opts[:form_params] || {}
|
@@ -329,13 +620,18 @@ module Svix
|
|
329
620
|
end
|
330
621
|
|
331
622
|
# List Attempts
|
332
|
-
# `msg_id`: Use a message id or a message `eventId`
|
623
|
+
# Deprecated: Please use the /attempt/ api instead. `msg_id`: Use a message id or a message `eventId`
|
333
624
|
# @param app_id [String]
|
334
625
|
# @param msg_id [String]
|
335
626
|
# @param [Hash] opts the optional parameters
|
336
627
|
# @option opts [String] :iterator
|
337
628
|
# @option opts [Integer] :limit (default to 50)
|
629
|
+
# @option opts [String] :endpoint_id
|
630
|
+
# @option opts [Array<String>] :event_types
|
631
|
+
# @option opts [String] :channel
|
338
632
|
# @option opts [MessageStatus] :status
|
633
|
+
# @option opts [Time] :before
|
634
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
339
635
|
# @return [ListResponseMessageAttemptOut]
|
340
636
|
def list_attempts_api_v1_app_app_id_msg_msg_id_attempt_get(app_id, msg_id, opts = {})
|
341
637
|
data, _status_code, _headers = list_attempts_api_v1_app_app_id_msg_msg_id_attempt_get_with_http_info(app_id, msg_id, opts)
|
@@ -343,13 +639,18 @@ module Svix
|
|
343
639
|
end
|
344
640
|
|
345
641
|
# List Attempts
|
346
|
-
# `msg_id`: Use a message id or a message `eventId`
|
642
|
+
# Deprecated: Please use the /attempt/ api instead. `msg_id`: Use a message id or a message `eventId`
|
347
643
|
# @param app_id [String]
|
348
644
|
# @param msg_id [String]
|
349
645
|
# @param [Hash] opts the optional parameters
|
350
646
|
# @option opts [String] :iterator
|
351
647
|
# @option opts [Integer] :limit
|
648
|
+
# @option opts [String] :endpoint_id
|
649
|
+
# @option opts [Array<String>] :event_types
|
650
|
+
# @option opts [String] :channel
|
352
651
|
# @option opts [MessageStatus] :status
|
652
|
+
# @option opts [Time] :before
|
653
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
353
654
|
# @return [Array<(ListResponseMessageAttemptOut, Integer, Hash)>] ListResponseMessageAttemptOut data, response status code and response headers
|
354
655
|
def list_attempts_api_v1_app_app_id_msg_msg_id_attempt_get_with_http_info(app_id, msg_id, opts = {})
|
355
656
|
if @api_client.config.debugging
|
@@ -389,6 +690,32 @@ module Svix
|
|
389
690
|
fail ArgumentError, "invalid value for 'msg_id' when calling MessageAttemptApi.list_attempts_api_v1_app_app_id_msg_msg_id_attempt_get, must conform to the pattern #{pattern}."
|
390
691
|
end
|
391
692
|
|
693
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
|
694
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.list_attempts_api_v1_app_app_id_msg_msg_id_attempt_get, must be smaller than or equal to 250.'
|
695
|
+
end
|
696
|
+
|
697
|
+
if @api_client.config.client_side_validation && !opts[:'endpoint_id'].nil? && opts[:'endpoint_id'].to_s.length > 256
|
698
|
+
fail ArgumentError, 'invalid value for "opts[:"endpoint_id"]" when calling MessageAttemptApi.list_attempts_api_v1_app_app_id_msg_msg_id_attempt_get, the character length must be smaller than or equal to 256.'
|
699
|
+
end
|
700
|
+
|
701
|
+
if @api_client.config.client_side_validation && !opts[:'endpoint_id'].nil? && opts[:'endpoint_id'].to_s.length < 1
|
702
|
+
fail ArgumentError, 'invalid value for "opts[:"endpoint_id"]" when calling MessageAttemptApi.list_attempts_api_v1_app_app_id_msg_msg_id_attempt_get, the character length must be great than or equal to 1.'
|
703
|
+
end
|
704
|
+
|
705
|
+
pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
706
|
+
if @api_client.config.client_side_validation && !opts[:'endpoint_id'].nil? && opts[:'endpoint_id'] !~ pattern
|
707
|
+
fail ArgumentError, "invalid value for 'opts[:\"endpoint_id\"]' when calling MessageAttemptApi.list_attempts_api_v1_app_app_id_msg_msg_id_attempt_get, must conform to the pattern #{pattern}."
|
708
|
+
end
|
709
|
+
|
710
|
+
if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
|
711
|
+
fail ArgumentError, 'invalid value for "opts[:"channel"]" when calling MessageAttemptApi.list_attempts_api_v1_app_app_id_msg_msg_id_attempt_get, the character length must be smaller than or equal to 128.'
|
712
|
+
end
|
713
|
+
|
714
|
+
pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
715
|
+
if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'] !~ pattern
|
716
|
+
fail ArgumentError, "invalid value for 'opts[:\"channel\"]' when calling MessageAttemptApi.list_attempts_api_v1_app_app_id_msg_msg_id_attempt_get, must conform to the pattern #{pattern}."
|
717
|
+
end
|
718
|
+
|
392
719
|
# resource path
|
393
720
|
local_var_path = '/api/v1/app/{app_id}/msg/{msg_id}/attempt/'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'msg_id' + '}', CGI.escape(msg_id.to_s))
|
394
721
|
|
@@ -396,12 +723,17 @@ module Svix
|
|
396
723
|
query_params = opts[:query_params] || {}
|
397
724
|
query_params[:'iterator'] = opts[:'iterator'] if !opts[:'iterator'].nil?
|
398
725
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
726
|
+
query_params[:'endpoint_id'] = opts[:'endpoint_id'] if !opts[:'endpoint_id'].nil?
|
727
|
+
query_params[:'event_types'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
|
728
|
+
query_params[:'channel'] = opts[:'channel'] if !opts[:'channel'].nil?
|
399
729
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
730
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
400
731
|
|
401
732
|
# header parameters
|
402
733
|
header_params = opts[:header_params] || {}
|
403
734
|
# HTTP header 'Accept' (if needed)
|
404
735
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
736
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
405
737
|
|
406
738
|
# form parameters
|
407
739
|
form_params = opts[:form_params] || {}
|
@@ -433,7 +765,7 @@ module Svix
|
|
433
765
|
end
|
434
766
|
|
435
767
|
# List Attempts For Endpoint
|
436
|
-
# List the message attempts for a particular endpoint. Returning the endpoint. The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
|
768
|
+
# DEPRECATED: please use list_attempts with endpoint_id as a query parameter instead. List the message attempts for a particular endpoint. Returning the endpoint. The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
|
437
769
|
# @param msg_id [String]
|
438
770
|
# @param app_id [String]
|
439
771
|
# @param endpoint_id [String]
|
@@ -441,8 +773,10 @@ module Svix
|
|
441
773
|
# @option opts [String] :iterator
|
442
774
|
# @option opts [Integer] :limit (default to 50)
|
443
775
|
# @option opts [Array<String>] :event_types
|
776
|
+
# @option opts [String] :channel
|
444
777
|
# @option opts [MessageStatus] :status
|
445
778
|
# @option opts [Time] :before
|
779
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
446
780
|
# @return [ListResponseMessageAttemptEndpointOut]
|
447
781
|
def list_attempts_for_endpoint_api_v1_app_app_id_msg_msg_id_endpoint_endpoint_id_attempt_get(msg_id, app_id, endpoint_id, opts = {})
|
448
782
|
data, _status_code, _headers = list_attempts_for_endpoint_api_v1_app_app_id_msg_msg_id_endpoint_endpoint_id_attempt_get_with_http_info(msg_id, app_id, endpoint_id, opts)
|
@@ -450,7 +784,7 @@ module Svix
|
|
450
784
|
end
|
451
785
|
|
452
786
|
# List Attempts For Endpoint
|
453
|
-
# List the message attempts for a particular endpoint. Returning the endpoint. The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
|
787
|
+
# DEPRECATED: please use list_attempts with endpoint_id as a query parameter instead. List the message attempts for a particular endpoint. Returning the endpoint. The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed.
|
454
788
|
# @param msg_id [String]
|
455
789
|
# @param app_id [String]
|
456
790
|
# @param endpoint_id [String]
|
@@ -458,8 +792,10 @@ module Svix
|
|
458
792
|
# @option opts [String] :iterator
|
459
793
|
# @option opts [Integer] :limit
|
460
794
|
# @option opts [Array<String>] :event_types
|
795
|
+
# @option opts [String] :channel
|
461
796
|
# @option opts [MessageStatus] :status
|
462
797
|
# @option opts [Time] :before
|
798
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
463
799
|
# @return [Array<(ListResponseMessageAttemptEndpointOut, Integer, Hash)>] ListResponseMessageAttemptEndpointOut data, response status code and response headers
|
464
800
|
def list_attempts_for_endpoint_api_v1_app_app_id_msg_msg_id_endpoint_endpoint_id_attempt_get_with_http_info(msg_id, app_id, endpoint_id, opts = {})
|
465
801
|
if @api_client.config.debugging
|
@@ -516,6 +852,19 @@ module Svix
|
|
516
852
|
fail ArgumentError, "invalid value for 'endpoint_id' when calling MessageAttemptApi.list_attempts_for_endpoint_api_v1_app_app_id_msg_msg_id_endpoint_endpoint_id_attempt_get, must conform to the pattern #{pattern}."
|
517
853
|
end
|
518
854
|
|
855
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
|
856
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageAttemptApi.list_attempts_for_endpoint_api_v1_app_app_id_msg_msg_id_endpoint_endpoint_id_attempt_get, must be smaller than or equal to 250.'
|
857
|
+
end
|
858
|
+
|
859
|
+
if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
|
860
|
+
fail ArgumentError, 'invalid value for "opts[:"channel"]" when calling MessageAttemptApi.list_attempts_for_endpoint_api_v1_app_app_id_msg_msg_id_endpoint_endpoint_id_attempt_get, the character length must be smaller than or equal to 128.'
|
861
|
+
end
|
862
|
+
|
863
|
+
pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
864
|
+
if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'] !~ pattern
|
865
|
+
fail ArgumentError, "invalid value for 'opts[:\"channel\"]' when calling MessageAttemptApi.list_attempts_for_endpoint_api_v1_app_app_id_msg_msg_id_endpoint_endpoint_id_attempt_get, must conform to the pattern #{pattern}."
|
866
|
+
end
|
867
|
+
|
519
868
|
# resource path
|
520
869
|
local_var_path = '/api/v1/app/{app_id}/msg/{msg_id}/endpoint/{endpoint_id}/attempt/'.sub('{' + 'msg_id' + '}', CGI.escape(msg_id.to_s)).sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'endpoint_id' + '}', CGI.escape(endpoint_id.to_s))
|
521
870
|
|
@@ -524,6 +873,7 @@ module Svix
|
|
524
873
|
query_params[:'iterator'] = opts[:'iterator'] if !opts[:'iterator'].nil?
|
525
874
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
526
875
|
query_params[:'event_types'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
|
876
|
+
query_params[:'channel'] = opts[:'channel'] if !opts[:'channel'].nil?
|
527
877
|
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
528
878
|
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
529
879
|
|
@@ -531,6 +881,7 @@ module Svix
|
|
531
881
|
header_params = opts[:header_params] || {}
|
532
882
|
# HTTP header 'Accept' (if needed)
|
533
883
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
884
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
534
885
|
|
535
886
|
# form parameters
|
536
887
|
form_params = opts[:form_params] || {}
|
@@ -567,6 +918,7 @@ module Svix
|
|
567
918
|
# @param msg_id [String]
|
568
919
|
# @param app_id [String]
|
569
920
|
# @param [Hash] opts the optional parameters
|
921
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
570
922
|
# @return [nil]
|
571
923
|
def resend_webhook_api_v1_app_app_id_msg_msg_id_endpoint_endpoint_id_resend_post(endpoint_id, msg_id, app_id, opts = {})
|
572
924
|
resend_webhook_api_v1_app_app_id_msg_msg_id_endpoint_endpoint_id_resend_post_with_http_info(endpoint_id, msg_id, app_id, opts)
|
@@ -579,6 +931,7 @@ module Svix
|
|
579
931
|
# @param msg_id [String]
|
580
932
|
# @param app_id [String]
|
581
933
|
# @param [Hash] opts the optional parameters
|
934
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
582
935
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
583
936
|
def resend_webhook_api_v1_app_app_id_msg_msg_id_endpoint_endpoint_id_resend_post_with_http_info(endpoint_id, msg_id, app_id, opts = {})
|
584
937
|
if @api_client.config.debugging
|
@@ -645,6 +998,7 @@ module Svix
|
|
645
998
|
header_params = opts[:header_params] || {}
|
646
999
|
# HTTP header 'Accept' (if needed)
|
647
1000
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1001
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
648
1002
|
|
649
1003
|
# form parameters
|
650
1004
|
form_params = opts[:form_params] || {}
|