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

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/insights/v1/call/call_summary.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, call_sid: nil) ⇒ CallSummaryInstance

Initialize the CallSummaryInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this CallSummary resource.

  • sid (String) —

    The SID of the Call resource to fetch.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 135

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

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



183
184
185
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 183

def 
    @properties['account_sid']
end

#annotation ⇒ Hash

Returns Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API.

Returns:

  • (Hash) —

    Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API.



315
316
317
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 315

def annotation
    @properties['annotation']
end

#answered_by ⇒ AnsweredBy

Returns:

  • (AnsweredBy) 


207
208
209
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 207

def answered_by
    @properties['answered_by']
end

#attributes ⇒ Hash

Returns Attributes capturing call-flow-specific details.

Returns:

  • (Hash) —

    Attributes capturing call-flow-specific details.



297
298
299
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 297

def attributes
    @properties['attributes']
end

#call_sid ⇒ String

Returns The unique SID identifier of the Call.

Returns:

  • (String) —

    The unique SID identifier of the Call.



189
190
191
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 189

def call_sid
    @properties['call_sid']
end

#call_state ⇒ CallState

Returns:

  • (CallState) 


201
202
203
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 201

def call_state
    @properties['call_state']
end

#call_type ⇒ CallType

Returns:

  • (CallType) 


195
196
197
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 195

def call_type
    @properties['call_type']
end

#carrier_edge ⇒ Hash

Returns Contains metrics and properties for the Twilio media gateway of a PSTN call.

Returns:

  • (Hash) —

    Contains metrics and properties for the Twilio media gateway of a PSTN call.



261
262
263
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 261

def carrier_edge
    @properties['carrier_edge']
end

#client_edge ⇒ Hash

Returns Contains metrics and properties for the Twilio media gateway of a Client call.

Returns:

  • (Hash) —

    Contains metrics and properties for the Twilio media gateway of a Client call.



267
268
269
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 267

def client_edge
    @properties['client_edge']
end

#connect_duration ⇒ String

Returns Duration between when the call was answered and when it ended.

Returns:

  • (String) —

    Duration between when the call was answered and when it ended



243
244
245
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 243

def connect_duration
    @properties['connect_duration']
end

#context ⇒ CallSummaryContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



174
175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 174

def context
    unless @instance_context
        @instance_context = CallSummaryContext.new(@version , @params['call_sid'])
    end
    @instance_context
end

#created_time ⇒ Time

Returns The time at which the Call was created, given in ISO 8601 format. Can be different from ‘start_time` in the event of queueing due to CPS.

Returns:

  • (Time) —

    The time at which the Call was created, given in ISO 8601 format. Can be different from ‘start_time` in the event of queueing due to CPS



219
220
221
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 219

def created_time
    @properties['created_time']
end

#duration ⇒ String

Returns Duration between when the call was initiated and the call was ended.

Returns:

  • (String) —

    Duration between when the call was initiated and the call was ended



237
238
239
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 237

def duration
    @properties['duration']
end

#end_time ⇒ Time

Returns The time at which the Call was ended, given in ISO 8601 format.

Returns:

  • (Time) —

    The time at which the Call was ended, given in ISO 8601 format.



231
232
233
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 231

def end_time
    @properties['end_time']
end

#fetch(processing_state: :unset) ⇒ CallSummaryInstance

Fetch the CallSummaryInstance

Parameters:

  • processing_state (ProcessingState) (defaults to: :unset) —

    The Processing State of this Call Summary. One of ‘complete`, `partial` or `all`.

Returns:



323
324
325
326
327
328
329
330
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 323

def fetch(
    processing_state: :unset
)

    context.fetch(
        processing_state: processing_state, 
    )
end

#from ⇒ Hash

Returns The calling party.

Returns:

  • (Hash) —

    The calling party.



249
250
251
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 249

def from
    @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



341
342
343
344
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 341

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Insights.V1.CallSummaryInstance #{values}>"
end

#processing_state ⇒ ProcessingState

Returns:

  • (ProcessingState) 


213
214
215
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 213

def processing_state
    @properties['processing_state']
end

#properties ⇒ Hash

Returns Contains edge-agnostic call-level details.

Returns:

  • (Hash) —

    Contains edge-agnostic call-level details.



303
304
305
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 303

def properties
    @properties['properties']
end

#sdk_edge ⇒ Hash

Returns Contains metrics and properties for the SDK sensor library for Client calls.

Returns:

  • (Hash) —

    Contains metrics and properties for the SDK sensor library for Client calls.



273
274
275
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 273

def sdk_edge
    @properties['sdk_edge']
end

#sip_edge ⇒ Hash

Returns Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.

Returns:

  • (Hash) —

    Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.



279
280
281
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 279

def sip_edge
    @properties['sip_edge']
end

#start_time ⇒ Time

Returns The time at which the Call was started, given in ISO 8601 format.

Returns:

  • (Time) —

    The time at which the Call was started, given in ISO 8601 format.



225
226
227
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 225

def start_time
    @properties['start_time']
end

#tags ⇒ Array<String>

Returns Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.

Returns:

  • (Array<String>) —

    Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.



285
286
287
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 285

def tags
    @properties['tags']
end

#to ⇒ Hash

Returns The called party.

Returns:

  • (Hash) —

    The called party.



255
256
257
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 255

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



334
335
336
337
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 334

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Insights.V1.CallSummaryInstance #{values}>"
end

#trust ⇒ Hash

Returns Contains trusted communications details including Branded Call and verified caller ID.

Returns:

  • (Hash) —

    Contains trusted communications details including Branded Call and verified caller ID.



309
310
311
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 309

def trust
    @properties['trust']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



291
292
293
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 291

def url
    @properties['url']
end