twilio-ruby 5.6.0 → 5.33.1

data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,9 +16,11 @@ module Twilio
               ##
               # Initialize the FeedbackList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] call_sid A 34 character string that uniquely identifies this
+              # @param [String] account_sid The unique id of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
               #   resource.
+              # @param [String] call_sid The unique string that that we created to identify this
+              #   Call resource.
               # @return [FeedbackList] FeedbackList
               def initialize(version, account_sid: nil, call_sid: nil)
                 super(version)
@@ -70,22 +74,29 @@ module Twilio
               ##
               # Initialize the FeedbackContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
+              # @param [String] account_sid The unique id of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
+              #   resource.
               # @param [String] call_sid The call sid that uniquely identifies the call
               # @return [FeedbackContext] FeedbackContext
               def initialize(version, account_sid, call_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, call_sid: call_sid}
+                @solution = {account_sid: account_sid, call_sid: call_sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Feedback.json"
               end
 
               ##
               # Retrieve a single page of FeedbackInstance records from the API.
               # Request is executed immediately.
-              # @param [String] quality_score The quality_score
-              # @param [feedback.Issues] issue The issue
+              # @param [String] quality_score The call quality expressed as an integer from `1`
+              #   to `5` where `1` represents very poor call quality and `5` represents a perfect
+              #   call.
+              # @param [feedback.Issues] issue A list of one or more issues experienced during
+              #   the call. Issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Newly created FeedbackInstance
               def create(quality_score: nil, issue: :unset)
                 data = Twilio::Values.of({
@@ -129,9 +140,13 @@ module Twilio
 
               ##
               # Update the FeedbackInstance
-              # @param [String] quality_score An integer from 1 to 5 quality score
-              # @param [feedback.Issues] issue One or more of the issues experienced during the
-              #   call
+              # @param [String] quality_score The call quality expressed as an integer from `1`
+              #   to `5` where `1` represents very poor call quality and `5` represents a perfect
+              #   call.
+              # @param [feedback.Issues] issue One or more issues experienced during the call.
+              #   The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`,
+              #   `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`,
+              #   or `one-way-audio`.
               # @return [FeedbackInstance] Updated FeedbackInstance
               def update(quality_score: nil, issue: :unset)
                 data = Twilio::Values.of({
@@ -159,6 +174,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.FeedbackContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.FeedbackContext #{context}>"
+              end
             end
 
             class FeedbackInstance < InstanceResource
@@ -166,9 +188,11 @@ module Twilio
               # Initialize the FeedbackInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The account_sid
-              # @param [String] call_sid A 34 character string that uniquely identifies this
+              # @param [String] account_sid The unique id of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
               #   resource.
+              # @param [String] call_sid The unique string that that we created to identify this
+              #   Call resource.
               # @return [FeedbackInstance] FeedbackInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil)
                 super(version)
@@ -185,7 +209,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'account_sid' => account_sid, 'call_sid' => call_sid}
+                @params = {'account_sid' => account_sid, 'call_sid' => call_sid, }
               end
 
               ##
@@ -194,31 +218,31 @@ module Twilio
               # @return [FeedbackContext] FeedbackContext for this FeedbackInstance
               def context
                 unless @instance_context
-                  @instance_context = FeedbackContext.new(@version, @params['account_sid'], @params['call_sid'])
+                  @instance_context = FeedbackContext.new(@version, @params['account_sid'], @params['call_sid'], )
                 end
                 @instance_context
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique sid that identifies this account
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date this resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date this resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [feedback.Issues] The issues
+              # @return [feedback.Issues] Issues experienced during the call
               def issues
                 @properties['issues']
               end
@@ -230,7 +254,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A string that uniquely identifies this feedback resource
               def sid
                 @properties['sid']
               end
@@ -238,11 +262,16 @@ module Twilio
               ##
               # Retrieve a single page of FeedbackInstance records from the API.
               # Request is executed immediately.
-              # @param [String] quality_score The quality_score
-              # @param [feedback.Issues] issue The issue
+              # @param [String] quality_score The call quality expressed as an integer from `1`
+              #   to `5` where `1` represents very poor call quality and `5` represents a perfect
+              #   call.
+              # @param [feedback.Issues] issue A list of one or more issues experienced during
+              #   the call. Issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Newly created FeedbackInstance
               def create(quality_score: nil, issue: :unset)
-                context.create(quality_score: quality_score, issue: issue)
+                context.create(quality_score: quality_score, issue: issue, )
               end
 
               ##
@@ -254,12 +283,16 @@ module Twilio
 
               ##
               # Update the FeedbackInstance
-              # @param [String] quality_score An integer from 1 to 5 quality score
-              # @param [feedback.Issues] issue One or more of the issues experienced during the
-              #   call
+              # @param [String] quality_score The call quality expressed as an integer from `1`
+              #   to `5` where `1` represents very poor call quality and `5` represents a perfect
+              #   call.
+              # @param [feedback.Issues] issue One or more issues experienced during the call.
+              #   The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`,
+              #   `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`,
+              #   or `one-way-audio`.
               # @return [FeedbackInstance] Updated FeedbackInstance
               def update(quality_score: nil, issue: :unset)
-                context.update(quality_score: quality_score, issue: issue)
+                context.update(quality_score: quality_score, issue: issue, )
               end
 
               ##

data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,9 @@ module Twilio
               ##
               # Initialize the FeedbackSummaryList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique id of the Account responsible for
-              #   creating this Call
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Call
+              #   resource.
               # @return [FeedbackSummaryList] FeedbackSummaryList
               def initialize(version, account_sid: nil)
                 super(version)
@@ -28,11 +31,17 @@ module Twilio
               ##
               # Retrieve a single page of FeedbackSummaryInstance records from the API.
               # Request is executed immediately.
-              # @param [Date] start_date The start_date
-              # @param [Date] end_date The end_date
-              # @param [Boolean] include_subaccounts The include_subaccounts
-              # @param [String] status_callback The status_callback
-              # @param [String] status_callback_method The status_callback_method
+              # @param [Date] start_date Only include feedback given on or after this date.
+              #   Format is `YYYY-MM-DD` and specified in UTC.
+              # @param [Date] end_date Only include feedback given on or before this date.
+              #   Format is `YYYY-MM-DD` and specified in UTC.
+              # @param [Boolean] include_subaccounts Whether to also include Feedback resources
+              #   from all subaccounts. `true` includes feedback from all subaccounts and `false`,
+              #   the default, includes feedback from only the specified account.
+              # @param [String] status_callback The URL that we will request when the feedback
+              #   summary is complete.
+              # @param [String] status_callback_method The HTTP method (`GET` or `POST`) we use
+              #   to make the request to the `StatusCallback` URL.
               # @return [FeedbackSummaryInstance] Newly created FeedbackSummaryInstance
               def create(start_date: nil, end_date: nil, include_subaccounts: :unset, status_callback: :unset, status_callback_method: :unset)
                 data = Twilio::Values.of({
@@ -49,7 +58,7 @@ module Twilio
                     data: data
                 )
 
-                FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -78,7 +87,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [FeedbackSummaryInstance] FeedbackSummaryInstance
               def get_instance(payload)
-                FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -92,14 +101,17 @@ module Twilio
               ##
               # Initialize the FeedbackSummaryContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] sid The sid
+              # @param [String] account_sid The unique id of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
+              #   resource.
+              # @param [String] sid A 34 character string that uniquely identifies this
+              #   resource.
               # @return [FeedbackSummaryContext] FeedbackSummaryContext
               def initialize(version, account_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, sid: sid}
+                @solution = {account_sid: account_sid, sid: sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/Calls/FeedbackSummary/#{@solution[:sid]}.json"
               end
 
@@ -125,7 +137,7 @@ module Twilio
 
               ##
               # Deletes the FeedbackSummaryInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -136,6 +148,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.FeedbackSummaryContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.FeedbackSummaryContext #{context}>"
+              end
             end
 
             class FeedbackSummaryInstance < InstanceResource
@@ -143,9 +162,11 @@ module Twilio
               # Initialize the FeedbackSummaryInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The unique id of the Account responsible for
-              #   creating this Call
-              # @param [String] sid The sid
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Call
+              #   resource.
+              # @param [String] sid A 34 character string that uniquely identifies this
+              #   resource.
               # @return [FeedbackSummaryInstance] FeedbackSummaryInstance
               def initialize(version, payload, account_sid: nil, sid: nil)
                 super(version)
@@ -170,7 +191,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
               end
 
               ##
@@ -179,91 +200,91 @@ module Twilio
               # @return [FeedbackSummaryContext] FeedbackSummaryContext for this FeedbackSummaryInstance
               def context
                 unless @instance_context
-                  @instance_context = FeedbackSummaryContext.new(@version, @params['account_sid'], @params['sid'])
+                  @instance_context = FeedbackSummaryContext.new(@version, @params['account_sid'], @params['sid'], )
                 end
                 @instance_context
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique sid that identifies this account
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The call_count
+              # @return [String] The total number of calls
               def call_count
                 @properties['call_count']
               end
 
               ##
-              # @return [String] The call_feedback_count
+              # @return [String] The total number of calls with a feedback entry
               def call_feedback_count
                 @properties['call_feedback_count']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date this resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date this resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [Time] The end_date
+              # @return [Time] The latest feedback entry date in the summary
               def end_date
                 @properties['end_date']
               end
 
               ##
-              # @return [Boolean] The include_subaccounts
+              # @return [Boolean] Whether the feedback summary includes subaccounts
               def include_subaccounts
                 @properties['include_subaccounts']
               end
 
               ##
-              # @return [String] The issues
+              # @return [String] Issues experienced during the call
               def issues
                 @properties['issues']
               end
 
               ##
-              # @return [String] The quality_score_average
+              # @return [String] The average QualityScore of the feedback entries
               def quality_score_average
                 @properties['quality_score_average']
               end
 
               ##
-              # @return [String] The quality_score_median
+              # @return [String] The median QualityScore of the feedback entries
               def quality_score_median
                 @properties['quality_score_median']
               end
 
               ##
-              # @return [String] The quality_score_standard_deviation
+              # @return [String] The standard deviation of the quality scores
               def quality_score_standard_deviation
                 @properties['quality_score_standard_deviation']
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A string that uniquely identifies this feedback entry
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [Time] The start_date
+              # @return [Time] The earliest feedback entry date in the summary
               def start_date
                 @properties['start_date']
               end
 
               ##
-              # @return [feedback_summary.Status] The status
+              # @return [feedback_summary.Status] The status of the feedback summary
               def status
                 @properties['status']
               end
@@ -277,7 +298,7 @@ module Twilio
 
               ##
               # Deletes the FeedbackSummaryInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end