twilio-ruby 5.9.0 → 5.10.0

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

@@ -15,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 unique id of the
+            #   [Service](https://www.twilio.com/docs/chat/api/services) this channel belongs
+            #   to.
             # @return [ChannelList] ChannelList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,13 +30,24 @@ 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 [Time] date_created The date_created
-            # @param [Time] date_updated The date_updated
-            # @param [String] created_by The created_by
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
+            # @param [channel.ChannelType] type The visibility of the channel - `public` or
+            #   `private`. Defaults to `public`.
+            # @param [Time] date_created The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as being created.  Will be set to the current time by the
+            #   Chat service if not specified.  Note that this should only be used in cases
+            #   where a a Channel is being recreated from a backup/separate source
+            # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as having been last updated.  Will be set to the `null` by
+            #   the Chat service if not specified.  Note that this should only be used in cases
+            #   where a Channel is being recreated from a backup/separate source  and where a
+            #   Message was previously updated.
+            # @param [String] created_by Optional field to specify the Identity of the User
+            #   that created the Channel.  Will be set to "system" if not specified.
             # @return [ChannelInstance] Newly created ChannelInstance
             def create(friendly_name: :unset, unique_name: :unset, attributes: :unset, type: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
               data = Twilio::Values.of({
@@ -196,6 +209,7 @@ module Twilio
               @members = nil
               @messages = nil
               @invites = nil
+              @webhooks = nil
             end
 
             ##
@@ -222,12 +236,17 @@ module Twilio
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [Time] date_created The date_created
-            # @param [Time] date_updated The date_updated
-            # @param [String] created_by The created_by
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
+            # @param [Time] date_created The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as being created.
+            # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as having been last updated.
+            # @param [String] created_by Optional field to specify the Identity of the User
+            #   that created the Channel.
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
               data = Twilio::Values.of({
@@ -314,6 +333,28 @@ module Twilio
               @invites
             end
 
+            ##
+            # Access the webhooks
+            # @return [WebhookList]
+            # @return [WebhookContext] if sid was passed.
+            def webhooks(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return WebhookContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
+              end
+
+              unless @webhooks
+                @webhooks = WebhookList.new(
+                    @version,
+                    service_sid: @solution[:service_sid],
+                    channel_sid: @solution[:sid],
+                )
+              end
+
+              @webhooks
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -327,7 +368,9 @@ 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] service_sid The unique id of the
+            #   [Service](https://www.twilio.com/docs/chat/api/services) this channel belongs
+            #   to.
             # @param [String] sid The sid
             # @return [ChannelInstance] ChannelInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -368,85 +411,85 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique id of the Account responsible for this channel.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The unique id of the Service this channel belongs to.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The human-readable name of this channel.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique_name
+            # @return [String] The unique, addressable name of this channel.
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] An optional string metadata field you can use to store any data you wish.
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [channel.ChannelType] The type
+            # @return [channel.ChannelType] The visibility of this channel - either public or private
             def type
               @properties['type']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date that this resource was created.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date that this resource was last updated.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The created_by
+            # @return [String] Identity of the channel's creator.
             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] An absolute URL for this channel.
             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 this Channel.
             def links
               @properties['links']
             end
@@ -467,12 +510,17 @@ module Twilio
 
             ##
             # Update the ChannelInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] unique_name The unique_name
-            # @param [String] attributes The attributes
-            # @param [Time] date_created The date_created
-            # @param [Time] date_updated The date_updated
-            # @param [String] created_by The created_by
+            # @param [String] friendly_name A human-readable name for the Channel. Optional.
+            # @param [String] unique_name A unique, addressable name for the Channel. 
+            #   Optional.
+            # @param [String] attributes An optional metadata field you can use to store any
+            #   data you wish. No processing or validation is done on this field.
+            # @param [Time] date_created The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as being created.
+            # @param [Time] date_updated The optional ISO8601 time specifying the datetime the
+            #   Channel should be set as having been last updated.
+            # @param [String] created_by Optional field to specify the Identity of the User
+            #   that created the Channel.
             # @return [ChannelInstance] Updated ChannelInstance
             def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
               context.update(
@@ -506,6 +554,13 @@ module Twilio
               context.invites
             end
 
+            ##
+            # Access the webhooks
+            # @return [webhooks] webhooks
+            def webhooks
+              context.webhooks
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

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

@@ -15,7 +15,8 @@ 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 unique id of the
+            #   [Service](https://www.twilio.com/docs/chat/api/services) this role belongs to.
             # @return [RoleList] RoleList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,9 +29,12 @@ 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 The human-readable name of this role.
+            # @param [role.RoleType] type What kind of role this is. Either `channel` for
+            #   [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment`
+            #   for [Service](https://www.twilio.com/docs/api/chat/rest/services) roles.
+            # @param [String] permission (multiple) A permission this role should have.
+            #   Consult the table above for the list of possible permissions.
             # @return [RoleInstance] Newly created RoleInstance
             def create(friendly_name: nil, type: nil, permission: nil)
               data = Twilio::Values.of({
@@ -205,7 +209,8 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission The permission
+            # @param [String] permission (multiple) A permission this role should have.
+            #   Consult the table above for the list of possible permissions.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })
@@ -232,7 +237,8 @@ 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] service_sid The unique id of the
+            #   [Service](https://www.twilio.com/docs/chat/api/services) this role belongs to.
             # @param [String] sid The sid
             # @return [RoleInstance] RoleInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -268,55 +274,55 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique id of the Account responsible for this role.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The unique id of the Service this role belongs to.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The human-readable name of this role.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [role.RoleType] The type
+            # @return [role.RoleType] What kind of role this is.
             def type
               @properties['type']
             end
 
             ##
-            # @return [String] The permissions
+            # @return [String] A JSON array of the permissions this role has.
             def permissions
               @properties['permissions']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date that this resource was created in ISO 8601 format.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date that this resource was last updated in ISO 8601 format.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] An absolute URL for this role.
             def url
               @properties['url']
             end
@@ -337,7 +343,8 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission The permission
+            # @param [String] permission (multiple) A permission this role should have.
+            #   Consult the table above for the list of possible permissions.
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               context.update(permission: permission, )

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

@@ -17,7 +17,8 @@ module Twilio
               # Initialize the UserChannelList
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The service_sid
-              # @param [String] user_sid The sid
+              # @param [String] user_sid A 34 character string that uniquely identifies this
+              #   resource.
               # @return [UserChannelList] UserChannelList
               def initialize(version, service_sid: nil, user_sid: nil)
                 super(version)
@@ -156,7 +157,8 @@ module Twilio
               # @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 sid
+              # @param [String] user_sid A 34 character string that uniquely identifies this
+              #   resource.
               # @return [UserChannelInstance] UserChannelInstance
               def initialize(version, payload, service_sid: nil, user_sid: nil)
                 super(version)

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

@@ -15,7 +15,9 @@ module Twilio
             ##
             # Initialize the UserList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The unique id of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this user belongs
+            #   to.
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,10 +30,16 @@ module Twilio
             ##
             # Retrieve a single page of UserInstance records from the API.
             # Request is executed immediately.
-            # @param [String] identity The identity
-            # @param [String] role_sid The role_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            # @param [String] identity A unique string that identifies the user within this
+            #   service - often a username or email address. See the [identity][identity] docs
+            #   for more details.
+            # @param [String] role_sid The unique id of the
+            #   [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.
+            # @param [String] attributes An optional string used to contain any metadata or
+            #   other information for the User.  The string must contain structurally valid JSON
+            #   if specified.
+            # @param [String] friendly_name An optional human readable string representing the
+            #   user.  Often used for display purposes.
             # @return [UserInstance] Newly created UserInstance
             def create(identity: nil, role_sid: :unset, attributes: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
@@ -211,9 +219,13 @@ module Twilio
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The role_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            # @param [String] role_sid The unique id of the [Role][role] assigned to this
+            #   user.
+            # @param [String] attributes An optional string used to contain any metadata or
+            #   other information for the User.  The string must contain structurally valid JSON
+            #   if specified.
+            # @param [String] friendly_name An optional human readable string representing the
+            #   user.  Often used for display purposes.
             # @return [UserInstance] Updated UserInstance
             def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
               data = Twilio::Values.of({
@@ -282,7 +294,9 @@ module Twilio
             # Initialize the UserInstance
             # @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] service_sid The unique id of the
+            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this user belongs
+            #   to.
             # @param [String] sid The sid
             # @return [UserInstance] UserInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -323,73 +337,73 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A 34 character string that uniquely identifies this resource.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The unique id of the Account responsible for this user.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The unique id of the Service this user belongs to.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] An optional string metadata field you can use to store any data you wish.
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The human-readable name of this user.
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The role_sid
+            # @return [String] The unique id of the [Role][role] assigned to this user.
             def role_sid
               @properties['role_sid']
             end
 
             ##
-            # @return [String] The identity
+            # @return [String] A unique string that identifies the user within this service - often a username or email address.
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [Boolean] The is_online
+            # @return [Boolean] Indicates whether the User is actively connected to the Service instance and online.
             def is_online
               @properties['is_online']
             end
 
             ##
-            # @return [Boolean] The is_notifiable
+            # @return [Boolean] Indicates whether the User has a potentially valid Push Notification registration  for the Service instance.
             def is_notifiable
               @properties['is_notifiable']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date that this resource was created in ISO 8601 format.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date that this resource was last updated in ISO 8601 format.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The joined_channels_count
+            # @return [String] The number of Channels this User is a Member of.
             def joined_channels_count
               @properties['joined_channels_count']
             end
@@ -401,7 +415,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The url
+            # @return [String] An absolute URL for this user.
             def url
               @properties['url']
             end
@@ -422,9 +436,13 @@ module Twilio
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The role_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            # @param [String] role_sid The unique id of the [Role][role] assigned to this
+            #   user.
+            # @param [String] attributes An optional string used to contain any metadata or
+            #   other information for the User.  The string must contain structurally valid JSON
+            #   if specified.
+            # @param [String] friendly_name An optional human readable string representing the
+            #   user.  Often used for display purposes.
             # @return [UserInstance] Updated UserInstance
             def update(role_sid: :unset, attributes: :unset, friendly_name: :unset)
               context.update(role_sid: role_sid, attributes: attributes, friendly_name: friendly_name, )