svix 0.84.0 → 0.84.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (113) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/lib/svix/api/application_api.rb +29 -25
  4. data/lib/svix/api/authentication_api.rb +13 -13
  5. data/lib/svix/api/background_tasks_api.rb +9 -5
  6. data/lib/svix/api/endpoint_api.rb +101 -97
  7. data/lib/svix/api/environment_api.rb +3 -3
  8. data/lib/svix/api/environment_settings_api.rb +2 -2
  9. data/lib/svix/api/event_type_api.rb +24 -20
  10. data/lib/svix/api/health_api.rb +1 -1
  11. data/lib/svix/api/integration_api.rb +40 -36
  12. data/lib/svix/api/message_api.rb +27 -23
  13. data/lib/svix/api/message_attempt_api.rb +117 -93
  14. data/lib/svix/api/statistics_api.rb +22 -22
  15. data/lib/svix/api_client.rb +2 -1
  16. data/lib/svix/api_error.rb +1 -1
  17. data/lib/svix/configuration.rb +9 -1
  18. data/lib/svix/models/app_portal_access_in.rb +1 -1
  19. data/lib/svix/models/app_portal_access_out.rb +1 -1
  20. data/lib/svix/models/{calculate_app_stats_in.rb → app_usage_stats_in.rb} +4 -4
  21. data/lib/svix/models/{background_task_out_common.rb → app_usage_stats_out.rb} +4 -4
  22. data/lib/svix/models/application_in.rb +1 -1
  23. data/lib/svix/models/application_out.rb +3 -1
  24. data/lib/svix/models/application_patch.rb +2 -1
  25. data/lib/svix/models/application_stats.rb +3 -1
  26. data/lib/svix/models/application_token_expire_in.rb +1 -1
  27. data/lib/svix/models/attempt_statistics_data.rb +1 -1
  28. data/lib/svix/models/attempt_statistics_response.rb +1 -1
  29. data/lib/svix/models/background_task_out.rb +1 -1
  30. data/lib/svix/models/background_task_status.rb +1 -1
  31. data/lib/svix/models/background_task_type.rb +1 -1
  32. data/lib/svix/models/border_radius_config.rb +1 -1
  33. data/lib/svix/models/border_radius_enum.rb +1 -1
  34. data/lib/svix/models/custom_color_palette.rb +1 -1
  35. data/lib/svix/models/custom_theme_override.rb +1 -1
  36. data/lib/svix/models/dashboard_access_out.rb +1 -1
  37. data/lib/svix/models/endpoint_created_event.rb +1 -1
  38. data/lib/svix/models/endpoint_created_event_data.rb +5 -1
  39. data/lib/svix/models/endpoint_deleted_event.rb +1 -1
  40. data/lib/svix/models/endpoint_deleted_event_data.rb +5 -1
  41. data/lib/svix/models/endpoint_disabled_event.rb +1 -1
  42. data/lib/svix/models/endpoint_disabled_event_data.rb +5 -1
  43. data/lib/svix/models/endpoint_headers_in.rb +1 -1
  44. data/lib/svix/models/endpoint_headers_out.rb +1 -1
  45. data/lib/svix/models/endpoint_headers_patch_in.rb +1 -1
  46. data/lib/svix/models/endpoint_in.rb +1 -1
  47. data/lib/svix/models/endpoint_message_out.rb +3 -1
  48. data/lib/svix/models/endpoint_out.rb +2 -1
  49. data/lib/svix/models/endpoint_patch.rb +2 -1
  50. data/lib/svix/models/endpoint_secret_out.rb +1 -1
  51. data/lib/svix/models/endpoint_secret_rotate_in.rb +1 -1
  52. data/lib/svix/models/endpoint_stats.rb +1 -1
  53. data/lib/svix/models/endpoint_transformation_in.rb +1 -1
  54. data/lib/svix/models/endpoint_transformation_out.rb +1 -1
  55. data/lib/svix/models/endpoint_transformation_simulate_in.rb +2 -1
  56. data/lib/svix/models/endpoint_transformation_simulate_out.rb +1 -1
  57. data/lib/svix/models/endpoint_update.rb +1 -1
  58. data/lib/svix/models/endpoint_updated_event.rb +1 -1
  59. data/lib/svix/models/endpoint_updated_event_data.rb +5 -1
  60. data/lib/svix/models/environment_in.rb +1 -1
  61. data/lib/svix/models/environment_out.rb +1 -1
  62. data/lib/svix/models/environment_settings_out.rb +1 -1
  63. data/lib/svix/models/event_example_in.rb +2 -1
  64. data/lib/svix/models/event_type_example_out.rb +1 -1
  65. data/lib/svix/models/event_type_in.rb +2 -1
  66. data/lib/svix/models/event_type_out.rb +2 -1
  67. data/lib/svix/models/event_type_patch.rb +1 -1
  68. data/lib/svix/models/event_type_schema_in.rb +1 -1
  69. data/lib/svix/models/event_type_update.rb +1 -1
  70. data/lib/svix/models/font_size_config.rb +1 -1
  71. data/lib/svix/models/http_error_out.rb +1 -1
  72. data/lib/svix/models/http_validation_error.rb +1 -1
  73. data/lib/svix/models/integration_in.rb +1 -1
  74. data/lib/svix/models/integration_key_out.rb +1 -1
  75. data/lib/svix/models/integration_out.rb +2 -1
  76. data/lib/svix/models/integration_update.rb +1 -1
  77. data/lib/svix/models/list_response_application_out.rb +1 -1
  78. data/lib/svix/models/list_response_application_stats.rb +1 -1
  79. data/lib/svix/models/list_response_background_task_out.rb +1 -1
  80. data/lib/svix/models/list_response_endpoint_message_out.rb +1 -1
  81. data/lib/svix/models/list_response_endpoint_out.rb +1 -1
  82. data/lib/svix/models/list_response_event_type_out.rb +1 -1
  83. data/lib/svix/models/list_response_integration_out.rb +1 -1
  84. data/lib/svix/models/list_response_message_attempt_endpoint_out.rb +1 -1
  85. data/lib/svix/models/list_response_message_attempt_out.rb +1 -1
  86. data/lib/svix/models/list_response_message_endpoint_out.rb +1 -1
  87. data/lib/svix/models/list_response_message_out.rb +1 -1
  88. data/lib/svix/models/message_attempt_endpoint_out.rb +4 -1
  89. data/lib/svix/models/message_attempt_exhausted_event.rb +1 -1
  90. data/lib/svix/models/message_attempt_exhausted_event_data.rb +6 -1
  91. data/lib/svix/models/message_attempt_failed_data.rb +2 -1
  92. data/lib/svix/models/message_attempt_failing_event.rb +1 -1
  93. data/lib/svix/models/message_attempt_failing_event_data.rb +6 -1
  94. data/lib/svix/models/message_attempt_headers_out.rb +1 -1
  95. data/lib/svix/models/message_attempt_out.rb +4 -1
  96. data/lib/svix/models/message_attempt_trigger_type.rb +1 -1
  97. data/lib/svix/models/message_endpoint_out.rb +2 -1
  98. data/lib/svix/models/message_in.rb +2 -1
  99. data/lib/svix/models/message_out.rb +3 -1
  100. data/lib/svix/models/message_status.rb +1 -1
  101. data/lib/svix/models/ordering.rb +1 -1
  102. data/lib/svix/models/recover_in.rb +1 -1
  103. data/lib/svix/models/recover_out.rb +1 -1
  104. data/lib/svix/models/replay_in.rb +1 -1
  105. data/lib/svix/models/replay_out.rb +1 -1
  106. data/lib/svix/models/settings_in.rb +1 -1
  107. data/lib/svix/models/settings_out.rb +1 -1
  108. data/lib/svix/models/statistics_period.rb +1 -1
  109. data/lib/svix/models/status_code_class.rb +1 -1
  110. data/lib/svix/models/transformation_http_method.rb +1 -1
  111. data/lib/svix/models/validation_error.rb +1 -1
  112. data/lib/svix/version.rb +1 -1
  113. 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,7 +21,7 @@ module Svix
21
21
  end
22
22
  # Patch Event Type
23
23
  # Partially update an event type.
24
- # @param event_type_name [String]
24
+ # @param event_type_name [String] The event type&#39;s name
25
25
  # @param event_type_patch [EventTypePatch]
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @return [EventTypeOut]
@@ -32,7 +32,7 @@ module Svix
32
32
 
33
33
  # Patch Event Type
34
34
  # Partially update an event type.
35
- # @param event_type_name [String]
35
+ # @param event_type_name [String] The event type&#39;s name
36
36
  # @param event_type_patch [EventTypePatch]
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @return [Array<(EventTypeOut, Integer, Hash)>] EventTypeOut data, response status code and response headers
@@ -80,7 +80,7 @@ module Svix
80
80
  return_type = opts[:debug_return_type] || 'EventTypeOut'
81
81
 
82
82
  # auth_names
83
- auth_names = opts[:debug_auth_names] || []
83
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
84
84
 
85
85
  new_options = opts.merge(
86
86
  :operation => :"EventTypeApi.patch_event_type",
@@ -148,7 +148,7 @@ module Svix
148
148
  return_type = opts[:debug_return_type] || 'EventTypeOut'
149
149
 
150
150
  # auth_names
151
- auth_names = opts[:debug_auth_names] || []
151
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
152
152
 
153
153
  new_options = opts.merge(
154
154
  :operation => :"EventTypeApi.v1_event_type_create",
@@ -169,7 +169,7 @@ module Svix
169
169
 
170
170
  # Delete Event Type
171
171
  # Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints can not filter on it. An event type can be unarchived with the [create operation](#operation/create_event_type_api_v1_event_type__post).
172
- # @param event_type_name [String]
172
+ # @param event_type_name [String] The event type&#39;s name
173
173
  # @param [Hash] opts the optional parameters
174
174
  # @option opts [Boolean] :expunge (default to false)
175
175
  # @return [nil]
@@ -180,7 +180,7 @@ module Svix
180
180
 
181
181
  # Delete Event Type
182
182
  # Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints can not filter on it. An event type can be unarchived with the [create operation](#operation/create_event_type_api_v1_event_type__post).
183
- # @param event_type_name [String]
183
+ # @param event_type_name [String] The event type&#39;s name
184
184
  # @param [Hash] opts the optional parameters
185
185
  # @option opts [Boolean] :expunge
186
186
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -223,7 +223,7 @@ module Svix
223
223
  return_type = opts[:debug_return_type]
224
224
 
225
225
  # auth_names
226
- auth_names = opts[:debug_auth_names] || []
226
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
227
227
 
228
228
  new_options = opts.merge(
229
229
  :operation => :"EventTypeApi.v1_event_type_delete",
@@ -291,7 +291,7 @@ module Svix
291
291
  return_type = opts[:debug_return_type] || 'EventTypeExampleOut'
292
292
 
293
293
  # auth_names
294
- auth_names = opts[:debug_auth_names] || []
294
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
295
295
 
296
296
  new_options = opts.merge(
297
297
  :operation => :"EventTypeApi.v1_event_type_generate_example",
@@ -312,7 +312,7 @@ module Svix
312
312
 
313
313
  # Get Event Type
314
314
  # Get an event type.
315
- # @param event_type_name [String]
315
+ # @param event_type_name [String] The event type&#39;s name
316
316
  # @param [Hash] opts the optional parameters
317
317
  # @return [EventTypeOut]
318
318
  def v1_event_type_get(event_type_name, opts = {})
@@ -322,7 +322,7 @@ module Svix
322
322
 
323
323
  # Get Event Type
324
324
  # Get an event type.
325
- # @param event_type_name [String]
325
+ # @param event_type_name [String] The event type&#39;s name
326
326
  # @param [Hash] opts the optional parameters
327
327
  # @return [Array<(EventTypeOut, Integer, Hash)>] EventTypeOut data, response status code and response headers
328
328
  def v1_event_type_get_with_http_info(event_type_name, opts = {})
@@ -363,7 +363,7 @@ module Svix
363
363
  return_type = opts[:debug_return_type] || 'EventTypeOut'
364
364
 
365
365
  # auth_names
366
- auth_names = opts[:debug_auth_names] || []
366
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
367
367
 
368
368
  new_options = opts.merge(
369
369
  :operation => :"EventTypeApi.v1_event_type_get",
@@ -386,7 +386,7 @@ module Svix
386
386
  # Return the list of event types.
387
387
  # @param [Hash] opts the optional parameters
388
388
  # @option opts [Integer] :limit
389
- # @option opts [String] :iterator
389
+ # @option opts [String] :iterator The event type&#39;s name
390
390
  # @option opts [Ordering] :order
391
391
  # @option opts [Boolean] :include_archived (default to false)
392
392
  # @option opts [Boolean] :with_content (default to false)
@@ -400,7 +400,7 @@ module Svix
400
400
  # Return the list of event types.
401
401
  # @param [Hash] opts the optional parameters
402
402
  # @option opts [Integer] :limit
403
- # @option opts [String] :iterator
403
+ # @option opts [String] :iterator The event type&#39;s name
404
404
  # @option opts [Ordering] :order
405
405
  # @option opts [Boolean] :include_archived
406
406
  # @option opts [Boolean] :with_content
@@ -409,8 +409,12 @@ module Svix
409
409
  if @api_client.config.debugging
410
410
  @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_list ...'
411
411
  end
412
- if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
413
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EventTypeApi.v1_event_type_list, must be greater than or equal to 0.'
412
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
413
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EventTypeApi.v1_event_type_list, must be smaller than or equal to 250.'
414
+ end
415
+
416
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
417
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EventTypeApi.v1_event_type_list, must be greater than or equal to 1.'
414
418
  end
415
419
 
416
420
  if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'].to_s.length > 256
@@ -448,7 +452,7 @@ module Svix
448
452
  return_type = opts[:debug_return_type] || 'ListResponseEventTypeOut'
449
453
 
450
454
  # auth_names
451
- auth_names = opts[:debug_auth_names] || []
455
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
452
456
 
453
457
  new_options = opts.merge(
454
458
  :operation => :"EventTypeApi.v1_event_type_list",
@@ -469,7 +473,7 @@ module Svix
469
473
 
470
474
  # Update Event Type
471
475
  # Update an event type.
472
- # @param event_type_name [String]
476
+ # @param event_type_name [String] The event type&#39;s name
473
477
  # @param event_type_update [EventTypeUpdate]
474
478
  # @param [Hash] opts the optional parameters
475
479
  # @return [EventTypeOut]
@@ -480,7 +484,7 @@ module Svix
480
484
 
481
485
  # Update Event Type
482
486
  # Update an event type.
483
- # @param event_type_name [String]
487
+ # @param event_type_name [String] The event type&#39;s name
484
488
  # @param event_type_update [EventTypeUpdate]
485
489
  # @param [Hash] opts the optional parameters
486
490
  # @return [Array<(EventTypeOut, Integer, Hash)>] EventTypeOut data, response status code and response headers
@@ -528,7 +532,7 @@ module Svix
528
532
  return_type = opts[:debug_return_type] || 'EventTypeOut'
529
533
 
530
534
  # auth_names
531
- auth_names = opts[:debug_auth_names] || []
535
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
532
536
 
533
537
  new_options = opts.merge(
534
538
  :operation => :"EventTypeApi.v1_event_type_update",
@@ -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
@@ -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,7 +21,7 @@ module Svix
21
21
  end
22
22
  # Create Integration
23
23
  # Create an integration.
24
- # @param app_id [String]
24
+ # @param app_id [String] The app&#39;s ID or UID
25
25
  # @param integration_in [IntegrationIn]
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -33,7 +33,7 @@ module Svix
33
33
 
34
34
  # Create Integration
35
35
  # Create an integration.
36
- # @param app_id [String]
36
+ # @param app_id [String] The app&#39;s ID or UID
37
37
  # @param integration_in [IntegrationIn]
38
38
  # @param [Hash] opts the optional parameters
39
39
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -87,7 +87,7 @@ module Svix
87
87
  return_type = opts[:debug_return_type] || 'IntegrationOut'
88
88
 
89
89
  # auth_names
90
- auth_names = opts[:debug_auth_names] || []
90
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
91
91
 
92
92
  new_options = opts.merge(
93
93
  :operation => :"IntegrationApi.v1_integration_create",
@@ -108,8 +108,8 @@ module Svix
108
108
 
109
109
  # Delete Integration
110
110
  # Delete an integration.
111
- # @param app_id [String]
112
- # @param integ_id [String]
111
+ # @param app_id [String] The app&#39;s ID or UID
112
+ # @param integ_id [String] The integ&#39;s ID
113
113
  # @param [Hash] opts the optional parameters
114
114
  # @return [nil]
115
115
  def v1_integration_delete(app_id, integ_id, opts = {})
@@ -119,8 +119,8 @@ module Svix
119
119
 
120
120
  # Delete Integration
121
121
  # Delete an integration.
122
- # @param app_id [String]
123
- # @param integ_id [String]
122
+ # @param app_id [String] The app&#39;s ID or UID
123
+ # @param integ_id [String] The integ&#39;s ID
124
124
  # @param [Hash] opts the optional parameters
125
125
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
126
126
  def v1_integration_delete_with_http_info(app_id, integ_id, opts = {})
@@ -169,7 +169,7 @@ module Svix
169
169
  return_type = opts[:debug_return_type]
170
170
 
171
171
  # auth_names
172
- auth_names = opts[:debug_auth_names] || []
172
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
173
173
 
174
174
  new_options = opts.merge(
175
175
  :operation => :"IntegrationApi.v1_integration_delete",
@@ -190,8 +190,8 @@ module Svix
190
190
 
191
191
  # Get Integration
192
192
  # Get an integration.
193
- # @param app_id [String]
194
- # @param integ_id [String]
193
+ # @param app_id [String] The app&#39;s ID or UID
194
+ # @param integ_id [String] The integ&#39;s ID
195
195
  # @param [Hash] opts the optional parameters
196
196
  # @return [IntegrationOut]
197
197
  def v1_integration_get(app_id, integ_id, opts = {})
@@ -201,8 +201,8 @@ module Svix
201
201
 
202
202
  # Get Integration
203
203
  # Get an integration.
204
- # @param app_id [String]
205
- # @param integ_id [String]
204
+ # @param app_id [String] The app&#39;s ID or UID
205
+ # @param integ_id [String] The integ&#39;s ID
206
206
  # @param [Hash] opts the optional parameters
207
207
  # @return [Array<(IntegrationOut, Integer, Hash)>] IntegrationOut data, response status code and response headers
208
208
  def v1_integration_get_with_http_info(app_id, integ_id, opts = {})
@@ -251,7 +251,7 @@ module Svix
251
251
  return_type = opts[:debug_return_type] || 'IntegrationOut'
252
252
 
253
253
  # auth_names
254
- auth_names = opts[:debug_auth_names] || []
254
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
255
255
 
256
256
  new_options = opts.merge(
257
257
  :operation => :"IntegrationApi.v1_integration_get",
@@ -272,8 +272,8 @@ module Svix
272
272
 
273
273
  # Get Integration Key
274
274
  # Get an integration's key.
275
- # @param app_id [String]
276
- # @param integ_id [String]
275
+ # @param app_id [String] The app&#39;s ID or UID
276
+ # @param integ_id [String] The integ&#39;s ID
277
277
  # @param [Hash] opts the optional parameters
278
278
  # @return [IntegrationKeyOut]
279
279
  def v1_integration_get_key(app_id, integ_id, opts = {})
@@ -283,8 +283,8 @@ module Svix
283
283
 
284
284
  # Get Integration Key
285
285
  # Get an integration&#39;s key.
286
- # @param app_id [String]
287
- # @param integ_id [String]
286
+ # @param app_id [String] The app&#39;s ID or UID
287
+ # @param integ_id [String] The integ&#39;s ID
288
288
  # @param [Hash] opts the optional parameters
289
289
  # @return [Array<(IntegrationKeyOut, Integer, Hash)>] IntegrationKeyOut data, response status code and response headers
290
290
  def v1_integration_get_key_with_http_info(app_id, integ_id, opts = {})
@@ -333,7 +333,7 @@ module Svix
333
333
  return_type = opts[:debug_return_type] || 'IntegrationKeyOut'
334
334
 
335
335
  # auth_names
336
- auth_names = opts[:debug_auth_names] || []
336
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
337
337
 
338
338
  new_options = opts.merge(
339
339
  :operation => :"IntegrationApi.v1_integration_get_key",
@@ -354,10 +354,10 @@ module Svix
354
354
 
355
355
  # List Integrations
356
356
  # List the application's integrations.
357
- # @param app_id [String]
357
+ # @param app_id [String] The app&#39;s ID or UID
358
358
  # @param [Hash] opts the optional parameters
359
359
  # @option opts [Integer] :limit
360
- # @option opts [String] :iterator
360
+ # @option opts [String] :iterator The integ&#39;s ID
361
361
  # @return [ListResponseIntegrationOut]
362
362
  def v1_integration_list(app_id, opts = {})
363
363
  data, _status_code, _headers = v1_integration_list_with_http_info(app_id, opts)
@@ -366,10 +366,10 @@ module Svix
366
366
 
367
367
  # List Integrations
368
368
  # List the application&#39;s integrations.
369
- # @param app_id [String]
369
+ # @param app_id [String] The app&#39;s ID or UID
370
370
  # @param [Hash] opts the optional parameters
371
371
  # @option opts [Integer] :limit
372
- # @option opts [String] :iterator
372
+ # @option opts [String] :iterator The integ&#39;s ID
373
373
  # @return [Array<(ListResponseIntegrationOut, Integer, Hash)>] ListResponseIntegrationOut data, response status code and response headers
374
374
  def v1_integration_list_with_http_info(app_id, opts = {})
375
375
  if @api_client.config.debugging
@@ -392,8 +392,12 @@ module Svix
392
392
  fail ArgumentError, "invalid value for 'app_id' when calling IntegrationApi.v1_integration_list, must conform to the pattern #{pattern}."
393
393
  end
394
394
 
395
- if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
396
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling IntegrationApi.v1_integration_list, must be greater than or equal to 0.'
395
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
396
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling IntegrationApi.v1_integration_list, must be smaller than or equal to 250.'
397
+ end
398
+
399
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
400
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling IntegrationApi.v1_integration_list, must be greater than or equal to 1.'
397
401
  end
398
402
 
399
403
  # resource path
@@ -419,7 +423,7 @@ module Svix
419
423
  return_type = opts[:debug_return_type] || 'ListResponseIntegrationOut'
420
424
 
421
425
  # auth_names
422
- auth_names = opts[:debug_auth_names] || []
426
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
423
427
 
424
428
  new_options = opts.merge(
425
429
  :operation => :"IntegrationApi.v1_integration_list",
@@ -440,8 +444,8 @@ module Svix
440
444
 
441
445
  # Rotate Integration Key
442
446
  # Rotate the integration's key. The previous key will be immediately revoked.
443
- # @param app_id [String]
444
- # @param integ_id [String]
447
+ # @param app_id [String] The app&#39;s ID or UID
448
+ # @param integ_id [String] The integ&#39;s ID
445
449
  # @param [Hash] opts the optional parameters
446
450
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
447
451
  # @return [IntegrationKeyOut]
@@ -452,8 +456,8 @@ module Svix
452
456
 
453
457
  # Rotate Integration Key
454
458
  # Rotate the integration&#39;s key. The previous key will be immediately revoked.
455
- # @param app_id [String]
456
- # @param integ_id [String]
459
+ # @param app_id [String] The app&#39;s ID or UID
460
+ # @param integ_id [String] The integ&#39;s ID
457
461
  # @param [Hash] opts the optional parameters
458
462
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
459
463
  # @return [Array<(IntegrationKeyOut, Integer, Hash)>] IntegrationKeyOut data, response status code and response headers
@@ -504,7 +508,7 @@ module Svix
504
508
  return_type = opts[:debug_return_type] || 'IntegrationKeyOut'
505
509
 
506
510
  # auth_names
507
- auth_names = opts[:debug_auth_names] || []
511
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
508
512
 
509
513
  new_options = opts.merge(
510
514
  :operation => :"IntegrationApi.v1_integration_rotate_key",
@@ -525,8 +529,8 @@ module Svix
525
529
 
526
530
  # Update Integration
527
531
  # Update an integration.
528
- # @param app_id [String]
529
- # @param integ_id [String]
532
+ # @param app_id [String] The app&#39;s ID or UID
533
+ # @param integ_id [String] The integ&#39;s ID
530
534
  # @param integration_update [IntegrationUpdate]
531
535
  # @param [Hash] opts the optional parameters
532
536
  # @return [IntegrationOut]
@@ -537,8 +541,8 @@ module Svix
537
541
 
538
542
  # Update Integration
539
543
  # Update an integration.
540
- # @param app_id [String]
541
- # @param integ_id [String]
544
+ # @param app_id [String] The app&#39;s ID or UID
545
+ # @param integ_id [String] The integ&#39;s ID
542
546
  # @param integration_update [IntegrationUpdate]
543
547
  # @param [Hash] opts the optional parameters
544
548
  # @return [Array<(IntegrationOut, Integer, Hash)>] IntegrationOut data, response status code and response headers
@@ -594,7 +598,7 @@ module Svix
594
598
  return_type = opts[:debug_return_type] || 'IntegrationOut'
595
599
 
596
600
  # auth_names
597
- auth_names = opts[:debug_auth_names] || []
601
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
598
602
 
599
603
  new_options = opts.merge(
600
604
  :operation => :"IntegrationApi.v1_integration_update",
@@ -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,7 +21,7 @@ module Svix
21
21
  end
22
22
  # Create Message
23
23
  # Creates a new message and dispatches it to all of the application's endpoints. The `eventId` is an optional custom unique ID. It's verified to be unique only up to a day, after that no verification will be made. If a message with the same `eventId` already exists for any application in your environment, a 409 conflict error will be returned. The `eventType` indicates the type and schema of the event. All messages of a certain `eventType` are expected to have the same schema. Endpoints can choose to only listen to specific event types. Messages can also have `channels`, which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don't imply a specific message content or schema. The `payload` property is the webhook's body (the actual webhook message). Svix supports payload sizes of up to ~350kb, though it's generally a good idea to keep webhook payloads small, probably no larger than 40kb.
24
- # @param app_id [String]
24
+ # @param app_id [String] The app&#39;s ID or UID
25
25
  # @param message_in [MessageIn]
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @option opts [Boolean] :with_content (default to true)
@@ -34,7 +34,7 @@ module Svix
34
34
 
35
35
  # Create Message
36
36
  # Creates a new message and dispatches it to all of the application&#39;s endpoints. The &#x60;eventId&#x60; is an optional custom unique ID. It&#39;s verified to be unique only up to a day, after that no verification will be made. If a message with the same &#x60;eventId&#x60; already exists for any application in your environment, a 409 conflict error will be returned. The &#x60;eventType&#x60; indicates the type and schema of the event. All messages of a certain &#x60;eventType&#x60; are expected to have the same schema. Endpoints can choose to only listen to specific event types. Messages can also have &#x60;channels&#x60;, which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don&#39;t imply a specific message content or schema. The &#x60;payload&#x60; property is the webhook&#39;s body (the actual webhook message). Svix supports payload sizes of up to ~350kb, though it&#39;s generally a good idea to keep webhook payloads small, probably no larger than 40kb.
37
- # @param app_id [String]
37
+ # @param app_id [String] The app&#39;s ID or UID
38
38
  # @param message_in [MessageIn]
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @option opts [Boolean] :with_content
@@ -90,7 +90,7 @@ module Svix
90
90
  return_type = opts[:debug_return_type] || 'MessageOut'
91
91
 
92
92
  # auth_names
93
- auth_names = opts[:debug_auth_names] || []
93
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
94
94
 
95
95
  new_options = opts.merge(
96
96
  :operation => :"MessageApi.v1_message_create",
@@ -109,10 +109,10 @@ module Svix
109
109
  return data, status_code, headers
110
110
  end
111
111
 
112
- # Expunge Message Content
112
+ # Delete message payload
113
113
  # Delete the given message's payload. Useful in cases when a message was accidentally sent with sensitive content. The message can't be replayed or resent once its payload has been deleted or expired.
114
- # @param app_id [String]
115
- # @param msg_id [String]
114
+ # @param app_id [String] The app&#39;s ID or UID
115
+ # @param msg_id [String] The msg&#39;s ID or UID
116
116
  # @param [Hash] opts the optional parameters
117
117
  # @return [nil]
118
118
  def v1_message_expunge_content(app_id, msg_id, opts = {})
@@ -120,10 +120,10 @@ module Svix
120
120
  nil
121
121
  end
122
122
 
123
- # Expunge Message Content
123
+ # Delete message payload
124
124
  # Delete the given message&#39;s payload. Useful in cases when a message was accidentally sent with sensitive content. The message can&#39;t be replayed or resent once its payload has been deleted or expired.
125
- # @param app_id [String]
126
- # @param msg_id [String]
125
+ # @param app_id [String] The app&#39;s ID or UID
126
+ # @param msg_id [String] The msg&#39;s ID or UID
127
127
  # @param [Hash] opts the optional parameters
128
128
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
129
129
  def v1_message_expunge_content_with_http_info(app_id, msg_id, opts = {})
@@ -185,7 +185,7 @@ module Svix
185
185
  return_type = opts[:debug_return_type]
186
186
 
187
187
  # auth_names
188
- auth_names = opts[:debug_auth_names] || []
188
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
189
189
 
190
190
  new_options = opts.merge(
191
191
  :operation => :"MessageApi.v1_message_expunge_content",
@@ -206,8 +206,8 @@ module Svix
206
206
 
207
207
  # Get Message
208
208
  # Get a message by its ID or eventID.
209
- # @param app_id [String]
210
- # @param msg_id [String]
209
+ # @param app_id [String] The app&#39;s ID or UID
210
+ # @param msg_id [String] The msg&#39;s ID or UID
211
211
  # @param [Hash] opts the optional parameters
212
212
  # @option opts [Boolean] :with_content (default to true)
213
213
  # @return [MessageOut]
@@ -218,8 +218,8 @@ module Svix
218
218
 
219
219
  # Get Message
220
220
  # Get a message by its ID or eventID.
221
- # @param app_id [String]
222
- # @param msg_id [String]
221
+ # @param app_id [String] The app&#39;s ID or UID
222
+ # @param msg_id [String] The msg&#39;s ID or UID
223
223
  # @param [Hash] opts the optional parameters
224
224
  # @option opts [Boolean] :with_content
225
225
  # @return [Array<(MessageOut, Integer, Hash)>] MessageOut data, response status code and response headers
@@ -283,7 +283,7 @@ module Svix
283
283
  return_type = opts[:debug_return_type] || 'MessageOut'
284
284
 
285
285
  # auth_names
286
- auth_names = opts[:debug_auth_names] || []
286
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
287
287
 
288
288
  new_options = opts.merge(
289
289
  :operation => :"MessageApi.v1_message_get",
@@ -304,10 +304,10 @@ module Svix
304
304
 
305
305
  # List Messages
306
306
  # List all of the application's messages. The `before` parameter lets you filter all items created before a certain date and is ignored if an iterator is passed. The `after` parameter lets you filter all items created after a certain date and is ignored if an iterator is passed. `before` and `after` cannot be used simultaneously.
307
- # @param app_id [String]
307
+ # @param app_id [String] The app&#39;s ID or UID
308
308
  # @param [Hash] opts the optional parameters
309
309
  # @option opts [Integer] :limit
310
- # @option opts [String] :iterator
310
+ # @option opts [String] :iterator The msg&#39;s ID
311
311
  # @option opts [String] :channel
312
312
  # @option opts [Time] :before
313
313
  # @option opts [Time] :after
@@ -320,10 +320,10 @@ module Svix
320
320
 
321
321
  # List Messages
322
322
  # List all of the application&#39;s messages. The &#x60;before&#x60; parameter lets you filter all items created before a certain date and is ignored if an iterator is passed. The &#x60;after&#x60; parameter lets you filter all items created after a certain date and is ignored if an iterator is passed. &#x60;before&#x60; and &#x60;after&#x60; cannot be used simultaneously.
323
- # @param app_id [String]
323
+ # @param app_id [String] The app&#39;s ID or UID
324
324
  # @param [Hash] opts the optional parameters
325
325
  # @option opts [Integer] :limit
326
- # @option opts [String] :iterator
326
+ # @option opts [String] :iterator The msg&#39;s ID
327
327
  # @option opts [String] :channel
328
328
  # @option opts [Time] :before
329
329
  # @option opts [Time] :after
@@ -350,8 +350,12 @@ module Svix
350
350
  fail ArgumentError, "invalid value for 'app_id' when calling MessageApi.v1_message_list, must conform to the pattern #{pattern}."
351
351
  end
352
352
 
353
- if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
354
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageApi.v1_message_list, must be greater than or equal to 0.'
353
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
354
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageApi.v1_message_list, must be smaller than or equal to 250.'
355
+ end
356
+
357
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
358
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageApi.v1_message_list, must be greater than or equal to 1.'
355
359
  end
356
360
 
357
361
  if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
@@ -390,7 +394,7 @@ module Svix
390
394
  return_type = opts[:debug_return_type] || 'ListResponseMessageOut'
391
395
 
392
396
  # auth_names
393
- auth_names = opts[:debug_auth_names] || []
397
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
394
398
 
395
399
  new_options = opts.merge(
396
400
  :operation => :"MessageApi.v1_message_list",