Class: Twilio::REST::Intelligence::V2::ServiceInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/intelligence/v2/service.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Service resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 328

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

Returns The unique SID identifier of the Account the Service belongs to.

Returns:

  • (String) —

    The unique SID identifier of the Account the Service belongs to.



369
370
371
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 369

def 
    @properties['account_sid']
end

#auto_redaction ⇒ Boolean

Returns Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.

Returns:

  • (Boolean) —

    Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.



375
376
377
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 375

def auto_redaction
    @properties['auto_redaction']
end

#auto_transcribe ⇒ Boolean

Returns Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.

Returns:

  • (Boolean) —

    Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.



387
388
389
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 387

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

Returns:



360
361
362
363
364
365
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 360

def context
    unless @instance_context
        @instance_context = ServiceContext.new(@version , @params['sid'])
    end
    @instance_context
end

#data_logging ⇒ Boolean

Returns 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. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.

Returns:

  • (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. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.



393
394
395
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 393

def data_logging
    @properties['data_logging']
end

#date_created ⇒ Time

Returns The date that this Service was created, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this Service was created, given in ISO 8601 format.



399
400
401
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 399

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this Service was updated, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that this Service was updated, given in ISO 8601 format.



405
406
407
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 405

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



466
467
468
469
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 466

def delete

    context.delete
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



474
475
476
477
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 474

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this resource, up to 64 characters.

Returns:

  • (String) —

    A human readable description of this resource, up to 64 characters.



411
412
413
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 411

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



525
526
527
528
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 525

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

#language_code ⇒ String

Returns The language code set during Service creation determines the Transcription language for all call recordings processed by that Service. The default is en-US if no language code is set. A Service can only support one language code, and it cannot be updated once it’s set.

Returns:

  • (String) —

    The language code set during Service creation determines the Transcription language for all call recordings processed by that Service. The default is en-US if no language code is set. A Service can only support one language code, and it cannot be updated once it’s set.



417
418
419
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 417

def language_code
    @properties['language_code']
end

#media_redaction ⇒ Boolean

Returns Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.

Returns:

  • (Boolean) —

    Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.



381
382
383
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 381

def media_redaction
    @properties['media_redaction']
end

#read_only_attached_operator_sids ⇒ Array<String>

Returns Operator sids attached to this service, read only.

Returns:

  • (Array<String>) —

    Operator sids attached to this service, read only



453
454
455
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 453

def read_only_attached_operator_sids
    @properties['read_only_attached_operator_sids']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Service.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Service.



423
424
425
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 423

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



518
519
520
521
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 518

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

#unique_name ⇒ String

Returns Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.

Returns:

  • (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.



429
430
431
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 429

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

Parameters:

  • auto_transcribe (Boolean) (defaults to: :unset) —

    Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.

  • data_logging (Boolean) (defaults to: :unset) —

    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. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.

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

    A human readable description of this resource, up to 64 characters.

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

    Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.

  • auto_redaction (Boolean) (defaults to: :unset) —

    Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.

  • media_redaction (Boolean) (defaults to: :unset) —

    Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.

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

    The URL Twilio will request when executing the Webhook.

  • webhook_http_method (HttpMethod) (defaults to: :unset)
  • if_match (String) (defaults to: :unset) —

    The If-Match HTTP request header

Returns:



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 491

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

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



435
436
437
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 435

def url
    @properties['url']
end

#version ⇒ String

Returns The version number of this Service.

Returns:

  • (String) —

    The version number of this Service.



459
460
461
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 459

def version
    @properties['version']
end

#webhook_http_method ⇒ HttpMethod

Returns:

  • (HttpMethod) 


447
448
449
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 447

def webhook_http_method
    @properties['webhook_http_method']
end

#webhook_url ⇒ String

Returns The URL Twilio will request when executing the Webhook.

Returns:

  • (String) —

    The URL Twilio will request when executing the Webhook.



441
442
443
 
# File 'lib/twilio-ruby/rest/intelligence/v2/service.rb', line 441

def webhook_url
    @properties['webhook_url']
end