Class: Twilio::REST::FlexApi::V1::InsightsSegmentsInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/insights_segments.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, segment_id: nil) ⇒ InsightsSegmentsInstance

Initialize the InsightsSegmentsInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    To unique id of the segment



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 211

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

  # Marshaled Properties
  @properties = {
      'segment_id' => payload['segment_id'],
      'external_id' => payload['external_id'],
      'queue' => payload['queue'],
      'external_contact' => payload['external_contact'],
      'external_segment_link_id' => payload['external_segment_link_id'],
      'date' => payload['date'],
      'account_id' => payload['account_id'],
      'external_segment_link' => payload['external_segment_link'],
      'agent_id' => payload['agent_id'],
      'agent_phone' => payload['agent_phone'],
      'agent_name' => payload['agent_name'],
      'agent_team_name' => payload['agent_team_name'],
      'agent_team_name_in_hierarchy' => payload['agent_team_name_in_hierarchy'],
      'agent_link' => payload['agent_link'],
      'customer_phone' => payload['customer_phone'],
      'customer_name' => payload['customer_name'],
      'customer_link' => payload['customer_link'],
      'segment_recording_offset' => payload['segment_recording_offset'],
      'media' => payload['media'],
      'assessment_type' => payload['assessment_type'],
      'assessment_percentage' => payload['assessment_percentage'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_id ⇒ String

Returns The id for the account.

Returns:

  • (String) —

    The id for the account.



294
295
296
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 294

def 
  @properties['account_id']
end

#agent_id ⇒ String

Returns The unique id for the agent.

Returns:

  • (String) —

    The unique id for the agent.



306
307
308
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 306

def agent_id
  @properties['agent_id']
end

#agent_link ⇒ String

Returns The link to the agent conversation.

Returns:

  • (String) —

    The link to the agent conversation.



336
337
338
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 336

def agent_link
  @properties['agent_link']
end

#agent_name ⇒ String

Returns The agent name.

Returns:

  • (String) —

    The agent name.



318
319
320
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 318

def agent_name
  @properties['agent_name']
end

#agent_phone ⇒ String

Returns The agent phone number.

Returns:

  • (String) —

    The agent phone number.



312
313
314
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 312

def agent_phone
  @properties['agent_phone']
end

#agent_team_name ⇒ String

Returns The team name of agent.

Returns:

  • (String) —

    The team name of agent.



324
325
326
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 324

def agent_team_name
  @properties['agent_team_name']
end

#agent_team_name_in_hierarchy ⇒ String

Returns he team name of agent.

Returns:

  • (String) —

    he team name of agent.



330
331
332
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 330

def agent_team_name_in_hierarchy
  @properties['agent_team_name_in_hierarchy']
end

#assessment_percentage ⇒ Hash

Returns The percentage score on Assessment.

Returns:

  • (Hash) —

    The percentage score on Assessment.



378
379
380
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 378

def assessment_percentage
  @properties['assessment_percentage']
end

#assessment_type ⇒ Hash

Returns The type of the assessment.

Returns:

  • (Hash) —

    The type of the assessment.



372
373
374
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 372

def assessment_type
  @properties['assessment_type']
end

#context ⇒ InsightsSegmentsContext

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

Returns:



249
250
251
252
253
254
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 249

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

#customer_link ⇒ String

Returns The link to the customer conversation.

Returns:

  • (String) —

    The link to the customer conversation.



354
355
356
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 354

def customer_link
  @properties['customer_link']
end

#customer_name ⇒ String

Returns The customer name.

Returns:

  • (String) —

    The customer name.



348
349
350
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 348

def customer_name
  @properties['customer_name']
end

#customer_phone ⇒ String

Returns The sort value for comment.

Returns:

  • (String) —

    The sort value for comment.



342
343
344
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 342

def customer_phone
  @properties['customer_phone']
end

#date ⇒ String

Returns The conversation date.

Returns:

  • (String) —

    The conversation date.



288
289
290
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 288

def date
  @properties['date']
end

#external_contact ⇒ String

Returns The external_contact.

Returns:

  • (String) —

    The external_contact



276
277
278
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 276

def external_contact
  @properties['external_contact']
end

#external_id ⇒ String

Returns The id for conversation.

Returns:

  • (String) —

    The id for conversation.



264
265
266
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 264

def external_id
  @properties['external_id']
end

#external_segment_link ⇒ String

Returns The hyperlink to recording.

Returns:

  • (String) —

    The hyperlink to recording.



300
301
302
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 300

def external_segment_link
  @properties['external_segment_link']
end

#external_segment_link_id ⇒ String

Returns The uuid for external_segment_link.

Returns:

  • (String) —

    The uuid for external_segment_link.



282
283
284
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 282

def external_segment_link_id
  @properties['external_segment_link_id']
end

#fetch(token: :unset) ⇒ InsightsSegmentsInstance

Fetch the InsightsSegmentsInstance

Parameters:

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

    The Token HTTP request header

Returns:



392
393
394
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 392

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



405
406
407
408
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 405

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

#media ⇒ Hash

Returns The media identifiers of the conversation.

Returns:

  • (Hash) —

    The media identifiers of the conversation.



366
367
368
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 366

def media
  @properties['media']
end

#queue ⇒ String

Returns The queue.

Returns:

  • (String) —

    The queue



270
271
272
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 270

def queue
  @properties['queue']
end

#segment_id ⇒ String

Returns Unique segment Id.

Returns:

  • (String) —

    Unique segment Id



258
259
260
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 258

def segment_id
  @properties['segment_id']
end

#segment_recording_offset ⇒ String

Returns The offset value for the recording.

Returns:

  • (String) —

    The offset value for the recording.



360
361
362
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 360

def segment_recording_offset
  @properties['segment_recording_offset']
end

#to_s ⇒ Object

Provide a user friendly representation



398
399
400
401
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 398

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



384
385
386
 
# File 'lib/twilio-ruby/rest/flex_api/v1/insights_segments.rb', line 384

def url
  @properties['url']
end