twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -16,8 +18,10 @@ module Twilio
               ##
               # Initialize the InteractionList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the Service.
-              # @param [String] session_sid The unique SID identifier of the Session.
+              # @param [String] service_sid The SID of the parent
+              #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
+              # @param [String] session_sid The SID of the parent
+              #   {Session}[https://www.twilio.com/docs/proxy/api/session] resource.
               # @return [InteractionList] InteractionList
               def initialize(version, service_sid: nil, session_sid: nil)
                 super(version)
@@ -31,16 +35,6 @@ module Twilio
               # Lists InteractionInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [interaction.ResourceStatus] inbound_participant_status The Inbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
-              # @param [interaction.ResourceStatus] outbound_participant_status The Outbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
               # @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
@@ -48,29 +42,14 @@ module Twilio
               #    but a limit is defined, stream() will attempt to read the limit with the most
               #    efficient page size, i.e. min(limit, 1000)
               # @return [Array] Array of up to limit results
-              def list(inbound_participant_status: :unset, outbound_participant_status: :unset, limit: nil, page_size: nil)
-                self.stream(
-                    inbound_participant_status: inbound_participant_status,
-                    outbound_participant_status: outbound_participant_status,
-                    limit: limit,
-                    page_size: page_size
-                ).entries
+              def list(limit: nil, page_size: nil)
+                self.stream(limit: limit, page_size: page_size).entries
               end
 
               ##
               # Streams InteractionInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [interaction.ResourceStatus] inbound_participant_status The Inbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
-              # @param [interaction.ResourceStatus] outbound_participant_status The Outbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
               # @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
@@ -78,14 +57,10 @@ module Twilio
               #    but a limit is defined, stream() will attempt to read the limit with the most
               #    efficient page size, i.e. min(limit, 1000)
               # @return [Enumerable] Enumerable that will yield up to limit results
-              def stream(inbound_participant_status: :unset, outbound_participant_status: :unset, limit: nil, page_size: nil)
+              def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(
-                    inbound_participant_status: inbound_participant_status,
-                    outbound_participant_status: outbound_participant_status,
-                    page_size: limits[:page_size],
-                )
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -97,7 +72,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -107,33 +82,19 @@ module Twilio
               ##
               # Retrieve a single page of InteractionInstance records from the API.
               # Request is executed immediately.
-              # @param [interaction.ResourceStatus] inbound_participant_status The Inbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
-              # @param [interaction.ResourceStatus] outbound_participant_status The Outbound
-              #   Participant Status of this Interaction. One of `accepted`, `answered`, `busy`,
-              #   `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`,
-              #   `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`,
-              #   `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
               # @return [Page] Page of InteractionInstance
-              def page(inbound_participant_status: :unset, outbound_participant_status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              def page(page_token: :unset, page_number: :unset, page_size: :unset)
                 params = Twilio::Values.of({
-                    'InboundParticipantStatus' => inbound_participant_status,
-                    'OutboundParticipantStatus' => outbound_participant_status,
                     'PageToken' => page_token,
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 InteractionPage.new(@version, response, @solution)
               end
 
@@ -199,30 +160,28 @@ module Twilio
               ##
               # Initialize the InteractionContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The unique SID identifier of the Service.
-              # @param [String] session_sid The unique SID identifier of the Session.
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   Interaction.
+              # @param [String] service_sid The SID of the parent
+              #   {Service}[https://www.twilio.com/docs/proxy/api/service] of the resource to
+              #   fetch.
+              # @param [String] session_sid The SID of the parent
+              #   {Session}[https://www.twilio.com/docs/proxy/api/session] of the resource to
+              #   fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Interaction resource to fetch.
               # @return [InteractionContext] InteractionContext
               def initialize(version, service_sid, session_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, session_sid: session_sid, sid: sid}
+                @solution = {service_sid: service_sid, session_sid: session_sid, sid: sid, }
                 @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Interactions/#{@solution[:sid]}"
               end
 
               ##
-              # Fetch a InteractionInstance
+              # Fetch the InteractionInstance
               # @return [InteractionInstance] Fetched InteractionInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 InteractionInstance.new(
                     @version,
@@ -234,10 +193,10 @@ module Twilio
               end
 
               ##
-              # Deletes the InteractionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the InteractionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -246,6 +205,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Proxy.V1.InteractionContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Proxy.V1.InteractionContext #{context}>"
+              end
             end
 
             ##
@@ -255,10 +221,12 @@ module Twilio
               # Initialize the InteractionInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The unique SID identifier of the Service.
-              # @param [String] session_sid The unique SID identifier of the Session.
-              # @param [String] sid A 34 character string that uniquely identifies this
-              #   Interaction.
+              # @param [String] service_sid The SID of the parent
+              #   {Service}[https://www.twilio.com/docs/proxy/api/service] resource.
+              # @param [String] session_sid The SID of the parent
+              #   {Session}[https://www.twilio.com/docs/proxy/api/session] resource.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Interaction resource to fetch.
               # @return [InteractionInstance] InteractionInstance
               def initialize(version, payload, service_sid: nil, session_sid: nil, sid: nil)
                 super(version)
@@ -312,129 +280,129 @@ module Twilio
               end
 
               ##
-              # @return [String] A string that uniquely identifies this Interaction.
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] Session Sid.
+              # @return [String] The SID of the resource's parent Session
               def session_sid
                 @properties['session_sid']
               end
 
               ##
-              # @return [String] Service Sid.
+              # @return [String] The SID of the resource's parent Service
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] Account Sid.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] Further details about an interaction.
+              # @return [String] A JSON string that includes the message body of message interactions
               def data
                 @properties['data']
               end
 
               ##
-              # @return [interaction.Type] The Type of this Interaction
+              # @return [interaction.Type] The Type of the Interaction
               def type
                 @properties['type']
               end
 
               ##
-              # @return [String] Inbound Participant Sid.
+              # @return [String] The SID of the inbound Participant resource
               def inbound_participant_sid
                 @properties['inbound_participant_sid']
               end
 
               ##
-              # @return [String] Inbound Resource Sid.
+              # @return [String] The SID of the inbound resource
               def inbound_resource_sid
                 @properties['inbound_resource_sid']
               end
 
               ##
-              # @return [interaction.ResourceStatus] The Inbound Resource Status of this Interaction
+              # @return [interaction.ResourceStatus] The inbound resource status of the Interaction
               def inbound_resource_status
                 @properties['inbound_resource_status']
               end
 
               ##
-              # @return [String] The type of the Inbound Resource, Call or Message.
+              # @return [String] The inbound resource type
               def inbound_resource_type
                 @properties['inbound_resource_type']
               end
 
               ##
-              # @return [String] The URL of the Twilio resource.
+              # @return [String] The URL of the Twilio inbound resource
               def inbound_resource_url
                 @properties['inbound_resource_url']
               end
 
               ##
-              # @return [String] Outbound Participant Sid.
+              # @return [String] The SID of the outbound Participant
               def outbound_participant_sid
                 @properties['outbound_participant_sid']
               end
 
               ##
-              # @return [String] Outbound Resource Sid.
+              # @return [String] The SID of the outbound resource
               def outbound_resource_sid
                 @properties['outbound_resource_sid']
               end
 
               ##
-              # @return [interaction.ResourceStatus] The Outbound Resource Status of this Interaction
+              # @return [interaction.ResourceStatus] The outbound resource status of the Interaction
               def outbound_resource_status
                 @properties['outbound_resource_status']
               end
 
               ##
-              # @return [String] The type of the Outbound Resource, Call or Message.
+              # @return [String] The outbound resource type
               def outbound_resource_type
                 @properties['outbound_resource_type']
               end
 
               ##
-              # @return [String] The URL of the Twilio resource.
+              # @return [String] The URL of the Twilio outbound resource
               def outbound_resource_url
                 @properties['outbound_resource_url']
               end
 
               ##
-              # @return [Time] The date this Interaction was created
+              # @return [Time] The ISO 8601 date and time in GMT when the Interaction was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date this Interaction was updated
+              # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The URL of this resource.
+              # @return [String] The absolute URL of the Interaction resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a InteractionInstance
+              # Fetch the InteractionInstance
               # @return [InteractionInstance] Fetched InteractionInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the InteractionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the InteractionInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end