twilio-ruby 5.40.2 → 5.43.0

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

@@ -17,11 +17,9 @@ module Twilio
           @version = 'v1'
           @configuration = nil
           @conversations = nil
-          @webhooks = nil
           @credentials = nil
           @roles = nil
           @services = nil
-          @notifications = nil
           @users = nil
         end
 
@@ -46,12 +44,6 @@ module Twilio
           end
         end
 
-        ##
-        # @return [Twilio::REST::Conversations::V1::WebhookContext]
-        def webhooks
-          @webhooks ||= WebhookContext.new self
-        end
-
         ##
         # @param [String] sid A 34 character string that uniquely identifies this
         #   resource.
@@ -96,22 +88,6 @@ module Twilio
           end
         end
 
-        ##
-        # @param [String] chat_service_sid The SID of the [Chat
-        #   Service](https://www.twilio.com/docs/chat/rest/service-resource) the
-        #   Configuration applies to.
-        # @return [Twilio::REST::Conversations::V1::NotificationContext] if chat_service_sid was passed.
-        # @return [Twilio::REST::Conversations::V1::NotificationList]
-        def notifications(chat_service_sid=:unset)
-          if chat_service_sid.nil?
-            raise ArgumentError, 'chat_service_sid cannot be nil'
-          elsif chat_service_sid == :unset
-            @notifications ||= NotificationList.new self
-          else
-            NotificationContext.new(self, chat_service_sid)
-          end
-        end
-
         ##
         # @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.

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

@@ -10,8 +10,6 @@ module Twilio
   module REST
     class Conversations < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConfigurationList < ListResource
           ##
           # Initialize the ConfigurationList
@@ -31,8 +29,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConfigurationPage < Page
           ##
           # Initialize the ConfigurationPage
@@ -62,8 +58,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConfigurationContext < InstanceContext
           ##
           # Initialize the ConfigurationContext
@@ -75,6 +69,9 @@ module Twilio
             # Path Solution
             @solution = {}
             @uri = "/Configuration"
+
+            # Components
+            @webhooks = nil
           end
 
           ##
@@ -88,11 +85,11 @@ module Twilio
 
           ##
           # Update the ConfigurationInstance
-          # @param [String] default_chat_service_sid The SID of the default [Chat
-          #   Service](https://www.twilio.com/docs/chat/rest/service-resource) to use when
-          #   creating a conversation.
-          # @param [String] default_messaging_service_sid The SID of the default [Messaging
-          #   Service](https://www.twilio.com/docs/sms/services/api) to use when creating a
+          # @param [String] default_chat_service_sid The SID of the default {Conversation
+          #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] to use
+          #   when creating a conversation.
+          # @param [String] default_messaging_service_sid The SID of the default {Messaging
+          #   Service}[https://www.twilio.com/docs/sms/services/api] to use when creating a
           #   conversation.
           # @param [String] default_inactive_timer Default ISO8601 duration when
           #   conversation will be switched to `inactive` state. Minimum value for this timer
@@ -113,6 +110,13 @@ module Twilio
             ConfigurationInstance.new(@version, payload, )
           end
 
+          ##
+          # Access the webhooks
+          # @return [WebhookContext] WebhookContext
+          def webhooks
+            return WebhookContext.new(@version, )
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -128,8 +132,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConfigurationInstance < InstanceResource
           ##
           # Initialize the ConfigurationInstance
@@ -173,7 +175,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The SID of the default Chat Service that every new conversation is associated with.
+          # @return [String] The SID of the default Conversation Service that every new conversation is associated with.
           def default_chat_service_sid
             @properties['default_chat_service_sid']
           end
@@ -197,13 +199,13 @@ module Twilio
           end
 
           ##
-          # @return [String] The url
+          # @return [String] An absolute URL for this global configuration.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Absolute URLs to access the webhook and default service configurations.
           def links
             @properties['links']
           end
@@ -217,11 +219,11 @@ module Twilio
 
           ##
           # Update the ConfigurationInstance
-          # @param [String] default_chat_service_sid The SID of the default [Chat
-          #   Service](https://www.twilio.com/docs/chat/rest/service-resource) to use when
-          #   creating a conversation.
-          # @param [String] default_messaging_service_sid The SID of the default [Messaging
-          #   Service](https://www.twilio.com/docs/sms/services/api) to use when creating a
+          # @param [String] default_chat_service_sid The SID of the default {Conversation
+          #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] to use
+          #   when creating a conversation.
+          # @param [String] default_messaging_service_sid The SID of the default {Messaging
+          #   Service}[https://www.twilio.com/docs/sms/services/api] to use when creating a
           #   conversation.
           # @param [String] default_inactive_timer Default ISO8601 duration when
           #   conversation will be switched to `inactive` state. Minimum value for this timer

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

@@ -0,0 +1,254 @@
+##
+# 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
+          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
+
+          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
+
+          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
+
+          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

@@ -10,8 +10,6 @@ module Twilio
   module REST
     class Conversations < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationList < ListResource
           ##
           # Initialize the ConversationList
@@ -34,8 +32,8 @@ module Twilio
           #   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
-          #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
+          # @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
           #   store any data you wish. The string value must contain structurally valid JSON
@@ -156,8 +154,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationPage < Page
           ##
           # Initialize the ConversationPage
@@ -187,8 +183,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationContext < InstanceContext
           ##
           # Initialize the ConversationContext
@@ -219,8 +213,8 @@ 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
-          #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
+          # @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
           #   either `active`, `inactive` or `closed` and defaults to `active`
@@ -228,10 +222,13 @@ module Twilio
           #   switched to `inactive` state. Minimum value for this timer is 1 minute.
           # @param [String] timers_closed ISO8601 duration when conversation will be
           #   switched to `closed` state. Minimum value for this timer is 10 minutes.
+          # @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 [conversation.WebhookEnabledType] x_twilio_webhook_enabled The
           #   X-Twilio-Webhook-Enabled HTTP request header
           # @return [ConversationInstance] Updated ConversationInstance
-          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, x_twilio_webhook_enabled: :unset)
+          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
@@ -241,6 +238,7 @@ module Twilio
                 'State' => state,
                 'Timers.Inactive' => timers_inactive,
                 'Timers.Closed' => timers_closed,
+                'UniqueName' => unique_name,
             })
             headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
 
@@ -338,8 +336,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ConversationInstance < InstanceResource
           ##
           # Initialize the ConversationInstance
@@ -385,19 +381,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
@@ -457,7 +453,7 @@ module Twilio
           end
 
           ##
-          # @return [String] Absolute URLs to access the Participants, Messages and Webhooks of this Conversation.
+          # @return [String] Absolute URLs to access the participants, messages and webhooks of this conversation.
           def links
             @properties['links']
           end
@@ -472,8 +468,8 @@ 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
-          #   Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs
+          # @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
           #   either `active`, `inactive` or `closed` and defaults to `active`
@@ -481,10 +477,13 @@ module Twilio
           #   switched to `inactive` state. Minimum value for this timer is 1 minute.
           # @param [String] timers_closed ISO8601 duration when conversation will be
           #   switched to `closed` state. Minimum value for this timer is 10 minutes.
+          # @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 [conversation.WebhookEnabledType] x_twilio_webhook_enabled The
           #   X-Twilio-Webhook-Enabled HTTP request header
           # @return [ConversationInstance] Updated ConversationInstance
-          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, x_twilio_webhook_enabled: :unset)
+          def update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, x_twilio_webhook_enabled: :unset)
             context.update(
                 friendly_name: friendly_name,
                 date_created: date_created,
@@ -494,6 +493,7 @@ module Twilio
                 state: state,
                 timers_inactive: timers_inactive,
                 timers_closed: timers_closed,
+                unique_name: unique_name,
                 x_twilio_webhook_enabled: x_twilio_webhook_enabled,
             )
           end