class Twilio::REST::Api::V2010::AccountContext::SipList::DomainContext::IpAccessControlListMappingList
Public Class Methods
Initialize the IpAccessControlListMappingList
@param [Version] version Version
that contains the resource @param [String] account_sid The unique id of the Account that is responsible for
this resource.
@param [String] domain_sid The unique string that is created to identify the
SipDomain resource.
@return [IpAccessControlListMappingList] IpAccessControlListMappingList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb 25 def initialize(version, account_sid: nil, domain_sid: nil) 26 super(version) 27 28 # Path Solution 29 @solution = {account_sid: account_sid, domain_sid: domain_sid} 30 @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains/#{@solution[:domain_sid]}/IpAccessControlListMappings.json" 31 end
Public Instance Methods
Create the IpAccessControlListMappingInstance
@param [String] ip_access_control_list_sid The unique id of the IP access
control list to map to the SIP domain.
@return [IpAccessControlListMappingInstance] Created IpAccessControlListMappingInstance
# File lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb 38 def create(ip_access_control_list_sid: nil) 39 data = Twilio::Values.of({'IpAccessControlListSid' => ip_access_control_list_sid, }) 40 41 payload = @version.create('POST', @uri, data: data) 42 43 IpAccessControlListMappingInstance.new( 44 @version, 45 payload, 46 account_sid: @solution[:account_sid], 47 domain_sid: @solution[:domain_sid], 48 ) 49 end
When passed a block, yields IpAccessControlListMappingInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb 89 def each 90 limits = @version.read_limits 91 92 page = self.page(page_size: limits[:page_size], ) 93 94 @version.stream(page, 95 limit: limits[:limit], 96 page_limit: limits[:page_limit]).each {|x| yield x} 97 end
Retrieve a single page of IpAccessControlListMappingInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of IpAccessControlListMappingInstance
# File lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb 123 def get_page(target_url) 124 response = @version.domain.request( 125 'GET', 126 target_url 127 ) 128 IpAccessControlListMappingPage.new(@version, response, @solution) 129 end
Lists IpAccessControlListMappingInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb 62 def list(limit: nil, page_size: nil) 63 self.stream(limit: limit, page_size: page_size).entries 64 end
Retrieve a single page of IpAccessControlListMappingInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of IpAccessControlListMappingInstance
# File lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb 106 def page(page_token: :unset, page_number: :unset, page_size: :unset) 107 params = Twilio::Values.of({ 108 'PageToken' => page_token, 109 'Page' => page_number, 110 'PageSize' => page_size, 111 }) 112 113 response = @version.page('GET', @uri, params: params) 114 115 IpAccessControlListMappingPage.new(@version, response, @solution) 116 end
Streams IpAccessControlListMappingInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb 77 def stream(limit: nil, page_size: nil) 78 limits = @version.read_limits(limit, page_size) 79 80 page = self.page(page_size: limits[:page_size], ) 81 82 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 83 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb 133 def to_s 134 '#<Twilio.Api.V2010.IpAccessControlListMappingList>' 135 end