Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::BundleContext::EvaluationList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Numbers::V2::RegulatoryComplianceList::BundleContext::EvaluationList
- Defined in:
- lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb
Instance Method Summary collapse
-
#create ⇒ EvaluationInstance
Create the EvaluationInstance.
-
#each ⇒ Object
When passed a block, yields EvaluationInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of EvaluationInstance records from the API.
-
#initialize(version, bundle_sid: nil) ⇒ EvaluationList
constructor
Initialize the EvaluationList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists EvaluationInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of EvaluationInstance 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, bundle_sid: nil) ⇒ EvaluationList
Initialize the EvaluationList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 28 def initialize(version, bundle_sid: nil) super(version) # Path Solution @solution = { bundle_sid: bundle_sid } @uri = "/RegulatoryCompliance/Bundles/#{@solution[:bundle_sid]}/Evaluations" end |
Instance Method Details
#create ⇒ EvaluationInstance
Create the EvaluationInstance
38 39 40 41 42 43 44 45 46 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 38 def create payload = @version.create('POST', @uri) EvaluationInstance.new( @version, payload, bundle_sid: @solution[:bundle_sid], ) end |
#each ⇒ Object
When passed a block, yields EvaluationInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
91 92 93 94 95 96 97 98 99 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 91 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 EvaluationInstance records from the API. Request is executed immediately.
125 126 127 128 129 130 131 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 125 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) EvaluationPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists EvaluationInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
60 61 62 63 64 65 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 60 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 EvaluationInstance records from the API. Request is executed immediately.
108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 108 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) EvaluationPage.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.
78 79 80 81 82 83 84 85 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 78 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
136 137 138 |
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 136 def to_s '#<Twilio.Numbers.V2.EvaluationList>' end |