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

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/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.



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 653

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'chat_instance_sid' => payload['chat_instance_sid'],
        'callback_url' => payload['callback_url'],
        'default_ttl' => payload['default_ttl'] == nil ? payload['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 The SID of the Account that created the Service resource.

Returns:

  • (String) —

    The SID of the Account that created the Service resource.



705
706
707
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 705

def 
    @properties['account_sid']
end

#callback_url ⇒ String

Returns The URL we call when the interaction status changes.

Returns:

  • (String) —

    The URL we call when the interaction status changes.



717
718
719
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 717

def callback_url
    @properties['callback_url']
end

#chat_instance_sid ⇒ String

Returns The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.

Returns:

  • (String) —

    The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.



711
712
713
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 711

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



684
685
686
687
688
689
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 684

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created.



753
754
755
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 753

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated.



759
760
761
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 759

def date_updated
    @properties['date_updated']
end

#default_ttl ⇒ String

Returns The default ttl value for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of 0 indicates an unlimited Session length. You can override a Session's default TTL value by setting its ttl value.

Returns:

  • (String) —

    The default ttl value for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of 0 indicates an unlimited Session length. You can override a Session's default TTL value by setting its ttl value.



723
724
725
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 723

def default_ttl
    @properties['default_ttl']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



778
779
780
781
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 778

def delete

    context.delete
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



786
787
788
789
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 786

def fetch

    context.fetch
end

#geo_match_level ⇒ GeoMatchLevel

Returns:

  • (GeoMatchLevel) 


735
736
737
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 735

def geo_match_level
    @properties['geo_match_level']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



848
849
850
851
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 848

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

#intercept_callback_url ⇒ String

Returns The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.

Returns:

  • (String) —

    The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.



741
742
743
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 741

def intercept_callback_url
    @properties['intercept_callback_url']
end

#links ⇒ Hash

Returns The URLs of resources related to the Service.

Returns:

  • (Hash) —

    The URLs of resources related to the Service.



771
772
773
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 771

def links
    @properties['links']
end

#number_selection_behavior ⇒ NumberSelectionBehavior

Returns:

  • (NumberSelectionBehavior) 


729
730
731
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 729

def number_selection_behavior
    @properties['number_selection_behavior']
end

#out_of_session_callback_url ⇒ String

Returns The URL we call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio function) responds with valid TwiML, we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See Out-of-Session Callback Response Guide for more information.

Returns:

  • (String) —

    The URL we call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio function) responds with valid TwiML, we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See Out-of-Session Callback Response Guide for more information.



747
748
749
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 747

def out_of_session_callback_url
    @properties['out_of_session_callback_url']
end

#phone_numbers ⇒ phone_numbers

Access the phone_numbers

Returns:



835
836
837
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 835

def phone_numbers
    context.phone_numbers
end

#sessions ⇒ sessions

Access the sessions

Returns:



828
829
830
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 828

def sessions
    context.sessions
end

#sid ⇒ String

Returns The unique string that we created to identify the Service resource.

Returns:

  • (String) —

    The unique string that we created to identify the Service resource.



693
694
695
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 693

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



841
842
843
844
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 841

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

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. Supports UTF-8 characters. This value should not have PII..

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. Supports UTF-8 characters. This value should not have PII.



699
700
701
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 699

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, chat_instance_sid: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

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

    An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. This value should not have PII.

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

    The default ttl value to set for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of 0 indicates an unlimited Session length. You can override a Session's default TTL value by setting its ttl value.

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

    The URL we should call when the interaction status changes.

  • geo_match_level (GeoMatchLevel) (defaults to: :unset)
  • number_selection_behavior (NumberSelectionBehavior) (defaults to: :unset)
  • intercept_callback_url (String) (defaults to: :unset) —

    The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.

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

    The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio function) responds with valid TwiML, we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See Out-of-Session Callback Response Guide for more information.

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

    The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.

Returns:



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 802

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, 
  chat_instance_sid: :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, 
        chat_instance_sid: chat_instance_sid, 
    )
end

#url ⇒ String

Returns The absolute URL of the Service resource.

Returns:

  • (String) —

    The absolute URL of the Service resource.



765
766
767
 
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 765

def url
    @properties['url']
end