svix 1.56.0 → 1.57.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/lib/svix/api/application_api.rb +115 -10
  4. data/lib/svix/api/authentication_api.rb +101 -16
  5. data/lib/svix/api/background_tasks_api.rb +43 -17
  6. data/lib/svix/api/endpoint_api.rb +312 -96
  7. data/lib/svix/api/inbound_api.rb +4 -4
  8. data/lib/svix/api/integration_api.rb +102 -24
  9. data/lib/svix/api/message_api.rb +142 -39
  10. data/lib/svix/api/message_attempt_api.rb +135 -372
  11. data/lib/svix/api/statistics_api.rb +6 -6
  12. data/lib/svix/api/stream_api.rb +203 -142
  13. data/lib/svix/api/transformation_template_api.rb +88 -23
  14. data/lib/svix/api/webhook_endpoint_api.rb +253 -77
  15. data/lib/svix/background_tasks_api.rb +2 -2
  16. data/lib/svix/message_attempt_api.rb +7 -3
  17. data/lib/svix/models/active_application_out.rb +373 -0
  18. data/lib/svix/models/active_endpoint_out.rb +355 -0
  19. data/lib/svix/models/aggregate_event_types_out.rb +40 -0
  20. data/lib/svix/models/aggregated_event_types.rb +305 -0
  21. data/lib/svix/models/app_portal_access_in.rb +18 -0
  22. data/lib/svix/models/app_usage_stats_out.rb +40 -0
  23. data/lib/svix/models/application_message_failure.rb +277 -0
  24. data/lib/svix/models/application_message_id_pair.rb +317 -0
  25. data/lib/svix/models/application_out.rb +41 -2
  26. data/lib/svix/models/application_patch.rb +1 -1
  27. data/lib/svix/models/application_stats.rb +41 -2
  28. data/lib/svix/models/application_stats_out.rb +324 -0
  29. data/lib/svix/models/auth_token_out.rb +40 -1
  30. data/lib/svix/models/background_task_finished_event.rb +272 -0
  31. data/lib/svix/models/background_task_finished_event2.rb +331 -0
  32. data/lib/svix/models/background_task_out.rb +40 -0
  33. data/lib/svix/models/background_task_type.rb +2 -1
  34. data/lib/svix/models/{template_in.rb → connector_in.rb} +4 -4
  35. data/lib/svix/models/{transformation_template_kind.rb → connector_kind.rb} +3 -3
  36. data/lib/svix/models/create_stream_in.rb +12 -12
  37. data/lib/svix/models/data.rb +108 -0
  38. data/lib/svix/models/data_any_of.rb +240 -0
  39. data/lib/svix/models/data_any_of1.rb +223 -0
  40. data/lib/svix/models/data_any_of2.rb +241 -0
  41. data/lib/svix/models/data_any_of3.rb +223 -0
  42. data/lib/svix/models/data_any_of4.rb +240 -0
  43. data/lib/svix/models/endpoint_created_event_data.rb +82 -4
  44. data/lib/svix/models/endpoint_deleted_event_data.rb +82 -4
  45. data/lib/svix/models/endpoint_disabled_event.rb +1 -1
  46. data/lib/svix/models/endpoint_disabled_event_data.rb +119 -16
  47. data/lib/svix/models/endpoint_disabled_trigger.rb +40 -0
  48. data/lib/svix/models/endpoint_enabled_event.rb +272 -0
  49. data/lib/svix/models/endpoint_enabled_event_data.rb +410 -0
  50. data/lib/svix/models/endpoint_message_out.rb +40 -1
  51. data/lib/svix/models/endpoint_mtls_config_out.rb +215 -0
  52. data/lib/svix/models/endpoint_oauth_config_in.rb +2 -2
  53. data/lib/svix/models/endpoint_oauth_config_out.rb +315 -0
  54. data/lib/svix/models/endpoint_out.rb +40 -1
  55. data/lib/svix/models/endpoint_patch.rb +1 -1
  56. data/lib/svix/models/endpoint_updated_event_data.rb +82 -4
  57. data/lib/svix/models/environment_in.rb +17 -19
  58. data/lib/svix/models/environment_settings_out.rb +23 -1
  59. data/lib/svix/models/event_type_import_open_api_in.rb +14 -2
  60. data/lib/svix/models/export_event_type_out.rb +40 -0
  61. data/lib/svix/models/expung_all_contents_out.rb +315 -0
  62. data/lib/svix/models/inbound_path_params.rb +1 -1
  63. data/lib/svix/models/integration_in.rb +41 -1
  64. data/lib/svix/models/integration_out.rb +81 -2
  65. data/lib/svix/models/integration_update.rb +41 -1
  66. data/lib/svix/models/list_response_active_application_out.rb +261 -0
  67. data/lib/svix/models/message_attempt_endpoint_out.rb +120 -3
  68. data/lib/svix/models/message_attempt_exhausted_event_data.rb +122 -5
  69. data/lib/svix/models/message_attempt_failed_data.rb +40 -1
  70. data/lib/svix/models/message_attempt_failing_event_data.rb +122 -5
  71. data/lib/svix/models/message_attempt_out.rb +120 -3
  72. data/lib/svix/models/message_attempt_recovered_event_data.rb +122 -5
  73. data/lib/svix/models/message_broadcast_out.rb +40 -0
  74. data/lib/svix/models/message_endpoint_out.rb +40 -1
  75. data/lib/svix/models/message_out.rb +40 -1
  76. data/lib/svix/models/message_precheck_in.rb +288 -0
  77. data/lib/svix/models/message_precheck_out.rb +221 -0
  78. data/lib/svix/models/{oauth2_auth_method_in.rb → oauth2_auth_method_in_out.rb} +3 -3
  79. data/lib/svix/models/{oauth2_grant_type_in.rb → oauth2_grant_type_in_out.rb} +3 -3
  80. data/lib/svix/models/operational_webhook_endpoint_headers_in.rb +223 -0
  81. data/lib/svix/models/operational_webhook_endpoint_headers_out.rb +251 -0
  82. data/lib/svix/models/operational_webhook_endpoint_out.rb +40 -1
  83. data/lib/svix/models/polling_endpoint_message_out.rb +454 -0
  84. data/lib/svix/models/polling_endpoint_out.rb +255 -0
  85. data/lib/svix/models/recover_out.rb +40 -0
  86. data/lib/svix/models/replay_out.rb +40 -0
  87. data/lib/svix/models/rotate_poller_token_in.rb +1 -1
  88. data/lib/svix/models/sink_secret_out.rb +233 -0
  89. data/lib/svix/models/stream_in.rb +6 -7
  90. data/lib/svix/models/stream_out.rb +46 -7
  91. data/lib/svix/models/stream_patch.rb +6 -7
  92. data/lib/svix/models/stream_portal_access_in.rb +293 -0
  93. data/lib/svix/models/template_out.rb +81 -1
  94. data/lib/svix/models/template_patch.rb +1 -1
  95. data/lib/svix/models/template_update.rb +1 -1
  96. data/lib/svix/version.rb +1 -1
  97. metadata +35 -7
  98. data/lib/svix/operational_webhook_endpoint_api.rb +0 -37
@@ -21,7 +21,7 @@ module Svix
21
21
  end
22
22
  # Handle Inbound
23
23
  # Handles a raw inbound webhook for the application.
24
- # @param app_id [String] The app's ID or UID
24
+ # @param app_id [String] The Application's ID or UID.
25
25
  # @param inbound_token [String]
26
26
  # @param body [String]
27
27
  # @param [Hash] opts the optional parameters
@@ -35,7 +35,7 @@ module Svix
35
35
 
36
36
  # Handle Inbound
37
37
  # Handles a raw inbound webhook for the application.
38
- # @param app_id [String] The app's ID or UID
38
+ # @param app_id [String] The Application's ID or UID.
39
39
  # @param inbound_token [String]
40
40
  # @param body [String]
41
41
  # @param [Hash] opts the optional parameters
@@ -129,7 +129,7 @@ module Svix
129
129
 
130
130
  # Rotate Url
131
131
  # Invalidates the previous inbound url (if one exists), producing a new inbound URL for this app.
132
- # @param app_id [String] The app's ID or UID
132
+ # @param app_id [String] The Application's ID or UID.
133
133
  # @param [Hash] opts the optional parameters
134
134
  # @option opts [String] :idempotency_key The request's idempotency key
135
135
  # @return [RotatedUrlOut]
@@ -140,7 +140,7 @@ module Svix
140
140
 
141
141
  # Rotate Url
142
142
  # Invalidates the previous inbound url (if one exists), producing a new inbound URL for this app.
143
- # @param app_id [String] The app's ID or UID
143
+ # @param app_id [String] The Application's ID or UID.
144
144
  # @param [Hash] opts the optional parameters
145
145
  # @option opts [String] :idempotency_key The request's idempotency key
146
146
  # @return [Array<(RotatedUrlOut, Integer, Hash)>] RotatedUrlOut data, response status code and response headers
@@ -21,7 +21,7 @@ module Svix
21
21
  end
22
22
  # Create Integration
23
23
  # Create an integration.
24
- # @param app_id [String] The app&#39;s ID or UID
24
+ # @param app_id [String] The Application&#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] The app&#39;s ID or UID
36
+ # @param app_id [String] The Application&#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
@@ -111,8 +111,8 @@ module Svix
111
111
 
112
112
  # Delete Integration
113
113
  # Delete an integration.
114
- # @param app_id [String] The app&#39;s ID or UID
115
- # @param integ_id [String] The integ&#39;s ID
114
+ # @param app_id [String] The Application&#39;s ID or UID.
115
+ # @param integ_id [String] The Integration&#39;s ID.
116
116
  # @param [Hash] opts the optional parameters
117
117
  # @return [nil]
118
118
  def v1_integration_delete(app_id, integ_id, opts = {})
@@ -122,8 +122,8 @@ module Svix
122
122
 
123
123
  # Delete Integration
124
124
  # Delete an integration.
125
- # @param app_id [String] The app&#39;s ID or UID
126
- # @param integ_id [String] The integ&#39;s ID
125
+ # @param app_id [String] The Application&#39;s ID or UID.
126
+ # @param integ_id [String] The Integration&#39;s ID.
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_integration_delete_with_http_info(app_id, integ_id, opts = {})
@@ -151,6 +151,19 @@ module Svix
151
151
  if @api_client.config.client_side_validation && integ_id.nil?
152
152
  fail ArgumentError, "Missing the required parameter 'integ_id' when calling IntegrationApi.v1_integration_delete"
153
153
  end
154
+ if @api_client.config.client_side_validation && integ_id.to_s.length > 33
155
+ fail ArgumentError, 'invalid value for "integ_id" when calling IntegrationApi.v1_integration_delete, the character length must be smaller than or equal to 33.'
156
+ end
157
+
158
+ if @api_client.config.client_side_validation && integ_id.to_s.length < 33
159
+ fail ArgumentError, 'invalid value for "integ_id" when calling IntegrationApi.v1_integration_delete, the character length must be great than or equal to 33.'
160
+ end
161
+
162
+ pattern = Regexp.new(/^integ_[A-Za-z0-9]{27}$/)
163
+ if @api_client.config.client_side_validation && integ_id !~ pattern
164
+ fail ArgumentError, "invalid value for 'integ_id' when calling IntegrationApi.v1_integration_delete, must conform to the pattern #{pattern}."
165
+ end
166
+
154
167
  # resource path
155
168
  local_var_path = '/api/v1/app/{app_id}/integration/{integ_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'integ_id' + '}', CGI.escape(integ_id.to_s))
156
169
 
@@ -193,8 +206,8 @@ module Svix
193
206
 
194
207
  # Get Integration
195
208
  # Get an integration.
196
- # @param app_id [String] The app&#39;s ID or UID
197
- # @param integ_id [String] The integ&#39;s ID
209
+ # @param app_id [String] The Application&#39;s ID or UID.
210
+ # @param integ_id [String] The Integration&#39;s ID.
198
211
  # @param [Hash] opts the optional parameters
199
212
  # @return [IntegrationOut]
200
213
  def v1_integration_get(app_id, integ_id, opts = {})
@@ -204,8 +217,8 @@ module Svix
204
217
 
205
218
  # Get Integration
206
219
  # Get an integration.
207
- # @param app_id [String] The app&#39;s ID or UID
208
- # @param integ_id [String] The integ&#39;s ID
220
+ # @param app_id [String] The Application&#39;s ID or UID.
221
+ # @param integ_id [String] The Integration&#39;s ID.
209
222
  # @param [Hash] opts the optional parameters
210
223
  # @return [Array<(IntegrationOut, Integer, Hash)>] IntegrationOut data, response status code and response headers
211
224
  def v1_integration_get_with_http_info(app_id, integ_id, opts = {})
@@ -233,6 +246,19 @@ module Svix
233
246
  if @api_client.config.client_side_validation && integ_id.nil?
234
247
  fail ArgumentError, "Missing the required parameter 'integ_id' when calling IntegrationApi.v1_integration_get"
235
248
  end
249
+ if @api_client.config.client_side_validation && integ_id.to_s.length > 33
250
+ fail ArgumentError, 'invalid value for "integ_id" when calling IntegrationApi.v1_integration_get, the character length must be smaller than or equal to 33.'
251
+ end
252
+
253
+ if @api_client.config.client_side_validation && integ_id.to_s.length < 33
254
+ fail ArgumentError, 'invalid value for "integ_id" when calling IntegrationApi.v1_integration_get, the character length must be great than or equal to 33.'
255
+ end
256
+
257
+ pattern = Regexp.new(/^integ_[A-Za-z0-9]{27}$/)
258
+ if @api_client.config.client_side_validation && integ_id !~ pattern
259
+ fail ArgumentError, "invalid value for 'integ_id' when calling IntegrationApi.v1_integration_get, must conform to the pattern #{pattern}."
260
+ end
261
+
236
262
  # resource path
237
263
  local_var_path = '/api/v1/app/{app_id}/integration/{integ_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'integ_id' + '}', CGI.escape(integ_id.to_s))
238
264
 
@@ -275,8 +301,8 @@ module Svix
275
301
 
276
302
  # Get Integration Key
277
303
  # Get an integration's key.
278
- # @param app_id [String] The app&#39;s ID or UID
279
- # @param integ_id [String] The integ&#39;s ID
304
+ # @param app_id [String] The Application&#39;s ID or UID.
305
+ # @param integ_id [String] The Integration&#39;s ID.
280
306
  # @param [Hash] opts the optional parameters
281
307
  # @return [IntegrationKeyOut]
282
308
  def v1_integration_get_key(app_id, integ_id, opts = {})
@@ -286,8 +312,8 @@ module Svix
286
312
 
287
313
  # Get Integration Key
288
314
  # Get an integration&#39;s key.
289
- # @param app_id [String] The app&#39;s ID or UID
290
- # @param integ_id [String] The integ&#39;s ID
315
+ # @param app_id [String] The Application&#39;s ID or UID.
316
+ # @param integ_id [String] The Integration&#39;s ID.
291
317
  # @param [Hash] opts the optional parameters
292
318
  # @return [Array<(IntegrationKeyOut, Integer, Hash)>] IntegrationKeyOut data, response status code and response headers
293
319
  def v1_integration_get_key_with_http_info(app_id, integ_id, opts = {})
@@ -315,6 +341,19 @@ module Svix
315
341
  if @api_client.config.client_side_validation && integ_id.nil?
316
342
  fail ArgumentError, "Missing the required parameter 'integ_id' when calling IntegrationApi.v1_integration_get_key"
317
343
  end
344
+ if @api_client.config.client_side_validation && integ_id.to_s.length > 33
345
+ fail ArgumentError, 'invalid value for "integ_id" when calling IntegrationApi.v1_integration_get_key, the character length must be smaller than or equal to 33.'
346
+ end
347
+
348
+ if @api_client.config.client_side_validation && integ_id.to_s.length < 33
349
+ fail ArgumentError, 'invalid value for "integ_id" when calling IntegrationApi.v1_integration_get_key, the character length must be great than or equal to 33.'
350
+ end
351
+
352
+ pattern = Regexp.new(/^integ_[A-Za-z0-9]{27}$/)
353
+ if @api_client.config.client_side_validation && integ_id !~ pattern
354
+ fail ArgumentError, "invalid value for 'integ_id' when calling IntegrationApi.v1_integration_get_key, must conform to the pattern #{pattern}."
355
+ end
356
+
318
357
  # resource path
319
358
  local_var_path = '/api/v1/app/{app_id}/integration/{integ_id}/key'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'integ_id' + '}', CGI.escape(integ_id.to_s))
320
359
 
@@ -357,7 +396,7 @@ module Svix
357
396
 
358
397
  # List Integrations
359
398
  # List the application's integrations.
360
- # @param app_id [String] The app&#39;s ID or UID
399
+ # @param app_id [String] The Application&#39;s ID or UID.
361
400
  # @param [Hash] opts the optional parameters
362
401
  # @option opts [Integer] :limit Limit the number of returned items
363
402
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -370,7 +409,7 @@ module Svix
370
409
 
371
410
  # List Integrations
372
411
  # List the application&#39;s integrations.
373
- # @param app_id [String] The app&#39;s ID or UID
412
+ # @param app_id [String] The Application&#39;s ID or UID.
374
413
  # @param [Hash] opts the optional parameters
375
414
  # @option opts [Integer] :limit Limit the number of returned items
376
415
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -405,6 +444,19 @@ module Svix
405
444
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling IntegrationApi.v1_integration_list, must be greater than or equal to 1.'
406
445
  end
407
446
 
447
+ if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'].to_s.length > 33
448
+ fail ArgumentError, 'invalid value for "opts[:"iterator"]" when calling IntegrationApi.v1_integration_list, the character length must be smaller than or equal to 33.'
449
+ end
450
+
451
+ if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'].to_s.length < 33
452
+ fail ArgumentError, 'invalid value for "opts[:"iterator"]" when calling IntegrationApi.v1_integration_list, the character length must be great than or equal to 33.'
453
+ end
454
+
455
+ pattern = Regexp.new(/^integ_[A-Za-z0-9]{27}$/)
456
+ if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'] !~ pattern
457
+ fail ArgumentError, "invalid value for 'opts[:\"iterator\"]' when calling IntegrationApi.v1_integration_list, must conform to the pattern #{pattern}."
458
+ end
459
+
408
460
  # resource path
409
461
  local_var_path = '/api/v1/app/{app_id}/integration'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
410
462
 
@@ -450,8 +502,8 @@ module Svix
450
502
 
451
503
  # Rotate Integration Key
452
504
  # Rotate the integration's key. The previous key will be immediately revoked.
453
- # @param app_id [String] The app&#39;s ID or UID
454
- # @param integ_id [String] The integ&#39;s ID
505
+ # @param app_id [String] The Application&#39;s ID or UID.
506
+ # @param integ_id [String] The Integration&#39;s ID.
455
507
  # @param [Hash] opts the optional parameters
456
508
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
457
509
  # @return [IntegrationKeyOut]
@@ -462,8 +514,8 @@ module Svix
462
514
 
463
515
  # Rotate Integration Key
464
516
  # Rotate the integration&#39;s key. The previous key will be immediately revoked.
465
- # @param app_id [String] The app&#39;s ID or UID
466
- # @param integ_id [String] The integ&#39;s ID
517
+ # @param app_id [String] The Application&#39;s ID or UID.
518
+ # @param integ_id [String] The Integration&#39;s ID.
467
519
  # @param [Hash] opts the optional parameters
468
520
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
469
521
  # @return [Array<(IntegrationKeyOut, Integer, Hash)>] IntegrationKeyOut data, response status code and response headers
@@ -492,6 +544,19 @@ module Svix
492
544
  if @api_client.config.client_side_validation && integ_id.nil?
493
545
  fail ArgumentError, "Missing the required parameter 'integ_id' when calling IntegrationApi.v1_integration_rotate_key"
494
546
  end
547
+ if @api_client.config.client_side_validation && integ_id.to_s.length > 33
548
+ fail ArgumentError, 'invalid value for "integ_id" when calling IntegrationApi.v1_integration_rotate_key, the character length must be smaller than or equal to 33.'
549
+ end
550
+
551
+ if @api_client.config.client_side_validation && integ_id.to_s.length < 33
552
+ fail ArgumentError, 'invalid value for "integ_id" when calling IntegrationApi.v1_integration_rotate_key, the character length must be great than or equal to 33.'
553
+ end
554
+
555
+ pattern = Regexp.new(/^integ_[A-Za-z0-9]{27}$/)
556
+ if @api_client.config.client_side_validation && integ_id !~ pattern
557
+ fail ArgumentError, "invalid value for 'integ_id' when calling IntegrationApi.v1_integration_rotate_key, must conform to the pattern #{pattern}."
558
+ end
559
+
495
560
  # resource path
496
561
  local_var_path = '/api/v1/app/{app_id}/integration/{integ_id}/key/rotate'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'integ_id' + '}', CGI.escape(integ_id.to_s))
497
562
 
@@ -535,8 +600,8 @@ module Svix
535
600
 
536
601
  # Update Integration
537
602
  # Update an integration.
538
- # @param app_id [String] The app&#39;s ID or UID
539
- # @param integ_id [String] The integ&#39;s ID
603
+ # @param app_id [String] The Application&#39;s ID or UID.
604
+ # @param integ_id [String] The Integration&#39;s ID.
540
605
  # @param integration_update [IntegrationUpdate]
541
606
  # @param [Hash] opts the optional parameters
542
607
  # @return [IntegrationOut]
@@ -547,8 +612,8 @@ module Svix
547
612
 
548
613
  # Update Integration
549
614
  # Update an integration.
550
- # @param app_id [String] The app&#39;s ID or UID
551
- # @param integ_id [String] The integ&#39;s ID
615
+ # @param app_id [String] The Application&#39;s ID or UID.
616
+ # @param integ_id [String] The Integration&#39;s ID.
552
617
  # @param integration_update [IntegrationUpdate]
553
618
  # @param [Hash] opts the optional parameters
554
619
  # @return [Array<(IntegrationOut, Integer, Hash)>] IntegrationOut data, response status code and response headers
@@ -577,6 +642,19 @@ module Svix
577
642
  if @api_client.config.client_side_validation && integ_id.nil?
578
643
  fail ArgumentError, "Missing the required parameter 'integ_id' when calling IntegrationApi.v1_integration_update"
579
644
  end
645
+ if @api_client.config.client_side_validation && integ_id.to_s.length > 33
646
+ fail ArgumentError, 'invalid value for "integ_id" when calling IntegrationApi.v1_integration_update, the character length must be smaller than or equal to 33.'
647
+ end
648
+
649
+ if @api_client.config.client_side_validation && integ_id.to_s.length < 33
650
+ fail ArgumentError, 'invalid value for "integ_id" when calling IntegrationApi.v1_integration_update, the character length must be great than or equal to 33.'
651
+ end
652
+
653
+ pattern = Regexp.new(/^integ_[A-Za-z0-9]{27}$/)
654
+ if @api_client.config.client_side_validation && integ_id !~ pattern
655
+ fail ArgumentError, "invalid value for 'integ_id' when calling IntegrationApi.v1_integration_update, must conform to the pattern #{pattern}."
656
+ end
657
+
580
658
  # verify the required parameter 'integration_update' is set
581
659
  if @api_client.config.client_side_validation && integration_update.nil?
582
660
  fail ArgumentError, "Missing the required parameter 'integration_update' when calling IntegrationApi.v1_integration_update"
@@ -21,8 +21,8 @@ module Svix
21
21
  end
22
22
  # Create Message Attempt For Endpoint
23
23
  # Creates and sends a message to the specified endpoint. The message attempt and response from the endpoint is returned.
24
- # @param app_id [String] The app&#39;s ID or UID
25
- # @param endpoint_id [String] The ep&#39;s ID or UID
24
+ # @param app_id [String] The Application&#39;s ID or UID.
25
+ # @param endpoint_id [String] The Endpoint&#39;s ID or UID.
26
26
  # @param message_in [MessageIn]
27
27
  # @param [Hash] opts the optional parameters
28
28
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -34,8 +34,8 @@ module Svix
34
34
 
35
35
  # Create Message Attempt For Endpoint
36
36
  # Creates and sends a message to the specified endpoint. The message attempt and response from the endpoint is returned.
37
- # @param app_id [String] The app&#39;s ID or UID
38
- # @param endpoint_id [String] The ep&#39;s ID or UID
37
+ # @param app_id [String] The Application&#39;s ID or UID.
38
+ # @param endpoint_id [String] The Endpoint&#39;s ID or UID.
39
39
  # @param message_in [MessageIn]
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -130,15 +130,15 @@ module Svix
130
130
 
131
131
  # Public Events
132
132
  # Reads the stream of created messages for an application, filtered on the Sink's event types and Channels.
133
- # @param app_id [String] The app&#39;s ID or UID
134
- # @param sink_id [String] The ep&#39;s ID or UID
133
+ # @param app_id [String] The Application&#39;s ID or UID.
134
+ # @param sink_id [String] The Endpoint&#39;s ID or UID.
135
135
  # @param [Hash] opts the optional parameters
136
136
  # @option opts [Integer] :limit Limit the number of returned items
137
137
  # @option opts [String] :iterator The iterator returned from a prior invocation
138
138
  # @option opts [String] :event_type Filters messages sent with this event type (optional).
139
139
  # @option opts [String] :channel Filters messages sent with this channel (optional).
140
140
  # @option opts [Time] :after
141
- # @return [MessageEventsOut]
141
+ # @return [PollingEndpointOut]
142
142
  def v1_events_public(app_id, sink_id, opts = {})
143
143
  data, _status_code, _headers = v1_events_public_with_http_info(app_id, sink_id, opts)
144
144
  data
@@ -146,15 +146,15 @@ module Svix
146
146
 
147
147
  # Public Events
148
148
  # Reads the stream of created messages for an application, filtered on the Sink&#39;s event types and Channels.
149
- # @param app_id [String] The app&#39;s ID or UID
150
- # @param sink_id [String] The ep&#39;s ID or UID
149
+ # @param app_id [String] The Application&#39;s ID or UID.
150
+ # @param sink_id [String] The Endpoint&#39;s ID or UID.
151
151
  # @param [Hash] opts the optional parameters
152
152
  # @option opts [Integer] :limit Limit the number of returned items
153
153
  # @option opts [String] :iterator The iterator returned from a prior invocation
154
154
  # @option opts [String] :event_type Filters messages sent with this event type (optional).
155
155
  # @option opts [String] :channel Filters messages sent with this channel (optional).
156
156
  # @option opts [Time] :after
157
- # @return [Array<(MessageEventsOut, Integer, Hash)>] MessageEventsOut data, response status code and response headers
157
+ # @return [Array<(PollingEndpointOut, Integer, Hash)>] PollingEndpointOut data, response status code and response headers
158
158
  def v1_events_public_with_http_info(app_id, sink_id, opts = {})
159
159
  if @api_client.config.debugging
160
160
  @api_client.config.logger.debug 'Calling API: MessageApi.v1_events_public ...'
@@ -242,7 +242,7 @@ module Svix
242
242
  post_body = opts[:debug_body]
243
243
 
244
244
  # return_type
245
- return_type = opts[:debug_return_type] || 'MessageEventsOut'
245
+ return_type = opts[:debug_return_type] || 'PollingEndpointOut'
246
246
 
247
247
  # auth_names
248
248
  auth_names = opts[:debug_auth_names] || ['HTTPBearer']
@@ -266,7 +266,7 @@ module Svix
266
266
 
267
267
  # Create Message
268
268
  # 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 the application, 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.
269
- # @param app_id [String] The app&#39;s ID or UID
269
+ # @param app_id [String] The Application&#39;s ID or UID.
270
270
  # @param message_in [MessageIn]
271
271
  # @param [Hash] opts the optional parameters
272
272
  # @option opts [Boolean] :with_content When &#x60;true&#x60;, message payloads are included in the response. (default to true)
@@ -279,7 +279,7 @@ module Svix
279
279
 
280
280
  # Create Message
281
281
  # 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 the application, 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.
282
- # @param app_id [String] The app&#39;s ID or UID
282
+ # @param app_id [String] The Application&#39;s ID or UID.
283
283
  # @param message_in [MessageIn]
284
284
  # @param [Hash] opts the optional parameters
285
285
  # @option opts [Boolean] :with_content When &#x60;true&#x60;, message payloads are included in the response. (default to true)
@@ -359,7 +359,7 @@ module Svix
359
359
 
360
360
  # Message Events
361
361
  # Reads the stream of created messages for an application.
362
- # @param app_id [String] The app&#39;s ID or UID
362
+ # @param app_id [String] The Application&#39;s ID or UID.
363
363
  # @param [Hash] opts the optional parameters
364
364
  # @option opts [Integer] :limit Limit the number of returned items
365
365
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -374,7 +374,7 @@ module Svix
374
374
 
375
375
  # Message Events
376
376
  # Reads the stream of created messages for an application.
377
- # @param app_id [String] The app&#39;s ID or UID
377
+ # @param app_id [String] The Application&#39;s ID or UID.
378
378
  # @param [Hash] opts the optional parameters
379
379
  # @option opts [Integer] :limit Limit the number of returned items
380
380
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -458,8 +458,8 @@ module Svix
458
458
 
459
459
  # Message Events Subscription
460
460
  # Reads the stream of created messages for an application, but using server-managed iterator tracking.
461
- # @param app_id [String] The app&#39;s ID or UID
462
- # @param subscription_id [String] The esub&#39;s ID or UID
461
+ # @param app_id [String] The Application&#39;s ID or UID.
462
+ # @param subscription_id [String] The EventsSubscription&#39;s ID or UID.
463
463
  # @param [Hash] opts the optional parameters
464
464
  # @option opts [Integer] :limit Limit the number of returned items
465
465
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -474,8 +474,8 @@ module Svix
474
474
 
475
475
  # Message Events Subscription
476
476
  # Reads the stream of created messages for an application, but using server-managed iterator tracking.
477
- # @param app_id [String] The app&#39;s ID or UID
478
- # @param subscription_id [String] The esub&#39;s ID or UID
477
+ # @param app_id [String] The Application&#39;s ID or UID.
478
+ # @param subscription_id [String] The EventsSubscription&#39;s ID or UID.
479
479
  # @param [Hash] opts the optional parameters
480
480
  # @option opts [Integer] :limit Limit the number of returned items
481
481
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -576,8 +576,8 @@ module Svix
576
576
 
577
577
  # Message Events Create Token
578
578
  # Creates an auth token that can be used with the `v1.message.events-subscription` endpoint.
579
- # @param app_id [String] The app&#39;s ID or UID
580
- # @param subscription_id [String] The esub&#39;s ID or UID
579
+ # @param app_id [String] The Application&#39;s ID or UID.
580
+ # @param subscription_id [String] The EventsSubscription&#39;s ID or UID.
581
581
  # @param [Hash] opts the optional parameters
582
582
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
583
583
  # @return [MessageSubscriberAuthTokenOut]
@@ -588,8 +588,8 @@ module Svix
588
588
 
589
589
  # Message Events Create Token
590
590
  # Creates an auth token that can be used with the &#x60;v1.message.events-subscription&#x60; endpoint.
591
- # @param app_id [String] The app&#39;s ID or UID
592
- # @param subscription_id [String] The esub&#39;s ID or UID
591
+ # @param app_id [String] The Application&#39;s ID or UID.
592
+ # @param subscription_id [String] The EventsSubscription&#39;s ID or UID.
593
593
  # @param [Hash] opts the optional parameters
594
594
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
595
595
  # @return [Array<(MessageSubscriberAuthTokenOut, Integer, Hash)>] MessageSubscriberAuthTokenOut data, response status code and response headers
@@ -674,8 +674,8 @@ module Svix
674
674
 
675
675
  # Delete message payload
676
676
  # 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.
677
- # @param app_id [String] The app&#39;s ID or UID
678
- # @param msg_id [String] The msg&#39;s ID or UID
677
+ # @param app_id [String] The Application&#39;s ID or UID.
678
+ # @param msg_id [String] The Message&#39;s ID or UID.
679
679
  # @param [Hash] opts the optional parameters
680
680
  # @return [nil]
681
681
  def v1_message_expunge_content(app_id, msg_id, opts = {})
@@ -685,8 +685,8 @@ module Svix
685
685
 
686
686
  # Delete message payload
687
687
  # 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.
688
- # @param app_id [String] The app&#39;s ID or UID
689
- # @param msg_id [String] The msg&#39;s ID or UID
688
+ # @param app_id [String] The Application&#39;s ID or UID.
689
+ # @param msg_id [String] The Message&#39;s ID or UID.
690
690
  # @param [Hash] opts the optional parameters
691
691
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
692
692
  def v1_message_expunge_content_with_http_info(app_id, msg_id, opts = {})
@@ -769,8 +769,8 @@ module Svix
769
769
 
770
770
  # Get Message
771
771
  # Get a message by its ID or eventID.
772
- # @param app_id [String] The app&#39;s ID or UID
773
- # @param msg_id [String] The msg&#39;s ID or UID
772
+ # @param app_id [String] The Application&#39;s ID or UID.
773
+ # @param msg_id [String] The Message&#39;s ID or UID.
774
774
  # @param [Hash] opts the optional parameters
775
775
  # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response. (default to true)
776
776
  # @return [MessageOut]
@@ -781,8 +781,8 @@ module Svix
781
781
 
782
782
  # Get Message
783
783
  # Get a message by its ID or eventID.
784
- # @param app_id [String] The app&#39;s ID or UID
785
- # @param msg_id [String] The msg&#39;s ID or UID
784
+ # @param app_id [String] The Application&#39;s ID or UID.
785
+ # @param msg_id [String] The Message&#39;s ID or UID.
786
786
  # @param [Hash] opts the optional parameters
787
787
  # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response. (default to true)
788
788
  # @return [Array<(MessageOut, Integer, Hash)>] MessageOut data, response status code and response headers
@@ -867,8 +867,8 @@ module Svix
867
867
 
868
868
  # Get Raw Message Payload
869
869
  # Get a message raw payload by its ID or eventID.
870
- # @param app_id [String] The app&#39;s ID or UID
871
- # @param msg_id [String] The msg&#39;s ID or UID
870
+ # @param app_id [String] The Application&#39;s ID or UID.
871
+ # @param msg_id [String] The Message&#39;s ID or UID.
872
872
  # @param [Hash] opts the optional parameters
873
873
  # @return [MessageRawPayloadOut]
874
874
  def v1_message_get_raw_payload(app_id, msg_id, opts = {})
@@ -878,8 +878,8 @@ module Svix
878
878
 
879
879
  # Get Raw Message Payload
880
880
  # Get a message raw payload by its ID or eventID.
881
- # @param app_id [String] The app&#39;s ID or UID
882
- # @param msg_id [String] The msg&#39;s ID or UID
881
+ # @param app_id [String] The Application&#39;s ID or UID.
882
+ # @param msg_id [String] The Message&#39;s ID or UID.
883
883
  # @param [Hash] opts the optional parameters
884
884
  # @return [Array<(MessageRawPayloadOut, Integer, Hash)>] MessageRawPayloadOut data, response status code and response headers
885
885
  def v1_message_get_raw_payload_with_http_info(app_id, msg_id, opts = {})
@@ -961,8 +961,8 @@ module Svix
961
961
  end
962
962
 
963
963
  # List Messages
964
- # List all of the application's messages. The `before` and `after` parameters let you filter all items created before or after a certain date. These can be used alongside an iterator to paginate over results within a certain window. Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the `before` or `after` parameter as appropriate.
965
- # @param app_id [String] The app&#39;s ID or UID
964
+ # List all of the application's messages. The `before` and `after` parameters let you filter all items created before or after a certain date. These can be used alongside an iterator to paginate over results within a certain window. Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the `before` or `after` parameter as appropriate.
965
+ # @param app_id [String] The Application&#39;s ID or UID.
966
966
  # @param [Hash] opts the optional parameters
967
967
  # @option opts [Integer] :limit Limit the number of returned items
968
968
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -979,8 +979,8 @@ module Svix
979
979
  end
980
980
 
981
981
  # List Messages
982
- # List all of the application&#39;s messages. The &#x60;before&#x60; and &#x60;after&#x60; parameters let you filter all items created before or after a certain date. These can be used alongside an iterator to paginate over results within a certain window. Note that by default this endpoint is limited to retrieving 90 days&#39; worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the &#x60;before&#x60; or &#x60;after&#x60; parameter as appropriate.
983
- # @param app_id [String] The app&#39;s ID or UID
982
+ # List all of the application&#39;s messages. The &#x60;before&#x60; and &#x60;after&#x60; parameters let you filter all items created before or after a certain date. These can be used alongside an iterator to paginate over results within a certain window. Note that by default this endpoint is limited to retrieving 90 days&#39; worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the &#x60;before&#x60; or &#x60;after&#x60; parameter as appropriate.
983
+ # @param app_id [String] The Application&#39;s ID or UID.
984
984
  # @param [Hash] opts the optional parameters
985
985
  # @option opts [Integer] :limit Limit the number of returned items
986
986
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -1020,6 +1020,19 @@ module Svix
1020
1020
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageApi.v1_message_list, must be greater than or equal to 1.'
1021
1021
  end
1022
1022
 
1023
+ if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'].to_s.length > 31
1024
+ fail ArgumentError, 'invalid value for "opts[:"iterator"]" when calling MessageApi.v1_message_list, the character length must be smaller than or equal to 31.'
1025
+ end
1026
+
1027
+ if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'].to_s.length < 31
1028
+ fail ArgumentError, 'invalid value for "opts[:"iterator"]" when calling MessageApi.v1_message_list, the character length must be great than or equal to 31.'
1029
+ end
1030
+
1031
+ pattern = Regexp.new(/^msg_[A-Za-z0-9]{27}$/)
1032
+ if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'] !~ pattern
1033
+ fail ArgumentError, "invalid value for 'opts[:\"iterator\"]' when calling MessageApi.v1_message_list, must conform to the pattern #{pattern}."
1034
+ end
1035
+
1023
1036
  if @api_client.config.client_side_validation && !opts[:'channel'].nil? && opts[:'channel'].to_s.length > 128
1024
1037
  fail ArgumentError, 'invalid value for "opts[:"channel"]" when calling MessageApi.v1_message_list, the character length must be smaller than or equal to 128.'
1025
1038
  end
@@ -1085,5 +1098,95 @@ module Svix
1085
1098
  end
1086
1099
  return data, status_code, headers
1087
1100
  end
1101
+
1102
+ # Create Message Precheck
1103
+ # A pre-check call for `create.message` that checks whether endpoints are actively listening to this message.
1104
+ # @param app_id [String] The Application&#39;s ID or UID.
1105
+ # @param message_precheck_in [MessagePrecheckIn]
1106
+ # @param [Hash] opts the optional parameters
1107
+ # @option opts [String] :idempotency_key The request&#39;s idempotency key
1108
+ # @return [MessagePrecheckOut]
1109
+ def v1_message_precheck(app_id, message_precheck_in, opts = {})
1110
+ data, _status_code, _headers = v1_message_precheck_with_http_info(app_id, message_precheck_in, opts)
1111
+ data
1112
+ end
1113
+
1114
+ # Create Message Precheck
1115
+ # A pre-check call for &#x60;create.message&#x60; that checks whether endpoints are actively listening to this message.
1116
+ # @param app_id [String] The Application&#39;s ID or UID.
1117
+ # @param message_precheck_in [MessagePrecheckIn]
1118
+ # @param [Hash] opts the optional parameters
1119
+ # @option opts [String] :idempotency_key The request&#39;s idempotency key
1120
+ # @return [Array<(MessagePrecheckOut, Integer, Hash)>] MessagePrecheckOut data, response status code and response headers
1121
+ def v1_message_precheck_with_http_info(app_id, message_precheck_in, opts = {})
1122
+ if @api_client.config.debugging
1123
+ @api_client.config.logger.debug 'Calling API: MessageApi.v1_message_precheck ...'
1124
+ end
1125
+ # verify the required parameter 'app_id' is set
1126
+ if @api_client.config.client_side_validation && app_id.nil?
1127
+ fail ArgumentError, "Missing the required parameter 'app_id' when calling MessageApi.v1_message_precheck"
1128
+ end
1129
+ if @api_client.config.client_side_validation && app_id.to_s.length > 256
1130
+ fail ArgumentError, 'invalid value for "app_id" when calling MessageApi.v1_message_precheck, the character length must be smaller than or equal to 256.'
1131
+ end
1132
+
1133
+ if @api_client.config.client_side_validation && app_id.to_s.length < 1
1134
+ fail ArgumentError, 'invalid value for "app_id" when calling MessageApi.v1_message_precheck, the character length must be great than or equal to 1.'
1135
+ end
1136
+
1137
+ pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
1138
+ if @api_client.config.client_side_validation && app_id !~ pattern
1139
+ fail ArgumentError, "invalid value for 'app_id' when calling MessageApi.v1_message_precheck, must conform to the pattern #{pattern}."
1140
+ end
1141
+
1142
+ # verify the required parameter 'message_precheck_in' is set
1143
+ if @api_client.config.client_side_validation && message_precheck_in.nil?
1144
+ fail ArgumentError, "Missing the required parameter 'message_precheck_in' when calling MessageApi.v1_message_precheck"
1145
+ end
1146
+ # resource path
1147
+ local_var_path = '/api/v1/app/{app_id}/msg/precheck/active'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s))
1148
+
1149
+ # query parameters
1150
+ query_params = opts[:query_params] || {}
1151
+
1152
+ # header parameters
1153
+ header_params = opts[:header_params] || {}
1154
+ # HTTP header 'Accept' (if needed)
1155
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1156
+ # HTTP header 'Content-Type'
1157
+ content_type = @api_client.select_header_content_type(['application/json'])
1158
+ if !content_type.nil?
1159
+ header_params['Content-Type'] = content_type
1160
+ end
1161
+ header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
1162
+
1163
+ # form parameters
1164
+ form_params = opts[:form_params] || {}
1165
+
1166
+ # http body (model)
1167
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(message_precheck_in)
1168
+
1169
+ # return_type
1170
+ return_type = opts[:debug_return_type] || 'MessagePrecheckOut'
1171
+
1172
+ # auth_names
1173
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
1174
+
1175
+ new_options = opts.merge(
1176
+ :operation => :"MessageApi.v1_message_precheck",
1177
+ :header_params => header_params,
1178
+ :query_params => query_params,
1179
+ :form_params => form_params,
1180
+ :body => post_body,
1181
+ :auth_names => auth_names,
1182
+ :return_type => return_type
1183
+ )
1184
+
1185
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1186
+ if @api_client.config.debugging
1187
+ @api_client.config.logger.debug "API called: MessageApi#v1_message_precheck\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1188
+ end
1189
+ return data, status_code, headers
1190
+ end
1088
1191
  end
1089
1192
  end