svix 1.10.0 → 1.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (135) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/lib/svix/api/application_api.rb +20 -20
  4. data/lib/svix/api/authentication_api.rb +2 -2
  5. data/lib/svix/api/background_tasks_api.rb +12 -12
  6. data/lib/svix/api/broadcast_api.rb +2 -2
  7. data/lib/svix/api/endpoint_api.rb +12 -12
  8. data/lib/svix/api/environment_api.rb +2 -2
  9. data/lib/svix/api/environment_settings_api.rb +2 -2
  10. data/lib/svix/api/event_type_api.rb +82 -14
  11. data/lib/svix/api/health_api.rb +2 -2
  12. data/lib/svix/api/integration_api.rb +6 -6
  13. data/lib/svix/api/message_api.rb +115 -20
  14. data/lib/svix/api/message_attempt_api.rb +94 -94
  15. data/lib/svix/api/statistics_api.rb +10 -10
  16. data/lib/svix/api/transformation_template_api.rb +8 -8
  17. data/lib/svix/api_client.rb +2 -2
  18. data/lib/svix/api_error.rb +2 -2
  19. data/lib/svix/configuration.rb +10 -6
  20. data/lib/svix/event_type_api.rb +4 -0
  21. data/lib/svix/models/app_portal_access_in.rb +2 -2
  22. data/lib/svix/models/app_portal_access_out.rb +2 -2
  23. data/lib/svix/models/app_usage_stats_in.rb +2 -2
  24. data/lib/svix/models/app_usage_stats_out.rb +2 -2
  25. data/lib/svix/models/application_in.rb +2 -2
  26. data/lib/svix/models/application_out.rb +2 -2
  27. data/lib/svix/models/application_patch.rb +2 -2
  28. data/lib/svix/models/application_stats.rb +2 -2
  29. data/lib/svix/models/application_token_expire_in.rb +2 -2
  30. data/lib/svix/models/attempt_statistics_data.rb +2 -2
  31. data/lib/svix/models/attempt_statistics_response.rb +2 -2
  32. data/lib/svix/models/background_task_out.rb +2 -2
  33. data/lib/svix/models/background_task_status.rb +2 -2
  34. data/lib/svix/models/background_task_type.rb +2 -2
  35. data/lib/svix/models/border_radius_config.rb +2 -2
  36. data/lib/svix/models/border_radius_enum.rb +2 -2
  37. data/lib/svix/models/custom_color_palette.rb +2 -2
  38. data/lib/svix/models/custom_theme_override.rb +2 -2
  39. data/lib/svix/models/dashboard_access_out.rb +2 -2
  40. data/lib/svix/models/endpoint_created_event.rb +2 -2
  41. data/lib/svix/models/endpoint_created_event_data.rb +2 -2
  42. data/lib/svix/models/endpoint_deleted_event.rb +2 -2
  43. data/lib/svix/models/endpoint_deleted_event_data.rb +2 -2
  44. data/lib/svix/models/endpoint_disabled_event.rb +2 -2
  45. data/lib/svix/models/endpoint_disabled_event_data.rb +2 -2
  46. data/lib/svix/models/endpoint_headers_in.rb +2 -2
  47. data/lib/svix/models/endpoint_headers_out.rb +2 -2
  48. data/lib/svix/models/endpoint_headers_patch_in.rb +2 -2
  49. data/lib/svix/models/endpoint_in.rb +2 -2
  50. data/lib/svix/models/endpoint_message_out.rb +2 -2
  51. data/lib/svix/models/endpoint_out.rb +2 -2
  52. data/lib/svix/models/endpoint_patch.rb +2 -2
  53. data/lib/svix/models/endpoint_secret_out.rb +2 -2
  54. data/lib/svix/models/endpoint_secret_rotate_in.rb +2 -2
  55. data/lib/svix/models/endpoint_stats.rb +2 -2
  56. data/lib/svix/models/endpoint_transformation_in.rb +2 -2
  57. data/lib/svix/models/endpoint_transformation_out.rb +2 -2
  58. data/lib/svix/models/endpoint_transformation_simulate_in.rb +2 -2
  59. data/lib/svix/models/endpoint_transformation_simulate_out.rb +2 -2
  60. data/lib/svix/models/endpoint_update.rb +2 -2
  61. data/lib/svix/models/endpoint_updated_event.rb +2 -2
  62. data/lib/svix/models/endpoint_updated_event_data.rb +2 -2
  63. data/lib/svix/models/environment_in.rb +2 -2
  64. data/lib/svix/models/environment_out.rb +2 -2
  65. data/lib/svix/models/environment_settings_out.rb +2 -2
  66. data/lib/svix/models/event_example_in.rb +2 -2
  67. data/lib/svix/models/event_type_example_out.rb +2 -2
  68. data/lib/svix/models/event_type_import_open_api_in.rb +225 -0
  69. data/lib/svix/models/event_type_import_open_api_out.rb +223 -0
  70. data/lib/svix/models/event_type_import_open_api_out_data.rb +225 -0
  71. data/lib/svix/models/event_type_in.rb +2 -2
  72. data/lib/svix/models/event_type_out.rb +2 -2
  73. data/lib/svix/models/event_type_patch.rb +2 -2
  74. data/lib/svix/models/event_type_schema_in.rb +2 -2
  75. data/lib/svix/models/event_type_update.rb +2 -2
  76. data/lib/svix/models/font_size_config.rb +2 -2
  77. data/lib/svix/models/http_error_out.rb +2 -2
  78. data/lib/svix/models/http_validation_error.rb +2 -2
  79. data/lib/svix/models/integration_in.rb +2 -2
  80. data/lib/svix/models/integration_key_out.rb +2 -2
  81. data/lib/svix/models/integration_out.rb +2 -2
  82. data/lib/svix/models/integration_update.rb +2 -2
  83. data/lib/svix/models/list_response_application_out.rb +2 -2
  84. data/lib/svix/models/list_response_application_stats.rb +2 -2
  85. data/lib/svix/models/list_response_background_task_out.rb +2 -2
  86. data/lib/svix/models/list_response_endpoint_message_out.rb +2 -2
  87. data/lib/svix/models/list_response_endpoint_out.rb +2 -2
  88. data/lib/svix/models/list_response_event_type_out.rb +2 -2
  89. data/lib/svix/models/list_response_integration_out.rb +2 -2
  90. data/lib/svix/models/list_response_message_attempt_endpoint_out.rb +2 -2
  91. data/lib/svix/models/list_response_message_attempt_out.rb +2 -2
  92. data/lib/svix/models/list_response_message_endpoint_out.rb +2 -2
  93. data/lib/svix/models/list_response_message_out.rb +2 -2
  94. data/lib/svix/models/list_response_template_out.rb +2 -2
  95. data/lib/svix/models/message_attempt_endpoint_out.rb +2 -2
  96. data/lib/svix/models/message_attempt_exhausted_event.rb +2 -2
  97. data/lib/svix/models/message_attempt_exhausted_event_data.rb +2 -2
  98. data/lib/svix/models/message_attempt_failed_data.rb +2 -2
  99. data/lib/svix/models/message_attempt_failing_event.rb +2 -2
  100. data/lib/svix/models/message_attempt_failing_event_data.rb +2 -2
  101. data/lib/svix/models/message_attempt_headers_out.rb +2 -2
  102. data/lib/svix/models/message_attempt_out.rb +2 -2
  103. data/lib/svix/models/message_attempt_recovered_event.rb +2 -2
  104. data/lib/svix/models/message_attempt_recovered_event_data.rb +2 -2
  105. data/lib/svix/models/message_attempt_trigger_type.rb +2 -2
  106. data/lib/svix/models/message_broadcast_in.rb +2 -2
  107. data/lib/svix/models/message_broadcast_out.rb +2 -2
  108. data/lib/svix/models/message_endpoint_out.rb +2 -2
  109. data/lib/svix/models/message_in.rb +2 -2
  110. data/lib/svix/models/message_out.rb +2 -2
  111. data/lib/svix/models/message_raw_payload_out.rb +223 -0
  112. data/lib/svix/models/message_status.rb +2 -2
  113. data/lib/svix/models/one_time_token_in.rb +2 -2
  114. data/lib/svix/models/one_time_token_out.rb +2 -2
  115. data/lib/svix/models/ordering.rb +2 -2
  116. data/lib/svix/models/recover_in.rb +2 -2
  117. data/lib/svix/models/recover_out.rb +2 -2
  118. data/lib/svix/models/replay_in.rb +2 -2
  119. data/lib/svix/models/replay_out.rb +2 -2
  120. data/lib/svix/models/settings_in.rb +2 -2
  121. data/lib/svix/models/settings_out.rb +2 -2
  122. data/lib/svix/models/statistics_period.rb +2 -2
  123. data/lib/svix/models/status_code_class.rb +2 -2
  124. data/lib/svix/models/template_in.rb +2 -2
  125. data/lib/svix/models/template_out.rb +2 -2
  126. data/lib/svix/models/template_patch.rb +2 -2
  127. data/lib/svix/models/template_update.rb +2 -2
  128. data/lib/svix/models/transformation_http_method.rb +2 -2
  129. data/lib/svix/models/transformation_simulate_in.rb +2 -2
  130. data/lib/svix/models/transformation_simulate_out.rb +2 -2
  131. data/lib/svix/models/transformation_template_kind.rb +2 -2
  132. data/lib/svix/models/validation_error.rb +3 -3
  133. data/lib/svix/version.rb +1 -1
  134. data/lib/svix.rb +3 -0
  135. metadata +6 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: aa20acf634e43e947e9dc494faac76ec3aa46d53a65a26bd0112763dfbde1299
4
- data.tar.gz: 5dddf5415e2e6f471159b8e1bd2ce98e79b3d4d7786237afbd176f3255198281
3
+ metadata.gz: eaab1c4418f3c0a4f3f7c63f1fe116c9bc4b60c020838830f360ad363613f568
4
+ data.tar.gz: a5397eba7cbd51dd78806a3b4a2526cd063ba6d833a7708274eebb0c2ee7b378
5
5
  SHA512:
6
- metadata.gz: f2d3abef8b6d4e7f2fdce7f3e6bdbda36349f36f7fd1c17de071d67cb3adf0ffacf2cae611e193d14380f1a4a1c514a1817a4c45834fb4549bca27f5aee2bd4e
7
- data.tar.gz: 590e0f43547c7f40781da9be358163142145fe70a57b887263fb6343c66d01d97afc228ce6100c6f95f30b254e946f4a4bd2e26abbda63966bb8b0f215c051d7
6
+ metadata.gz: ecef7b2e766d99655203c24950eae35b831654ede0a2f01c6eaf97c1c179d5c396259b3b6001520f96c20757087aa1f8fc1f7450e4812b7e154990966e20680e
7
+ data.tar.gz: 650c74bb8413282a8a21153bd8a7ec6917174a216df442950c1c68f97505ef91dec7df63d0244dd5e236737538510e378cac418ab62c3eaa3a031f2a8c69d6f1
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- svix (1.10.0)
4
+ svix (1.11.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -1,9 +1,9 @@
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
5
 
6
- The version of the OpenAPI document: 1.7.0
6
+ The version of the OpenAPI document: 1.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -21,11 +21,11 @@ module Svix
21
21
  end
22
22
  # Get App Usage Stats
23
23
  # Get basic statistics for all applications.
24
- # @param since [Time]
25
- # @param _until [Time]
24
+ # @param since [Time] Filter the range to data after this date
25
+ # @param _until [Time] Filter the range to data before this date
26
26
  # @param [Hash] opts the optional parameters
27
- # @option opts [Integer] :limit (default to 50)
28
- # @option opts [String] :iterator The app&#39;s ID
27
+ # @option opts [Integer] :limit Limit the number of returned items (default to 50)
28
+ # @option opts [String] :iterator The iterator to use (depends on the chosen ordering)
29
29
  # @return [ListResponseApplicationStats]
30
30
  def get_app_usage_stats_api_v1_app_stats_usage_get(since, _until, opts = {})
31
31
  data, _status_code, _headers = get_app_usage_stats_api_v1_app_stats_usage_get_with_http_info(since, _until, opts)
@@ -34,11 +34,11 @@ module Svix
34
34
 
35
35
  # Get App Usage Stats
36
36
  # Get basic statistics for all applications.
37
- # @param since [Time]
38
- # @param _until [Time]
37
+ # @param since [Time] Filter the range to data after this date
38
+ # @param _until [Time] Filter the range to data before this date
39
39
  # @param [Hash] opts the optional parameters
40
- # @option opts [Integer] :limit
41
- # @option opts [String] :iterator The app&#39;s ID
40
+ # @option opts [Integer] :limit Limit the number of returned items
41
+ # @option opts [String] :iterator The iterator to use (depends on the chosen ordering)
42
42
  # @return [Array<(ListResponseApplicationStats, Integer, Hash)>] ListResponseApplicationStats data, response status code and response headers
43
43
  def get_app_usage_stats_api_v1_app_stats_usage_get_with_http_info(since, _until, opts = {})
44
44
  if @api_client.config.debugging
@@ -325,8 +325,8 @@ module Svix
325
325
 
326
326
  # Get App Stats
327
327
  # Get basic statistics for the application
328
- # @param since [Time]
329
- # @param _until [Time]
328
+ # @param since [Time] Filter the range to data starting from this date
329
+ # @param _until [Time] Filter the range to data ending by this date
330
330
  # @param app_id [String] The app&#39;s ID or UID
331
331
  # @param [Hash] opts the optional parameters
332
332
  # @return [ApplicationStats]
@@ -337,8 +337,8 @@ module Svix
337
337
 
338
338
  # Get App Stats
339
339
  # Get basic statistics for the application
340
- # @param since [Time]
341
- # @param _until [Time]
340
+ # @param since [Time] Filter the range to data starting from this date
341
+ # @param _until [Time] Filter the range to data ending by this date
342
342
  # @param app_id [String] The app&#39;s ID or UID
343
343
  # @param [Hash] opts the optional parameters
344
344
  # @return [Array<(ApplicationStats, Integer, Hash)>] ApplicationStats data, response status code and response headers
@@ -416,9 +416,9 @@ module Svix
416
416
  # List Applications
417
417
  # List of all the organization's applications.
418
418
  # @param [Hash] opts the optional parameters
419
- # @option opts [Integer] :limit
420
- # @option opts [String] :iterator The app&#39;s ID
421
- # @option opts [Ordering] :order
419
+ # @option opts [Integer] :limit Limit the number of returned items
420
+ # @option opts [String] :iterator The iterator returned from a prior invocation
421
+ # @option opts [Ordering] :order The sorting order of the returned items
422
422
  # @return [ListResponseApplicationOut]
423
423
  def v1_application_list(opts = {})
424
424
  data, _status_code, _headers = v1_application_list_with_http_info(opts)
@@ -428,9 +428,9 @@ module Svix
428
428
  # List Applications
429
429
  # List of all the organization&#39;s applications.
430
430
  # @param [Hash] opts the optional parameters
431
- # @option opts [Integer] :limit
432
- # @option opts [String] :iterator The app&#39;s ID
433
- # @option opts [Ordering] :order
431
+ # @option opts [Integer] :limit Limit the number of returned items
432
+ # @option opts [String] :iterator The iterator returned from a prior invocation
433
+ # @option opts [Ordering] :order The sorting order of the returned items
434
434
  # @return [Array<(ListResponseApplicationOut, Integer, Hash)>] ListResponseApplicationOut data, response status code and response headers
435
435
  def v1_application_list_with_http_info(opts = {})
436
436
  if @api_client.config.debugging
@@ -1,9 +1,9 @@
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
5
 
6
- The version of the OpenAPI document: 1.7.0
6
+ The version of the OpenAPI document: 1.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -1,9 +1,9 @@
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
5
 
6
- The version of the OpenAPI document: 1.7.0
6
+ The version of the OpenAPI document: 1.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -85,11 +85,11 @@ module Svix
85
85
  # List Background Tasks
86
86
  # List background tasks executed in the past 90 days.
87
87
  # @param [Hash] opts the optional parameters
88
- # @option opts [BackgroundTaskStatus] :status
89
- # @option opts [BackgroundTaskType] :task
90
- # @option opts [Integer] :limit
91
- # @option opts [String] :iterator
92
- # @option opts [Ordering] :order
88
+ # @option opts [BackgroundTaskStatus] :status Filter the response based on the status
89
+ # @option opts [BackgroundTaskType] :task Filter the response based on the type
90
+ # @option opts [Integer] :limit Limit the number of returned items
91
+ # @option opts [String] :iterator The iterator returned from a prior invocation
92
+ # @option opts [Ordering] :order The sorting order of the returned items
93
93
  # @return [ListResponseBackgroundTaskOut]
94
94
  def list_background_tasks(opts = {})
95
95
  data, _status_code, _headers = list_background_tasks_with_http_info(opts)
@@ -99,11 +99,11 @@ module Svix
99
99
  # List Background Tasks
100
100
  # List background tasks executed in the past 90 days.
101
101
  # @param [Hash] opts the optional parameters
102
- # @option opts [BackgroundTaskStatus] :status
103
- # @option opts [BackgroundTaskType] :task
104
- # @option opts [Integer] :limit
105
- # @option opts [String] :iterator
106
- # @option opts [Ordering] :order
102
+ # @option opts [BackgroundTaskStatus] :status Filter the response based on the status
103
+ # @option opts [BackgroundTaskType] :task Filter the response based on the type
104
+ # @option opts [Integer] :limit Limit the number of returned items
105
+ # @option opts [String] :iterator The iterator returned from a prior invocation
106
+ # @option opts [Ordering] :order The sorting order of the returned items
107
107
  # @return [Array<(ListResponseBackgroundTaskOut, Integer, Hash)>] ListResponseBackgroundTaskOut data, response status code and response headers
108
108
  def list_background_tasks_with_http_info(opts = {})
109
109
  if @api_client.config.debugging
@@ -1,9 +1,9 @@
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
5
 
6
- The version of the OpenAPI document: 1.7.0
6
+ The version of the OpenAPI document: 1.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -1,9 +1,9 @@
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
5
 
6
- The version of the OpenAPI document: 1.7.0
6
+ The version of the OpenAPI document: 1.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -491,8 +491,8 @@ module Svix
491
491
  # @param app_id [String] The app&#39;s ID or UID
492
492
  # @param endpoint_id [String] The ep&#39;s ID or UID
493
493
  # @param [Hash] opts the optional parameters
494
- # @option opts [Time] :since
495
- # @option opts [Time] :_until
494
+ # @option opts [Time] :since Filter the range to data starting from this date
495
+ # @option opts [Time] :_until Filter the range to data ending by this date
496
496
  # @return [EndpointStats]
497
497
  def v1_endpoint_get_stats(app_id, endpoint_id, opts = {})
498
498
  data, _status_code, _headers = v1_endpoint_get_stats_with_http_info(app_id, endpoint_id, opts)
@@ -504,8 +504,8 @@ module Svix
504
504
  # @param app_id [String] The app&#39;s ID or UID
505
505
  # @param endpoint_id [String] The ep&#39;s ID or UID
506
506
  # @param [Hash] opts the optional parameters
507
- # @option opts [Time] :since
508
- # @option opts [Time] :_until
507
+ # @option opts [Time] :since Filter the range to data starting from this date
508
+ # @option opts [Time] :_until Filter the range to data ending by this date
509
509
  # @return [Array<(EndpointStats, Integer, Hash)>] EndpointStats data, response status code and response headers
510
510
  def v1_endpoint_get_stats_with_http_info(app_id, endpoint_id, opts = {})
511
511
  if @api_client.config.debugging
@@ -591,9 +591,9 @@ module Svix
591
591
  # List the application's endpoints.
592
592
  # @param app_id [String] The app&#39;s ID or UID
593
593
  # @param [Hash] opts the optional parameters
594
- # @option opts [Integer] :limit
595
- # @option opts [String] :iterator The ep&#39;s ID
596
- # @option opts [Ordering] :order
594
+ # @option opts [Integer] :limit Limit the number of returned items
595
+ # @option opts [String] :iterator The iterator returned from a prior invocation
596
+ # @option opts [Ordering] :order The sorting order of the returned items
597
597
  # @return [ListResponseEndpointOut]
598
598
  def v1_endpoint_list(app_id, opts = {})
599
599
  data, _status_code, _headers = v1_endpoint_list_with_http_info(app_id, opts)
@@ -604,9 +604,9 @@ module Svix
604
604
  # List the application&#39;s endpoints.
605
605
  # @param app_id [String] The app&#39;s ID or UID
606
606
  # @param [Hash] opts the optional parameters
607
- # @option opts [Integer] :limit
608
- # @option opts [String] :iterator The ep&#39;s ID
609
- # @option opts [Ordering] :order
607
+ # @option opts [Integer] :limit Limit the number of returned items
608
+ # @option opts [String] :iterator The iterator returned from a prior invocation
609
+ # @option opts [Ordering] :order The sorting order of the returned items
610
610
  # @return [Array<(ListResponseEndpointOut, Integer, Hash)>] ListResponseEndpointOut data, response status code and response headers
611
611
  def v1_endpoint_list_with_http_info(app_id, opts = {})
612
612
  if @api_client.config.debugging
@@ -1,9 +1,9 @@
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
5
 
6
- The version of the OpenAPI document: 1.7.0
6
+ The version of the OpenAPI document: 1.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -1,9 +1,9 @@
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
5
 
6
- The version of the OpenAPI document: 1.7.0
6
+ The version of the OpenAPI document: 1.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -1,9 +1,9 @@
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
5
 
6
- The version of the OpenAPI document: 1.7.0
6
+ The version of the OpenAPI document: 1.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -91,7 +91,7 @@ module Svix
91
91
  # 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).
92
92
  # @param event_type_name [String] The event type&#39;s name
93
93
  # @param [Hash] opts the optional parameters
94
- # @option opts [Boolean] :expunge (default to false)
94
+ # @option opts [Boolean] :expunge By default event types are archived when \&quot;deleted\&quot;. Passing this to &#x60;true&#x60; deletes them entirely. (default to false)
95
95
  # @return [nil]
96
96
  def v1_event_type_delete(event_type_name, opts = {})
97
97
  v1_event_type_delete_with_http_info(event_type_name, opts)
@@ -102,7 +102,7 @@ module Svix
102
102
  # 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).
103
103
  # @param event_type_name [String] The event type&#39;s name
104
104
  # @param [Hash] opts the optional parameters
105
- # @option opts [Boolean] :expunge
105
+ # @option opts [Boolean] :expunge By default event types are archived when \&quot;deleted\&quot;. Passing this to &#x60;true&#x60; deletes them entirely.
106
106
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
107
107
  def v1_event_type_delete_with_http_info(event_type_name, opts = {})
108
108
  if @api_client.config.debugging
@@ -302,14 +302,82 @@ module Svix
302
302
  return data, status_code, headers
303
303
  end
304
304
 
305
+ # Event Type Import From Openapi
306
+ # Given an OpenAPI spec, create new or update existing event types. If an existing `archived` event type is updated, it will be unarchvied. The importer will convert all webhooks found in the either the `webhooks` or `x-webhooks` top-level.
307
+ # @param event_type_import_open_api_in [EventTypeImportOpenApiIn]
308
+ # @param [Hash] opts the optional parameters
309
+ # @option opts [String] :idempotency_key The request&#39;s idempotency key
310
+ # @return [EventTypeImportOpenApiOut]
311
+ def v1_event_type_import_openapi(event_type_import_open_api_in, opts = {})
312
+ data, _status_code, _headers = v1_event_type_import_openapi_with_http_info(event_type_import_open_api_in, opts)
313
+ data
314
+ end
315
+
316
+ # Event Type Import From Openapi
317
+ # Given an OpenAPI spec, create new or update existing event types. If an existing &#x60;archived&#x60; event type is updated, it will be unarchvied. The importer will convert all webhooks found in the either the &#x60;webhooks&#x60; or &#x60;x-webhooks&#x60; top-level.
318
+ # @param event_type_import_open_api_in [EventTypeImportOpenApiIn]
319
+ # @param [Hash] opts the optional parameters
320
+ # @option opts [String] :idempotency_key The request&#39;s idempotency key
321
+ # @return [Array<(EventTypeImportOpenApiOut, Integer, Hash)>] EventTypeImportOpenApiOut data, response status code and response headers
322
+ def v1_event_type_import_openapi_with_http_info(event_type_import_open_api_in, opts = {})
323
+ if @api_client.config.debugging
324
+ @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_import_openapi ...'
325
+ end
326
+ # verify the required parameter 'event_type_import_open_api_in' is set
327
+ if @api_client.config.client_side_validation && event_type_import_open_api_in.nil?
328
+ fail ArgumentError, "Missing the required parameter 'event_type_import_open_api_in' when calling EventTypeApi.v1_event_type_import_openapi"
329
+ end
330
+ # resource path
331
+ local_var_path = '/api/v1/event-type/import/openapi/'
332
+
333
+ # query parameters
334
+ query_params = opts[:query_params] || {}
335
+
336
+ # header parameters
337
+ header_params = opts[:header_params] || {}
338
+ # HTTP header 'Accept' (if needed)
339
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
340
+ # HTTP header 'Content-Type'
341
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
342
+ header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
343
+
344
+ # form parameters
345
+ form_params = opts[:form_params] || {}
346
+
347
+ # http body (model)
348
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(event_type_import_open_api_in)
349
+
350
+ # return_type
351
+ return_type = opts[:debug_return_type] || 'EventTypeImportOpenApiOut'
352
+
353
+ # auth_names
354
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
355
+
356
+ new_options = opts.merge(
357
+ :operation => :"EventTypeApi.v1_event_type_import_openapi",
358
+ :header_params => header_params,
359
+ :query_params => query_params,
360
+ :form_params => form_params,
361
+ :body => post_body,
362
+ :auth_names => auth_names,
363
+ :return_type => return_type
364
+ )
365
+
366
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
367
+ if @api_client.config.debugging
368
+ @api_client.config.logger.debug "API called: EventTypeApi#v1_event_type_import_openapi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
369
+ end
370
+ return data, status_code, headers
371
+ end
372
+
305
373
  # List Event Types
306
374
  # Return the list of event types.
307
375
  # @param [Hash] opts the optional parameters
308
- # @option opts [Integer] :limit
309
- # @option opts [String] :iterator The event type&#39;s name
310
- # @option opts [Ordering] :order
311
- # @option opts [Boolean] :include_archived (default to false)
312
- # @option opts [Boolean] :with_content (default to false)
376
+ # @option opts [Integer] :limit Limit the number of returned items
377
+ # @option opts [String] :iterator The iterator returned from a prior invocation
378
+ # @option opts [Ordering] :order The sorting order of the returned items
379
+ # @option opts [Boolean] :include_archived When &#x60;true&#x60; archived (deleted but not expunged) items are included in the response (default to false)
380
+ # @option opts [Boolean] :with_content When &#x60;true&#x60; the full item (including the schema) is included in the response (default to false)
313
381
  # @return [ListResponseEventTypeOut]
314
382
  def v1_event_type_list(opts = {})
315
383
  data, _status_code, _headers = v1_event_type_list_with_http_info(opts)
@@ -319,11 +387,11 @@ module Svix
319
387
  # List Event Types
320
388
  # Return the list of event types.
321
389
  # @param [Hash] opts the optional parameters
322
- # @option opts [Integer] :limit
323
- # @option opts [String] :iterator The event type&#39;s name
324
- # @option opts [Ordering] :order
325
- # @option opts [Boolean] :include_archived
326
- # @option opts [Boolean] :with_content
390
+ # @option opts [Integer] :limit Limit the number of returned items
391
+ # @option opts [String] :iterator The iterator returned from a prior invocation
392
+ # @option opts [Ordering] :order The sorting order of the returned items
393
+ # @option opts [Boolean] :include_archived When &#x60;true&#x60; archived (deleted but not expunged) items are included in the response
394
+ # @option opts [Boolean] :with_content When &#x60;true&#x60; the full item (including the schema) is included in the response
327
395
  # @return [Array<(ListResponseEventTypeOut, Integer, Hash)>] ListResponseEventTypeOut data, response status code and response headers
328
396
  def v1_event_type_list_with_http_info(opts = {})
329
397
  if @api_client.config.debugging
@@ -1,9 +1,9 @@
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
5
 
6
- The version of the OpenAPI document: 1.7.0
6
+ The version of the OpenAPI document: 1.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -1,9 +1,9 @@
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
5
 
6
- The version of the OpenAPI document: 1.7.0
6
+ The version of the OpenAPI document: 1.1.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -356,8 +356,8 @@ module Svix
356
356
  # List the application's integrations.
357
357
  # @param app_id [String] The app&#39;s ID or UID
358
358
  # @param [Hash] opts the optional parameters
359
- # @option opts [Integer] :limit
360
- # @option opts [String] :iterator The integ&#39;s ID
359
+ # @option opts [Integer] :limit Limit the number of returned items
360
+ # @option opts [String] :iterator The iterator returned from a prior invocation
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)
@@ -368,8 +368,8 @@ module Svix
368
368
  # List the application&#39;s integrations.
369
369
  # @param app_id [String] The app&#39;s ID or UID
370
370
  # @param [Hash] opts the optional parameters
371
- # @option opts [Integer] :limit
372
- # @option opts [String] :iterator The integ&#39;s ID
371
+ # @option opts [Integer] :limit Limit the number of returned items
372
+ # @option opts [String] :iterator The iterator returned from a prior invocation
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