twilio-ruby 5.39.2 → 5.60.0

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

@@ -0,0 +1,260 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        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
+
+        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
+
+        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
+
+        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] An absolute URL for this global configuration.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] Absolute URLs to access the webhook and default service configurations.
+          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

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

@@ -12,15 +12,16 @@ module Twilio
       class V1 < Version
         class ConversationContext < InstanceContext
           class MessageContext < InstanceContext
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DeliveryReceiptList < ListResource
               ##
               # 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)
@@ -117,8 +118,6 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DeliveryReceiptPage < Page
               ##
               # Initialize the DeliveryReceiptPage
@@ -153,16 +152,16 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DeliveryReceiptContext < InstanceContext
               ##
               # 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
@@ -204,16 +203,17 @@ module Twilio
               end
             end
 
-            ##
-            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
             class DeliveryReceiptInstance < InstanceResource
               ##
               # 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 +222,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 +260,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 +279,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 +291,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
@@ -296,7 +303,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status
+              # @return [String] The message {delivery error code}[https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors] for a `failed` status
               def error_code
                 @properties['error_code']
               end

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

@@ -11,14 +11,13 @@ module Twilio
     class Conversations < Domain
       class V1 < Version
         class ConversationContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessageList < ListResource
             ##
             # 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 +39,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
@@ -64,6 +63,8 @@ module Twilio
             # Lists MessageInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
+            # @param [message.OrderType] order The sort order of the returned messages. Can
+            #   be: `asc` (ascending) or `desc` (descending), with `asc` as the default.
             # @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
@@ -71,14 +72,16 @@ module Twilio
             #    but a limit is defined, stream() will attempt to read the limit with the most
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Array] Array of up to limit results
-            def list(limit: nil, page_size: nil)
-              self.stream(limit: limit, page_size: page_size).entries
+            def list(order: :unset, limit: nil, page_size: nil)
+              self.stream(order: order, limit: limit, page_size: page_size).entries
             end
 
             ##
             # Streams MessageInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
+            # @param [message.OrderType] order The sort order of the returned messages. Can
+            #   be: `asc` (ascending) or `desc` (descending), with `asc` as the default.
             # @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
@@ -86,10 +89,10 @@ module Twilio
             #    but a limit is defined, stream() will attempt to read the limit with the most
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Enumerable] Enumerable that will yield up to limit results
-            def stream(limit: nil, page_size: nil)
+            def stream(order: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size], )
+              page = self.page(order: order, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -111,12 +114,15 @@ module Twilio
             ##
             # Retrieve a single page of MessageInstance records from the API.
             # Request is executed immediately.
+            # @param [message.OrderType] order The sort order of the returned messages. Can
+            #   be: `asc` (ascending) or `desc` (descending), with `asc` as the default.
             # @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
             # @return [Page] Page of MessageInstance
-            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(order: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
+                  'Order' => order,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
@@ -147,8 +153,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessagePage < Page
             ##
             # Initialize the MessagePage
@@ -178,14 +182,13 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessageContext < InstanceContext
             ##
             # 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
@@ -297,15 +300,14 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class MessageInstance < InstanceResource
             ##
             # 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 +349,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
@@ -383,7 +385,7 @@ module Twilio
             end
 
             ##
-            # @return [Hash] An array of objects that describe the Message's media if attached, otherwise, null.
+            # @return [Array[Hash]] An array of objects that describe the Message's media if attached, otherwise, null.
             def media
               @properties['media']
             end
@@ -395,7 +397,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
@@ -413,7 +415,7 @@ module Twilio
             end
 
             ##
-            # @return [String] An absolute URL for this message.
+            # @return [String] An absolute API URL for this message.
             def url
               @properties['url']
             end
@@ -425,7 +427,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Absolute URL to access the receipts of this message.
             def links
               @properties['links']
             end