twilio-ruby 5.39.2 → 5.40.3

data/lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb

@@ -0,0 +1,262 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        class ConfigurationContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class WebhookList < ListResource
+            ##
+            # Initialize the WebhookList
+            # @param [Version] version Version that contains the resource
+            # @return [WebhookList] WebhookList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Conversations.V1.WebhookList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class WebhookPage < Page
+            ##
+            # Initialize the WebhookPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [WebhookPage] WebhookPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of WebhookInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [WebhookInstance] WebhookInstance
+            def get_instance(payload)
+              WebhookInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Conversations.V1.WebhookPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class WebhookContext < InstanceContext
+            ##
+            # Initialize the WebhookContext
+            # @param [Version] version Version that contains the resource
+            # @return [WebhookContext] WebhookContext
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+              @uri = "/Configuration/Webhooks"
+            end
+
+            ##
+            # Fetch the WebhookInstance
+            # @return [WebhookInstance] Fetched WebhookInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              WebhookInstance.new(@version, payload, )
+            end
+
+            ##
+            # Update the WebhookInstance
+            # @param [String] method The HTTP method to be used when sending a webhook
+            #   request.
+            # @param [String] filters The list of webhook event triggers that are enabled for
+            #   this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`,
+            #   `onConversationUpdated`, `onConversationRemoved`, `onParticipantAdded`,
+            #   `onParticipantUpdated`, `onParticipantRemoved`
+            # @param [String] pre_webhook_url The absolute url the pre-event webhook request
+            #   should be sent to.
+            # @param [String] post_webhook_url The absolute url the post-event webhook request
+            #   should be sent to.
+            # @param [webhook.Target] target The routing target of the webhook.
+            # @return [WebhookInstance] Updated WebhookInstance
+            def update(method: :unset, filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, target: :unset)
+              data = Twilio::Values.of({
+                  'Method' => method,
+                  'Filters' => Twilio.serialize_list(filters) { |e| e },
+                  'PreWebhookUrl' => pre_webhook_url,
+                  'PostWebhookUrl' => post_webhook_url,
+                  'Target' => target,
+              })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              WebhookInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class WebhookInstance < InstanceResource
+            ##
+            # Initialize the WebhookInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @return [WebhookInstance] WebhookInstance
+            def initialize(version, payload)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'account_sid' => payload['account_sid'],
+                  'method' => payload['method'],
+                  'filters' => payload['filters'],
+                  'pre_webhook_url' => payload['pre_webhook_url'],
+                  'post_webhook_url' => payload['post_webhook_url'],
+                  'target' => payload['target'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {}
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [WebhookContext] WebhookContext for this WebhookInstance
+            def context
+              unless @instance_context
+                @instance_context = WebhookContext.new(@version, )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique ID of the Account responsible for this conversation.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [webhook.Method] The HTTP method to be used when sending a webhook request.
+            def method
+              @properties['method']
+            end
+
+            ##
+            # @return [String] The list of webhook event triggers that are enabled for this Service.
+            def filters
+              @properties['filters']
+            end
+
+            ##
+            # @return [String] The absolute url the pre-event webhook request should be sent to.
+            def pre_webhook_url
+              @properties['pre_webhook_url']
+            end
+
+            ##
+            # @return [String] The absolute url the post-event webhook request should be sent to.
+            def post_webhook_url
+              @properties['post_webhook_url']
+            end
+
+            ##
+            # @return [webhook.Target] The routing target of the webhook.
+            def target
+              @properties['target']
+            end
+
+            ##
+            # @return [String] An absolute URL for this webhook.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the WebhookInstance
+            # @return [WebhookInstance] Fetched WebhookInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the WebhookInstance
+            # @param [String] method The HTTP method to be used when sending a webhook
+            #   request.
+            # @param [String] filters The list of webhook event triggers that are enabled for
+            #   this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`,
+            #   `onConversationUpdated`, `onConversationRemoved`, `onParticipantAdded`,
+            #   `onParticipantUpdated`, `onParticipantRemoved`
+            # @param [String] pre_webhook_url The absolute url the pre-event webhook request
+            #   should be sent to.
+            # @param [String] post_webhook_url The absolute url the post-event webhook request
+            #   should be sent to.
+            # @param [webhook.Target] target The routing target of the webhook.
+            # @return [WebhookInstance] Updated WebhookInstance
+            def update(method: :unset, filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, target: :unset)
+              context.update(
+                  method: method,
+                  filters: filters,
+                  pre_webhook_url: pre_webhook_url,
+                  post_webhook_url: post_webhook_url,
+                  target: target,
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/conversations/v1/conversation.rb

@@ -29,9 +29,12 @@ module Twilio
           # Create the ConversationInstance
           # @param [String] friendly_name The human-readable name of this conversation,
           #   limited to 256 characters. Optional.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used to address the resource in place of the
+          #   resource's `sid` in the URL.
           # @param [Time] date_created The date that this resource was created.
           # @param [Time] date_updated The date that this resource was last updated.
-          # @param [String] messaging_service_sid The unique id of the [SMS
+          # @param [String] messaging_service_sid The unique ID of the [Messaging
           #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
           #   to.
           # @param [String] attributes An optional string metadata field you can use to
@@ -47,9 +50,10 @@ module Twilio
           # @param [conversation.WebhookEnabledType] x_twilio_webhook_enabled The
           #   X-Twilio-Webhook-Enabled HTTP request header
           # @return [ConversationInstance] Created ConversationInstance
-          def create(friendly_name: :unset, date_created: :unset, date_updated: :unset, messaging_service_sid: :unset, attributes: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, x_twilio_webhook_enabled: :unset)
+          def create(friendly_name: :unset, unique_name: :unset, date_created: :unset, date_updated: :unset, messaging_service_sid: :unset, attributes: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, x_twilio_webhook_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
+                'UniqueName' => unique_name,
                 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
                 'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
                 'MessagingServiceSid' => messaging_service_sid,
@@ -190,7 +194,7 @@ module Twilio
           # Initialize the ConversationContext
           # @param [Version] version Version that contains the resource
           # @param [String] sid A 34 character string that uniquely identifies this
-          #   resource.
+          #   resource. Can also be the `unique_name` of the Conversation.
           # @return [ConversationContext] ConversationContext
           def initialize(version, sid)
             super(version)
@@ -215,7 +219,7 @@ module Twilio
           #   store any data you wish. The string value must contain structurally valid JSON
           #   if specified.  **Note** that if the attributes are not set "{}" will be
           #   returned.
-          # @param [String] messaging_service_sid The unique id of the [SMS
+          # @param [String] messaging_service_sid The unique ID of the [Messaging
           #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
           #   to.
           # @param [conversation.State] state Current state of this conversation. Can be
@@ -342,7 +346,7 @@ module Twilio
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
           # @param [String] sid A 34 character string that uniquely identifies this
-          #   resource.
+          #   resource. Can also be the `unique_name` of the Conversation.
           # @return [ConversationInstance] ConversationInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -354,6 +358,7 @@ module Twilio
                 'messaging_service_sid' => payload['messaging_service_sid'],
                 'sid' => payload['sid'],
                 'friendly_name' => payload['friendly_name'],
+                'unique_name' => payload['unique_name'],
                 'attributes' => payload['attributes'],
                 'state' => payload['state'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
@@ -380,19 +385,19 @@ module Twilio
           end
 
           ##
-          # @return [String] The unique id of the Account responsible for this conversation.
+          # @return [String] The unique ID of the Account responsible for this conversation.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The unique id of the Chat Service this conversation belongs to.
+          # @return [String] The unique ID of the Conversation Service this conversation belongs to.
           def chat_service_sid
             @properties['chat_service_sid']
           end
 
           ##
-          # @return [String] The unique id of the SMS Service this conversation belongs to.
+          # @return [String] The unique ID of the Messaging Service this conversation belongs to.
           def messaging_service_sid
             @properties['messaging_service_sid']
           end
@@ -409,6 +414,12 @@ module Twilio
             @properties['friendly_name']
           end
 
+          ##
+          # @return [String] An application-defined string that uniquely identifies the resource
+          def unique_name
+            @properties['unique_name']
+          end
+
           ##
           # @return [String] An optional string metadata field you can use to store any data you wish.
           def attributes
@@ -446,7 +457,7 @@ module Twilio
           end
 
           ##
-          # @return [String] Absolute URLs to access the Participants of this Conversation.
+          # @return [String] Absolute URLs to access the Participants, Messages and Webhooks of this Conversation.
           def links
             @properties['links']
           end
@@ -461,7 +472,7 @@ module Twilio
           #   store any data you wish. The string value must contain structurally valid JSON
           #   if specified.  **Note** that if the attributes are not set "{}" will be
           #   returned.
-          # @param [String] messaging_service_sid The unique id of the [SMS
+          # @param [String] messaging_service_sid The unique ID of the [Messaging
           #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
           #   to.
           # @param [conversation.State] state Current state of this conversation. Can be

data/lib/twilio-ruby/rest/conversations/v1/conversation/message.rb

@@ -17,8 +17,9 @@ module Twilio
             ##
             # Initialize the MessageList
             # @param [Version] version Version that contains the resource
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this message.
             # @return [MessageList] MessageList
             def initialize(version, conversation_sid: nil)
               super(version)
@@ -40,7 +41,7 @@ module Twilio
             # @param [String] attributes A string metadata field you can use to store any data
             #   you wish. The string value must contain structurally valid JSON if specified.
             #   **Note** that if the attributes are not set "{}" will be returned.
-            # @param [String] media_sid The Media Sid to be attached to the new Message.
+            # @param [String] media_sid The Media SID to be attached to the new Message.
             # @param [message.WebhookEnabledType] x_twilio_webhook_enabled The
             #   X-Twilio-Webhook-Enabled HTTP request header
             # @return [MessageInstance] Created MessageInstance
@@ -184,8 +185,9 @@ module Twilio
             ##
             # Initialize the MessageContext
             # @param [Version] version Version that contains the resource
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this message.
             # @param [String] sid A 34 character string that uniquely identifies this
             #   resource.
             # @return [MessageContext] MessageContext
@@ -304,8 +306,9 @@ module Twilio
             # Initialize the MessageInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] conversation_sid The unique id of the
-            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
+            # @param [String] conversation_sid The unique ID of the
+            #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+            #   for this message.
             # @param [String] sid A 34 character string that uniquely identifies this
             #   resource.
             # @return [MessageInstance] MessageInstance
@@ -347,13 +350,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique id of the Account responsible for this message.
+            # @return [String] The unique ID of the Account responsible for this message.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The unique id of the Conversation for this message.
+            # @return [String] The unique ID of the Conversation for this message.
             def conversation_sid
               @properties['conversation_sid']
             end
@@ -395,7 +398,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique id of messages's author participant.
+            # @return [String] The unique ID of messages's author participant.
             def participant_sid
               @properties['participant_sid']
             end

data/lib/twilio-ruby/rest/conversations/v1/conversation/message/delivery_receipt.rb

@@ -18,9 +18,12 @@ module Twilio
               ##
               # Initialize the DeliveryReceiptList
               # @param [Version] version Version that contains the resource
-              # @param [String] conversation_sid The conversation_sid
-              # @param [String] message_sid The sid of the message within a
-              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to
+              # @param [String] conversation_sid The unique ID of the
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   for this message.
+              # @param [String] message_sid The SID of the message within a
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   the delivery receipt belongs to
               # @return [DeliveryReceiptList] DeliveryReceiptList
               def initialize(version, conversation_sid: nil, message_sid: nil)
                 super(version)
@@ -159,10 +162,12 @@ module Twilio
               ##
               # Initialize the DeliveryReceiptContext
               # @param [Version] version Version that contains the resource
-              # @param [String] conversation_sid The unique id of the
-              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
-              # @param [String] message_sid The sid of the message within a
-              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to
+              # @param [String] conversation_sid The unique ID of the
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   for this message.
+              # @param [String] message_sid The SID of the message within a
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   the delivery receipt belongs to.
               # @param [String] sid A 34 character string that uniquely identifies this
               #   resource.
               # @return [DeliveryReceiptContext] DeliveryReceiptContext
@@ -211,9 +216,12 @@ module Twilio
               # Initialize the DeliveryReceiptInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] conversation_sid The conversation_sid
-              # @param [String] message_sid The sid of the message within a
-              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to
+              # @param [String] conversation_sid The unique ID of the
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   for this message.
+              # @param [String] message_sid The SID of the message within a
+              #   [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)
+              #   the delivery receipt belongs to
               # @param [String] sid A 34 character string that uniquely identifies this
               #   resource.
               # @return [DeliveryReceiptInstance] DeliveryReceiptInstance
@@ -222,9 +230,10 @@ module Twilio
 
                 # Marshaled Properties
                 @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'conversation_sid' => payload['conversation_sid'],
                     'sid' => payload['sid'],
                     'message_sid' => payload['message_sid'],
-                    'conversation_sid' => payload['conversation_sid'],
                     'channel_message_sid' => payload['channel_message_sid'],
                     'participant_sid' => payload['participant_sid'],
                     'status' => payload['status'],
@@ -259,6 +268,18 @@ module Twilio
                 @instance_context
               end
 
+              ##
+              # @return [String] The unique ID of the Account responsible for this participant.
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The unique ID of the Conversation for this message.
+              def conversation_sid
+                @properties['conversation_sid']
+              end
+
               ##
               # @return [String] A 34 character string that uniquely identifies this resource.
               def sid
@@ -266,17 +287,11 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid of the message the delivery receipt belongs to
+              # @return [String] The SID of the message the delivery receipt belongs to
               def message_sid
                 @properties['message_sid']
               end
 
-              ##
-              # @return [String] The conversation_sid
-              def conversation_sid
-                @properties['conversation_sid']
-              end
-
               ##
               # @return [String] A messaging channel-specific identifier for the message delivered to participant
               def channel_message_sid
@@ -284,7 +299,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique id of the participant the delivery receipt belongs to.
+              # @return [String] The unique ID of the participant the delivery receipt belongs to.
               def participant_sid
                 @properties['participant_sid']
               end