Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::BundleContext::EvaluationList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, bundle_sid: nil) ⇒ EvaluationList

Initialize the EvaluationList



29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 29

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 39

def create

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.create('POST', @uri, headers: headers)
    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.



94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 94

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.



128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 128

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.



63
64
65
66
67
68
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 63

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.



111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 111

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.



81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 81

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



139
140
141
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/evaluation.rb', line 139

def to_s
    '#<Twilio.Numbers.V2.EvaluationList>'
end