Class: Twilio::REST::Intelligence::V2::TranscriptContext::OperatorResultList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, transcript_sid: nil) ⇒ OperatorResultList

Initialize the OperatorResultList



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 28

def initialize(version, transcript_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { transcript_sid: transcript_sid }
    @uri = "/Transcripts/#{@solution[:transcript_sid]}/OperatorResults"
    
end

Instance Method Details

#each ⇒ Object

When passed a block, yields OperatorResultInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



107
108
109
110
111
112
113
114
115
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 107

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 OperatorResultInstance records from the API. Request is executed immediately.



146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 146

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
OperatorResultPage.new(@version, response, @solution)
end

#list(redacted: :unset, limit: nil, page_size: nil) ⇒ Array

Lists OperatorResultInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.



49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 49

def list(redacted: :unset, limit: nil, page_size: nil)
    self.stream(
        redacted: redacted,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(redacted: :unset, limit: nil, page_size: nil) ⇒ Array 



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 89

def list_with_metadata(redacted: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Redacted' => redacted,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    OperatorResultPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(redacted: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of OperatorResultInstance records from the API. Request is executed immediately.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 125

def page(redacted: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'Redacted' => redacted,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    OperatorResultPage.new(@version, response, @solution)
end

#stream(redacted: :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.



69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 69

def stream(redacted: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        redacted: redacted,
        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



157
158
159
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/operator_result.rb', line 157

def to_s
    '#<Twilio.Intelligence.V2.OperatorResultList>'
end