Class: Twilio::REST::FlexApi::V1::ConfigurationInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::FlexApi::V1::ConfigurationInstance
- Defined in:
- lib/twilio-ruby/rest/flex_api/v1/configuration.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Configuration resource.
-
#agent_conv_end_methods ⇒ Hash
Agent conversation end methods.
-
#attributes ⇒ Hash
An object that contains application-specific data.
-
#call_recording_enabled ⇒ Boolean
Whether call recording is enabled.
-
#call_recording_webhook_url ⇒ String
The call recording webhook URL.
-
#channel_configs ⇒ Array<Hash>
Settings for different limits for Flex Conversations channels attachments.
-
#chat_service_instance_sid ⇒ String
The SID of the chat service this user belongs to.
-
#citrix_voice_vdi ⇒ Hash
Citrix voice vdi configuration and settings.
-
#context ⇒ ConfigurationContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#crm_attributes ⇒ Hash
An object that contains the CRM attributes.
-
#crm_callback_url ⇒ String
The CRM Callback URL.
-
#crm_enabled ⇒ Boolean
Whether CRM is present for Flex.
-
#crm_fallback_url ⇒ String
The CRM Fallback URL.
-
#crm_type ⇒ String
The CRM type.
-
#date_created ⇒ Time
The date and time in GMT when the Configuration resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the Configuration resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#debugger_integration ⇒ Hash
Configurable parameters for Debugger Integration.
-
#fetch(ui_version: :unset) ⇒ ConfigurationInstance
Fetch the ConfigurationInstance.
-
#flex_insights_drilldown ⇒ Boolean
Setting this to true will redirect Flex UI to the URL set in flex_url.
-
#flex_insights_hr ⇒ Hash
Object with enabled/disabled flag with list of workspaces.
-
#flex_instance_sid ⇒ String
The SID of the Flex instance.
-
#flex_service_instance_sid ⇒ String
The SID of the Flex service instance.
-
#flex_ui_status_report ⇒ Hash
Configurable parameters for Flex UI Status report.
-
#flex_url ⇒ String
URL to redirect to in case drilldown is enabled.
-
#initialize(version, payload) ⇒ ConfigurationInstance
constructor
Initialize the ConfigurationInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#integrations ⇒ Array<Hash>
A list of objects that contain the configurations for the Integrations supported in this configuration.
-
#markdown ⇒ Hash
Configurable parameters for Markdown.
-
#messaging_service_instance_sid ⇒ String
The SID of the Messaging service instance.
-
#notifications ⇒ Hash
Configurable parameters for Notifications.
-
#offline_config ⇒ Hash
Presence and presence ttl configuration.
-
#outbound_call_flows ⇒ Hash
The list of outbound call flows.
-
#plugin_service_attributes ⇒ Hash
The plugin service attributes.
-
#plugin_service_enabled ⇒ Boolean
Whether the plugin service enabled.
-
#public_attributes ⇒ Hash
The list of public attributes, which are visible to unauthenticated clients.
-
#queue_stats_configuration ⇒ Hash
Configurable parameters for Queues Statistics.
-
#runtime_domain ⇒ String
The URL where the Flex instance is hosted.
-
#serverless_service_sids ⇒ Array<String>
The list of serverless service SIDs.
-
#service_version ⇒ String
The Flex Service version.
- #status ⇒ Status
-
#taskrouter_offline_activity_sid ⇒ String
The TaskRouter SID of the offline activity.
-
#taskrouter_skills ⇒ Array<Hash>
The Skill description for TaskRouter workers.
-
#taskrouter_target_taskqueue_sid ⇒ String
The SID of the TaskRouter Target TaskQueue.
-
#taskrouter_target_workflow_sid ⇒ String
The SID of the TaskRouter target Workflow.
-
#taskrouter_taskqueues ⇒ Array<Hash>
The list of TaskRouter TaskQueues.
-
#taskrouter_worker_attributes ⇒ Hash
The TaskRouter Worker attributes.
-
#taskrouter_worker_channels ⇒ Hash
The TaskRouter default channel capacities and availability for workers.
-
#taskrouter_workspace_sid ⇒ String
The SID of the TaskRouter Workspace.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#ui_attributes ⇒ Hash
The object that describes Flex UI characteristics and settings.
-
#ui_dependencies ⇒ Hash
The object that defines the NPM packages and versions to be used in Hosted Flex.
-
#ui_language ⇒ String
The primary language of the Flex UI.
-
#ui_version ⇒ String
The Pinned UI version.
-
#update(body: :unset) ⇒ ConfigurationInstance
Update the ConfigurationInstance.
-
#url ⇒ String
The absolute URL of the Configuration resource.
Constructor Details
#initialize(version, payload) ⇒ ConfigurationInstance
Initialize the ConfigurationInstance
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 321 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
396 397 398 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 396 def account_sid @properties['account_sid'] end |
#agent_conv_end_methods ⇒ Hash
672 673 674 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 672 def agent_conv_end_methods @properties['agent_conv_end_methods'] end |
#attributes ⇒ Hash
414 415 416 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 414 def attributes @properties['attributes'] end |
#call_recording_enabled ⇒ Boolean
534 535 536 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 534 def call_recording_enabled @properties['call_recording_enabled'] end |
#call_recording_webhook_url ⇒ String
540 541 542 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 540 def call_recording_webhook_url @properties['call_recording_webhook_url'] end |
#channel_configs ⇒ Array<Hash>
654 655 656 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 654 def channel_configs @properties['channel_configs'] end |
#chat_service_instance_sid ⇒ String
486 487 488 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 486 def chat_service_instance_sid @properties['chat_service_instance_sid'] end |
#citrix_voice_vdi ⇒ Hash
678 679 680 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 678 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
387 388 389 390 391 392 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 387 def context unless @instance_context @instance_context = ConfigurationContext.new(@version ) end @instance_context end |
#crm_attributes ⇒ Hash
570 571 572 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 570 def crm_attributes @properties['crm_attributes'] end |
#crm_callback_url ⇒ String
558 559 560 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 558 def crm_callback_url @properties['crm_callback_url'] end |
#crm_enabled ⇒ Boolean
546 547 548 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 546 def crm_enabled @properties['crm_enabled'] end |
#crm_fallback_url ⇒ String
564 565 566 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 564 def crm_fallback_url @properties['crm_fallback_url'] end |
#crm_type ⇒ String
552 553 554 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 552 def crm_type @properties['crm_type'] end |
#date_created ⇒ Time
402 403 404 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 402 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
408 409 410 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 408 def date_updated @properties['date_updated'] end |
#debugger_integration ⇒ Hash
660 661 662 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 660 def debugger_integration @properties['debugger_integration'] end |
#fetch(ui_version: :unset) ⇒ ConfigurationInstance
Fetch the ConfigurationInstance
692 693 694 695 696 697 698 699 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 692 def fetch( ui_version: :unset ) context.fetch( ui_version: ui_version, ) end |
#flex_insights_drilldown ⇒ Boolean
642 643 644 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 642 def flex_insights_drilldown @properties['flex_insights_drilldown'] end |
#flex_insights_hr ⇒ Hash
636 637 638 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 636 def flex_insights_hr @properties['flex_insights_hr'] end |
#flex_instance_sid ⇒ String
498 499 500 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 498 def flex_instance_sid @properties['flex_instance_sid'] end |
#flex_service_instance_sid ⇒ String
492 493 494 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 492 def flex_service_instance_sid @properties['flex_service_instance_sid'] end |
#flex_ui_status_report ⇒ Hash
666 667 668 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 666 def flex_ui_status_report @properties['flex_ui_status_report'] end |
#flex_url ⇒ String
648 649 650 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 648 def flex_url @properties['flex_url'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
721 722 723 724 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 721 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.FlexApi.V1.ConfigurationInstance #{values}>" end |
#integrations ⇒ Array<Hash>
594 595 596 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 594 def integrations @properties['integrations'] end |
#markdown ⇒ Hash
624 625 626 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 624 def markdown @properties['markdown'] end |
#messaging_service_instance_sid ⇒ String
480 481 482 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 480 def messaging_service_instance_sid @properties['messaging_service_instance_sid'] end |
#notifications ⇒ Hash
618 619 620 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 618 def notifications @properties['notifications'] end |
#offline_config ⇒ Hash
684 685 686 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 684 def offline_config @properties['offline_config'] end |
#outbound_call_flows ⇒ Hash
600 601 602 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 600 def outbound_call_flows @properties['outbound_call_flows'] end |
#plugin_service_attributes ⇒ Hash
588 589 590 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 588 def plugin_service_attributes @properties['plugin_service_attributes'] end |
#plugin_service_enabled ⇒ Boolean
582 583 584 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 582 def plugin_service_enabled @properties['plugin_service_enabled'] end |
#public_attributes ⇒ Hash
576 577 578 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 576 def public_attributes @properties['public_attributes'] end |
#queue_stats_configuration ⇒ Hash
612 613 614 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 612 def queue_stats_configuration @properties['queue_stats_configuration'] end |
#runtime_domain ⇒ String
474 475 476 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 474 def runtime_domain @properties['runtime_domain'] end |
#serverless_service_sids ⇒ Array<String>
606 607 608 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 606 def serverless_service_sids @properties['serverless_service_sids'] end |
#service_version ⇒ String
528 529 530 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 528 def service_version @properties['service_version'] end |
#status ⇒ Status
420 421 422 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 420 def status @properties['status'] end |
#taskrouter_offline_activity_sid ⇒ String
468 469 470 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 468 def taskrouter_offline_activity_sid @properties['taskrouter_offline_activity_sid'] end |
#taskrouter_skills ⇒ Array<Hash>
450 451 452 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 450 def taskrouter_skills @properties['taskrouter_skills'] end |
#taskrouter_target_taskqueue_sid ⇒ String
438 439 440 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 438 def taskrouter_target_taskqueue_sid @properties['taskrouter_target_taskqueue_sid'] end |
#taskrouter_target_workflow_sid ⇒ String
432 433 434 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 432 def taskrouter_target_workflow_sid @properties['taskrouter_target_workflow_sid'] end |
#taskrouter_taskqueues ⇒ Array<Hash>
444 445 446 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 444 def taskrouter_taskqueues @properties['taskrouter_taskqueues'] end |
#taskrouter_worker_attributes ⇒ Hash
462 463 464 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 462 def taskrouter_worker_attributes @properties['taskrouter_worker_attributes'] end |
#taskrouter_worker_channels ⇒ Hash
456 457 458 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 456 def taskrouter_worker_channels @properties['taskrouter_worker_channels'] end |
#taskrouter_workspace_sid ⇒ String
426 427 428 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 426 def taskrouter_workspace_sid @properties['taskrouter_workspace_sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
714 715 716 717 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 714 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.FlexApi.V1.ConfigurationInstance #{values}>" end |
#ui_attributes ⇒ Hash
510 511 512 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 510 def ui_attributes @properties['ui_attributes'] end |
#ui_dependencies ⇒ Hash
516 517 518 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 516 def ui_dependencies @properties['ui_dependencies'] end |
#ui_language ⇒ String
504 505 506 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 504 def ui_language @properties['ui_language'] end |
#ui_version ⇒ String
522 523 524 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 522 def ui_version @properties['ui_version'] end |
#update(body: :unset) ⇒ ConfigurationInstance
Update the ConfigurationInstance
705 706 707 708 709 710 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 705 def update(body: :unset ) context.update( ) end |
#url ⇒ String
630 631 632 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 630 def url @properties['url'] end |