Class: Twilio::REST::Voice::V1::ConnectionPolicyContext::ConnectionPolicyTargetList

Inherits:
ListResource
  • 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, connection_policy_sid: nil) ⇒ ConnectionPolicyTargetList

Initialize the ConnectionPolicyTargetList



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 27

def initialize(version, connection_policy_sid: nil)
    super(version)
    # Path Solution
    @solution = { connection_policy_sid: connection_policy_sid }
    @uri = "/ConnectionPolicies/#{@solution[:connection_policy_sid]}/Targets"
    
end

Instance Method Details

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

Create the ConnectionPolicyTargetInstance



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 42

def create(
    target: nil, 
    friendly_name: :unset, 
    priority: :unset, 
    weight: :unset, 
    enabled: :unset
)

    data = Twilio::Values.of({
        'Target' => target,
        'FriendlyName' => friendly_name,
        'Priority' => priority,
        'Weight' => weight,
        'Enabled' => enabled,
    })

    payload = @version.create('POST', @uri, data: data)
    ConnectionPolicyTargetInstance.new(
        @version,
        payload,
        connection_policy_sid: @solution[:connection_policy_sid],
    )
end

#each ⇒ Object

When passed a block, yields ConnectionPolicyTargetInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



109
110
111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 109

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of ConnectionPolicyTargetInstance records from the API. Request is executed immediately.



144
145
146
147
148
149
150
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 144

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
ConnectionPolicyTargetPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists ConnectionPolicyTargetInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 78

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of ConnectionPolicyTargetInstance records from the API. Request is executed immediately.



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 126

def page(page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

    response = @version.page('GET', @uri, params: params)

    ConnectionPolicyTargetPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 96

def stream(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



155
156
157
 
# File 'lib/twilio-ruby/rest/voice/v1/connection_policy/connection_policy_target.rb', line 155

def to_s
    '#<Twilio.Voice.V1.ConnectionPolicyTargetList>'
end