Class: Twilio::REST::Voice::V1::IpRecordList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Voice::V1::IpRecordList
- Defined in:
- lib/twilio-ruby/rest/voice/v1/ip_record.rb
Instance Method Summary collapse
-
#create(ip_address: nil, friendly_name: :unset, cidr_prefix_length: :unset) ⇒ IpRecordInstance
Create the IpRecordInstance.
-
#each ⇒ Object
When passed a block, yields IpRecordInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of IpRecordInstance records from the API.
-
#initialize(version) ⇒ IpRecordList
constructor
Initialize the IpRecordList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists IpRecordInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of IpRecordInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams IpRecordInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ IpRecordList
Initialize the IpRecordList
18 19 20 21 22 23 24 |
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 18 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
35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 35 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, }) payload = @version.create('POST', @uri, data: data) 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.
85 86 87 88 89 90 91 92 93 |
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 85 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.
119 120 121 122 123 124 125 |
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 119 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.
58 59 60 |
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 58 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.
102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 102 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) IpRecordPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams IpRecordInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
73 74 75 76 77 78 79 |
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 73 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
129 130 131 |
# File 'lib/twilio-ruby/rest/voice/v1/ip_record.rb', line 129 def to_s '#<Twilio.Voice.V1.IpRecordList>' end |