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

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

Overview

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 [email protected].

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

  • call_sid (String) (defaults to: nil) —

    The call_sid



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 123

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'],
      'processing_state' => payload['processing_state'],
      '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'],
  }

  # Context
  @instance_context = nil
  @params = {'call_sid' => call_sid, }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



167
168
169
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 167

def 
  @properties['account_sid']
end

#attributes ⇒ Hash

Returns The attributes.

Returns:

  • (Hash) —

    The attributes



269
270
271
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 269

def attributes
  @properties['attributes']
end

#call_sid ⇒ String

Returns The call_sid.

Returns:

  • (String) —

    The call_sid



173
174
175
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 173

def call_sid
  @properties['call_sid']
end

#call_state ⇒ call_summary.CallState

Returns The call_state.

Returns:

  • (call_summary.CallState) —

    The call_state



185
186
187
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 185

def call_state
  @properties['call_state']
end

#call_type ⇒ call_summary.CallType

Returns The call_type.

Returns:

  • (call_summary.CallType) —

    The call_type



179
180
181
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 179

def call_type
  @properties['call_type']
end

#carrier_edge ⇒ Hash

Returns The carrier_edge.

Returns:

  • (Hash) —

    The carrier_edge



233
234
235
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 233

def carrier_edge
  @properties['carrier_edge']
end

#client_edge ⇒ Hash

Returns The client_edge.

Returns:

  • (Hash) —

    The client_edge



239
240
241
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 239

def client_edge
  @properties['client_edge']
end

#connect_duration ⇒ String

Returns The connect_duration.

Returns:

  • (String) —

    The connect_duration



215
216
217
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 215

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:



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

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

#duration ⇒ String

Returns The duration.

Returns:

  • (String) —

    The duration



209
210
211
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 209

def duration
  @properties['duration']
end

#end_time ⇒ Time

Returns The end_time.

Returns:

  • (Time) —

    The end_time



203
204
205
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 203

def end_time
  @properties['end_time']
end

#fetch(processing_state: :unset) ⇒ CallSummaryInstance

Fetch a CallSummaryInstance

Parameters:

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

    The processing_state

Returns:



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

def fetch(processing_state: :unset)
  context.fetch(processing_state: processing_state, )
end

#from ⇒ Hash

Returns The from.

Returns:

  • (Hash) —

    The from



221
222
223
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 221

def from
  @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#processing_state ⇒ call_summary.ProcessingState

Returns The processing_state.

Returns:

  • (call_summary.ProcessingState) —

    The processing_state



191
192
193
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 191

def processing_state
  @properties['processing_state']
end

#properties ⇒ Hash

Returns The properties.

Returns:

  • (Hash) —

    The properties



275
276
277
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 275

def properties
  @properties['properties']
end

#sdk_edge ⇒ Hash

Returns The sdk_edge.

Returns:

  • (Hash) —

    The sdk_edge



245
246
247
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 245

def sdk_edge
  @properties['sdk_edge']
end

#sip_edge ⇒ Hash

Returns The sip_edge.

Returns:

  • (Hash) —

    The sip_edge



251
252
253
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 251

def sip_edge
  @properties['sip_edge']
end

#start_time ⇒ Time

Returns The start_time.

Returns:

  • (Time) —

    The start_time



197
198
199
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 197

def start_time
  @properties['start_time']
end

#tags ⇒ String

Returns The tags.

Returns:

  • (String) —

    The tags



257
258
259
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 257

def tags
  @properties['tags']
end

#to ⇒ Hash

Returns The to.

Returns:

  • (Hash) —

    The to



227
228
229
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 227

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



263
264
265
 
# File 'lib/twilio-ruby/rest/insights/v1/call/summary.rb', line 263

def url
  @properties['url']
end