twilio-ruby 5.31.1 → 5.54.0

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

@@ -17,7 +17,7 @@ module Twilio
               # Initialize the UserChannelList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
               #   associated with.
               # @param [String] user_sid The unique string that we created to identify the User
               #   resource.
@@ -91,11 +91,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 UserChannelPage.new(@version, response, @solution)
               end
 
@@ -159,7 +157,7 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   {Service}[https://www.twilio.com/docs/api/chat/rest/services] the resource is
               #   associated with.
               # @param [String] user_sid The unique string that we created to identify the User
               #   resource.

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

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Chat::V2::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
@@ -39,11 +40,12 @@ module Twilio
         # @return [Twilio::REST::Chat::V2::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

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

@@ -84,11 +84,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             CredentialPage.new(@version, response, @solution)
           end
 
@@ -106,8 +104,7 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CredentialInstance records from the API.
-          # Request is executed immediately.
+          # Create the CredentialInstance
           # @param [credential.PushService] type The type of push-notification service the
           #   credential is for. Can be: `gcm`, `fcm`, or `apn`.
           # @param [String] friendly_name A descriptive string that you create to describe
@@ -128,7 +125,7 @@ module Twilio
           #   from the Google Developer console for your GCM Service application credential.
           # @param [String] secret [FCM only] The **Server key** of your project from the
           #   Firebase console, found under Settings / Cloud messaging.
-          # @return [CredentialInstance] Newly created CredentialInstance
+          # @return [CredentialInstance] Created CredentialInstance
           def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
             data = Twilio::Values.of({
                 'Type' => type,
@@ -140,11 +137,7 @@ module Twilio
                 'Secret' => secret,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             CredentialInstance.new(@version, payload, )
           end
@@ -200,16 +193,10 @@ module Twilio
           end
 
           ##
-          # Fetch a CredentialInstance
+          # Fetch the CredentialInstance
           # @return [CredentialInstance] Fetched CredentialInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -245,20 +232,16 @@ module Twilio
                 'Secret' => secret,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the CredentialInstance
+          # Delete the CredentialInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -363,7 +346,7 @@ module Twilio
           end
 
           ##
-          # Fetch a CredentialInstance
+          # Fetch the CredentialInstance
           # @return [CredentialInstance] Fetched CredentialInstance
           def fetch
             context.fetch
@@ -402,7 +385,7 @@ module Twilio
           end
 
           ##
-          # Deletes the CredentialInstance
+          # Delete the CredentialInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete

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

@@ -24,19 +24,14 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
-          # Request is executed immediately.
+          # Create the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the new resource.
-          # @return [ServiceInstance] Newly created ServiceInstance
+          # @return [ServiceInstance] Created ServiceInstance
           def create(friendly_name: nil)
             data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, )
           end
@@ -102,11 +97,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             ServicePage.new(@version, response, @solution)
           end
 
@@ -180,25 +173,19 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Delete the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -206,22 +193,22 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource.
           # @param [String] default_service_role_sid The service role assigned to users when
-          #   they are added to the service. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to the service. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_role_sid The channel role assigned to users when
-          #   they are added to a channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to a channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_creator_role_sid The channel role assigned to a
-          #   channel creator when they join a new channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   channel creator when they join a new channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
-          # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
-          #   Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
+          # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
+          #   Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
           #   default is `true`.
-          # @param [Boolean] reachability_enabled Whether to enable the [Reachability
-          #   Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this
+          # @param [Boolean] reachability_enabled Whether to enable the {Reachability
+          #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
           #   Service instance. The default is `false`.
           # @param [String] typing_indicator_timeout How long in seconds after a `started
           #   typing` event until clients should assume that user is no longer typing, even if
@@ -264,18 +251,18 @@ module Twilio
           #   play when a user is invited to a channel and
           #   `notifications.invited_to_channel.enabled` is `true`.
           # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
-          #   by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] post_webhook_url The URL for post-event webhooks, which are
-          #   called by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   called by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhook_method The HTTP method to use for calls to the
           #   `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
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   the default is `POST`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
+          # @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.
           # @param [String] limits_user_channels The maximum number of Channels Users can be
@@ -328,11 +315,7 @@ module Twilio
                 'Notifications.LogEnabled' => notifications_log_enabled,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -574,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
@@ -616,14 +599,14 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the ServiceInstance
+          # Delete the ServiceInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
@@ -634,22 +617,22 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource.
           # @param [String] default_service_role_sid The service role assigned to users when
-          #   they are added to the service. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to the service. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_role_sid The channel role assigned to users when
-          #   they are added to a channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to a channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_creator_role_sid The channel role assigned to a
-          #   channel creator when they join a new channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   channel creator when they join a new channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
-          # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
-          #   Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
+          # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
+          #   Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
           #   default is `true`.
-          # @param [Boolean] reachability_enabled Whether to enable the [Reachability
-          #   Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this
+          # @param [Boolean] reachability_enabled Whether to enable the {Reachability
+          #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
           #   Service instance. The default is `false`.
           # @param [String] typing_indicator_timeout How long in seconds after a `started
           #   typing` event until clients should assume that user is no longer typing, even if
@@ -692,18 +675,18 @@ module Twilio
           #   play when a user is invited to a channel and
           #   `notifications.invited_to_channel.enabled` is `true`.
           # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
-          #   by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] post_webhook_url The URL for post-event webhooks, which are
-          #   called by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   called by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhook_method The HTTP method to use for calls to the
           #   `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
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   the default is `POST`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
+          # @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.
           # @param [String] limits_user_channels The maximum number of Channels Users can be

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the BindingList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Binding
             #   resource is associated with.
             # @return [BindingList] BindingList
             def initialize(version, service_sid: nil)
@@ -31,15 +31,15 @@ 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
-            #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See [push
+            # @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)
+            #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
             #   for more info.
-            # @param [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.
+            # @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.
             # @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
@@ -60,15 +60,15 @@ 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
-            #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See [push
+            # @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)
+            #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
             #   for more info.
-            # @param [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.
+            # @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.
             # @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
@@ -101,15 +101,15 @@ 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
-            #   Binding resources to read.  Can be: `apn`, `gcm`, or `fcm`.  See [push
+            # @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)
+            #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
             #   for more info.
-            # @param [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.
+            # @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.
             # @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
@@ -122,11 +122,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               BindingPage.new(@version, response, @solution)
             end
 
@@ -184,7 +182,7 @@ module Twilio
             # Initialize the BindingContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the
             #   Binding resource from.
             # @param [String] sid The SID of the Binding resource to fetch.
             # @return [BindingContext] BindingContext
@@ -197,25 +195,19 @@ module Twilio
             end
 
             ##
-            # Fetch a BindingInstance
+            # Fetch the BindingInstance
             # @return [BindingInstance] Fetched BindingInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the BindingInstance
+            # Delete the BindingInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -239,7 +231,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Binding
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Binding
             #   resource is associated with.
             # @param [String] sid The SID of the Binding resource to fetch.
             # @return [BindingInstance] BindingInstance
@@ -333,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
@@ -351,14 +343,14 @@ module Twilio
             end
 
             ##
-            # Fetch a BindingInstance
+            # Fetch the BindingInstance
             # @return [BindingInstance] Fetched BindingInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the BindingInstance
+            # Delete the BindingInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete