Class: Twilio::REST::Insights::V1::CallContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/insights/v1/call.rb,
lib/twilio-ruby/rest/insights/v1/call/event.rb,
lib/twilio-ruby/rest/insights/v1/call/metric.rb,
lib/twilio-ruby/rest/insights/v1/call/annotation.rb,
lib/twilio-ruby/rest/insights/v1/call/call_summary.rb

Defined Under Namespace

Classes: AnnotationContext, AnnotationInstance, AnnotationInstanceMetadata, AnnotationList, AnnotationListResponse, AnnotationPage, AnnotationPageMetadata, CallSummaryContext, CallSummaryInstance, CallSummaryInstanceMetadata, CallSummaryList, CallSummaryListResponse, CallSummaryPage, CallSummaryPageMetadata, EventInstance, EventList, EventListResponse, EventPage, EventPageMetadata, MetricInstance, MetricList, MetricListResponse, MetricPage, MetricPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ CallContext

Initialize the CallContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) 


50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/insights/v1/call.rb', line 50

def initialize(version, sid)
    super(version)
    

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/Voice/#{@solution[:sid]}"

    # Dependents
    @metrics = nil
    @events = nil
    @summary = nil
    @annotation = nil
end

Instance Method Details

#annotation ⇒ AnnotationList, AnnotationContext

Access the annotation

Returns:



144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/insights/v1/call.rb', line 144

def annotation
    AnnotationContext.new(
            @version,
            @solution[:sid]
            )
end

#events ⇒ EventList, EventContext

Access the events

Returns:



123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/insights/v1/call.rb', line 123

def events
  unless @events
    @events = EventList.new(
            @version, call_sid: @solution[:sid], )
  end
  @events
end

#fetch ⇒ CallInstance

Fetch the CallInstance

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/insights/v1/call.rb', line 67

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    CallInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ CallInstance

Fetch the CallInstanceMetadata

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/insights/v1/call.rb', line 86

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    call_instance = CallInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    CallInstanceMetadata.new(
        @version,
        call_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



160
161
162
163
 
# File 'lib/twilio-ruby/rest/insights/v1/call.rb', line 160

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Insights.V1.CallContext #{context}>"
end

#metrics ⇒ MetricList, MetricContext

Access the metrics

Returns:



112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/insights/v1/call.rb', line 112

def metrics
  unless @metrics
    @metrics = MetricList.new(
            @version, call_sid: @solution[:sid], )
  end
  @metrics
end

#summary ⇒ CallSummaryList, CallSummaryContext

Access the summary

Returns:



134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/insights/v1/call.rb', line 134

def summary
    CallSummaryContext.new(
            @version,
            @solution[:sid]
            )
end

#to_s ⇒ Object

Provide a user friendly representation



153
154
155
156
 
# File 'lib/twilio-ruby/rest/insights/v1/call.rb', line 153

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Insights.V1.CallContext #{context}>"
end