twilio-ruby 6.8.0 → 7.10.7

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

@@ -0,0 +1,399 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Conversations
+#    This is the public Twilio REST API.
+#
+#    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 V1 < Version
+                class ServiceContext < InstanceContext
+
+                     class ConversationWithParticipantsList < ListResource
+                
+                    ##
+                    # Initialize the ConversationWithParticipantsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ConversationWithParticipantsList] ConversationWithParticipantsList
+                    def initialize(version, chat_service_sid: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { chat_service_sid: chat_service_sid }
+                        @uri = "/Services/#{@solution[:chat_service_sid]}/ConversationWithParticipants"
+                        
+                    end
+                    ##
+                    # Create the ConversationWithParticipantsInstance
+                    # @param [String] friendly_name The human-readable name of this conversation, limited to 256 characters. Optional.
+                    # @param [String] unique_name An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.
+                    # @param [Time] date_created The date that this resource was created.
+                    # @param [Time] date_updated The date that this resource was last updated.
+                    # @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) 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 if specified.  **Note** that if the attributes are not set \\\"{}\\\" will be returned.
+                    # @param [State] state 
+                    # @param [String] timers_inactive ISO8601 duration when conversation will be 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] bindings_email_address The default email address that will be used when sending outbound emails in this conversation.
+                    # @param [String] bindings_email_name The default name that will be used when sending outbound emails in this conversation.
+                    # @param [Array[String]] participant The participant to be added to the conversation in JSON format. The JSON object attributes are as parameters in [Participant Resource](https://www.twilio.com/docs/conversations/api/conversation-participant-resource). The maximum number of participants that can be added in a single request is 10.
+                    # @param [ServiceConversationWithParticipantsEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [ConversationWithParticipantsInstance] Created ConversationWithParticipantsInstance
+                    def create(
+                      friendly_name: :unset, 
+                      unique_name: :unset, 
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      messaging_service_sid: :unset, 
+                      attributes: :unset, 
+                      state: :unset, 
+                      timers_inactive: :unset, 
+                      timers_closed: :unset, 
+                      bindings_email_address: :unset, 
+                      bindings_email_name: :unset, 
+                      participant: :unset, 
+                      x_twilio_webhook_enabled: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'UniqueName' => unique_name,
+                            'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
+                            'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
+                            'MessagingServiceSid' => messaging_service_sid,
+                            'Attributes' => attributes,
+                            'State' => state,
+                            'Timers.Inactive' => timers_inactive,
+                            'Timers.Closed' => timers_closed,
+                            'Bindings.Email.Address' => bindings_email_address,
+                            'Bindings.Email.Name' => bindings_email_name,
+                            'Participant' => Twilio.serialize_list(participant) { |e| e },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        ConversationWithParticipantsInstance.new(
+                            @version,
+                            payload,
+                            chat_service_sid: @solution[:chat_service_sid],
+                        )
+                    end
+
+                    ##
+                    # Create the ConversationWithParticipantsInstanceMetadata
+                    # @param [String] friendly_name The human-readable name of this conversation, limited to 256 characters. Optional.
+                    # @param [String] unique_name An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.
+                    # @param [Time] date_created The date that this resource was created.
+                    # @param [Time] date_updated The date that this resource was last updated.
+                    # @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) 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 if specified.  **Note** that if the attributes are not set \\\"{}\\\" will be returned.
+                    # @param [State] state 
+                    # @param [String] timers_inactive ISO8601 duration when conversation will be 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] bindings_email_address The default email address that will be used when sending outbound emails in this conversation.
+                    # @param [String] bindings_email_name The default name that will be used when sending outbound emails in this conversation.
+                    # @param [Array[String]] participant The participant to be added to the conversation in JSON format. The JSON object attributes are as parameters in [Participant Resource](https://www.twilio.com/docs/conversations/api/conversation-participant-resource). The maximum number of participants that can be added in a single request is 10.
+                    # @param [ServiceConversationWithParticipantsEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [ConversationWithParticipantsInstance] Created ConversationWithParticipantsInstance
+                    def create_with_metadata(
+                      friendly_name: :unset, 
+                      unique_name: :unset, 
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      messaging_service_sid: :unset, 
+                      attributes: :unset, 
+                      state: :unset, 
+                      timers_inactive: :unset, 
+                      timers_closed: :unset, 
+                      bindings_email_address: :unset, 
+                      bindings_email_name: :unset, 
+                      participant: :unset, 
+                      x_twilio_webhook_enabled: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'UniqueName' => unique_name,
+                            'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
+                            'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
+                            'MessagingServiceSid' => messaging_service_sid,
+                            'Attributes' => attributes,
+                            'State' => state,
+                            'Timers.Inactive' => timers_inactive,
+                            'Timers.Closed' => timers_closed,
+                            'Bindings.Email.Address' => bindings_email_address,
+                            'Bindings.Email.Name' => bindings_email_name,
+                            'Participant' => Twilio.serialize_list(participant) { |e| e },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        conversation_with_participants_instance = ConversationWithParticipantsInstance.new(
+                            @version,
+                            response.body,
+                            chat_service_sid: @solution[:chat_service_sid],
+                        )
+                        ConversationWithParticipantsInstanceMetadata.new(
+                            @version,
+                            conversation_with_participants_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Conversations.V1.ConversationWithParticipantsList>'
+                    end
+                end
+
+                class ConversationWithParticipantsPage < Page
+                    ##
+                    # Initialize the ConversationWithParticipantsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ConversationWithParticipantsPage] ConversationWithParticipantsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ConversationWithParticipantsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ConversationWithParticipantsInstance] ConversationWithParticipantsInstance
+                    def get_instance(payload)
+                        ConversationWithParticipantsInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Conversations.V1.ConversationWithParticipantsPage>'
+                    end
+                end
+
+                class ConversationWithParticipantsPageMetadata < PageMetadata
+                    attr_reader :conversation_with_participants_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @conversation_with_participants_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @conversation_with_participants_page << ConversationWithParticipantsListResponse.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
+                        @conversation_with_participants_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Conversations::V1PageMetadata>';
+                    end
+                end
+                class ConversationWithParticipantsListResponse < InstanceListResource
+
+                    # @param [Array<ConversationWithParticipantsInstance>] 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
+                      @conversation_with_participants = data_list.map do |data|
+                        ConversationWithParticipantsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def conversation_with_participants
+                        @conversation_with_participants
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ConversationWithParticipantsInstance < InstanceResource
+                    ##
+                    # Initialize the ConversationWithParticipantsInstance
+                    # @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 ConversationWithParticipants
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ConversationWithParticipantsInstance] ConversationWithParticipantsInstance
+                    def initialize(version, payload , chat_service_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'chat_service_sid' => payload['chat_service_sid'],
+                            'messaging_service_sid' => payload['messaging_service_sid'],
+                            'sid' => payload['sid'],
+                            'friendly_name' => payload['friendly_name'],
+                            'unique_name' => payload['unique_name'],
+                            'attributes' => payload['attributes'],
+                            'state' => payload['state'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                            'timers' => payload['timers'],
+                            'links' => payload['links'],
+                            'bindings' => payload['bindings'],
+                            'url' => payload['url'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.
+                    def chat_service_sid
+                        @properties['chat_service_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to.
+                    def messaging_service_sid
+                        @properties['messaging_service_sid']
+                    end
+                    
+                    ##
+                    # @return [String] A 34 character string that uniquely identifies this resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The human-readable name of this conversation, limited to 256 characters. Optional.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] 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.
+                    def unique_name
+                        @properties['unique_name']
+                    end
+                    
+                    ##
+                    # @return [String] An optional 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.
+                    def attributes
+                        @properties['attributes']
+                    end
+                    
+                    ##
+                    # @return [State] 
+                    def state
+                        @properties['state']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this resource was created.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this resource was last updated.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [Hash] Timer date values representing state update for this conversation.
+                    def timers
+                        @properties['timers']
+                    end
+                    
+                    ##
+                    # @return [Hash] Contains absolute URLs to access the [participants](https://www.twilio.com/docs/conversations/api/conversation-participant-resource), [messages](https://www.twilio.com/docs/conversations/api/conversation-message-resource) and [webhooks](https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation.
+                    def links
+                        @properties['links']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def bindings
+                        @properties['bindings']
+                    end
+                    
+                    ##
+                    # @return [String] An absolute API resource URL for this conversation.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Conversations.V1.ConversationWithParticipantsInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Conversations.V1.ConversationWithParticipantsInstance>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+

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

@@ -20,12 +20,14 @@ module Twilio
                 class ServiceContext < InstanceContext
 
                      class ParticipantConversationList < ListResource
+                
                     ##
                     # Initialize the ParticipantConversationList
                     # @param [Version] version Version that contains the resource
                     # @return [ParticipantConversationList] ParticipantConversationList
                     def initialize(version, chat_service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { chat_service_sid: chat_service_sid }
                         @uri = "/Services/#{@solution[:chat_service_sid]}/ParticipantConversations"
@@ -75,7 +77,37 @@ module Twilio
                             address: address,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists ParticipantConversationPageMetadata records from the API as a list.
+                      # @param [String] identity A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.
+                      # @param [String] address A unique string identifier for the conversation participant who's not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded.
+                    # @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
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    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_with_metadata(identity: :unset, address: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Identity' => identity,
+                            'Address' => address,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ParticipantConversationPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -87,9 +119,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -101,7 +137,7 @@ module Twilio
                     # @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 ParticipantConversationInstance
-                    def page(identity: :unset, address: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(identity: :unset, address: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Identity' => identity,
                             'Address' => address,
@@ -109,8 +145,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         ParticipantConversationPage.new(@version, response, @solution)
                     end
@@ -145,6 +184,7 @@ module Twilio
                     # @return [ParticipantConversationPage] ParticipantConversationPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -164,6 +204,66 @@ module Twilio
                         '<Twilio.Conversations.V1.ParticipantConversationPage>'
                     end
                 end
+
+                class ParticipantConversationPageMetadata < PageMetadata
+                    attr_reader :participant_conversation_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @participant_conversation_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @participant_conversation_page << ParticipantConversationListResponse.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
+                        @participant_conversation_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Conversations::V1PageMetadata>';
+                    end
+                end
+                class ParticipantConversationListResponse < InstanceListResource
+
+                    # @param [Array<ParticipantConversationInstance>] 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
+                      @participant_conversation = data_list.map do |data|
+                        ParticipantConversationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def participant_conversation
+                        @participant_conversation
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ParticipantConversationInstance < InstanceResource
                     ##
                     # Initialize the ParticipantConversationInstance
@@ -177,6 +277,7 @@ module Twilio
                     def initialize(version, payload , chat_service_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],