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.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
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
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 128

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'],
        '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'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Configuration resource.

Returns:



198
199
200
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 198

def 
    @properties['account_sid']
end

#attributes ⇒ Hash

Returns An object that contains application-specific data.

Returns:

  • (Hash) —

    An object that contains application-specific data.



216
217
218
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 216

def attributes
    @properties['attributes']
end

#call_recording_enabled ⇒ Boolean

Returns Whether call recording is enabled.

Returns:

  • (Boolean) —

    Whether call recording is enabled.



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

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.



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

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.



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

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.



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

def chat_service_instance_sid
    @properties['chat_service_instance_sid']
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:



189
190
191
192
193
194
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 189

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.



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

def crm_attributes
    @properties['crm_attributes']
end

#crm_callback_url ⇒ String

Returns The CRM Callback URL.

Returns:

  • (String) —

    The CRM Callback URL.



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

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.



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

def crm_enabled
    @properties['crm_enabled']
end

#crm_fallback_url ⇒ String

Returns The CRM Fallback URL.

Returns:

  • (String) —

    The CRM Fallback URL.



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

def crm_fallback_url
    @properties['crm_fallback_url']
end

#crm_type ⇒ String

Returns The CRM type.

Returns:

  • (String) —

    The CRM type.



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

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](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



204
205
206
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 204

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](en.wikipedia.org/wiki/ISO_8601) format.

Returns:

  • (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.



210
211
212
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 210

def date_updated
    @properties['date_updated']
end

#debugger_integration ⇒ Hash

Returns Configurable parameters for Debugger Integration.

Returns:

  • (Hash) —

    Configurable parameters for Debugger Integration.



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

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:



470
471
472
473
474
475
476
477
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 470

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



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

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.



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

def flex_insights_hr
    @properties['flex_insights_hr']
end

#flex_service_instance_sid ⇒ String

Returns The SID of the Flex service instance.

Returns:

  • (String) —

    The SID of the Flex service instance.



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

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.



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

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.



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

def flex_url
    @properties['flex_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

def integrations
    @properties['integrations']
end

#markdown ⇒ Hash

Returns Configurable parameters for Markdown.

Returns:

  • (Hash) —

    Configurable parameters for Markdown.



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

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.



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

def messaging_service_instance_sid
    @properties['messaging_service_instance_sid']
end

#notifications ⇒ Hash

Returns Configurable parameters for Notifications.

Returns:

  • (Hash) —

    Configurable parameters for Notifications.



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

def notifications
    @properties['notifications']
end

#outbound_call_flows ⇒ Hash

Returns The list of outbound call flows.

Returns:

  • (Hash) —

    The list of outbound call flows.



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

def outbound_call_flows
    @properties['outbound_call_flows']
end

#plugin_service_attributes ⇒ Hash

Returns The plugin service attributes.

Returns:

  • (Hash) —

    The plugin service attributes.



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

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.



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

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.



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

def public_attributes
    @properties['public_attributes']
end

#queue_stats_configuration ⇒ Hash

Returns Configurable parameters for Queues Statistics.

Returns:

  • (Hash) —

    Configurable parameters for Queues Statistics.



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

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.



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

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.



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

def serverless_service_sids
    @properties['serverless_service_sids']
end

#service_version ⇒ String

Returns The Flex Service version.

Returns:

  • (String) —

    The Flex Service version.



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

def service_version
    @properties['service_version']
end

#status ⇒ Status

Returns:

  • (Status) 


222
223
224
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 222

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.



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

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.



252
253
254
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 252

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.



240
241
242
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 240

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.



234
235
236
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 234

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.



246
247
248
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 246

def taskrouter_taskqueues
    @properties['taskrouter_taskqueues']
end

#taskrouter_worker_attributes ⇒ Hash

Returns The TaskRouter Worker attributes.

Returns:

  • (Hash) —

    The TaskRouter Worker attributes.



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

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.



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

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.



228
229
230
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 228

def taskrouter_workspace_sid
    @properties['taskrouter_workspace_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

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.



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

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.



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

def ui_language
    @properties['ui_language']
end

#ui_version ⇒ String

Returns The Pinned UI version.

Returns:

  • (String) —

    The Pinned UI version.



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

def ui_version
    @properties['ui_version']
end

#url ⇒ String

Returns The absolute URL of the Configuration resource.

Returns:

  • (String) —

    The absolute URL of the Configuration resource.



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

def url
    @properties['url']
end