twilio-ruby 5.6.0 → 5.33.1

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,9 @@ module Twilio
             ##
             # Initialize the ChannelList
             # @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/api/chat/rest/services) the resource is
+            #   associated with.
             # @return [ChannelList] ChannelList
             def initialize(version, service_sid: nil)
               super(version)
@@ -26,10 +30,16 @@ module Twilio
             ##
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [channel.ChannelType] type The type
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the new resource. It can be up to 64 characters long.
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the resource. It can be used to address the resource in place of the
+            #   resource's `sid` in the URL. This value must be 64 characters or less in length
+            #   and be unique within the Service.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
+            # @param [channel.ChannelType] type The visibility of the channel. Can be:
+            #   `public` or `private` and defaults to `public`.
             # @return [ChannelInstance] Newly created ChannelInstance
             def create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset)
               data = Twilio::Values.of({
@@ -45,14 +55,15 @@ module Twilio
                   data: data
               )
 
-              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
             # 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 type
+            # @param [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
@@ -68,7 +79,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 type
+            # @param [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
@@ -79,7 +91,7 @@ module Twilio
             def stream(type: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(type: type, page_size: limits[:page_size])
+              page = self.page(type: type, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -91,7 +103,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],
@@ -101,7 +113,8 @@ module Twilio
             ##
             # Retrieve a single page of ChannelInstance records from the API.
             # Request is executed immediately.
-            # @param [channel.ChannelType] type The type
+            # @param [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
@@ -160,7 +173,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ChannelInstance] ChannelInstance
             def get_instance(payload)
-              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -174,14 +187,17 @@ module Twilio
             ##
             # Initialize the ChannelContext
             # @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/api/chat/rest/services) to fetch the
+            #   resource from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Channel resource to fetch.
             # @return [ChannelContext] ChannelContext
             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]}/Channels/#{@solution[:sid]}"
 
               # Dependents
@@ -202,21 +218,26 @@ module Twilio
                   params,
               )
 
-              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the ChannelInstance
-            # @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 ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the resource. It can be used to address the resource in place of the
+            #   resource's `sid` in the URL. This value must be 64 characters or less in length
+            #   and be unique within the Service.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset)
               data = Twilio::Values.of({
@@ -231,7 +252,7 @@ module Twilio
                   data: data,
               )
 
-              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -242,7 +263,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return MemberContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return MemberContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
               end
 
               unless @members
@@ -264,7 +285,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return MessageContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return MessageContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
               end
 
               unless @messages
@@ -286,7 +307,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return InviteContext.new(@version, @solution[:service_sid], @solution[:sid], sid)
+                return InviteContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
               end
 
               unless @invites
@@ -306,6 +327,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Chat.V1.ChannelContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Chat.V1.ChannelContext #{context}>"
+            end
           end
 
           class ChannelInstance < InstanceResource
@@ -313,8 +341,11 @@ module Twilio
             # Initialize the ChannelInstance
             # @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/api/chat/rest/services) the resource is
+            #   associated with.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Channel resource to fetch.
             # @return [ChannelInstance] ChannelInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -339,7 +370,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
 
             ##
@@ -348,91 +379,91 @@ module Twilio
             # @return [ChannelContext] ChannelContext for this ChannelInstance
             def context
               unless @instance_context
-                @instance_context = ChannelContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = ChannelContext.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 [String] The unique_name
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] The JSON string that stores application-specific data
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [channel.ChannelType] The type
+            # @return [channel.ChannelType] The visibility of the channel. Can be: `public` or `private`
             def type
               @properties['type']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 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 RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The created_by
+            # @return [String] The identity of the User that created the channel
             def created_by
               @properties['created_by']
             end
 
             ##
-            # @return [String] The members_count
+            # @return [String] The number of Members in the Channel
             def members_count
               @properties['members_count']
             end
 
             ##
-            # @return [String] The messages_count
+            # @return [String] The number of Messages in the Channel
             def messages_count
               @properties['messages_count']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Channel resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel
             def links
               @properties['links']
             end
@@ -446,19 +477,24 @@ module Twilio
 
             ##
             # Deletes the ChannelInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the resource. It can be used to address the resource in place of the
+            #   resource's `sid` in the URL. This value must be 64 characters or less in length
+            #   and be unique within the Service.
+            # @param [String] attributes A valid JSON string that contains
+            #   application-specific data.
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset)
-              context.update(friendly_name: friendly_name, unique_name: unique_name, attributes: attributes)
+              context.update(friendly_name: friendly_name, unique_name: unique_name, attributes: attributes, )
             end
 
             ##

data/lib/twilio-ruby/rest/chat/v1/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/api/chat/rest/services) the 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/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.
             # @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,17 @@ 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/api/chat/rest/services) to fetch the
+            #   resource from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies 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 +204,25 @@ 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. The values for this parameter
+            #   depend on the role's `type` and are described in the documentation.
             # @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 +230,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 +239,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Chat.V1.RoleContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Chat.V1.RoleContext #{context}>"
+            end
           end
 
           class RoleInstance < InstanceResource
@@ -230,8 +253,11 @@ 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/api/chat/rest/services) the resource is
+            #   associated with.
+            # @param [String] sid The Twilio-provided string that uniquely identifies 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 RFC 2822 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 RFC 2822 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,20 @@ 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. The values for this parameter
+            #   depend on the role's `type` and are described in the documentation.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
-              context.update(permission: permission)
+              context.update(permission: permission, )
             end
 
             ##