svix 1.60.1 → 1.61.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.
- checksums.yaml +4 -4
- data/Gemfile +5 -1
- data/Gemfile.lock +35 -21
- data/README.md +0 -7
- data/lib/svix/api/application.rb +96 -0
- data/lib/svix/api/authentication.rb +65 -0
- data/lib/svix/api/background_task.rb +39 -0
- data/lib/svix/api/endpoint.rb +202 -0
- data/lib/svix/api/environment.rb +39 -0
- data/lib/svix/api/event_type.rb +99 -0
- data/lib/svix/api/health.rb +21 -0
- data/lib/svix/api/integration.rb +91 -0
- data/lib/svix/api/message.rb +112 -0
- data/lib/svix/api/message_attempt.rb +123 -0
- data/lib/svix/api/operational_webhook_endpoint.rb +109 -0
- data/lib/svix/api/statistics.rb +36 -0
- data/lib/svix/api_error.rb +7 -17
- data/lib/svix/errors.rb +9 -9
- data/lib/svix/http_error_out.rb +18 -0
- data/lib/svix/http_validation_error.rb +18 -0
- data/lib/svix/internal.rb +0 -9
- data/lib/svix/models/aggregate_event_types_out.rb +32 -292
- data/lib/svix/models/app_portal_access_in.rb +31 -278
- data/lib/svix/models/app_portal_access_out.rb +27 -243
- data/lib/svix/models/app_usage_stats_in.rb +30 -234
- data/lib/svix/models/app_usage_stats_out.rb +31 -320
- data/lib/svix/models/application_in.rb +31 -298
- data/lib/svix/models/application_out.rb +37 -371
- data/lib/svix/models/application_patch.rb +31 -272
- data/lib/svix/models/application_token_expire_in.rb +28 -219
- data/lib/svix/models/background_task_out.rb +31 -307
- data/lib/svix/models/background_task_status.rb +14 -25
- data/lib/svix/models/background_task_type.rb +23 -26
- data/lib/svix/models/connector_in.rb +58 -385
- data/lib/svix/models/connector_kind.rb +28 -26
- data/lib/svix/models/dashboard_access_out.rb +27 -243
- data/lib/svix/models/endpoint_headers_in.rb +25 -202
- data/lib/svix/models/endpoint_headers_out.rb +30 -230
- data/lib/svix/models/endpoint_headers_patch_in.rb +28 -202
- data/lib/svix/models/endpoint_in.rb +61 -449
- data/lib/svix/models/endpoint_message_out.rb +48 -467
- data/lib/svix/models/endpoint_out.rb +67 -528
- data/lib/svix/models/endpoint_patch.rb +61 -383
- data/lib/svix/models/endpoint_secret_out.rb +25 -222
- data/lib/svix/models/endpoint_secret_rotate_in.rb +28 -212
- data/lib/svix/models/endpoint_stats.rb +31 -245
- data/lib/svix/models/endpoint_transformation_in.rb +30 -226
- data/lib/svix/models/endpoint_transformation_out.rb +30 -228
- data/lib/svix/models/endpoint_update.rb +58 -422
- data/lib/svix/models/environment_in.rb +31 -212
- data/lib/svix/models/environment_out.rb +35 -255
- data/lib/svix/models/event_example_in.rb +27 -261
- data/lib/svix/models/event_type_from_open_api.rb +35 -341
- data/lib/svix/models/event_type_import_open_api_in.rb +37 -228
- data/lib/svix/models/event_type_import_open_api_out.rb +28 -200
- data/lib/svix/models/event_type_import_open_api_out_data.rb +31 -211
- data/lib/svix/models/event_type_in.rb +37 -347
- data/lib/svix/models/event_type_out.rb +58 -389
- data/lib/svix/models/event_type_patch.rb +35 -289
- data/lib/svix/models/event_type_update.rb +35 -301
- data/lib/svix/models/expung_all_contents_out.rb +29 -292
- data/lib/svix/models/integration_in.rb +27 -239
- data/lib/svix/models/integration_key_out.rb +25 -200
- data/lib/svix/models/integration_out.rb +33 -324
- data/lib/svix/models/integration_update.rb +27 -239
- data/lib/svix/models/list_response_application_out.rb +34 -237
- data/lib/svix/models/list_response_background_task_out.rb +34 -237
- data/lib/svix/models/list_response_endpoint_message_out.rb +34 -237
- data/lib/svix/models/list_response_endpoint_out.rb +34 -237
- data/lib/svix/models/list_response_event_type_out.rb +34 -237
- data/lib/svix/models/list_response_integration_out.rb +34 -237
- data/lib/svix/models/list_response_message_attempt_out.rb +34 -237
- data/lib/svix/models/list_response_message_endpoint_out.rb +34 -237
- data/lib/svix/models/list_response_message_out.rb +34 -237
- data/lib/svix/models/list_response_operational_webhook_endpoint_out.rb +34 -237
- data/lib/svix/models/message_attempt_out.rb +64 -521
- data/lib/svix/models/message_attempt_trigger_type.rb +20 -28
- data/lib/svix/models/message_endpoint_out.rb +70 -557
- data/lib/svix/models/message_in.rb +58 -450
- data/lib/svix/models/message_out.rb +37 -414
- data/lib/svix/models/message_status.rb +24 -30
- data/lib/svix/models/operational_webhook_endpoint_headers_in.rb +28 -202
- data/lib/svix/models/operational_webhook_endpoint_headers_out.rb +30 -229
- data/lib/svix/models/operational_webhook_endpoint_in.rb +42 -380
- data/lib/svix/models/operational_webhook_endpoint_out.rb +64 -458
- data/lib/svix/models/operational_webhook_endpoint_secret_in.rb +28 -212
- data/lib/svix/models/operational_webhook_endpoint_secret_out.rb +28 -222
- data/lib/svix/models/operational_webhook_endpoint_update.rb +40 -353
- data/lib/svix/models/ordering.rb +15 -25
- data/lib/svix/models/recover_in.rb +28 -210
- data/lib/svix/models/recover_out.rb +29 -292
- data/lib/svix/models/replay_in.rb +28 -210
- data/lib/svix/models/replay_out.rb +29 -292
- data/lib/svix/models/status_code_class.rb +28 -32
- data/lib/svix/models/template_out.rb +70 -514
- data/lib/svix/svix.rb +50 -50
- data/lib/svix/svix_http_client.rb +110 -0
- data/lib/svix/util.rb +44 -25
- data/lib/svix/validation_error.rb +28 -0
- data/lib/svix/version.rb +1 -1
- data/lib/svix/webhook.rb +69 -65
- data/lib/svix.rb +51 -37
- data/svix.gemspec +1 -10
- metadata +22 -194
- data/lib/svix/api/application_api.rb +0 -772
- data/lib/svix/api/authentication_api.rb +0 -791
- data/lib/svix/api/background_tasks_api.rb +0 -191
- data/lib/svix/api/broadcast_api.rb +0 -93
- data/lib/svix/api/endpoint_api.rb +0 -2752
- data/lib/svix/api/environment_api.rb +0 -153
- data/lib/svix/api/environment_settings_api.rb +0 -79
- data/lib/svix/api/event_type_api.rb +0 -852
- data/lib/svix/api/events_api.rb +0 -102
- data/lib/svix/api/health_api.rb +0 -79
- data/lib/svix/api/inbound_api.rb +0 -209
- data/lib/svix/api/integration_api.rb +0 -707
- data/lib/svix/api/message_api.rb +0 -1192
- data/lib/svix/api/message_attempt_api.rb +0 -1245
- data/lib/svix/api/statistics_api.rb +0 -333
- data/lib/svix/api/stream_api.rb +0 -659
- data/lib/svix/api/stream_event_types_api.rb +0 -486
- data/lib/svix/api/transformation_template_api.rb +0 -967
- data/lib/svix/api/webhook_endpoint_api.rb +0 -748
- data/lib/svix/api_client.rb +0 -423
- data/lib/svix/application_api.rb +0 -35
- data/lib/svix/authentication_api.rb +0 -21
- data/lib/svix/background_tasks_api.rb +0 -17
- data/lib/svix/configuration.rb +0 -312
- data/lib/svix/endpoint_api.rb +0 -80
- data/lib/svix/event_type_api.rb +0 -37
- data/lib/svix/integration_api.rb +0 -38
- data/lib/svix/message_api.rb +0 -54
- data/lib/svix/message_attempt_api.rb +0 -51
- data/lib/svix/models/active_application_out.rb +0 -373
- data/lib/svix/models/active_endpoint_out.rb +0 -355
- data/lib/svix/models/aggregated_event_types.rb +0 -305
- data/lib/svix/models/application_message_failure.rb +0 -277
- data/lib/svix/models/application_message_id_pair.rb +0 -317
- data/lib/svix/models/application_stats.rb +0 -323
- data/lib/svix/models/application_stats_out.rb +0 -324
- data/lib/svix/models/attempt_statistics_data.rb +0 -229
- data/lib/svix/models/attempt_statistics_response.rb +0 -291
- data/lib/svix/models/auth_token_out.rb +0 -325
- data/lib/svix/models/azure_blob_storage_config.rb +0 -253
- data/lib/svix/models/background_task_finished_event.rb +0 -272
- data/lib/svix/models/background_task_finished_event2.rb +0 -331
- data/lib/svix/models/big_query_config.rb +0 -271
- data/lib/svix/models/border_radius_config.rb +0 -254
- data/lib/svix/models/border_radius_enum.rb +0 -43
- data/lib/svix/models/client_secret_jwt_params_in.rb +0 -297
- data/lib/svix/models/completion_choice.rb +0 -253
- data/lib/svix/models/completion_message.rb +0 -237
- data/lib/svix/models/count_out.rb +0 -258
- data/lib/svix/models/create_stream_in.rb +0 -232
- data/lib/svix/models/create_token_in.rb +0 -248
- data/lib/svix/models/custom_color_palette.rb +0 -295
- data/lib/svix/models/custom_strings_override.rb +0 -235
- data/lib/svix/models/custom_theme_override.rb +0 -223
- data/lib/svix/models/data.rb +0 -108
- data/lib/svix/models/data_any_of.rb +0 -240
- data/lib/svix/models/data_any_of1.rb +0 -223
- data/lib/svix/models/data_any_of2.rb +0 -241
- data/lib/svix/models/data_any_of3.rb +0 -223
- data/lib/svix/models/data_any_of4.rb +0 -240
- data/lib/svix/models/duration.rb +0 -275
- data/lib/svix/models/endpoint_created_event.rb +0 -272
- data/lib/svix/models/endpoint_created_event_data.rb +0 -410
- data/lib/svix/models/endpoint_deleted_event.rb +0 -272
- data/lib/svix/models/endpoint_deleted_event_data.rb +0 -410
- data/lib/svix/models/endpoint_disabled_event.rb +0 -272
- data/lib/svix/models/endpoint_disabled_event_data.rb +0 -451
- data/lib/svix/models/endpoint_disabled_trigger.rb +0 -40
- data/lib/svix/models/endpoint_enabled_event.rb +0 -272
- data/lib/svix/models/endpoint_enabled_event_data.rb +0 -410
- data/lib/svix/models/endpoint_mtls_config_in.rb +0 -233
- data/lib/svix/models/endpoint_mtls_config_out.rb +0 -215
- data/lib/svix/models/endpoint_oauth_config_in.rb +0 -350
- data/lib/svix/models/endpoint_oauth_config_out.rb +0 -315
- data/lib/svix/models/endpoint_transformation_simulate_in.rb +0 -330
- data/lib/svix/models/endpoint_transformation_simulate_out.rb +0 -296
- data/lib/svix/models/endpoint_updated_event.rb +0 -272
- data/lib/svix/models/endpoint_updated_event_data.rb +0 -410
- data/lib/svix/models/environment_settings_out.rb +0 -455
- data/lib/svix/models/event_in.rb +0 -258
- data/lib/svix/models/event_out.rb +0 -274
- data/lib/svix/models/event_stream_out.rb +0 -255
- data/lib/svix/models/event_type_example_out.rb +0 -221
- data/lib/svix/models/event_type_schema_in.rb +0 -221
- data/lib/svix/models/export_event_type_out.rb +0 -315
- data/lib/svix/models/font_size_config.rb +0 -230
- data/lib/svix/models/generate_in.rb +0 -221
- data/lib/svix/models/generate_out.rb +0 -287
- data/lib/svix/models/google_cloud_storage_config.rb +0 -239
- data/lib/svix/models/http_error_out.rb +0 -237
- data/lib/svix/models/http_validation_error.rb +0 -223
- data/lib/svix/models/hubspot_oauth_config_in.rb +0 -221
- data/lib/svix/models/inbound_path_params.rb +0 -277
- data/lib/svix/models/incoming_webhook_payload_out.rb +0 -235
- data/lib/svix/models/kafka_security_protocol_type.rb +0 -41
- data/lib/svix/models/list_response_active_application_out.rb +0 -261
- data/lib/svix/models/list_response_application_stats.rb +0 -261
- data/lib/svix/models/list_response_message_attempt_endpoint_out.rb +0 -261
- data/lib/svix/models/list_response_sink_out.rb +0 -261
- data/lib/svix/models/list_response_stream_event_type_out.rb +0 -261
- data/lib/svix/models/list_response_stream_out.rb +0 -261
- data/lib/svix/models/list_response_stream_sink_out.rb +0 -261
- data/lib/svix/models/list_response_template_out.rb +0 -261
- data/lib/svix/models/message_attempt_endpoint_out.rb +0 -545
- data/lib/svix/models/message_attempt_exhausted_event.rb +0 -272
- data/lib/svix/models/message_attempt_exhausted_event_data.rb +0 -482
- data/lib/svix/models/message_attempt_failed_data.rb +0 -293
- data/lib/svix/models/message_attempt_failing_event.rb +0 -272
- data/lib/svix/models/message_attempt_failing_event_data.rb +0 -482
- data/lib/svix/models/message_attempt_headers_out.rb +0 -263
- data/lib/svix/models/message_attempt_recovered_event.rb +0 -272
- data/lib/svix/models/message_attempt_recovered_event_data.rb +0 -482
- data/lib/svix/models/message_broadcast_in.rb +0 -423
- data/lib/svix/models/message_broadcast_out.rb +0 -315
- data/lib/svix/models/message_events_out.rb +0 -255
- data/lib/svix/models/message_precheck_in.rb +0 -288
- data/lib/svix/models/message_precheck_out.rb +0 -221
- data/lib/svix/models/message_raw_payload_out.rb +0 -221
- data/lib/svix/models/message_subscriber_auth_token_out.rb +0 -237
- data/lib/svix/models/o_auth_payload_in.rb +0 -237
- data/lib/svix/models/o_auth_payload_out.rb +0 -235
- data/lib/svix/models/oauth2_auth_method_in_out.rb +0 -41
- data/lib/svix/models/oauth2_grant_type_in_out.rb +0 -40
- data/lib/svix/models/oauth_jws_signing_algorithm.rb +0 -39
- data/lib/svix/models/one_time_token_in.rb +0 -221
- data/lib/svix/models/one_time_token_out.rb +0 -221
- data/lib/svix/models/polling_endpoint_message_out.rb +0 -454
- data/lib/svix/models/polling_endpoint_out.rb +0 -255
- data/lib/svix/models/redshift_config.rb +0 -317
- data/lib/svix/models/retry_schedule_in_out.rb +0 -216
- data/lib/svix/models/rotate_poller_token_in.rb +0 -280
- data/lib/svix/models/rotated_url_out.rb +0 -221
- data/lib/svix/models/s3_config.rb +0 -269
- data/lib/svix/models/sink_http_config.rb +0 -242
- data/lib/svix/models/sink_in.rb +0 -108
- data/lib/svix/models/sink_in_one_of.rb +0 -287
- data/lib/svix/models/sink_in_one_of1.rb +0 -319
- data/lib/svix/models/sink_in_one_of2.rb +0 -325
- data/lib/svix/models/sink_in_one_of3.rb +0 -271
- data/lib/svix/models/sink_in_one_of4.rb +0 -255
- data/lib/svix/models/sink_otel_v1_config.rb +0 -221
- data/lib/svix/models/sink_out.rb +0 -108
- data/lib/svix/models/sink_payload_format.rb +0 -39
- data/lib/svix/models/sink_secret_out.rb +0 -233
- data/lib/svix/models/sink_status.rb +0 -41
- data/lib/svix/models/sink_status_in.rb +0 -40
- data/lib/svix/models/sink_transform_in.rb +0 -248
- data/lib/svix/models/sink_transformation_out.rb +0 -226
- data/lib/svix/models/snowflake_config.rb +0 -287
- data/lib/svix/models/statistics_period.rb +0 -40
- data/lib/svix/models/stream_event_type_in.rb +0 -262
- data/lib/svix/models/stream_event_type_out.rb +0 -294
- data/lib/svix/models/stream_event_type_patch.rb +0 -254
- data/lib/svix/models/stream_in.rb +0 -287
- data/lib/svix/models/stream_out.rb +0 -350
- data/lib/svix/models/stream_patch.rb +0 -261
- data/lib/svix/models/stream_portal_access_in.rb +0 -293
- data/lib/svix/models/stream_sink_in.rb +0 -111
- data/lib/svix/models/stream_sink_in_one_of.rb +0 -271
- data/lib/svix/models/stream_sink_in_one_of1.rb +0 -271
- data/lib/svix/models/stream_sink_in_one_of2.rb +0 -271
- data/lib/svix/models/stream_sink_in_one_of3.rb +0 -271
- data/lib/svix/models/stream_sink_in_one_of4.rb +0 -271
- data/lib/svix/models/stream_sink_in_one_of5.rb +0 -271
- data/lib/svix/models/stream_sink_in_one_of6.rb +0 -271
- data/lib/svix/models/stream_sink_in_one_of7.rb +0 -271
- data/lib/svix/models/stream_sink_out.rb +0 -111
- data/lib/svix/models/stream_sink_patch.rb +0 -111
- data/lib/svix/models/template_patch.rb +0 -382
- data/lib/svix/models/template_update.rb +0 -402
- data/lib/svix/models/transformation_http_method.rb +0 -41
- data/lib/svix/models/transformation_simulate_in.rb +0 -330
- data/lib/svix/models/transformation_simulate_out.rb +0 -296
- data/lib/svix/models/validation_error.rb +0 -259
- data/lib/svix/statistics_api.rb +0 -17
@@ -1,191 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#Svix API
|
3
|
-
|
4
|
-
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 1.1.1
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
Generator version: 7.9.0
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'cgi'
|
14
|
-
|
15
|
-
module Svix
|
16
|
-
class BackgroundTasksApi
|
17
|
-
attr_accessor :api_client
|
18
|
-
|
19
|
-
def initialize(api_client = ApiClient.default)
|
20
|
-
@api_client = api_client
|
21
|
-
end
|
22
|
-
# Get Background Task
|
23
|
-
# Get a background task by ID.
|
24
|
-
# @param task_id [String] The QueueBackgroundTask's ID.
|
25
|
-
# @param [Hash] opts the optional parameters
|
26
|
-
# @return [BackgroundTaskOut]
|
27
|
-
def v1_background_task_get(task_id, opts = {})
|
28
|
-
data, _status_code, _headers = v1_background_task_get_with_http_info(task_id, opts)
|
29
|
-
data
|
30
|
-
end
|
31
|
-
|
32
|
-
# Get Background Task
|
33
|
-
# Get a background task by ID.
|
34
|
-
# @param task_id [String] The QueueBackgroundTask's ID.
|
35
|
-
# @param [Hash] opts the optional parameters
|
36
|
-
# @return [Array<(BackgroundTaskOut, Integer, Hash)>] BackgroundTaskOut data, response status code and response headers
|
37
|
-
def v1_background_task_get_with_http_info(task_id, opts = {})
|
38
|
-
if @api_client.config.debugging
|
39
|
-
@api_client.config.logger.debug 'Calling API: BackgroundTasksApi.v1_background_task_get ...'
|
40
|
-
end
|
41
|
-
# verify the required parameter 'task_id' is set
|
42
|
-
if @api_client.config.client_side_validation && task_id.nil?
|
43
|
-
fail ArgumentError, "Missing the required parameter 'task_id' when calling BackgroundTasksApi.v1_background_task_get"
|
44
|
-
end
|
45
|
-
if @api_client.config.client_side_validation && task_id.to_s.length > 33
|
46
|
-
fail ArgumentError, 'invalid value for "task_id" when calling BackgroundTasksApi.v1_background_task_get, the character length must be smaller than or equal to 33.'
|
47
|
-
end
|
48
|
-
|
49
|
-
if @api_client.config.client_side_validation && task_id.to_s.length < 33
|
50
|
-
fail ArgumentError, 'invalid value for "task_id" when calling BackgroundTasksApi.v1_background_task_get, the character length must be great than or equal to 33.'
|
51
|
-
end
|
52
|
-
|
53
|
-
pattern = Regexp.new(/^qtask_[A-Za-z0-9]{27}$/)
|
54
|
-
if @api_client.config.client_side_validation && task_id !~ pattern
|
55
|
-
fail ArgumentError, "invalid value for 'task_id' when calling BackgroundTasksApi.v1_background_task_get, must conform to the pattern #{pattern}."
|
56
|
-
end
|
57
|
-
|
58
|
-
# resource path
|
59
|
-
local_var_path = '/api/v1/background-task/{task_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
|
60
|
-
|
61
|
-
# query parameters
|
62
|
-
query_params = opts[:query_params] || {}
|
63
|
-
|
64
|
-
# header parameters
|
65
|
-
header_params = opts[:header_params] || {}
|
66
|
-
# HTTP header 'Accept' (if needed)
|
67
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
68
|
-
|
69
|
-
# form parameters
|
70
|
-
form_params = opts[:form_params] || {}
|
71
|
-
|
72
|
-
# http body (model)
|
73
|
-
post_body = opts[:debug_body]
|
74
|
-
|
75
|
-
# return_type
|
76
|
-
return_type = opts[:debug_return_type] || 'BackgroundTaskOut'
|
77
|
-
|
78
|
-
# auth_names
|
79
|
-
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
80
|
-
|
81
|
-
new_options = opts.merge(
|
82
|
-
:operation => :"BackgroundTasksApi.v1_background_task_get",
|
83
|
-
:header_params => header_params,
|
84
|
-
:query_params => query_params,
|
85
|
-
:form_params => form_params,
|
86
|
-
:body => post_body,
|
87
|
-
:auth_names => auth_names,
|
88
|
-
:return_type => return_type
|
89
|
-
)
|
90
|
-
|
91
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
92
|
-
if @api_client.config.debugging
|
93
|
-
@api_client.config.logger.debug "API called: BackgroundTasksApi#v1_background_task_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
94
|
-
end
|
95
|
-
return data, status_code, headers
|
96
|
-
end
|
97
|
-
|
98
|
-
# List Background Tasks
|
99
|
-
# List background tasks executed in the past 90 days.
|
100
|
-
# @param [Hash] opts the optional parameters
|
101
|
-
# @option opts [BackgroundTaskStatus] :status Filter the response based on the status.
|
102
|
-
# @option opts [BackgroundTaskType] :task Filter the response based on the type.
|
103
|
-
# @option opts [Integer] :limit Limit the number of returned items
|
104
|
-
# @option opts [String] :iterator The iterator returned from a prior invocation
|
105
|
-
# @option opts [Ordering] :order The sorting order of the returned items
|
106
|
-
# @return [ListResponseBackgroundTaskOut]
|
107
|
-
def v1_background_task_list(opts = {})
|
108
|
-
data, _status_code, _headers = v1_background_task_list_with_http_info(opts)
|
109
|
-
data
|
110
|
-
end
|
111
|
-
|
112
|
-
# List Background Tasks
|
113
|
-
# List background tasks executed in the past 90 days.
|
114
|
-
# @param [Hash] opts the optional parameters
|
115
|
-
# @option opts [BackgroundTaskStatus] :status Filter the response based on the status.
|
116
|
-
# @option opts [BackgroundTaskType] :task Filter the response based on the type.
|
117
|
-
# @option opts [Integer] :limit Limit the number of returned items
|
118
|
-
# @option opts [String] :iterator The iterator returned from a prior invocation
|
119
|
-
# @option opts [Ordering] :order The sorting order of the returned items
|
120
|
-
# @return [Array<(ListResponseBackgroundTaskOut, Integer, Hash)>] ListResponseBackgroundTaskOut data, response status code and response headers
|
121
|
-
def v1_background_task_list_with_http_info(opts = {})
|
122
|
-
if @api_client.config.debugging
|
123
|
-
@api_client.config.logger.debug 'Calling API: BackgroundTasksApi.v1_background_task_list ...'
|
124
|
-
end
|
125
|
-
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
|
126
|
-
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BackgroundTasksApi.v1_background_task_list, must be smaller than or equal to 250.'
|
127
|
-
end
|
128
|
-
|
129
|
-
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
130
|
-
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BackgroundTasksApi.v1_background_task_list, must be greater than or equal to 1.'
|
131
|
-
end
|
132
|
-
|
133
|
-
if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'].to_s.length > 33
|
134
|
-
fail ArgumentError, 'invalid value for "opts[:"iterator"]" when calling BackgroundTasksApi.v1_background_task_list, the character length must be smaller than or equal to 33.'
|
135
|
-
end
|
136
|
-
|
137
|
-
if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'].to_s.length < 33
|
138
|
-
fail ArgumentError, 'invalid value for "opts[:"iterator"]" when calling BackgroundTasksApi.v1_background_task_list, the character length must be great than or equal to 33.'
|
139
|
-
end
|
140
|
-
|
141
|
-
pattern = Regexp.new(/^qtask_[A-Za-z0-9]{27}$/)
|
142
|
-
if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'] !~ pattern
|
143
|
-
fail ArgumentError, "invalid value for 'opts[:\"iterator\"]' when calling BackgroundTasksApi.v1_background_task_list, must conform to the pattern #{pattern}."
|
144
|
-
end
|
145
|
-
|
146
|
-
# resource path
|
147
|
-
local_var_path = '/api/v1/background-task'
|
148
|
-
|
149
|
-
# query parameters
|
150
|
-
query_params = opts[:query_params] || {}
|
151
|
-
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
152
|
-
query_params[:'task'] = opts[:'task'] if !opts[:'task'].nil?
|
153
|
-
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
154
|
-
query_params[:'iterator'] = opts[:'iterator'] if !opts[:'iterator'].nil?
|
155
|
-
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
156
|
-
|
157
|
-
# header parameters
|
158
|
-
header_params = opts[:header_params] || {}
|
159
|
-
# HTTP header 'Accept' (if needed)
|
160
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
161
|
-
|
162
|
-
# form parameters
|
163
|
-
form_params = opts[:form_params] || {}
|
164
|
-
|
165
|
-
# http body (model)
|
166
|
-
post_body = opts[:debug_body]
|
167
|
-
|
168
|
-
# return_type
|
169
|
-
return_type = opts[:debug_return_type] || 'ListResponseBackgroundTaskOut'
|
170
|
-
|
171
|
-
# auth_names
|
172
|
-
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
173
|
-
|
174
|
-
new_options = opts.merge(
|
175
|
-
:operation => :"BackgroundTasksApi.v1_background_task_list",
|
176
|
-
:header_params => header_params,
|
177
|
-
:query_params => query_params,
|
178
|
-
:form_params => form_params,
|
179
|
-
:body => post_body,
|
180
|
-
:auth_names => auth_names,
|
181
|
-
:return_type => return_type
|
182
|
-
)
|
183
|
-
|
184
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
185
|
-
if @api_client.config.debugging
|
186
|
-
@api_client.config.logger.debug "API called: BackgroundTasksApi#v1_background_task_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
187
|
-
end
|
188
|
-
return data, status_code, headers
|
189
|
-
end
|
190
|
-
end
|
191
|
-
end
|
@@ -1,93 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#Svix API
|
3
|
-
|
4
|
-
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
|
-
|
6
|
-
The version of the OpenAPI document: 1.1.1
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
Generator version: 7.9.0
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'cgi'
|
14
|
-
|
15
|
-
module Svix
|
16
|
-
class BroadcastApi
|
17
|
-
attr_accessor :api_client
|
18
|
-
|
19
|
-
def initialize(api_client = ApiClient.default)
|
20
|
-
@api_client = api_client
|
21
|
-
end
|
22
|
-
# Create Broadcast Message
|
23
|
-
# Creates a background task to send the same message to each application in your organization.
|
24
|
-
# @param message_broadcast_in [MessageBroadcastIn]
|
25
|
-
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [String] :idempotency_key The request's idempotency key
|
27
|
-
# @return [MessageBroadcastOut]
|
28
|
-
def create_broadcast_message(message_broadcast_in, opts = {})
|
29
|
-
data, _status_code, _headers = create_broadcast_message_with_http_info(message_broadcast_in, opts)
|
30
|
-
data
|
31
|
-
end
|
32
|
-
|
33
|
-
# Create Broadcast Message
|
34
|
-
# Creates a background task to send the same message to each application in your organization.
|
35
|
-
# @param message_broadcast_in [MessageBroadcastIn]
|
36
|
-
# @param [Hash] opts the optional parameters
|
37
|
-
# @option opts [String] :idempotency_key The request's idempotency key
|
38
|
-
# @return [Array<(MessageBroadcastOut, Integer, Hash)>] MessageBroadcastOut data, response status code and response headers
|
39
|
-
def create_broadcast_message_with_http_info(message_broadcast_in, opts = {})
|
40
|
-
if @api_client.config.debugging
|
41
|
-
@api_client.config.logger.debug 'Calling API: BroadcastApi.create_broadcast_message ...'
|
42
|
-
end
|
43
|
-
# verify the required parameter 'message_broadcast_in' is set
|
44
|
-
if @api_client.config.client_side_validation && message_broadcast_in.nil?
|
45
|
-
fail ArgumentError, "Missing the required parameter 'message_broadcast_in' when calling BroadcastApi.create_broadcast_message"
|
46
|
-
end
|
47
|
-
# resource path
|
48
|
-
local_var_path = '/api/v1/msg/broadcast'
|
49
|
-
|
50
|
-
# query parameters
|
51
|
-
query_params = opts[:query_params] || {}
|
52
|
-
|
53
|
-
# header parameters
|
54
|
-
header_params = opts[:header_params] || {}
|
55
|
-
# HTTP header 'Accept' (if needed)
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
57
|
-
# HTTP header 'Content-Type'
|
58
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
59
|
-
if !content_type.nil?
|
60
|
-
header_params['Content-Type'] = content_type
|
61
|
-
end
|
62
|
-
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
63
|
-
|
64
|
-
# form parameters
|
65
|
-
form_params = opts[:form_params] || {}
|
66
|
-
|
67
|
-
# http body (model)
|
68
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(message_broadcast_in)
|
69
|
-
|
70
|
-
# return_type
|
71
|
-
return_type = opts[:debug_return_type] || 'MessageBroadcastOut'
|
72
|
-
|
73
|
-
# auth_names
|
74
|
-
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
75
|
-
|
76
|
-
new_options = opts.merge(
|
77
|
-
:operation => :"BroadcastApi.create_broadcast_message",
|
78
|
-
:header_params => header_params,
|
79
|
-
:query_params => query_params,
|
80
|
-
:form_params => form_params,
|
81
|
-
:body => post_body,
|
82
|
-
:auth_names => auth_names,
|
83
|
-
:return_type => return_type
|
84
|
-
)
|
85
|
-
|
86
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
87
|
-
if @api_client.config.debugging
|
88
|
-
@api_client.config.logger.debug "API called: BroadcastApi#create_broadcast_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
89
|
-
end
|
90
|
-
return data, status_code, headers
|
91
|
-
end
|
92
|
-
end
|
93
|
-
end
|