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



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

def 
  @properties['account_sid']
end

#attributes ⇒ Hash

Returns Attiributes.

Returns:

  • (Hash) —

    Attiributes



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

def attributes
  @properties['attributes']
end

#call_recording_enabled ⇒ Boolean

Returns Call recording enabled.

Returns:

  • (Boolean) —

    Call recording enabled



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

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



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

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



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

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:



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

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:



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

def create
  context.create
end

#crm_attributes ⇒ Hash

Returns CRM Attributes.

Returns:

  • (Hash) —

    CRM Attributes



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

def crm_attributes
  @properties['crm_attributes']
end

#crm_callback_url ⇒ String

Returns CRM Callback URL.

Returns:

  • (String) —

    CRM Callback URL



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

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



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

def crm_enabled
  @properties['crm_enabled']
end

#crm_fallback_url ⇒ String

Returns CRM Fallback URL.

Returns:

  • (String) —

    CRM Fallback URL



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

def crm_fallback_url
  @properties['crm_fallback_url']
end

#crm_type ⇒ String

Returns CRM Type.

Returns:

  • (String) —

    CRM Type



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

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



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

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



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

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:



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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

def messaging_service_instance_sid
  @properties['messaging_service_instance_sid']
end

#plugin_service_attributes ⇒ Hash

Returns Plugin service Attributes.

Returns:

  • (Hash) —

    Plugin service Attributes



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

def plugin_service_attributes
  @properties['plugin_service_attributes']
end

#plugin_service_enabled ⇒ Boolean

Returns Is plugin service Enabled.

Returns:

  • (Boolean) —

    Is plugin service Enabled



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

def plugin_service_enabled
  @properties['plugin_service_enabled']
end

#public_attributes ⇒ Hash

Returns Public Attributes.

Returns:

  • (Hash) —

    Public Attributes



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

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



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

def runtime_domain
  @properties['runtime_domain']
end

#service_version ⇒ String

Returns Flex Service version.

Returns:

  • (String) —

    Flex Service version



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

def service_version
  @properties['service_version']
end

#status ⇒ configuration.Status

Returns Status of the Flex onboarding.

Returns:



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

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



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

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



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

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



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

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



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

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



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

def taskrouter_taskqueues
  @properties['taskrouter_taskqueues']
end

#taskrouter_worker_attributes ⇒ Hash

Returns The taskrouter_worker_attributes.

Returns:

  • (Hash) —

    The taskrouter_worker_attributes



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

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



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

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



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

def taskrouter_workspace_sid
  @properties['taskrouter_workspace_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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



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

def ui_language
  @properties['ui_language']
end

#ui_version ⇒ String

Returns Pinned UI version.

Returns:

  • (String) —

    Pinned UI version



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

def ui_version
  @properties['ui_version']
end

#update ⇒ ConfigurationInstance

Update the ConfigurationInstance

Returns:



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

def update
  context.update
end

#url ⇒ String

Returns The URL for this resource.

Returns:

  • (String) —

    The URL for this resource



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

def url
  @properties['url']
end