Class: Twilio::REST::Insights::V1::CallInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ CallInstance

Initialize the CallInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

    The sid


152
153
154
155
156
157
158
159
160
161
# File 'lib/twilio-ruby/rest/insights/v1/call.rb', line 152

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {'sid' => payload['sid'], 'url' => payload['url'], 'links' => payload['links'], }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#annotationannotation

Access the annotation

Returns:


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

def annotation
  context.annotation
end

#contextCallContext

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

Returns:


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

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

#eventsevents

Access the events

Returns:


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

def events
  context.events
end

#fetchCallInstance

Fetch the CallInstance

Returns:


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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns The links.

Returns:

  • (String)

    The links


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

def links
  @properties['links']
end

#metricsmetrics

Access the metrics

Returns:


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

def metrics
  context.metrics
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid


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

def sid
  @properties['sid']
end

#summarysummary

Access the summary

Returns:


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

def summary
  context.summary
end

#to_sObject

Provide a user friendly representation


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

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

#urlString

Returns The url.

Returns:

  • (String)

    The url


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

def url
  @properties['url']
end