twilio-ruby 5.39.2 → 5.40.3

data/lib/twilio-ruby/rest/autopilot/v1/assistant/query.rb

@@ -34,7 +34,9 @@ module Twilio
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
             # @param [String] language The [ISO
-            #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used by the Query resources to read. For example: `en-US`.
+            #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+            #   string that specifies the language used by the Query resources to read. For
+            #   example: `en-US`.
             # @param [String] model_build The SID or unique name of the [Model
             #   Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
             # @param [String] status The status of the resources to read. Can be:
@@ -64,7 +66,9 @@ module Twilio
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             # @param [String] language The [ISO
-            #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used by the Query resources to read. For example: `en-US`.
+            #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+            #   string that specifies the language used by the Query resources to read. For
+            #   example: `en-US`.
             # @param [String] model_build The SID or unique name of the [Model
             #   Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
             # @param [String] status The status of the resources to read. Can be:
@@ -110,7 +114,9 @@ module Twilio
             # Retrieve a single page of QueryInstance records from the API.
             # Request is executed immediately.
             # @param [String] language The [ISO
-            #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used by the Query resources to read. For example: `en-US`.
+            #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+            #   string that specifies the language used by the Query resources to read. For
+            #   example: `en-US`.
             # @param [String] model_build The SID or unique name of the [Model
             #   Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
             # @param [String] status The status of the resources to read. Can be:
@@ -153,7 +159,8 @@ module Twilio
             ##
             # Create the QueryInstance
             # @param [String] language The [ISO
-            #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the new query. For example: `en-US`.
+            #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+            #   string that specifies the language used for the new query. For example: `en-US`.
             # @param [String] query The end-user's natural language input. It can be up to
             #   2048 characters long.
             # @param [String] tasks The list of tasks to limit the new query to. Tasks are

data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/sample.rb

@@ -38,7 +38,8 @@ module Twilio
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
               # @param [String] language The [ISO
-              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.
+              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+              #   string that specifies the language used for the sample. For example: `en-US`.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit.  Default is no limit
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -55,7 +56,8 @@ module Twilio
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
               # @param [String] language The [ISO
-              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.
+              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+              #   string that specifies the language used for the sample. For example: `en-US`.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit. Default is no limit.
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -89,7 +91,8 @@ module Twilio
               # Retrieve a single page of SampleInstance records from the API.
               # Request is executed immediately.
               # @param [String] language The [ISO
-              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.
+              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+              #   string that specifies the language used for the sample. For example: `en-US`.
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
@@ -123,7 +126,9 @@ module Twilio
               ##
               # Create the SampleInstance
               # @param [String] language The [ISO
-              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the new sample. For example: `en-US`.
+              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+              #   string that specifies the language used for the new sample. For example:
+              #   `en-US`.
               # @param [String] tagged_text The text example of how end users might express the
               #   task. The sample can contain [Field tag
               #   blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).
@@ -232,7 +237,8 @@ module Twilio
               ##
               # Update the SampleInstance
               # @param [String] language The [ISO
-              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.
+              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+              #   string that specifies the language used for the sample. For example: `en-US`.
               # @param [String] tagged_text The text example of how end users might express the
               #   task. The sample can contain [Field tag
               #   blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).
@@ -408,7 +414,8 @@ module Twilio
               ##
               # Update the SampleInstance
               # @param [String] language The [ISO
-              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.
+              #   language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
+              #   string that specifies the language used for the sample. For example: `en-US`.
               # @param [String] tagged_text The text example of how end users might express the
               #   task. The sample can contain [Field tag
               #   blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).

data/lib/twilio-ruby/rest/client.rb

@@ -33,6 +33,7 @@ module Twilio
         @autopilot = nil
         @chat = nil
         @conversations = nil
+        @events = nil
         @fax = nil
         @flex_api = nil
         @insights = nil
@@ -160,6 +161,12 @@ module Twilio
         @conversations ||= Conversations.new self
       end
 
+      ##
+      # Access the Events Twilio Domain
+      def events
+        @events ||= Events.new self
+      end
+
       ##
       # Access the Fax Twilio Domain
       def fax

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

@@ -28,6 +28,12 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @return [Twilio::REST::Conversations::V1::ConfigurationInstance]
+      def configuration
+        self.v1.configuration()
+      end
+
       ##
       # @param [String] sid A 34 character string that uniquely identifies this
       #   resource.
@@ -38,9 +44,39 @@ module Twilio
       end
 
       ##
-      # @return [Twilio::REST::Conversations::V1::WebhookInstance]
-      def webhooks
-        self.v1.webhooks()
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Conversations::V1::CredentialInstance] if sid was passed.
+      # @return [Twilio::REST::Conversations::V1::CredentialList]
+      def credentials(sid=:unset)
+        self.v1.credentials(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Role
+      #   resource.
+      # @return [Twilio::REST::Conversations::V1::RoleInstance] if sid was passed.
+      # @return [Twilio::REST::Conversations::V1::RoleList]
+      def roles(sid=:unset)
+        self.v1.roles(sid)
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Conversations::V1::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Conversations::V1::ServiceList]
+      def services(sid=:unset)
+        self.v1.services(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the User
+      #   resource.
+      # @return [Twilio::REST::Conversations::V1::UserInstance] if sid was passed.
+      # @return [Twilio::REST::Conversations::V1::UserList]
+      def users(sid=:unset)
+        self.v1.users(sid)
       end
 
       ##

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

@@ -15,13 +15,23 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
+          @configuration = nil
           @conversations = nil
-          @webhooks = nil
+          @credentials = nil
+          @roles = nil
+          @services = nil
+          @users = nil
+        end
+
+        ##
+        # @return [Twilio::REST::Conversations::V1::ConfigurationContext]
+        def configuration
+          @configuration ||= ConfigurationContext.new self
         end
 
         ##
         # @param [String] sid A 34 character string that uniquely identifies this
-        #   resource.
+        #   resource. Can also be the `unique_name` of the Conversation.
         # @return [Twilio::REST::Conversations::V1::ConversationContext] if sid was passed.
         # @return [Twilio::REST::Conversations::V1::ConversationList]
         def conversations(sid=:unset)
@@ -35,9 +45,62 @@ module Twilio
         end
 
         ##
-        # @return [Twilio::REST::Conversations::V1::WebhookContext]
-        def webhooks
-          @webhooks ||= WebhookContext.new self
+        # @param [String] sid A 34 character string that uniquely identifies this
+        #   resource.
+        # @return [Twilio::REST::Conversations::V1::CredentialContext] if sid was passed.
+        # @return [Twilio::REST::Conversations::V1::CredentialList]
+        def credentials(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @credentials ||= CredentialList.new self
+          else
+            CredentialContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The SID of the Role resource to fetch.
+        # @return [Twilio::REST::Conversations::V1::RoleContext] if sid was passed.
+        # @return [Twilio::REST::Conversations::V1::RoleList]
+        def roles(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @roles ||= RoleList.new self
+          else
+            RoleContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid A 34 character string that uniquely identifies this
+        #   resource.
+        # @return [Twilio::REST::Conversations::V1::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Conversations::V1::ServiceList]
+        def services(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @services ||= ServiceList.new self
+          else
+            ServiceContext.new(self, 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.
+        # @return [Twilio::REST::Conversations::V1::UserContext] if sid was passed.
+        # @return [Twilio::REST::Conversations::V1::UserList]
+        def users(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @users ||= UserList.new self
+          else
+            UserContext.new(self, sid)
+          end
         end
 
         ##

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

@@ -0,0 +1,268 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+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
+          # @param [Version] version Version that contains the resource
+          # @return [ConfigurationList] ConfigurationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Conversations.V1.ConfigurationList>'
+          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
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ConfigurationPage] ConfigurationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ConfigurationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ConfigurationInstance] ConfigurationInstance
+          def get_instance(payload)
+            ConfigurationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Conversations.V1.ConfigurationPage>'
+          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
+          # @param [Version] version Version that contains the resource
+          # @return [ConfigurationContext] ConfigurationContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Configuration"
+
+            # Components
+            @webhooks = nil
+          end
+
+          ##
+          # Fetch the ConfigurationInstance
+          # @return [ConfigurationInstance] Fetched ConfigurationInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            ConfigurationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Update the ConfigurationInstance
+          # @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
+          #   is 1 minute.
+          # @param [String] default_closed_timer Default ISO8601 duration when conversation
+          #   will be switched to `closed` state. Minimum value for this timer is 10 minutes.
+          # @return [ConfigurationInstance] Updated ConfigurationInstance
+          def update(default_chat_service_sid: :unset, default_messaging_service_sid: :unset, default_inactive_timer: :unset, default_closed_timer: :unset)
+            data = Twilio::Values.of({
+                'DefaultChatServiceSid' => default_chat_service_sid,
+                'DefaultMessagingServiceSid' => default_messaging_service_sid,
+                'DefaultInactiveTimer' => default_inactive_timer,
+                'DefaultClosedTimer' => default_closed_timer,
+            })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            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
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.ConfigurationContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.ConfigurationContext #{context}>"
+          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
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [ConfigurationInstance] ConfigurationInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'default_chat_service_sid' => payload['default_chat_service_sid'],
+                'default_messaging_service_sid' => payload['default_messaging_service_sid'],
+                'default_inactive_timer' => payload['default_inactive_timer'],
+                'default_closed_timer' => payload['default_closed_timer'],
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # 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 [ConfigurationContext] ConfigurationContext for this ConfigurationInstance
+          def context
+            unless @instance_context
+              @instance_context = ConfigurationContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The SID of the Account responsible for this configuration.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @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
+
+          ##
+          # @return [String] The SID of the default Messaging Service that every new conversation is associated with.
+          def default_messaging_service_sid
+            @properties['default_messaging_service_sid']
+          end
+
+          ##
+          # @return [String] Default ISO8601 duration when conversation will be switched to `inactive` state.
+          def default_inactive_timer
+            @properties['default_inactive_timer']
+          end
+
+          ##
+          # @return [String] Default ISO8601 duration when conversation will be switched to `closed` state.
+          def default_closed_timer
+            @properties['default_closed_timer']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch the ConfigurationInstance
+          # @return [ConfigurationInstance] Fetched ConfigurationInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the ConfigurationInstance
+          # @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
+          #   is 1 minute.
+          # @param [String] default_closed_timer Default ISO8601 duration when conversation
+          #   will be switched to `closed` state. Minimum value for this timer is 10 minutes.
+          # @return [ConfigurationInstance] Updated ConfigurationInstance
+          def update(default_chat_service_sid: :unset, default_messaging_service_sid: :unset, default_inactive_timer: :unset, default_closed_timer: :unset)
+            context.update(
+                default_chat_service_sid: default_chat_service_sid,
+                default_messaging_service_sid: default_messaging_service_sid,
+                default_inactive_timer: default_inactive_timer,
+                default_closed_timer: default_closed_timer,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.ConfigurationInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.ConfigurationInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end