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

  # 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



193
194
195
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 193

def 
  @properties['account_sid']
end

#attributes ⇒ Hash

Returns An object that contains application-specific data.

Returns:

  • (Hash) —

    An object that contains application-specific data



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

def attributes
  @properties['attributes']
end

#call_recording_enabled ⇒ Boolean

Returns Whether call recording is enabled.

Returns:

  • (Boolean) —

    Whether call recording is enabled



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

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



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

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



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

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:



184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 184

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

#create ⇒ ConfigurationInstance

Create the ConfigurationInstance

Returns:



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

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



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

def crm_attributes
  @properties['crm_attributes']
end

#crm_callback_url ⇒ String

Returns The CRM Callback URL.

Returns:

  • (String) —

    The CRM Callback URL



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

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



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

def crm_enabled
  @properties['crm_enabled']
end

#crm_fallback_url ⇒ String

Returns The CRM Fallback URL.

Returns:

  • (String) —

    The CRM Fallback URL



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

def crm_fallback_url
  @properties['crm_fallback_url']
end

#crm_type ⇒ String

Returns The CRM Type.

Returns:

  • (String) —

    The CRM Type



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

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



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

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



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

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



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

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



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

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



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

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



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

def flex_service_instance_sid
  @properties['flex_service_instance_sid']
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.



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

def flex_url
  @properties['flex_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

def integrations
  @properties['integrations']
end

#markdown ⇒ Hash

Returns Configurable parameters for Markdown.

Returns:

  • (Hash) —

    Configurable parameters for Markdown



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

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



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

def messaging_service_instance_sid
  @properties['messaging_service_instance_sid']
end

#notifications ⇒ Hash

Returns Configurable parameters for Notifications.

Returns:

  • (Hash) —

    Configurable parameters for Notifications



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

def notifications
  @properties['notifications']
end

#outbound_call_flows ⇒ Hash

Returns The list of outbound call flows.

Returns:

  • (Hash) —

    The list of outbound call flows



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

def outbound_call_flows
  @properties['outbound_call_flows']
end

#plugin_service_attributes ⇒ Hash

Returns The plugin service attributes.

Returns:

  • (Hash) —

    The plugin service attributes



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

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



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

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



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

def public_attributes
  @properties['public_attributes']
end

#queue_stats_configuration ⇒ Hash

Returns Configurable parameters for Queues Statistics.

Returns:

  • (Hash) —

    Configurable parameters for Queues Statistics



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

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



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

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



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

def serverless_service_sids
  @properties['serverless_service_sids']
end

#service_version ⇒ String

Returns The Flex Service version.

Returns:

  • (String) —

    The Flex Service version



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

def service_version
  @properties['service_version']
end

#status ⇒ configuration.Status

Returns The status of the Flex onboarding.

Returns:



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

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



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

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



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

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



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

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



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

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



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

def taskrouter_taskqueues
  @properties['taskrouter_taskqueues']
end

#taskrouter_worker_attributes ⇒ Hash

Returns The TaskRouter Worker attributes.

Returns:

  • (Hash) —

    The TaskRouter Worker attributes



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

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



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

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



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

def taskrouter_workspace_sid
  @properties['taskrouter_workspace_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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



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

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



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

def ui_language
  @properties['ui_language']
end

#ui_version ⇒ String

Returns The Pinned UI version.

Returns:

  • (String) —

    The Pinned UI version



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

def ui_version
  @properties['ui_version']
end

#update ⇒ ConfigurationInstance

Update the ConfigurationInstance

Returns:



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

def update
  context.update
end

#url ⇒ String

Returns The absolute URL of the Configuration resource.

Returns:

  • (String) —

    The absolute URL of the Configuration resource



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

def url
  @properties['url']
end