Class: Twilio::REST::Intelligence::V2::TranscriptContext::SentenceList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, transcript_sid: nil) ⇒ SentenceList

Initialize the SentenceList



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

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

Instance Method Details

#each ⇒ Object

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



113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb', line 113

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



154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb', line 154

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

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

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



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

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

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb', line 94

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

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

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

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

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb', line 132

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

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

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

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



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb', line 72

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

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



165
166
167
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb', line 165

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