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
 
# 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'],
      'url' => payload['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



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

def 
  @properties['account_sid']
end

#attributes ⇒ Hash

Returns An object that contains application-specific data.

Returns:

  • (Hash) —

    An object that contains application-specific data



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

def attributes
  @properties['attributes']
end

#call_recording_enabled ⇒ Boolean

Returns Whether call recording is enabled.

Returns:

  • (Boolean) —

    Whether call recording is enabled



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

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



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

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



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

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:



179
180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 179

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

#create ⇒ ConfigurationInstance

Create the ConfigurationInstance

Returns:



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

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



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

def crm_attributes
  @properties['crm_attributes']
end

#crm_callback_url ⇒ String

Returns The CRM Callback URL.

Returns:

  • (String) —

    The CRM Callback URL



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

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



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

def crm_enabled
  @properties['crm_enabled']
end

#crm_fallback_url ⇒ String

Returns The CRM Fallback URL.

Returns:

  • (String) —

    The CRM Fallback URL



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

def crm_fallback_url
  @properties['crm_fallback_url']
end

#crm_type ⇒ String

Returns The CRM Type.

Returns:

  • (String) —

    The CRM Type



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

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



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

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



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

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:



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

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

#flex_service_instance_sid ⇒ String

Returns The SID of the Flex service instance.

Returns:

  • (String) —

    The SID of the Flex service instance



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

def flex_service_instance_sid
  @properties['flex_service_instance_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.FlexApi.V1.ConfigurationInstance #{values}>"
end

#integrations ⇒ Hash

Returns A list of objects that contain the configurations for the Integrations supported in this configuration.

Returns:

  • (Hash) —

    A list of objects that contain the configurations for the Integrations supported in this configuration



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

def integrations
  @properties['integrations']
end

#messaging_service_instance_sid ⇒ String

Returns The SID of the Messaging service instance.

Returns:

  • (String) —

    The SID of the Messaging service instance



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

def messaging_service_instance_sid
  @properties['messaging_service_instance_sid']
end

#outbound_call_flows ⇒ Hash

Returns The list of outbound call flows.

Returns:

  • (Hash) —

    The list of outbound call flows



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

def outbound_call_flows
  @properties['outbound_call_flows']
end

#plugin_service_attributes ⇒ Hash

Returns The plugin service attributes.

Returns:

  • (Hash) —

    The plugin service attributes



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

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



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

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



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

def public_attributes
  @properties['public_attributes']
end

#queue_stats_configuration ⇒ Hash

Returns Configurable parameters for Queues Statistics.

Returns:

  • (Hash) —

    Configurable parameters for Queues Statistics



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

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



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

def runtime_domain
  @properties['runtime_domain']
end

#serverless_service_sids ⇒ String

Returns The list of serverless service SIDs.

Returns:

  • (String) —

    The list of serverless service SIDs



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

def serverless_service_sids
  @properties['serverless_service_sids']
end

#service_version ⇒ String

Returns The Flex Service version.

Returns:

  • (String) —

    The Flex Service version



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

def service_version
  @properties['service_version']
end

#status ⇒ configuration.Status

Returns The status of the Flex onboarding.

Returns:



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

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



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

def taskrouter_offline_activity_sid
  @properties['taskrouter_offline_activity_sid']
end

#taskrouter_skills ⇒ Hash

Returns The Skill description for TaskRouter workers.

Returns:

  • (Hash) —

    The Skill description for TaskRouter workers



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

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



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

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



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

def taskrouter_target_workflow_sid
  @properties['taskrouter_target_workflow_sid']
end

#taskrouter_taskqueues ⇒ Hash

Returns The list of TaskRouter TaskQueues.

Returns:

  • (Hash) —

    The list of TaskRouter TaskQueues



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

def taskrouter_taskqueues
  @properties['taskrouter_taskqueues']
end

#taskrouter_worker_attributes ⇒ Hash

Returns The TaskRouter Worker attributes.

Returns:

  • (Hash) —

    The TaskRouter Worker attributes



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

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



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

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



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

def taskrouter_workspace_sid
  @properties['taskrouter_workspace_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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



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

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



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

def ui_language
  @properties['ui_language']
end

#ui_version ⇒ String

Returns The Pinned UI version.

Returns:

  • (String) —

    The Pinned UI version



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

def ui_version
  @properties['ui_version']
end

#update ⇒ ConfigurationInstance

Update the ConfigurationInstance

Returns:



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

def update
  context.update
end

#url ⇒ String

Returns The absolute URL of the Configuration resource.

Returns:

  • (String) —

    The absolute URL of the Configuration resource



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

def url
  @properties['url']
end