Class: Twilio::REST::Intelligence::V2::ServiceInstance
- Inherits:
-
Twilio::REST::InstanceResource
- Object
- Twilio::REST::InstanceResource
- Twilio::REST::Intelligence::V2::ServiceInstance
- Defined in:
- lib/twilio-ruby/rest/intelligence/v2/service.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique SID identifier of the Account the Service belongs to.
-
#auto_redaction ⇒ Boolean
Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
-
#auto_transcribe ⇒ Boolean
Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
-
#context ⇒ ServiceContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#data_logging ⇒ Boolean
Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.
-
#date_created ⇒ Time
The date that this Service was created, given in ISO 8601 format.
-
#date_updated ⇒ Time
The date that this Service was updated, given in ISO 8601 format.
-
#delete ⇒ Boolean
Delete the ServiceInstance.
-
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance.
-
#friendly_name ⇒ String
A human readable description of this resource, up to 64 characters.
-
#initialize(version, payload, sid: nil) ⇒ ServiceInstance
constructor
Initialize the ServiceInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#language_code ⇒ String
The language code set during Service creation determines the Transcription language for all call recordings processed by that Service.
-
#media_redaction ⇒ Boolean
Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service.
-
#read_only_attached_operator_sids ⇒ Array<String>
Operator sids attached to this service, read only.
-
#sid ⇒ String
A 34 character string that uniquely identifies this Service.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_name ⇒ String
Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
-
#update(auto_transcribe: :unset, data_logging: :unset, friendly_name: :unset, unique_name: :unset, auto_redaction: :unset, media_redaction: :unset, webhook_url: :unset, webhook_http_method: :unset, if_match: :unset) ⇒ ServiceInstance
Update the ServiceInstance.
-
#url ⇒ String
The URL of this resource.
-
#version ⇒ String
The version number of this Service.
- #webhook_http_method ⇒ HttpMethod
-
#webhook_url ⇒ String
The URL Twilio will request when executing the Webhook.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ ServiceInstance
Initialize the ServiceInstance
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 311 def initialize(version, payload , sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'auto_redaction' => payload['auto_redaction'], 'media_redaction' => payload['media_redaction'], 'auto_transcribe' => payload['auto_transcribe'], 'data_logging' => payload['data_logging'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'friendly_name' => payload['friendly_name'], 'language_code' => payload['language_code'], 'sid' => payload['sid'], 'unique_name' => payload['unique_name'], 'url' => payload['url'], 'webhook_url' => payload['webhook_url'], 'webhook_http_method' => payload['webhook_http_method'], 'read_only_attached_operator_sids' => payload['read_only_attached_operator_sids'], 'version' => payload['version'] == nil ? payload['version'] : payload['version'].to_i, } # Context @instance_context = nil @params = { 'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
352 353 354 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 352 def account_sid @properties['account_sid'] end |
#auto_redaction ⇒ Boolean
358 359 360 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 358 def auto_redaction @properties['auto_redaction'] end |
#auto_transcribe ⇒ Boolean
370 371 372 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 370 def auto_transcribe @properties['auto_transcribe'] end |
#context ⇒ ServiceContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
343 344 345 346 347 348 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 343 def context unless @instance_context @instance_context = ServiceContext.new(@version , @params['sid']) end @instance_context end |
#data_logging ⇒ Boolean
376 377 378 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 376 def data_logging @properties['data_logging'] end |
#date_created ⇒ Time
382 383 384 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 382 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
388 389 390 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 388 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the ServiceInstance
449 450 451 452 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 449 def delete context.delete end |
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance
457 458 459 460 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 457 def fetch context.fetch end |
#friendly_name ⇒ String
394 395 396 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 394 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
508 509 510 511 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 508 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Intelligence.V2.ServiceInstance #{values}>" end |
#language_code ⇒ String
400 401 402 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 400 def language_code @properties['language_code'] end |
#media_redaction ⇒ Boolean
364 365 366 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 364 def media_redaction @properties['media_redaction'] end |
#read_only_attached_operator_sids ⇒ Array<String>
436 437 438 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 436 def read_only_attached_operator_sids @properties['read_only_attached_operator_sids'] end |
#sid ⇒ String
406 407 408 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 406 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
501 502 503 504 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 501 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Intelligence.V2.ServiceInstance #{values}>" end |
#unique_name ⇒ String
412 413 414 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 412 def unique_name @properties['unique_name'] end |
#update(auto_transcribe: :unset, data_logging: :unset, friendly_name: :unset, unique_name: :unset, auto_redaction: :unset, media_redaction: :unset, webhook_url: :unset, webhook_http_method: :unset, if_match: :unset) ⇒ ServiceInstance
Update the ServiceInstance
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 474 def update( auto_transcribe: :unset, data_logging: :unset, friendly_name: :unset, unique_name: :unset, auto_redaction: :unset, media_redaction: :unset, webhook_url: :unset, webhook_http_method: :unset, if_match: :unset ) context.update( auto_transcribe: auto_transcribe, data_logging: data_logging, friendly_name: friendly_name, unique_name: unique_name, auto_redaction: auto_redaction, media_redaction: media_redaction, webhook_url: webhook_url, webhook_http_method: webhook_http_method, if_match: if_match, ) end |
#url ⇒ String
418 419 420 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 418 def url @properties['url'] end |
#version ⇒ String
442 443 444 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 442 def version @properties['version'] end |
#webhook_http_method ⇒ HttpMethod
430 431 432 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 430 def webhook_http_method @properties['webhook_http_method'] end |
#webhook_url ⇒ String
424 425 426 |
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 424 def webhook_url @properties['webhook_url'] end |