Class: Twilio::REST::Voice::V1::ConnectionPolicyContext::ConnectionPolicyTargetInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, connection_policy_sid: nil, sid: nil) ⇒ ConnectionPolicyTargetInstance

Initialize the ConnectionPolicyTargetInstance

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 ConnectionPolicyTarget resource.

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

    The SID of the Call resource to fetch.



578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 578

def initialize(version, payload , connection_policy_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'connection_policy_sid' => payload['connection_policy_sid'],
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'target' => payload['target'],
        'priority' => payload['priority'] == nil ? payload['priority'] : payload['priority'].to_i,
        'weight' => payload['weight'] == nil ? payload['weight'] : payload['weight'].to_i,
        'enabled' => payload['enabled'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'connection_policy_sid' => connection_policy_sid  || @properties['connection_policy_sid']  ,'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 Target resource.

Returns:



615
616
617
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 615

def 
    @properties['account_sid']
end

#connection_policy_sid ⇒ String

Returns The SID of the Connection Policy that owns the Target.

Returns:

  • (String) —

    The SID of the Connection Policy that owns the Target.



621
622
623
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 621

def connection_policy_sid
    @properties['connection_policy_sid']
end

#context ⇒ ConnectionPolicyTargetContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



606
607
608
609
610
611
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 606

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



663
664
665
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 663

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



669
670
671
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 669

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ConnectionPolicyTargetInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



682
683
684
685
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 682

def delete

    context.delete
end

#enabled ⇒ Boolean

Returns Whether the target is enabled. The default is true.

Returns:

  • (Boolean) —

    Whether the target is enabled. The default is true.



657
658
659
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 657

def enabled
    @properties['enabled']
end

#fetch ⇒ ConnectionPolicyTargetInstance

Fetch the ConnectionPolicyTargetInstance

Returns:



690
691
692
693
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 690

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



633
634
635
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 633

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



729
730
731
732
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 729

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

#priority ⇒ String

Returns The relative importance of the target. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important target.

Returns:

  • (String) —

    The relative importance of the target. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important target.



645
646
647
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 645

def priority
    @properties['priority']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



627
628
629
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 627

def sid
    @properties['sid']
end

#target ⇒ String

Returns The SIP address you want Twilio to route your calls to. This must be a sip: schema. sips is NOT supported.

Returns:

  • (String) —

    The SIP address you want Twilio to route your calls to. This must be a sip: schema. sips is NOT supported.



639
640
641
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 639

def target
    @properties['target']
end

#to_s ⇒ Object

Provide a user friendly representation



722
723
724
725
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 722

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

#update(friendly_name: :unset, target: :unset, priority: :unset, weight: :unset, enabled: :unset) ⇒ ConnectionPolicyTargetInstance

Update the ConnectionPolicyTargetInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

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

    The SIP address you want Twilio to route your calls to. This must be a sip: schema. sips is NOT supported.

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

    The relative importance of the target. Can be an integer from 0 to 65535, inclusive. The lowest number represents the most important target.

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

    The value that determines the relative share of the load the Target should receive compared to other Targets with the same priority. Can be an integer from 1 to 65535, inclusive. Targets with higher values receive more load than those with lower ones with the same priority.

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

    Whether the Target is enabled.

Returns:



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 703

def update(
    friendly_name: :unset, 
    target: :unset, 
    priority: :unset, 
    weight: :unset, 
    enabled: :unset
)

    context.update(
        friendly_name: friendly_name, 
        target: target, 
        priority: priority, 
        weight: weight, 
        enabled: enabled, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



675
676
677
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 675

def url
    @properties['url']
end

#weight ⇒ String

Returns The value that determines the relative share of the load the Target should receive compared to other Targets with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. Targets with higher values receive more load than those with lower ones with the same priority.

Returns:

  • (String) —

    The value that determines the relative share of the load the Target should receive compared to other Targets with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. Targets with higher values receive more load than those with lower ones with the same priority.



651
652
653
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 651

def weight
    @properties['weight']
end