svix 1.44.0 → 1.45.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/lib/svix/api/application_api.rb +14 -14
  4. data/lib/svix/api/authentication_api.rb +208 -4
  5. data/lib/svix/api/background_tasks_api.rb +4 -4
  6. data/lib/svix/api/broadcast_api.rb +2 -2
  7. data/lib/svix/api/endpoint_api.rb +43 -43
  8. data/lib/svix/api/environment_api.rb +2 -2
  9. data/lib/svix/api/environment_settings_api.rb +2 -2
  10. data/lib/svix/api/event_type_api.rb +12 -12
  11. data/lib/svix/api/events_api.rb +4 -4
  12. data/lib/svix/api/inbound_api.rb +2 -2
  13. data/lib/svix/api/message_api.rb +57 -31
  14. data/lib/svix/api/message_attempt_api.rb +6 -6
  15. data/lib/svix/api/statistics_api.rb +10 -10
  16. data/lib/svix/api/transformation_template_api.rb +22 -22
  17. data/lib/svix/endpoint_api.rb +1 -1
  18. data/lib/svix/message_api.rb +1 -1
  19. data/lib/svix/models/application_in.rb +1 -1
  20. data/lib/svix/models/endpoint_in.rb +2 -2
  21. data/lib/svix/models/endpoint_oauth_config_in.rb +1 -1
  22. data/lib/svix/models/endpoint_out.rb +3 -3
  23. data/lib/svix/models/endpoint_update.rb +2 -2
  24. data/lib/svix/models/environment_settings_out.rb +12 -1
  25. data/lib/svix/models/message_broadcast_in.rb +2 -2
  26. data/lib/svix/models/message_endpoint_out.rb +3 -3
  27. data/lib/svix/models/message_in.rb +0 -9
  28. data/lib/svix/models/operational_webhook_endpoint_in.rb +1 -1
  29. data/lib/svix/models/operational_webhook_endpoint_out.rb +2 -2
  30. data/lib/svix/models/operational_webhook_endpoint_update.rb +1 -1
  31. data/lib/svix/models/rotate_poller_token_in.rb +280 -0
  32. data/lib/svix/models/transformation_http_method.rb +2 -1
  33. data/lib/svix/version.rb +1 -1
  34. metadata +3 -2
@@ -20,7 +20,7 @@ module Svix
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create Message Attempt For Endpoint
23
- # Creates and sends a message to the specified endpoint. The message attempt and response from the endpoint is returned. FIXME: use MessageIn for expediency, even though the `application` parameter is unused. Since this endpoint isn't publicly documented anyway, it should be fine
23
+ # Creates and sends a message to the specified endpoint. The message attempt and response from the endpoint is returned.
24
24
  # @param app_id [String] The app's ID or UID
25
25
  # @param endpoint_id [String] The ep's ID or UID
26
26
  # @param message_in [MessageIn]
@@ -33,7 +33,7 @@ module Svix
33
33
  end
34
34
 
35
35
  # Create Message Attempt For Endpoint
36
- # Creates and sends a message to the specified endpoint. The message attempt and response from the endpoint is returned. FIXME: use MessageIn for expediency, even though the `application` parameter is unused. Since this endpoint isn't publicly documented anyway, it should be fine
36
+ # Creates and sends a message to the specified endpoint. The message attempt and response from the endpoint is returned.
37
37
  # @param app_id [String] The app's ID or UID
38
38
  # @param endpoint_id [String] The ep's ID or UID
39
39
  # @param message_in [MessageIn]
@@ -130,8 +130,8 @@ module Svix
130
130
 
131
131
  # Public Events
132
132
  # Reads the stream of created messages for an application, filtered on the Sink's event types and Channels.
133
- # @param app_id [String] The app's ID
134
- # @param sink_id [String] The ep's ID
133
+ # @param app_id [String] The app's ID or UID
134
+ # @param sink_id [String] The ep's ID or UID
135
135
  # @param [Hash] opts the optional parameters
136
136
  # @option opts [Integer] :limit Limit the number of returned items
137
137
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -146,8 +146,8 @@ module Svix
146
146
 
147
147
  # Public Events
148
148
  # Reads the stream of created messages for an application, filtered on the Sink's event types and Channels.
149
- # @param app_id [String] The app's ID
150
- # @param sink_id [String] The ep's ID
149
+ # @param app_id [String] The app's ID or UID
150
+ # @param sink_id [String] The ep's ID or UID
151
151
  # @param [Hash] opts the optional parameters
152
152
  # @option opts [Integer] :limit Limit the number of returned items
153
153
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -163,10 +163,36 @@ module Svix
163
163
  if @api_client.config.client_side_validation && app_id.nil?
164
164
  fail ArgumentError, "Missing the required parameter 'app_id' when calling MessageApi.v1_events_public"
165
165
  end
166
+ if @api_client.config.client_side_validation && app_id.to_s.length > 256
167
+ fail ArgumentError, 'invalid value for "app_id" when calling MessageApi.v1_events_public, the character length must be smaller than or equal to 256.'
168
+ end
169
+
170
+ if @api_client.config.client_side_validation && app_id.to_s.length < 1
171
+ fail ArgumentError, 'invalid value for "app_id" when calling MessageApi.v1_events_public, the character length must be great than or equal to 1.'
172
+ end
173
+
174
+ pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
175
+ if @api_client.config.client_side_validation && app_id !~ pattern
176
+ fail ArgumentError, "invalid value for 'app_id' when calling MessageApi.v1_events_public, must conform to the pattern #{pattern}."
177
+ end
178
+
166
179
  # verify the required parameter 'sink_id' is set
167
180
  if @api_client.config.client_side_validation && sink_id.nil?
168
181
  fail ArgumentError, "Missing the required parameter 'sink_id' when calling MessageApi.v1_events_public"
169
182
  end
183
+ if @api_client.config.client_side_validation && sink_id.to_s.length > 256
184
+ fail ArgumentError, 'invalid value for "sink_id" when calling MessageApi.v1_events_public, the character length must be smaller than or equal to 256.'
185
+ end
186
+
187
+ if @api_client.config.client_side_validation && sink_id.to_s.length < 1
188
+ fail ArgumentError, 'invalid value for "sink_id" when calling MessageApi.v1_events_public, the character length must be great than or equal to 1.'
189
+ end
190
+
191
+ pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
192
+ if @api_client.config.client_side_validation && sink_id !~ pattern
193
+ fail ArgumentError, "invalid value for 'sink_id' when calling MessageApi.v1_events_public, must conform to the pattern #{pattern}."
194
+ end
195
+
170
196
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
171
197
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MessageApi.v1_events_public, must be smaller than or equal to 250.'
172
198
  end
@@ -194,7 +220,7 @@ module Svix
194
220
  end
195
221
 
196
222
  # resource path
197
- local_var_path = '/api/v1/app/{app_id}/events/{sink_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'sink_id' + '}', CGI.escape(sink_id.to_s))
223
+ local_var_path = '/api/v1/app/{app_id}/poller/{sink_id}'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'sink_id' + '}', CGI.escape(sink_id.to_s))
198
224
 
199
225
  # query parameters
200
226
  query_params = opts[:query_params] || {}
@@ -243,7 +269,7 @@ module Svix
243
269
  # @param app_id [String] The app&#39;s ID or UID
244
270
  # @param message_in [MessageIn]
245
271
  # @param [Hash] opts the optional parameters
246
- # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response (default to true)
272
+ # @option opts [Boolean] :with_content When &#x60;true&#x60;, message payloads are included in the response. (default to true)
247
273
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
248
274
  # @return [MessageOut]
249
275
  def v1_message_create(app_id, message_in, opts = {})
@@ -256,7 +282,7 @@ module Svix
256
282
  # @param app_id [String] The app&#39;s ID or UID
257
283
  # @param message_in [MessageIn]
258
284
  # @param [Hash] opts the optional parameters
259
- # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response (default to true)
285
+ # @option opts [Boolean] :with_content When &#x60;true&#x60;, message payloads are included in the response. (default to true)
260
286
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
261
287
  # @return [Array<(MessageOut, Integer, Hash)>] MessageOut data, response status code and response headers
262
288
  def v1_message_create_with_http_info(app_id, message_in, opts = {})
@@ -332,13 +358,13 @@ module Svix
332
358
  end
333
359
 
334
360
  # Message Events
335
- # Reads the stream of created messages for an application
361
+ # Reads the stream of created messages for an application.
336
362
  # @param app_id [String] The app&#39;s ID or UID
337
363
  # @param [Hash] opts the optional parameters
338
364
  # @option opts [Integer] :limit Limit the number of returned items
339
365
  # @option opts [String] :iterator The iterator returned from a prior invocation
340
366
  # @option opts [Array<String>] :event_types Filter response based on the event type
341
- # @option opts [Array<String>] :channels Filter response based on the event type
367
+ # @option opts [Array<String>] :channels Filter response based on the event type.
342
368
  # @option opts [Time] :after
343
369
  # @return [MessageEventsOut]
344
370
  def v1_message_events(app_id, opts = {})
@@ -347,13 +373,13 @@ module Svix
347
373
  end
348
374
 
349
375
  # Message Events
350
- # Reads the stream of created messages for an application
376
+ # Reads the stream of created messages for an application.
351
377
  # @param app_id [String] The app&#39;s ID or UID
352
378
  # @param [Hash] opts the optional parameters
353
379
  # @option opts [Integer] :limit Limit the number of returned items
354
380
  # @option opts [String] :iterator The iterator returned from a prior invocation
355
381
  # @option opts [Array<String>] :event_types Filter response based on the event type
356
- # @option opts [Array<String>] :channels Filter response based on the event type
382
+ # @option opts [Array<String>] :channels Filter response based on the event type.
357
383
  # @option opts [Time] :after
358
384
  # @return [Array<(MessageEventsOut, Integer, Hash)>] MessageEventsOut data, response status code and response headers
359
385
  def v1_message_events_with_http_info(app_id, opts = {})
@@ -438,7 +464,7 @@ module Svix
438
464
  # @option opts [Integer] :limit Limit the number of returned items
439
465
  # @option opts [String] :iterator The iterator returned from a prior invocation
440
466
  # @option opts [Array<String>] :event_types Filter response based on the event type
441
- # @option opts [Array<String>] :channels Filter response based on the event type
467
+ # @option opts [Array<String>] :channels Filter response based on the event type.
442
468
  # @option opts [Time] :after
443
469
  # @return [MessageEventsOut]
444
470
  def v1_message_events_subscription(app_id, subscription_id, opts = {})
@@ -454,7 +480,7 @@ module Svix
454
480
  # @option opts [Integer] :limit Limit the number of returned items
455
481
  # @option opts [String] :iterator The iterator returned from a prior invocation
456
482
  # @option opts [Array<String>] :event_types Filter response based on the event type
457
- # @option opts [Array<String>] :channels Filter response based on the event type
483
+ # @option opts [Array<String>] :channels Filter response based on the event type.
458
484
  # @option opts [Time] :after
459
485
  # @return [Array<(MessageEventsOut, Integer, Hash)>] MessageEventsOut data, response status code and response headers
460
486
  def v1_message_events_subscription_with_http_info(app_id, subscription_id, opts = {})
@@ -549,7 +575,7 @@ module Svix
549
575
  end
550
576
 
551
577
  # Message Events Create Token
552
- # Creates an auth token that can be used with the `v1.message.events-subscription` endpoint
578
+ # Creates an auth token that can be used with the `v1.message.events-subscription` endpoint.
553
579
  # @param app_id [String] The app&#39;s ID or UID
554
580
  # @param subscription_id [String] The esub&#39;s ID or UID
555
581
  # @param [Hash] opts the optional parameters
@@ -561,7 +587,7 @@ module Svix
561
587
  end
562
588
 
563
589
  # Message Events Create Token
564
- # Creates an auth token that can be used with the &#x60;v1.message.events-subscription&#x60; endpoint
590
+ # Creates an auth token that can be used with the &#x60;v1.message.events-subscription&#x60; endpoint.
565
591
  # @param app_id [String] The app&#39;s ID or UID
566
592
  # @param subscription_id [String] The esub&#39;s ID or UID
567
593
  # @param [Hash] opts the optional parameters
@@ -647,7 +673,7 @@ module Svix
647
673
  end
648
674
 
649
675
  # Delete message payload
650
- # Delete the given message's payload. Useful in cases when a message was accidentally sent with sensitive content. The message can't be replayed or resent once its payload has been deleted or expired.
676
+ # Delete the given message's payload. Useful in cases when a message was accidentally sent with sensitive content. The message can't be replayed or resent once its payload has been deleted or expired.
651
677
  # @param app_id [String] The app&#39;s ID or UID
652
678
  # @param msg_id [String] The msg&#39;s ID or UID
653
679
  # @param [Hash] opts the optional parameters
@@ -658,7 +684,7 @@ module Svix
658
684
  end
659
685
 
660
686
  # Delete message payload
661
- # Delete the given message&#39;s payload. Useful in cases when a message was accidentally sent with sensitive content. The message can&#39;t be replayed or resent once its payload has been deleted or expired.
687
+ # Delete the given message&#39;s payload. Useful in cases when a message was accidentally sent with sensitive content. The message can&#39;t be replayed or resent once its payload has been deleted or expired.
662
688
  # @param app_id [String] The app&#39;s ID or UID
663
689
  # @param msg_id [String] The msg&#39;s ID or UID
664
690
  # @param [Hash] opts the optional parameters
@@ -746,7 +772,7 @@ module Svix
746
772
  # @param app_id [String] The app&#39;s ID or UID
747
773
  # @param msg_id [String] The msg&#39;s ID or UID
748
774
  # @param [Hash] opts the optional parameters
749
- # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response (default to true)
775
+ # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response. (default to true)
750
776
  # @return [MessageOut]
751
777
  def v1_message_get(app_id, msg_id, opts = {})
752
778
  data, _status_code, _headers = v1_message_get_with_http_info(app_id, msg_id, opts)
@@ -758,7 +784,7 @@ module Svix
758
784
  # @param app_id [String] The app&#39;s ID or UID
759
785
  # @param msg_id [String] The msg&#39;s ID or UID
760
786
  # @param [Hash] opts the optional parameters
761
- # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response (default to true)
787
+ # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response. (default to true)
762
788
  # @return [Array<(MessageOut, Integer, Hash)>] MessageOut data, response status code and response headers
763
789
  def v1_message_get_with_http_info(app_id, msg_id, opts = {})
764
790
  if @api_client.config.debugging
@@ -940,11 +966,11 @@ module Svix
940
966
  # @param [Hash] opts the optional parameters
941
967
  # @option opts [Integer] :limit Limit the number of returned items
942
968
  # @option opts [String] :iterator The iterator returned from a prior invocation
943
- # @option opts [String] :channel Filter response based on the channel
944
- # @option opts [Time] :before Only include items created before a certain date
945
- # @option opts [Time] :after Only include items created after a certain date
946
- # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response (default to true)
947
- # @option opts [String] :tag Filter messages matching the provided tag
969
+ # @option opts [String] :channel Filter response based on the channel.
970
+ # @option opts [Time] :before Only include items created before a certain date.
971
+ # @option opts [Time] :after Only include items created after a certain date.
972
+ # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response. (default to true)
973
+ # @option opts [String] :tag Filter messages matching the provided tag.
948
974
  # @option opts [Array<String>] :event_types Filter response based on the event type
949
975
  # @return [ListResponseMessageOut]
950
976
  def v1_message_list(app_id, opts = {})
@@ -958,11 +984,11 @@ module Svix
958
984
  # @param [Hash] opts the optional parameters
959
985
  # @option opts [Integer] :limit Limit the number of returned items
960
986
  # @option opts [String] :iterator The iterator returned from a prior invocation
961
- # @option opts [String] :channel Filter response based on the channel
962
- # @option opts [Time] :before Only include items created before a certain date
963
- # @option opts [Time] :after Only include items created after a certain date
964
- # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response (default to true)
965
- # @option opts [String] :tag Filter messages matching the provided tag
987
+ # @option opts [String] :channel Filter response based on the channel.
988
+ # @option opts [Time] :before Only include items created before a certain date.
989
+ # @option opts [Time] :after Only include items created after a certain date.
990
+ # @option opts [Boolean] :with_content When &#x60;true&#x60; message payloads are included in the response. (default to true)
991
+ # @option opts [String] :tag Filter messages matching the provided tag.
966
992
  # @option opts [Array<String>] :event_types Filter response based on the event type
967
993
  # @return [Array<(ListResponseMessageOut, Integer, Hash)>] ListResponseMessageOut data, response status code and response headers
968
994
  def v1_message_list_with_http_info(app_id, opts = {})
@@ -154,7 +154,7 @@ module Svix
154
154
  end
155
155
 
156
156
  # Delete attempt response body
157
- # Deletes the given attempt's response body. Useful when an endpoint accidentally returned sensitive content.
157
+ # Deletes the given attempt's response body. Useful when an endpoint accidentally returned sensitive content. The message can't be replayed or resent once its payload has been deleted or expired.
158
158
  # @param app_id [String] The app&#39;s ID or UID
159
159
  # @param msg_id [String] The msg&#39;s ID or UID
160
160
  # @param attempt_id [String] The attempt&#39;s ID
@@ -166,7 +166,7 @@ module Svix
166
166
  end
167
167
 
168
168
  # Delete attempt response body
169
- # Deletes the given attempt&#39;s response body. Useful when an endpoint accidentally returned sensitive content.
169
+ # Deletes the given attempt&#39;s response body. Useful when an endpoint accidentally returned sensitive content. The message can&#39;t be replayed or resent once its payload has been deleted or expired.
170
170
  # @param app_id [String] The app&#39;s ID or UID
171
171
  # @param msg_id [String] The msg&#39;s ID or UID
172
172
  # @param attempt_id [String] The attempt&#39;s ID
@@ -457,7 +457,7 @@ module Svix
457
457
  end
458
458
 
459
459
  # List Attempted Destinations
460
- # List endpoints attempted by a given message. Additionally includes metadata about the latest message attempt. By default, endpoints are listed in ascending order by ID.
460
+ # List endpoints attempted by a given message. Additionally includes metadata about the latest message attempt. By default, endpoints are listed in ascending order by ID.
461
461
  # @param app_id [String] The app&#39;s ID or UID
462
462
  # @param msg_id [String] The msg&#39;s ID or UID
463
463
  # @param [Hash] opts the optional parameters
@@ -470,7 +470,7 @@ module Svix
470
470
  end
471
471
 
472
472
  # List Attempted Destinations
473
- # List endpoints attempted by a given message. Additionally includes metadata about the latest message attempt. By default, endpoints are listed in ascending order by ID.
473
+ # List endpoints attempted by a given message. Additionally includes metadata about the latest message attempt. By default, endpoints are listed in ascending order by ID.
474
474
  # @param app_id [String] The app&#39;s ID or UID
475
475
  # @param msg_id [String] The msg&#39;s ID or UID
476
476
  # @param [Hash] opts the optional parameters
@@ -1032,7 +1032,7 @@ module Svix
1032
1032
  end
1033
1033
 
1034
1034
  # List Attempts By Msg
1035
- # List attempts by message id Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the `before` or `after` parameter as appropriate.
1035
+ # List attempts by message ID. Note that by default this endpoint is limited to retrieving 90 days' worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the `before` or `after` parameter as appropriate.
1036
1036
  # @param app_id [String] The app&#39;s ID or UID
1037
1037
  # @param msg_id [String] The msg&#39;s ID or UID
1038
1038
  # @param [Hash] opts the optional parameters
@@ -1054,7 +1054,7 @@ module Svix
1054
1054
  end
1055
1055
 
1056
1056
  # List Attempts By Msg
1057
- # List attempts by message id Note that by default this endpoint is limited to retrieving 90 days&#39; worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the &#x60;before&#x60; or &#x60;after&#x60; parameter as appropriate.
1057
+ # List attempts by message ID. Note that by default this endpoint is limited to retrieving 90 days&#39; worth of data relative to now or, if an iterator is provided, 90 days before/after the time indicated by the iterator ID. If you require data beyond those time ranges, you will need to explicitly set the &#x60;before&#x60; or &#x60;after&#x60; parameter as appropriate.
1058
1058
  # @param app_id [String] The app&#39;s ID or UID
1059
1059
  # @param msg_id [String] The msg&#39;s ID or UID
1060
1060
  # @param [Hash] opts the optional parameters
@@ -151,8 +151,8 @@ module Svix
151
151
  # Returns application-level statistics on message attempts
152
152
  # @param app_id [String] The app&#39;s ID or UID
153
153
  # @param [Hash] opts the optional parameters
154
- # @option opts [Time] :start_date Filter the range to data starting from this date
155
- # @option opts [Time] :end_date Filter the range to data ending by this date
154
+ # @option opts [Time] :start_date Filter the range to data starting from this date.
155
+ # @option opts [Time] :end_date Filter the range to data ending by this date.
156
156
  # @return [AttemptStatisticsResponse]
157
157
  def v1_stats_app_attempts(app_id, opts = {})
158
158
  data, _status_code, _headers = v1_stats_app_attempts_with_http_info(app_id, opts)
@@ -163,8 +163,8 @@ module Svix
163
163
  # Returns application-level statistics on message attempts
164
164
  # @param app_id [String] The app&#39;s ID or UID
165
165
  # @param [Hash] opts the optional parameters
166
- # @option opts [Time] :start_date Filter the range to data starting from this date
167
- # @option opts [Time] :end_date Filter the range to data ending by this date
166
+ # @option opts [Time] :start_date Filter the range to data starting from this date.
167
+ # @option opts [Time] :end_date Filter the range to data ending by this date.
168
168
  # @return [Array<(AttemptStatisticsResponse, Integer, Hash)>] AttemptStatisticsResponse data, response status code and response headers
169
169
  def v1_stats_app_attempts_with_http_info(app_id, opts = {})
170
170
  if @api_client.config.debugging
@@ -230,12 +230,12 @@ module Svix
230
230
  end
231
231
 
232
232
  # Get Ep Stats
233
- # Returns endpoint-level statistics on message attempts
233
+ # Returns endpoint-level statistics on message attempts.
234
234
  # @param app_id [String] The app&#39;s ID or UID
235
235
  # @param endpoint_id [String] The ep&#39;s ID or UID
236
236
  # @param [Hash] opts the optional parameters
237
- # @option opts [Time] :start_date Filter the range to data starting from this date
238
- # @option opts [Time] :end_date Filter the range to data ending by this date
237
+ # @option opts [Time] :start_date Filter the range to data starting from this date.
238
+ # @option opts [Time] :end_date Filter the range to data ending by this date.
239
239
  # @return [AttemptStatisticsResponse]
240
240
  def v1_stats_endpoint_attempts(app_id, endpoint_id, opts = {})
241
241
  data, _status_code, _headers = v1_stats_endpoint_attempts_with_http_info(app_id, endpoint_id, opts)
@@ -243,12 +243,12 @@ module Svix
243
243
  end
244
244
 
245
245
  # Get Ep Stats
246
- # Returns endpoint-level statistics on message attempts
246
+ # Returns endpoint-level statistics on message attempts.
247
247
  # @param app_id [String] The app&#39;s ID or UID
248
248
  # @param endpoint_id [String] The ep&#39;s ID or UID
249
249
  # @param [Hash] opts the optional parameters
250
- # @option opts [Time] :start_date Filter the range to data starting from this date
251
- # @option opts [Time] :end_date Filter the range to data ending by this date
250
+ # @option opts [Time] :start_date Filter the range to data starting from this date.
251
+ # @option opts [Time] :end_date Filter the range to data ending by this date.
252
252
  # @return [Array<(AttemptStatisticsResponse, Integer, Hash)>] AttemptStatisticsResponse data, response status code and response headers
253
253
  def v1_stats_endpoint_attempts_with_http_info(app_id, endpoint_id, opts = {})
254
254
  if @api_client.config.debugging
@@ -126,7 +126,7 @@ module Svix
126
126
  end
127
127
 
128
128
  # Create Transformation Template
129
- # Create a new transformation template
129
+ # Create a new transformation template.
130
130
  # @param template_in [TemplateIn]
131
131
  # @param [Hash] opts the optional parameters
132
132
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -137,7 +137,7 @@ module Svix
137
137
  end
138
138
 
139
139
  # Create Transformation Template
140
- # Create a new transformation template
140
+ # Create a new transformation template.
141
141
  # @param template_in [TemplateIn]
142
142
  # @param [Hash] opts the optional parameters
143
143
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -197,7 +197,7 @@ module Svix
197
197
  end
198
198
 
199
199
  # Delete Transformation Template
200
- # Delete a transformation template
200
+ # Delete a transformation template.
201
201
  # @param transformation_template_id [String]
202
202
  # @param [Hash] opts the optional parameters
203
203
  # @return [nil]
@@ -207,7 +207,7 @@ module Svix
207
207
  end
208
208
 
209
209
  # Delete Transformation Template
210
- # Delete a transformation template
210
+ # Delete a transformation template.
211
211
  # @param transformation_template_id [String]
212
212
  # @param [Hash] opts the optional parameters
213
213
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -260,7 +260,7 @@ module Svix
260
260
  end
261
261
 
262
262
  # Generate
263
- # Use OpenAI's Completion API to generate code for a transformation template
263
+ # Use OpenAI's Completion API to generate code for a transformation template.
264
264
  # @param generate_in [GenerateIn]
265
265
  # @param [Hash] opts the optional parameters
266
266
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -271,7 +271,7 @@ module Svix
271
271
  end
272
272
 
273
273
  # Generate
274
- # Use OpenAI&#39;s Completion API to generate code for a transformation template
274
+ # Use OpenAI&#39;s Completion API to generate code for a transformation template.
275
275
  # @param generate_in [GenerateIn]
276
276
  # @param [Hash] opts the optional parameters
277
277
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -331,7 +331,7 @@ module Svix
331
331
  end
332
332
 
333
333
  # Get Transformation Template
334
- # Get a transformation template
334
+ # Get a transformation template.
335
335
  # @param transformation_template_id [String]
336
336
  # @param [Hash] opts the optional parameters
337
337
  # @return [TemplateOut]
@@ -341,7 +341,7 @@ module Svix
341
341
  end
342
342
 
343
343
  # Get Transformation Template
344
- # Get a transformation template
344
+ # Get a transformation template.
345
345
  # @param transformation_template_id [String]
346
346
  # @param [Hash] opts the optional parameters
347
347
  # @return [Array<(TemplateOut, Integer, Hash)>] TemplateOut data, response status code and response headers
@@ -394,7 +394,7 @@ module Svix
394
394
  end
395
395
 
396
396
  # List Transformation Templates
397
- # List all transformation templates for an application
397
+ # List all transformation templates for an application.
398
398
  # @param [Hash] opts the optional parameters
399
399
  # @option opts [Integer] :limit Limit the number of returned items
400
400
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -406,7 +406,7 @@ module Svix
406
406
  end
407
407
 
408
408
  # List Transformation Templates
409
- # List all transformation templates for an application
409
+ # List all transformation templates for an application.
410
410
  # @param [Hash] opts the optional parameters
411
411
  # @option opts [Integer] :limit Limit the number of returned items
412
412
  # @option opts [String] :iterator The iterator returned from a prior invocation
@@ -468,7 +468,7 @@ module Svix
468
468
  end
469
469
 
470
470
  # Authorize Discord
471
- # Get Discord Incoming webhook URL
471
+ # Get Discord Incoming webhook URL.
472
472
  # @param o_auth_payload_in [OAuthPayloadIn]
473
473
  # @param [Hash] opts the optional parameters
474
474
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -479,7 +479,7 @@ module Svix
479
479
  end
480
480
 
481
481
  # Authorize Discord
482
- # Get Discord Incoming webhook URL
482
+ # Get Discord Incoming webhook URL.
483
483
  # @param o_auth_payload_in [OAuthPayloadIn]
484
484
  # @param [Hash] opts the optional parameters
485
485
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -539,7 +539,7 @@ module Svix
539
539
  end
540
540
 
541
541
  # Authorize Hubspot
542
- # Get Hubspot access token using authorization code
542
+ # Get Hubspot access token using authorization code.
543
543
  # @param o_auth_payload_in [OAuthPayloadIn]
544
544
  # @param [Hash] opts the optional parameters
545
545
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -550,7 +550,7 @@ module Svix
550
550
  end
551
551
 
552
552
  # Authorize Hubspot
553
- # Get Hubspot access token using authorization code
553
+ # Get Hubspot access token using authorization code.
554
554
  # @param o_auth_payload_in [OAuthPayloadIn]
555
555
  # @param [Hash] opts the optional parameters
556
556
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -610,7 +610,7 @@ module Svix
610
610
  end
611
611
 
612
612
  # Authorize Slack
613
- # Get Slack Incoming webhook URL
613
+ # Get Slack Incoming webhook URL.
614
614
  # @param o_auth_payload_in [OAuthPayloadIn]
615
615
  # @param [Hash] opts the optional parameters
616
616
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -621,7 +621,7 @@ module Svix
621
621
  end
622
622
 
623
623
  # Authorize Slack
624
- # Get Slack Incoming webhook URL
624
+ # Get Slack Incoming webhook URL.
625
625
  # @param o_auth_payload_in [OAuthPayloadIn]
626
626
  # @param [Hash] opts the optional parameters
627
627
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -681,7 +681,7 @@ module Svix
681
681
  end
682
682
 
683
683
  # Patch Transformation Template
684
- # Partially update a transformation template
684
+ # Partially update a transformation template.
685
685
  # @param transformation_template_id [String]
686
686
  # @param template_patch [TemplatePatch]
687
687
  # @param [Hash] opts the optional parameters
@@ -692,7 +692,7 @@ module Svix
692
692
  end
693
693
 
694
694
  # Patch Transformation Template
695
- # Partially update a transformation template
695
+ # Partially update a transformation template.
696
696
  # @param transformation_template_id [String]
697
697
  # @param template_patch [TemplatePatch]
698
698
  # @param [Hash] opts the optional parameters
@@ -755,7 +755,7 @@ module Svix
755
755
  end
756
756
 
757
757
  # Simulate
758
- # Simulate running the transformation on the payload and code
758
+ # Simulate running the transformation on the payload and code.
759
759
  # @param transformation_simulate_in [TransformationSimulateIn]
760
760
  # @param [Hash] opts the optional parameters
761
761
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -766,7 +766,7 @@ module Svix
766
766
  end
767
767
 
768
768
  # Simulate
769
- # Simulate running the transformation on the payload and code
769
+ # Simulate running the transformation on the payload and code.
770
770
  # @param transformation_simulate_in [TransformationSimulateIn]
771
771
  # @param [Hash] opts the optional parameters
772
772
  # @option opts [String] :idempotency_key The request&#39;s idempotency key
@@ -826,7 +826,7 @@ module Svix
826
826
  end
827
827
 
828
828
  # Update Transformation Template
829
- # Update a transformation template
829
+ # Update a transformation template.
830
830
  # @param transformation_template_id [String]
831
831
  # @param template_update [TemplateUpdate]
832
832
  # @param [Hash] opts the optional parameters
@@ -837,7 +837,7 @@ module Svix
837
837
  end
838
838
 
839
839
  # Update Transformation Template
840
- # Update a transformation template
840
+ # Update a transformation template.
841
841
  # @param transformation_template_id [String]
842
842
  # @param template_update [TemplateUpdate]
843
843
  # @param [Hash] opts the optional parameters
@@ -60,7 +60,7 @@ module Svix
60
60
  end
61
61
 
62
62
  def replay_missing(app_id, endpoint_id, replay_in, options = {})
63
- @api.v1_endpoint_replay(app_id, endpoint_id, replay_in, options)
63
+ @api.v1_endpoint_replay_missing(app_id, endpoint_id, replay_in, options)
64
64
  nil
65
65
  end
66
66
 
@@ -25,7 +25,7 @@ module Svix
25
25
  end
26
26
  end
27
27
 
28
- # Creates a [`MessageIn`] with a pre-serialized payload.
28
+ # Creates a [`MessageIn`] with a raw string payload.
29
29
  #
30
30
  # The payload is not normalized on the server. Normally, payloads are required
31
31
  # to be JSON, and Svix will minify the payload before sending the webhook
@@ -21,7 +21,7 @@ module Svix
21
21
 
22
22
  attr_accessor :rate_limit
23
23
 
24
- # Optional unique identifier for the application
24
+ # Optional unique identifier for the application.
25
25
  attr_accessor :uid
26
26
 
27
27
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -15,7 +15,7 @@ require 'time'
15
15
 
16
16
  module Svix
17
17
  class EndpointIn
18
- # List of message channels this endpoint listens to (omit for all)
18
+ # List of message channels this endpoint listens to (omit for all).
19
19
  attr_accessor :channels
20
20
 
21
21
  attr_accessor :description
@@ -31,7 +31,7 @@ module Svix
31
31
  # The endpoint's verification secret. Format: `base64` encoded random bytes optionally prefixed with `whsec_`. It is recommended to not set this and let the server generate the secret.
32
32
  attr_accessor :secret
33
33
 
34
- # Optional unique identifier for the endpoint
34
+ # Optional unique identifier for the endpoint.
35
35
  attr_accessor :uid
36
36
 
37
37
  attr_accessor :url
@@ -30,7 +30,7 @@ module Svix
30
30
 
31
31
  attr_accessor :jwt_params
32
32
 
33
- # For `refreshToken` grant type
33
+ # For `refreshToken` grant type.
34
34
  attr_accessor :refresh_token
35
35
 
36
36
  # Optional OAuth scopes added to the request body.
@@ -15,12 +15,12 @@ require 'time'
15
15
 
16
16
  module Svix
17
17
  class EndpointOut
18
- # List of message channels this endpoint listens to (omit for all)
18
+ # List of message channels this endpoint listens to (omit for all).
19
19
  attr_accessor :channels
20
20
 
21
21
  attr_accessor :created_at
22
22
 
23
- # An example endpoint name
23
+ # An example endpoint name.
24
24
  attr_accessor :description
25
25
 
26
26
  attr_accessor :disabled
@@ -34,7 +34,7 @@ module Svix
34
34
 
35
35
  attr_accessor :rate_limit
36
36
 
37
- # Optional unique identifier for the endpoint
37
+ # Optional unique identifier for the endpoint.
38
38
  attr_accessor :uid
39
39
 
40
40
  attr_accessor :updated_at
@@ -15,7 +15,7 @@ require 'time'
15
15
 
16
16
  module Svix
17
17
  class EndpointUpdate
18
- # List of message channels this endpoint listens to (omit for all)
18
+ # List of message channels this endpoint listens to (omit for all).
19
19
  attr_accessor :channels
20
20
 
21
21
  attr_accessor :description
@@ -28,7 +28,7 @@ module Svix
28
28
 
29
29
  attr_accessor :rate_limit
30
30
 
31
- # Optional unique identifier for the endpoint
31
+ # Optional unique identifier for the endpoint.
32
32
  attr_accessor :uid
33
33
 
34
34
  attr_accessor :url