svix 0.84.0 → 0.84.1
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/lib/svix/api/application_api.rb +29 -25
- data/lib/svix/api/authentication_api.rb +13 -13
- data/lib/svix/api/background_tasks_api.rb +9 -5
- data/lib/svix/api/endpoint_api.rb +101 -97
- data/lib/svix/api/environment_api.rb +3 -3
- data/lib/svix/api/environment_settings_api.rb +2 -2
- data/lib/svix/api/event_type_api.rb +24 -20
- data/lib/svix/api/health_api.rb +1 -1
- data/lib/svix/api/integration_api.rb +40 -36
- data/lib/svix/api/message_api.rb +27 -23
- data/lib/svix/api/message_attempt_api.rb +117 -93
- data/lib/svix/api/statistics_api.rb +22 -22
- data/lib/svix/api_client.rb +2 -1
- data/lib/svix/api_error.rb +1 -1
- data/lib/svix/configuration.rb +9 -1
- data/lib/svix/models/app_portal_access_in.rb +1 -1
- data/lib/svix/models/app_portal_access_out.rb +1 -1
- data/lib/svix/models/{calculate_app_stats_in.rb → app_usage_stats_in.rb} +4 -4
- data/lib/svix/models/{background_task_out_common.rb → app_usage_stats_out.rb} +4 -4
- data/lib/svix/models/application_in.rb +1 -1
- data/lib/svix/models/application_out.rb +3 -1
- data/lib/svix/models/application_patch.rb +2 -1
- data/lib/svix/models/application_stats.rb +3 -1
- data/lib/svix/models/application_token_expire_in.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/background_task_out.rb +1 -1
- data/lib/svix/models/background_task_status.rb +1 -1
- data/lib/svix/models/background_task_type.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_color_palette.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 +5 -1
- data/lib/svix/models/endpoint_deleted_event.rb +1 -1
- data/lib/svix/models/endpoint_deleted_event_data.rb +5 -1
- data/lib/svix/models/endpoint_disabled_event.rb +1 -1
- data/lib/svix/models/endpoint_disabled_event_data.rb +5 -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_headers_patch_in.rb +1 -1
- data/lib/svix/models/endpoint_in.rb +1 -1
- data/lib/svix/models/endpoint_message_out.rb +3 -1
- data/lib/svix/models/endpoint_out.rb +2 -1
- data/lib/svix/models/endpoint_patch.rb +2 -1
- 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_transformation_in.rb +1 -1
- data/lib/svix/models/endpoint_transformation_out.rb +1 -1
- data/lib/svix/models/endpoint_transformation_simulate_in.rb +2 -1
- data/lib/svix/models/endpoint_transformation_simulate_out.rb +1 -1
- data/lib/svix/models/endpoint_update.rb +1 -1
- data/lib/svix/models/endpoint_updated_event.rb +1 -1
- data/lib/svix/models/endpoint_updated_event_data.rb +5 -1
- data/lib/svix/models/environment_in.rb +1 -1
- data/lib/svix/models/environment_out.rb +1 -1
- data/lib/svix/models/environment_settings_out.rb +1 -1
- data/lib/svix/models/event_example_in.rb +2 -1
- data/lib/svix/models/event_type_example_out.rb +1 -1
- data/lib/svix/models/event_type_in.rb +2 -1
- data/lib/svix/models/event_type_out.rb +2 -1
- data/lib/svix/models/event_type_patch.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/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/integration_in.rb +1 -1
- data/lib/svix/models/integration_key_out.rb +1 -1
- data/lib/svix/models/integration_out.rb +2 -1
- data/lib/svix/models/integration_update.rb +1 -1
- data/lib/svix/models/list_response_application_out.rb +1 -1
- data/lib/svix/models/list_response_application_stats.rb +1 -1
- data/lib/svix/models/list_response_background_task_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 +1 -1
- 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 +4 -1
- data/lib/svix/models/message_attempt_exhausted_event.rb +1 -1
- data/lib/svix/models/message_attempt_exhausted_event_data.rb +6 -1
- data/lib/svix/models/message_attempt_failed_data.rb +2 -1
- data/lib/svix/models/message_attempt_failing_event.rb +1 -1
- data/lib/svix/models/message_attempt_failing_event_data.rb +6 -1
- data/lib/svix/models/message_attempt_headers_out.rb +1 -1
- data/lib/svix/models/message_attempt_out.rb +4 -1
- data/lib/svix/models/message_attempt_trigger_type.rb +1 -1
- data/lib/svix/models/message_endpoint_out.rb +2 -1
- data/lib/svix/models/message_in.rb +2 -1
- data/lib/svix/models/message_out.rb +3 -1
- data/lib/svix/models/message_status.rb +1 -1
- data/lib/svix/models/ordering.rb +1 -1
- data/lib/svix/models/recover_in.rb +1 -1
- data/lib/svix/models/recover_out.rb +1 -1
- data/lib/svix/models/replay_in.rb +1 -1
- data/lib/svix/models/replay_out.rb +1 -1
- data/lib/svix/models/settings_in.rb +1 -1
- data/lib/svix/models/settings_out.rb +1 -1
- data/lib/svix/models/statistics_period.rb +1 -1
- data/lib/svix/models/status_code_class.rb +1 -1
- data/lib/svix/models/transformation_http_method.rb +1 -1
- data/lib/svix/models/validation_error.rb +1 -1
- data/lib/svix/version.rb +1 -1
- metadata +4 -4
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
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
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -21,8 +21,8 @@ module Svix
|
|
21
21
|
end
|
22
22
|
# Patch Endpoint
|
23
23
|
# Partially update an endpoint.
|
24
|
-
# @param app_id [String]
|
25
|
-
# @param endpoint_id [String]
|
24
|
+
# @param app_id [String] The app's ID or UID
|
25
|
+
# @param endpoint_id [String] The ep's ID or UID
|
26
26
|
# @param endpoint_patch [EndpointPatch]
|
27
27
|
# @param [Hash] opts the optional parameters
|
28
28
|
# @return [EndpointOut]
|
@@ -33,8 +33,8 @@ module Svix
|
|
33
33
|
|
34
34
|
# Patch Endpoint
|
35
35
|
# Partially update an endpoint.
|
36
|
-
# @param app_id [String]
|
37
|
-
# @param endpoint_id [String]
|
36
|
+
# @param app_id [String] The app's ID or UID
|
37
|
+
# @param endpoint_id [String] The ep's ID or UID
|
38
38
|
# @param endpoint_patch [EndpointPatch]
|
39
39
|
# @param [Hash] opts the optional parameters
|
40
40
|
# @return [Array<(EndpointOut, Integer, Hash)>] EndpointOut data, response status code and response headers
|
@@ -103,7 +103,7 @@ module Svix
|
|
103
103
|
return_type = opts[:debug_return_type] || 'EndpointOut'
|
104
104
|
|
105
105
|
# auth_names
|
106
|
-
auth_names = opts[:debug_auth_names] || []
|
106
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
107
107
|
|
108
108
|
new_options = opts.merge(
|
109
109
|
:operation => :"EndpointApi.patch_endpoint",
|
@@ -124,7 +124,7 @@ module Svix
|
|
124
124
|
|
125
125
|
# Create Endpoint
|
126
126
|
# Create a new endpoint for the application. When `secret` is `null` the secret is automatically generated (recommended)
|
127
|
-
# @param app_id [String]
|
127
|
+
# @param app_id [String] The app's ID or UID
|
128
128
|
# @param endpoint_in [EndpointIn]
|
129
129
|
# @param [Hash] opts the optional parameters
|
130
130
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -136,7 +136,7 @@ module Svix
|
|
136
136
|
|
137
137
|
# Create Endpoint
|
138
138
|
# Create a new endpoint for the application. When `secret` is `null` the secret is automatically generated (recommended)
|
139
|
-
# @param app_id [String]
|
139
|
+
# @param app_id [String] The app's ID or UID
|
140
140
|
# @param endpoint_in [EndpointIn]
|
141
141
|
# @param [Hash] opts the optional parameters
|
142
142
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -190,7 +190,7 @@ module Svix
|
|
190
190
|
return_type = opts[:debug_return_type] || 'EndpointOut'
|
191
191
|
|
192
192
|
# auth_names
|
193
|
-
auth_names = opts[:debug_auth_names] || []
|
193
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
194
194
|
|
195
195
|
new_options = opts.merge(
|
196
196
|
:operation => :"EndpointApi.v1_endpoint_create",
|
@@ -211,8 +211,8 @@ module Svix
|
|
211
211
|
|
212
212
|
# Delete Endpoint
|
213
213
|
# Delete an endpoint.
|
214
|
-
# @param app_id [String]
|
215
|
-
# @param endpoint_id [String]
|
214
|
+
# @param app_id [String] The app's ID or UID
|
215
|
+
# @param endpoint_id [String] The ep's ID or UID
|
216
216
|
# @param [Hash] opts the optional parameters
|
217
217
|
# @return [nil]
|
218
218
|
def v1_endpoint_delete(app_id, endpoint_id, opts = {})
|
@@ -222,8 +222,8 @@ module Svix
|
|
222
222
|
|
223
223
|
# Delete Endpoint
|
224
224
|
# Delete an endpoint.
|
225
|
-
# @param app_id [String]
|
226
|
-
# @param endpoint_id [String]
|
225
|
+
# @param app_id [String] The app's ID or UID
|
226
|
+
# @param endpoint_id [String] The ep's ID or UID
|
227
227
|
# @param [Hash] opts the optional parameters
|
228
228
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
229
229
|
def v1_endpoint_delete_with_http_info(app_id, endpoint_id, opts = {})
|
@@ -285,7 +285,7 @@ module Svix
|
|
285
285
|
return_type = opts[:debug_return_type]
|
286
286
|
|
287
287
|
# auth_names
|
288
|
-
auth_names = opts[:debug_auth_names] || []
|
288
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
289
289
|
|
290
290
|
new_options = opts.merge(
|
291
291
|
:operation => :"EndpointApi.v1_endpoint_delete",
|
@@ -306,8 +306,8 @@ module Svix
|
|
306
306
|
|
307
307
|
# Get Endpoint
|
308
308
|
# Get an endpoint.
|
309
|
-
# @param app_id [String]
|
310
|
-
# @param endpoint_id [String]
|
309
|
+
# @param app_id [String] The app's ID or UID
|
310
|
+
# @param endpoint_id [String] The ep's ID or UID
|
311
311
|
# @param [Hash] opts the optional parameters
|
312
312
|
# @return [EndpointOut]
|
313
313
|
def v1_endpoint_get(app_id, endpoint_id, opts = {})
|
@@ -317,8 +317,8 @@ module Svix
|
|
317
317
|
|
318
318
|
# Get Endpoint
|
319
319
|
# Get an endpoint.
|
320
|
-
# @param app_id [String]
|
321
|
-
# @param endpoint_id [String]
|
320
|
+
# @param app_id [String] The app's ID or UID
|
321
|
+
# @param endpoint_id [String] The ep's ID or UID
|
322
322
|
# @param [Hash] opts the optional parameters
|
323
323
|
# @return [Array<(EndpointOut, Integer, Hash)>] EndpointOut data, response status code and response headers
|
324
324
|
def v1_endpoint_get_with_http_info(app_id, endpoint_id, opts = {})
|
@@ -380,7 +380,7 @@ module Svix
|
|
380
380
|
return_type = opts[:debug_return_type] || 'EndpointOut'
|
381
381
|
|
382
382
|
# auth_names
|
383
|
-
auth_names = opts[:debug_auth_names] || []
|
383
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
384
384
|
|
385
385
|
new_options = opts.merge(
|
386
386
|
:operation => :"EndpointApi.v1_endpoint_get",
|
@@ -401,8 +401,8 @@ module Svix
|
|
401
401
|
|
402
402
|
# Get Endpoint Headers
|
403
403
|
# Get the additional headers to be sent with the webhook
|
404
|
-
# @param app_id [String]
|
405
|
-
# @param endpoint_id [String]
|
404
|
+
# @param app_id [String] The app's ID or UID
|
405
|
+
# @param endpoint_id [String] The ep's ID or UID
|
406
406
|
# @param [Hash] opts the optional parameters
|
407
407
|
# @return [EndpointHeadersOut]
|
408
408
|
def v1_endpoint_get_headers(app_id, endpoint_id, opts = {})
|
@@ -412,8 +412,8 @@ module Svix
|
|
412
412
|
|
413
413
|
# Get Endpoint Headers
|
414
414
|
# Get the additional headers to be sent with the webhook
|
415
|
-
# @param app_id [String]
|
416
|
-
# @param endpoint_id [String]
|
415
|
+
# @param app_id [String] The app's ID or UID
|
416
|
+
# @param endpoint_id [String] The ep's ID or UID
|
417
417
|
# @param [Hash] opts the optional parameters
|
418
418
|
# @return [Array<(EndpointHeadersOut, Integer, Hash)>] EndpointHeadersOut data, response status code and response headers
|
419
419
|
def v1_endpoint_get_headers_with_http_info(app_id, endpoint_id, opts = {})
|
@@ -475,7 +475,7 @@ module Svix
|
|
475
475
|
return_type = opts[:debug_return_type] || 'EndpointHeadersOut'
|
476
476
|
|
477
477
|
# auth_names
|
478
|
-
auth_names = opts[:debug_auth_names] || []
|
478
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
479
479
|
|
480
480
|
new_options = opts.merge(
|
481
481
|
:operation => :"EndpointApi.v1_endpoint_get_headers",
|
@@ -496,8 +496,8 @@ module Svix
|
|
496
496
|
|
497
497
|
# Get Endpoint Secret
|
498
498
|
# Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).
|
499
|
-
# @param app_id [String]
|
500
|
-
# @param endpoint_id [String]
|
499
|
+
# @param app_id [String] The app's ID or UID
|
500
|
+
# @param endpoint_id [String] The ep's ID or UID
|
501
501
|
# @param [Hash] opts the optional parameters
|
502
502
|
# @return [EndpointSecretOut]
|
503
503
|
def v1_endpoint_get_secret(app_id, endpoint_id, opts = {})
|
@@ -507,8 +507,8 @@ module Svix
|
|
507
507
|
|
508
508
|
# Get Endpoint Secret
|
509
509
|
# Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to [the consuming webhooks docs](https://docs.svix.com/consuming-webhooks/).
|
510
|
-
# @param app_id [String]
|
511
|
-
# @param endpoint_id [String]
|
510
|
+
# @param app_id [String] The app's ID or UID
|
511
|
+
# @param endpoint_id [String] The ep's ID or UID
|
512
512
|
# @param [Hash] opts the optional parameters
|
513
513
|
# @return [Array<(EndpointSecretOut, Integer, Hash)>] EndpointSecretOut data, response status code and response headers
|
514
514
|
def v1_endpoint_get_secret_with_http_info(app_id, endpoint_id, opts = {})
|
@@ -570,7 +570,7 @@ module Svix
|
|
570
570
|
return_type = opts[:debug_return_type] || 'EndpointSecretOut'
|
571
571
|
|
572
572
|
# auth_names
|
573
|
-
auth_names = opts[:debug_auth_names] || []
|
573
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
574
574
|
|
575
575
|
new_options = opts.merge(
|
576
576
|
:operation => :"EndpointApi.v1_endpoint_get_secret",
|
@@ -591,8 +591,8 @@ module Svix
|
|
591
591
|
|
592
592
|
# Endpoint Stats
|
593
593
|
# Get basic statistics for the endpoint.
|
594
|
-
# @param app_id [String]
|
595
|
-
# @param endpoint_id [String]
|
594
|
+
# @param app_id [String] The app's ID or UID
|
595
|
+
# @param endpoint_id [String] The ep's ID or UID
|
596
596
|
# @param [Hash] opts the optional parameters
|
597
597
|
# @option opts [Time] :since
|
598
598
|
# @option opts [Time] :_until
|
@@ -604,8 +604,8 @@ module Svix
|
|
604
604
|
|
605
605
|
# Endpoint Stats
|
606
606
|
# Get basic statistics for the endpoint.
|
607
|
-
# @param app_id [String]
|
608
|
-
# @param endpoint_id [String]
|
607
|
+
# @param app_id [String] The app's ID or UID
|
608
|
+
# @param endpoint_id [String] The ep's ID or UID
|
609
609
|
# @param [Hash] opts the optional parameters
|
610
610
|
# @option opts [Time] :since
|
611
611
|
# @option opts [Time] :_until
|
@@ -671,7 +671,7 @@ module Svix
|
|
671
671
|
return_type = opts[:debug_return_type] || 'EndpointStats'
|
672
672
|
|
673
673
|
# auth_names
|
674
|
-
auth_names = opts[:debug_auth_names] || []
|
674
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
675
675
|
|
676
676
|
new_options = opts.merge(
|
677
677
|
:operation => :"EndpointApi.v1_endpoint_get_stats",
|
@@ -692,10 +692,10 @@ module Svix
|
|
692
692
|
|
693
693
|
# List Endpoints
|
694
694
|
# List the application's endpoints.
|
695
|
-
# @param app_id [String]
|
695
|
+
# @param app_id [String] The app's ID or UID
|
696
696
|
# @param [Hash] opts the optional parameters
|
697
697
|
# @option opts [Integer] :limit
|
698
|
-
# @option opts [String] :iterator
|
698
|
+
# @option opts [String] :iterator The ep's ID
|
699
699
|
# @option opts [Ordering] :order
|
700
700
|
# @return [ListResponseEndpointOut]
|
701
701
|
def v1_endpoint_list(app_id, opts = {})
|
@@ -705,10 +705,10 @@ module Svix
|
|
705
705
|
|
706
706
|
# List Endpoints
|
707
707
|
# List the application's endpoints.
|
708
|
-
# @param app_id [String]
|
708
|
+
# @param app_id [String] The app's ID or UID
|
709
709
|
# @param [Hash] opts the optional parameters
|
710
710
|
# @option opts [Integer] :limit
|
711
|
-
# @option opts [String] :iterator
|
711
|
+
# @option opts [String] :iterator The ep's ID
|
712
712
|
# @option opts [Ordering] :order
|
713
713
|
# @return [Array<(ListResponseEndpointOut, Integer, Hash)>] ListResponseEndpointOut data, response status code and response headers
|
714
714
|
def v1_endpoint_list_with_http_info(app_id, opts = {})
|
@@ -732,8 +732,12 @@ module Svix
|
|
732
732
|
fail ArgumentError, "invalid value for 'app_id' when calling EndpointApi.v1_endpoint_list, must conform to the pattern #{pattern}."
|
733
733
|
end
|
734
734
|
|
735
|
-
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit']
|
736
|
-
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EndpointApi.v1_endpoint_list, must be
|
735
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
|
736
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EndpointApi.v1_endpoint_list, must be smaller than or equal to 250.'
|
737
|
+
end
|
738
|
+
|
739
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
740
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EndpointApi.v1_endpoint_list, must be greater than or equal to 1.'
|
737
741
|
end
|
738
742
|
|
739
743
|
# resource path
|
@@ -760,7 +764,7 @@ module Svix
|
|
760
764
|
return_type = opts[:debug_return_type] || 'ListResponseEndpointOut'
|
761
765
|
|
762
766
|
# auth_names
|
763
|
-
auth_names = opts[:debug_auth_names] || []
|
767
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
764
768
|
|
765
769
|
new_options = opts.merge(
|
766
770
|
:operation => :"EndpointApi.v1_endpoint_list",
|
@@ -781,8 +785,8 @@ module Svix
|
|
781
785
|
|
782
786
|
# Patch Endpoint Headers
|
783
787
|
# Partially set the additional headers to be sent with the webhook
|
784
|
-
# @param app_id [String]
|
785
|
-
# @param endpoint_id [String]
|
788
|
+
# @param app_id [String] The app's ID or UID
|
789
|
+
# @param endpoint_id [String] The ep's ID or UID
|
786
790
|
# @param endpoint_headers_patch_in [EndpointHeadersPatchIn]
|
787
791
|
# @param [Hash] opts the optional parameters
|
788
792
|
# @return [nil]
|
@@ -793,8 +797,8 @@ module Svix
|
|
793
797
|
|
794
798
|
# Patch Endpoint Headers
|
795
799
|
# Partially set the additional headers to be sent with the webhook
|
796
|
-
# @param app_id [String]
|
797
|
-
# @param endpoint_id [String]
|
800
|
+
# @param app_id [String] The app's ID or UID
|
801
|
+
# @param endpoint_id [String] The ep's ID or UID
|
798
802
|
# @param endpoint_headers_patch_in [EndpointHeadersPatchIn]
|
799
803
|
# @param [Hash] opts the optional parameters
|
800
804
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -863,7 +867,7 @@ module Svix
|
|
863
867
|
return_type = opts[:debug_return_type]
|
864
868
|
|
865
869
|
# auth_names
|
866
|
-
auth_names = opts[:debug_auth_names] || []
|
870
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
867
871
|
|
868
872
|
new_options = opts.merge(
|
869
873
|
:operation => :"EndpointApi.v1_endpoint_patch_headers",
|
@@ -884,8 +888,8 @@ module Svix
|
|
884
888
|
|
885
889
|
# Recover Failed Webhooks
|
886
890
|
# Resend all failed messages since a given time.
|
887
|
-
# @param app_id [String]
|
888
|
-
# @param endpoint_id [String]
|
891
|
+
# @param app_id [String] The app's ID or UID
|
892
|
+
# @param endpoint_id [String] The ep's ID or UID
|
889
893
|
# @param recover_in [RecoverIn]
|
890
894
|
# @param [Hash] opts the optional parameters
|
891
895
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -897,8 +901,8 @@ module Svix
|
|
897
901
|
|
898
902
|
# Recover Failed Webhooks
|
899
903
|
# Resend all failed messages since a given time.
|
900
|
-
# @param app_id [String]
|
901
|
-
# @param endpoint_id [String]
|
904
|
+
# @param app_id [String] The app's ID or UID
|
905
|
+
# @param endpoint_id [String] The ep's ID or UID
|
902
906
|
# @param recover_in [RecoverIn]
|
903
907
|
# @param [Hash] opts the optional parameters
|
904
908
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -969,7 +973,7 @@ module Svix
|
|
969
973
|
return_type = opts[:debug_return_type] || 'RecoverOut'
|
970
974
|
|
971
975
|
# auth_names
|
972
|
-
auth_names = opts[:debug_auth_names] || []
|
976
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
973
977
|
|
974
978
|
new_options = opts.merge(
|
975
979
|
:operation => :"EndpointApi.v1_endpoint_recover",
|
@@ -990,8 +994,8 @@ module Svix
|
|
990
994
|
|
991
995
|
# Replay Missing Webhooks
|
992
996
|
# Replays messages to the endpoint. Only messages that were created after `since` will be sent. Messages that were previously sent to the endpoint are not resent.
|
993
|
-
# @param app_id [String]
|
994
|
-
# @param endpoint_id [String]
|
997
|
+
# @param app_id [String] The app's ID or UID
|
998
|
+
# @param endpoint_id [String] The ep's ID or UID
|
995
999
|
# @param replay_in [ReplayIn]
|
996
1000
|
# @param [Hash] opts the optional parameters
|
997
1001
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -1003,8 +1007,8 @@ module Svix
|
|
1003
1007
|
|
1004
1008
|
# Replay Missing Webhooks
|
1005
1009
|
# Replays messages to the endpoint. Only messages that were created after `since` will be sent. Messages that were previously sent to the endpoint are not resent.
|
1006
|
-
# @param app_id [String]
|
1007
|
-
# @param endpoint_id [String]
|
1010
|
+
# @param app_id [String] The app's ID or UID
|
1011
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1008
1012
|
# @param replay_in [ReplayIn]
|
1009
1013
|
# @param [Hash] opts the optional parameters
|
1010
1014
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -1075,7 +1079,7 @@ module Svix
|
|
1075
1079
|
return_type = opts[:debug_return_type] || 'ReplayOut'
|
1076
1080
|
|
1077
1081
|
# auth_names
|
1078
|
-
auth_names = opts[:debug_auth_names] || []
|
1082
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
1079
1083
|
|
1080
1084
|
new_options = opts.merge(
|
1081
1085
|
:operation => :"EndpointApi.v1_endpoint_replay",
|
@@ -1096,8 +1100,8 @@ module Svix
|
|
1096
1100
|
|
1097
1101
|
# Rotate Endpoint Secret
|
1098
1102
|
# Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.
|
1099
|
-
# @param app_id [String]
|
1100
|
-
# @param endpoint_id [String]
|
1103
|
+
# @param app_id [String] The app's ID or UID
|
1104
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1101
1105
|
# @param endpoint_secret_rotate_in [EndpointSecretRotateIn]
|
1102
1106
|
# @param [Hash] opts the optional parameters
|
1103
1107
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -1109,8 +1113,8 @@ module Svix
|
|
1109
1113
|
|
1110
1114
|
# Rotate Endpoint Secret
|
1111
1115
|
# Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours.
|
1112
|
-
# @param app_id [String]
|
1113
|
-
# @param endpoint_id [String]
|
1116
|
+
# @param app_id [String] The app's ID or UID
|
1117
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1114
1118
|
# @param endpoint_secret_rotate_in [EndpointSecretRotateIn]
|
1115
1119
|
# @param [Hash] opts the optional parameters
|
1116
1120
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -1181,7 +1185,7 @@ module Svix
|
|
1181
1185
|
return_type = opts[:debug_return_type]
|
1182
1186
|
|
1183
1187
|
# auth_names
|
1184
|
-
auth_names = opts[:debug_auth_names] || []
|
1188
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
1185
1189
|
|
1186
1190
|
new_options = opts.merge(
|
1187
1191
|
:operation => :"EndpointApi.v1_endpoint_rotate_secret",
|
@@ -1200,10 +1204,10 @@ module Svix
|
|
1200
1204
|
return data, status_code, headers
|
1201
1205
|
end
|
1202
1206
|
|
1203
|
-
# Send Example
|
1207
|
+
# Send Event Type Example Message
|
1204
1208
|
# Send an example message for event
|
1205
|
-
# @param app_id [String]
|
1206
|
-
# @param endpoint_id [String]
|
1209
|
+
# @param app_id [String] The app's ID or UID
|
1210
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1207
1211
|
# @param event_example_in [EventExampleIn]
|
1208
1212
|
# @param [Hash] opts the optional parameters
|
1209
1213
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -1213,10 +1217,10 @@ module Svix
|
|
1213
1217
|
data
|
1214
1218
|
end
|
1215
1219
|
|
1216
|
-
# Send Example
|
1220
|
+
# Send Event Type Example Message
|
1217
1221
|
# Send an example message for event
|
1218
|
-
# @param app_id [String]
|
1219
|
-
# @param endpoint_id [String]
|
1222
|
+
# @param app_id [String] The app's ID or UID
|
1223
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1220
1224
|
# @param event_example_in [EventExampleIn]
|
1221
1225
|
# @param [Hash] opts the optional parameters
|
1222
1226
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -1287,7 +1291,7 @@ module Svix
|
|
1287
1291
|
return_type = opts[:debug_return_type] || 'MessageOut'
|
1288
1292
|
|
1289
1293
|
# auth_names
|
1290
|
-
auth_names = opts[:debug_auth_names] || []
|
1294
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
1291
1295
|
|
1292
1296
|
new_options = opts.merge(
|
1293
1297
|
:operation => :"EndpointApi.v1_endpoint_send_example",
|
@@ -1306,10 +1310,10 @@ module Svix
|
|
1306
1310
|
return data, status_code, headers
|
1307
1311
|
end
|
1308
1312
|
|
1309
|
-
# Get Endpoint
|
1313
|
+
# Get Endpoint Transformation
|
1310
1314
|
# Get the transformation code associated with this endpoint
|
1311
|
-
# @param app_id [String]
|
1312
|
-
# @param endpoint_id [String]
|
1315
|
+
# @param app_id [String] The app's ID or UID
|
1316
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1313
1317
|
# @param [Hash] opts the optional parameters
|
1314
1318
|
# @return [EndpointTransformationOut]
|
1315
1319
|
def v1_endpoint_transformation_get(app_id, endpoint_id, opts = {})
|
@@ -1317,10 +1321,10 @@ module Svix
|
|
1317
1321
|
data
|
1318
1322
|
end
|
1319
1323
|
|
1320
|
-
# Get Endpoint
|
1324
|
+
# Get Endpoint Transformation
|
1321
1325
|
# Get the transformation code associated with this endpoint
|
1322
|
-
# @param app_id [String]
|
1323
|
-
# @param endpoint_id [String]
|
1326
|
+
# @param app_id [String] The app's ID or UID
|
1327
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1324
1328
|
# @param [Hash] opts the optional parameters
|
1325
1329
|
# @return [Array<(EndpointTransformationOut, Integer, Hash)>] EndpointTransformationOut data, response status code and response headers
|
1326
1330
|
def v1_endpoint_transformation_get_with_http_info(app_id, endpoint_id, opts = {})
|
@@ -1382,7 +1386,7 @@ module Svix
|
|
1382
1386
|
return_type = opts[:debug_return_type] || 'EndpointTransformationOut'
|
1383
1387
|
|
1384
1388
|
# auth_names
|
1385
|
-
auth_names = opts[:debug_auth_names] || []
|
1389
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
1386
1390
|
|
1387
1391
|
new_options = opts.merge(
|
1388
1392
|
:operation => :"EndpointApi.v1_endpoint_transformation_get",
|
@@ -1401,10 +1405,10 @@ module Svix
|
|
1401
1405
|
return data, status_code, headers
|
1402
1406
|
end
|
1403
1407
|
|
1404
|
-
# Set Endpoint
|
1408
|
+
# Set Endpoint Transformation
|
1405
1409
|
# Set or unset the transformation code associated with this endpoint
|
1406
|
-
# @param app_id [String]
|
1407
|
-
# @param endpoint_id [String]
|
1410
|
+
# @param app_id [String] The app's ID or UID
|
1411
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1408
1412
|
# @param endpoint_transformation_in [EndpointTransformationIn]
|
1409
1413
|
# @param [Hash] opts the optional parameters
|
1410
1414
|
# @return [nil]
|
@@ -1413,10 +1417,10 @@ module Svix
|
|
1413
1417
|
nil
|
1414
1418
|
end
|
1415
1419
|
|
1416
|
-
# Set Endpoint
|
1420
|
+
# Set Endpoint Transformation
|
1417
1421
|
# Set or unset the transformation code associated with this endpoint
|
1418
|
-
# @param app_id [String]
|
1419
|
-
# @param endpoint_id [String]
|
1422
|
+
# @param app_id [String] The app's ID or UID
|
1423
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1420
1424
|
# @param endpoint_transformation_in [EndpointTransformationIn]
|
1421
1425
|
# @param [Hash] opts the optional parameters
|
1422
1426
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -1485,7 +1489,7 @@ module Svix
|
|
1485
1489
|
return_type = opts[:debug_return_type]
|
1486
1490
|
|
1487
1491
|
# auth_names
|
1488
|
-
auth_names = opts[:debug_auth_names] || []
|
1492
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
1489
1493
|
|
1490
1494
|
new_options = opts.merge(
|
1491
1495
|
:operation => :"EndpointApi.v1_endpoint_transformation_partial_update",
|
@@ -1506,8 +1510,8 @@ module Svix
|
|
1506
1510
|
|
1507
1511
|
# Simulate
|
1508
1512
|
# Simulate running the transformation on the payload and code
|
1509
|
-
# @param app_id [String]
|
1510
|
-
# @param endpoint_id [String]
|
1513
|
+
# @param app_id [String] The app's ID or UID
|
1514
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1511
1515
|
# @param endpoint_transformation_simulate_in [EndpointTransformationSimulateIn]
|
1512
1516
|
# @param [Hash] opts the optional parameters
|
1513
1517
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -1519,8 +1523,8 @@ module Svix
|
|
1519
1523
|
|
1520
1524
|
# Simulate
|
1521
1525
|
# Simulate running the transformation on the payload and code
|
1522
|
-
# @param app_id [String]
|
1523
|
-
# @param endpoint_id [String]
|
1526
|
+
# @param app_id [String] The app's ID or UID
|
1527
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1524
1528
|
# @param endpoint_transformation_simulate_in [EndpointTransformationSimulateIn]
|
1525
1529
|
# @param [Hash] opts the optional parameters
|
1526
1530
|
# @option opts [String] :idempotency_key The request's idempotency key
|
@@ -1591,7 +1595,7 @@ module Svix
|
|
1591
1595
|
return_type = opts[:debug_return_type] || 'EndpointTransformationSimulateOut'
|
1592
1596
|
|
1593
1597
|
# auth_names
|
1594
|
-
auth_names = opts[:debug_auth_names] || []
|
1598
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
1595
1599
|
|
1596
1600
|
new_options = opts.merge(
|
1597
1601
|
:operation => :"EndpointApi.v1_endpoint_transformation_simulate",
|
@@ -1612,8 +1616,8 @@ module Svix
|
|
1612
1616
|
|
1613
1617
|
# Update Endpoint
|
1614
1618
|
# Update an endpoint.
|
1615
|
-
# @param app_id [String]
|
1616
|
-
# @param endpoint_id [String]
|
1619
|
+
# @param app_id [String] The app's ID or UID
|
1620
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1617
1621
|
# @param endpoint_update [EndpointUpdate]
|
1618
1622
|
# @param [Hash] opts the optional parameters
|
1619
1623
|
# @return [EndpointOut]
|
@@ -1624,8 +1628,8 @@ module Svix
|
|
1624
1628
|
|
1625
1629
|
# Update Endpoint
|
1626
1630
|
# Update an endpoint.
|
1627
|
-
# @param app_id [String]
|
1628
|
-
# @param endpoint_id [String]
|
1631
|
+
# @param app_id [String] The app's ID or UID
|
1632
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1629
1633
|
# @param endpoint_update [EndpointUpdate]
|
1630
1634
|
# @param [Hash] opts the optional parameters
|
1631
1635
|
# @return [Array<(EndpointOut, Integer, Hash)>] EndpointOut data, response status code and response headers
|
@@ -1694,7 +1698,7 @@ module Svix
|
|
1694
1698
|
return_type = opts[:debug_return_type] || 'EndpointOut'
|
1695
1699
|
|
1696
1700
|
# auth_names
|
1697
|
-
auth_names = opts[:debug_auth_names] || []
|
1701
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
1698
1702
|
|
1699
1703
|
new_options = opts.merge(
|
1700
1704
|
:operation => :"EndpointApi.v1_endpoint_update",
|
@@ -1715,8 +1719,8 @@ module Svix
|
|
1715
1719
|
|
1716
1720
|
# Update Endpoint Headers
|
1717
1721
|
# Set the additional headers to be sent with the webhook
|
1718
|
-
# @param app_id [String]
|
1719
|
-
# @param endpoint_id [String]
|
1722
|
+
# @param app_id [String] The app's ID or UID
|
1723
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1720
1724
|
# @param endpoint_headers_in [EndpointHeadersIn]
|
1721
1725
|
# @param [Hash] opts the optional parameters
|
1722
1726
|
# @return [nil]
|
@@ -1727,8 +1731,8 @@ module Svix
|
|
1727
1731
|
|
1728
1732
|
# Update Endpoint Headers
|
1729
1733
|
# Set the additional headers to be sent with the webhook
|
1730
|
-
# @param app_id [String]
|
1731
|
-
# @param endpoint_id [String]
|
1734
|
+
# @param app_id [String] The app's ID or UID
|
1735
|
+
# @param endpoint_id [String] The ep's ID or UID
|
1732
1736
|
# @param endpoint_headers_in [EndpointHeadersIn]
|
1733
1737
|
# @param [Hash] opts the optional parameters
|
1734
1738
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -1797,7 +1801,7 @@ module Svix
|
|
1797
1801
|
return_type = opts[:debug_return_type]
|
1798
1802
|
|
1799
1803
|
# auth_names
|
1800
|
-
auth_names = opts[:debug_auth_names] || []
|
1804
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
1801
1805
|
|
1802
1806
|
new_options = opts.merge(
|
1803
1807
|
:operation => :"EndpointApi.v1_endpoint_update_headers",
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
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
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -68,7 +68,7 @@ module Svix
|
|
68
68
|
return_type = opts[:debug_return_type] || 'EnvironmentOut'
|
69
69
|
|
70
70
|
# auth_names
|
71
|
-
auth_names = opts[:debug_auth_names] || []
|
71
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
72
72
|
|
73
73
|
new_options = opts.merge(
|
74
74
|
:operation => :"EnvironmentApi.v1_environment_export",
|
@@ -136,7 +136,7 @@ module Svix
|
|
136
136
|
return_type = opts[:debug_return_type]
|
137
137
|
|
138
138
|
# auth_names
|
139
|
-
auth_names = opts[:debug_auth_names] || []
|
139
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
140
140
|
|
141
141
|
new_options = opts.merge(
|
142
142
|
:operation => :"EnvironmentApi.v1_environment_import",
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
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
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -57,7 +57,7 @@ module Svix
|
|
57
57
|
return_type = opts[:debug_return_type] || 'EnvironmentSettingsOut'
|
58
58
|
|
59
59
|
# auth_names
|
60
|
-
auth_names = opts[:debug_auth_names] || []
|
60
|
+
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
61
61
|
|
62
62
|
new_options = opts.merge(
|
63
63
|
:operation => :"EnvironmentSettingsApi.v1_environment_get_settings",
|