svix 1.44.0 → 1.45.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/lib/svix/api/application_api.rb +14 -14
  4. data/lib/svix/api/authentication_api.rb +208 -4
  5. data/lib/svix/api/background_tasks_api.rb +4 -4
  6. data/lib/svix/api/broadcast_api.rb +2 -2
  7. data/lib/svix/api/endpoint_api.rb +43 -43
  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 +12 -12
  11. data/lib/svix/api/events_api.rb +4 -4
  12. data/lib/svix/api/inbound_api.rb +2 -2
  13. data/lib/svix/api/message_api.rb +57 -31
  14. data/lib/svix/api/message_attempt_api.rb +6 -6
  15. data/lib/svix/api/statistics_api.rb +10 -10
  16. data/lib/svix/api/transformation_template_api.rb +22 -22
  17. data/lib/svix/endpoint_api.rb +1 -1
  18. data/lib/svix/message_api.rb +1 -1
  19. data/lib/svix/models/application_in.rb +1 -1
  20. data/lib/svix/models/endpoint_in.rb +2 -2
  21. data/lib/svix/models/endpoint_oauth_config_in.rb +1 -1
  22. data/lib/svix/models/endpoint_out.rb +3 -3
  23. data/lib/svix/models/endpoint_update.rb +2 -2
  24. data/lib/svix/models/environment_settings_out.rb +12 -1
  25. data/lib/svix/models/message_broadcast_in.rb +2 -2
  26. data/lib/svix/models/message_endpoint_out.rb +3 -3
  27. data/lib/svix/models/message_in.rb +0 -9
  28. data/lib/svix/models/operational_webhook_endpoint_in.rb +1 -1
  29. data/lib/svix/models/operational_webhook_endpoint_out.rb +2 -2
  30. data/lib/svix/models/operational_webhook_endpoint_update.rb +1 -1
  31. data/lib/svix/models/rotate_poller_token_in.rb +280 -0
  32. data/lib/svix/models/transformation_http_method.rb +2 -1
  33. data/lib/svix/version.rb +1 -1
  34. metadata +3 -2
@@ -20,7 +20,7 @@ module Svix
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create Endpoint
23
- # Create a new endpoint for the application. When `secret` is `null` the secret is automatically generated (recommended)
23
+ # Create a new endpoint for the application. When `secret` is `null` the secret is automatically generated (recommended).
24
24
  # @param app_id [String] The app's ID or UID
25
25
  # @param endpoint_in [EndpointIn]
26
26
  # @param [Hash] opts the optional parameters
@@ -32,7 +32,7 @@ module Svix
32
32
  end
33
33
 
34
34
  # Create Endpoint
35
- # Create a new endpoint for the application. When `secret` is `null` the secret is automatically generated (recommended)
35
+ # Create a new endpoint for the application. When `secret` is `null` the secret is automatically generated (recommended).
36
36
  # @param app_id [String] The app's ID or UID
37
37
  # @param endpoint_in [EndpointIn]
38
38
  # @param [Hash] opts the optional parameters
@@ -205,7 +205,7 @@ module Svix
205
205
  end
206
206
 
207
207
  # Delete Endpoint Mtls Config
208
- # Delete endpoint mTLS configuration
208
+ # Delete endpoint mTLS configuration.
209
209
  # @param app_id [String] The app's ID or UID
210
210
  # @param endpoint_id [String] The ep's ID or UID
211
211
  # @param [Hash] opts the optional parameters
@@ -216,7 +216,7 @@ module Svix
216
216
  end
217
217
 
218
218
  # Delete Endpoint Mtls Config
219
- # Delete endpoint mTLS configuration
219
+ # Delete endpoint mTLS configuration.
220
220
  # @param app_id [String] The app's ID or UID
221
221
  # @param endpoint_id [String] The ep's ID or UID
222
222
  # @param [Hash] opts the optional parameters
@@ -300,7 +300,7 @@ module Svix
300
300
  end
301
301
 
302
302
  # Delete Endpoint Oauth Config
303
- # Delete endpoint OAuth configuration
303
+ # Delete endpoint OAuth configuration.
304
304
  # @param app_id [String] The app's ID or UID
305
305
  # @param endpoint_id [String] The ep's ID or UID
306
306
  # @param [Hash] opts the optional parameters
@@ -311,7 +311,7 @@ module Svix
311
311
  end
312
312
 
313
313
  # Delete Endpoint Oauth Config
314
- # Delete endpoint OAuth configuration
314
+ # Delete endpoint OAuth configuration.
315
315
  # @param app_id [String] The app's ID or UID
316
316
  # @param endpoint_id [String] The ep's ID or UID
317
317
  # @param [Hash] opts the optional parameters
@@ -490,7 +490,7 @@ module Svix
490
490
  end
491
491
 
492
492
  # Get Endpoint Headers
493
- # Get the additional headers to be sent with the webhook
493
+ # Get the additional headers to be sent with the webhook.
494
494
  # @param app_id [String] The app's ID or UID
495
495
  # @param endpoint_id [String] The ep's ID or UID
496
496
  # @param [Hash] opts the optional parameters
@@ -501,7 +501,7 @@ module Svix
501
501
  end
502
502
 
503
503
  # Get Endpoint Headers
504
- # Get the additional headers to be sent with the webhook
504
+ # Get the additional headers to be sent with the webhook.
505
505
  # @param app_id [String] The app's ID or UID
506
506
  # @param endpoint_id [String] The ep's ID or UID
507
507
  # @param [Hash] opts the optional parameters
@@ -684,8 +684,8 @@ module Svix
684
684
  # @param app_id [String] The app's ID or UID
685
685
  # @param endpoint_id [String] The ep's ID or UID
686
686
  # @param [Hash] opts the optional parameters
687
- # @option opts [Time] :since Filter the range to data starting from this date
688
- # @option opts [Time] :_until Filter the range to data ending by this date
687
+ # @option opts [Time] :since Filter the range to data starting from this date.
688
+ # @option opts [Time] :_until Filter the range to data ending by this date.
689
689
  # @return [EndpointStats]
690
690
  def v1_endpoint_get_stats(app_id, endpoint_id, opts = {})
691
691
  data, _status_code, _headers = v1_endpoint_get_stats_with_http_info(app_id, endpoint_id, opts)
@@ -697,8 +697,8 @@ module Svix
697
697
  # @param app_id [String] The app's ID or UID
698
698
  # @param endpoint_id [String] The ep's ID or UID
699
699
  # @param [Hash] opts the optional parameters
700
- # @option opts [Time] :since Filter the range to data starting from this date
701
- # @option opts [Time] :_until Filter the range to data ending by this date
700
+ # @option opts [Time] :since Filter the range to data starting from this date.
701
+ # @option opts [Time] :_until Filter the range to data ending by this date.
702
702
  # @return [Array<(EndpointStats, Integer, Hash)>] EndpointStats data, response status code and response headers
703
703
  def v1_endpoint_get_stats_with_http_info(app_id, endpoint_id, opts = {})
704
704
  if @api_client.config.debugging
@@ -980,7 +980,7 @@ module Svix
980
980
  end
981
981
 
982
982
  # Patch Endpoint Headers
983
- # Partially set the additional headers to be sent with the webhook
983
+ # Partially set the additional headers to be sent with the webhook.
984
984
  # @param app_id [String] The app&#39;s ID or UID
985
985
  # @param endpoint_id [String] The ep&#39;s ID or UID
986
986
  # @param endpoint_headers_patch_in [EndpointHeadersPatchIn]
@@ -992,7 +992,7 @@ module Svix
992
992
  end
993
993
 
994
994
  # Patch Endpoint Headers
995
- # Partially set the additional headers to be sent with the webhook
995
+ # Partially set the additional headers to be sent with the webhook.
996
996
  # @param app_id [String] The app&#39;s ID or UID
997
997
  # @param endpoint_id [String] The ep&#39;s ID or UID
998
998
  # @param endpoint_headers_patch_in [EndpointHeadersPatchIn]
@@ -1202,8 +1202,8 @@ module Svix
1202
1202
  # @param [Hash] opts the optional parameters
1203
1203
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
1204
1204
  # @return [ReplayOut]
1205
- def v1_endpoint_replay(app_id, endpoint_id, replay_in, opts = {})
1206
- data, _status_code, _headers = v1_endpoint_replay_with_http_info(app_id, endpoint_id, replay_in, opts)
1205
+ def v1_endpoint_replay_missing(app_id, endpoint_id, replay_in, opts = {})
1206
+ data, _status_code, _headers = v1_endpoint_replay_missing_with_http_info(app_id, endpoint_id, replay_in, opts)
1207
1207
  data
1208
1208
  end
1209
1209
 
@@ -1215,47 +1215,47 @@ module Svix
1215
1215
  # @param [Hash] opts the optional parameters
1216
1216
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
1217
1217
  # @return [Array<(ReplayOut, Integer, Hash)>] ReplayOut data, response status code and response headers
1218
- def v1_endpoint_replay_with_http_info(app_id, endpoint_id, replay_in, opts = {})
1218
+ def v1_endpoint_replay_missing_with_http_info(app_id, endpoint_id, replay_in, opts = {})
1219
1219
  if @api_client.config.debugging
1220
- @api_client.config.logger.debug 'Calling API: EndpointApi.v1_endpoint_replay ...'
1220
+ @api_client.config.logger.debug 'Calling API: EndpointApi.v1_endpoint_replay_missing ...'
1221
1221
  end
1222
1222
  # verify the required parameter 'app_id' is set
1223
1223
  if @api_client.config.client_side_validation && app_id.nil?
1224
- fail ArgumentError, "Missing the required parameter 'app_id' when calling EndpointApi.v1_endpoint_replay"
1224
+ fail ArgumentError, "Missing the required parameter 'app_id' when calling EndpointApi.v1_endpoint_replay_missing"
1225
1225
  end
1226
1226
  if @api_client.config.client_side_validation && app_id.to_s.length > 256
1227
- fail ArgumentError, 'invalid value for "app_id" when calling EndpointApi.v1_endpoint_replay, the character length must be smaller than or equal to 256.'
1227
+ fail ArgumentError, 'invalid value for "app_id" when calling EndpointApi.v1_endpoint_replay_missing, the character length must be smaller than or equal to 256.'
1228
1228
  end
1229
1229
 
1230
1230
  if @api_client.config.client_side_validation && app_id.to_s.length < 1
1231
- fail ArgumentError, 'invalid value for "app_id" when calling EndpointApi.v1_endpoint_replay, the character length must be great than or equal to 1.'
1231
+ fail ArgumentError, 'invalid value for "app_id" when calling EndpointApi.v1_endpoint_replay_missing, the character length must be great than or equal to 1.'
1232
1232
  end
1233
1233
 
1234
1234
  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
1235
1235
  if @api_client.config.client_side_validation && app_id !~ pattern
1236
- fail ArgumentError, "invalid value for 'app_id' when calling EndpointApi.v1_endpoint_replay, must conform to the pattern #{pattern}."
1236
+ fail ArgumentError, "invalid value for 'app_id' when calling EndpointApi.v1_endpoint_replay_missing, must conform to the pattern #{pattern}."
1237
1237
  end
1238
1238
 
1239
1239
  # verify the required parameter 'endpoint_id' is set
1240
1240
  if @api_client.config.client_side_validation && endpoint_id.nil?
1241
- fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling EndpointApi.v1_endpoint_replay"
1241
+ fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling EndpointApi.v1_endpoint_replay_missing"
1242
1242
  end
1243
1243
  if @api_client.config.client_side_validation && endpoint_id.to_s.length > 256
1244
- fail ArgumentError, 'invalid value for "endpoint_id" when calling EndpointApi.v1_endpoint_replay, the character length must be smaller than or equal to 256.'
1244
+ fail ArgumentError, 'invalid value for "endpoint_id" when calling EndpointApi.v1_endpoint_replay_missing, the character length must be smaller than or equal to 256.'
1245
1245
  end
1246
1246
 
1247
1247
  if @api_client.config.client_side_validation && endpoint_id.to_s.length < 1
1248
- fail ArgumentError, 'invalid value for "endpoint_id" when calling EndpointApi.v1_endpoint_replay, the character length must be great than or equal to 1.'
1248
+ fail ArgumentError, 'invalid value for "endpoint_id" when calling EndpointApi.v1_endpoint_replay_missing, the character length must be great than or equal to 1.'
1249
1249
  end
1250
1250
 
1251
1251
  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
1252
1252
  if @api_client.config.client_side_validation && endpoint_id !~ pattern
1253
- fail ArgumentError, "invalid value for 'endpoint_id' when calling EndpointApi.v1_endpoint_replay, must conform to the pattern #{pattern}."
1253
+ fail ArgumentError, "invalid value for 'endpoint_id' when calling EndpointApi.v1_endpoint_replay_missing, must conform to the pattern #{pattern}."
1254
1254
  end
1255
1255
 
1256
1256
  # verify the required parameter 'replay_in' is set
1257
1257
  if @api_client.config.client_side_validation && replay_in.nil?
1258
- fail ArgumentError, "Missing the required parameter 'replay_in' when calling EndpointApi.v1_endpoint_replay"
1258
+ fail ArgumentError, "Missing the required parameter 'replay_in' when calling EndpointApi.v1_endpoint_replay_missing"
1259
1259
  end
1260
1260
  # resource path
1261
1261
  local_var_path = '/api/v1/app/{app_id}/endpoint/{endpoint_id}/replay-missing'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'endpoint_id' + '}', CGI.escape(endpoint_id.to_s))
@@ -1287,7 +1287,7 @@ module Svix
1287
1287
  auth_names = opts[:debug_auth_names] || ['HTTPBearer']
1288
1288
 
1289
1289
  new_options = opts.merge(
1290
- :operation => :"EndpointApi.v1_endpoint_replay",
1290
+ :operation => :"EndpointApi.v1_endpoint_replay_missing",
1291
1291
  :header_params => header_params,
1292
1292
  :query_params => query_params,
1293
1293
  :form_params => form_params,
@@ -1298,7 +1298,7 @@ module Svix
1298
1298
 
1299
1299
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1300
1300
  if @api_client.config.debugging
1301
- @api_client.config.logger.debug "API called: EndpointApi#v1_endpoint_replay\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1301
+ @api_client.config.logger.debug "API called: EndpointApi#v1_endpoint_replay_missing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1302
1302
  end
1303
1303
  return data, status_code, headers
1304
1304
  end
@@ -1413,7 +1413,7 @@ module Svix
1413
1413
  end
1414
1414
 
1415
1415
  # Send Event Type Example Message
1416
- # Send an example message for an event
1416
+ # Send an example message for an event.
1417
1417
  # @param app_id [String] The app&#39;s ID or UID
1418
1418
  # @param endpoint_id [String] The ep&#39;s ID or UID
1419
1419
  # @param event_example_in [EventExampleIn]
@@ -1426,7 +1426,7 @@ module Svix
1426
1426
  end
1427
1427
 
1428
1428
  # Send Event Type Example Message
1429
- # Send an example message for an event
1429
+ # Send an example message for an event.
1430
1430
  # @param app_id [String] The app&#39;s ID or UID
1431
1431
  # @param endpoint_id [String] The ep&#39;s ID or UID
1432
1432
  # @param event_example_in [EventExampleIn]
@@ -1522,7 +1522,7 @@ module Svix
1522
1522
  end
1523
1523
 
1524
1524
  # Get Endpoint Transformation
1525
- # Get the transformation code associated with this endpoint
1525
+ # Get the transformation code associated with this endpoint.
1526
1526
  # @param app_id [String] The app&#39;s ID or UID
1527
1527
  # @param endpoint_id [String] The ep&#39;s ID or UID
1528
1528
  # @param [Hash] opts the optional parameters
@@ -1533,7 +1533,7 @@ module Svix
1533
1533
  end
1534
1534
 
1535
1535
  # Get Endpoint Transformation
1536
- # Get the transformation code associated with this endpoint
1536
+ # Get the transformation code associated with this endpoint.
1537
1537
  # @param app_id [String] The app&#39;s ID or UID
1538
1538
  # @param endpoint_id [String] The ep&#39;s ID or UID
1539
1539
  # @param [Hash] opts the optional parameters
@@ -1617,7 +1617,7 @@ module Svix
1617
1617
  end
1618
1618
 
1619
1619
  # Set Endpoint Transformation
1620
- # Set or unset the transformation code associated with this endpoint
1620
+ # Set or unset the transformation code associated with this endpoint.
1621
1621
  # @param app_id [String] The app&#39;s ID or UID
1622
1622
  # @param endpoint_id [String] The ep&#39;s ID or UID
1623
1623
  # @param endpoint_transformation_in [EndpointTransformationIn]
@@ -1629,7 +1629,7 @@ module Svix
1629
1629
  end
1630
1630
 
1631
1631
  # Set Endpoint Transformation
1632
- # Set or unset the transformation code associated with this endpoint
1632
+ # Set or unset the transformation code associated with this endpoint.
1633
1633
  # @param app_id [String] The app&#39;s ID or UID
1634
1634
  # @param endpoint_id [String] The ep&#39;s ID or UID
1635
1635
  # @param endpoint_transformation_in [EndpointTransformationIn]
@@ -1723,7 +1723,7 @@ module Svix
1723
1723
  end
1724
1724
 
1725
1725
  # Simulate
1726
- # Simulate running the transformation on the payload and code
1726
+ # Simulate running the transformation on the payload and code.
1727
1727
  # @param app_id [String] The app&#39;s ID or UID
1728
1728
  # @param endpoint_id [String] The ep&#39;s ID or UID
1729
1729
  # @param endpoint_transformation_simulate_in [EndpointTransformationSimulateIn]
@@ -1736,7 +1736,7 @@ module Svix
1736
1736
  end
1737
1737
 
1738
1738
  # Simulate
1739
- # Simulate running the transformation on the payload and code
1739
+ # Simulate running the transformation on the payload and code.
1740
1740
  # @param app_id [String] The app&#39;s ID or UID
1741
1741
  # @param endpoint_id [String] The ep&#39;s ID or UID
1742
1742
  # @param endpoint_transformation_simulate_in [EndpointTransformationSimulateIn]
@@ -1938,7 +1938,7 @@ module Svix
1938
1938
  end
1939
1939
 
1940
1940
  # Update Endpoint Headers
1941
- # Set the additional headers to be sent with the webhook
1941
+ # Set the additional headers to be sent with the webhook.
1942
1942
  # @param app_id [String] The app&#39;s ID or UID
1943
1943
  # @param endpoint_id [String] The ep&#39;s ID or UID
1944
1944
  # @param endpoint_headers_in [EndpointHeadersIn]
@@ -1950,7 +1950,7 @@ module Svix
1950
1950
  end
1951
1951
 
1952
1952
  # Update Endpoint Headers
1953
- # Set the additional headers to be sent with the webhook
1953
+ # Set the additional headers to be sent with the webhook.
1954
1954
  # @param app_id [String] The app&#39;s ID or UID
1955
1955
  # @param endpoint_id [String] The ep&#39;s ID or UID
1956
1956
  # @param endpoint_headers_in [EndpointHeadersIn]
@@ -2044,7 +2044,7 @@ module Svix
2044
2044
  end
2045
2045
 
2046
2046
  # Update Endpoint Mtls Config
2047
- # Create/update endpoint mTLS configuration
2047
+ # Create/update endpoint mTLS configuration.
2048
2048
  # @param app_id [String] The app&#39;s ID or UID
2049
2049
  # @param endpoint_id [String] The ep&#39;s ID or UID
2050
2050
  # @param endpoint_mtls_config_in [EndpointMtlsConfigIn]
@@ -2056,7 +2056,7 @@ module Svix
2056
2056
  end
2057
2057
 
2058
2058
  # Update Endpoint Mtls Config
2059
- # Create/update endpoint mTLS configuration
2059
+ # Create/update endpoint mTLS configuration.
2060
2060
  # @param app_id [String] The app&#39;s ID or UID
2061
2061
  # @param endpoint_id [String] The ep&#39;s ID or UID
2062
2062
  # @param endpoint_mtls_config_in [EndpointMtlsConfigIn]
@@ -2150,7 +2150,7 @@ module Svix
2150
2150
  end
2151
2151
 
2152
2152
  # Update Endpoint Oauth Config
2153
- # Create/update endpoint OAuth configuration
2153
+ # Create/update endpoint OAuth configuration.
2154
2154
  # @param app_id [String] The app&#39;s ID or UID
2155
2155
  # @param endpoint_id [String] The ep&#39;s ID or UID
2156
2156
  # @param endpoint_oauth_config_in [EndpointOauthConfigIn]
@@ -2162,7 +2162,7 @@ module Svix
2162
2162
  end
2163
2163
 
2164
2164
  # Update Endpoint Oauth Config
2165
- # Create/update endpoint OAuth configuration
2165
+ # Create/update endpoint OAuth configuration.
2166
2166
  # @param app_id [String] The app&#39;s ID or UID
2167
2167
  # @param endpoint_id [String] The ep&#39;s ID or UID
2168
2168
  # @param endpoint_oauth_config_in [EndpointOauthConfigIn]
@@ -20,7 +20,7 @@ module Svix
20
20
  @api_client = api_client
21
21
  end
22
22
  # Export Environment Configuration
23
- # Download a JSON file containing all org-settings and event types
23
+ # Download a JSON file containing all org-settings and event types.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
26
26
  # @return [EnvironmentOut]
@@ -30,7 +30,7 @@ module Svix
30
30
  end
31
31
 
32
32
  # Export Environment Configuration
33
- # Download a JSON file containing all org-settings and event types
33
+ # Download a JSON file containing all org-settings and event types.
34
34
  # @param [Hash] opts the optional parameters
35
35
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
36
36
  # @return [Array<(EnvironmentOut, Integer, Hash)>] EnvironmentOut data, response status code and response headers
@@ -20,7 +20,7 @@ module Svix
20
20
  @api_client = api_client
21
21
  end
22
22
  # Get Org Settings
23
- # Get the environment's settings
23
+ # Get the environment's settings.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [EnvironmentSettingsOut]
26
26
  def v1_environment_get_settings(opts = {})
@@ -29,7 +29,7 @@ module Svix
29
29
  end
30
30
 
31
31
  # Get Org Settings
32
- # Get the environment&#39;s settings
32
+ # Get the environment&#39;s settings.
33
33
  # @param [Hash] opts the optional parameters
34
34
  # @return [Array<(EnvironmentSettingsOut, Integer, Hash)>] EnvironmentSettingsOut data, response status code and response headers
35
35
  def v1_environment_get_settings_with_http_info(opts = {})
@@ -166,7 +166,7 @@ module Svix
166
166
  end
167
167
 
168
168
  # Event Type Export From Openapi
169
- # Exports event type definitions based on the OpenAPI schemas associated with each existing event type
169
+ # Exports event type definitions based on the OpenAPI schemas associated with each existing event type.
170
170
  # @param [Hash] opts the optional parameters
171
171
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
172
172
  # @return [ExportEventTypeOut]
@@ -176,7 +176,7 @@ module Svix
176
176
  end
177
177
 
178
178
  # Event Type Export From Openapi
179
- # Exports event type definitions based on the OpenAPI schemas associated with each existing event type
179
+ # Exports event type definitions based on the OpenAPI schemas associated with each existing event type.
180
180
  # @param [Hash] opts the optional parameters
181
181
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
182
182
  # @return [Array<(ExportEventTypeOut, Integer, Hash)>] ExportEventTypeOut data, response status code and response headers
@@ -226,7 +226,7 @@ module Svix
226
226
  end
227
227
 
228
228
  # Generate Schema Example
229
- # Generates a fake example from the given JSONSchema
229
+ # Generates a fake example from the given JSONSchema.
230
230
  # @param event_type_schema_in [EventTypeSchemaIn]
231
231
  # @param [Hash] opts the optional parameters
232
232
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -237,7 +237,7 @@ module Svix
237
237
  end
238
238
 
239
239
  # Generate Schema Example
240
- # Generates a fake example from the given JSONSchema
240
+ # Generates a fake example from the given JSONSchema.
241
241
  # @param event_type_schema_in [EventTypeSchemaIn]
242
242
  # @param [Hash] opts the optional parameters
243
243
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -369,7 +369,7 @@ module Svix
369
369
  end
370
370
 
371
371
  # Get Retry Schedule
372
- # Gets the retry schedule for messages using the given event type
372
+ # Gets the retry schedule for messages using the given event type.
373
373
  # @param event_type_name [String] The event type&#39;s name
374
374
  # @param [Hash] opts the optional parameters
375
375
  # @return [RetryScheduleInOut]
@@ -379,7 +379,7 @@ module Svix
379
379
  end
380
380
 
381
381
  # Get Retry Schedule
382
- # Gets the retry schedule for messages using the given event type
382
+ # Gets the retry schedule for messages using the given event type.
383
383
  # @param event_type_name [String] The event type&#39;s name
384
384
  # @param [Hash] opts the optional parameters
385
385
  # @return [Array<(RetryScheduleInOut, Integer, Hash)>] RetryScheduleInOut data, response status code and response headers
@@ -517,8 +517,8 @@ module Svix
517
517
  # @option opts [Integer] :limit Limit the number of returned items
518
518
  # @option opts [String] :iterator The iterator returned from a prior invocation
519
519
  # @option opts [Ordering] :order The sorting order of the returned items
520
- # @option opts [Boolean] :include_archived When &#x60;true&#x60; archived (deleted but not expunged) items are included in the response (default to false)
521
- # @option opts [Boolean] :with_content When &#x60;true&#x60; the full item (including the schema) is included in the response (default to false)
520
+ # @option opts [Boolean] :include_archived When &#x60;true&#x60; archived (deleted but not expunged) items are included in the response. (default to false)
521
+ # @option opts [Boolean] :with_content When &#x60;true&#x60; the full item (including the schema) is included in the response. (default to false)
522
522
  # @return [ListResponseEventTypeOut]
523
523
  def v1_event_type_list(opts = {})
524
524
  data, _status_code, _headers = v1_event_type_list_with_http_info(opts)
@@ -531,8 +531,8 @@ module Svix
531
531
  # @option opts [Integer] :limit Limit the number of returned items
532
532
  # @option opts [String] :iterator The iterator returned from a prior invocation
533
533
  # @option opts [Ordering] :order The sorting order of the returned items
534
- # @option opts [Boolean] :include_archived When &#x60;true&#x60; archived (deleted but not expunged) items are included in the response (default to false)
535
- # @option opts [Boolean] :with_content When &#x60;true&#x60; the full item (including the schema) is included in the response (default to false)
534
+ # @option opts [Boolean] :include_archived When &#x60;true&#x60; archived (deleted but not expunged) items are included in the response. (default to false)
535
+ # @option opts [Boolean] :with_content When &#x60;true&#x60; the full item (including the schema) is included in the response. (default to false)
536
536
  # @return [Array<(ListResponseEventTypeOut, Integer, Hash)>] ListResponseEventTypeOut data, response status code and response headers
537
537
  def v1_event_type_list_with_http_info(opts = {})
538
538
  if @api_client.config.debugging
@@ -767,7 +767,7 @@ module Svix
767
767
  end
768
768
 
769
769
  # Update Retry Schedule
770
- # Sets a retry schedule for all messages using the given event type
770
+ # Sets a retry schedule for all messages using the given event type.
771
771
  # @param event_type_name [String] The event type&#39;s name
772
772
  # @param retry_schedule_in_out [RetryScheduleInOut]
773
773
  # @param [Hash] opts the optional parameters
@@ -778,7 +778,7 @@ module Svix
778
778
  end
779
779
 
780
780
  # Update Retry Schedule
781
- # Sets a retry schedule for all messages using the given event type
781
+ # Sets a retry schedule for all messages using the given event type.
782
782
  # @param event_type_name [String] The event type&#39;s name
783
783
  # @param retry_schedule_in_out [RetryScheduleInOut]
784
784
  # @param [Hash] opts the optional parameters
@@ -20,12 +20,12 @@ module Svix
20
20
  @api_client = api_client
21
21
  end
22
22
  # Events
23
- # Reads the stream of operational webhook events for this environment
23
+ # Reads the stream of operational webhook events for this environment.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [Integer] :limit Limit the number of returned items
26
26
  # @option opts [String] :iterator The iterator returned from a prior invocation
27
27
  # @option opts [Array<String>] :event_types Filter response based on the event type
28
- # @option opts [Array<String>] :channels Filter response based on the event type
28
+ # @option opts [Array<String>] :channels Filter response based on the event type.
29
29
  # @option opts [Time] :after
30
30
  # @return [MessageEventsOut]
31
31
  def v1_events(opts = {})
@@ -34,12 +34,12 @@ module Svix
34
34
  end
35
35
 
36
36
  # Events
37
- # Reads the stream of operational webhook events for this environment
37
+ # Reads the stream of operational webhook events for this environment.
38
38
  # @param [Hash] opts the optional parameters
39
39
  # @option opts [Integer] :limit Limit the number of returned items
40
40
  # @option opts [String] :iterator The iterator returned from a prior invocation
41
41
  # @option opts [Array<String>] :event_types Filter response based on the event type
42
- # @option opts [Array<String>] :channels Filter response based on the event type
42
+ # @option opts [Array<String>] :channels Filter response based on the event type.
43
43
  # @option opts [Time] :after
44
44
  # @return [Array<(MessageEventsOut, Integer, Hash)>] MessageEventsOut data, response status code and response headers
45
45
  def v1_events_with_http_info(opts = {})
@@ -128,7 +128,7 @@ module Svix
128
128
  end
129
129
 
130
130
  # Rotate Url
131
- # Invalidates the previous inbound url (if one exists), producing a new inbound URL for this app
131
+ # Invalidates the previous inbound url (if one exists), producing a new inbound URL for this app.
132
132
  # @param app_id [String] The app&#39;s ID or UID
133
133
  # @param [Hash] opts the optional parameters
134
134
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -139,7 +139,7 @@ module Svix
139
139
  end
140
140
 
141
141
  # Rotate Url
142
- # Invalidates the previous inbound url (if one exists), producing a new inbound URL for this app
142
+ # Invalidates the previous inbound url (if one exists), producing a new inbound URL for this app.
143
143
  # @param app_id [String] The app&#39;s ID or UID
144
144
  # @param [Hash] opts the optional parameters
145
145
  # @option opts [String] :idempotency_key The request&#39;s idempotency key