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



126
127
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
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 126

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 that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#attributes ⇒ Hash

Returns An object that contains application-specific data.

Returns:

  • (Hash) —

    An object that contains application-specific data



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

def attributes
  @properties['attributes']
end

#call_recording_enabled ⇒ Boolean

Returns Whether call recording is enabled.

Returns:

  • (Boolean) —

    Whether call recording is enabled



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

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



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

def call_recording_webhook_url
  @properties['call_recording_webhook_url']
end

#channel_configs ⇒ Array[Hash]

Returns Flex Conversations channels’ attachments configurations.

Returns:

  • (Array[Hash]) —

    Flex Conversations channels’ attachments configurations



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

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



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

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:



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

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

#create ⇒ ConfigurationInstance

Create the ConfigurationInstance

Returns:



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

def create
  context.create
end

#crm_attributes ⇒ Hash

Returns An object that contains the CRM attributes.

Returns:

  • (Hash) —

    An object that contains the CRM attributes



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

def crm_attributes
  @properties['crm_attributes']
end

#crm_callback_url ⇒ String

Returns The CRM Callback URL.

Returns:

  • (String) —

    The CRM Callback URL



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

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



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

def crm_enabled
  @properties['crm_enabled']
end

#crm_fallback_url ⇒ String

Returns The CRM Fallback URL.

Returns:

  • (String) —

    The CRM Fallback URL



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

def crm_fallback_url
  @properties['crm_fallback_url']
end

#crm_type ⇒ String

Returns The CRM Type.

Returns:

  • (String) —

    The CRM Type



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

def crm_type
  @properties['crm_type']
end

#date_created ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_updated
  @properties['date_updated']
end

#debugger_integration ⇒ Hash

Returns Configurable parameters for Debugger Integration.

Returns:

  • (Hash) —

    Configurable parameters for Debugger Integration



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

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:



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

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

#flex_insights_drilldown ⇒ Boolean

Returns Setting to enable Flex UI redirection.

Returns:

  • (Boolean) —

    Setting to enable Flex UI redirection



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

def flex_insights_drilldown
  @properties['flex_insights_drilldown']
end

#flex_insights_hr ⇒ Hash

Returns Object that controls workspace reporting.

Returns:

  • (Hash) —

    Object that controls workspace reporting



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

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



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

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



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

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.



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

def flex_url
  @properties['flex_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



496
497
498
499
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 496

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



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

def integrations
  @properties['integrations']
end

#markdown ⇒ Hash

Returns Configurable parameters for Markdown.

Returns:

  • (Hash) —

    Configurable parameters for Markdown



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

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



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

def messaging_service_instance_sid
  @properties['messaging_service_instance_sid']
end

#notifications ⇒ Hash

Returns Configurable parameters for Notifications.

Returns:

  • (Hash) —

    Configurable parameters for Notifications



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

def notifications
  @properties['notifications']
end

#outbound_call_flows ⇒ Hash

Returns The list of outbound call flows.

Returns:

  • (Hash) —

    The list of outbound call flows



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

def outbound_call_flows
  @properties['outbound_call_flows']
end

#plugin_service_attributes ⇒ Hash

Returns The plugin service attributes.

Returns:

  • (Hash) —

    The plugin service attributes



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

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



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

def plugin_service_enabled
  @properties['plugin_service_enabled']
end

#public_attributes ⇒ Hash

Returns The list of public attributes.

Returns:

  • (Hash) —

    The list of public attributes



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

def public_attributes
  @properties['public_attributes']
end

#queue_stats_configuration ⇒ Hash

Returns Configurable parameters for Queues Statistics.

Returns:

  • (Hash) —

    Configurable parameters for Queues Statistics



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

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



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

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



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

def serverless_service_sids
  @properties['serverless_service_sids']
end

#service_version ⇒ String

Returns The Flex Service version.

Returns:

  • (String) —

    The Flex Service version



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

def service_version
  @properties['service_version']
end

#status ⇒ configuration.Status

Returns The status of the Flex onboarding.

Returns:



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

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



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

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



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

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



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

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



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

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



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

def taskrouter_taskqueues
  @properties['taskrouter_taskqueues']
end

#taskrouter_worker_attributes ⇒ Hash

Returns The TaskRouter Worker attributes.

Returns:

  • (Hash) —

    The TaskRouter Worker attributes



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

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



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

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



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

def taskrouter_workspace_sid
  @properties['taskrouter_workspace_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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



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

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



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

def ui_language
  @properties['ui_language']
end

#ui_version ⇒ String

Returns The Pinned UI version.

Returns:

  • (String) —

    The Pinned UI version



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

def ui_version
  @properties['ui_version']
end

#update ⇒ ConfigurationInstance

Update the ConfigurationInstance

Returns:



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

def update
  context.update
end

#url ⇒ String

Returns The absolute URL of the Configuration resource.

Returns:

  • (String) —

    The absolute URL of the Configuration resource



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

def url
  @properties['url']
end