Class: Twilio::REST::Api::V2010::AccountContext::SipList::DomainContext::IpAccessControlListMappingList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::SipList::DomainContext::IpAccessControlListMappingList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb
Instance Method Summary collapse
-
#create(ip_access_control_list_sid: nil) ⇒ IpAccessControlListMappingInstance
Create the IpAccessControlListMappingInstance.
-
#each ⇒ Object
When passed a block, yields IpAccessControlListMappingInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of IpAccessControlListMappingInstance records from the API.
-
#initialize(version, account_sid: nil, domain_sid: nil) ⇒ IpAccessControlListMappingList
constructor
Initialize the IpAccessControlListMappingList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists IpAccessControlListMappingInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of IpAccessControlListMappingInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, account_sid: nil, domain_sid: nil) ⇒ IpAccessControlListMappingList
Initialize the IpAccessControlListMappingList
29 30 31 32 33 34 35 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb', line 29 def initialize(version, account_sid: nil, domain_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid, domain_sid: domain_sid } @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains/#{@solution[:domain_sid]}/IpAccessControlListMappings.json" end |
Instance Method Details
#create(ip_access_control_list_sid: nil) ⇒ IpAccessControlListMappingInstance
Create the IpAccessControlListMappingInstance
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb', line 40 def create( ip_access_control_list_sid: nil ) data = Twilio::Values.of({ 'IpAccessControlListSid' => ip_access_control_list_sid, }) payload = @version.create('POST', @uri, data: data) IpAccessControlListMappingInstance.new( @version, payload, account_sid: @solution[:account_sid], domain_sid: @solution[:domain_sid], ) end |
#each ⇒ Object
When passed a block, yields IpAccessControlListMappingInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
100 101 102 103 104 105 106 107 108 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb', line 100 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 IpAccessControlListMappingInstance records from the API. Request is executed immediately.
135 136 137 138 139 140 141 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb', line 135 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) IpAccessControlListMappingPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists IpAccessControlListMappingInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
69 70 71 72 73 74 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb', line 69 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 IpAccessControlListMappingInstance records from the API. Request is executed immediately.
117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb', line 117 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) IpAccessControlListMappingPage.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.
87 88 89 90 91 92 93 94 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb', line 87 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
146 147 148 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb', line 146 def to_s '#<Twilio.Api.V2010.IpAccessControlListMappingList>' end |