twilio-ruby 5.45.1 → 5.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9f0db0d1556e9972e56f14ebc213999bf7a63d00814e26f02469d8a8dcf634b
-  data.tar.gz: 31c7e92dc8c8701761038ed62ed0db2f827cd70fd34c50d2670c6962271ee611
+  metadata.gz: 22d3f1dbff39d52a6ca1bf1359af11445923587ab7b120eaccc70593fd1f9288
+  data.tar.gz: 4d2a1250feb5d9fb012310ad8412d773fc4b23ffdca3c60d3b8ce2291c74f576
 SHA512:
-  metadata.gz: 839bbe234edfce0944ca90e80e6ce37add9ffb15e6f2b3920d64613a5ba37f3aa96d7f57f23d3217331e96caf5559588d3faf431b0d6fcf2530c533c23e70669
-  data.tar.gz: 29154b15e1f4de47a17c820049d4fecf13224695fda25f6d06d23d4c8036ef7e46d507330ab1b0a58b385a5fcb3141cff9380bf14063a6b06af0b1a990cc5cc0
+  metadata.gz: b067c7548e4cd004d6ae454109a539fd5024a9cc79bcfeb55aa1dcedf3b6a64d273259a6501cf1a466b0916fc8f3b480a8830985dca2c635cc66b36a4c11b320
+  data.tar.gz: 82c65f7a0ab86731ccb3ec20b3350837f21e646ce67c6a08bcd20df135c0f2252ca745f587d58da08cfb39dd956b873d527027e275acf7315e03864f72f540bf

data/.travis.yml

@@ -4,6 +4,7 @@ bundler_args: --without development
 
 rvm:
   - ruby-head
+  - 3.0
   - 2.7
   - 2.6
   - 2.5

data/CHANGES.md

@@ -1,6 +1,114 @@
 twilio-ruby changelog
 =====================
 
+[2021-03-15] Version 5.49.0
+---------------------------
+**Library - Fix**
+- [PR #550](https://github.com/twilio/twilio-ruby/pull/550): regenerating with the path parameter fix. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Events**
+- Set maturity to beta
+
+**Messaging**
+- Adjust A2P brand registration status enum **(breaking change)**
+
+**Studio**
+- Remove internal safeguards for Studio V2 API usage now that it's GA
+
+**Verify**
+- Add support for creating and verifying totp factors. Support for totp factors is behind the `api.verify.totp` beta feature.
+
+**Twiml**
+- Add support for `<VirtualAgent>` noun
+
+
+[2021-02-24] Version 5.48.0
+---------------------------
+**Events**
+- Update description of types in the create sink resource
+
+**Messaging**
+- Add WA template header and footer
+- Remove A2P campaign and use cases API **(breaking change)**
+- Add number_registration_status field to read and fetch campaign responses
+
+**Trusthub**
+- Make all resources public
+
+**Verify**
+- Verify List Attempts API endpoints added.
+
+
+[2021-02-10] Version 5.47.0
+---------------------------
+**Library - Fix**
+- [PR #548](https://github.com/twilio/twilio-ruby/pull/548): shortcut syntax for new non-GA versions. Thanks to [@eshanholtz](https://github.com/eshanholtz)!
+
+**Api**
+- Revert change that conference participant create `from` and `to` param to be endpoint type for supporting client identifier and sip address
+- Update the conference participant create `from` and `to` param to be endpoint type for supporting client identifier and sip address
+
+**Events**
+- Documentation should state that no fields are PII
+
+**Flex**
+- Adding `notifications` and `markdown` to Flex Configuration
+
+**Messaging**
+- Add A2P use cases API
+- Add Brand Registrations API
+- Add Campaigns API
+
+**Serverless**
+- Add runtime field to Build response and as an optional parameter to the Build create endpoint.
+- Add @twilio/runtime-handler dependency to Build response example.
+
+**Sync**
+- Remove If-Match header for Document **(breaking change)**
+
+**Twiml**
+- Add `refer_url` and `refer_method` to `Dial`.
+
+
+[2021-01-27] Version 5.46.1
+---------------------------
+**Library - Docs**
+- [PR #547](https://github.com/twilio/twilio-ruby/pull/547): Document how to use an API Key. Thanks to [@davetron5000](https://github.com/davetron5000)!
+
+**Studio**
+- Studio V2 API is now GA
+
+**Supersim**
+- Allow updating `CommandsUrl` and `CommandsMethod` on a Fleet
+
+**Twiml**
+- Add `status_callback` and `status_callback_method` to `Stream`.
+
+
+[2021-01-13] Version 5.46.0
+---------------------------
+**Library - Docs**
+- [PR #546](https://github.com/twilio/twilio-ruby/pull/546): Fixing docs for list parameter types. Thanks to [@shwetha-manvinkurke](https://github.com/shwetha-manvinkurke)!
+
+**Library - Fix**
+- [PR #545](https://github.com/twilio/twilio-ruby/pull/545): Adds Ruby 3.0 to Travis. Fixes test. Thanks to [@philnash](https://github.com/philnash)!
+
+**Api**
+- Add 'Electric Imp v1 Usage' to usage categories
+
+**Conversations**
+- Changed `last_read_message_index` type in Participant's resource **(breaking change)**
+
+**Insights**
+- Added `created_time` to call summary.
+
+**Sync**
+- Remove HideExpired query parameter for filtering Sync Documents with expired **(breaking change)**
+
+**Video**
+- [Rooms] Expose maxConcurrentPublishedTracks property in Room resource
+
+
 [2020-12-16] Version 5.45.1
 ---------------------------
 **Api**

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2020, Twilio, Inc. <help@twilio.com>
+Copyright (C) 2021, Twilio, Inc. <help@twilio.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -34,13 +34,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.45.1'
+gem 'twilio-ruby', '~> 5.49.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.45.1
+gem install twilio-ruby -v 5.49.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -66,6 +66,20 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 @client = Twilio::REST::Client.new account_sid, auth_token
 ```
 
+### Use An API Key
+
+```ruby
+require 'twilio-ruby'
+
+# put your own credentials here
+account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+api_key_sid = 'zzzzzzzzzzzzzzzzzzzzzz'
+api_key_secret = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+
+# set up a client to talk to the Twilio REST API using an API Key
+@client = Twilio::REST::Client.new api_key_sid, api_key_secret, account_sid
+```
+
 ### Specify a Region and/or Edge
 
 To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/docs/global-infrastructure), specify the target Region and/or Edge for the client:

data/lib/twilio-ruby/rest/api.rb

@@ -86,7 +86,7 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The unique string that that we created to identify this Call
+      # @param [String] sid The unique string that we created to identify this Call
       #   resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::CallInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::CallList]

data/lib/twilio-ruby/rest/api/v2010.rb

@@ -26,11 +26,12 @@ module Twilio
         # @return [Twilio::REST::Api::V2010::AccountList]
         def accounts(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @accounts ||= AccountList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @accounts ||= AccountList.new self
           else
-            AccountContext.new(self, sid)
+              AccountContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb

@@ -288,7 +288,7 @@ module Twilio
             end
 
             ##
-            # @return [authorized_connect_app.Permission] Permissions authorized to the app
+            # @return [Array[authorized_connect_app.Permission]] Permissions authorized to the app
             def permissions
               @properties['permissions']
             end

data/lib/twilio-ruby/rest/api/v2010/account/call.rb

@@ -52,10 +52,10 @@ module Twilio
             #   `status_callback_event` is specified, we will send the `completed` status. If an
             #   `application_sid` parameter is present, this parameter is ignored. URLs must
             #   contain a valid hostname (underscores are not permitted).
-            # @param [String] status_callback_event The call progress events that we will send
-            #   to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and
-            #   `completed`. If no event is specified, we send the `completed` status. If you
-            #   want to receive multiple events, specify each one in a separate
+            # @param [Array[String]] status_callback_event The call progress events that we
+            #   will send to the `status_callback` URL. Can be: `initiated`, `ringing`,
+            #   `answered`, and `completed`. If no event is specified, we send the `completed`
+            #   status. If you want to receive multiple events, specify each one in a separate
             #   `status_callback_event` parameter. See the code sample for {monitoring call
             #   progress}[https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json].
             #   If an `application_sid` is present, this parameter is ignored.
@@ -106,10 +106,10 @@ module Twilio
             # @param [String] machine_detection_timeout The number of seconds that we should
             #   attempt to detect an answering machine before timing out and sending a voice
             #   request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds.
-            # @param [String] recording_status_callback_event The recording status events that
-            #   will trigger calls to the URL specified in `recording_status_callback`. Can be:
-            #   `in-progress`, `completed` and `absent`. Defaults to `completed`. Separate
-            #   multiple values with a space.
+            # @param [Array[String]] recording_status_callback_event The recording status
+            #   events that will trigger calls to the URL specified in
+            #   `recording_status_callback`. Can be: `in-progress`, `completed` and `absent`.
+            #   Defaults to `completed`. Separate  multiple values with a space.
             # @param [String] trim Whether to trim any leading and trailing silence from the
             #   recording. Can be: `trim-silence` or `do-not-trim` and the default is
             #   `trim-silence`.

data/lib/twilio-ruby/rest/api/v2010/account/call/event.rb

@@ -19,8 +19,8 @@ module Twilio
               # @param [String] account_sid The SID of the
               #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
               #   resource.
-              # @param [String] call_sid The unique string that that we created to identify this
-              #   Call resource.
+              # @param [String] call_sid The unique string that we created to identify this Call
+              #   resource.
               # @return [EventList] EventList
               def initialize(version, account_sid: nil, call_sid: nil)
                 super(version)
@@ -159,8 +159,8 @@ module Twilio
               # @param [String] account_sid The SID of the
               #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
               #   resource.
-              # @param [String] call_sid The unique string that that we created to identify this
-              #   Call resource.
+              # @param [String] call_sid The unique string that we created to identify this Call
+              #   resource.
               # @return [EventInstance] EventInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil)
                 super(version)

data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb

@@ -19,8 +19,8 @@ module Twilio
               # @param [String] account_sid The unique id of the
               #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
               #   resource.
-              # @param [String] call_sid The unique string that that we created to identify this
-              #   Call resource.
+              # @param [String] call_sid The unique string that we created to identify this Call
+              #   resource.
               # @return [FeedbackList] FeedbackList
               def initialize(version, account_sid: nil, call_sid: nil)
                 super(version)
@@ -92,8 +92,8 @@ module Twilio
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue A list of one or more issues experienced during
-              #   the call. Issues can be: `imperfect-audio`, `dropped-call`,
+              # @param [Array[feedback.Issues]] issue A list of one or more issues experienced
+              #   during the call. Issues can be: `imperfect-audio`, `dropped-call`,
               #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
               #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Created FeedbackInstance
@@ -132,10 +132,10 @@ module Twilio
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue One or more issues experienced during the call.
-              #   The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`,
-              #   `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`,
-              #   or `one-way-audio`.
+              # @param [Array[feedback.Issues]] issue One or more issues experienced during the
+              #   call. The issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Updated FeedbackInstance
               def update(quality_score: nil, issue: :unset)
                 data = Twilio::Values.of({
@@ -176,8 +176,8 @@ module Twilio
               # @param [String] account_sid The unique id of the
               #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
               #   resource.
-              # @param [String] call_sid The unique string that that we created to identify this
-              #   Call resource.
+              # @param [String] call_sid The unique string that we created to identify this Call
+              #   resource.
               # @return [FeedbackInstance] FeedbackInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil)
                 super(version)
@@ -227,7 +227,7 @@ module Twilio
               end
 
               ##
-              # @return [feedback.Issues] Issues experienced during the call
+              # @return [Array[feedback.Issues]] Issues experienced during the call
               def issues
                 @properties['issues']
               end
@@ -249,8 +249,8 @@ module Twilio
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue A list of one or more issues experienced during
-              #   the call. Issues can be: `imperfect-audio`, `dropped-call`,
+              # @param [Array[feedback.Issues]] issue A list of one or more issues experienced
+              #   during the call. Issues can be: `imperfect-audio`, `dropped-call`,
               #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
               #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Created FeedbackInstance
@@ -270,10 +270,10 @@ module Twilio
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue One or more issues experienced during the call.
-              #   The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`,
-              #   `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`,
-              #   or `one-way-audio`.
+              # @param [Array[feedback.Issues]] issue One or more issues experienced during the
+              #   call. The issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Updated FeedbackInstance
               def update(quality_score: nil, issue: :unset)
                 context.update(quality_score: quality_score, issue: issue, )

data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb

@@ -237,7 +237,7 @@ module Twilio
               end
 
               ##
-              # @return [String] Issues experienced during the call
+              # @return [Array[String]] Issues experienced during the call
               def issues
                 @properties['issues']
               end

data/lib/twilio-ruby/rest/api/v2010/account/call/recording.rb

@@ -33,10 +33,10 @@ module Twilio
 
               ##
               # Create the RecordingInstance
-              # @param [String] recording_status_callback_event The recording status events on
-              #   which we should call the `recording_status_callback` URL. Can be: `in-progress`,
-              #   `completed` and `absent` and the default is `completed`. Separate multiple event
-              #   values with a space.
+              # @param [Array[String]] recording_status_callback_event The recording status
+              #   events on which we should call the `recording_status_callback` URL. Can be:
+              #   `in-progress`, `completed` and `absent` and the default is `completed`. Separate
+              #   multiple event values with a space.
               # @param [String] recording_status_callback The URL we should call using the
               #   `recording_status_callback_method` on each recording event specified in
               #   `recording_status_callback_event`. For more information, see

data/lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb

@@ -52,8 +52,8 @@ module Twilio
               #   `status_callback_method` to send status information to your application.
               # @param [String] status_callback_method The HTTP method we should use to call
               #   `status_callback`. Can be: `GET` and `POST` and defaults to `POST`.
-              # @param [String] status_callback_event The conference state changes that should
-              #   generate a call to `status_callback`. Can be: `initiated`, `ringing`,
+              # @param [Array[String]] status_callback_event The conference state changes that
+              #   should generate a call to `status_callback`. Can be: `initiated`, `ringing`,
               #   `answered`, and `completed`. Separate multiple values with a space. The default
               #   value is `completed`.
               # @param [String] label A label for this participant. If one is supplied, it may
@@ -105,10 +105,10 @@ module Twilio
               # @param [String] conference_status_callback_method The HTTP method we should use
               #   to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to
               #   `POST`.
-              # @param [String] conference_status_callback_event The conference state changes
-              #   that should generate a call to `conference_status_callback`. Can be: `start`,
-              #   `end`, `join`, `leave`, `mute`, `hold`, and `speaker`. Separate multiple values
-              #   with a space. Defaults to `start end`.
+              # @param [Array[String]] conference_status_callback_event The conference state
+              #   changes that should generate a call to `conference_status_callback`. Can be:
+              #   `start`, `end`, `join`, `leave`, `mute`, `hold`, and `speaker`. Separate
+              #   multiple values with a space. Defaults to `start end`.
               # @param [String] recording_channels The recording channels for the final
               #   recording. Can be: `mono` or `dual` and the default is `mono`.
               # @param [String] recording_status_callback The URL that we should call using the
@@ -128,11 +128,11 @@ module Twilio
               # @param [String] conference_recording_status_callback_method The HTTP method we
               #   should use to call `conference_recording_status_callback`. Can be: `GET` or
               #   `POST` and defaults to `POST`.
-              # @param [String] recording_status_callback_event The recording state changes that
-              #   should generate a call to `recording_status_callback`. Can be: `in-progress`,
-              #   `completed`, and `failed`. Separate multiple values with a space. The default
-              #   value is `in-progress completed failed`.
-              # @param [String] conference_recording_status_callback_event The conference
+              # @param [Array[String]] recording_status_callback_event The recording state
+              #   changes that should generate a call to `recording_status_callback`. Can be:
+              #   `in-progress`, `completed`, and `failed`. Separate multiple values with a space.
+              #   The default value is `in-progress completed failed`.
+              # @param [Array[String]] conference_recording_status_callback_event The conference
               #   recording state changes that generate a call to
               #   `conference_recording_status_callback`. Can be: `in-progress`, `completed`, and
               #   `failed`. Separate multiple values with a space. The default value is

data/lib/twilio-ruby/rest/api/v2010/account/connect_app.rb

@@ -189,7 +189,7 @@ module Twilio
             #   the resource. It can be up to 64 characters long.
             # @param [String] homepage_url A public URL where users can obtain more
             #   information about this Connect App.
-            # @param [connect_app.Permission] permissions A comma-separated list of the
+            # @param [Array[connect_app.Permission]] permissions A comma-separated list of the
             #   permissions you will request from the users of this ConnectApp.  Can include:
             #   `get-all` and `post-all`.
             # @return [ConnectAppInstance] Updated ConnectAppInstance
@@ -331,7 +331,7 @@ module Twilio
             end
 
             ##
-            # @return [connect_app.Permission] The set of permissions that your ConnectApp requests
+            # @return [Array[connect_app.Permission]] The set of permissions that your ConnectApp requests
             def permissions
               @properties['permissions']
             end
@@ -369,7 +369,7 @@ module Twilio
             #   the resource. It can be up to 64 characters long.
             # @param [String] homepage_url A public URL where users can obtain more
             #   information about this Connect App.
-            # @param [connect_app.Permission] permissions A comma-separated list of the
+            # @param [Array[connect_app.Permission]] permissions A comma-separated list of the
             #   permissions you will request from the users of this ConnectApp.  Can include:
             #   `get-all` and `post-all`.
             # @return [ConnectAppInstance] Updated ConnectAppInstance