Class: Twilio::REST::Voice::V1::IpRecordList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/voice/v1/ip_record.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ IpRecordList

Initialize the IpRecordList



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

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/IpRecords"
    
end

Instance Method Details

#create(ip_address: nil, friendly_name: :unset, cidr_prefix_length: :unset) ⇒ IpRecordInstance

Create the IpRecordInstance



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

def create(
    ip_address: nil, 
    friendly_name: :unset, 
    cidr_prefix_length: :unset
)

    data = Twilio::Values.of({
        'IpAddress' => ip_address,
        'FriendlyName' => friendly_name,
        'CidrPrefixLength' => cidr_prefix_length,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    IpRecordInstance.new(
        @version,
        payload,
    )
end

#each ⇒ Object

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



107
108
109
110
111
112
113
114
115
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 107

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 IpRecordInstance records from the API. Request is executed immediately.



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

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

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

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



76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 76

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 IpRecordInstance records from the API. Request is executed immediately.



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

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

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

    IpRecordPage.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.



94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 94

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/ip_record.rb', line 155

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