twilio-ruby 4.13.0 → 5.6.4

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

@@ -0,0 +1,284 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class CallContext < InstanceContext
+            class FeedbackList < ListResource
+              ##
+              # 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
+              #   resource.
+              # @return [FeedbackList] FeedbackList
+              def initialize(version, account_sid: nil, call_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid, call_sid: call_sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Api.V2010.FeedbackList>'
+              end
+            end
+
+            class FeedbackPage < Page
+              ##
+              # Initialize the FeedbackPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [FeedbackPage] FeedbackPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of FeedbackInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [FeedbackInstance] FeedbackInstance
+              def get_instance(payload)
+                FeedbackInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Api.V2010.FeedbackPage>'
+              end
+            end
+
+            class FeedbackContext < InstanceContext
+              ##
+              # Initialize the FeedbackContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] account_sid The account_sid
+              # @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, }
+                @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
+              # @return [FeedbackInstance] Newly created FeedbackInstance
+              def create(quality_score: nil, issue: :unset)
+                data = Twilio::Values.of({
+                    'QualityScore' => quality_score,
+                    'Issue' => Twilio.serialize_list(issue) { |e| e },
+                })
+
+                payload = @version.create(
+                    'POST',
+                    @uri,
+                    data: data
+                )
+
+                FeedbackInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
+              ##
+              # Fetch a FeedbackInstance
+              # @return [FeedbackInstance] Fetched FeedbackInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                FeedbackInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
+              ##
+              # 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
+              # @return [FeedbackInstance] Updated FeedbackInstance
+              def update(quality_score: nil, issue: :unset)
+                data = Twilio::Values.of({
+                    'QualityScore' => quality_score,
+                    'Issue' => Twilio.serialize_list(issue) { |e| e },
+                })
+
+                payload = @version.update(
+                    'POST',
+                    @uri,
+                    data: data,
+                )
+
+                FeedbackInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.FeedbackContext #{context}>"
+              end
+            end
+
+            class FeedbackInstance < InstanceResource
+              ##
+              # 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
+              #   resource.
+              # @return [FeedbackInstance] FeedbackInstance
+              def initialize(version, payload, account_sid: nil, call_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                    'issues' => payload['issues'],
+                    'quality_score' => payload['quality_score'].to_i,
+                    'sid' => payload['sid'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'account_sid' => account_sid, 'call_sid' => call_sid, }
+              end
+
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [FeedbackContext] FeedbackContext for this FeedbackInstance
+              def context
+                unless @instance_context
+                  @instance_context = FeedbackContext.new(@version, @params['account_sid'], @params['call_sid'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The account_sid
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [Time] The date_created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The date_updated
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # @return [feedback.Issues] The issues
+              def issues
+                @properties['issues']
+              end
+
+              ##
+              # @return [String] 1 to 5 quality score
+              def quality_score
+                @properties['quality_score']
+              end
+
+              ##
+              # @return [String] The sid
+              def sid
+                @properties['sid']
+              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
+              # @return [FeedbackInstance] Newly created FeedbackInstance
+              def create(quality_score: nil, issue: :unset)
+                context.create(quality_score: quality_score, issue: issue, )
+              end
+
+              ##
+              # Fetch a FeedbackInstance
+              # @return [FeedbackInstance] Fetched FeedbackInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # 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
+              # @return [FeedbackInstance] Updated FeedbackInstance
+              def update(quality_score: nil, issue: :unset)
+                context.update(quality_score: quality_score, issue: issue, )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.FeedbackInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.FeedbackInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,304 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class CallList < ListResource
+            class FeedbackSummaryList < ListResource
+              ##
+              # 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
+              # @return [FeedbackSummaryList] FeedbackSummaryList
+              def initialize(version, account_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid}
+                @uri = "/Accounts/#{@solution[:account_sid]}/Calls/FeedbackSummary.json"
+              end
+
+              ##
+              # 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
+              # @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({
+                    'StartDate' => Twilio.serialize_iso8601_date(start_date),
+                    'EndDate' => Twilio.serialize_iso8601_date(end_date),
+                    'IncludeSubaccounts' => include_subaccounts,
+                    'StatusCallback' => status_callback,
+                    'StatusCallbackMethod' => status_callback_method,
+                })
+
+                payload = @version.create(
+                    'POST',
+                    @uri,
+                    data: data
+                )
+
+                FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Api.V2010.FeedbackSummaryList>'
+              end
+            end
+
+            class FeedbackSummaryPage < Page
+              ##
+              # Initialize the FeedbackSummaryPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [FeedbackSummaryPage] FeedbackSummaryPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of FeedbackSummaryInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [FeedbackSummaryInstance] FeedbackSummaryInstance
+              def get_instance(payload)
+                FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Api.V2010.FeedbackSummaryPage>'
+              end
+            end
+
+            class FeedbackSummaryContext < InstanceContext
+              ##
+              # Initialize the FeedbackSummaryContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] account_sid The account_sid
+              # @param [String] sid The sid
+              # @return [FeedbackSummaryContext] FeedbackSummaryContext
+              def initialize(version, account_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid, sid: sid, }
+                @uri = "/Accounts/#{@solution[:account_sid]}/Calls/FeedbackSummary/#{@solution[:sid]}.json"
+              end
+
+              ##
+              # Fetch a FeedbackSummaryInstance
+              # @return [FeedbackSummaryInstance] Fetched FeedbackSummaryInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                FeedbackSummaryInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Deletes the FeedbackSummaryInstance
+              # @return [Boolean] true if delete succeeds, true otherwise
+              def delete
+                @version.delete('delete', @uri)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.FeedbackSummaryContext #{context}>"
+              end
+            end
+
+            class FeedbackSummaryInstance < InstanceResource
+              ##
+              # 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
+              # @return [FeedbackSummaryInstance] FeedbackSummaryInstance
+              def initialize(version, payload, account_sid: nil, sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'call_count' => payload['call_count'].to_i,
+                    'call_feedback_count' => payload['call_feedback_count'].to_i,
+                    'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                    'end_date' => Twilio.deserialize_iso8601_datetime(payload['end_date']),
+                    'include_subaccounts' => payload['include_subaccounts'],
+                    'issues' => payload['issues'],
+                    'quality_score_average' => payload['quality_score_average'].to_f,
+                    'quality_score_median' => payload['quality_score_median'].to_f,
+                    'quality_score_standard_deviation' => payload['quality_score_standard_deviation'].to_f,
+                    'sid' => payload['sid'],
+                    'start_date' => Twilio.deserialize_iso8601_datetime(payload['start_date']),
+                    'status' => payload['status'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
+              end
+
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [FeedbackSummaryContext] FeedbackSummaryContext for this FeedbackSummaryInstance
+              def context
+                unless @instance_context
+                  @instance_context = FeedbackSummaryContext.new(@version, @params['account_sid'], @params['sid'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The account_sid
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [String] The call_count
+              def call_count
+                @properties['call_count']
+              end
+
+              ##
+              # @return [String] The call_feedback_count
+              def call_feedback_count
+                @properties['call_feedback_count']
+              end
+
+              ##
+              # @return [Time] The date_created
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The date_updated
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # @return [Time] The end_date
+              def end_date
+                @properties['end_date']
+              end
+
+              ##
+              # @return [Boolean] The include_subaccounts
+              def include_subaccounts
+                @properties['include_subaccounts']
+              end
+
+              ##
+              # @return [String] The issues
+              def issues
+                @properties['issues']
+              end
+
+              ##
+              # @return [String] The quality_score_average
+              def quality_score_average
+                @properties['quality_score_average']
+              end
+
+              ##
+              # @return [String] The quality_score_median
+              def quality_score_median
+                @properties['quality_score_median']
+              end
+
+              ##
+              # @return [String] The quality_score_standard_deviation
+              def quality_score_standard_deviation
+                @properties['quality_score_standard_deviation']
+              end
+
+              ##
+              # @return [String] The sid
+              def sid
+                @properties['sid']
+              end
+
+              ##
+              # @return [Time] The start_date
+              def start_date
+                @properties['start_date']
+              end
+
+              ##
+              # @return [feedback_summary.Status] The status
+              def status
+                @properties['status']
+              end
+
+              ##
+              # Fetch a FeedbackSummaryInstance
+              # @return [FeedbackSummaryInstance] Fetched FeedbackSummaryInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Deletes the FeedbackSummaryInstance
+              # @return [Boolean] true if delete succeeds, true otherwise
+              def delete
+                context.delete
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.FeedbackSummaryInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Api.V2010.FeedbackSummaryInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end