twilio-ruby 5.31.1 → 5.54.0

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

@@ -17,10 +17,10 @@ module Twilio
               # Initialize the MessageList
               # @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 Message
+              #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Message
               #   resource is associated with.
               # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) the Message resource
+              #   {Channel}[https://www.twilio.com/docs/chat/channels] the Message resource
               #   belongs to.
               # @return [MessageList] MessageList
               def initialize(version, service_sid: nil, channel_sid: nil)
@@ -32,31 +32,32 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of MessageInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity)
+              # Create the MessageInstance
+              # @param [String] from The {Identity}[https://www.twilio.com/docs/chat/identity]
               #   of the new message's author. The default value is `system`.
               # @param [String] attributes A valid JSON string that contains
               #   application-specific data.
-              # @param [Time] date_created The date, specified in [ISO
-              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              # @param [Time] date_created The date, specified in {ISO
+              #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
               #   as the date it was created. The default value is the current time set by the
               #   Chat service. This parameter should only be used when a Chat's history is being
               #   recreated from a backup/separate source.
-              # @param [Time] date_updated The date, specified in [ISO
-              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              # @param [Time] date_updated The date, specified in {ISO
+              #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
               #   as the date it was last updated.
               # @param [String] last_updated_by The
-              #   [Identity](https://www.twilio.com/docs/chat/identity) of the User who last
+              #   {Identity}[https://www.twilio.com/docs/chat/identity] of the User who last
               #   updated the Message, if applicable.
               # @param [String] body The message to send to the channel. Can be an empty string
               #   or `null`, which sets the value as an empty string. You can send structured data
               #   in the body by serializing it as a string.
               # @param [String] media_sid The SID of the
-              #   [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new
+              #   {Media}[https://www.twilio.com/docs/chat/rest/media] to attach to the new
               #   Message.
-              # @return [MessageInstance] Newly created MessageInstance
-              def create(from: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, body: :unset, media_sid: :unset)
+              # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
+              #   X-Twilio-Webhook-Enabled HTTP request header
+              # @return [MessageInstance] Created MessageInstance
+              def create(from: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, body: :unset, media_sid: :unset, x_twilio_webhook_enabled: :unset)
                 data = Twilio::Values.of({
                     'From' => from,
                     'Attributes' => attributes,
@@ -66,12 +67,9 @@ module Twilio
                     'Body' => body,
                     'MediaSid' => media_sid,
                 })
+                headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data, headers: headers)
 
                 MessageInstance.new(
                     @version,
@@ -149,11 +147,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 MessagePage.new(@version, response, @solution)
               end
 
@@ -216,10 +212,10 @@ module Twilio
               # Initialize the MessageContext
               # @param [Version] version Version that contains the resource
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
+              #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the
               #   Message resource from.
               # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) the Message resource to
+              #   {Channel}[https://www.twilio.com/docs/chat/channels] the Message resource to
               #   fetch belongs to. This value can be the Channel resource's `sid` or
               #   `unique_name`.
               # @param [String] sid The SID of the Message resource to fetch.
@@ -233,16 +229,10 @@ module Twilio
               end
 
               ##
-              # Fetch a MessageInstance
+              # Fetch the MessageInstance
               # @return [MessageInstance] Fetched MessageInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 MessageInstance.new(
                     @version,
@@ -254,10 +244,14 @@ module Twilio
               end
 
               ##
-              # Deletes the MessageInstance
+              # Delete the MessageInstance
+              # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
+              #   X-Twilio-Webhook-Enabled HTTP request header
               # @return [Boolean] true if delete succeeds, false otherwise
-              def delete
-                @version.delete('delete', @uri)
+              def delete(x_twilio_webhook_enabled: :unset)
+                headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+
+                 @version.delete('DELETE', @uri, headers: headers)
               end
 
               ##
@@ -267,21 +261,23 @@ module Twilio
               #   in the body by serializing it as a string.
               # @param [String] attributes A valid JSON string that contains
               #   application-specific data.
-              # @param [Time] date_created The date, specified in [ISO
-              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              # @param [Time] date_created The date, specified in {ISO
+              #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
               #   as the date it was created. The default value is the current time set by the
               #   Chat service. This parameter should only be used when a Chat's history is being
               #   recreated from a backup/separate source.
-              # @param [Time] date_updated The date, specified in [ISO
-              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              # @param [Time] date_updated The date, specified in {ISO
+              #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
               #   as the date it was last updated.
               # @param [String] last_updated_by The
-              #   [Identity](https://www.twilio.com/docs/chat/identity) of the User who last
+              #   {Identity}[https://www.twilio.com/docs/chat/identity] of the User who last
               #   updated the Message, if applicable.
-              # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity)
+              # @param [String] from The {Identity}[https://www.twilio.com/docs/chat/identity]
               #   of the message's author.
+              # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
+              #   X-Twilio-Webhook-Enabled HTTP request header
               # @return [MessageInstance] Updated MessageInstance
-              def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset)
+              def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset, x_twilio_webhook_enabled: :unset)
                 data = Twilio::Values.of({
                     'Body' => body,
                     'Attributes' => attributes,
@@ -290,12 +286,9 @@ module Twilio
                     'LastUpdatedBy' => last_updated_by,
                     'From' => from,
                 })
+                headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data, headers: headers)
 
                 MessageInstance.new(
                     @version,
@@ -327,10 +320,10 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Message
+              #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the Message
               #   resource is associated with.
               # @param [String] channel_sid The SID of the
-              #   [Channel](https://www.twilio.com/docs/chat/channels) the Message resource
+              #   {Channel}[https://www.twilio.com/docs/chat/channels] the Message resource
               #   belongs to.
               # @param [String] sid The SID of the Message resource to fetch.
               # @return [MessageInstance] MessageInstance
@@ -479,17 +472,19 @@ module Twilio
               end
 
               ##
-              # Fetch a MessageInstance
+              # Fetch the MessageInstance
               # @return [MessageInstance] Fetched MessageInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the MessageInstance
+              # Delete the MessageInstance
+              # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
+              #   X-Twilio-Webhook-Enabled HTTP request header
               # @return [Boolean] true if delete succeeds, false otherwise
-              def delete
-                context.delete
+              def delete(x_twilio_webhook_enabled: :unset)
+                context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
               end
 
               ##
@@ -499,21 +494,23 @@ module Twilio
               #   in the body by serializing it as a string.
               # @param [String] attributes A valid JSON string that contains
               #   application-specific data.
-              # @param [Time] date_created The date, specified in [ISO
-              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              # @param [Time] date_created The date, specified in {ISO
+              #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
               #   as the date it was created. The default value is the current time set by the
               #   Chat service. This parameter should only be used when a Chat's history is being
               #   recreated from a backup/separate source.
-              # @param [Time] date_updated The date, specified in [ISO
-              #   8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource
+              # @param [Time] date_updated The date, specified in {ISO
+              #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format, to assign to the resource
               #   as the date it was last updated.
               # @param [String] last_updated_by The
-              #   [Identity](https://www.twilio.com/docs/chat/identity) of the User who last
+              #   {Identity}[https://www.twilio.com/docs/chat/identity] of the User who last
               #   updated the Message, if applicable.
-              # @param [String] from The [Identity](https://www.twilio.com/docs/chat/identity)
+              # @param [String] from The {Identity}[https://www.twilio.com/docs/chat/identity]
               #   of the message's author.
+              # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
+              #   X-Twilio-Webhook-Enabled HTTP request header
               # @return [MessageInstance] Updated MessageInstance
-              def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset)
+              def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset, from: :unset, x_twilio_webhook_enabled: :unset)
                 context.update(
                     body: body,
                     attributes: attributes,
@@ -521,6 +518,7 @@ module Twilio
                     date_updated: date_updated,
                     last_updated_by: last_updated_by,
                     from: from,
+                    x_twilio_webhook_enabled: x_twilio_webhook_enabled,
                 )
               end
 

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

@@ -17,10 +17,10 @@ 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
+              #   {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
+              #   {Channel}[https://www.twilio.com/docs/chat/channels] the Channel Webhook
               #   resource belongs to.
               # @return [WebhookList] WebhookList
               def initialize(version, service_sid: nil, channel_sid: nil)
@@ -92,11 +92,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 WebhookPage.new(@version, response, @solution)
               end
 
@@ -114,30 +112,30 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of WebhookInstance records from the API.
-              # Request is executed immediately.
+              # 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 [Array[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 [Array[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
+              #   {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.
-              # @return [WebhookInstance] Newly created WebhookInstance
+              # @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({
                     'Type' => type,
@@ -149,11 +147,7 @@ module Twilio
                     'Configuration.RetryCount' => configuration_retry_count,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 WebhookInstance.new(
                     @version,
@@ -209,10 +203,10 @@ 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
+              #   {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
+              #   {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.
@@ -226,16 +220,10 @@ module Twilio
               end
 
               ##
-              # Fetch a WebhookInstance
+              # Fetch the WebhookInstance
               # @return [WebhookInstance] Fetched WebhookInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 WebhookInstance.new(
                     @version,
@@ -252,17 +240,18 @@ module Twilio
               #   `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 [Array[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 [Array[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
+              #   {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,
@@ -278,11 +267,7 @@ module Twilio
                     'Configuration.RetryCount' => configuration_retry_count,
                 })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 WebhookInstance.new(
                     @version,
@@ -294,10 +279,10 @@ module Twilio
               end
 
               ##
-              # Deletes the WebhookInstance
+              # Delete the WebhookInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -321,10 +306,10 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] service_sid The SID of the
-              #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel
+              #   {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
+              #   {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.
               # @return [WebhookInstance] WebhookInstance
@@ -424,7 +409,7 @@ module Twilio
               end
 
               ##
-              # Fetch a WebhookInstance
+              # Fetch the WebhookInstance
               # @return [WebhookInstance] Fetched WebhookInstance
               def fetch
                 context.fetch
@@ -436,17 +421,18 @@ module Twilio
               #   `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 [Array[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 [Array[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
+              #   {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,
@@ -464,7 +450,7 @@ module Twilio
               end
 
               ##
-              # Deletes the WebhookInstance
+              # Delete the WebhookInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete