Class: Twilio::REST::Supersim::V1::SmsCommandList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Supersim::V1::SmsCommandList
- Defined in:
- lib/twilio-ruby/rest/supersim/v1/sms_command.rb
Instance Method Summary collapse
-
#create(sim: nil, payload: nil, callback_method: :unset, callback_url: :unset) ⇒ SmsCommandInstance
Create the SmsCommandInstance.
-
#each ⇒ Object
When passed a block, yields SmsCommandInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of SmsCommandInstance records from the API.
-
#initialize(version) ⇒ SmsCommandList
constructor
Initialize the SmsCommandList.
-
#list(sim: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Array
Lists SmsCommandInstance records from the API as a list.
-
#page(sim: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of SmsCommandInstance records from the API.
-
#stream(sim: :unset, status: :unset, direction: :unset, 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) ⇒ SmsCommandList
Initialize the SmsCommandList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/supersim/v1/sms_command.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/SmsCommands" end |
Instance Method Details
#create(sim: nil, payload: nil, callback_method: :unset, callback_url: :unset) ⇒ SmsCommandInstance
Create the SmsCommandInstance
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/twilio-ruby/rest/supersim/v1/sms_command.rb', line 39 def create( sim: nil, payload: nil, callback_method: :unset, callback_url: :unset ) data = Twilio::Values.of({ 'Sim' => sim, 'Payload' => payload, 'CallbackMethod' => callback_method, 'CallbackUrl' => callback_url, }) payload = @version.create('POST', @uri, data: data) SmsCommandInstance.new( @version, payload, ) end |
#each ⇒ Object
When passed a block, yields SmsCommandInstance 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/supersim/v1/sms_command.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 SmsCommandInstance records from the API. Request is executed immediately.
159 160 161 162 163 164 165 |
# File 'lib/twilio-ruby/rest/supersim/v1/sms_command.rb', line 159 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) SmsCommandPage.new(@version, response, @solution) end |
#list(sim: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Array
Lists SmsCommandInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
75 76 77 78 79 80 81 82 83 |
# File 'lib/twilio-ruby/rest/supersim/v1/sms_command.rb', line 75 def list(sim: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) self.stream( sim: sim, status: status, direction: direction, limit: limit, page_size: page_size ).entries end |
#page(sim: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of SmsCommandInstance records from the API. Request is executed immediately.
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/twilio-ruby/rest/supersim/v1/sms_command.rb', line 135 def page(sim: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Sim' => sim, 'Status' => status, 'Direction' => direction, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) SmsCommandPage.new(@version, response, @solution) end |
#stream(sim: :unset, status: :unset, direction: :unset, 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.
99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/twilio-ruby/rest/supersim/v1/sms_command.rb', line 99 def stream(sim: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( sim: sim, status: status, direction: direction, 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
170 171 172 |
# File 'lib/twilio-ruby/rest/supersim/v1/sms_command.rb', line 170 def to_s '#<Twilio.Supersim.V1.SmsCommandList>' end |