twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,8 +16,12 @@ module Twilio
               ##
               # Initialize the WebhookList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_sid
+              # @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.
               # @return [WebhookList] WebhookList
               def initialize(version, service_sid: nil, channel_sid: nil)
                 super(version)
@@ -88,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
 
@@ -110,16 +112,30 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of WebhookInstance records from the API.
-              # Request is executed immediately.
-              # @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] Newly created WebhookInstance
+              # 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 [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
+              #   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] 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,
@@ -131,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,
@@ -190,9 +202,14 @@ module Twilio
               ##
               # Initialize the WebhookContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] channel_sid The channel_sid
-              # @param [String] sid The sid
+              # @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.
               # @return [WebhookContext] WebhookContext
               def initialize(version, service_sid, channel_sid, sid)
                 super(version)
@@ -203,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,
@@ -225,12 +236,26 @@ module Twilio
 
               ##
               # Update the WebhookInstance
-              # @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
+              # @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 [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
+              #   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.
               # @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({
@@ -242,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,
@@ -258,10 +279,10 @@ module Twilio
               end
 
               ##
-              # Deletes the WebhookInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the WebhookInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -270,6 +291,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Chat.V2.WebhookContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V2.WebhookContext #{context}>"
+              end
             end
 
             class WebhookInstance < InstanceResource
@@ -277,9 +305,13 @@ 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 service_sid
-              # @param [String] channel_sid The channel_sid
-              # @param [String] sid The sid
+              # @param [String] service_sid The SID of the
+              #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the 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.
               # @return [WebhookInstance] WebhookInstance
               def initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil)
                 super(version)
@@ -323,61 +355,61 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The service_sid
+              # @return [String] The SID of the Service that the Channel Webhook resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The channel_sid
+              # @return [String] The SID of the Channel the Channel Webhook resource belongs to
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [String] The type
+              # @return [String] The type of webhook
               def type
                 @properties['type']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Channel Webhook resource
               def url
                 @properties['url']
               end
 
               ##
-              # @return [Hash] The configuration
+              # @return [Hash] The JSON string that describes the configuration object for the channel webhook
               def configuration
                 @properties['configuration']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # Fetch a WebhookInstance
+              # Fetch the WebhookInstance
               # @return [WebhookInstance] Fetched WebhookInstance
               def fetch
                 context.fetch
@@ -385,12 +417,26 @@ module Twilio
 
               ##
               # Update the WebhookInstance
-              # @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
+              # @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 [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
+              #   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.
               # @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(
@@ -404,8 +450,8 @@ module Twilio
               end
 
               ##
-              # Deletes the WebhookInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the WebhookInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end