Class: Twilio::REST::Api::V2010::AccountContext::SipList::IpAccessControlListList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ IpAccessControlListList

Initialize the IpAccessControlListList



20
21
22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb', line 20

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

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

Instance Method Details

#create(friendly_name: nil) ⇒ IpAccessControlListInstance

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



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

def create(friendly_name: nil)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
  })

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

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

#each ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb', line 73

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



111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb', line 111

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

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

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



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

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



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb', line 92

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
  )
  IpAccessControlListPage.new(@version, response, @solution)
end

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

Streams IpAccessControlListInstance 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
66
67
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.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



145
146
147
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb', line 145

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