svix 1.56.0 → 1.58.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
@@ -20,9 +20,9 @@ module Svix
20
20
  @api_client = api_client
21
21
  end
22
22
  # Update Hubspot Oauth Config
23
- # Create/update endpoint Hubspot OAuth configuration Specific private endpoint just for us, to avoid exposing the Hubspot secret to the client.
24
- # @param app_id [String] The app's ID or UID
25
- # @param endpoint_id [String] The ep's ID or UID
23
+ # Create / update endpoint Hubspot OAuth configuration. Specific private endpoint just for us, to avoid exposing the Hubspot secret to the client.
24
+ # @param app_id [String] The Application's ID or UID.
25
+ # @param endpoint_id [String] The Endpoint's ID or UID.
26
26
  # @param hubspot_oauth_config_in [HubspotOauthConfigIn]
27
27
  # @param [Hash] opts the optional parameters
28
28
  # @return [nil]
@@ -32,9 +32,9 @@ module Svix
32
32
  end
33
33
 
34
34
  # Update Hubspot Oauth Config
35
- # Create/update endpoint Hubspot OAuth configuration Specific private endpoint just for us, to avoid exposing the Hubspot secret to the client.
36
- # @param app_id [String] The app's ID or UID
37
- # @param endpoint_id [String] The ep's ID or UID
35
+ # Create / update endpoint Hubspot OAuth configuration. Specific private endpoint just for us, to avoid exposing the Hubspot secret to the client.
36
+ # @param app_id [String] The Application's ID or UID.
37
+ # @param endpoint_id [String] The Endpoint's ID or UID.
38
38
  # @param hubspot_oauth_config_in [HubspotOauthConfigIn]
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -127,28 +127,28 @@ module Svix
127
127
 
128
128
  # Create Transformation Template
129
129
  # Create a new transformation template.
130
- # @param template_in [TemplateIn]
130
+ # @param connector_in [ConnectorIn]
131
131
  # @param [Hash] opts the optional parameters
132
132
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
133
133
  # @return [TemplateOut]
134
- def v1_transformation_template_create(template_in, opts = {})
135
- data, _status_code, _headers = v1_transformation_template_create_with_http_info(template_in, opts)
134
+ def v1_transformation_template_create(connector_in, opts = {})
135
+ data, _status_code, _headers = v1_transformation_template_create_with_http_info(connector_in, opts)
136
136
  data
137
137
  end
138
138
 
139
139
  # Create Transformation Template
140
140
  # Create a new transformation template.
141
- # @param template_in [TemplateIn]
141
+ # @param connector_in [ConnectorIn]
142
142
  # @param [Hash] opts the optional parameters
143
143
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
144
144
  # @return [Array<(TemplateOut, Integer, Hash)>] TemplateOut data, response status code and response headers
145
- def v1_transformation_template_create_with_http_info(template_in, opts = {})
145
+ def v1_transformation_template_create_with_http_info(connector_in, opts = {})
146
146
  if @api_client.config.debugging
147
147
  @api_client.config.logger.debug 'Calling API: TransformationTemplateApi.v1_transformation_template_create ...'
148
148
  end
149
- # verify the required parameter 'template_in' is set
150
- if @api_client.config.client_side_validation && template_in.nil?
151
- fail ArgumentError, "Missing the required parameter 'template_in' when calling TransformationTemplateApi.v1_transformation_template_create"
149
+ # verify the required parameter 'connector_in' is set
150
+ if @api_client.config.client_side_validation && connector_in.nil?
151
+ fail ArgumentError, "Missing the required parameter 'connector_in' when calling TransformationTemplateApi.v1_transformation_template_create"
152
152
  end
153
153
  # resource path
154
154
  local_var_path = '/api/v1/transformation-template'
@@ -171,7 +171,7 @@ module Svix
171
171
  form_params = opts[:form_params] || {}
172
172
 
173
173
  # http body (model)
174
- post_body = opts[:debug_body] || @api_client.object_to_http_body(template_in)
174
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(connector_in)
175
175
 
176
176
  # return_type
177
177
  return_type = opts[:debug_return_type] || 'TemplateOut'
@@ -198,7 +198,7 @@ module Svix
198
198
 
199
199
  # Delete Transformation Template
200
200
  # Delete a transformation template.
201
- # @param transformation_template_id [String]
201
+ # @param transformation_template_id [String] The TransformationTemplate&#39;s ID.
202
202
  # @param [Hash] opts the optional parameters
203
203
  # @return [nil]
204
204
  def v1_transformation_template_delete(transformation_template_id, opts = {})
@@ -208,7 +208,7 @@ module Svix
208
208
 
209
209
  # Delete Transformation Template
210
210
  # Delete a transformation template.
211
- # @param transformation_template_id [String]
211
+ # @param transformation_template_id [String] The TransformationTemplate&#39;s ID.
212
212
  # @param [Hash] opts the optional parameters
213
213
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
214
214
  def v1_transformation_template_delete_with_http_info(transformation_template_id, opts = {})
@@ -219,6 +219,19 @@ module Svix
219
219
  if @api_client.config.client_side_validation && transformation_template_id.nil?
220
220
  fail ArgumentError, "Missing the required parameter 'transformation_template_id' when calling TransformationTemplateApi.v1_transformation_template_delete"
221
221
  end
222
+ if @api_client.config.client_side_validation && transformation_template_id.to_s.length > 34
223
+ fail ArgumentError, 'invalid value for "transformation_template_id" when calling TransformationTemplateApi.v1_transformation_template_delete, the character length must be smaller than or equal to 34.'
224
+ end
225
+
226
+ if @api_client.config.client_side_validation && transformation_template_id.to_s.length < 34
227
+ fail ArgumentError, 'invalid value for "transformation_template_id" when calling TransformationTemplateApi.v1_transformation_template_delete, the character length must be great than or equal to 34.'
228
+ end
229
+
230
+ pattern = Regexp.new(/^trtmpl_[A-Za-z0-9]{27}$/)
231
+ if @api_client.config.client_side_validation && transformation_template_id !~ pattern
232
+ fail ArgumentError, "invalid value for 'transformation_template_id' when calling TransformationTemplateApi.v1_transformation_template_delete, must conform to the pattern #{pattern}."
233
+ end
234
+
222
235
  # resource path
223
236
  local_var_path = '/api/v1/transformation-template/{transformation_template_id}'.sub('{' + 'transformation_template_id' + '}', CGI.escape(transformation_template_id.to_s))
224
237
 
@@ -332,7 +345,7 @@ module Svix
332
345
 
333
346
  # Get Transformation Template
334
347
  # Get a transformation template.
335
- # @param transformation_template_id [String]
348
+ # @param transformation_template_id [String] The TransformationTemplate&#39;s ID.
336
349
  # @param [Hash] opts the optional parameters
337
350
  # @return [TemplateOut]
338
351
  def v1_transformation_template_get(transformation_template_id, opts = {})
@@ -342,7 +355,7 @@ module Svix
342
355
 
343
356
  # Get Transformation Template
344
357
  # Get a transformation template.
345
- # @param transformation_template_id [String]
358
+ # @param transformation_template_id [String] The TransformationTemplate&#39;s ID.
346
359
  # @param [Hash] opts the optional parameters
347
360
  # @return [Array<(TemplateOut, Integer, Hash)>] TemplateOut data, response status code and response headers
348
361
  def v1_transformation_template_get_with_http_info(transformation_template_id, opts = {})
@@ -353,6 +366,19 @@ module Svix
353
366
  if @api_client.config.client_side_validation && transformation_template_id.nil?
354
367
  fail ArgumentError, "Missing the required parameter 'transformation_template_id' when calling TransformationTemplateApi.v1_transformation_template_get"
355
368
  end
369
+ if @api_client.config.client_side_validation && transformation_template_id.to_s.length > 34
370
+ fail ArgumentError, 'invalid value for "transformation_template_id" when calling TransformationTemplateApi.v1_transformation_template_get, the character length must be smaller than or equal to 34.'
371
+ end
372
+
373
+ if @api_client.config.client_side_validation && transformation_template_id.to_s.length < 34
374
+ fail ArgumentError, 'invalid value for "transformation_template_id" when calling TransformationTemplateApi.v1_transformation_template_get, the character length must be great than or equal to 34.'
375
+ end
376
+
377
+ pattern = Regexp.new(/^trtmpl_[A-Za-z0-9]{27}$/)
378
+ if @api_client.config.client_side_validation && transformation_template_id !~ pattern
379
+ fail ArgumentError, "invalid value for 'transformation_template_id' when calling TransformationTemplateApi.v1_transformation_template_get, must conform to the pattern #{pattern}."
380
+ end
381
+
356
382
  # resource path
357
383
  local_var_path = '/api/v1/transformation-template/{transformation_template_id}'.sub('{' + 'transformation_template_id' + '}', CGI.escape(transformation_template_id.to_s))
358
384
 
@@ -424,6 +450,19 @@ module Svix
424
450
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransformationTemplateApi.v1_transformation_template_list, must be greater than or equal to 1.'
425
451
  end
426
452
 
453
+ if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'].to_s.length > 34
454
+ fail ArgumentError, 'invalid value for "opts[:"iterator"]" when calling TransformationTemplateApi.v1_transformation_template_list, the character length must be smaller than or equal to 34.'
455
+ end
456
+
457
+ if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'].to_s.length < 34
458
+ fail ArgumentError, 'invalid value for "opts[:"iterator"]" when calling TransformationTemplateApi.v1_transformation_template_list, the character length must be great than or equal to 34.'
459
+ end
460
+
461
+ pattern = Regexp.new(/^trtmpl_[A-Za-z0-9]{27}$/)
462
+ if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'] !~ pattern
463
+ fail ArgumentError, "invalid value for 'opts[:\"iterator\"]' when calling TransformationTemplateApi.v1_transformation_template_list, must conform to the pattern #{pattern}."
464
+ end
465
+
427
466
  # resource path
428
467
  local_var_path = '/api/v1/transformation-template'
429
468
 
@@ -682,7 +721,7 @@ module Svix
682
721
 
683
722
  # Patch Transformation Template
684
723
  # Partially update a transformation template.
685
- # @param transformation_template_id [String]
724
+ # @param transformation_template_id [String] The TransformationTemplate&#39;s ID.
686
725
  # @param template_patch [TemplatePatch]
687
726
  # @param [Hash] opts the optional parameters
688
727
  # @return [TemplateOut]
@@ -693,7 +732,7 @@ module Svix
693
732
 
694
733
  # Patch Transformation Template
695
734
  # Partially update a transformation template.
696
- # @param transformation_template_id [String]
735
+ # @param transformation_template_id [String] The TransformationTemplate&#39;s ID.
697
736
  # @param template_patch [TemplatePatch]
698
737
  # @param [Hash] opts the optional parameters
699
738
  # @return [Array<(TemplateOut, Integer, Hash)>] TemplateOut data, response status code and response headers
@@ -705,6 +744,19 @@ module Svix
705
744
  if @api_client.config.client_side_validation && transformation_template_id.nil?
706
745
  fail ArgumentError, "Missing the required parameter 'transformation_template_id' when calling TransformationTemplateApi.v1_transformation_template_patch"
707
746
  end
747
+ if @api_client.config.client_side_validation && transformation_template_id.to_s.length > 34
748
+ fail ArgumentError, 'invalid value for "transformation_template_id" when calling TransformationTemplateApi.v1_transformation_template_patch, the character length must be smaller than or equal to 34.'
749
+ end
750
+
751
+ if @api_client.config.client_side_validation && transformation_template_id.to_s.length < 34
752
+ fail ArgumentError, 'invalid value for "transformation_template_id" when calling TransformationTemplateApi.v1_transformation_template_patch, the character length must be great than or equal to 34.'
753
+ end
754
+
755
+ pattern = Regexp.new(/^trtmpl_[A-Za-z0-9]{27}$/)
756
+ if @api_client.config.client_side_validation && transformation_template_id !~ pattern
757
+ fail ArgumentError, "invalid value for 'transformation_template_id' when calling TransformationTemplateApi.v1_transformation_template_patch, must conform to the pattern #{pattern}."
758
+ end
759
+
708
760
  # verify the required parameter 'template_patch' is set
709
761
  if @api_client.config.client_side_validation && template_patch.nil?
710
762
  fail ArgumentError, "Missing the required parameter 'template_patch' when calling TransformationTemplateApi.v1_transformation_template_patch"
@@ -827,7 +879,7 @@ module Svix
827
879
 
828
880
  # Update Transformation Template
829
881
  # Update a transformation template.
830
- # @param transformation_template_id [String]
882
+ # @param transformation_template_id [String] The TransformationTemplate&#39;s ID.
831
883
  # @param template_update [TemplateUpdate]
832
884
  # @param [Hash] opts the optional parameters
833
885
  # @return [TemplateOut]
@@ -838,7 +890,7 @@ module Svix
838
890
 
839
891
  # Update Transformation Template
840
892
  # Update a transformation template.
841
- # @param transformation_template_id [String]
893
+ # @param transformation_template_id [String] The TransformationTemplate&#39;s ID.
842
894
  # @param template_update [TemplateUpdate]
843
895
  # @param [Hash] opts the optional parameters
844
896
  # @return [Array<(TemplateOut, Integer, Hash)>] TemplateOut data, response status code and response headers
@@ -850,6 +902,19 @@ module Svix
850
902
  if @api_client.config.client_side_validation && transformation_template_id.nil?
851
903
  fail ArgumentError, "Missing the required parameter 'transformation_template_id' when calling TransformationTemplateApi.v1_transformation_template_update"
852
904
  end
905
+ if @api_client.config.client_side_validation && transformation_template_id.to_s.length > 34
906
+ fail ArgumentError, 'invalid value for "transformation_template_id" when calling TransformationTemplateApi.v1_transformation_template_update, the character length must be smaller than or equal to 34.'
907
+ end
908
+
909
+ if @api_client.config.client_side_validation && transformation_template_id.to_s.length < 34
910
+ fail ArgumentError, 'invalid value for "transformation_template_id" when calling TransformationTemplateApi.v1_transformation_template_update, the character length must be great than or equal to 34.'
911
+ end
912
+
913
+ pattern = Regexp.new(/^trtmpl_[A-Za-z0-9]{27}$/)
914
+ if @api_client.config.client_side_validation && transformation_template_id !~ pattern
915
+ fail ArgumentError, "invalid value for 'transformation_template_id' when calling TransformationTemplateApi.v1_transformation_template_update, must conform to the pattern #{pattern}."
916
+ end
917
+
853
918
  # verify the required parameter 'template_update' is set
854
919
  if @api_client.config.client_side_validation && template_update.nil?
855
920
  fail ArgumentError, "Missing the required parameter 'template_update' when calling TransformationTemplateApi.v1_transformation_template_update"