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



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

def 
  @properties['account_sid']
end

#attributes ⇒ Hash

Returns Attiributes.

Returns:

  • (Hash) —

    Attiributes



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

def attributes
  @properties['attributes']
end

#call_recording_enabled ⇒ Boolean

Returns Call recording enabled.

Returns:

  • (Boolean) —

    Call recording enabled



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

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



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

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



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

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:



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

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:



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

def create
  context.create
end

#crm_attributes ⇒ Hash

Returns CRM Attributes.

Returns:

  • (Hash) —

    CRM Attributes



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

def crm_attributes
  @properties['crm_attributes']
end

#crm_callback_url ⇒ String

Returns CRM Callback URL.

Returns:

  • (String) —

    CRM Callback URL



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

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



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

def crm_enabled
  @properties['crm_enabled']
end

#crm_fallback_url ⇒ String

Returns CRM Fallback URL.

Returns:

  • (String) —

    CRM Fallback URL



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

def crm_fallback_url
  @properties['crm_fallback_url']
end

#crm_type ⇒ String

Returns CRM Type.

Returns:

  • (String) —

    CRM Type



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#fetch(ui_version: :unset) ⇒ ConfigurationInstance

Fetch a ConfigurationInstance

Parameters:

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

    Pinned UI version

Returns:



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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

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



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

def messaging_service_instance_sid
  @properties['messaging_service_instance_sid']
end

#plugin_service_attributes ⇒ Hash

Returns Plugin service Attributes.

Returns:

  • (Hash) —

    Plugin service Attributes



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

def plugin_service_attributes
  @properties['plugin_service_attributes']
end

#plugin_service_enabled ⇒ Boolean

Returns Is plugin service Enabled.

Returns:

  • (Boolean) —

    Is plugin service Enabled



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

def plugin_service_enabled
  @properties['plugin_service_enabled']
end

#public_attributes ⇒ Hash

Returns Public Attributes.

Returns:

  • (Hash) —

    Public Attributes



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

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



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

def runtime_domain
  @properties['runtime_domain']
end

#service_version ⇒ String

Returns Flex Service version.

Returns:

  • (String) —

    Flex Service version



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

def service_version
  @properties['service_version']
end

#status ⇒ configuration.Status

Returns Status of the Flex onboarding.

Returns:



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

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



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

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



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

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



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

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



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

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



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

def taskrouter_taskqueues
  @properties['taskrouter_taskqueues']
end

#taskrouter_worker_attributes ⇒ Hash

Returns The taskrouter_worker_attributes.

Returns:

  • (Hash) —

    The taskrouter_worker_attributes



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

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



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

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



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

def taskrouter_workspace_sid
  @properties['taskrouter_workspace_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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



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

Returns:

  • (String) —

    Pinned UI version



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

def ui_version
  @properties['ui_version']
end

#update ⇒ ConfigurationInstance

Update the ConfigurationInstance

Returns:



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

def update
  context.update
end

#url ⇒ String

Returns The URL for this resource.

Returns:

  • (String) —

    The URL for this resource



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

def url
  @properties['url']
end