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
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 155 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
229 230 231 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 229 def account_sid @properties['account_sid'] end |
#agent_conv_end_methods ⇒ Hash
505 506 507 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 505 def agent_conv_end_methods @properties['agent_conv_end_methods'] end |
#attributes ⇒ Hash
247 248 249 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 247 def attributes @properties['attributes'] end |
#call_recording_enabled ⇒ Boolean
367 368 369 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 367 def call_recording_enabled @properties['call_recording_enabled'] end |
#call_recording_webhook_url ⇒ String
373 374 375 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 373 def call_recording_webhook_url @properties['call_recording_webhook_url'] end |
#channel_configs ⇒ Array<Hash>
487 488 489 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 487 def channel_configs @properties['channel_configs'] end |
#chat_service_instance_sid ⇒ String
319 320 321 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 319 def chat_service_instance_sid @properties['chat_service_instance_sid'] end |
#citrix_voice_vdi ⇒ Hash
511 512 513 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 511 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
220 221 222 223 224 225 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 220 def context unless @instance_context @instance_context = ConfigurationContext.new(@version ) end @instance_context end |
#crm_attributes ⇒ Hash
403 404 405 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 403 def crm_attributes @properties['crm_attributes'] end |
#crm_callback_url ⇒ String
391 392 393 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 391 def crm_callback_url @properties['crm_callback_url'] end |
#crm_enabled ⇒ Boolean
379 380 381 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 379 def crm_enabled @properties['crm_enabled'] end |
#crm_fallback_url ⇒ String
397 398 399 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 397 def crm_fallback_url @properties['crm_fallback_url'] end |
#crm_type ⇒ String
385 386 387 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 385 def crm_type @properties['crm_type'] end |
#date_created ⇒ Time
235 236 237 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 235 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
241 242 243 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 241 def date_updated @properties['date_updated'] end |
#debugger_integration ⇒ Hash
493 494 495 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 493 def debugger_integration @properties['debugger_integration'] end |
#fetch(ui_version: :unset) ⇒ ConfigurationInstance
Fetch the ConfigurationInstance
525 526 527 528 529 530 531 532 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 525 def fetch( ui_version: :unset ) context.fetch( ui_version: ui_version, ) end |
#flex_insights_drilldown ⇒ Boolean
475 476 477 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 475 def flex_insights_drilldown @properties['flex_insights_drilldown'] end |
#flex_insights_hr ⇒ Hash
469 470 471 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 469 def flex_insights_hr @properties['flex_insights_hr'] end |
#flex_instance_sid ⇒ String
331 332 333 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 331 def flex_instance_sid @properties['flex_instance_sid'] end |
#flex_service_instance_sid ⇒ String
325 326 327 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 325 def flex_service_instance_sid @properties['flex_service_instance_sid'] end |
#flex_ui_status_report ⇒ Hash
499 500 501 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 499 def flex_ui_status_report @properties['flex_ui_status_report'] end |
#flex_url ⇒ String
481 482 483 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 481 def flex_url @properties['flex_url'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
554 555 556 557 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 554 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.FlexApi.V1.ConfigurationInstance #{values}>" end |
#integrations ⇒ Array<Hash>
427 428 429 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 427 def integrations @properties['integrations'] end |
#markdown ⇒ Hash
457 458 459 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 457 def markdown @properties['markdown'] end |
#messaging_service_instance_sid ⇒ String
313 314 315 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 313 def messaging_service_instance_sid @properties['messaging_service_instance_sid'] end |
#notifications ⇒ Hash
451 452 453 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 451 def notifications @properties['notifications'] end |
#offline_config ⇒ Hash
517 518 519 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 517 def offline_config @properties['offline_config'] end |
#outbound_call_flows ⇒ Hash
433 434 435 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 433 def outbound_call_flows @properties['outbound_call_flows'] end |
#plugin_service_attributes ⇒ Hash
421 422 423 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 421 def plugin_service_attributes @properties['plugin_service_attributes'] end |
#plugin_service_enabled ⇒ Boolean
415 416 417 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 415 def plugin_service_enabled @properties['plugin_service_enabled'] end |
#public_attributes ⇒ Hash
409 410 411 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 409 def public_attributes @properties['public_attributes'] end |
#queue_stats_configuration ⇒ Hash
445 446 447 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 445 def queue_stats_configuration @properties['queue_stats_configuration'] end |
#runtime_domain ⇒ String
307 308 309 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 307 def runtime_domain @properties['runtime_domain'] end |
#serverless_service_sids ⇒ Array<String>
439 440 441 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 439 def serverless_service_sids @properties['serverless_service_sids'] end |
#service_version ⇒ String
361 362 363 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 361 def service_version @properties['service_version'] end |
#status ⇒ Status
253 254 255 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 253 def status @properties['status'] end |
#taskrouter_offline_activity_sid ⇒ String
301 302 303 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 301 def taskrouter_offline_activity_sid @properties['taskrouter_offline_activity_sid'] end |
#taskrouter_skills ⇒ Array<Hash>
283 284 285 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 283 def taskrouter_skills @properties['taskrouter_skills'] end |
#taskrouter_target_taskqueue_sid ⇒ String
271 272 273 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 271 def taskrouter_target_taskqueue_sid @properties['taskrouter_target_taskqueue_sid'] end |
#taskrouter_target_workflow_sid ⇒ String
265 266 267 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 265 def taskrouter_target_workflow_sid @properties['taskrouter_target_workflow_sid'] end |
#taskrouter_taskqueues ⇒ Array<Hash>
277 278 279 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 277 def taskrouter_taskqueues @properties['taskrouter_taskqueues'] end |
#taskrouter_worker_attributes ⇒ Hash
295 296 297 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 295 def taskrouter_worker_attributes @properties['taskrouter_worker_attributes'] end |
#taskrouter_worker_channels ⇒ Hash
289 290 291 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 289 def taskrouter_worker_channels @properties['taskrouter_worker_channels'] end |
#taskrouter_workspace_sid ⇒ String
259 260 261 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 259 def taskrouter_workspace_sid @properties['taskrouter_workspace_sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
547 548 549 550 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 547 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.FlexApi.V1.ConfigurationInstance #{values}>" end |
#ui_attributes ⇒ Hash
343 344 345 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 343 def ui_attributes @properties['ui_attributes'] end |
#ui_dependencies ⇒ Hash
349 350 351 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 349 def ui_dependencies @properties['ui_dependencies'] end |
#ui_language ⇒ String
337 338 339 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 337 def ui_language @properties['ui_language'] end |
#ui_version ⇒ String
355 356 357 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 355 def ui_version @properties['ui_version'] end |
#update(body: :unset) ⇒ ConfigurationInstance
Update the ConfigurationInstance
538 539 540 541 542 543 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 538 def update(body: :unset ) context.update( ) end |
#url ⇒ String
463 464 465 |
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 463 def url @properties['url'] end |