Class: Twilio::REST::Proxy::V1::ServiceInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

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

    A 34 character string that uniquely identifies this Service.



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 345

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'unique_name' => payload['unique_name'],
      'account_sid' => payload['account_sid'],
      'callback_url' => payload['callback_url'],
      'default_ttl' => payload['default_ttl'].to_i,
      'number_selection_behavior' => payload['number_selection_behavior'],
      'geo_match_level' => payload['geo_match_level'],
      'intercept_callback_url' => payload['intercept_callback_url'],
      'out_of_session_callback_url' => payload['out_of_session_callback_url'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



395
396
397
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 395

def 
  @properties['account_sid']
end

#callback_url ⇒ String

Returns URL Twilio will send callbacks to.

Returns:

  • (String) —

    URL Twilio will send callbacks to



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

def callback_url
  @properties['callback_url']
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:



374
375
376
377
378
379
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 374

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

#date_created ⇒ Time

Returns The date this Service was created.

Returns:

  • (Time) —

    The date this Service was created



437
438
439
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 437

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Service was last updated.

Returns:

  • (Time) —

    The date this Service was last updated



443
444
445
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 443

def date_updated
  @properties['date_updated']
end

#default_ttl ⇒ String

Returns Default TTL for a Session, in seconds.

Returns:

  • (String) —

    Default TTL for a Session, in seconds.



407
408
409
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 407

def default_ttl
  @properties['default_ttl']
end

#delete ⇒ Boolean

Deletes the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



469
470
471
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 469

def delete
  context.delete
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance

Returns:



462
463
464
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 462

def fetch
  context.fetch
end

#geo_match_level ⇒ service.GeoMatchLevel

Returns Whether proxy number selected must be in the same area code as the participant identifier.

Returns:

  • (service.GeoMatchLevel) —

    Whether proxy number selected must be in the same area code as the participant identifier.



419
420
421
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 419

def geo_match_level
  @properties['geo_match_level']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



536
537
538
539
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 536

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

#intercept_callback_url ⇒ String

Returns A URL for Twilio call before each Interaction.

Returns:

  • (String) —

    A URL for Twilio call before each Interaction.



425
426
427
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 425

def intercept_callback_url
  @properties['intercept_callback_url']
end

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



455
456
457
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 455

def links
  @properties['links']
end

#number_selection_behavior ⇒ service.NumberSelectionBehavior

Returns What behavior to use when choosing a proxy number.

Returns:

  • (service.NumberSelectionBehavior) —

    What behavior to use when choosing a proxy number.



413
414
415
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 413

def number_selection_behavior
  @properties['number_selection_behavior']
end

#out_of_session_callback_url ⇒ String

Returns A URL for Twilio call when a new Interaction has no Session.

Returns:

  • (String) —

    A URL for Twilio call when a new Interaction has no Session.



431
432
433
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 431

def out_of_session_callback_url
  @properties['out_of_session_callback_url']
end

#phone_numbers ⇒ phone_numbers

Access the phone_numbers

Returns:



516
517
518
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 516

def phone_numbers
  context.phone_numbers
end

#sessions ⇒ sessions

Access the sessions

Returns:



509
510
511
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 509

def sessions
  context.sessions
end

#short_codes ⇒ short_codes

Access the short_codes

Returns:



523
524
525
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 523

def short_codes
  context.short_codes
end

#sid ⇒ String

Returns A string that uniquely identifies this Service.

Returns:

  • (String) —

    A string that uniquely identifies this Service.



383
384
385
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 383

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



529
530
531
532
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 529

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

#unique_name ⇒ String

Returns A human-readable description of this resource.

Returns:

  • (String) —

    A human-readable description of this resource.



389
390
391
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 389

def unique_name
  @properties['unique_name']
end

#update(unique_name: :unset, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

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

    A human-readable description of this resource, up to 64 characters. *Should not contain PII.*

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

    The default time delay in seconds after the latest of Session create time or the Session’s last Interaction time, after which a session will expire. Used for sessions where TTL is not specified.

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

    The URL to which Twilio will make callbacks on interaction status changes.

  • geo_match_level (service.GeoMatchLevel) (defaults to: :unset) —

    Whether proxy number selected must be in the same area code as the participant identifier. Options: ‘country`, `area-code`, `extended-area-code`. Default: `country`. Levels lower than country are only available in North America.

  • number_selection_behavior (service.NumberSelectionBehavior) (defaults to: :unset) —

    Options: ‘prefer-sticky`, `avoid-sticky`. Default: `prefer-sticky`.

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

    A URL for Twilio call before each Interaction. Returning a 403 status code will prevent the interaction from continuing.

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

    A URL for Twilio call when a new Interaction has no [Session](www.twilio.com/docs/proxy/api/session).

Returns:



494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 494

def update(unique_name: :unset, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset)
  context.update(
      unique_name: unique_name,
      default_ttl: default_ttl,
      callback_url: callback_url,
      geo_match_level: geo_match_level,
      number_selection_behavior: number_selection_behavior,
      intercept_callback_url: intercept_callback_url,
      out_of_session_callback_url: out_of_session_callback_url,
  )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



449
450
451
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 449

def url
  @properties['url']
end