twilio-ruby 5.40.1 → 5.42.0

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

@@ -16,12 +16,8 @@ module Twilio
               ##
               # Initialize the WebhookList
               # @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 Channel
-              #   Webhook resource is associated with.
-              # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook
-              #   resource belongs to.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
               # @return [WebhookList] WebhookList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -113,27 +109,13 @@ module Twilio
 
               ##
               # Create the WebhookInstance
-              # @param [webhook.Type] type The type of webhook. Can be: `webhook`, `studio`, or
-              #   `trigger`.
-              # @param [String] configuration_url The URL of the webhook to call using the
-              #   `configuration.method`.
-              # @param [webhook.Method] configuration_method The HTTP method used to call
-              #   `configuration.url`. Can be: `GET` or `POST` and the default is `POST`.
-              # @param [String] configuration_filters The events that cause us to call the
-              #   Channel Webhook. Used when `type` is `webhook`. This parameter takes only one
-              #   event. To specify more than one event, repeat this parameter for each event. For
-              #   the list of possible events, see [Webhook Event
-              #   Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).
-              # @param [String] configuration_triggers A string that will cause us to call the
-              #   webhook when it is present in a message body. This parameter takes only one
-              #   trigger string. To specify more than one, repeat this parameter for each trigger
-              #   string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
-              # @param [String] configuration_flow_sid The SID of the Studio
-              #   [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event
-              #   in `configuration.filters` occurs. Used only when `type` is `studio`.
-              # @param [String] configuration_retry_count The number of times to retry the
-              #   webhook if the first attempt fails. Can be an integer between 0 and 3,
-              #   inclusive, and the default is 0.
+              # @param [webhook.Type] type The type
+              # @param [String] configuration_url The configuration.url
+              # @param [webhook.Method] configuration_method The configuration.method
+              # @param [String] configuration_filters The configuration.filters
+              # @param [String] configuration_triggers The configuration.triggers
+              # @param [String] configuration_flow_sid The configuration.flow_sid
+              # @param [String] configuration_retry_count The configuration.retry_count
               # @return [WebhookInstance] Created WebhookInstance
               def create(type: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset)
                 data = Twilio::Values.of({
@@ -201,14 +183,9 @@ module Twilio
               ##
               # Initialize the WebhookContext
               # @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) with the
-              #   Channel to fetch the Webhook resource from.
-              # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook
-              #   resource to fetch belongs to. This value can be the Channel resource's `sid` or
-              #   `unique_name`.
-              # @param [String] sid The SID of the Channel Webhook resource to fetch.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
+              # @param [String] sid The sid
               # @return [WebhookContext] WebhookContext
               def initialize(version, service_sid, channel_sid, sid)
                 super(version)
@@ -235,25 +212,12 @@ module Twilio
 
               ##
               # Update the WebhookInstance
-              # @param [String] configuration_url The URL of the webhook to call using the
-              #   `configuration.method`.
-              # @param [webhook.Method] configuration_method The HTTP method used to call
-              #   `configuration.url`. Can be: `GET` or `POST` and the default is `POST`.
-              # @param [String] configuration_filters The events that cause us to call the
-              #   Channel Webhook. Used when `type` is `webhook`. This parameter takes only one
-              #   event. To specify more than one event, repeat this parameter for each event. For
-              #   the list of possible events, see [Webhook Event
-              #   Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).
-              # @param [String] configuration_triggers A string that will cause us to call the
-              #   webhook when it is present in a message body. This parameter takes only one
-              #   trigger string. To specify more than one, repeat this parameter for each trigger
-              #   string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
-              # @param [String] configuration_flow_sid The SID of the Studio
-              #   [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event
-              #   in `configuration.filters` occurs. Used only when `type` = `studio`.
-              # @param [String] configuration_retry_count The number of times to retry the
-              #   webhook if the first attempt fails. Can be an integer between 0 and 3,
-              #   inclusive, and the default is 0.
+              # @param [String] configuration_url The configuration.url
+              # @param [webhook.Method] configuration_method The configuration.method
+              # @param [String] configuration_filters The configuration.filters
+              # @param [String] configuration_triggers The configuration.triggers
+              # @param [String] configuration_flow_sid The configuration.flow_sid
+              # @param [String] configuration_retry_count The configuration.retry_count
               # @return [WebhookInstance] Updated WebhookInstance
               def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset)
                 data = Twilio::Values.of({
@@ -303,13 +267,9 @@ module Twilio
               # Initialize the WebhookInstance
               # @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 Channel
-              #   Webhook resource is associated with.
-              # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook
-              #   resource belongs to.
-              # @param [String] sid The SID of the Channel Webhook resource to fetch.
+              # @param [String] service_sid The service_sid
+              # @param [String] channel_sid The channel_sid
+              # @param [String] sid The sid
               # @return [WebhookInstance] WebhookInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -353,55 +313,55 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique string that identifies the resource
+              # @return [String] The sid
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The SID of the Account that created the resource
+              # @return [String] The account_sid
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The SID of the Service that the Channel Webhook resource is associated with
+              # @return [String] The service_sid
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The SID of the Channel the Channel Webhook resource belongs to
+              # @return [String] The channel_sid
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [String] The type of webhook
+              # @return [String] The type
               def type
                 @properties['type']
               end
 
               ##
-              # @return [String] The absolute URL of the Channel Webhook resource
+              # @return [String] The url
               def url
                 @properties['url']
               end
 
               ##
-              # @return [Hash] The JSON string that describes the configuration object for the channel webhook
+              # @return [Hash] The configuration
               def configuration
                 @properties['configuration']
               end
 
               ##
-              # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+              # @return [Time] The date_created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+              # @return [Time] The date_updated
               def date_updated
                 @properties['date_updated']
               end
@@ -415,25 +375,12 @@ module Twilio
 
               ##
               # Update the WebhookInstance
-              # @param [String] configuration_url The URL of the webhook to call using the
-              #   `configuration.method`.
-              # @param [webhook.Method] configuration_method The HTTP method used to call
-              #   `configuration.url`. Can be: `GET` or `POST` and the default is `POST`.
-              # @param [String] configuration_filters The events that cause us to call the
-              #   Channel Webhook. Used when `type` is `webhook`. This parameter takes only one
-              #   event. To specify more than one event, repeat this parameter for each event. For
-              #   the list of possible events, see [Webhook Event
-              #   Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).
-              # @param [String] configuration_triggers A string that will cause us to call the
-              #   webhook when it is present in a message body. This parameter takes only one
-              #   trigger string. To specify more than one, repeat this parameter for each trigger
-              #   string up to a total of 5 trigger strings. Used only when `type` = `trigger`.
-              # @param [String] configuration_flow_sid The SID of the Studio
-              #   [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event
-              #   in `configuration.filters` occurs. Used only when `type` = `studio`.
-              # @param [String] configuration_retry_count The number of times to retry the
-              #   webhook if the first attempt fails. Can be an integer between 0 and 3,
-              #   inclusive, and the default is 0.
+              # @param [String] configuration_url The configuration.url
+              # @param [webhook.Method] configuration_method The configuration.method
+              # @param [String] configuration_filters The configuration.filters
+              # @param [String] configuration_triggers The configuration.triggers
+              # @param [String] configuration_flow_sid The configuration.flow_sid
+              # @param [String] configuration_retry_count The configuration.retry_count
               # @return [WebhookInstance] Updated WebhookInstance
               def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset)
                 context.update(

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

@@ -15,9 +15,7 @@ module Twilio
             ##
             # Initialize the RoleList
             # @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 Role
-            #   resource is associated with.
+            # @param [String] service_sid The service_sid
             # @return [RoleList] RoleList
             def initialize(version, service_sid: nil)
               super(version)
@@ -29,15 +27,9 @@ module Twilio
 
             ##
             # Create the RoleInstance
-            # @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`.
+            # @param [String] friendly_name The friendly_name
+            # @param [role.RoleType] type The type
+            # @param [String] permission The permission
             # @return [RoleInstance] Created RoleInstance
             def create(friendly_name: nil, type: nil, permission: nil)
               data = Twilio::Values.of({
@@ -171,10 +163,8 @@ module Twilio
             ##
             # Initialize the RoleContext
             # @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
-            #   Role resource from.
-            # @param [String] sid The SID of the Role resource to fetch.
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
             # @return [RoleContext] RoleContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -202,12 +192,7 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission A permission that you grant to the role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
-            #   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`.
+            # @param [String] permission The permission
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })
@@ -237,10 +222,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 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.
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
             # @return [RoleInstance] RoleInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -275,55 +258,55 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique string that identifies the resource
+            # @return [String] The sid
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The SID of the Account that created the resource
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The SID of the Service that the resource is associated with
+            # @return [String] The service_sid
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The string that you assigned to describe the resource
+            # @return [String] The friendly_name
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [role.RoleType] The type of role
+            # @return [role.RoleType] The type
             def type
               @properties['type']
             end
 
             ##
-            # @return [String] An array of the permissions the role has been granted
+            # @return [String] The permissions
             def permissions
               @properties['permissions']
             end
 
             ##
-            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+            # @return [Time] The date_created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+            # @return [Time] The date_updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The absolute URL of the Role resource
+            # @return [String] The url
             def url
               @properties['url']
             end
@@ -344,12 +327,7 @@ module Twilio
 
             ##
             # Update the RoleInstance
-            # @param [String] permission A permission that you grant to the role. Only one
-            #   permission can be granted per parameter. To assign more than one permission,
-            #   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`.
+            # @param [String] permission The permission
             # @return [RoleInstance] Updated RoleInstance
             def update(permission: nil)
               context.update(permission: permission, )

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

@@ -15,9 +15,7 @@ module Twilio
             ##
             # Initialize the UserList
             # @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 User
-            #   resource is associated with.
+            # @param [String] service_sid The service_sid
             # @return [UserList] UserList
             def initialize(version, service_sid: nil)
               super(version)
@@ -29,18 +27,10 @@ module Twilio
 
             ##
             # Create the UserInstance
-            # @param [String] identity The `identity` value that uniquely identifies the new
-            #   resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within
-            #   the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This
-            #   value is often a username or email address. See the Identity documentation for
-            #   more info.
-            # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the new
-            #   User.
-            # @param [String] attributes A valid JSON string that contains
-            #   application-specific data.
-            # @param [String] friendly_name A descriptive string that you create to describe
-            #   the new resource. This value is often used for display purposes.
+            # @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 [user.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Created UserInstance
@@ -178,11 +168,8 @@ module Twilio
             ##
             # Initialize the UserContext
             # @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
-            #   User resource from.
-            # @param [String] sid The SID of the User resource to fetch. This value can be
-            #   either the `sid` or the `identity` of the User resource to fetch.
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
             # @return [UserContext] UserContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -214,13 +201,9 @@ module Twilio
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the
-            #   User.
-            # @param [String] attributes A valid JSON string that contains
-            #   application-specific data.
-            # @param [String] friendly_name A descriptive string that you create to describe
-            #   the resource. It is often used for display purposes.
+            # @param [String] role_sid The role_sid
+            # @param [String] attributes The attributes
+            # @param [String] friendly_name The friendly_name
             # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Updated UserInstance
@@ -301,11 +284,8 @@ 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 SID of the
-            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the User
-            #   resource is associated with.
-            # @param [String] sid The SID of the User resource to fetch. This value can be
-            #   either the `sid` or the `identity` of the User resource to fetch.
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
             # @return [UserInstance] UserInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -345,85 +325,85 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique string that identifies the resource
+            # @return [String] The sid
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The SID of the Account that created the resource
+            # @return [String] The account_sid
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The SID of the Service that the resource is associated with
+            # @return [String] The service_sid
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The JSON string that stores application-specific data
+            # @return [String] The attributes
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [String] The string that you assigned to describe the resource
+            # @return [String] The friendly_name
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The SID of the Role assigned to the user
+            # @return [String] The role_sid
             def role_sid
               @properties['role_sid']
             end
 
             ##
-            # @return [String] The string that identifies the resource's User
+            # @return [String] The identity
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [Boolean] Whether the User is actively connected to the Service instance and online
+            # @return [Boolean] The is_online
             def is_online
               @properties['is_online']
             end
 
             ##
-            # @return [Boolean] Whether the User has a potentially valid Push Notification registration for the Service instance
+            # @return [Boolean] The is_notifiable
             def is_notifiable
               @properties['is_notifiable']
             end
 
             ##
-            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+            # @return [Time] The date_created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+            # @return [Time] The date_updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The number of Channels the User is a Member of
+            # @return [String] The joined_channels_count
             def joined_channels_count
               @properties['joined_channels_count']
             end
 
             ##
-            # @return [String] The absolute URLs of the Channel and Binding resources related to the user
+            # @return [String] The links
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] The absolute URL of the User resource
+            # @return [String] The url
             def url
               @properties['url']
             end
@@ -444,13 +424,9 @@ module Twilio
 
             ##
             # Update the UserInstance
-            # @param [String] role_sid The SID of the
-            #   [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the
-            #   User.
-            # @param [String] attributes A valid JSON string that contains
-            #   application-specific data.
-            # @param [String] friendly_name A descriptive string that you create to describe
-            #   the resource. It is often used for display purposes.
+            # @param [String] role_sid The role_sid
+            # @param [String] attributes The attributes
+            # @param [String] friendly_name The friendly_name
             # @param [user.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [UserInstance] Updated UserInstance