Class: Twilio::REST::Api::V2010::AccountContext::UsageList::TriggerList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Api::V2010::AccountContext::UsageList::TriggerList
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb
Instance Method Summary collapse
-
#create(callback_url: nil, trigger_value: nil, usage_category: nil, callback_method: :unset, friendly_name: :unset, recurring: :unset, trigger_by: :unset) ⇒ TriggerInstance
Create the TriggerInstance.
-
#each ⇒ Object
When passed a block, yields TriggerInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of TriggerInstance records from the API.
-
#initialize(version, account_sid: nil) ⇒ TriggerList
constructor
Initialize the TriggerList.
-
#list(recurring: :unset, trigger_by: :unset, usage_category: :unset, limit: nil, page_size: nil) ⇒ Array
Lists TriggerInstance records from the API as a list.
-
#page(recurring: :unset, trigger_by: :unset, usage_category: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TriggerInstance records from the API.
-
#stream(recurring: :unset, trigger_by: :unset, usage_category: :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, account_sid: nil) ⇒ TriggerList
Initialize the TriggerList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 28 def initialize(version, account_sid: nil) super(version) # Path Solution @solution = { account_sid: account_sid } @uri = "/Accounts/#{@solution[:account_sid]}/Usage/Triggers.json" end |
Instance Method Details
#create(callback_url: nil, trigger_value: nil, usage_category: nil, callback_method: :unset, friendly_name: :unset, recurring: :unset, trigger_by: :unset) ⇒ TriggerInstance
Create the TriggerInstance
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 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 45 def create( callback_url: nil, trigger_value: nil, usage_category: nil, callback_method: :unset, friendly_name: :unset, recurring: :unset, trigger_by: :unset ) data = Twilio::Values.of({ 'CallbackUrl' => callback_url, 'TriggerValue' => trigger_value, 'UsageCategory' => usage_category, 'CallbackMethod' => callback_method, 'FriendlyName' => friendly_name, 'Recurring' => recurring, 'TriggerBy' => trigger_by, }) payload = @version.create('POST', @uri, data: data) TriggerInstance.new( @version, payload, account_sid: @solution[:account_sid], ) end |
#each ⇒ Object
When passed a block, yields TriggerInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
128 129 130 131 132 133 134 135 136 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 128 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 TriggerInstance records from the API. Request is executed immediately.
168 169 170 171 172 173 174 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 168 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) TriggerPage.new(@version, response, @solution) end |
#list(recurring: :unset, trigger_by: :unset, usage_category: :unset, limit: nil, page_size: nil) ⇒ Array
Lists TriggerInstance 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 91 92 93 94 95 96 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 88 def list(recurring: :unset, trigger_by: :unset, usage_category: :unset, limit: nil, page_size: nil) self.stream( recurring: recurring, trigger_by: trigger_by, usage_category: usage_category, limit: limit, page_size: page_size ).entries end |
#page(recurring: :unset, trigger_by: :unset, usage_category: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TriggerInstance records from the API. Request is executed immediately.
148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 148 def page(recurring: :unset, trigger_by: :unset, usage_category: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'Recurring' => recurring, 'TriggerBy' => trigger_by, 'UsageCategory' => usage_category, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) TriggerPage.new(@version, response, @solution) end |
#stream(recurring: :unset, trigger_by: :unset, usage_category: :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.
112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 112 def stream(recurring: :unset, trigger_by: :unset, usage_category: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( recurring: recurring, trigger_by: trigger_by, usage_category: usage_category, 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/usage/trigger.rb', line 179 def to_s '#<Twilio.Api.V2010.TriggerList>' end |