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



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
184
185
186
187
 
# File 'lib/twilio-ruby/rest/flex_api/v1/configuration.rb', line 142

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'],
      'ui_language' => payload['ui_language'],
      'ui_attributes' => payload['ui_attributes'],
      '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'],
      'features_enabled' => payload['features_enabled'],
      'serverless_service_sids' => payload['serverless_service_sids'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account responsible for this configuration.

Returns:

  • (String) —

    The unique id of the Account responsible for this configuration



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

def 
  @properties['account_sid']
end

#attributes ⇒ Hash

Returns Attiributes.

Returns:

  • (Hash) —

    Attiributes



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

def attributes
  @properties['attributes']
end

#call_recording_enabled ⇒ Boolean

Returns Call recording enabled.

Returns:

  • (Boolean) —

    Call recording enabled



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

def call_recording_enabled
  @properties['call_recording_enabled']
end

#call_recording_webhook_url ⇒ String

Returns Call recording webhook url.

Returns:

  • (String) —

    Call recording webhook url



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

def call_recording_webhook_url
  @properties['call_recording_webhook_url']
end

#chat_service_instance_sid ⇒ String

Returns The unique id of the Chat Service this user belongs to.

Returns:

  • (String) —

    The unique id of the Chat Service this user belongs to



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

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:



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

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

#create ⇒ ConfigurationInstance

Retrieve a single page of ConfigurationInstance records from the API. Request is executed immediately.

Returns:



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

def create
  context.create
end

#crm_attributes ⇒ Hash

Returns CRM Attributes.

Returns:

  • (Hash) —

    CRM Attributes



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

def crm_attributes
  @properties['crm_attributes']
end

#crm_callback_url ⇒ String

Returns CRM Callback URL.

Returns:

  • (String) —

    CRM Callback URL



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

def crm_callback_url
  @properties['crm_callback_url']
end

#crm_enabled ⇒ Boolean

Returns Flag indicating whether CRM is present for Flex.

Returns:

  • (Boolean) —

    Flag indicating whether CRM is present for Flex



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

def crm_enabled
  @properties['crm_enabled']
end

#crm_fallback_url ⇒ String

Returns CRM Fallback URL.

Returns:

  • (String) —

    CRM Fallback URL



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

def crm_fallback_url
  @properties['crm_fallback_url']
end

#crm_type ⇒ String

Returns CRM Type.

Returns:

  • (String) —

    CRM Type



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

def crm_type
  @properties['crm_type']
end

#date_created ⇒ Time

Returns The time the Configuration was created, given as GMT in ISO 8601 format.

Returns:

  • (Time) —

    The time the Configuration was created, given as GMT in ISO 8601 format



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The time the Configuration was last updated, given as GMT in ISO 8601 format.

Returns:

  • (Time) —

    The time the Configuration was last updated, given as GMT in ISO 8601 format



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

def date_updated
  @properties['date_updated']
end

#features_enabled ⇒ String

Returns List of enabled features.

Returns:

  • (String) —

    List of enabled features



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

def features_enabled
  @properties['features_enabled']
end

#fetch(ui_version: :unset) ⇒ ConfigurationInstance

Fetch a ConfigurationInstance

Parameters:

  • ui_version (String) (defaults to: :unset) —

    Pinned UI version

Returns:



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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#integrations ⇒ Hash

Returns Integration parameters.

Returns:

  • (Hash) —

    Integration parameters



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

def integrations
  @properties['integrations']
end

#messaging_service_instance_sid ⇒ String

Returns Unique 34 character ID of the Messaging Service.

Returns:

  • (String) —

    Unique 34 character ID of the Messaging Service



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

def messaging_service_instance_sid
  @properties['messaging_service_instance_sid']
end

#outbound_call_flows ⇒ Hash

Returns Outbound call flows Attributes.

Returns:

  • (Hash) —

    Outbound call flows Attributes



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

def outbound_call_flows
  @properties['outbound_call_flows']
end

#plugin_service_attributes ⇒ Hash

Returns Plugin service Attributes.

Returns:

  • (Hash) —

    Plugin service Attributes



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

def plugin_service_attributes
  @properties['plugin_service_attributes']
end

#plugin_service_enabled ⇒ Boolean

Returns Is plugin service Enabled.

Returns:

  • (Boolean) —

    Is plugin service Enabled



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

def plugin_service_enabled
  @properties['plugin_service_enabled']
end

#public_attributes ⇒ Hash

Returns Public Attributes.

Returns:

  • (Hash) —

    Public Attributes



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

def public_attributes
  @properties['public_attributes']
end

#runtime_domain ⇒ String

Returns Flex resources hosting URL for the main UI.

Returns:

  • (String) —

    Flex resources hosting URL for the main UI



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

def runtime_domain
  @properties['runtime_domain']
end

#serverless_service_sids ⇒ String

Returns List of serverless services sids.

Returns:

  • (String) —

    List of serverless services 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 Flex Service version.

Returns:

  • (String) —

    Flex Service version



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

def service_version
  @properties['service_version']
end

#status ⇒ configuration.Status

Returns Status of the Flex onboarding.

Returns:



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

def status
  @properties['status']
end

#taskrouter_offline_activity_sid ⇒ String

Returns The unique ID of the offline activity.

Returns:

  • (String) —

    The unique ID of the offline activity



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

def taskrouter_offline_activity_sid
  @properties['taskrouter_offline_activity_sid']
end

#taskrouter_skills ⇒ Hash

Returns Skill description for TaskRouter workers.

Returns:

  • (Hash) —

    Skill description for TaskRouter workers



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

def taskrouter_skills
  @properties['taskrouter_skills']
end

#taskrouter_target_taskqueue_sid ⇒ String

Returns The unique ID of the TaskRouter Target TaskQueue.

Returns:

  • (String) —

    The unique ID of the TaskRouter Target TaskQueue



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

def taskrouter_target_taskqueue_sid
  @properties['taskrouter_target_taskqueue_sid']
end

#taskrouter_target_workflow_sid ⇒ String

Returns The unique ID of the TaskRouter Target Workflow.

Returns:

  • (String) —

    The unique ID of the TaskRouter Target Workflow



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

def taskrouter_target_workflow_sid
  @properties['taskrouter_target_workflow_sid']
end

#taskrouter_taskqueues ⇒ Hash

Returns Array of TaskRouter TaskQueues.

Returns:

  • (Hash) —

    Array of TaskRouter TaskQueues



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

def taskrouter_taskqueues
  @properties['taskrouter_taskqueues']
end

#taskrouter_worker_attributes ⇒ Hash

Returns The taskrouter_worker_attributes.

Returns:

  • (Hash) —

    The taskrouter_worker_attributes



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

def taskrouter_worker_attributes
  @properties['taskrouter_worker_attributes']
end

#taskrouter_worker_channels ⇒ Hash

Returns TaskRouter default channel capacities and availability for workers.

Returns:

  • (Hash) —

    TaskRouter default channel capacities and availability for workers



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

def taskrouter_worker_channels
  @properties['taskrouter_worker_channels']
end

#taskrouter_workspace_sid ⇒ String

Returns The unique ID of the TaskRouter Workspace.

Returns:

  • (String) —

    The unique ID of the TaskRouter Workspace



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

def taskrouter_workspace_sid
  @properties['taskrouter_workspace_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#ui_attributes ⇒ Hash

Returns UI Attributes.

Returns:

  • (Hash) —

    UI Attributes



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

def ui_attributes
  @properties['ui_attributes']
end

#ui_language ⇒ String

Returns Main language of the Flex UI.

Returns:

  • (String) —

    Main 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 Pinned UI version.

Returns:

  • (String) —

    Pinned UI version



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

def ui_version
  @properties['ui_version']
end

#update ⇒ ConfigurationInstance

Update the ConfigurationInstance

Returns:



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

def update
  context.update
end

#url ⇒ String

Returns The URL for this resource.

Returns:

  • (String) —

    The URL for this resource



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

def url
  @properties['url']
end