twilio-ruby 5.19.0 → 5.77.0

data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb

@@ -0,0 +1,322 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Insights < Domain
+      class V1 < Version
+        class CallContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationList < ListResource
+            ##
+            # Initialize the AnnotationList
+            # @param [Version] version Version that contains the resource
+            # @param [String] call_sid The unique SID identifier of the Call.
+            # @return [AnnotationList] AnnotationList
+            def initialize(version, call_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {call_sid: call_sid}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Insights.V1.AnnotationList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationPage < Page
+            ##
+            # Initialize the AnnotationPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [AnnotationPage] AnnotationPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of AnnotationInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [AnnotationInstance] AnnotationInstance
+            def get_instance(payload)
+              AnnotationInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Insights.V1.AnnotationPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationContext < InstanceContext
+            ##
+            # Initialize the AnnotationContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] call_sid The unique SID identifier of the Call.
+            # @return [AnnotationContext] AnnotationContext
+            def initialize(version, call_sid)
+              super(version)
+
+              # Path Solution
+              @solution = {call_sid: call_sid, }
+              @uri = "/Voice/#{@solution[:call_sid]}/Annotation"
+            end
+
+            ##
+            # Update the AnnotationInstance
+            # @param [annotation.AnsweredBy] answered_by Which entity answered the call as
+            #   determined by Answering Machine Detection. Use this to provide feedback on
+            #   Answering Machine Detection accuracy. Possible enumerated values, one of: human,
+            #   machine. human indicates the call was answered by a person. machine indicates
+            #   the call was answered by an answering machine.
+            # @param [annotation.ConnectivityIssue] connectivity_issue Specify if the call had
+            #   any connectivity issues. Possible enumerated values, one :
+            #   no_connectivity_issue, invalid_number, caller_id, dropped_call,
+            #   number_reachability.
+            # @param [String] quality_issues Specify if the call had any subjective quality
+            #   issues. Possible values, one or more of:  no_quality_issue, low_volume,
+            #   choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated
+            #   values to indicate multiple quality issues for the same call
+            # @param [Boolean] spam Specify if the call was a spam call. Use this to provide
+            #   feedback on whether calls placed from your account were marked as spam, or if
+            #   inbound calls received by your account were unwanted spam. Is of type Boolean:
+            #   true, false. Use true if the call was a spam call.
+            # @param [String] call_score Specify the call score. This is of type integer. Use
+            #   a range of 1-5 to indicate the call experience score, with the following mapping
+            #   as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor,
+            #   1: Bad].
+            # @param [String] comment Specify any comments pertaining to the call. This of
+            #   type string with a max limit of 100 characters. Twilio does not treat this field
+            #   as PII, so don’t put any PII in here.
+            # @param [String] incident Associate this call with an incident or support ticket.
+            #   This is of type string with a max limit of 100 characters. Twilio does not treat
+            #   this field as PII, so don’t put any PII in here.
+            # @return [AnnotationInstance] Updated AnnotationInstance
+            def update(answered_by: :unset, connectivity_issue: :unset, quality_issues: :unset, spam: :unset, call_score: :unset, comment: :unset, incident: :unset)
+              data = Twilio::Values.of({
+                  'AnsweredBy' => answered_by,
+                  'ConnectivityIssue' => connectivity_issue,
+                  'QualityIssues' => quality_issues,
+                  'Spam' => spam,
+                  'CallScore' => call_score,
+                  'Comment' => comment,
+                  'Incident' => incident,
+              })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              AnnotationInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Fetch the AnnotationInstance
+            # @return [AnnotationInstance] Fetched AnnotationInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              AnnotationInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Insights.V1.AnnotationContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Insights.V1.AnnotationContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class AnnotationInstance < InstanceResource
+            ##
+            # Initialize the AnnotationInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] call_sid The unique SID identifier of the Call.
+            # @return [AnnotationInstance] AnnotationInstance
+            def initialize(version, payload, call_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'call_sid' => payload['call_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'answered_by' => payload['answered_by'],
+                  'connectivity_issue' => payload['connectivity_issue'],
+                  'quality_issues' => payload['quality_issues'],
+                  'spam' => payload['spam'],
+                  'call_score' => payload['call_score'] == nil ? payload['call_score'] : payload['call_score'].to_i,
+                  'comment' => payload['comment'],
+                  'incident' => payload['incident'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'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 [AnnotationContext] AnnotationContext for this AnnotationInstance
+            def context
+              unless @instance_context
+                @instance_context = AnnotationContext.new(@version, @params['call_sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] Call SID.
+            def call_sid
+              @properties['call_sid']
+            end
+
+            ##
+            # @return [String] Account SID.
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [annotation.AnsweredBy] Indicates the answering entity as determined by Answering Machine Detection.
+            def answered_by
+              @properties['answered_by']
+            end
+
+            ##
+            # @return [annotation.ConnectivityIssue] Indicates if the call had any connectivity issue
+            def connectivity_issue
+              @properties['connectivity_issue']
+            end
+
+            ##
+            # @return [Array[String]] Indicates if the call had audio quality issues.
+            def quality_issues
+              @properties['quality_issues']
+            end
+
+            ##
+            # @return [Boolean] Call spam indicator
+            def spam
+              @properties['spam']
+            end
+
+            ##
+            # @return [String] Call Score
+            def call_score
+              @properties['call_score']
+            end
+
+            ##
+            # @return [String] User comments
+            def comment
+              @properties['comment']
+            end
+
+            ##
+            # @return [String] Call tag for incidents or support ticket
+            def incident
+              @properties['incident']
+            end
+
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Update the AnnotationInstance
+            # @param [annotation.AnsweredBy] answered_by Which entity answered the call as
+            #   determined by Answering Machine Detection. Use this to provide feedback on
+            #   Answering Machine Detection accuracy. Possible enumerated values, one of: human,
+            #   machine. human indicates the call was answered by a person. machine indicates
+            #   the call was answered by an answering machine.
+            # @param [annotation.ConnectivityIssue] connectivity_issue Specify if the call had
+            #   any connectivity issues. Possible enumerated values, one :
+            #   no_connectivity_issue, invalid_number, caller_id, dropped_call,
+            #   number_reachability.
+            # @param [String] quality_issues Specify if the call had any subjective quality
+            #   issues. Possible values, one or more of:  no_quality_issue, low_volume,
+            #   choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated
+            #   values to indicate multiple quality issues for the same call
+            # @param [Boolean] spam Specify if the call was a spam call. Use this to provide
+            #   feedback on whether calls placed from your account were marked as spam, or if
+            #   inbound calls received by your account were unwanted spam. Is of type Boolean:
+            #   true, false. Use true if the call was a spam call.
+            # @param [String] call_score Specify the call score. This is of type integer. Use
+            #   a range of 1-5 to indicate the call experience score, with the following mapping
+            #   as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor,
+            #   1: Bad].
+            # @param [String] comment Specify any comments pertaining to the call. This of
+            #   type string with a max limit of 100 characters. Twilio does not treat this field
+            #   as PII, so don’t put any PII in here.
+            # @param [String] incident Associate this call with an incident or support ticket.
+            #   This is of type string with a max limit of 100 characters. Twilio does not treat
+            #   this field as PII, so don’t put any PII in here.
+            # @return [AnnotationInstance] Updated AnnotationInstance
+            def update(answered_by: :unset, connectivity_issue: :unset, quality_issues: :unset, spam: :unset, call_score: :unset, comment: :unset, incident: :unset)
+              context.update(
+                  answered_by: answered_by,
+                  connectivity_issue: connectivity_issue,
+                  quality_issues: quality_issues,
+                  spam: spam,
+                  call_score: call_score,
+                  comment: comment,
+                  incident: incident,
+              )
+            end
+
+            ##
+            # Fetch the AnnotationInstance
+            # @return [AnnotationInstance] Fetched AnnotationInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Insights.V1.AnnotationInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Insights.V1.AnnotationInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/insights/v1/call/event.rb

@@ -0,0 +1,262 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Insights < Domain
+      class V1 < Version
+        class CallContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class EventList < ListResource
+            ##
+            # Initialize the EventList
+            # @param [Version] version Version that contains the resource
+            # @param [String] call_sid The call_sid
+            # @return [EventList] EventList
+            def initialize(version, call_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {call_sid: call_sid}
+              @uri = "/Voice/#{@solution[:call_sid]}/Events"
+            end
+
+            ##
+            # Lists EventInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @param [event.TwilioEdge] edge The edge
+            # @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(edge: :unset, limit: nil, page_size: nil)
+              self.stream(edge: edge, limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams EventInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @param [event.TwilioEdge] edge The edge
+            # @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 [Enumerable] Enumerable that will yield up to limit results
+            def stream(edge: :unset, limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(edge: edge, page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields EventInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            def each
+              limits = @version.read_limits
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # Retrieve a single page of EventInstance records from the API.
+            # Request is executed immediately.
+            # @param [event.TwilioEdge] edge The edge
+            # @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 EventInstance
+            def page(edge: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'Edge' => edge,
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              EventPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of EventInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of EventInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              EventPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Insights.V1.EventList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class EventPage < Page
+            ##
+            # Initialize the EventPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [EventPage] EventPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of EventInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [EventInstance] EventInstance
+            def get_instance(payload)
+              EventInstance.new(@version, payload, call_sid: @solution[:call_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Insights.V1.EventPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class EventInstance < InstanceResource
+            ##
+            # Initialize the EventInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] call_sid The call_sid
+            # @return [EventInstance] EventInstance
+            def initialize(version, payload, call_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'timestamp' => payload['timestamp'],
+                  'call_sid' => payload['call_sid'],
+                  'account_sid' => payload['account_sid'],
+                  'edge' => payload['edge'],
+                  'group' => payload['group'],
+                  'level' => payload['level'],
+                  'name' => payload['name'],
+                  'carrier_edge' => payload['carrier_edge'],
+                  'sip_edge' => payload['sip_edge'],
+                  'sdk_edge' => payload['sdk_edge'],
+                  'client_edge' => payload['client_edge'],
+              }
+            end
+
+            ##
+            # @return [String] The timestamp
+            def timestamp
+              @properties['timestamp']
+            end
+
+            ##
+            # @return [String] The call_sid
+            def call_sid
+              @properties['call_sid']
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [event.TwilioEdge] The edge
+            def edge
+              @properties['edge']
+            end
+
+            ##
+            # @return [String] The group
+            def group
+              @properties['group']
+            end
+
+            ##
+            # @return [event.Level] The level
+            def level
+              @properties['level']
+            end
+
+            ##
+            # @return [String] The name
+            def name
+              @properties['name']
+            end
+
+            ##
+            # @return [Hash] The carrier_edge
+            def carrier_edge
+              @properties['carrier_edge']
+            end
+
+            ##
+            # @return [Hash] The sip_edge
+            def sip_edge
+              @properties['sip_edge']
+            end
+
+            ##
+            # @return [Hash] The sdk_edge
+            def sdk_edge
+              @properties['sdk_edge']
+            end
+
+            ##
+            # @return [Hash] The client_edge
+            def client_edge
+              @properties['client_edge']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Insights.V1.EventInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Insights.V1.EventInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end