Class: Twilio::REST::FlexApi::V1::ConfigurationInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/configuration.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ ConfigurationInstance

Initialize the ConfigurationInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 262

def initialize(version, payload )
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'attributes' => payload['attributes'],
        'status' => payload['status'],
        'taskrouter_workspace_sid' => payload['taskrouter_workspace_sid'],
        'taskrouter_target_workflow_sid' => payload['taskrouter_target_workflow_sid'],
        'taskrouter_target_taskqueue_sid' => payload['taskrouter_target_taskqueue_sid'],
        'taskrouter_taskqueues' => payload['taskrouter_taskqueues'],
        'taskrouter_skills' => payload['taskrouter_skills'],
        'taskrouter_worker_channels' => payload['taskrouter_worker_channels'],
        'taskrouter_worker_attributes' => payload['taskrouter_worker_attributes'],
        'taskrouter_offline_activity_sid' => payload['taskrouter_offline_activity_sid'],
        'runtime_domain' => payload['runtime_domain'],
        'messaging_service_instance_sid' => payload['messaging_service_instance_sid'],
        'chat_service_instance_sid' => payload['chat_service_instance_sid'],
        'flex_service_instance_sid' => payload['flex_service_instance_sid'],
        'flex_instance_sid' => payload['flex_instance_sid'],
        'ui_language' => payload['ui_language'],
        'ui_attributes' => payload['ui_attributes'],
        'ui_dependencies' => payload['ui_dependencies'],
        'ui_version' => payload['ui_version'],
        'service_version' => payload['service_version'],
        'call_recording_enabled' => payload['call_recording_enabled'],
        'call_recording_webhook_url' => payload['call_recording_webhook_url'],
        'crm_enabled' => payload['crm_enabled'],
        'crm_type' => payload['crm_type'],
        'crm_callback_url' => payload['crm_callback_url'],
        'crm_fallback_url' => payload['crm_fallback_url'],
        'crm_attributes' => payload['crm_attributes'],
        'public_attributes' => payload['public_attributes'],
        'plugin_service_enabled' => payload['plugin_service_enabled'],
        'plugin_service_attributes' => payload['plugin_service_attributes'],
        'integrations' => payload['integrations'],
        'outbound_call_flows' => payload['outbound_call_flows'],
        'serverless_service_sids' => payload['serverless_service_sids'],
        'queue_stats_configuration' => payload['queue_stats_configuration'],
        'notifications' => payload['notifications'],
        'markdown' => payload['markdown'],
        'url' => payload['url'],
        'flex_insights_hr' => payload['flex_insights_hr'],
        'flex_insights_drilldown' => payload['flex_insights_drilldown'],
        'flex_url' => payload['flex_url'],
        'channel_configs' => payload['channel_configs'],
        'debugger_integration' => payload['debugger_integration'],
        'flex_ui_status_report' => payload['flex_ui_status_report'],
        'agent_conv_end_methods' => payload['agent_conv_end_methods'],
        'citrix_voice_vdi' => payload['citrix_voice_vdi'],
        'offline_config' => payload['offline_config'],
    }

    # Context
    @instance_context = nil
    @params = {  }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the Configuration resource.

Returns:

  • (String) —

    The SID of the Account that created the Configuration resource.



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

def 
    @properties['account_sid']
end

#agent_conv_end_methods ⇒ Hash

Returns Agent conversation end methods.

Returns:

  • (Hash) —

    Agent conversation end methods.



613
614
615
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 613

def agent_conv_end_methods
    @properties['agent_conv_end_methods']
end

#attributes ⇒ Hash

Returns An object that contains application-specific data.

Returns:

  • (Hash) —

    An object that contains application-specific data.



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

def attributes
    @properties['attributes']
end

#call_recording_enabled ⇒ Boolean

Returns Whether call recording is enabled.

Returns:

  • (Boolean) —

    Whether call recording is enabled.



475
476
477
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 475

def call_recording_enabled
    @properties['call_recording_enabled']
end

#call_recording_webhook_url ⇒ String

Returns The call recording webhook URL.

Returns:

  • (String) —

    The call recording webhook URL.



481
482
483
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 481

def call_recording_webhook_url
    @properties['call_recording_webhook_url']
end

#channel_configs ⇒ Array<Hash>

Returns Settings for different limits for Flex Conversations channels attachments.

Returns:

  • (Array<Hash>) —

    Settings for different limits for Flex Conversations channels attachments.



595
596
597
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 595

def channel_configs
    @properties['channel_configs']
end

#chat_service_instance_sid ⇒ String

Returns The SID of the chat service this user belongs to.

Returns:

  • (String) —

    The SID of the chat service this user belongs to.



427
428
429
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 427

def chat_service_instance_sid
    @properties['chat_service_instance_sid']
end

#citrix_voice_vdi ⇒ Hash

Returns Citrix voice vdi configuration and settings.

Returns:

  • (Hash) —

    Citrix voice vdi configuration and settings.



619
620
621
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 619

def citrix_voice_vdi
    @properties['citrix_voice_vdi']
end

#context ⇒ ConfigurationContext

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

Returns:



328
329
330
331
332
333
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 328

def context
    unless @instance_context
        @instance_context = ConfigurationContext.new(@version )
    end
    @instance_context
end

#crm_attributes ⇒ Hash

Returns An object that contains the CRM attributes.

Returns:

  • (Hash) —

    An object that contains the CRM attributes.



511
512
513
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 511

def crm_attributes
    @properties['crm_attributes']
end

#crm_callback_url ⇒ String

Returns The CRM Callback URL.

Returns:

  • (String) —

    The CRM Callback URL.



499
500
501
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 499

def crm_callback_url
    @properties['crm_callback_url']
end

#crm_enabled ⇒ Boolean

Returns Whether CRM is present for Flex.

Returns:

  • (Boolean) —

    Whether CRM is present for Flex.



487
488
489
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 487

def crm_enabled
    @properties['crm_enabled']
end

#crm_fallback_url ⇒ String

Returns The CRM Fallback URL.

Returns:

  • (String) —

    The CRM Fallback URL.



505
506
507
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 505

def crm_fallback_url
    @properties['crm_fallback_url']
end

#crm_type ⇒ String

Returns The CRM type.

Returns:

  • (String) —

    The CRM type.



493
494
495
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 493

def crm_type
    @properties['crm_type']
end

#date_created ⇒ Time

Returns The date and time in GMT when the Configuration resource was created specified in ISO 8601 format.

Returns:

  • (Time) —

    The date and time in GMT when the Configuration resource was created specified in ISO 8601 format.



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the Configuration resource was last updated specified in ISO 8601 format.

Returns:

  • (Time) —

    The date and time in GMT when the Configuration resource was last updated specified in ISO 8601 format.



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

def date_updated
    @properties['date_updated']
end

#debugger_integration ⇒ Hash

Returns Configurable parameters for Debugger Integration.

Returns:

  • (Hash) —

    Configurable parameters for Debugger Integration.



601
602
603
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 601

def debugger_integration
    @properties['debugger_integration']
end

#fetch(ui_version: :unset) ⇒ ConfigurationInstance

Fetch the ConfigurationInstance

Parameters:

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

    The Pinned UI version of the Configuration resource to fetch.

Returns:



633
634
635
636
637
638
639
640
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 633

def fetch(
  ui_version: :unset
)

    context.fetch(
        ui_version: ui_version, 
    )
end

#flex_insights_drilldown ⇒ Boolean

Returns Setting this to true will redirect Flex UI to the URL set in flex_url.

Returns:

  • (Boolean) —

    Setting this to true will redirect Flex UI to the URL set in flex_url



583
584
585
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 583

def flex_insights_drilldown
    @properties['flex_insights_drilldown']
end

#flex_insights_hr ⇒ Hash

Returns Object with enabled/disabled flag with list of workspaces.

Returns:

  • (Hash) —

    Object with enabled/disabled flag with list of workspaces.



577
578
579
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 577

def flex_insights_hr
    @properties['flex_insights_hr']
end

#flex_instance_sid ⇒ String

Returns The SID of the Flex instance.

Returns:

  • (String) —

    The SID of the Flex instance.



439
440
441
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 439

def flex_instance_sid
    @properties['flex_instance_sid']
end

#flex_service_instance_sid ⇒ String

Returns The SID of the Flex service instance.

Returns:

  • (String) —

    The SID of the Flex service instance.



433
434
435
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 433

def flex_service_instance_sid
    @properties['flex_service_instance_sid']
end

#flex_ui_status_report ⇒ Hash

Returns Configurable parameters for Flex UI Status report.

Returns:

  • (Hash) —

    Configurable parameters for Flex UI Status report.



607
608
609
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 607

def flex_ui_status_report
    @properties['flex_ui_status_report']
end

#flex_url ⇒ String

Returns URL to redirect to in case drilldown is enabled.

Returns:

  • (String) —

    URL to redirect to in case drilldown is enabled.



589
590
591
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 589

def flex_url
    @properties['flex_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



663
664
665
666
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 663

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

#integrations ⇒ Array<Hash>

Returns A list of objects that contain the configurations for the Integrations supported in this configuration.

Returns:

  • (Array<Hash>) —

    A list of objects that contain the configurations for the Integrations supported in this configuration.



535
536
537
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 535

def integrations
    @properties['integrations']
end

#markdown ⇒ Hash

Returns Configurable parameters for Markdown.

Returns:

  • (Hash) —

    Configurable parameters for Markdown.



565
566
567
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 565

def markdown
    @properties['markdown']
end

#messaging_service_instance_sid ⇒ String

Returns The SID of the Messaging service instance.

Returns:

  • (String) —

    The SID of the Messaging service instance.



421
422
423
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 421

def messaging_service_instance_sid
    @properties['messaging_service_instance_sid']
end

#notifications ⇒ Hash

Returns Configurable parameters for Notifications.

Returns:

  • (Hash) —

    Configurable parameters for Notifications.



559
560
561
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 559

def notifications
    @properties['notifications']
end

#offline_config ⇒ Hash

Returns Presence and presence ttl configuration.

Returns:

  • (Hash) —

    Presence and presence ttl configuration



625
626
627
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 625

def offline_config
    @properties['offline_config']
end

#outbound_call_flows ⇒ Hash

Returns The list of outbound call flows.

Returns:

  • (Hash) —

    The list of outbound call flows.



541
542
543
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 541

def outbound_call_flows
    @properties['outbound_call_flows']
end

#plugin_service_attributes ⇒ Hash

Returns The plugin service attributes.

Returns:

  • (Hash) —

    The plugin service attributes.



529
530
531
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 529

def plugin_service_attributes
    @properties['plugin_service_attributes']
end

#plugin_service_enabled ⇒ Boolean

Returns Whether the plugin service enabled.

Returns:

  • (Boolean) —

    Whether the plugin service enabled.



523
524
525
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 523

def plugin_service_enabled
    @properties['plugin_service_enabled']
end

#public_attributes ⇒ Hash

Returns The list of public attributes, which are visible to unauthenticated clients.

Returns:

  • (Hash) —

    The list of public attributes, which are visible to unauthenticated clients.



517
518
519
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 517

def public_attributes
    @properties['public_attributes']
end

#queue_stats_configuration ⇒ Hash

Returns Configurable parameters for Queues Statistics.

Returns:

  • (Hash) —

    Configurable parameters for Queues Statistics.



553
554
555
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 553

def queue_stats_configuration
    @properties['queue_stats_configuration']
end

#runtime_domain ⇒ String

Returns The URL where the Flex instance is hosted.

Returns:

  • (String) —

    The URL where the Flex instance is hosted.



415
416
417
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 415

def runtime_domain
    @properties['runtime_domain']
end

#serverless_service_sids ⇒ Array<String>

Returns The list of serverless service SIDs.

Returns:

  • (Array<String>) —

    The list of serverless service SIDs.



547
548
549
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 547

def serverless_service_sids
    @properties['serverless_service_sids']
end

#service_version ⇒ String

Returns The Flex Service version.

Returns:

  • (String) —

    The Flex Service version.



469
470
471
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 469

def service_version
    @properties['service_version']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#taskrouter_offline_activity_sid ⇒ String

Returns The TaskRouter SID of the offline activity.

Returns:

  • (String) —

    The TaskRouter SID of the offline activity.



409
410
411
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 409

def taskrouter_offline_activity_sid
    @properties['taskrouter_offline_activity_sid']
end

#taskrouter_skills ⇒ Array<Hash>

Returns The Skill description for TaskRouter workers.

Returns:

  • (Array<Hash>) —

    The Skill description for TaskRouter workers.



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

def taskrouter_skills
    @properties['taskrouter_skills']
end

#taskrouter_target_taskqueue_sid ⇒ String

Returns The SID of the TaskRouter Target TaskQueue.

Returns:

  • (String) —

    The SID of the TaskRouter Target TaskQueue.



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

def taskrouter_target_taskqueue_sid
    @properties['taskrouter_target_taskqueue_sid']
end

#taskrouter_target_workflow_sid ⇒ String

Returns The SID of the TaskRouter target Workflow.

Returns:

  • (String) —

    The SID of the TaskRouter target Workflow.



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

def taskrouter_target_workflow_sid
    @properties['taskrouter_target_workflow_sid']
end

#taskrouter_taskqueues ⇒ Array<Hash>

Returns The list of TaskRouter TaskQueues.

Returns:

  • (Array<Hash>) —

    The list of TaskRouter TaskQueues.



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

def taskrouter_taskqueues
    @properties['taskrouter_taskqueues']
end

#taskrouter_worker_attributes ⇒ Hash

Returns The TaskRouter Worker attributes.

Returns:

  • (Hash) —

    The TaskRouter Worker attributes.



403
404
405
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 403

def taskrouter_worker_attributes
    @properties['taskrouter_worker_attributes']
end

#taskrouter_worker_channels ⇒ Hash

Returns The TaskRouter default channel capacities and availability for workers.

Returns:

  • (Hash) —

    The TaskRouter default channel capacities and availability for workers.



397
398
399
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 397

def taskrouter_worker_channels
    @properties['taskrouter_worker_channels']
end

#taskrouter_workspace_sid ⇒ String

Returns The SID of the TaskRouter Workspace.

Returns:

  • (String) —

    The SID of the TaskRouter Workspace.



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

def taskrouter_workspace_sid
    @properties['taskrouter_workspace_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



656
657
658
659
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 656

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

#ui_attributes ⇒ Hash

Returns The object that describes Flex UI characteristics and settings.

Returns:

  • (Hash) —

    The object that describes Flex UI characteristics and settings.



451
452
453
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 451

def ui_attributes
    @properties['ui_attributes']
end

#ui_dependencies ⇒ Hash

Returns The object that defines the NPM packages and versions to be used in Hosted Flex.

Returns:

  • (Hash) —

    The object that defines the NPM packages and versions to be used in Hosted Flex.



457
458
459
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 457

def ui_dependencies
    @properties['ui_dependencies']
end

#ui_language ⇒ String

Returns The primary language of the Flex UI.

Returns:

  • (String) —

    The primary language of the Flex UI.



445
446
447
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 445

def ui_language
    @properties['ui_language']
end

#ui_version ⇒ String

Returns The Pinned UI version.

Returns:

  • (String) —

    The Pinned UI version.



463
464
465
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 463

def ui_version
    @properties['ui_version']
end

#update(body: :unset) ⇒ ConfigurationInstance

Update the ConfigurationInstance

Parameters:

  • body (Object) (defaults to: :unset)

Returns:



646
647
648
649
650
651
652
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 646

def update(body: :unset
)

    context.update(
        body: body, 
    )
end

#url ⇒ String

Returns The absolute URL of the Configuration resource.

Returns:

  • (String) —

    The absolute URL of the Configuration resource.



571
572
573
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 571

def url
    @properties['url']
end