## # This code was generated by # ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ # | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ # | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ # # Twilio - Api # This is the public Twilio REST API. # # NOTE: This class is auto generated by OpenAPI Generator. # https://openapi-generator.tech # Do not edit the class manually. # module Twilio module REST class Api < ApiBase class V2010 < Version class AccountContext < InstanceContext class CallList < ListResource class FeedbackSummaryList < ListResource ## # Initialize the FeedbackSummaryList # @param [Version] version Version that contains the resource # @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 ## # Create the FeedbackSummaryInstance # @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] 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 '#' end end class FeedbackSummaryContext < InstanceContext ## # Initialize the FeedbackSummaryContext # @param [Version] version Version that contains the resource # @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, } @uri = "/Accounts/#{@solution[:account_sid]}/Calls/FeedbackSummary/#{@solution[:sid]}.json" end ## # Delete the FeedbackSummaryInstance # @return [Boolean] True if delete succeeds, false otherwise def delete @version.delete('DELETE', @uri) end ## # Fetch the FeedbackSummaryInstance # @return [FeedbackSummaryInstance] Fetched FeedbackSummaryInstance def fetch payload = @version.fetch('GET', @uri) FeedbackSummaryInstance.new( @version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], ) end ## # Provide a user friendly representation def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#" end ## # Provide a detailed, user friendly representation def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#" 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 '' 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 SID of the # {Account}[https://www.twilio.com/docs/iam/api/account] that created this FeedbackSummary # resource. # @param [String] sid The SID of the Call resource to fetch. # @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'] == nil ? payload['call_count'] : payload['call_count'].to_i, 'call_feedback_count' => payload['call_feedback_count'] == nil ? payload['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_date(payload['end_date']), 'include_subaccounts' => payload['include_subaccounts'], 'issues' => payload['issues'], 'quality_score_average' => payload['quality_score_average'], 'quality_score_median' => payload['quality_score_median'], 'quality_score_standard_deviation' => payload['quality_score_standard_deviation'], 'sid' => payload['sid'], 'start_date' => Twilio.deserialize_iso8601_date(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] CallContext for this CallInstance def context unless @instance_context @instance_context = FeedbackSummaryContext.new(@version , @params['account_sid'], @params['sid']) end @instance_context end ## # @return [String] The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. def account_sid @properties['account_sid'] end ## # @return [String] The total number of calls. def call_count @properties['call_count'] end ## # @return [String] The total number of calls with a feedback entry. def call_feedback_count @properties['call_feedback_count'] end ## # @return [Time] The date that this resource was created, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format. def date_created @properties['date_created'] end ## # @return [Time] The date that this resource was last updated, given in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format. def date_updated @properties['date_updated'] end ## # @return [Date] The last date for which feedback entries are included in this Feedback Summary, formatted as `YYYY-MM-DD` and specified in UTC. def end_date @properties['end_date'] end ## # @return [Boolean] Whether the feedback summary includes subaccounts; `true` if it does, otherwise `false`. def include_subaccounts @properties['include_subaccounts'] end ## # @return [Array] A list of issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, or `one-way-audio`. def issues @properties['issues'] end ## # @return [Float] The average QualityScore of the feedback entries. def quality_score_average @properties['quality_score_average'] end ## # @return [Float] The median QualityScore of the feedback entries. def quality_score_median @properties['quality_score_median'] end ## # @return [Float] The standard deviation of the quality scores. def quality_score_standard_deviation @properties['quality_score_standard_deviation'] end ## # @return [String] A 34 character string that uniquely identifies this resource. def sid @properties['sid'] end ## # @return [Date] The first date for which feedback entries are included in this feedback summary, formatted as `YYYY-MM-DD` and specified in UTC. def start_date @properties['start_date'] end ## # @return [Status] def status @properties['status'] end ## # Delete the FeedbackSummaryInstance # @return [Boolean] True if delete succeeds, false otherwise def delete context.delete end ## # Fetch the FeedbackSummaryInstance # @return [FeedbackSummaryInstance] Fetched FeedbackSummaryInstance def fetch context.fetch end ## # Provide a user friendly representation def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "" end ## # Provide a detailed, user friendly representation def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "" end end end end end end end end