class Twilio::REST::FlexApi::V1::ConfigurationInstance

Public Class Methods

new(version, payload) click to toggle source

Initialize the ConfigurationInstance @param [Version] version Version that contains the resource @param [Hash] payload payload that contains response from Twilio @return [ConfigurationInstance] ConfigurationInstance

Calls superclass method Twilio::REST::InstanceResource::new
    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
126 def initialize(version, payload)
127   super(version)
128 
129   # Marshaled Properties
130   @properties = {
131       'account_sid' => payload['account_sid'],
132       'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
133       'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
134       'attributes' => payload['attributes'],
135       'status' => payload['status'],
136       'taskrouter_workspace_sid' => payload['taskrouter_workspace_sid'],
137       'taskrouter_target_workflow_sid' => payload['taskrouter_target_workflow_sid'],
138       'taskrouter_target_taskqueue_sid' => payload['taskrouter_target_taskqueue_sid'],
139       'taskrouter_taskqueues' => payload['taskrouter_taskqueues'],
140       'taskrouter_skills' => payload['taskrouter_skills'],
141       'taskrouter_worker_channels' => payload['taskrouter_worker_channels'],
142       'taskrouter_worker_attributes' => payload['taskrouter_worker_attributes'],
143       'taskrouter_offline_activity_sid' => payload['taskrouter_offline_activity_sid'],
144       'runtime_domain' => payload['runtime_domain'],
145       'messaging_service_instance_sid' => payload['messaging_service_instance_sid'],
146       'chat_service_instance_sid' => payload['chat_service_instance_sid'],
147       'flex_service_instance_sid' => payload['flex_service_instance_sid'],
148       'ui_language' => payload['ui_language'],
149       'ui_attributes' => payload['ui_attributes'],
150       'ui_dependencies' => payload['ui_dependencies'],
151       'ui_version' => payload['ui_version'],
152       'service_version' => payload['service_version'],
153       'call_recording_enabled' => payload['call_recording_enabled'],
154       'call_recording_webhook_url' => payload['call_recording_webhook_url'],
155       'crm_enabled' => payload['crm_enabled'],
156       'crm_type' => payload['crm_type'],
157       'crm_callback_url' => payload['crm_callback_url'],
158       'crm_fallback_url' => payload['crm_fallback_url'],
159       'crm_attributes' => payload['crm_attributes'],
160       'public_attributes' => payload['public_attributes'],
161       'plugin_service_enabled' => payload['plugin_service_enabled'],
162       'plugin_service_attributes' => payload['plugin_service_attributes'],
163       'integrations' => payload['integrations'],
164       'outbound_call_flows' => payload['outbound_call_flows'],
165       'serverless_service_sids' => payload['serverless_service_sids'],
166       'queue_stats_configuration' => payload['queue_stats_configuration'],
167       'notifications' => payload['notifications'],
168       'markdown' => payload['markdown'],
169       'url' => payload['url'],
170   }
171 
172   # Context
173   @instance_context = nil
174   @params = {}
175 end

Public Instance Methods

account_sid() click to toggle source

@return [String] The SID of the Account that created the resource

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
190 def account_sid
191   @properties['account_sid']
192 end
attributes() click to toggle source

@return [Hash] An object that contains application-specific data

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
208 def attributes
209   @properties['attributes']
210 end
call_recording_enabled() click to toggle source

@return [Boolean] Whether call recording is enabled

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
322 def call_recording_enabled
323   @properties['call_recording_enabled']
324 end
call_recording_webhook_url() click to toggle source

@return [String] The call recording webhook URL

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
328 def call_recording_webhook_url
329   @properties['call_recording_webhook_url']
330 end
chat_service_instance_sid() click to toggle source

@return [String] The SID of the chat service this user belongs to

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
280 def chat_service_instance_sid
281   @properties['chat_service_instance_sid']
282 end
context() click to toggle source

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [ConfigurationContext] ConfigurationContext for this ConfigurationInstance

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
181 def context
182   unless @instance_context
183     @instance_context = ConfigurationContext.new(@version, )
184   end
185   @instance_context
186 end
create() click to toggle source

Create the ConfigurationInstance @return [ConfigurationInstance] Created ConfigurationInstance

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
434 def create
435   context.create
436 end
crm_attributes() click to toggle source

@return [Hash] An object that contains the CRM attributes

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
358 def crm_attributes
359   @properties['crm_attributes']
360 end
crm_callback_url() click to toggle source

@return [String] The CRM Callback URL

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
346 def crm_callback_url
347   @properties['crm_callback_url']
348 end
crm_enabled() click to toggle source

@return [Boolean] Whether CRM is present for Flex

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
334 def crm_enabled
335   @properties['crm_enabled']
336 end
crm_fallback_url() click to toggle source

@return [String] The CRM Fallback URL

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
352 def crm_fallback_url
353   @properties['crm_fallback_url']
354 end
crm_type() click to toggle source

@return [String] The CRM Type

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
340 def crm_type
341   @properties['crm_type']
342 end
date_created() click to toggle source

@return [Time] The ISO 8601 date and time in GMT when the Configuration resource was created

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
196 def date_created
197   @properties['date_created']
198 end
date_updated() click to toggle source

@return [Time] The ISO 8601 date and time in GMT when the Configuration resource was last updated

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
202 def date_updated
203   @properties['date_updated']
204 end
fetch(ui_version: :unset) click to toggle source

Fetch the ConfigurationInstance @param [String] ui_version The Pinned UI version of the Configuration resource

to fetch.

@return [ConfigurationInstance] Fetched ConfigurationInstance

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
427 def fetch(ui_version: :unset)
428   context.fetch(ui_version: ui_version, )
429 end
flex_service_instance_sid() click to toggle source

@return [String] The SID of the Flex service instance

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
286 def flex_service_instance_sid
287   @properties['flex_service_instance_sid']
288 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
454 def inspect
455   values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
456   "<Twilio.FlexApi.V1.ConfigurationInstance #{values}>"
457 end
integrations() click to toggle source

@return [Array] A list of objects that contain the configurations for the Integrations supported in this configuration

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
382 def integrations
383   @properties['integrations']
384 end
markdown() click to toggle source

@return [Hash] Configurable parameters for Markdown

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
412 def markdown
413   @properties['markdown']
414 end
messaging_service_instance_sid() click to toggle source

@return [String] The SID of the Messaging service instance

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
274 def messaging_service_instance_sid
275   @properties['messaging_service_instance_sid']
276 end
notifications() click to toggle source

@return [Hash] Configurable parameters for Notifications

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
406 def notifications
407   @properties['notifications']
408 end
outbound_call_flows() click to toggle source

@return [Hash] The list of outbound call flows

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
388 def outbound_call_flows
389   @properties['outbound_call_flows']
390 end
plugin_service_attributes() click to toggle source

@return [Hash] The plugin service attributes

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
376 def plugin_service_attributes
377   @properties['plugin_service_attributes']
378 end
plugin_service_enabled() click to toggle source

@return [Boolean] Whether the plugin service enabled

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
370 def plugin_service_enabled
371   @properties['plugin_service_enabled']
372 end
public_attributes() click to toggle source

@return [Hash] The list of public attributes

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
364 def public_attributes
365   @properties['public_attributes']
366 end
queue_stats_configuration() click to toggle source

@return [Hash] Configurable parameters for Queues Statistics

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
400 def queue_stats_configuration
401   @properties['queue_stats_configuration']
402 end
runtime_domain() click to toggle source

@return [String] The URL where the Flex instance is hosted

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
268 def runtime_domain
269   @properties['runtime_domain']
270 end
serverless_service_sids() click to toggle source

@return [Array] The list of serverless service SIDs

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
394 def serverless_service_sids
395   @properties['serverless_service_sids']
396 end
service_version() click to toggle source

@return [String] The Flex Service version

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
316 def service_version
317   @properties['service_version']
318 end
status() click to toggle source

@return [configuration.Status] The status of the Flex onboarding

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
214 def status
215   @properties['status']
216 end
taskrouter_offline_activity_sid() click to toggle source

@return [String] The TaskRouter SID of the offline activity

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
262 def taskrouter_offline_activity_sid
263   @properties['taskrouter_offline_activity_sid']
264 end
taskrouter_skills() click to toggle source

@return [Array] The Skill description for TaskRouter workers

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
244 def taskrouter_skills
245   @properties['taskrouter_skills']
246 end
taskrouter_target_taskqueue_sid() click to toggle source

@return [String] The SID of the TaskRouter Target TaskQueue

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
232 def taskrouter_target_taskqueue_sid
233   @properties['taskrouter_target_taskqueue_sid']
234 end
taskrouter_target_workflow_sid() click to toggle source

@return [String] The SID of the TaskRouter target Workflow

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
226 def taskrouter_target_workflow_sid
227   @properties['taskrouter_target_workflow_sid']
228 end
taskrouter_taskqueues() click to toggle source

@return [Array] The list of TaskRouter TaskQueues

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
238 def taskrouter_taskqueues
239   @properties['taskrouter_taskqueues']
240 end
taskrouter_worker_attributes() click to toggle source

@return [Hash] The TaskRouter Worker attributes

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
256 def taskrouter_worker_attributes
257   @properties['taskrouter_worker_attributes']
258 end
taskrouter_worker_channels() click to toggle source

@return [Hash] The TaskRouter default channel capacities and availability for workers

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
250 def taskrouter_worker_channels
251   @properties['taskrouter_worker_channels']
252 end
taskrouter_workspace_sid() click to toggle source

@return [String] The SID of the TaskRouter Workspace

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
220 def taskrouter_workspace_sid
221   @properties['taskrouter_workspace_sid']
222 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
447 def to_s
448   values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
449   "<Twilio.FlexApi.V1.ConfigurationInstance #{values}>"
450 end
ui_attributes() click to toggle source

@return [Hash] The object that describes Flex UI characteristics and settings

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
298 def ui_attributes
299   @properties['ui_attributes']
300 end
ui_dependencies() click to toggle source

@return [Hash] The object that defines the NPM packages and versions to be used in Hosted Flex

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
304 def ui_dependencies
305   @properties['ui_dependencies']
306 end
ui_language() click to toggle source

@return [String] The primary language of the Flex UI

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
292 def ui_language
293   @properties['ui_language']
294 end
ui_version() click to toggle source

@return [String] The Pinned UI version

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
310 def ui_version
311   @properties['ui_version']
312 end
update() click to toggle source

Update the ConfigurationInstance @return [ConfigurationInstance] Updated ConfigurationInstance

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
441 def update
442   context.update
443 end
url() click to toggle source

@return [String] The absolute URL of the Configuration resource

    # File lib/twilio-ruby/rest/flex_api/v1/configuration.rb
418 def url
419   @properties['url']
420 end