twilio-ruby 5.53.0 → 5.56.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop_todo.yml +7 -7
  3. data/.travis.yml +2 -2
  4. data/CHANGES.md +62 -0
  5. data/README.md +10 -2
  6. data/lib/twilio-ruby.rb +5 -15
  7. data/lib/twilio-ruby/framework/{domain.rb → rest/domain.rb} +0 -0
  8. data/lib/twilio-ruby/framework/{error.rb → rest/error.rb} +0 -0
  9. data/lib/twilio-ruby/framework/{helper.rb → rest/helper.rb} +0 -0
  10. data/lib/twilio-ruby/framework/{obsolete_client.rb → rest/obsolete_client.rb} +0 -0
  11. data/lib/twilio-ruby/framework/{page.rb → rest/page.rb} +0 -0
  12. data/lib/twilio-ruby/framework/{resource.rb → rest/resource.rb} +0 -0
  13. data/lib/twilio-ruby/framework/{version.rb → rest/version.rb} +0 -0
  14. data/lib/twilio-ruby/http.rb +5 -0
  15. data/lib/twilio-ruby/http/http_client.rb +11 -1
  16. data/lib/twilio-ruby/rest.rb +13 -0
  17. data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb +8 -7
  18. data/lib/twilio-ruby/rest/api/v2010/account/message.rb +2 -2
  19. data/lib/twilio-ruby/rest/client.rb +7 -0
  20. data/lib/twilio-ruby/rest/conversations/v1/conversation.rb +7 -0
  21. data/lib/twilio-ruby/rest/conversations/v1/service/conversation.rb +7 -0
  22. data/lib/twilio-ruby/rest/events/v1/event_type.rb +12 -5
  23. data/lib/twilio-ruby/rest/events/v1/sink.rb +19 -5
  24. data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb +28 -22
  25. data/lib/twilio-ruby/rest/frontline_api.rb +47 -0
  26. data/lib/twilio-ruby/rest/frontline_api/v1.rb +45 -0
  27. data/lib/twilio-ruby/rest/frontline_api/v1/user.rb +233 -0
  28. data/lib/twilio-ruby/rest/messaging/v1/external_campaign.rb +7 -0
  29. data/lib/twilio-ruby/rest/messaging/v1/service.rb +8 -2
  30. data/lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb +175 -15
  31. data/lib/twilio-ruby/rest/supersim/v1/sim.rb +30 -1
  32. data/lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb +231 -0
  33. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb +15 -6
  34. data/lib/twilio-ruby/rest/verify/v2/service/entity/challenge/notification.rb +6 -7
  35. data/lib/twilio-ruby/rest/verify/v2/service/entity/new_factor.rb +8 -8
  36. data/lib/twilio-ruby/rest/video/v1/composition.rb +0 -8
  37. data/lib/twilio-ruby/rest/video/v1/composition_hook.rb +0 -8
  38. data/lib/twilio-ruby/version.rb +1 -1
  39. metadata +15 -9
@@ -38,16 +38,21 @@ module Twilio
38
38
  # is five (5) minutes after Challenge creation. The max value is sixty (60)
39
39
  # minutes after creation.
40
40
  # @param [String] details_message Shown to the user when the push notification
41
- # arrives. Required when `factor_type` is `push`
41
+ # arrives. Required when `factor_type` is `push`. Can be up to 256 characters in
42
+ # length
42
43
  # @param [Array[Hash]] details_fields A list of objects that describe the Fields
43
44
  # included in the Challenge. Each object contains the label and value of the
44
- # field. Used when `factor_type` is `push`.
45
+ # field, the label can be up to 36 characters in length and the value can be up to
46
+ # 128 characters in length. Used when `factor_type` is `push`. There can be up to
47
+ # 20 details fields.
45
48
  # @param [Hash] hidden_details Details provided to give context about the
46
49
  # Challenge. Not shown to the end user. It must be a stringified JSON with only
47
- # strings values eg. `{"ip": "172.168.1.234"}`
50
+ # strings values eg. `{"ip": "172.168.1.234"}`. Can be up to 1024 characters in
51
+ # length
48
52
  # @param [String] auth_payload Optional payload used to verify the Challenge upon
49
53
  # creation. Only used with a Factor of type `totp` to carry the TOTP code that
50
- # needs to be verified.
54
+ # needs to be verified. For `TOTP` this value must be between 3 and 8 characters
55
+ # long.
51
56
  # @return [ChallengeInstance] Created ChallengeInstance
52
57
  def create(factor_sid: nil, expiration_date: :unset, details_message: :unset, details_fields: :unset, hidden_details: :unset, auth_payload: :unset)
53
58
  data = Twilio::Values.of({
@@ -246,7 +251,9 @@ module Twilio
246
251
  ##
247
252
  # Update the ChallengeInstance
248
253
  # @param [String] auth_payload The optional payload needed to verify the
249
- # Challenge. E.g., a TOTP would use the numeric code.
254
+ # Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must
255
+ # be between 3 and 8 characters long. For `Push` this value can be up to 5456
256
+ # characters in length
250
257
  # @return [ChallengeInstance] Updated ChallengeInstance
251
258
  def update(auth_payload: :unset)
252
259
  data = Twilio::Values.of({'AuthPayload' => auth_payload, })
@@ -464,7 +471,9 @@ module Twilio
464
471
  ##
465
472
  # Update the ChallengeInstance
466
473
  # @param [String] auth_payload The optional payload needed to verify the
467
- # Challenge. E.g., a TOTP would use the numeric code.
474
+ # Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must
475
+ # be between 3 and 8 characters long. For `Push` this value can be up to 5456
476
+ # characters in length
468
477
  # @return [ChallengeInstance] Updated ChallengeInstance
469
478
  def update(auth_payload: :unset)
470
479
  context.update(auth_payload: auth_payload, )
@@ -34,11 +34,10 @@ module Twilio
34
34
 
35
35
  ##
36
36
  # Create the NotificationInstance
37
- # @param [String] ttl How long, in seconds, the Notification is valid. Delivery
38
- # will be attempted if the device is offline until the TTL elapses. 0 means that
39
- # the notification delivery is attempted immediately, only once, and is not stored
40
- # for future delivery. Must be an integer between 0 and 300 seconds, inclusive.
41
- # Defaults to 300 seconds.
37
+ # @param [String] ttl How long, in seconds, the notification is valid. Can be an
38
+ # integer between 0 and 300. Default is 300. Delivery is attempted until the TTL
39
+ # elapses, even if the device is offline. 0 means that the notification delivery
40
+ # is attempted immediately, only once, and is not stored for future delivery.
42
41
  # @return [NotificationInstance] Created NotificationInstance
43
42
  def create(ttl: :unset)
44
43
  data = Twilio::Values.of({'Ttl' => ttl, })
@@ -164,13 +163,13 @@ module Twilio
164
163
  end
165
164
 
166
165
  ##
167
- # @return [String] The priority of the Notification.
166
+ # @return [String] The priority of the notification.
168
167
  def priority
169
168
  @properties['priority']
170
169
  end
171
170
 
172
171
  ##
173
- # @return [String] How long, in seconds, the Notification is valid.
172
+ # @return [String] How long, in seconds, the notification is valid.
174
173
  def ttl
175
174
  @properties['ttl']
176
175
  end
@@ -51,24 +51,24 @@ module Twilio
51
51
  #
52
52
  # Required when `factor_type` is `push`
53
53
  # @param [String] config_app_id The ID that uniquely identifies your app in the
54
- # Google or Apple store, such as `com.example.myapp`.
55
- #
56
- # Required when `factor_type` is `push`. If specified, it can be up to 100
54
+ # Google or Apple store, such as `com.example.myapp`. It can be up to 100
57
55
  # characters long.
56
+ #
57
+ # Required when `factor_type` is `push`.
58
58
  # @param [new_factor.NotificationPlatforms] config_notification_platform The
59
59
  # transport technology used to generate the Notification Token. Can be `apn` or
60
60
  # `fcm`.
61
61
  #
62
- # Required when `factor_type` is `push`
62
+ # Required when `factor_type` is `push`.
63
63
  # @param [String] config_notification_token For APN, the device token. For FCM the
64
- # registration token. It used to send the push notifications.
64
+ # registration token. It used to send the push notifications. Must be between 32
65
+ # and 255 characters long.
65
66
  #
66
- # Used when `factor_type` is `push`. If specified, must be between 32 and 255
67
- # characters long.
67
+ # Required when `factor_type` is `push`.
68
68
  # @param [String] config_sdk_version The Verify Push SDK version used to configure
69
69
  # the factor
70
70
  #
71
- # Used when `factor_type` is `push`
71
+ # Required when `factor_type` is `push`
72
72
  # @param [String] binding_secret The shared secret for TOTP factors encoded in
73
73
  # Base32. This can be provided when creating the Factor, otherwise it will be
74
74
  # generated.
@@ -10,8 +10,6 @@ module Twilio
10
10
  module REST
11
11
  class Video < Domain
12
12
  class V1 < Version
13
- ##
14
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
15
13
  class CompositionList < ListResource
16
14
  ##
17
15
  # Initialize the CompositionList
@@ -234,8 +232,6 @@ module Twilio
234
232
  end
235
233
  end
236
234
 
237
- ##
238
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
239
235
  class CompositionPage < Page
240
236
  ##
241
237
  # Initialize the CompositionPage
@@ -265,8 +261,6 @@ module Twilio
265
261
  end
266
262
  end
267
263
 
268
- ##
269
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
270
264
  class CompositionContext < InstanceContext
271
265
  ##
272
266
  # Initialize the CompositionContext
@@ -312,8 +306,6 @@ module Twilio
312
306
  end
313
307
  end
314
308
 
315
- ##
316
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
317
309
  class CompositionInstance < InstanceResource
318
310
  ##
319
311
  # Initialize the CompositionInstance
@@ -10,8 +10,6 @@ module Twilio
10
10
  module REST
11
11
  class Video < Domain
12
12
  class V1 < Version
13
- ##
14
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
15
13
  class CompositionHookList < ListResource
16
14
  ##
17
15
  # Initialize the CompositionHookList
@@ -248,8 +246,6 @@ module Twilio
248
246
  end
249
247
  end
250
248
 
251
- ##
252
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
253
249
  class CompositionHookPage < Page
254
250
  ##
255
251
  # Initialize the CompositionHookPage
@@ -279,8 +275,6 @@ module Twilio
279
275
  end
280
276
  end
281
277
 
282
- ##
283
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
284
278
  class CompositionHookContext < InstanceContext
285
279
  ##
286
280
  # Initialize the CompositionHookContext
@@ -412,8 +406,6 @@ module Twilio
412
406
  end
413
407
  end
414
408
 
415
- ##
416
- # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
417
409
  class CompositionHookInstance < InstanceResource
418
410
  ##
419
411
  # Initialize the CompositionHookInstance
@@ -1,3 +1,3 @@
1
1
  module Twilio
2
- VERSION = '5.53.0'
2
+ VERSION = '5.56.0'
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: twilio-ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.53.0
4
+ version: 5.56.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Twilio API Team
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-05-05 00:00:00.000000000 Z
11
+ date: 2021-06-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jwt
@@ -236,23 +236,25 @@ files:
236
236
  - githooks/pre-commit
237
237
  - lib/rack/twilio_webhook_authentication.rb
238
238
  - lib/twilio-ruby.rb
239
- - lib/twilio-ruby/framework/domain.rb
240
- - lib/twilio-ruby/framework/error.rb
241
- - lib/twilio-ruby/framework/helper.rb
242
- - lib/twilio-ruby/framework/obsolete_client.rb
243
- - lib/twilio-ruby/framework/page.rb
244
239
  - lib/twilio-ruby/framework/request.rb
245
- - lib/twilio-ruby/framework/resource.rb
246
240
  - lib/twilio-ruby/framework/response.rb
241
+ - lib/twilio-ruby/framework/rest/domain.rb
242
+ - lib/twilio-ruby/framework/rest/error.rb
243
+ - lib/twilio-ruby/framework/rest/helper.rb
244
+ - lib/twilio-ruby/framework/rest/obsolete_client.rb
245
+ - lib/twilio-ruby/framework/rest/page.rb
246
+ - lib/twilio-ruby/framework/rest/resource.rb
247
+ - lib/twilio-ruby/framework/rest/version.rb
247
248
  - lib/twilio-ruby/framework/serialize.rb
248
249
  - lib/twilio-ruby/framework/twilio_response.rb
249
250
  - lib/twilio-ruby/framework/values.rb
250
- - lib/twilio-ruby/framework/version.rb
251
+ - lib/twilio-ruby/http.rb
251
252
  - lib/twilio-ruby/http/http_client.rb
252
253
  - lib/twilio-ruby/jwt/access_token.rb
253
254
  - lib/twilio-ruby/jwt/client_capability.rb
254
255
  - lib/twilio-ruby/jwt/jwt.rb
255
256
  - lib/twilio-ruby/jwt/task_router.rb
257
+ - lib/twilio-ruby/rest.rb
256
258
  - lib/twilio-ruby/rest/accounts.rb
257
259
  - lib/twilio-ruby/rest/accounts/v1.rb
258
260
  - lib/twilio-ruby/rest/accounts/v1/auth_token_promotion.rb
@@ -429,6 +431,9 @@ files:
429
431
  - lib/twilio-ruby/rest/flex_api/v1/configuration.rb
430
432
  - lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb
431
433
  - lib/twilio-ruby/rest/flex_api/v1/web_channel.rb
434
+ - lib/twilio-ruby/rest/frontline_api.rb
435
+ - lib/twilio-ruby/rest/frontline_api/v1.rb
436
+ - lib/twilio-ruby/rest/frontline_api/v1/user.rb
432
437
  - lib/twilio-ruby/rest/insights.rb
433
438
  - lib/twilio-ruby/rest/insights/v1.rb
434
439
  - lib/twilio-ruby/rest/insights/v1/call.rb
@@ -619,6 +624,7 @@ files:
619
624
  - lib/twilio-ruby/rest/supersim/v1/network_access_profile.rb
620
625
  - lib/twilio-ruby/rest/supersim/v1/network_access_profile/network_access_profile_network.rb
621
626
  - lib/twilio-ruby/rest/supersim/v1/sim.rb
627
+ - lib/twilio-ruby/rest/supersim/v1/sim/billing_period.rb
622
628
  - lib/twilio-ruby/rest/supersim/v1/sms_command.rb
623
629
  - lib/twilio-ruby/rest/supersim/v1/usage_record.rb
624
630
  - lib/twilio-ruby/rest/sync.rb