svix 1.7.0 → 1.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (129) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/lib/svix/api/application_api.rb +1 -1
  4. data/lib/svix/api/authentication_api.rb +1 -1
  5. data/lib/svix/api/background_tasks_api.rb +1 -1
  6. data/lib/svix/api/broadcast_api.rb +1 -1
  7. data/lib/svix/api/endpoint_api.rb +1 -1
  8. data/lib/svix/api/environment_api.rb +1 -1
  9. data/lib/svix/api/environment_settings_api.rb +1 -1
  10. data/lib/svix/api/event_type_api.rb +1 -1
  11. data/lib/svix/api/health_api.rb +1 -1
  12. data/lib/svix/api/integration_api.rb +1 -1
  13. data/lib/svix/api/message_api.rb +3 -3
  14. data/lib/svix/api/message_attempt_api.rb +21 -12
  15. data/lib/svix/api/statistics_api.rb +1 -1
  16. data/lib/svix/api/transformation_template_api.rb +500 -0
  17. data/lib/svix/api_client.rb +1 -1
  18. data/lib/svix/api_error.rb +1 -1
  19. data/lib/svix/configuration.rb +1 -1
  20. data/lib/svix/models/app_portal_access_in.rb +1 -1
  21. data/lib/svix/models/app_portal_access_out.rb +1 -1
  22. data/lib/svix/models/app_usage_stats_in.rb +1 -1
  23. data/lib/svix/models/app_usage_stats_out.rb +1 -1
  24. data/lib/svix/models/application_in.rb +1 -1
  25. data/lib/svix/models/application_out.rb +1 -1
  26. data/lib/svix/models/application_patch.rb +1 -1
  27. data/lib/svix/models/application_stats.rb +1 -1
  28. data/lib/svix/models/application_token_expire_in.rb +1 -1
  29. data/lib/svix/models/attempt_statistics_data.rb +1 -1
  30. data/lib/svix/models/attempt_statistics_response.rb +1 -1
  31. data/lib/svix/models/background_task_out.rb +1 -1
  32. data/lib/svix/models/background_task_status.rb +1 -1
  33. data/lib/svix/models/background_task_type.rb +1 -1
  34. data/lib/svix/models/border_radius_config.rb +1 -1
  35. data/lib/svix/models/border_radius_enum.rb +1 -1
  36. data/lib/svix/models/custom_color_palette.rb +1 -1
  37. data/lib/svix/models/custom_theme_override.rb +1 -1
  38. data/lib/svix/models/dashboard_access_out.rb +1 -1
  39. data/lib/svix/models/endpoint_created_event.rb +1 -1
  40. data/lib/svix/models/endpoint_created_event_data.rb +1 -1
  41. data/lib/svix/models/endpoint_deleted_event.rb +1 -1
  42. data/lib/svix/models/endpoint_deleted_event_data.rb +1 -1
  43. data/lib/svix/models/endpoint_disabled_event.rb +1 -1
  44. data/lib/svix/models/endpoint_disabled_event_data.rb +1 -1
  45. data/lib/svix/models/endpoint_headers_in.rb +1 -1
  46. data/lib/svix/models/endpoint_headers_out.rb +1 -1
  47. data/lib/svix/models/endpoint_headers_patch_in.rb +1 -1
  48. data/lib/svix/models/endpoint_in.rb +7 -13
  49. data/lib/svix/models/endpoint_message_out.rb +1 -1
  50. data/lib/svix/models/endpoint_out.rb +1 -1
  51. data/lib/svix/models/endpoint_patch.rb +6 -6
  52. data/lib/svix/models/endpoint_secret_out.rb +1 -1
  53. data/lib/svix/models/endpoint_secret_rotate_in.rb +1 -1
  54. data/lib/svix/models/endpoint_stats.rb +1 -1
  55. data/lib/svix/models/endpoint_transformation_in.rb +1 -1
  56. data/lib/svix/models/endpoint_transformation_out.rb +1 -1
  57. data/lib/svix/models/endpoint_transformation_simulate_in.rb +1 -1
  58. data/lib/svix/models/endpoint_transformation_simulate_out.rb +1 -1
  59. data/lib/svix/models/endpoint_update.rb +7 -13
  60. data/lib/svix/models/endpoint_updated_event.rb +1 -1
  61. data/lib/svix/models/endpoint_updated_event_data.rb +1 -1
  62. data/lib/svix/models/environment_in.rb +1 -1
  63. data/lib/svix/models/environment_out.rb +1 -1
  64. data/lib/svix/models/environment_settings_out.rb +1 -1
  65. data/lib/svix/models/event_example_in.rb +1 -1
  66. data/lib/svix/models/event_type_example_out.rb +1 -1
  67. data/lib/svix/models/event_type_in.rb +1 -1
  68. data/lib/svix/models/event_type_out.rb +1 -1
  69. data/lib/svix/models/event_type_patch.rb +1 -1
  70. data/lib/svix/models/event_type_schema_in.rb +1 -1
  71. data/lib/svix/models/event_type_update.rb +1 -1
  72. data/lib/svix/models/font_size_config.rb +1 -1
  73. data/lib/svix/models/http_error_out.rb +1 -1
  74. data/lib/svix/models/http_validation_error.rb +1 -1
  75. data/lib/svix/models/integration_in.rb +1 -1
  76. data/lib/svix/models/integration_key_out.rb +1 -1
  77. data/lib/svix/models/integration_out.rb +1 -1
  78. data/lib/svix/models/integration_update.rb +1 -1
  79. data/lib/svix/models/list_response_application_out.rb +1 -1
  80. data/lib/svix/models/list_response_application_stats.rb +1 -1
  81. data/lib/svix/models/list_response_background_task_out.rb +1 -1
  82. data/lib/svix/models/list_response_endpoint_message_out.rb +1 -1
  83. data/lib/svix/models/list_response_endpoint_out.rb +1 -1
  84. data/lib/svix/models/list_response_event_type_out.rb +1 -1
  85. data/lib/svix/models/list_response_integration_out.rb +1 -1
  86. data/lib/svix/models/list_response_message_attempt_endpoint_out.rb +1 -1
  87. data/lib/svix/models/list_response_message_attempt_out.rb +1 -1
  88. data/lib/svix/models/list_response_message_endpoint_out.rb +1 -1
  89. data/lib/svix/models/list_response_message_out.rb +1 -1
  90. data/lib/svix/models/list_response_template_out.rb +259 -0
  91. data/lib/svix/models/message_attempt_endpoint_out.rb +1 -1
  92. data/lib/svix/models/message_attempt_exhausted_event.rb +1 -1
  93. data/lib/svix/models/message_attempt_exhausted_event_data.rb +1 -1
  94. data/lib/svix/models/message_attempt_failed_data.rb +1 -1
  95. data/lib/svix/models/message_attempt_failing_event.rb +1 -1
  96. data/lib/svix/models/message_attempt_failing_event_data.rb +1 -1
  97. data/lib/svix/models/message_attempt_headers_out.rb +1 -1
  98. data/lib/svix/models/message_attempt_out.rb +1 -1
  99. data/lib/svix/models/message_attempt_recovered_event.rb +274 -0
  100. data/lib/svix/models/message_attempt_recovered_event_data.rb +361 -0
  101. data/lib/svix/models/message_attempt_trigger_type.rb +1 -1
  102. data/lib/svix/models/message_broadcast_in.rb +1 -1
  103. data/lib/svix/models/message_broadcast_out.rb +1 -1
  104. data/lib/svix/models/message_endpoint_out.rb +1 -1
  105. data/lib/svix/models/message_in.rb +1 -1
  106. data/lib/svix/models/message_out.rb +1 -1
  107. data/lib/svix/models/message_status.rb +1 -1
  108. data/lib/svix/models/one_time_token_in.rb +1 -1
  109. data/lib/svix/models/one_time_token_out.rb +1 -1
  110. data/lib/svix/models/ordering.rb +1 -1
  111. data/lib/svix/models/recover_in.rb +1 -1
  112. data/lib/svix/models/recover_out.rb +1 -1
  113. data/lib/svix/models/replay_in.rb +1 -1
  114. data/lib/svix/models/replay_out.rb +1 -1
  115. data/lib/svix/models/settings_in.rb +1 -1
  116. data/lib/svix/models/settings_out.rb +1 -1
  117. data/lib/svix/models/statistics_period.rb +1 -1
  118. data/lib/svix/models/status_code_class.rb +1 -1
  119. data/lib/svix/models/template_in.rb +340 -0
  120. data/lib/svix/models/template_out.rb +386 -0
  121. data/lib/svix/models/template_patch.rb +315 -0
  122. data/lib/svix/models/template_update.rb +335 -0
  123. data/lib/svix/models/transformation_http_method.rb +1 -1
  124. data/lib/svix/models/transformation_simulate_in.rb +328 -0
  125. data/lib/svix/models/transformation_simulate_out.rb +274 -0
  126. data/lib/svix/models/transformation_template_kind.rb +36 -0
  127. data/lib/svix/models/validation_error.rb +1 -1
  128. data/lib/svix/version.rb +1 -1
  129. metadata +13 -2
@@ -0,0 +1,335 @@
1
+ =begin
2
+ #Svix API
3
+
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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
+
6
+ The version of the OpenAPI document: 1.7.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.2.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Svix
17
+ class TemplateUpdate
18
+ attr_accessor :description
19
+
20
+ attr_accessor :filter_types
21
+
22
+ attr_accessor :instructions
23
+
24
+ attr_accessor :instructions_link
25
+
26
+ attr_accessor :logo
27
+
28
+ attr_accessor :name
29
+
30
+ attr_accessor :transformation
31
+
32
+ # Attribute mapping from ruby-style variable name to JSON key.
33
+ def self.attribute_map
34
+ {
35
+ :'description' => :'description',
36
+ :'filter_types' => :'filterTypes',
37
+ :'instructions' => :'instructions',
38
+ :'instructions_link' => :'instructionsLink',
39
+ :'logo' => :'logo',
40
+ :'name' => :'name',
41
+ :'transformation' => :'transformation'
42
+ }
43
+ end
44
+
45
+ # Returns all the JSON keys this model knows about
46
+ def self.acceptable_attributes
47
+ attribute_map.values
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.openapi_types
52
+ {
53
+ :'description' => :'String',
54
+ :'filter_types' => :'Array<String>',
55
+ :'instructions' => :'String',
56
+ :'instructions_link' => :'String',
57
+ :'logo' => :'String',
58
+ :'name' => :'String',
59
+ :'transformation' => :'String'
60
+ }
61
+ end
62
+
63
+ # List of attributes with nullable: true
64
+ def self.openapi_nullable
65
+ Set.new([
66
+ :'filter_types',
67
+ :'instructions_link',
68
+ ])
69
+ end
70
+
71
+ # Initializes the object
72
+ # @param [Hash] attributes Model attributes in the form of hash
73
+ def initialize(attributes = {})
74
+ if (!attributes.is_a?(Hash))
75
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::TemplateUpdate` initialize method"
76
+ end
77
+
78
+ # check to see if the attribute exists and convert string to symbol for hash key
79
+ attributes = attributes.each_with_object({}) { |(k, v), h|
80
+ if (!self.class.attribute_map.key?(k.to_sym))
81
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::TemplateUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
82
+ end
83
+ h[k.to_sym] = v
84
+ }
85
+
86
+ if attributes.key?(:'description')
87
+ self.description = attributes[:'description']
88
+ else
89
+ self.description = ''
90
+ end
91
+
92
+ if attributes.key?(:'filter_types')
93
+ if (value = attributes[:'filter_types']).is_a?(Array)
94
+ self.filter_types = value
95
+ end
96
+ end
97
+
98
+ if attributes.key?(:'instructions')
99
+ self.instructions = attributes[:'instructions']
100
+ else
101
+ self.instructions = ''
102
+ end
103
+
104
+ if attributes.key?(:'instructions_link')
105
+ self.instructions_link = attributes[:'instructions_link']
106
+ end
107
+
108
+ if attributes.key?(:'logo')
109
+ self.logo = attributes[:'logo']
110
+ end
111
+
112
+ if attributes.key?(:'name')
113
+ self.name = attributes[:'name']
114
+ else
115
+ self.name = ''
116
+ end
117
+
118
+ if attributes.key?(:'transformation')
119
+ self.transformation = attributes[:'transformation']
120
+ end
121
+ end
122
+
123
+ # Show invalid properties with the reasons. Usually used together with valid?
124
+ # @return Array for valid properties with the reasons
125
+ def list_invalid_properties
126
+ invalid_properties = Array.new
127
+ if !@filter_types.nil? && @filter_types.length < 1
128
+ invalid_properties.push('invalid value for "filter_types", number of items must be greater than or equal to 1.')
129
+ end
130
+
131
+ if @logo.nil?
132
+ invalid_properties.push('invalid value for "logo", logo cannot be nil.')
133
+ end
134
+
135
+ if @transformation.nil?
136
+ invalid_properties.push('invalid value for "transformation", transformation cannot be nil.')
137
+ end
138
+
139
+ if @transformation.to_s.length > 51200
140
+ invalid_properties.push('invalid value for "transformation", the character length must be smaller than or equal to 51200.')
141
+ end
142
+
143
+ if @transformation.to_s.length < 10
144
+ invalid_properties.push('invalid value for "transformation", the character length must be great than or equal to 10.')
145
+ end
146
+
147
+ invalid_properties
148
+ end
149
+
150
+ # Check to see if the all the properties in the model are valid
151
+ # @return true if the model is valid
152
+ def valid?
153
+ return false if !@filter_types.nil? && @filter_types.length < 1
154
+ return false if @logo.nil?
155
+ return false if @transformation.nil?
156
+ return false if @transformation.to_s.length > 51200
157
+ return false if @transformation.to_s.length < 10
158
+ true
159
+ end
160
+
161
+ # Custom attribute writer method with validation
162
+ # @param [Object] filter_types Value to be assigned
163
+ def filter_types=(filter_types)
164
+ if !filter_types.nil? && filter_types.length < 1
165
+ fail ArgumentError, 'invalid value for "filter_types", number of items must be greater than or equal to 1.'
166
+ end
167
+
168
+ @filter_types = filter_types
169
+ end
170
+
171
+ # Custom attribute writer method with validation
172
+ # @param [Object] transformation Value to be assigned
173
+ def transformation=(transformation)
174
+ if transformation.nil?
175
+ fail ArgumentError, 'transformation cannot be nil'
176
+ end
177
+
178
+ if transformation.to_s.length > 51200
179
+ fail ArgumentError, 'invalid value for "transformation", the character length must be smaller than or equal to 51200.'
180
+ end
181
+
182
+ if transformation.to_s.length < 10
183
+ fail ArgumentError, 'invalid value for "transformation", the character length must be great than or equal to 10.'
184
+ end
185
+
186
+ @transformation = transformation
187
+ end
188
+
189
+ # Checks equality by comparing each attribute.
190
+ # @param [Object] Object to be compared
191
+ def ==(o)
192
+ return true if self.equal?(o)
193
+ self.class == o.class &&
194
+ description == o.description &&
195
+ filter_types == o.filter_types &&
196
+ instructions == o.instructions &&
197
+ instructions_link == o.instructions_link &&
198
+ logo == o.logo &&
199
+ name == o.name &&
200
+ transformation == o.transformation
201
+ end
202
+
203
+ # @see the `==` method
204
+ # @param [Object] Object to be compared
205
+ def eql?(o)
206
+ self == o
207
+ end
208
+
209
+ # Calculates hash code according to all attributes.
210
+ # @return [Integer] Hash code
211
+ def hash
212
+ [description, filter_types, instructions, instructions_link, logo, name, transformation].hash
213
+ end
214
+
215
+ # Builds the object from hash
216
+ # @param [Hash] attributes Model attributes in the form of hash
217
+ # @return [Object] Returns the model itself
218
+ def self.build_from_hash(attributes)
219
+ new.build_from_hash(attributes)
220
+ end
221
+
222
+ # Builds the object from hash
223
+ # @param [Hash] attributes Model attributes in the form of hash
224
+ # @return [Object] Returns the model itself
225
+ def build_from_hash(attributes)
226
+ return nil unless attributes.is_a?(Hash)
227
+ self.class.openapi_types.each_pair do |key, type|
228
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
229
+ self.send("#{key}=", nil)
230
+ elsif type =~ /\AArray<(.*)>/i
231
+ # check to ensure the input is an array given that the attribute
232
+ # is documented as an array but the input is not
233
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
234
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
235
+ end
236
+ elsif !attributes[self.class.attribute_map[key]].nil?
237
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
238
+ end
239
+ end
240
+
241
+ self
242
+ end
243
+
244
+ # Deserializes the data based on type
245
+ # @param string type Data type
246
+ # @param string value Value to be deserialized
247
+ # @return [Object] Deserialized data
248
+ def _deserialize(type, value)
249
+ case type.to_sym
250
+ when :Time
251
+ Time.parse(value)
252
+ when :Date
253
+ Date.parse(value)
254
+ when :String
255
+ value.to_s
256
+ when :Integer
257
+ value.to_i
258
+ when :Float
259
+ value.to_f
260
+ when :Boolean
261
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
262
+ true
263
+ else
264
+ false
265
+ end
266
+ when :Object
267
+ # generic object (usually a Hash), return directly
268
+ value
269
+ when /\AArray<(?<inner_type>.+)>\z/
270
+ inner_type = Regexp.last_match[:inner_type]
271
+ value.map { |v| _deserialize(inner_type, v) }
272
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
273
+ k_type = Regexp.last_match[:k_type]
274
+ v_type = Regexp.last_match[:v_type]
275
+ {}.tap do |hash|
276
+ value.each do |k, v|
277
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
278
+ end
279
+ end
280
+ else # model
281
+ # models (e.g. Pet) or oneOf
282
+ klass = Svix.const_get(type)
283
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
284
+ end
285
+ end
286
+
287
+ # Returns the string representation of the object
288
+ # @return [String] String presentation of the object
289
+ def to_s
290
+ to_hash.to_s
291
+ end
292
+
293
+ # to_body is an alias to to_hash (backward compatibility)
294
+ # @return [Hash] Returns the object in the form of hash
295
+ def to_body
296
+ to_hash
297
+ end
298
+
299
+ # Returns the object in the form of hash
300
+ # @return [Hash] Returns the object in the form of hash
301
+ def to_hash
302
+ hash = {}
303
+ self.class.attribute_map.each_pair do |attr, param|
304
+ value = self.send(attr)
305
+ if value.nil?
306
+ is_nullable = self.class.openapi_nullable.include?(attr)
307
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
308
+ end
309
+
310
+ hash[param] = _to_hash(value)
311
+ end
312
+ hash
313
+ end
314
+
315
+ # Outputs non-array value in the form of hash
316
+ # For object, use to_hash. Otherwise, just return the value
317
+ # @param [Object] value Any valid value
318
+ # @return [Hash] Returns the value in the form of hash
319
+ def _to_hash(value)
320
+ if value.is_a?(Array)
321
+ value.compact.map { |v| _to_hash(v) }
322
+ elsif value.is_a?(Hash)
323
+ {}.tap do |hash|
324
+ value.each { |k, v| hash[k] = _to_hash(v) }
325
+ end
326
+ elsif value.respond_to? :to_hash
327
+ value.to_hash
328
+ else
329
+ value
330
+ end
331
+ end
332
+
333
+ end
334
+
335
+ end
@@ -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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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.12
6
+ The version of the OpenAPI document: 1.7.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.2.0
@@ -0,0 +1,328 @@
1
+ =begin
2
+ #Svix API
3
+
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}`. For more information on authentication, please refer to the [authentication token docs](https://docs.svix.com/api-keys). <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
+
6
+ The version of the OpenAPI document: 1.7.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.2.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Svix
17
+ class TransformationSimulateIn
18
+ attr_accessor :channels
19
+
20
+ attr_accessor :code
21
+
22
+ # The event type's name
23
+ attr_accessor :event_type
24
+
25
+ attr_accessor :payload
26
+
27
+ # Attribute mapping from ruby-style variable name to JSON key.
28
+ def self.attribute_map
29
+ {
30
+ :'channels' => :'channels',
31
+ :'code' => :'code',
32
+ :'event_type' => :'eventType',
33
+ :'payload' => :'payload'
34
+ }
35
+ end
36
+
37
+ # Returns all the JSON keys this model knows about
38
+ def self.acceptable_attributes
39
+ attribute_map.values
40
+ end
41
+
42
+ # Attribute type mapping.
43
+ def self.openapi_types
44
+ {
45
+ :'channels' => :'Array<String>',
46
+ :'code' => :'String',
47
+ :'event_type' => :'String',
48
+ :'payload' => :'Object'
49
+ }
50
+ end
51
+
52
+ # List of attributes with nullable: true
53
+ def self.openapi_nullable
54
+ Set.new([
55
+ :'channels',
56
+ ])
57
+ end
58
+
59
+ # Initializes the object
60
+ # @param [Hash] attributes Model attributes in the form of hash
61
+ def initialize(attributes = {})
62
+ if (!attributes.is_a?(Hash))
63
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::TransformationSimulateIn` initialize method"
64
+ end
65
+
66
+ # check to see if the attribute exists and convert string to symbol for hash key
67
+ attributes = attributes.each_with_object({}) { |(k, v), h|
68
+ if (!self.class.attribute_map.key?(k.to_sym))
69
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::TransformationSimulateIn`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
70
+ end
71
+ h[k.to_sym] = v
72
+ }
73
+
74
+ if attributes.key?(:'channels')
75
+ if (value = attributes[:'channels']).is_a?(Array)
76
+ self.channels = value
77
+ end
78
+ end
79
+
80
+ if attributes.key?(:'code')
81
+ self.code = attributes[:'code']
82
+ end
83
+
84
+ if attributes.key?(:'event_type')
85
+ self.event_type = attributes[:'event_type']
86
+ end
87
+
88
+ if attributes.key?(:'payload')
89
+ self.payload = attributes[:'payload']
90
+ end
91
+ end
92
+
93
+ # Show invalid properties with the reasons. Usually used together with valid?
94
+ # @return Array for valid properties with the reasons
95
+ def list_invalid_properties
96
+ invalid_properties = Array.new
97
+ if @code.nil?
98
+ invalid_properties.push('invalid value for "code", code cannot be nil.')
99
+ end
100
+
101
+ if @code.to_s.length > 51200
102
+ invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 51200.')
103
+ end
104
+
105
+ if @code.to_s.length < 10
106
+ invalid_properties.push('invalid value for "code", the character length must be great than or equal to 10.')
107
+ end
108
+
109
+ if @event_type.nil?
110
+ invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
111
+ end
112
+
113
+ if @event_type.to_s.length > 256
114
+ invalid_properties.push('invalid value for "event_type", the character length must be smaller than or equal to 256.')
115
+ end
116
+
117
+ pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
118
+ if @event_type !~ pattern
119
+ invalid_properties.push("invalid value for \"event_type\", must conform to the pattern #{pattern}.")
120
+ end
121
+
122
+ if @payload.nil?
123
+ invalid_properties.push('invalid value for "payload", payload cannot be nil.')
124
+ end
125
+
126
+ invalid_properties
127
+ end
128
+
129
+ # Check to see if the all the properties in the model are valid
130
+ # @return true if the model is valid
131
+ def valid?
132
+ return false if @code.nil?
133
+ return false if @code.to_s.length > 51200
134
+ return false if @code.to_s.length < 10
135
+ return false if @event_type.nil?
136
+ return false if @event_type.to_s.length > 256
137
+ return false if @event_type !~ Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
138
+ return false if @payload.nil?
139
+ true
140
+ end
141
+
142
+ # Custom attribute writer method with validation
143
+ # @param [Object] channels Value to be assigned
144
+ def channels=(channels)
145
+ @channels = channels
146
+ end
147
+
148
+ # Custom attribute writer method with validation
149
+ # @param [Object] code Value to be assigned
150
+ def code=(code)
151
+ if code.nil?
152
+ fail ArgumentError, 'code cannot be nil'
153
+ end
154
+
155
+ if code.to_s.length > 51200
156
+ fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 51200.'
157
+ end
158
+
159
+ if code.to_s.length < 10
160
+ fail ArgumentError, 'invalid value for "code", the character length must be great than or equal to 10.'
161
+ end
162
+
163
+ @code = code
164
+ end
165
+
166
+ # Custom attribute writer method with validation
167
+ # @param [Object] event_type Value to be assigned
168
+ def event_type=(event_type)
169
+ if event_type.nil?
170
+ fail ArgumentError, 'event_type cannot be nil'
171
+ end
172
+
173
+ if event_type.to_s.length > 256
174
+ fail ArgumentError, 'invalid value for "event_type", the character length must be smaller than or equal to 256.'
175
+ end
176
+
177
+ pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
178
+ if event_type !~ pattern
179
+ fail ArgumentError, "invalid value for \"event_type\", must conform to the pattern #{pattern}."
180
+ end
181
+
182
+ @event_type = event_type
183
+ end
184
+
185
+ # Checks equality by comparing each attribute.
186
+ # @param [Object] Object to be compared
187
+ def ==(o)
188
+ return true if self.equal?(o)
189
+ self.class == o.class &&
190
+ channels == o.channels &&
191
+ code == o.code &&
192
+ event_type == o.event_type &&
193
+ payload == o.payload
194
+ end
195
+
196
+ # @see the `==` method
197
+ # @param [Object] Object to be compared
198
+ def eql?(o)
199
+ self == o
200
+ end
201
+
202
+ # Calculates hash code according to all attributes.
203
+ # @return [Integer] Hash code
204
+ def hash
205
+ [channels, code, event_type, payload].hash
206
+ end
207
+
208
+ # Builds the object from hash
209
+ # @param [Hash] attributes Model attributes in the form of hash
210
+ # @return [Object] Returns the model itself
211
+ def self.build_from_hash(attributes)
212
+ new.build_from_hash(attributes)
213
+ end
214
+
215
+ # Builds the object from hash
216
+ # @param [Hash] attributes Model attributes in the form of hash
217
+ # @return [Object] Returns the model itself
218
+ def build_from_hash(attributes)
219
+ return nil unless attributes.is_a?(Hash)
220
+ self.class.openapi_types.each_pair do |key, type|
221
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
222
+ self.send("#{key}=", nil)
223
+ elsif type =~ /\AArray<(.*)>/i
224
+ # check to ensure the input is an array given that the attribute
225
+ # is documented as an array but the input is not
226
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
227
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
228
+ end
229
+ elsif !attributes[self.class.attribute_map[key]].nil?
230
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
231
+ end
232
+ end
233
+
234
+ self
235
+ end
236
+
237
+ # Deserializes the data based on type
238
+ # @param string type Data type
239
+ # @param string value Value to be deserialized
240
+ # @return [Object] Deserialized data
241
+ def _deserialize(type, value)
242
+ case type.to_sym
243
+ when :Time
244
+ Time.parse(value)
245
+ when :Date
246
+ Date.parse(value)
247
+ when :String
248
+ value.to_s
249
+ when :Integer
250
+ value.to_i
251
+ when :Float
252
+ value.to_f
253
+ when :Boolean
254
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
255
+ true
256
+ else
257
+ false
258
+ end
259
+ when :Object
260
+ # generic object (usually a Hash), return directly
261
+ value
262
+ when /\AArray<(?<inner_type>.+)>\z/
263
+ inner_type = Regexp.last_match[:inner_type]
264
+ value.map { |v| _deserialize(inner_type, v) }
265
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
266
+ k_type = Regexp.last_match[:k_type]
267
+ v_type = Regexp.last_match[:v_type]
268
+ {}.tap do |hash|
269
+ value.each do |k, v|
270
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
271
+ end
272
+ end
273
+ else # model
274
+ # models (e.g. Pet) or oneOf
275
+ klass = Svix.const_get(type)
276
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
277
+ end
278
+ end
279
+
280
+ # Returns the string representation of the object
281
+ # @return [String] String presentation of the object
282
+ def to_s
283
+ to_hash.to_s
284
+ end
285
+
286
+ # to_body is an alias to to_hash (backward compatibility)
287
+ # @return [Hash] Returns the object in the form of hash
288
+ def to_body
289
+ to_hash
290
+ end
291
+
292
+ # Returns the object in the form of hash
293
+ # @return [Hash] Returns the object in the form of hash
294
+ def to_hash
295
+ hash = {}
296
+ self.class.attribute_map.each_pair do |attr, param|
297
+ value = self.send(attr)
298
+ if value.nil?
299
+ is_nullable = self.class.openapi_nullable.include?(attr)
300
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
301
+ end
302
+
303
+ hash[param] = _to_hash(value)
304
+ end
305
+ hash
306
+ end
307
+
308
+ # Outputs non-array value in the form of hash
309
+ # For object, use to_hash. Otherwise, just return the value
310
+ # @param [Object] value Any valid value
311
+ # @return [Hash] Returns the value in the form of hash
312
+ def _to_hash(value)
313
+ if value.is_a?(Array)
314
+ value.compact.map { |v| _to_hash(v) }
315
+ elsif value.is_a?(Hash)
316
+ {}.tap do |hash|
317
+ value.each { |k, v| hash[k] = _to_hash(v) }
318
+ end
319
+ elsif value.respond_to? :to_hash
320
+ value.to_hash
321
+ else
322
+ value
323
+ end
324
+ end
325
+
326
+ end
327
+
328
+ end