twilio-ruby 5.44.0 → 5.47.0

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

@@ -110,7 +110,8 @@ module Twilio
               ##
               # Create the DomainInstance
               # @param [String] domain_name The unique address you reserve on Twilio to which
-              #   you route your SIP traffic. Domain names can contain letters, digits, and "-".
+              #   you route your SIP traffic. Domain names can contain letters, digits, and "-"
+              #   and must end with `sip.twilio.com`.
               # @param [String] friendly_name A descriptive string that you created to describe
               #   the resource. It can be up to 64 characters long.
               # @param [String] voice_url The URL we should when the domain receives a call.
@@ -248,7 +249,8 @@ module Twilio
               #   with the domain to receive calls. Can be `true` or `false`. `true` allows SIP
               #   Endpoints to register with the domain to receive calls, `false` does not.
               # @param [String] domain_name The unique address you reserve on Twilio to which
-              #   you route your SIP traffic. Domain names can contain letters, digits, and "-".
+              #   you route your SIP traffic. Domain names can contain letters, digits, and "-"
+              #   and must end with `sip.twilio.com`.
               # @param [Boolean] emergency_calling_enabled Whether emergency calling is enabled
               #   for the domain. If enabled, allows emergency calls on the domain from phone
               #   numbers with validated addresses.
@@ -576,7 +578,8 @@ module Twilio
               #   with the domain to receive calls. Can be `true` or `false`. `true` allows SIP
               #   Endpoints to register with the domain to receive calls, `false` does not.
               # @param [String] domain_name The unique address you reserve on Twilio to which
-              #   you route your SIP traffic. Domain names can contain letters, digits, and "-".
+              #   you route your SIP traffic. Domain names can contain letters, digits, and "-"
+              #   and must end with `sip.twilio.com`.
               # @param [Boolean] emergency_calling_enabled Whether emergency calling is enabled
               #   for the domain. If enabled, allows emergency calls on the domain from phone
               #   numbers with validated addresses.

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

@@ -119,7 +119,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array representing the ephemeral credentials
+            # @return [Array[String]] An array representing the ephemeral credentials
             def ice_servers
               @properties['ice_servers']
             end

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

@@ -29,7 +29,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::Bulkexports::V1::ExportInstance] if resource_type was passed.
       # @return [Twilio::REST::Bulkexports::V1::ExportList]
       def exports(resource_type=:unset)
@@ -37,7 +38,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::Bulkexports::V1::ExportConfigurationInstance] if resource_type was passed.
       # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationList]
       def export_configuration(resource_type=:unset)

data/lib/twilio-ruby/rest/bulkexports/v1.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::Bulkexports::V1::ExportContext] if resource_type was passed.
         # @return [Twilio::REST::Bulkexports::V1::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::Bulkexports::V1::ExportConfigurationContext] if resource_type was passed.
         # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationList]
         def export_configuration(resource_type=:unset)

data/lib/twilio-ruby/rest/bulkexports/v1/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/bulkexports/v1/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/bulkexports/v1/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)
@@ -184,7 +185,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)
@@ -210,7 +212,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/bulkexports/v1/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/bulkexports/v1/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/chat/v1/service.rb

@@ -246,8 +246,8 @@ module Twilio
           #   `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and
           #   the default is `POST`. See {Webhook
           #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
-          # @param [String] webhook_filters The list of WebHook events that are enabled for
-          #   this Service instance. See {Webhook
+          # @param [Array[String]] webhook_filters The list of WebHook events that are
+          #   enabled for this Service instance. See {Webhook
           #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhooks_on_message_send_url The URL of the webhook to call in
           #   response to the `on_message_send` event using the
@@ -621,7 +621,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The list of WebHook events that are enabled for this Service instance
+          # @return [Array[String]] The list of WebHook events that are enabled for this Service instance
           def webhook_filters
             @properties['webhook_filters']
           end
@@ -716,8 +716,8 @@ module Twilio
           #   `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and
           #   the default is `POST`. See {Webhook
           #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
-          # @param [String] webhook_filters The list of WebHook events that are enabled for
-          #   this Service instance. See {Webhook
+          # @param [Array[String]] webhook_filters The list of WebHook events that are
+          #   enabled for this Service instance. See {Webhook
           #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhooks_on_message_send_url The URL of the webhook to call in
           #   response to the `on_message_send` event using the

data/lib/twilio-ruby/rest/chat/v1/service/channel.rb

@@ -57,8 +57,8 @@ module Twilio
             # Lists ChannelInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [channel.ChannelType] type The visibility of the Channels to read. Can
-            #   be: `public` or `private` and defaults to `public`.
+            # @param [Array[channel.ChannelType]] type The visibility of the Channels to read.
+            #   Can be: `public` or `private` and defaults to `public`.
             # @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
@@ -74,8 +74,8 @@ module Twilio
             # Streams ChannelInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [channel.ChannelType] type The visibility of the Channels to read. Can
-            #   be: `public` or `private` and defaults to `public`.
+            # @param [Array[channel.ChannelType]] type The visibility of the Channels to read.
+            #   Can be: `public` or `private` and defaults to `public`.
             # @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
@@ -108,8 +108,8 @@ module Twilio
             ##
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
-            # @param [channel.ChannelType] type The visibility of the Channels to read. Can
-            #   be: `public` or `private` and defaults to `public`.
+            # @param [Array[channel.ChannelType]] type The visibility of the Channels to read.
+            #   Can be: `public` or `private` and defaults to `public`.
             # @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

data/lib/twilio-ruby/rest/chat/v1/service/channel/invite.rb

@@ -59,7 +59,7 @@ module Twilio
               # Lists InviteInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [String] identity The
+              # @param [Array[String]] identity The
               #   {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of
               #   the resources to read. See {access
               #   tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more
@@ -79,7 +79,7 @@ module Twilio
               # Streams InviteInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] identity The
+              # @param [Array[String]] identity The
               #   {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of
               #   the resources to read. See {access
               #   tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more
@@ -116,7 +116,7 @@ module Twilio
               ##
               # Retrieve a single page of InviteInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identity The
+              # @param [Array[String]] identity The
               #   {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of
               #   the resources to read. See {access
               #   tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more

data/lib/twilio-ruby/rest/chat/v1/service/channel/member.rb

@@ -59,7 +59,7 @@ module Twilio
               # Lists MemberInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [String] identity The
+              # @param [Array[String]] identity The
               #   {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of
               #   the resources to read. See {access
               #   tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more
@@ -79,7 +79,7 @@ module Twilio
               # Streams MemberInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] identity The
+              # @param [Array[String]] identity The
               #   {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of
               #   the resources to read. See {access
               #   tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more
@@ -116,7 +116,7 @@ module Twilio
               ##
               # Retrieve a single page of MemberInstance records from the API.
               # Request is executed immediately.
-              # @param [String] identity The
+              # @param [Array[String]] identity The
               #   {User}[https://www.twilio.com/docs/api/chat/rest/v1/user]'s `identity` value of
               #   the resources to read. See {access
               #   tokens}[https://www.twilio.com/docs/api/chat/guides/create-tokens] for more

data/lib/twilio-ruby/rest/chat/v1/service/role.rb

@@ -34,10 +34,10 @@ module Twilio
             # @param [role.RoleType] type The type of role. Can be: `channel` for
             #   {Channel}[https://www.twilio.com/docs/chat/api/channels] roles or `deployment`
             #   for {Service}[https://www.twilio.com/docs/chat/api/services] roles.
-            # @param [String] permission A permission that you grant to the new role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
-            #   repeat this parameter for each permission value. The values for this parameter
-            #   depend on the role's `type` and are described in the documentation.
+            # @param [Array[String]] permission A permission that you grant to the new role.
+            #   Only one permission can be granted per parameter. To assign more than one
+            #   permission, repeat this parameter for each permission value. The values for this
+            #   parameter depend on the role's `type` and are described in the documentation.
             # @return [RoleInstance] Created RoleInstance
             def create(friendly_name: nil, type: nil, permission: nil)
               data = Twilio::Values.of({
@@ -203,8 +203,8 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission A permission that you grant to the role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
+            # @param [Array[String]] permission A permission that you grant to the role. Only
+            #   one permission can be granted per parameter. To assign more than one permission,
             #   repeat this parameter for each permission value. The values for this parameter
             #   depend on the role's `type` and are described in the documentation.
             # @return [RoleInstance] Updated RoleInstance
@@ -305,7 +305,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An array of the permissions the role has been granted
+            # @return [Array[String]] An array of the permissions the role has been granted
             def permissions
               @properties['permissions']
             end
@@ -344,8 +344,8 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission A permission that you grant to the role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
+            # @param [Array[String]] permission A permission that you grant to the role. Only
+            #   one permission can be granted per parameter. To assign more than one permission,
             #   repeat this parameter for each permission value. The values for this parameter
             #   depend on the role's `type` and are described in the documentation.
             # @return [RoleInstance] Updated RoleInstance

data/lib/twilio-ruby/rest/chat/v2/service.rb

@@ -260,8 +260,8 @@ module Twilio
           #   `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and
           #   the default is `POST`. See {Webhook
           #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
-          # @param [String] webhook_filters The list of webhook events that are enabled for
-          #   this Service instance. See {Webhook
+          # @param [Array[String]] webhook_filters The list of webhook events that are
+          #   enabled for this Service instance. See {Webhook
           #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] limits_channel_members The maximum number of Members that can be
           #   added to Channels within this Service. Can be up to 1,000.
@@ -557,7 +557,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The list of webhook events that are enabled for this Service instance
+          # @return [Array[String]] The list of webhook events that are enabled for this Service instance
           def webhook_filters
             @properties['webhook_filters']
           end
@@ -684,8 +684,8 @@ module Twilio
           #   `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and
           #   the default is `POST`. See {Webhook
           #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
-          # @param [String] webhook_filters The list of webhook events that are enabled for
-          #   this Service instance. See {Webhook
+          # @param [Array[String]] webhook_filters The list of webhook events that are
+          #   enabled for this Service instance. See {Webhook
           #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] limits_channel_members The maximum number of Members that can be
           #   added to Channels within this Service. Can be up to 1,000.

data/lib/twilio-ruby/rest/chat/v2/service/binding.rb

@@ -31,12 +31,12 @@ module Twilio
             # Lists BindingInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [binding.BindingType] binding_type The push technology used by the
+            # @param [Array[binding.BindingType]] binding_type The push technology used by the
             #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See {push
             #   notification
             #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
             #   for more info.
-            # @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. See {access
             #   tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details.
@@ -60,12 +60,12 @@ module Twilio
             # Streams BindingInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [binding.BindingType] binding_type The push technology used by the
+            # @param [Array[binding.BindingType]] binding_type The push technology used by the
             #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See {push
             #   notification
             #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
             #   for more info.
-            # @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. See {access
             #   tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details.
@@ -101,12 +101,12 @@ module Twilio
             ##
             # Retrieve a single page of BindingInstance records from the API.
             # Request is executed immediately.
-            # @param [binding.BindingType] binding_type The push technology used by the
+            # @param [Array[binding.BindingType]] binding_type The push technology used by the
             #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See {push
             #   notification
             #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
             #   for more info.
-            # @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. See {access
             #   tokens}[https://www.twilio.com/docs/chat/create-tokens] for more details.
@@ -325,7 +325,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The Programmable Chat message types the binding is subscribed to
+            # @return [Array[String]] The Programmable Chat message types the binding is subscribed to
             def message_types
               @properties['message_types']
             end