twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb

@@ -28,6 +28,7 @@ module Twilio
                     # @return [ParticipantList] ParticipantList
                     def initialize(version, service_sid: nil, session_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid, session_sid: session_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants"
@@ -69,6 +70,48 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the ParticipantInstanceMetadata
+                    # @param [String] identifier The phone number of the Participant.
+                    # @param [String] friendly_name The string that you assigned to describe the participant. This value must be 255 characters or fewer. **This value should not have PII.**
+                    # @param [String] proxy_identifier The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool.
+                    # @param [String] proxy_identifier_sid The SID of the Proxy Identifier to assign to the Participant.
+                    # @return [ParticipantInstance] Created ParticipantInstance
+                    def create_with_metadata(
+                      identifier: nil, 
+                      friendly_name: :unset, 
+                      proxy_identifier: :unset, 
+                      proxy_identifier_sid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Identifier' => identifier,
+                            'FriendlyName' => friendly_name,
+                            'ProxyIdentifier' => proxy_identifier,
+                            'ProxyIdentifierSid' => proxy_identifier_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        participant_instance = ParticipantInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            session_sid: @solution[:session_sid],
+                        )
+                        ParticipantInstanceMetadata.new(
+                            @version,
+                            participant_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists ParticipantInstance records from the API as a list.
@@ -108,6 +151,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists ParticipantPageMetadata records from the API as a list.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ParticipantPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields ParticipantInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -129,7 +194,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 ParticipantInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
@@ -176,6 +241,7 @@ module Twilio
                     # @return [ParticipantContext] ParticipantContext
                     def initialize(version, service_sid, session_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, session_sid: session_sid, sid: sid,  }
@@ -193,9 +259,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the ParticipantInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          participant_instance = ParticipantInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          ParticipantInstanceMetadata.new(@version, participant_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the ParticipantInstance
                     # @return [ParticipantInstance] Fetched ParticipantInstance
@@ -217,6 +303,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ParticipantInstanceMetadata
+                    # @return [ParticipantInstance] Fetched ParticipantInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        participant_instance = ParticipantInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            session_sid: @solution[:session_sid],
+                            sid: @solution[:sid],
+                        )
+                        ParticipantInstanceMetadata.new(
+                            @version,
+                            participant_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the message_interactions
                     # @return [MessageInteractionList]
@@ -252,6 +365,53 @@ module Twilio
                     end
                 end
 
+                class ParticipantInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ParticipantInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ParticipantInstance] participant_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 [ParticipantInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, participant_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @participant_instance = participant_instance
+                    end
+
+                    def participant
+                        @participant_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ParticipantInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ParticipantListResponse < InstanceListResource
+                    # @param [Array<ParticipantInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @participant_instance = payload.body[key].map do |data|
+                        ParticipantInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def participant_instance
+                          @instance
+                      end
+                  end
+
                 class ParticipantPage < Page
                     ##
                     # Initialize the ParticipantPage
@@ -261,6 +421,7 @@ module Twilio
                     # @return [ParticipantPage] ParticipantPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -280,6 +441,66 @@ module Twilio
                         '<Twilio.Proxy.V1.ParticipantPage>'
                     end
                 end
+
+                class ParticipantPageMetadata < PageMetadata
+                    attr_reader :participant_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @participant_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @participant_page << ParticipantListResponse.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_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Proxy::V1PageMetadata>';
+                    end
+                end
+                class ParticipantListResponse < InstanceListResource
+
+                    # @param [Array<ParticipantInstance>] 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 = data_list.map do |data|
+                        ParticipantInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def participant
+                        @participant
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ParticipantInstance < InstanceResource
                     ##
                     # Initialize the ParticipantInstance
@@ -293,6 +514,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, session_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

data/lib/twilio-ruby/rest/proxy/v1/service/session.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [SessionList] SessionList
                     def initialize(version, service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Sessions"
@@ -73,6 +74,53 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the SessionInstanceMetadata
+                    # @param [String] unique_name An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**
+                    # @param [Time] date_expiry The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value.
+                    # @param [String] ttl The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.
+                    # @param [Mode] mode 
+                    # @param [Status] status 
+                    # @param [Array[Hash]] participants The Participant objects to include in the new session.
+                    # @return [SessionInstance] Created SessionInstance
+                    def create_with_metadata(
+                      unique_name: :unset, 
+                      date_expiry: :unset, 
+                      ttl: :unset, 
+                      mode: :unset, 
+                      status: :unset, 
+                      participants: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'UniqueName' => unique_name,
+                            'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
+                            'Ttl' => ttl,
+                            'Mode' => mode,
+                            'Status' => status,
+                            'Participants' => Twilio.serialize_list(participants) { |e| Twilio.serialize_object(e) },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        session_instance = SessionInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        SessionInstanceMetadata.new(
+                            @version,
+                            session_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists SessionInstance records from the API as a list.
@@ -112,6 +160,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists SessionPageMetadata records from the API as a list.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        SessionPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields SessionInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -133,7 +203,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 SessionInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
@@ -179,6 +249,7 @@ module Twilio
                     # @return [SessionContext] SessionContext
                     def initialize(version, service_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, sid: sid,  }
@@ -197,9 +268,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the SessionInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          session_instance = SessionInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          SessionInstanceMetadata.new(@version, session_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the SessionInstance
                     # @return [SessionInstance] Fetched SessionInstance
@@ -220,6 +311,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SessionInstanceMetadata
+                    # @return [SessionInstance] Fetched SessionInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        session_instance = SessionInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        SessionInstanceMetadata.new(
+                            @version,
+                            session_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the SessionInstance
                     # @param [Time] date_expiry The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value.
@@ -253,6 +370,45 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the SessionInstanceMetadata
+                    # @param [Time] date_expiry The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value.
+                    # @param [String] ttl The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.
+                    # @param [Status] status 
+                    # @return [SessionInstance] Updated SessionInstance
+                    def update_with_metadata(
+                      date_expiry: :unset, 
+                      ttl: :unset, 
+                      status: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
+                            'Ttl' => ttl,
+                            'Status' => status,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        session_instance = SessionInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        SessionInstanceMetadata.new(
+                            @version,
+                            session_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the interactions
                     # @return [InteractionList]
@@ -307,6 +463,53 @@ module Twilio
                     end
                 end
 
+                class SessionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SessionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SessionInstance] session_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 [SessionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, session_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @session_instance = session_instance
+                    end
+
+                    def session
+                        @session_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SessionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SessionListResponse < InstanceListResource
+                    # @param [Array<SessionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @session_instance = payload.body[key].map do |data|
+                        SessionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def session_instance
+                          @instance
+                      end
+                  end
+
                 class SessionPage < Page
                     ##
                     # Initialize the SessionPage
@@ -316,6 +519,7 @@ module Twilio
                     # @return [SessionPage] SessionPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -335,6 +539,66 @@ module Twilio
                         '<Twilio.Proxy.V1.SessionPage>'
                     end
                 end
+
+                class SessionPageMetadata < PageMetadata
+                    attr_reader :session_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @session_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @session_page << SessionListResponse.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
+                        @session_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Proxy::V1PageMetadata>';
+                    end
+                end
+                class SessionListResponse < InstanceListResource
+
+                    # @param [Array<SessionInstance>] 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
+                      @session = data_list.map do |data|
+                        SessionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def session
+                        @session
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SessionInstance < InstanceResource
                     ##
                     # Initialize the SessionInstance
@@ -348,6 +612,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],