Class: Twilio::REST::Api::V2010::AccountContext::SipList::IpAccessControlListContext::IpAddressList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, ip_access_control_list_sid: nil) ⇒ IpAddressList

Initialize the IpAddressList



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 25

def initialize(version, account_sid: nil, ip_access_control_list_sid: nil)
  super(version)

  # Path Solution
  @solution = {account_sid: , ip_access_control_list_sid: ip_access_control_list_sid}
  @uri = "/Accounts/#{@solution[:account_sid]}/SIP/IpAccessControlLists/#{@solution[:ip_access_control_list_sid]}/IpAddresses.json"
end

Instance Method Details

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

Create the IpAddressInstance



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 124

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

  payload = @version.create('POST', @uri, data: data)

  IpAddressInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      ip_access_control_list_sid: @solution[:ip_access_control_list_sid],
  )
end

#each ⇒ Object

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



71
72
73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 71

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



105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 105

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

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

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



44
45
46
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 44

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



88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 88

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)

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

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

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



59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 59

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



143
144
145
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb', line 143

def to_s
  '#<Twilio.Api.V2010.IpAddressList>'
end