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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the AnnotationInstance

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 Annotation resource.

  • sid (String) —

    The SID of the Call resource to fetch.



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 166

def initialize(version, payload , call_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'call_sid' => payload['call_sid'],
        'account_sid' => payload['account_sid'],
        'answered_by' => payload['answered_by'],
        'connectivity_issue' => payload['connectivity_issue'],
        'quality_issues' => payload['quality_issues'],
        'spam' => payload['spam'],
        'call_score' => payload['call_score'] == nil ? payload['call_score'] : payload['call_score'].to_i,
        'comment' => payload['comment'],
        'incident' => payload['incident'],
        'url' => payload['url'],
    }

    # 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.



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

def 
    @properties['account_sid']
end

#answered_by ⇒ AnsweredBy

Returns:

  • (AnsweredBy) 


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

def answered_by
    @properties['answered_by']
end

#call_score ⇒ String

Returns Specifies the Call Score, if available. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].

Returns:

  • (String) —

    Specifies the Call Score, if available. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].



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

def call_score
    @properties['call_score']
end

#call_sid ⇒ String

Returns The unique SID identifier of the Call.

Returns:

  • (String) —

    The unique SID identifier of the Call.



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

def call_sid
    @properties['call_sid']
end

#comment ⇒ String

Returns Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments.

Returns:

  • (String) —

    Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments.



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

def comment
    @properties['comment']
end

#connectivity_issue ⇒ ConnectivityIssue

Returns:

  • (ConnectivityIssue) 


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

def connectivity_issue
    @properties['connectivity_issue']
end

#context ⇒ AnnotationContext

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

Returns:



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

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

#fetch ⇒ AnnotationInstance

Fetch the AnnotationInstance

Returns:



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

def fetch

    context.fetch
end

#incident ⇒ String

Returns Incident or support ticket associated with this call. The ‘incident` property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.

Returns:

  • (String) —

    Incident or support ticket associated with this call. The ‘incident` property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.



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

def incident
    @properties['incident']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#quality_issues ⇒ Array<String>

Returns Specifies if the call had any subjective quality issues. Possible values are one or more of ‘no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, or `static_noise`.

Returns:

  • (Array<String>) —

    Specifies if the call had any subjective quality issues. Possible values are one or more of ‘no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, or `static_noise`.



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

def quality_issues
    @properties['quality_issues']
end

#spam ⇒ Boolean

Returns Specifies if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.

Returns:

  • (Boolean) —

    Specifies if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.



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

def spam
    @properties['spam']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(answered_by: :unset, connectivity_issue: :unset, quality_issues: :unset, spam: :unset, call_score: :unset, comment: :unset, incident: :unset) ⇒ AnnotationInstance

Update the AnnotationInstance

Parameters:

  • answered_by (AnsweredBy) (defaults to: :unset)
  • connectivity_issue (ConnectivityIssue) (defaults to: :unset)
  • quality_issues (String) (defaults to: :unset) —

    Specify if the call had any subjective quality issues. Possible values, one or more of ‘no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. Use comma separated values to indicate multiple quality issues for the same call.

  • spam (Boolean) (defaults to: :unset) —

    A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use ‘true` if the call was a spam call.

  • call_score (String) (defaults to: :unset) —

    Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].

  • comment (String) (defaults to: :unset) —

    Specify any comments pertaining to the call. ‘comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`.

  • incident (String) (defaults to: :unset) —

    Associate this call with an incident or support ticket. The ‘incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.

Returns:



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/insights/v1/call/annotation.rb', line 277

def update(
    answered_by: :unset, 
    connectivity_issue: :unset, 
    quality_issues: :unset, 
    spam: :unset, 
    call_score: :unset, 
    comment: :unset, 
    incident: :unset
)

    context.update(
        answered_by: answered_by, 
        connectivity_issue: connectivity_issue, 
        quality_issues: quality_issues, 
        spam: spam, 
        call_score: call_score, 
        comment: comment, 
        incident: incident, 
    )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
    @properties['url']
end