Class: Twilio::REST::Voice::V1::ByocTrunkList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Voice::V1::ByocTrunkList
- Defined in:
- lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb
Instance Method Summary collapse
-
#create(friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, cnam_lookup_enabled: :unset, connection_policy_sid: :unset, from_domain_sid: :unset) ⇒ ByocTrunkInstance
Create the ByocTrunkInstance.
-
#each ⇒ Object
When passed a block, yields ByocTrunkInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of ByocTrunkInstance records from the API.
-
#initialize(version) ⇒ ByocTrunkList
constructor
Initialize the ByocTrunkList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists ByocTrunkInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of ByocTrunkInstance 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) ⇒ ByocTrunkList
Initialize the ByocTrunkList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/ByocTrunks" end |
Instance Method Details
#create(friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, cnam_lookup_enabled: :unset, connection_policy_sid: :unset, from_domain_sid: :unset) ⇒ ByocTrunkInstance
Create the ByocTrunkInstance
45 46 47 48 49 50 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 |
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 45 def create( friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, status_callback_url: :unset, status_callback_method: :unset, cnam_lookup_enabled: :unset, connection_policy_sid: :unset, from_domain_sid: :unset ) data = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'VoiceUrl' => voice_url, 'VoiceMethod' => voice_method, 'VoiceFallbackUrl' => voice_fallback_url, 'VoiceFallbackMethod' => voice_fallback_method, 'StatusCallbackUrl' => status_callback_url, 'StatusCallbackMethod' => status_callback_method, 'CnamLookupEnabled' => cnam_lookup_enabled, 'ConnectionPolicySid' => connection_policy_sid, 'FromDomainSid' => from_domain_sid, }) payload = @version.create('POST', @uri, data: data) ByocTrunkInstance.new( @version, payload, ) end |
#each ⇒ Object
When passed a block, yields ByocTrunkInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
121 122 123 124 125 126 127 128 129 |
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 121 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 ByocTrunkInstance records from the API. Request is executed immediately.
155 156 157 158 159 160 161 |
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 155 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ByocTrunkPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists ByocTrunkInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
90 91 92 93 94 95 |
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 90 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 ByocTrunkInstance records from the API. Request is executed immediately.
138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 138 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) ByocTrunkPage.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.
108 109 110 111 112 113 114 115 |
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 108 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
166 167 168 |
# File 'lib/twilio-ruby/rest/voice/v1/byoc_trunk.rb', line 166 def to_s '#<Twilio.Voice.V1.ByocTrunkList>' end |