Class: Twilio::REST::Serverless::V1::ServiceInstance

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



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 631

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'unique_name' => payload['unique_name'],
        'include_credentials' => payload['include_credentials'],
        'ui_editable' => payload['ui_editable'],
        'domain_base' => payload['domain_base'],
        '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](www.twilio.com/docs/iam/api/account) that created the Service resource.

Returns:



674
675
676
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 674

def 
    @properties['account_sid']
end

#assets ⇒ assets

Access the assets

Returns:



791
792
793
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 791

def assets
    context.assets
end

#builds ⇒ builds

Access the builds

Returns:



784
785
786
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 784

def builds
    context.builds
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:



659
660
661
662
663
664
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 659

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

#date_created ⇒ Time

Returns The date and time in GMT when the Service resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the Service resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#domain_base ⇒ String

Returns The base domain name for this Service, which is a combination of the unique name and a randomly generated string.

Returns:

  • (String) —

    The base domain name for this Service, which is a combination of the unique name and a randomly generated string.



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

def domain_base
    @properties['domain_base']
end

#environments ⇒ environments

Access the environments

Returns:



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

def environments
    context.environments
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



743
744
745
746
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 743

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the Service resource.

Returns:

  • (String) —

    The string that you assigned to describe the Service resource.



680
681
682
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 680

def friendly_name
    @properties['friendly_name']
end

#functions ⇒ functions

Access the functions

Returns:



777
778
779
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 777

def functions
    context.functions
end

#include_credentials ⇒ Boolean

Returns Whether to inject Account credentials into a function invocation context.

Returns:

  • (Boolean) —

    Whether to inject Account credentials into a function invocation context.



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

def include_credentials
    @properties['include_credentials']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



804
805
806
807
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 804

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

#links ⇒ Hash

Returns The URLs of the Service’s nested resources.

Returns:

  • (Hash) —

    The URLs of the Service’s nested resources.



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

def links
    @properties['links']
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.



668
669
670
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 668

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



797
798
799
800
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 797

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

#ui_editable ⇒ Boolean

Returns Whether the Service resource’s properties and subresources can be edited via the UI.

Returns:

  • (Boolean) —

    Whether the Service resource’s properties and subresources can be edited via the UI.



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

def ui_editable
    @properties['ui_editable']
end

#unique_name ⇒ String

Returns A user-defined string that uniquely identifies the Service resource. It can be used in place of the Service resource’s sid in the URL to address the Service resource.

Returns:

  • (String) —

    A user-defined string that uniquely identifies the Service resource. It can be used in place of the Service resource’s sid in the URL to address the Service resource.



686
687
688
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 686

def unique_name
    @properties['unique_name']
end

#update(include_credentials: :unset, friendly_name: :unset, ui_editable: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

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

    Whether to inject Account credentials into a function invocation context.

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

    A descriptive string that you create to describe the Service resource. It can be a maximum of 255 characters.

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

    Whether the Service resource’s properties and subresources can be edited via the UI. The default value is false.

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 754

def update(
    include_credentials: :unset, 
    friendly_name: :unset, 
    ui_editable: :unset
)

    context.update(
        include_credentials: include_credentials, 
        friendly_name: friendly_name, 
        ui_editable: ui_editable, 
    )
end

#url ⇒ String

Returns The absolute URL of the Service resource.

Returns:

  • (String) —

    The absolute URL of the Service resource.



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

def url
    @properties['url']
end