twilio-ruby 5.6.0 → 5.33.1

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,9 @@ module Twilio
             ##
             # Initialize the RoleList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Role
+            #   resource is associated with.
             # @return [RoleList] RoleList
             def initialize(version, service_sid: nil)
               super(version)
@@ -26,9 +30,15 @@ module Twilio
             ##
             # Retrieve a single page of RoleInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [role.RoleType] type The type
-            # @param [String] permission The permission
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the new resource. It can be up to 64 characters long.
+            # @param [role.RoleType] type The type of role. Can be: `channel` for
+            #   [Channel](https://www.twilio.com/docs/chat/channels) roles or `deployment` for
+            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) 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`.
             # @return [RoleInstance] Newly created RoleInstance
             def create(friendly_name: nil, type: nil, permission: nil)
               data = Twilio::Values.of({
@@ -43,7 +53,7 @@ module Twilio
                   data: data
               )
 
-              RoleInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -75,7 +85,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -87,7 +97,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -154,7 +164,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [RoleInstance] RoleInstance
             def get_instance(payload)
-              RoleInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -168,14 +178,16 @@ module Twilio
             ##
             # Initialize the RoleContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
+            #   Role resource from.
+            # @param [String] sid The SID of the Role resource to fetch.
             # @return [RoleContext] RoleContext
             def initialize(version, service_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/Roles/#{@solution[:sid]}"
             end
 
@@ -191,22 +203,27 @@ module Twilio
                   params,
               )
 
-              RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the RoleInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
 
             ##
             # Update the RoleInstance
-            # @param [String] permission The permission
+            # @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,
+            #   repeat this parameter for each permission value. Note that the update action
+            #   replaces all previously assigned permissions with those defined in the update
+            #   action. To remove a permission, do not include it in the subsequent update
+            #   action. The values for this parameter depend on the role's `type`.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
-              data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }})
+              data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })
 
               payload = @version.update(
                   'POST',
@@ -214,7 +231,7 @@ module Twilio
                   data: data,
               )
 
-              RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              RoleInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -223,6 +240,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Chat.V2.RoleContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Chat.V2.RoleContext #{context}>"
+            end
           end
 
           class RoleInstance < InstanceResource
@@ -230,8 +254,10 @@ module Twilio
             # Initialize the RoleInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Role
+            #   resource is associated with.
+            # @param [String] sid The SID of the Role resource to fetch.
             # @return [RoleInstance] RoleInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -251,7 +277,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -260,61 +286,61 @@ module Twilio
             # @return [RoleContext] RoleContext for this RoleInstance
             def context
               unless @instance_context
-                @instance_context = RoleContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = RoleContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [role.RoleType] The type
+            # @return [role.RoleType] The type of role
             def type
               @properties['type']
             end
 
             ##
-            # @return [String] The permissions
+            # @return [String] An array of the permissions the role has been granted
             def permissions
               @properties['permissions']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Role resource
             def url
               @properties['url']
             end
@@ -328,17 +354,22 @@ module Twilio
 
             ##
             # Deletes the RoleInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the RoleInstance
-            # @param [String] permission The permission
+            # @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,
+            #   repeat this parameter for each permission value. Note that the update action
+            #   replaces all previously assigned permissions with those defined in the update
+            #   action. To remove a permission, do not include it in the subsequent update
+            #   action. The values for this parameter depend on the role's `type`.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
-              context.update(permission: permission)
+              context.update(permission: permission, )
             end
 
             ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,14 @@ module Twilio
               ##
               # Initialize the UserBindingList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] user_sid The user_sid
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
+              #   Binding resource is associated with.
+              # @param [String] user_sid The SID of the
+              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User
+              #   Binding resource.  See [push notification
+              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
+              #   for more info.
               # @return [UserBindingList] UserBindingList
               def initialize(version, service_sid: nil, user_sid: nil)
                 super(version)
@@ -29,7 +37,11 @@ module Twilio
               # Lists UserBindingInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [user_binding.BindingType] binding_type The binding_type
+              # @param [user_binding.BindingType] binding_type The push technology used by the
+              #   User 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 [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
@@ -45,7 +57,11 @@ module Twilio
               # Streams UserBindingInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [user_binding.BindingType] binding_type The binding_type
+              # @param [user_binding.BindingType] binding_type The push technology used by the
+              #   User 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 [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
@@ -56,7 +72,7 @@ module Twilio
               def stream(binding_type: :unset, limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(binding_type: binding_type, page_size: limits[:page_size])
+                page = self.page(binding_type: binding_type, page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -68,7 +84,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -78,7 +94,11 @@ module Twilio
               ##
               # Retrieve a single page of UserBindingInstance records from the API.
               # Request is executed immediately.
-              # @param [user_binding.BindingType] binding_type The binding_type
+              # @param [user_binding.BindingType] binding_type The push technology used by the
+              #   User 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] 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
@@ -156,15 +176,21 @@ module Twilio
               ##
               # Initialize the UserBindingContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] user_sid The user_sid
-              # @param [String] sid The sid
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
+              #   User Binding resource from.
+              # @param [String] user_sid The SID of the
+              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User
+              #   Binding resource to fetch.  See [push notification
+              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
+              #   for more info.
+              # @param [String] sid The SID of the User Binding resource to fetch.
               # @return [UserBindingContext] UserBindingContext
               def initialize(version, service_sid, user_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, user_sid: user_sid, sid: sid}
+                @solution = {service_sid: service_sid, user_sid: user_sid, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Bindings/#{@solution[:sid]}"
               end
 
@@ -191,7 +217,7 @@ module Twilio
 
               ##
               # Deletes the UserBindingInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -202,6 +228,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Chat.V2.UserBindingContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V2.UserBindingContext #{context}>"
+              end
             end
 
             class UserBindingInstance < InstanceResource
@@ -209,9 +242,15 @@ module Twilio
               # Initialize the UserBindingInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The service_sid
-              # @param [String] user_sid The user_sid
-              # @param [String] sid The sid
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
+              #   Binding resource is associated with.
+              # @param [String] user_sid The SID of the
+              #   [User](https://www.twilio.com/docs/chat/rest/user-resource) with the User
+              #   Binding resource.  See [push notification
+              #   configuration](https://www.twilio.com/docs/chat/push-notification-configuration)
+              #   for more info.
+              # @param [String] sid The SID of the User Binding resource to fetch.
               # @return [UserBindingInstance] UserBindingInstance
               def initialize(version, payload, service_sid: nil, user_sid: nil, sid: nil)
                 super(version)
@@ -234,7 +273,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'service_sid' => service_sid, 'user_sid' => user_sid, 'sid' => sid || @properties['sid']}
+                @params = {'service_sid' => service_sid, 'user_sid' => user_sid, 'sid' => sid || @properties['sid'], }
               end
 
               ##
@@ -254,73 +293,73 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The service_sid
+              # @return [String] The SID of the Service that the resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The endpoint
+              # @return [String] The unique endpoint identifier for the User Binding
               def endpoint
                 @properties['endpoint']
               end
 
               ##
-              # @return [String] The identity
+              # @return [String] The string that identifies the resource's User
               def identity
                 @properties['identity']
               end
 
               ##
-              # @return [String] The user_sid
+              # @return [String] The SID of the User with the binding
               def user_sid
                 @properties['user_sid']
               end
 
               ##
-              # @return [String] The credential_sid
+              # @return [String] The SID of the Credential for the binding
               def credential_sid
                 @properties['credential_sid']
               end
 
               ##
-              # @return [user_binding.BindingType] The binding_type
+              # @return [user_binding.BindingType] The push technology to use for the binding
               def binding_type
                 @properties['binding_type']
               end
 
               ##
-              # @return [String] The message_types
+              # @return [String] The Programmable Chat message types the binding is subscribed to
               def message_types
                 @properties['message_types']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the User Binding resource
               def url
                 @properties['url']
               end
@@ -334,7 +373,7 @@ module Twilio
 
               ##
               # Deletes the UserBindingInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end