Class: Twilio::REST::Trunking::V1::TrunkList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Trunking::V1::TrunkList
- Defined in:
- lib/twilio-ruby/rest/trunking/v1/trunk.rb
Instance Method Summary collapse
-
#create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset, transfer_caller_id: :unset) ⇒ TrunkInstance
Create the TrunkInstance.
-
#each ⇒ Object
When passed a block, yields TrunkInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of TrunkInstance records from the API.
-
#initialize(version) ⇒ TrunkList
constructor
Initialize the TrunkList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists TrunkInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TrunkInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams TrunkInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ TrunkList
Initialize the TrunkList
18 19 20 21 22 23 24 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 18 def initialize(version) super(version) # Path Solution @solution = {} @uri = "/Trunks" end |
Instance Method Details
#create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset, transfer_caller_id: :unset) ⇒ TrunkInstance
Create the TrunkInstance
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 60 def create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, transfer_mode: :unset, secure: :unset, cnam_lookup_enabled: :unset, transfer_caller_id: :unset) data = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'DomainName' => domain_name, 'DisasterRecoveryUrl' => disaster_recovery_url, 'DisasterRecoveryMethod' => disaster_recovery_method, 'TransferMode' => transfer_mode, 'Secure' => secure, 'CnamLookupEnabled' => cnam_lookup_enabled, 'TransferCallerId' => transfer_caller_id, }) payload = @version.create('POST', @uri, data: data) TrunkInstance.new(@version, payload, ) end |
#each ⇒ Object
When passed a block, yields TrunkInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
115 116 117 118 119 120 121 122 123 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 115 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 TrunkInstance records from the API. Request is executed immediately.
149 150 151 152 153 154 155 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 149 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) TrunkPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists TrunkInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
88 89 90 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 88 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 TrunkInstance records from the API. Request is executed immediately.
132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 132 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) TrunkPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams TrunkInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
103 104 105 106 107 108 109 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 103 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
159 160 161 |
# File 'lib/twilio-ruby/rest/trunking/v1/trunk.rb', line 159 def to_s '#<Twilio.Trunking.V1.TrunkList>' end |