twilio-ruby 7.10.6 → 7.11.1

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

@@ -0,0 +1,507 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Conversation Orchestrator
+#    Manage configurations, conversations, participants, and communications. Create configurations to define capture rules and channel settings, then use conversations to group related communications.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Conversations < ConversationsBase
+            class V2 < Version
+                class ActionList < ListResource
+                
+                    class ConversationsV2SendMessageContent
+                            # @param [text]: [String] Plain text message body.
+                            # @param [content_id]: [String] Content template ID (HX... format). When provided, the template is rendered with the variables map and sent to the recipient. 
+                            # @param [variables]: [Hash<String, String>] Variables to substitute into the content template.
+                            # @param [media_urls]: [Array<String>] URLs of media attachments to include with the message.
+                        attr_accessor :text, :content_id, :variables, :media_urls
+                        def initialize(payload)
+                                @text = payload["text"]
+                                @content_id = payload["content_id"]
+                                @variables = payload["variables"]
+                                @media_urls = payload["media_urls"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "text": @text,
+                                "contentId": @content_id,
+                                "variables": @variables,
+                                "mediaUrls": @media_urls,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ConversationsV2SendMessageParticipant
+                            # @param [participant_id]: [String] Participant ID to resolve address from.
+                            # @param [address]: [String] Explicit address formatted according to channel type.
+                            # @param [channel]: [ConversationsV2Channel] 
+                        attr_accessor :participant_id, :address, :channel
+                        def initialize(payload)
+                                @participant_id = payload["participant_id"]
+                                @address = payload["address"]
+                                @channel = payload["channel"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "participantId": @participant_id,
+                                "address": @address,
+                                "channel": @channel,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class ConversationsV2SendMessagePayload
+                            # @param [from]: [ActionList.ConversationsV2SendMessageParticipant] 
+                            # @param [to]: [Array<ActionList.ConversationsV2SendMessageParticipant>] The recipients of this action.
+                            # @param [content]: [ActionList.ConversationsV2SendMessageContent] 
+                            # @param [channel_settings]: [Hash<String, Object>] Channel-specific parameters forwarded as-is to the downstream sending service. Allows passing backend-specific fields without requiring API changes. 
+                        attr_accessor :from, :to, :content, :channel_settings
+                        def initialize(payload)
+                                @from = payload["from"]
+                                @to = payload["to"]
+                                @content = payload["content"]
+                                @channel_settings = payload["channel_settings"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "from": @from,
+                                "to": @to,
+                                "content": @content,
+                                "channelSettings": @channel_settings,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateConversationActionRequest
+                            # @param [type]: [String] Action type discriminator. Accepted values: SEND_MESSAGE.
+                            # @param [payload]: [ActionList.ConversationsV2SendMessagePayload] 
+                        attr_accessor :type, :payload
+                        def initialize(payload)
+                                @type = payload["type"]
+                                @payload = payload["payload"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "type": @type,
+                                "payload": @payload,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the ActionList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ActionList] ActionList
+                    def initialize(version, conversation_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = { conversation_id: conversation_id }
+                        @uri = "/Conversations/#{@solution[:conversation_id]}/Actions"
+                        
+                    end
+                    ##
+                    # Create the ActionInstance
+                    # @param [CreateConversationActionRequest] create_conversation_action_request The action to perform.
+                    # @return [ActionInstance] Created ActionInstance
+                    def create(create_conversation_action_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: create_conversation_action_request.to_json)
+                        ActionInstance.new(
+                            @version,
+                            payload,
+                            conversation_id: @solution[:conversation_id],
+                        )
+                    end
+
+                    ##
+                    # Create the ActionInstanceMetadata
+                    # @param [CreateConversationActionRequest] create_conversation_action_request The action to perform.
+                    # @return [ActionInstance] Created ActionInstance
+                    def create_with_metadata(create_conversation_action_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: create_conversation_action_request.to_json)
+                        action_instance = ActionInstance.new(
+                            @version,
+                            response.body,
+                            conversation_id: @solution[:conversation_id],
+                        )
+                        ActionInstanceMetadata.new(
+                            @version,
+                            action_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Conversations.V2.ActionList>'
+                    end
+                end
+
+
+                class ActionContext < InstanceContext
+                    ##
+                    # Initialize the ActionContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] conversation_id 
+                    # @param [String] action_id 
+                    # @return [ActionContext] ActionContext
+                    def initialize(version, conversation_id, action_id)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { conversation_id: conversation_id, action_id: action_id,  }
+                        @uri = "/Conversations/#{@solution[:conversation_id]}/Actions/#{@solution[:action_id]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the ActionInstance
+                    # @return [ActionInstance] Fetched ActionInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        ActionInstance.new(
+                            @version,
+                            payload,
+                            conversation_id: @solution[:conversation_id],
+                            action_id: @solution[:action_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the ActionInstanceMetadata
+                    # @return [ActionInstance] Fetched ActionInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        action_instance = ActionInstance.new(
+                            @version,
+                            response.body,
+                            conversation_id: @solution[:conversation_id],
+                            action_id: @solution[:action_id],
+                        )
+                        ActionInstanceMetadata.new(
+                            @version,
+                            action_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Conversations.V2.ActionContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Conversations.V2.ActionContext #{context}>"
+                    end
+                end
+
+                class ActionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ActionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ActionInstance] action_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [ActionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, action_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @action_instance = action_instance
+                    end
+
+                    def action
+                        @action_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ActionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ActionListResponse < InstanceListResource
+                    # @param [Array<ActionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @action_instance = payload.body[key].map do |data|
+                        ActionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def action_instance
+                          @instance
+                      end
+                  end
+
+                class ActionPage < TokenPage
+                    ##
+                    # Initialize the ActionPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ActionPage] ActionPage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ActionInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ActionInstance] ActionInstance
+                    def get_instance(payload)
+                        ActionInstance.new(@version, payload, conversation_id: @solution[:conversation_id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Conversations.V2.ActionPage>'
+                    end
+                end
+
+                class ActionPageMetadata < PageMetadata
+                    attr_reader :action_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @action_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @action_page << ActionListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @action_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Conversations::V2PageMetadata>';
+                    end
+                end
+                class ActionListResponse < InstanceListResource
+
+                    # @param [Array<ActionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @action = data_list.map do |data|
+                        ActionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def action
+                        @action
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ActionInstance < InstanceResource
+                    ##
+                    # Initialize the ActionInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Action
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ActionInstance] ActionInstance
+                    def initialize(version, payload , conversation_id: nil, action_id: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'type' => payload['type'],
+                            'status' => payload['status'],
+                            'conversation_id' => payload['conversation_id'],
+                            'related' => payload['related'],
+                            'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                            'updated_at' => Twilio.deserialize_iso8601_datetime(payload['updated_at']),
+                            'completed_at' => Twilio.deserialize_iso8601_datetime(payload['completed_at']),
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'conversation_id' => conversation_id  || @properties['conversation_id']  ,'action_id' => action_id  || @properties['action_id']  , }
+                    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 [ActionContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ActionContext.new(@version , @params['conversation_id'], @params['action_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] Unique identifier for this Action.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] The type of action. Accepted values: SEND_MESSAGE.
+                    def type
+                        @properties['type']
+                    end
+                    
+                    ##
+                    # @return [ConversationsV2ActionStatus] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] The conversation this action belongs to.
+                    def conversation_id
+                        @properties['conversation_id']
+                    end
+                    
+                    ##
+                    # @return [Hash<String, String>] Named identifiers from downstream. For SEND_MESSAGE: - messageSid: The downstream message SID (present when PENDING or COMPLETED) - communicationId: The Communication ID (present when COMPLETED) 
+                    def related
+                        @properties['related']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp when the action was created.
+                    def created_at
+                        @properties['created_at']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp when the action was last updated.
+                    def updated_at
+                        @properties['updated_at']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp when the action reached a terminal status.
+                    def completed_at
+                        @properties['completed_at']
+                    end
+                    
+                    ##
+                    # Fetch the ActionInstance
+                    # @return [ActionInstance] Fetched ActionInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Conversations.V2.ActionInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Conversations.V2.ActionInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -83,13 +83,15 @@ module Twilio
                             # @param [author]: [CommunicationList.CreateCommunicationInConversationRequestAuthor] 
                             # @param [content]: [CommunicationList.CreateCommunicationInConversationRequestContent] 
                             # @param [channel_id]: [String] 
-                            # @param [recipients]: [Array<CommunicationList.CreateCommunicationInConversationRequestAuthor>] 
-                        attr_accessor :author, :content, :channel_id, :recipients
+                            # @param [recipients]: [Array<CommunicationList.CreateCommunicationInConversationRequestRecipients>] 
+                            # @param [occurred_at]: [Time] Timestamp when this Communication occurred. If omitted, the server uses the current time.
+                        attr_accessor :author, :content, :channel_id, :recipients, :occurred_at
                         def initialize(payload)
                                 @author = payload["author"]
                                 @content = payload["content"]
                                 @channel_id = payload["channel_id"]
                                 @recipients = payload["recipients"]
+                                @occurred_at = payload["occurred_at"]
                         end
                         def to_json(options = {})
                         {
@@ -97,13 +99,14 @@ module Twilio
                                 "content": @content,
                                 "channelId": @channel_id,
                                 "recipients": @recipients,
+                                "occurredAt": @occurred_at,
                         }.to_json(options)
                         end
                     end
 
                     class CreateCommunicationInConversationRequestAuthor
                             # @param [address]: [String] 
-                            # @param [channel]: [String] 
+                            # @param [channel]: [String] Channel type for a Communication address.
                             # @param [participant_id]: [String] 
                         attr_accessor :address, :channel, :participant_id
                         def initialize(payload)
@@ -139,18 +142,37 @@ module Twilio
                         end
                     end
 
+                    class CreateCommunicationInConversationRequestRecipients
+                            # @param [address]: [String] 
+                            # @param [channel]: [String] Channel type for a Communication address.
+                            # @param [participant_id]: [String] 
+                        attr_accessor :address, :channel, :participant_id
+                        def initialize(payload)
+                                @address = payload["address"]
+                                @channel = payload["channel"]
+                                @participant_id = payload["participant_id"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "address": @address,
+                                "channel": @channel,
+                                "participantId": @participant_id,
+                        }.to_json(options)
+                        end
+                    end
+
 
                     ##
                     # Initialize the CommunicationList
                     # @param [Version] version Version that contains the resource
                     # @return [CommunicationList] CommunicationList
-                    def initialize(version, conversation_sid: nil)
+                    def initialize(version, conversation_id: nil)
                         
                         apiV1Version = ApiV1Version.new version.domain, version
                         super(apiV1Version)
                         # Path Solution
-                        @solution = { conversation_sid: conversation_sid }
-                        @uri = "/Conversations/#{@solution[:conversation_sid]}/Communications"
+                        @solution = { conversation_id: conversation_id }
+                        @uri = "/Conversations/#{@solution[:conversation_id]}/Communications"
                         
                     end
                     ##
@@ -170,7 +192,7 @@ module Twilio
                         CommunicationInstance.new(
                             @version,
                             payload,
-                            conversation_sid: @solution[:conversation_sid],
+                            conversation_id: @solution[:conversation_id],
                         )
                     end
 
@@ -191,7 +213,7 @@ module Twilio
                         communication_instance = CommunicationInstance.new(
                             @version,
                             response.body,
-                            conversation_sid: @solution[:conversation_sid],
+                            conversation_id: @solution[:conversation_id],
                         )
                         CommunicationInstanceMetadata.new(
                             @version,
@@ -344,17 +366,17 @@ module Twilio
                     ##
                     # Initialize the CommunicationContext
                     # @param [Version] version Version that contains the resource
-                    # @param [String] conversation_sid 
-                    # @param [String] sid 
+                    # @param [String] conversation_id 
+                    # @param [String] id 
                     # @return [CommunicationContext] CommunicationContext
-                    def initialize(version, conversation_sid, sid)
+                    def initialize(version, conversation_id, id)
                         
                         apiV1Version = ApiV1Version.new version.domain, version
                         super(apiV1Version)
 
                         # Path Solution
-                        @solution = { conversation_sid: conversation_sid, sid: sid,  }
-                        @uri = "/Conversations/#{@solution[:conversation_sid]}/Communications/#{@solution[:sid]}"
+                        @solution = { conversation_id: conversation_id, id: id,  }
+                        @uri = "/Conversations/#{@solution[:conversation_id]}/Communications/#{@solution[:id]}"
 
                         
                     end
@@ -373,8 +395,8 @@ module Twilio
                         CommunicationInstance.new(
                             @version,
                             payload,
-                            conversation_sid: @solution[:conversation_sid],
-                            sid: @solution[:sid],
+                            conversation_id: @solution[:conversation_id],
+                            id: @solution[:id],
                         )
                     end
 
@@ -393,8 +415,8 @@ module Twilio
                         communication_instance = CommunicationInstance.new(
                             @version,
                             response.body,
-                            conversation_sid: @solution[:conversation_sid],
-                            sid: @solution[:sid],
+                            conversation_id: @solution[:conversation_id],
+                            id: @solution[:id],
                         )
                         CommunicationInstanceMetadata.new(
                             @version,
@@ -488,7 +510,7 @@ module Twilio
                     # @param [Hash] payload Payload response from the API
                     # @return [CommunicationInstance] CommunicationInstance
                     def get_instance(payload)
-                        CommunicationInstance.new(@version, payload, conversation_sid: @solution[:conversation_sid])
+                        CommunicationInstance.new(@version, payload, conversation_id: @solution[:conversation_id])
                     end
 
                     ##
@@ -567,7 +589,7 @@ module Twilio
                     #   resource.
                     # @param [String] sid The SID of the Call resource to fetch.
                     # @return [CommunicationInstance] CommunicationInstance
-                    def initialize(version, payload , conversation_sid: nil, sid: nil)
+                    def initialize(version, payload , conversation_id: nil, id: nil)
                         
                         apiV1Version = ApiV1Version.new version.domain, version
                         super(apiV1Version)
@@ -589,7 +611,7 @@ module Twilio
 
                         # Context
                         @instance_context = nil
-                        @params = { 'conversation_sid' => conversation_sid  || @properties['conversation_sid']  ,'sid' => sid  || @properties['sid']  , }
+                        @params = { 'conversation_id' => conversation_id  || @properties['conversation_id']  ,'id' => id  || @properties['id']  , }
                     end
 
                     ##
@@ -598,7 +620,7 @@ module Twilio
                     # @return [CommunicationContext] CallContext for this CallInstance
                     def context
                         unless @instance_context
-                            @instance_context = CommunicationContext.new(@version , @params['conversation_sid'], @params['sid'])
+                            @instance_context = CommunicationContext.new(@version , @params['conversation_id'], @params['id'])
                         end
                         @instance_context
                     end