Class: Twilio::REST::Api::V2010::AccountContext::SipList::DomainList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::SipList::DomainList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb
Instance Method Summary collapse
-
#create(domain_name: nil, friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset, emergency_calling_enabled: :unset, secure: :unset, byoc_trunk_sid: :unset, emergency_caller_sid: :unset) ⇒ DomainInstance
Create the DomainInstance.
-
#each ⇒ Object
When passed a block, yields DomainInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of DomainInstance records from the API.
-
#initialize(version, account_sid: nil) ⇒ DomainList
constructor
Initialize the DomainList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists DomainInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of DomainInstance 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) ⇒ DomainList
Initialize the DomainList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 28 def initialize(version, account_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid } @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains.json" end |
Instance Method Details
#create(domain_name: nil, friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset, emergency_calling_enabled: :unset, secure: :unset, byoc_trunk_sid: :unset, emergency_caller_sid: :unset) ⇒ DomainInstance
Create the DomainInstance
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 51 def create( domain_name: nil, friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset, emergency_calling_enabled: :unset, secure: :unset, byoc_trunk_sid: :unset, emergency_caller_sid: :unset ) data = Twilio::Values.of({ 'DomainName' => domain_name, 'FriendlyName' => friendly_name, 'VoiceUrl' => voice_url, 'VoiceMethod' => voice_method, 'VoiceFallbackUrl' => voice_fallback_url, 'VoiceFallbackMethod' => voice_fallback_method, 'VoiceStatusCallbackUrl' => voice_status_callback_url, 'VoiceStatusCallbackMethod' => voice_status_callback_method, 'SipRegistration' => sip_registration, 'EmergencyCallingEnabled' => emergency_calling_enabled, 'Secure' => secure, 'ByocTrunkSid' => byoc_trunk_sid, 'EmergencyCallerSid' => emergency_caller_sid, }) payload = @version.create('POST', @uri, data: data) DomainInstance.new( @version, payload, account_sid: @solution[:account_sid], ) end |
#each ⇒ Object
When passed a block, yields DomainInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
134 135 136 137 138 139 140 141 142 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 134 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 DomainInstance records from the API. Request is executed immediately.
168 169 170 171 172 173 174 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 168 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) DomainPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists DomainInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
103 104 105 106 107 108 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 103 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 DomainInstance records from the API. Request is executed immediately.
151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 151 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) DomainPage.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.
121 122 123 124 125 126 127 128 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 121 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
179 180 181 |
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb', line 179 def to_s '#<Twilio.Api.V2010.DomainList>' end |