whoosh-ruby 0.1.0 → 0.1.2

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

@@ -0,0 +1,319 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Insights
+#    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 Insights < InsightsBase
+            class V1 < Version
+                class CallContext < InstanceContext
+
+                     class AnnotationList < ListResource
+                    ##
+                    # Initialize the AnnotationList
+                    # @param [Version] version Version that contains the resource
+                    # @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 AnnotationContext < InstanceContext
+                    ##
+                    # Initialize the AnnotationContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] call_sid The unique string that Twilio created to identify this Call resource. It always starts with a CA.
+                    # @return [AnnotationContext] AnnotationContext
+                    def initialize(version, call_sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { call_sid: call_sid,  }
+                        @uri = "/Voice/#{@solution[:call_sid]}/Annotation"
+
+                        
+                    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
+
+                    ##
+                    # Update the AnnotationInstance
+                    # @param [AnsweredBy] answered_by 
+                    # @param [ConnectivityIssue] connectivity_issue 
+                    # @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
+
+
+                    ##
+                    # 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
+
+                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
+                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] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Annotation
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @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  || @properties['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] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = AnnotationContext.new(@version , @params['call_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Call.
+                    def call_sid
+                        @properties['call_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Account.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [AnsweredBy] 
+                    def answered_by
+                        @properties['answered_by']
+                    end
+                    
+                    ##
+                    # @return [ConnectivityIssue] 
+                    def connectivity_issue
+                        @properties['connectivity_issue']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] 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
+                    def quality_issues
+                        @properties['quality_issues']
+                    end
+                    
+                    ##
+                    # @return [Boolean] 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.
+                    def spam
+                        @properties['spam']
+                    end
+                    
+                    ##
+                    # @return [String] 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].
+                    def call_score
+                        @properties['call_score']
+                    end
+                    
+                    ##
+                    # @return [String] 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.
+                    def comment
+                        @properties['comment']
+                    end
+                    
+                    ##
+                    # @return [String] 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.
+                    def incident
+                        @properties['incident']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of this resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the AnnotationInstance
+                    # @return [AnnotationInstance] Fetched AnnotationInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the AnnotationInstance
+                    # @param [AnsweredBy] answered_by 
+                    # @param [ConnectivityIssue] connectivity_issue 
+                    # @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
+
+                    ##
+                    # 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/call_summary.rb

@@ -0,0 +1,350 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Insights
+#    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 Insights < InsightsBase
+            class V1 < Version
+                class CallContext < InstanceContext
+
+                     class CallSummaryList < ListResource
+                    ##
+                    # Initialize the CallSummaryList
+                    # @param [Version] version Version that contains the resource
+                    # @return [CallSummaryList] CallSummaryList
+                    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.CallSummaryList>'
+                    end
+                end
+
+
+                class CallSummaryContext < InstanceContext
+                    ##
+                    # Initialize the CallSummaryContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] call_sid 
+                    # @return [CallSummaryContext] CallSummaryContext
+                    def initialize(version, call_sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { call_sid: call_sid,  }
+                        @uri = "/Voice/#{@solution[:call_sid]}/Summary"
+
+                        
+                    end
+                    ##
+                    # Fetch the CallSummaryInstance
+                    # @param [ProcessingState] processing_state 
+                    # @return [CallSummaryInstance] Fetched CallSummaryInstance
+                    def fetch(
+                        processing_state: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'ProcessingState' => processing_state,
+                        })
+                        payload = @version.fetch('GET', @uri, params: params)
+                        CallSummaryInstance.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.CallSummaryContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Insights.V1.CallSummaryContext #{context}>"
+                    end
+                end
+
+                class CallSummaryPage < Page
+                    ##
+                    # Initialize the CallSummaryPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [CallSummaryPage] CallSummaryPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of CallSummaryInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [CallSummaryInstance] CallSummaryInstance
+                    def get_instance(payload)
+                        CallSummaryInstance.new(@version, payload, call_sid: @solution[:call_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Insights.V1.CallSummaryPage>'
+                    end
+                end
+                class CallSummaryInstance < InstanceResource
+                    ##
+                    # Initialize the CallSummaryInstance
+                    # @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 CallSummary
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [CallSummaryInstance] CallSummaryInstance
+                    def initialize(version, payload , call_sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'call_sid' => payload['call_sid'],
+                            'call_type' => payload['call_type'],
+                            'call_state' => payload['call_state'],
+                            'answered_by' => payload['answered_by'],
+                            'processing_state' => payload['processing_state'],
+                            'created_time' => Twilio.deserialize_iso8601_datetime(payload['created_time']),
+                            'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
+                            'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
+                            'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
+                            'connect_duration' => payload['connect_duration'] == nil ? payload['connect_duration'] : payload['connect_duration'].to_i,
+                            'from' => payload['from'],
+                            'to' => payload['to'],
+                            'carrier_edge' => payload['carrier_edge'],
+                            'client_edge' => payload['client_edge'],
+                            'sdk_edge' => payload['sdk_edge'],
+                            'sip_edge' => payload['sip_edge'],
+                            'tags' => payload['tags'],
+                            'url' => payload['url'],
+                            'attributes' => payload['attributes'],
+                            'properties' => payload['properties'],
+                            'trust' => payload['trust'],
+                            'annotation' => payload['annotation'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'call_sid' => call_sid  || @properties['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 [CallSummaryContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = CallSummaryContext.new(@version , @params['call_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def call_sid
+                        @properties['call_sid']
+                    end
+                    
+                    ##
+                    # @return [CallType] 
+                    def call_type
+                        @properties['call_type']
+                    end
+                    
+                    ##
+                    # @return [CallState] 
+                    def call_state
+                        @properties['call_state']
+                    end
+                    
+                    ##
+                    # @return [AnsweredBy] 
+                    def answered_by
+                        @properties['answered_by']
+                    end
+                    
+                    ##
+                    # @return [ProcessingState] 
+                    def processing_state
+                        @properties['processing_state']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def created_time
+                        @properties['created_time']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def start_time
+                        @properties['start_time']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def end_time
+                        @properties['end_time']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def duration
+                        @properties['duration']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def connect_duration
+                        @properties['connect_duration']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def from
+                        @properties['from']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def to
+                        @properties['to']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def carrier_edge
+                        @properties['carrier_edge']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def client_edge
+                        @properties['client_edge']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def sdk_edge
+                        @properties['sdk_edge']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def sip_edge
+                        @properties['sip_edge']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] 
+                    def tags
+                        @properties['tags']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def attributes
+                        @properties['attributes']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def properties
+                        @properties['properties']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def trust
+                        @properties['trust']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def annotation
+                        @properties['annotation']
+                    end
+                    
+                    ##
+                    # Fetch the CallSummaryInstance
+                    # @param [ProcessingState] processing_state 
+                    # @return [CallSummaryInstance] Fetched CallSummaryInstance
+                    def fetch(
+                        processing_state: :unset
+                    )
+
+                        context.fetch(
+                            processing_state: processing_state, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Insights.V1.CallSummaryInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Insights.V1.CallSummaryInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+