twilio-ruby 5.45.1 → 5.46.0

data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb

@@ -296,7 +296,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of values that describe whether the number can receive calls or messages
+            # @return [Array[String]] An array of values that describe whether the number can receive calls or messages
             def capabilities
               @properties['capabilities']
             end

data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb

@@ -302,7 +302,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of values that describe whether the number can receive calls or messages
+            # @return [Array[String]] An array of values that describe whether the number can receive calls or messages
             def capabilities
               @properties['capabilities']
             end

data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb

@@ -297,7 +297,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of values that describe whether the number can receive calls or messages
+            # @return [Array[String]] An array of values that describe whether the number can receive calls or messages
             def capabilities
               @properties['capabilities']
             end

data/lib/twilio-ruby/rest/notify/v1/service/binding.rb

@@ -41,8 +41,9 @@ module Twilio
             #   token. For FCM and GCM, the registration token. For SMS, a phone number in E.164
             #   format. For Facebook Messenger, the Messenger ID of the user or a phone number
             #   in E.164 format.
-            # @param [String] tag A tag that can be used to select the Bindings to notify.
-            #   Repeat this parameter to specify more than one tag, up to a total of 20 tags.
+            # @param [Array[String]] tag A tag that can be used to select the Bindings to
+            #   notify. Repeat this parameter to specify more than one tag, up to a total of 20
+            #   tags.
             # @param [String] notification_protocol_version The protocol version to use to
             #   send the notification. This defaults to the value of
             #   `default_xxxx_notification_protocol_version` for the protocol in the
@@ -81,12 +82,12 @@ module Twilio
             #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
             # @param [Date] end_date Only include usage that occurred on or before this date.
             #   Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [String] identity The
+            # @param [Array[String]] identity The
             #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
             #   of the resources to read.
-            # @param [String] tag Only list Bindings that have all of the specified Tags. The
-            #   following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`,
-            #   `facebook-messenger`. Up to 5 tags are allowed.
+            # @param [Array[String]] tag Only list Bindings that have all of the specified
+            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
+            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit.  Default is no limit
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -113,12 +114,12 @@ module Twilio
             #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
             # @param [Date] end_date Only include usage that occurred on or before this date.
             #   Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [String] identity The
+            # @param [Array[String]] identity The
             #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
             #   of the resources to read.
-            # @param [String] tag Only list Bindings that have all of the specified Tags. The
-            #   following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`,
-            #   `facebook-messenger`. Up to 5 tags are allowed.
+            # @param [Array[String]] tag Only list Bindings that have all of the specified
+            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
+            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit. Default is no limit.
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -161,12 +162,12 @@ module Twilio
             #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
             # @param [Date] end_date Only include usage that occurred on or before this date.
             #   Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [String] identity The
+            # @param [Array[String]] identity The
             #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
             #   of the resources to read.
-            # @param [String] tag Only list Bindings that have all of the specified Tags. The
-            #   following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`,
-            #   `facebook-messenger`. Up to 5 tags are allowed.
+            # @param [Array[String]] tag Only list Bindings that have all of the specified
+            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
+            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
             # @param [Integer] page_size Number of records to return, defaults to 50
@@ -406,7 +407,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The list of tags associated with this Binding
+            # @return [Array[String]] The list of tags associated with this Binding
             def tags
               @properties['tags']
             end

data/lib/twilio-ruby/rest/notify/v1/service/notification.rb

@@ -107,24 +107,24 @@ module Twilio
             #   FCM also {reserves certain
             #   keys}[https://firebase.google.com/docs/cloud-messaging/http-server-ref], which
             #   cannot be used in that channel.
-            # @param [String] segment The Segment resource is deprecated. Use the `tag`
+            # @param [Array[String]] segment The Segment resource is deprecated. Use the `tag`
             #   parameter, instead.
             # @param [Hash] alexa Deprecated.
-            # @param [String] to_binding The destination address specified as a JSON string.
-            #   Multiple `to_binding` parameters can be included but the total size of the
-            #   request entity should not exceed 1MB. This is typically sufficient for 10,000
-            #   phone numbers.
+            # @param [Array[String]] to_binding The destination address specified as a JSON
+            #   string.  Multiple `to_binding` parameters can be included but the total size of
+            #   the request entity should not exceed 1MB. This is typically sufficient for
+            #   10,000 phone numbers.
             # @param [String] delivery_callback_url URL to send webhooks.
-            # @param [String] identity The `identity` value that uniquely identifies the new
-            #   resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource] within
-            #   the {Service}[https://www.twilio.com/docs/notify/api/service-resource]. Delivery
-            #   will be attempted only to Bindings with an Identity in this list. No more than
-            #   20 items are allowed in this list.
-            # @param [String] tag A tag that selects the Bindings to notify. Repeat this
-            #   parameter to specify more than one tag, up to a total of 5 tags. The implicit
-            #   tag `all` is available to notify all Bindings in a Service instance. Similarly,
-            #   the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are
-            #   available to notify all Bindings in a specific channel.
+            # @param [Array[String]] identity The `identity` value that uniquely identifies
+            #   the new resource's {User}[https://www.twilio.com/docs/chat/rest/user-resource]
+            #   within the {Service}[https://www.twilio.com/docs/notify/api/service-resource].
+            #   Delivery will be attempted only to Bindings with an Identity in this list. No
+            #   more than 20 items are allowed in this list.
+            # @param [Array[String]] tag A tag that selects the Bindings to notify. Repeat
+            #   this parameter to specify more than one tag, up to a total of 5 tags. The
+            #   implicit tag `all` is available to notify all Bindings in a Service instance.
+            #   Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger`
+            #   are available to notify all Bindings in a specific channel.
             # @return [NotificationInstance] Created NotificationInstance
             def create(body: :unset, priority: :unset, ttl: :unset, title: :unset, sound: :unset, action: :unset, data: :unset, apn: :unset, gcm: :unset, sms: :unset, facebook_messenger: :unset, fcm: :unset, segment: :unset, alexa: :unset, to_binding: :unset, delivery_callback_url: :unset, identity: :unset, tag: :unset)
               data = Twilio::Values.of({
@@ -255,19 +255,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The list of identity values of the Users to notify
+            # @return [Array[String]] The list of identity values of the Users to notify
             def identities
               @properties['identities']
             end
 
             ##
-            # @return [String] The tags that select the Bindings to notify
+            # @return [Array[String]] The tags that select the Bindings to notify
             def tags
               @properties['tags']
             end
 
             ##
-            # @return [String] The list of Segments to notify
+            # @return [Array[String]] The list of Segments to notify
             def segments
               @properties['segments']
             end

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb

@@ -263,7 +263,7 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The results of the Evaluation resource
+              # @return [Array[Hash]] The results of the Evaluation resource
               def results
                 @properties['results']
               end

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user_type.rb

@@ -234,7 +234,7 @@ module Twilio
             end
 
             ##
-            # @return [Hash] The required information for creating an End-User.
+            # @return [Array[Hash]] The required information for creating an End-User.
             def fields
               @properties['fields']
             end

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb

@@ -234,7 +234,7 @@ module Twilio
             end
 
             ##
-            # @return [Hash] The required information for creating a Supporting Document
+            # @return [Array[Hash]] The required information for creating a Supporting Document
             def fields
               @properties['fields']
             end

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

@@ -78,7 +78,8 @@ module Twilio
       end
 
       ##
-      # @param [String] resource_type The type of communication – Messages, Calls
+      # @param [String] resource_type The type of communication – Messages, Calls,
+      #   Conferences, and Participants
       # @return [Twilio::REST::Preview::BulkExports::ExportInstance] if resource_type was passed.
       # @return [Twilio::REST::Preview::BulkExports::ExportList]
       def exports(resource_type=:unset)
@@ -86,7 +87,8 @@ module Twilio
       end
 
       ##
-      # @param [String] resource_type The type of communication – Messages, Calls
+      # @param [String] resource_type The type of communication – Messages, Calls,
+      #   Conferences, and Participants
       # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationInstance] if resource_type was passed.
       # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationList]
       def export_configuration(resource_type=:unset)

data/lib/twilio-ruby/rest/preview/bulk_exports.rb

@@ -20,7 +20,8 @@ module Twilio
         end
 
         ##
-        # @param [String] resource_type The type of communication – Messages, Calls
+        # @param [String] resource_type The type of communication – Messages, Calls,
+        #   Conferences, and Participants
         # @return [Twilio::REST::Preview::BulkExports::ExportContext] if resource_type was passed.
         # @return [Twilio::REST::Preview::BulkExports::ExportList]
         def exports(resource_type=:unset)
@@ -34,7 +35,8 @@ module Twilio
         end
 
         ##
-        # @param [String] resource_type The type of communication – Messages, Calls
+        # @param [String] resource_type The type of communication – Messages, Calls,
+        #   Conferences, and Participants
         # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationContext] if resource_type was passed.
         # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationList]
         def export_configuration(resource_type=:unset)

data/lib/twilio-ruby/rest/preview/bulk_exports/export.rb

@@ -29,7 +29,8 @@ module Twilio
 
           ##
           # Access the jobs
-          # @param [String] job_sid The job_sid
+          # @param [String] job_sid The unique string that that we created to identify the
+          #   Bulk Export job
           # @return [JobList]
           # @return [JobContext] if job_sid was passed.
           def jobs(job_sid=:unset)
@@ -86,7 +87,8 @@ module Twilio
           ##
           # Initialize the ExportContext
           # @param [Version] version Version that contains the resource
-          # @param [String] resource_type The type of communication – Messages, Calls
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
           # @return [ExportContext] ExportContext
           def initialize(version, resource_type)
             super(version)
@@ -161,7 +163,8 @@ module Twilio
           # Initialize the ExportInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] resource_type The type of communication – Messages, Calls
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
           # @return [ExportInstance] ExportInstance
           def initialize(version, payload, resource_type: nil)
             super(version)
@@ -190,7 +193,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The type of communication – Messages, Calls
+          # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
           def resource_type
             @properties['resource_type']
           end

data/lib/twilio-ruby/rest/preview/bulk_exports/export/day.rb

@@ -17,7 +17,8 @@ module Twilio
             ##
             # Initialize the DayList
             # @param [Version] version Version that contains the resource
-            # @param [String] resource_type The type of communication – Messages, Calls
+            # @param [String] resource_type The type of communication – Messages, Calls,
+            #   Conferences, and Participants
             # @return [DayList] DayList
             def initialize(version, resource_type: nil)
               super(version)
@@ -151,7 +152,8 @@ module Twilio
             ##
             # Initialize the DayContext
             # @param [Version] version Version that contains the resource
-            # @param [String] resource_type The type of communication – Messages, Calls
+            # @param [String] resource_type The type of communication – Messages, Calls,
+            #   Conferences, and Participants
             # @param [String] day The ISO 8601 format date of the resources in the file, for a
             #   UTC day
             # @return [DayContext] DayContext
@@ -194,7 +196,8 @@ module Twilio
             # Initialize the DayInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] resource_type The type of communication – Messages, Calls
+            # @param [String] resource_type The type of communication – Messages, Calls,
+            #   Conferences, and Participants
             # @param [String] day The ISO 8601 format date of the resources in the file, for a
             #   UTC day
             # @return [DayInstance] DayInstance
@@ -258,7 +261,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The type of communication – Messages, Calls
+            # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
             def resource_type
               @properties['resource_type']
             end

data/lib/twilio-ruby/rest/preview/bulk_exports/export/export_custom_job.rb

@@ -17,7 +17,8 @@ module Twilio
             ##
             # Initialize the ExportCustomJobList
             # @param [Version] version Version that contains the resource
-            # @param [String] resource_type The type of communication – Messages, Calls
+            # @param [String] resource_type The type of communication – Messages, Calls,
+            #   Conferences, and Participants
             # @return [ExportCustomJobList] ExportCustomJobList
             def initialize(version, resource_type: nil)
               super(version)
@@ -181,7 +182,8 @@ module Twilio
             # Initialize the ExportCustomJobInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] resource_type The type of communication – Messages, Calls
+            # @param [String] resource_type The type of communication – Messages, Calls,
+            #   Conferences, and Participants
             # @return [ExportCustomJobInstance] ExportCustomJobInstance
             def initialize(version, payload, resource_type: nil)
               super(version)
@@ -207,7 +209,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The type of communication – Messages, Calls
+            # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
             def resource_type
               @properties['resource_type']
             end

data/lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb

@@ -69,7 +69,8 @@ module Twilio
             ##
             # Initialize the JobContext
             # @param [Version] version Version that contains the resource
-            # @param [String] job_sid The job_sid
+            # @param [String] job_sid The unique string that that we created to identify the
+            #   Bulk Export job
             # @return [JobContext] JobContext
             def initialize(version, job_sid)
               super(version)
@@ -117,7 +118,8 @@ module Twilio
             # Initialize the JobInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] job_sid The job_sid
+            # @param [String] job_sid The unique string that that we created to identify the
+            #   Bulk Export job
             # @return [JobInstance] JobInstance
             def initialize(version, payload, job_sid: nil)
               super(version)
@@ -153,7 +155,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The type of communication – Messages, Calls
+            # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
             def resource_type
               @properties['resource_type']
             end

data/lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb

@@ -68,7 +68,8 @@ module Twilio
           ##
           # Initialize the ExportConfigurationContext
           # @param [Version] version Version that contains the resource
-          # @param [String] resource_type The type of communication – Messages, Calls
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
           # @return [ExportConfigurationContext] ExportConfigurationContext
           def initialize(version, resource_type)
             super(version)
@@ -131,7 +132,8 @@ module Twilio
           # Initialize the ExportConfigurationInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] resource_type The type of communication – Messages, Calls
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
           # @return [ExportConfigurationInstance] ExportConfigurationInstance
           def initialize(version, payload, resource_type: nil)
             super(version)
@@ -180,7 +182,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The type of communication – Messages, Calls
+          # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
           def resource_type
             @properties['resource_type']
           end

data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document.rb

@@ -130,9 +130,9 @@ module Twilio
 
           ##
           # Create the AuthorizationDocumentInstance
-          # @param [String] hosted_number_order_sids A list of HostedNumberOrder sids that
-          #   this AuthorizationDocument will authorize for hosting phone number capabilities
-          #   on Twilio's platform.
+          # @param [Array[String]] hosted_number_order_sids A list of HostedNumberOrder sids
+          #   that this AuthorizationDocument will authorize for hosting phone number
+          #   capabilities on Twilio's platform.
           # @param [String] address_sid A 34 character string that uniquely identifies the
           #   Address resource that is associated with this AuthorizationDocument.
           # @param [String] email Email that this AuthorizationDocument will be sent to for
@@ -141,7 +141,7 @@ module Twilio
           #   Authorization Document for this phone number.
           # @param [String] contact_phone_number The contact phone number of the person
           #   authorized to sign the Authorization Document.
-          # @param [String] cc_emails Email recipients who will be informed when an
+          # @param [Array[String]] cc_emails Email recipients who will be informed when an
           #   Authorization Document has been sent and signed.
           # @return [AuthorizationDocumentInstance] Created AuthorizationDocumentInstance
           def create(hosted_number_order_sids: nil, address_sid: nil, email: nil, contact_title: nil, contact_phone_number: nil, cc_emails: :unset)
@@ -228,14 +228,14 @@ module Twilio
 
           ##
           # Update the AuthorizationDocumentInstance
-          # @param [String] hosted_number_order_sids A list of HostedNumberOrder sids that
-          #   this AuthorizationDocument will authorize for hosting phone number capabilities
-          #   on Twilio's platform.
+          # @param [Array[String]] hosted_number_order_sids A list of HostedNumberOrder sids
+          #   that this AuthorizationDocument will authorize for hosting phone number
+          #   capabilities on Twilio's platform.
           # @param [String] address_sid A 34 character string that uniquely identifies the
           #   Address resource that is associated with this AuthorizationDocument.
           # @param [String] email Email that this AuthorizationDocument will be sent to for
           #   signing.
-          # @param [String] cc_emails Email recipients who will be informed when an
+          # @param [Array[String]] cc_emails Email recipients who will be informed when an
           #   Authorization Document has been sent and signed
           # @param [authorization_document.Status] status Status of an instance resource. It
           #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
@@ -360,7 +360,7 @@ module Twilio
           end
 
           ##
-          # @return [String] A list of emails.
+          # @return [Array[String]] A list of emails.
           def cc_emails
             @properties['cc_emails']
           end
@@ -398,14 +398,14 @@ module Twilio
 
           ##
           # Update the AuthorizationDocumentInstance
-          # @param [String] hosted_number_order_sids A list of HostedNumberOrder sids that
-          #   this AuthorizationDocument will authorize for hosting phone number capabilities
-          #   on Twilio's platform.
+          # @param [Array[String]] hosted_number_order_sids A list of HostedNumberOrder sids
+          #   that this AuthorizationDocument will authorize for hosting phone number
+          #   capabilities on Twilio's platform.
           # @param [String] address_sid A 34 character string that uniquely identifies the
           #   Address resource that is associated with this AuthorizationDocument.
           # @param [String] email Email that this AuthorizationDocument will be sent to for
           #   signing.
-          # @param [String] cc_emails Email recipients who will be informed when an
+          # @param [Array[String]] cc_emails Email recipients who will be informed when an
           #   Authorization Document has been sent and signed
           # @param [authorization_document.Status] status Status of an instance resource. It
           #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.