svix 0.83.1 → 0.84.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/lib/svix/api/application_api.rb +251 -181
- data/lib/svix/api/authentication_api.rb +84 -152
- data/lib/svix/api/background_tasks_api.rb +165 -0
- data/lib/svix/api/endpoint_api.rb +591 -511
- data/lib/svix/api/environment_api.rb +15 -15
- data/lib/svix/api/environment_settings_api.rb +7 -10
- data/lib/svix/api/event_type_api.rb +160 -85
- data/lib/svix/api/health_api.rb +7 -10
- data/lib/svix/api/integration_api.rb +136 -143
- data/lib/svix/api/message_api.rb +103 -105
- data/lib/svix/api/message_attempt_api.rb +419 -419
- data/lib/svix/api/statistics_api.rb +110 -48
- data/lib/svix/api_client.rb +1 -1
- data/lib/svix/api_error.rb +1 -1
- data/lib/svix/application_api.rb +22 -22
- data/lib/svix/authentication_api.rb +3 -3
- data/lib/svix/configuration.rb +2 -1
- data/lib/svix/endpoint_api.rb +16 -16
- data/lib/svix/event_type_api.rb +19 -19
- data/lib/svix/integration_api.rb +26 -26
- data/lib/svix/message_api.rb +4 -4
- data/lib/svix/message_attempt_api.rb +8 -8
- data/lib/svix/models/app_portal_access_in.rb +2 -1
- data/lib/svix/models/app_portal_access_out.rb +1 -1
- data/lib/svix/models/app_usage_stats_in.rb +255 -0
- data/lib/svix/models/app_usage_stats_out.rb +251 -0
- data/lib/svix/models/application_in.rb +35 -2
- data/lib/svix/models/application_out.rb +23 -3
- data/lib/svix/models/application_patch.rb +300 -0
- data/lib/svix/models/application_stats.rb +3 -2
- data/lib/svix/models/application_token_expire_in.rb +1 -1
- data/lib/svix/models/attempt_statistics_data.rb +1 -1
- data/lib/svix/models/attempt_statistics_response.rb +1 -1
- data/lib/svix/models/{webhook_types.rb → background_task_out.rb} +41 -70
- data/lib/svix/models/background_task_status.rb +38 -0
- data/lib/svix/models/background_task_type.rb +38 -0
- data/lib/svix/models/border_radius_config.rb +1 -1
- data/lib/svix/models/border_radius_enum.rb +1 -1
- data/lib/svix/models/custom_color_palette.rb +1 -1
- data/lib/svix/models/custom_theme_override.rb +1 -1
- data/lib/svix/models/dashboard_access_out.rb +1 -1
- data/lib/svix/models/endpoint_created_event.rb +6 -1
- data/lib/svix/models/endpoint_created_event_data.rb +5 -3
- data/lib/svix/models/endpoint_deleted_event.rb +6 -1
- data/lib/svix/models/endpoint_deleted_event_data.rb +5 -3
- data/lib/svix/models/endpoint_disabled_event.rb +6 -1
- data/lib/svix/models/endpoint_disabled_event_data.rb +6 -3
- data/lib/svix/models/endpoint_headers_in.rb +1 -1
- data/lib/svix/models/endpoint_headers_out.rb +1 -1
- data/lib/svix/models/endpoint_headers_patch_in.rb +1 -1
- data/lib/svix/models/endpoint_in.rb +20 -11
- data/lib/svix/models/endpoint_message_out.rb +4 -1
- data/lib/svix/models/endpoint_out.rb +35 -16
- data/lib/svix/models/endpoint_patch.rb +406 -0
- data/lib/svix/models/endpoint_secret_out.rb +1 -1
- data/lib/svix/models/endpoint_secret_rotate_in.rb +3 -1
- data/lib/svix/models/endpoint_stats.rb +1 -1
- data/lib/svix/models/endpoint_transformation_in.rb +1 -3
- data/lib/svix/models/endpoint_transformation_out.rb +1 -1
- data/lib/svix/models/endpoint_transformation_simulate_in.rb +8 -1
- data/lib/svix/models/endpoint_transformation_simulate_out.rb +1 -1
- data/lib/svix/models/endpoint_update.rb +20 -11
- data/lib/svix/models/endpoint_updated_event.rb +6 -1
- data/lib/svix/models/endpoint_updated_event_data.rb +5 -3
- data/lib/svix/models/environment_in.rb +1 -1
- data/lib/svix/models/environment_out.rb +1 -1
- data/lib/svix/models/environment_settings_out.rb +1 -1
- data/lib/svix/models/event_example_in.rb +2 -1
- data/lib/svix/models/event_type_example_out.rb +5 -3
- data/lib/svix/models/event_type_in.rb +2 -1
- data/lib/svix/models/event_type_out.rb +2 -1
- data/lib/svix/models/event_type_patch.rb +275 -0
- data/lib/svix/models/event_type_schema_in.rb +1 -2
- data/lib/svix/models/event_type_update.rb +1 -1
- data/lib/svix/models/font_size_config.rb +1 -1
- data/lib/svix/models/http_error_out.rb +1 -1
- data/lib/svix/models/http_validation_error.rb +6 -1
- data/lib/svix/models/integration_in.rb +1 -1
- data/lib/svix/models/integration_key_out.rb +1 -1
- data/lib/svix/models/integration_out.rb +2 -1
- data/lib/svix/models/integration_update.rb +1 -1
- data/lib/svix/models/list_response_application_out.rb +1 -1
- data/lib/svix/models/list_response_application_stats.rb +16 -6
- data/lib/svix/models/list_response_background_task_out.rb +259 -0
- data/lib/svix/models/list_response_endpoint_message_out.rb +1 -1
- data/lib/svix/models/list_response_endpoint_out.rb +1 -1
- data/lib/svix/models/list_response_event_type_out.rb +1 -1
- data/lib/svix/models/list_response_integration_out.rb +16 -6
- data/lib/svix/models/list_response_message_attempt_endpoint_out.rb +1 -1
- data/lib/svix/models/list_response_message_attempt_out.rb +1 -1
- data/lib/svix/models/list_response_message_endpoint_out.rb +16 -6
- data/lib/svix/models/list_response_message_out.rb +1 -1
- data/lib/svix/models/message_attempt_endpoint_out.rb +4 -1
- data/lib/svix/models/message_attempt_exhausted_event.rb +6 -1
- data/lib/svix/models/message_attempt_exhausted_event_data.rb +7 -3
- data/lib/svix/models/message_attempt_failed_data.rb +2 -1
- data/lib/svix/models/message_attempt_failing_event.rb +6 -1
- data/lib/svix/models/message_attempt_failing_event_data.rb +7 -3
- data/lib/svix/models/message_attempt_headers_out.rb +28 -2
- data/lib/svix/models/message_attempt_out.rb +4 -1
- data/lib/svix/models/message_attempt_trigger_type.rb +1 -1
- data/lib/svix/models/message_endpoint_out.rb +47 -30
- data/lib/svix/models/message_in.rb +2 -2
- data/lib/svix/models/message_out.rb +3 -1
- data/lib/svix/models/message_status.rb +1 -1
- data/lib/svix/models/ordering.rb +1 -1
- data/lib/svix/models/recover_in.rb +1 -1
- data/lib/svix/models/{one_time_token_out.rb → recover_out.rb} +42 -14
- data/lib/svix/models/replay_in.rb +1 -1
- data/lib/svix/models/{one_time_token_in.rb → replay_out.rb} +42 -14
- data/lib/svix/models/settings_in.rb +1 -1
- data/lib/svix/models/settings_out.rb +1 -1
- data/lib/svix/models/statistics_period.rb +1 -1
- data/lib/svix/models/status_code_class.rb +1 -1
- data/lib/svix/models/transformation_http_method.rb +2 -2
- data/lib/svix/models/validation_error.rb +5 -1
- data/lib/svix/version.rb +1 -1
- metadata +14 -5
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -20,16 +20,16 @@ module Svix
|
|
20
20
|
|
21
21
|
attr_accessor :created_at
|
22
22
|
|
23
|
+
# An example endpoint name
|
23
24
|
attr_accessor :description
|
24
25
|
|
25
26
|
attr_accessor :disabled
|
26
27
|
|
27
28
|
attr_accessor :filter_types
|
28
29
|
|
30
|
+
# The ep's ID
|
29
31
|
attr_accessor :id
|
30
32
|
|
31
|
-
attr_accessor :metadata
|
32
|
-
|
33
33
|
attr_accessor :next_attempt
|
34
34
|
|
35
35
|
attr_accessor :rate_limit
|
@@ -39,6 +39,8 @@ module Svix
|
|
39
39
|
# Optional unique identifier for the endpoint
|
40
40
|
attr_accessor :uid
|
41
41
|
|
42
|
+
attr_accessor :updated_at
|
43
|
+
|
42
44
|
attr_accessor :url
|
43
45
|
|
44
46
|
attr_accessor :version
|
@@ -52,11 +54,11 @@ module Svix
|
|
52
54
|
:'disabled' => :'disabled',
|
53
55
|
:'filter_types' => :'filterTypes',
|
54
56
|
:'id' => :'id',
|
55
|
-
:'metadata' => :'metadata',
|
56
57
|
:'next_attempt' => :'nextAttempt',
|
57
58
|
:'rate_limit' => :'rateLimit',
|
58
59
|
:'status' => :'status',
|
59
60
|
:'uid' => :'uid',
|
61
|
+
:'updated_at' => :'updatedAt',
|
60
62
|
:'url' => :'url',
|
61
63
|
:'version' => :'version'
|
62
64
|
}
|
@@ -76,11 +78,11 @@ module Svix
|
|
76
78
|
:'disabled' => :'Boolean',
|
77
79
|
:'filter_types' => :'Array<String>',
|
78
80
|
:'id' => :'String',
|
79
|
-
:'metadata' => :'Hash<String, String>',
|
80
81
|
:'next_attempt' => :'Time',
|
81
82
|
:'rate_limit' => :'Integer',
|
82
83
|
:'status' => :'MessageStatus',
|
83
84
|
:'uid' => :'String',
|
85
|
+
:'updated_at' => :'Time',
|
84
86
|
:'url' => :'String',
|
85
87
|
:'version' => :'Integer'
|
86
88
|
}
|
@@ -91,7 +93,6 @@ module Svix
|
|
91
93
|
Set.new([
|
92
94
|
:'channels',
|
93
95
|
:'filter_types',
|
94
|
-
:'metadata',
|
95
96
|
:'next_attempt',
|
96
97
|
:'rate_limit',
|
97
98
|
:'uid',
|
@@ -125,8 +126,6 @@ module Svix
|
|
125
126
|
|
126
127
|
if attributes.key?(:'description')
|
127
128
|
self.description = attributes[:'description']
|
128
|
-
else
|
129
|
-
self.description = ''
|
130
129
|
end
|
131
130
|
|
132
131
|
if attributes.key?(:'disabled')
|
@@ -145,12 +144,6 @@ module Svix
|
|
145
144
|
self.id = attributes[:'id']
|
146
145
|
end
|
147
146
|
|
148
|
-
if attributes.key?(:'metadata')
|
149
|
-
if (value = attributes[:'metadata']).is_a?(Hash)
|
150
|
-
self.metadata = value
|
151
|
-
end
|
152
|
-
end
|
153
|
-
|
154
147
|
if attributes.key?(:'next_attempt')
|
155
148
|
self.next_attempt = attributes[:'next_attempt']
|
156
149
|
end
|
@@ -167,6 +160,10 @@ module Svix
|
|
167
160
|
self.uid = attributes[:'uid']
|
168
161
|
end
|
169
162
|
|
163
|
+
if attributes.key?(:'updated_at')
|
164
|
+
self.updated_at = attributes[:'updated_at']
|
165
|
+
end
|
166
|
+
|
170
167
|
if attributes.key?(:'url')
|
171
168
|
self.url = attributes[:'url']
|
172
169
|
end
|
@@ -192,6 +189,10 @@ module Svix
|
|
192
189
|
invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
|
193
190
|
end
|
194
191
|
|
192
|
+
if @description.nil?
|
193
|
+
invalid_properties.push('invalid value for "description", description cannot be nil.')
|
194
|
+
end
|
195
|
+
|
195
196
|
if !@filter_types.nil? && @filter_types.length < 1
|
196
197
|
invalid_properties.push('invalid value for "filter_types", number of items must be greater than or equal to 1.')
|
197
198
|
end
|
@@ -200,12 +201,8 @@ module Svix
|
|
200
201
|
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
201
202
|
end
|
202
203
|
|
203
|
-
if !@rate_limit.nil? && @rate_limit
|
204
|
-
invalid_properties.push('invalid value for "rate_limit", must be
|
205
|
-
end
|
206
|
-
|
207
|
-
if !@rate_limit.nil? && @rate_limit < 1
|
208
|
-
invalid_properties.push('invalid value for "rate_limit", must be greater than or equal to 1.')
|
204
|
+
if !@rate_limit.nil? && @rate_limit < 0
|
205
|
+
invalid_properties.push('invalid value for "rate_limit", must be greater than or equal to 0.')
|
209
206
|
end
|
210
207
|
|
211
208
|
if @status.nil?
|
@@ -225,6 +222,10 @@ module Svix
|
|
225
222
|
invalid_properties.push("invalid value for \"uid\", must conform to the pattern #{pattern}.")
|
226
223
|
end
|
227
224
|
|
225
|
+
if @updated_at.nil?
|
226
|
+
invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
|
227
|
+
end
|
228
|
+
|
228
229
|
if @url.nil?
|
229
230
|
invalid_properties.push('invalid value for "url", url cannot be nil.')
|
230
231
|
end
|
@@ -241,6 +242,10 @@ module Svix
|
|
241
242
|
invalid_properties.push('invalid value for "version", version cannot be nil.')
|
242
243
|
end
|
243
244
|
|
245
|
+
if @version < 1
|
246
|
+
invalid_properties.push('invalid value for "version", must be greater than or equal to 1.')
|
247
|
+
end
|
248
|
+
|
244
249
|
invalid_properties
|
245
250
|
end
|
246
251
|
|
@@ -250,18 +255,20 @@ module Svix
|
|
250
255
|
return false if !@channels.nil? && @channels.length > 10
|
251
256
|
return false if !@channels.nil? && @channels.length < 1
|
252
257
|
return false if @created_at.nil?
|
258
|
+
return false if @description.nil?
|
253
259
|
return false if !@filter_types.nil? && @filter_types.length < 1
|
254
260
|
return false if @id.nil?
|
255
|
-
return false if !@rate_limit.nil? && @rate_limit
|
256
|
-
return false if !@rate_limit.nil? && @rate_limit < 1
|
261
|
+
return false if !@rate_limit.nil? && @rate_limit < 0
|
257
262
|
return false if @status.nil?
|
258
263
|
return false if !@uid.nil? && @uid.to_s.length > 256
|
259
264
|
return false if !@uid.nil? && @uid.to_s.length < 1
|
260
265
|
return false if !@uid.nil? && @uid !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
|
266
|
+
return false if @updated_at.nil?
|
261
267
|
return false if @url.nil?
|
262
268
|
return false if @url.to_s.length > 65536
|
263
269
|
return false if @url.to_s.length < 1
|
264
270
|
return false if @version.nil?
|
271
|
+
return false if @version < 1
|
265
272
|
true
|
266
273
|
end
|
267
274
|
|
@@ -292,12 +299,8 @@ module Svix
|
|
292
299
|
# Custom attribute writer method with validation
|
293
300
|
# @param [Object] rate_limit Value to be assigned
|
294
301
|
def rate_limit=(rate_limit)
|
295
|
-
if !rate_limit.nil? && rate_limit
|
296
|
-
fail ArgumentError, 'invalid value for "rate_limit", must be
|
297
|
-
end
|
298
|
-
|
299
|
-
if !rate_limit.nil? && rate_limit < 1
|
300
|
-
fail ArgumentError, 'invalid value for "rate_limit", must be greater than or equal to 1.'
|
302
|
+
if !rate_limit.nil? && rate_limit < 0
|
303
|
+
fail ArgumentError, 'invalid value for "rate_limit", must be greater than or equal to 0.'
|
301
304
|
end
|
302
305
|
|
303
306
|
@rate_limit = rate_limit
|
@@ -340,6 +343,20 @@ module Svix
|
|
340
343
|
@url = url
|
341
344
|
end
|
342
345
|
|
346
|
+
# Custom attribute writer method with validation
|
347
|
+
# @param [Object] version Value to be assigned
|
348
|
+
def version=(version)
|
349
|
+
if version.nil?
|
350
|
+
fail ArgumentError, 'version cannot be nil'
|
351
|
+
end
|
352
|
+
|
353
|
+
if version < 1
|
354
|
+
fail ArgumentError, 'invalid value for "version", must be greater than or equal to 1.'
|
355
|
+
end
|
356
|
+
|
357
|
+
@version = version
|
358
|
+
end
|
359
|
+
|
343
360
|
# Checks equality by comparing each attribute.
|
344
361
|
# @param [Object] Object to be compared
|
345
362
|
def ==(o)
|
@@ -351,11 +368,11 @@ module Svix
|
|
351
368
|
disabled == o.disabled &&
|
352
369
|
filter_types == o.filter_types &&
|
353
370
|
id == o.id &&
|
354
|
-
metadata == o.metadata &&
|
355
371
|
next_attempt == o.next_attempt &&
|
356
372
|
rate_limit == o.rate_limit &&
|
357
373
|
status == o.status &&
|
358
374
|
uid == o.uid &&
|
375
|
+
updated_at == o.updated_at &&
|
359
376
|
url == o.url &&
|
360
377
|
version == o.version
|
361
378
|
end
|
@@ -369,7 +386,7 @@ module Svix
|
|
369
386
|
# Calculates hash code according to all attributes.
|
370
387
|
# @return [Integer] Hash code
|
371
388
|
def hash
|
372
|
-
[channels, created_at, description, disabled, filter_types, id,
|
389
|
+
[channels, created_at, description, disabled, filter_types, id, next_attempt, rate_limit, status, uid, updated_at, url, version].hash
|
373
390
|
end
|
374
391
|
|
375
392
|
# Builds the object from hash
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -23,11 +23,11 @@ module Svix
|
|
23
23
|
# Optional unique identifier for the message
|
24
24
|
attr_accessor :event_id
|
25
25
|
|
26
|
+
# The event type's name
|
26
27
|
attr_accessor :event_type
|
27
28
|
|
28
29
|
attr_accessor :payload
|
29
30
|
|
30
|
-
# The retention period for the payload (in days).
|
31
31
|
attr_accessor :payload_retention_period
|
32
32
|
|
33
33
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -21,8 +21,10 @@ module Svix
|
|
21
21
|
# Optional unique identifier for the message
|
22
22
|
attr_accessor :event_id
|
23
23
|
|
24
|
+
# The event type's name
|
24
25
|
attr_accessor :event_type
|
25
26
|
|
27
|
+
# The msg's ID
|
26
28
|
attr_accessor :id
|
27
29
|
|
28
30
|
attr_accessor :payload
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
data/lib/svix/models/ordering.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -14,13 +14,19 @@ require 'date'
|
|
14
14
|
require 'time'
|
15
15
|
|
16
16
|
module Svix
|
17
|
-
class
|
18
|
-
attr_accessor :
|
17
|
+
class RecoverOut
|
18
|
+
attr_accessor :id
|
19
|
+
|
20
|
+
attr_accessor :status
|
21
|
+
|
22
|
+
attr_accessor :task
|
19
23
|
|
20
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
21
25
|
def self.attribute_map
|
22
26
|
{
|
23
|
-
:'
|
27
|
+
:'id' => :'id',
|
28
|
+
:'status' => :'status',
|
29
|
+
:'task' => :'task'
|
24
30
|
}
|
25
31
|
end
|
26
32
|
|
@@ -32,7 +38,9 @@ module Svix
|
|
32
38
|
# Attribute type mapping.
|
33
39
|
def self.openapi_types
|
34
40
|
{
|
35
|
-
:'
|
41
|
+
:'id' => :'String',
|
42
|
+
:'status' => :'BackgroundTaskStatus',
|
43
|
+
:'task' => :'BackgroundTaskType'
|
36
44
|
}
|
37
45
|
end
|
38
46
|
|
@@ -46,19 +54,27 @@ module Svix
|
|
46
54
|
# @param [Hash] attributes Model attributes in the form of hash
|
47
55
|
def initialize(attributes = {})
|
48
56
|
if (!attributes.is_a?(Hash))
|
49
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::
|
57
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::RecoverOut` initialize method"
|
50
58
|
end
|
51
59
|
|
52
60
|
# check to see if the attribute exists and convert string to symbol for hash key
|
53
61
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
54
62
|
if (!self.class.attribute_map.key?(k.to_sym))
|
55
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::
|
63
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::RecoverOut`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
56
64
|
end
|
57
65
|
h[k.to_sym] = v
|
58
66
|
}
|
59
67
|
|
60
|
-
if attributes.key?(:'
|
61
|
-
self.
|
68
|
+
if attributes.key?(:'id')
|
69
|
+
self.id = attributes[:'id']
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.key?(:'status')
|
73
|
+
self.status = attributes[:'status']
|
74
|
+
end
|
75
|
+
|
76
|
+
if attributes.key?(:'task')
|
77
|
+
self.task = attributes[:'task']
|
62
78
|
end
|
63
79
|
end
|
64
80
|
|
@@ -66,8 +82,16 @@ module Svix
|
|
66
82
|
# @return Array for valid properties with the reasons
|
67
83
|
def list_invalid_properties
|
68
84
|
invalid_properties = Array.new
|
69
|
-
if @
|
70
|
-
invalid_properties.push('invalid value for "
|
85
|
+
if @id.nil?
|
86
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
87
|
+
end
|
88
|
+
|
89
|
+
if @status.nil?
|
90
|
+
invalid_properties.push('invalid value for "status", status cannot be nil.')
|
91
|
+
end
|
92
|
+
|
93
|
+
if @task.nil?
|
94
|
+
invalid_properties.push('invalid value for "task", task cannot be nil.')
|
71
95
|
end
|
72
96
|
|
73
97
|
invalid_properties
|
@@ -76,7 +100,9 @@ module Svix
|
|
76
100
|
# Check to see if the all the properties in the model are valid
|
77
101
|
# @return true if the model is valid
|
78
102
|
def valid?
|
79
|
-
return false if @
|
103
|
+
return false if @id.nil?
|
104
|
+
return false if @status.nil?
|
105
|
+
return false if @task.nil?
|
80
106
|
true
|
81
107
|
end
|
82
108
|
|
@@ -85,7 +111,9 @@ module Svix
|
|
85
111
|
def ==(o)
|
86
112
|
return true if self.equal?(o)
|
87
113
|
self.class == o.class &&
|
88
|
-
|
114
|
+
id == o.id &&
|
115
|
+
status == o.status &&
|
116
|
+
task == o.task
|
89
117
|
end
|
90
118
|
|
91
119
|
# @see the `==` method
|
@@ -97,7 +125,7 @@ module Svix
|
|
97
125
|
# Calculates hash code according to all attributes.
|
98
126
|
# @return [Integer] Hash code
|
99
127
|
def hash
|
100
|
-
[
|
128
|
+
[id, status, task].hash
|
101
129
|
end
|
102
130
|
|
103
131
|
# Builds the object from hash
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -14,13 +14,19 @@ require 'date'
|
|
14
14
|
require 'time'
|
15
15
|
|
16
16
|
module Svix
|
17
|
-
class
|
18
|
-
attr_accessor :
|
17
|
+
class ReplayOut
|
18
|
+
attr_accessor :id
|
19
|
+
|
20
|
+
attr_accessor :status
|
21
|
+
|
22
|
+
attr_accessor :task
|
19
23
|
|
20
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
21
25
|
def self.attribute_map
|
22
26
|
{
|
23
|
-
:'
|
27
|
+
:'id' => :'id',
|
28
|
+
:'status' => :'status',
|
29
|
+
:'task' => :'task'
|
24
30
|
}
|
25
31
|
end
|
26
32
|
|
@@ -32,7 +38,9 @@ module Svix
|
|
32
38
|
# Attribute type mapping.
|
33
39
|
def self.openapi_types
|
34
40
|
{
|
35
|
-
:'
|
41
|
+
:'id' => :'String',
|
42
|
+
:'status' => :'BackgroundTaskStatus',
|
43
|
+
:'task' => :'BackgroundTaskType'
|
36
44
|
}
|
37
45
|
end
|
38
46
|
|
@@ -46,19 +54,27 @@ module Svix
|
|
46
54
|
# @param [Hash] attributes Model attributes in the form of hash
|
47
55
|
def initialize(attributes = {})
|
48
56
|
if (!attributes.is_a?(Hash))
|
49
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::
|
57
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::ReplayOut` initialize method"
|
50
58
|
end
|
51
59
|
|
52
60
|
# check to see if the attribute exists and convert string to symbol for hash key
|
53
61
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
54
62
|
if (!self.class.attribute_map.key?(k.to_sym))
|
55
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::
|
63
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::ReplayOut`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
56
64
|
end
|
57
65
|
h[k.to_sym] = v
|
58
66
|
}
|
59
67
|
|
60
|
-
if attributes.key?(:'
|
61
|
-
self.
|
68
|
+
if attributes.key?(:'id')
|
69
|
+
self.id = attributes[:'id']
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.key?(:'status')
|
73
|
+
self.status = attributes[:'status']
|
74
|
+
end
|
75
|
+
|
76
|
+
if attributes.key?(:'task')
|
77
|
+
self.task = attributes[:'task']
|
62
78
|
end
|
63
79
|
end
|
64
80
|
|
@@ -66,8 +82,16 @@ module Svix
|
|
66
82
|
# @return Array for valid properties with the reasons
|
67
83
|
def list_invalid_properties
|
68
84
|
invalid_properties = Array.new
|
69
|
-
if @
|
70
|
-
invalid_properties.push('invalid value for "
|
85
|
+
if @id.nil?
|
86
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
87
|
+
end
|
88
|
+
|
89
|
+
if @status.nil?
|
90
|
+
invalid_properties.push('invalid value for "status", status cannot be nil.')
|
91
|
+
end
|
92
|
+
|
93
|
+
if @task.nil?
|
94
|
+
invalid_properties.push('invalid value for "task", task cannot be nil.')
|
71
95
|
end
|
72
96
|
|
73
97
|
invalid_properties
|
@@ -76,7 +100,9 @@ module Svix
|
|
76
100
|
# Check to see if the all the properties in the model are valid
|
77
101
|
# @return true if the model is valid
|
78
102
|
def valid?
|
79
|
-
return false if @
|
103
|
+
return false if @id.nil?
|
104
|
+
return false if @status.nil?
|
105
|
+
return false if @task.nil?
|
80
106
|
true
|
81
107
|
end
|
82
108
|
|
@@ -85,7 +111,9 @@ module Svix
|
|
85
111
|
def ==(o)
|
86
112
|
return true if self.equal?(o)
|
87
113
|
self.class == o.class &&
|
88
|
-
|
114
|
+
id == o.id &&
|
115
|
+
status == o.status &&
|
116
|
+
task == o.task
|
89
117
|
end
|
90
118
|
|
91
119
|
# @see the `==` method
|
@@ -97,7 +125,7 @@ module Svix
|
|
97
125
|
# Calculates hash code according to all attributes.
|
98
126
|
# @return [Integer] Hash code
|
99
127
|
def hash
|
100
|
-
[
|
128
|
+
[id, status, task].hash
|
101
129
|
end
|
102
130
|
|
103
131
|
# Builds the object from hash
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Svix API documentation! Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/) # Introduction This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com). ## Main concepts In Svix you have four important entities you will be interacting with: - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint. ## Authentication Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`. <SecurityDefinitions /> ## Code samples The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/). ## Idempotency Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions. Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result. Please note that idempotency is only supported for `POST` requests. ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.4
|
6
|
+
The version of the OpenAPI document: 1.4.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.2.0
|