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
 
# 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.



86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb', line 86

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.



127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb', line 127

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.



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

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

#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.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb', line 105

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.



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

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



138
139
140
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript/sentence.rb', line 138

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