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.



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
169
170
171
172
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 139

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.



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

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.



319
320
321
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 319

def annotation
    @properties['annotation']
end

#answered_by ⇒ AnsweredBy

Returns:

  • (AnsweredBy) 


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

def answered_by
    @properties['answered_by']
end

#attributes ⇒ Hash

Returns Attributes capturing call-flow-specific details.

Returns:

  • (Hash) —

    Attributes capturing call-flow-specific details.



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

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.



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

def call_sid
    @properties['call_sid']
end

#call_state ⇒ CallState

Returns:

  • (CallState) 


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

def call_state
    @properties['call_state']
end

#call_type ⇒ CallType

Returns:

  • (CallType) 


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

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.



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

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.



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

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



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

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:



178
179
180
181
182
183
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 178

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



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

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



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

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.



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

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:



327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 327

def fetch(
    processing_state: :unset
)

    context.fetch(
        processing_state: processing_state, 
    )
end

#from ⇒ Hash

Returns The calling party.

Returns:

  • (Hash) —

    The calling party.



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

def from
    @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



345
346
347
348
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 345

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

#processing_state ⇒ ProcessingState

Returns:

  • (ProcessingState) 


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

def processing_state
    @properties['processing_state']
end

#properties ⇒ Hash

Returns Contains edge-agnostic call-level details.

Returns:

  • (Hash) —

    Contains edge-agnostic call-level details.



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

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.



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

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.



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

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.



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

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.



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

def tags
    @properties['tags']
end

#to ⇒ Hash

Returns The called party.

Returns:

  • (Hash) —

    The called party.



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

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



338
339
340
341
 
# File 'lib/twilio-ruby/rest/insights/v1/call/call_summary.rb', line 338

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.



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

def trust
    @properties['trust']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
    @properties['url']
end