Class: Twilio::REST::Intelligence::V2::TranscriptList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ TranscriptList

Initialize the TranscriptList

Parameters:

  • version (Version) —

    Version that contains the resource



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

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Transcripts"
    
end

Instance Method Details

#create(service_sid: nil, channel: nil, customer_key: :unset, media_start_time: :unset) ⇒ TranscriptInstance

Create the TranscriptInstance

Parameters:

  • service_sid (String) (defaults to: nil) —

    The unique SID identifier of the Service.

  • channel (Object) (defaults to: nil) —

    JSON object describing Media Channel including Source and Participants

  • customer_key (String) (defaults to: :unset) —

    Used to store client provided metadata. Maximum of 64 double-byte UTF8 characters.

  • media_start_time (Time) (defaults to: :unset) —

    The date that this Transcript’s media was started, given in ISO 8601 format.

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 41

def create(
    service_sid: nil, 
    channel: nil, 
    customer_key: :unset, 
    media_start_time: :unset
)

    data = Twilio::Values.of({
        'ServiceSid' => service_sid,
        'Channel' => Twilio.serialize_object(channel),
        'CustomerKey' => customer_key,
        'MediaStartTime' => Twilio.serialize_iso8601_datetime(media_start_time),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    TranscriptInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(service_sid: nil, channel: nil, customer_key: :unset, media_start_time: :unset) ⇒ TranscriptInstance

Create the TranscriptInstanceMetadata

Parameters:

  • service_sid (String) (defaults to: nil) —

    The unique SID identifier of the Service.

  • channel (Object) (defaults to: nil) —

    JSON object describing Media Channel including Source and Participants

  • customer_key (String) (defaults to: :unset) —

    Used to store client provided metadata. Maximum of 64 double-byte UTF8 characters.

  • media_start_time (Time) (defaults to: :unset) —

    The date that this Transcript’s media was started, given in ISO 8601 format.

Returns:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 75

def create_with_metadata(
  service_sid: nil, 
  channel: nil, 
  customer_key: :unset, 
  media_start_time: :unset
)

    data = Twilio::Values.of({
        'ServiceSid' => service_sid,
        'Channel' => Twilio.serialize_object(channel),
        'CustomerKey' => customer_key,
        'MediaStartTime' => Twilio.serialize_iso8601_datetime(media_start_time),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    transcript_instance = TranscriptInstance.new(
        @version,
        response.body,
    )
    TranscriptInstanceMetadata.new(
        @version,
        transcript_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



221
222
223
224
225
226
227
228
229
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 221

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of TranscriptInstance



274
275
276
277
278
279
280
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 274

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

#list(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • service_sid (String) (defaults to: :unset) —

    The unique SID identifier of the Service.

  • before_start_time (String) (defaults to: :unset) —

    Filter by before StartTime.

  • after_start_time (String) (defaults to: :unset) —

    Filter by after StartTime.

  • before_date_created (String) (defaults to: :unset) —

    Filter by before DateCreated.

  • after_date_created (String) (defaults to: :unset) —

    Filter by after DateCreated.

  • status (String) (defaults to: :unset) —

    Filter by status.

  • language_code (String) (defaults to: :unset) —

    Filter by Language Code.

  • source_sid (String) (defaults to: :unset) —

    Filter by SourceSid.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



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

def list(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :unset, limit: nil, page_size: nil)
    self.stream(
        service_sid: service_sid,
        before_start_time: before_start_time,
        after_start_time: after_start_time,
        before_date_created: before_date_created,
        after_date_created: after_date_created,
        status: status,
        language_code: language_code,
        source_sid: source_sid,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 196

def list_with_metadata(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'ServiceSid' => service_sid,
        'BeforeStartTime' => before_start_time,
        'AfterStartTime' => after_start_time,
        'BeforeDateCreated' => before_date_created,
        'AfterDateCreated' => after_date_created,
        'Status' => status,
        'LanguageCode' => language_code,
        'SourceSid' => source_sid,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

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

#page(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • service_sid (String) (defaults to: :unset) —

    The unique SID identifier of the Service.

  • before_start_time (String) (defaults to: :unset) —

    Filter by before StartTime.

  • after_start_time (String) (defaults to: :unset) —

    Filter by after StartTime.

  • before_date_created (String) (defaults to: :unset) —

    Filter by before DateCreated.

  • after_date_created (String) (defaults to: :unset) —

    Filter by after DateCreated.

  • status (String) (defaults to: :unset) —

    Filter by status.

  • language_code (String) (defaults to: :unset) —

    Filter by Language Code.

  • source_sid (String) (defaults to: :unset) —

    Filter by SourceSid.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of TranscriptInstance



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 246

def page(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'ServiceSid' => service_sid,
        'BeforeStartTime' => before_start_time,
        'AfterStartTime' => after_start_time,
        'BeforeDateCreated' => before_date_created,
        'AfterDateCreated' => after_date_created,
        'Status' => status,
        'LanguageCode' => language_code,
        'SourceSid' => source_sid,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :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.

Parameters:

  • service_sid (String) (defaults to: :unset) —

    The unique SID identifier of the Service.

  • before_start_time (String) (defaults to: :unset) —

    Filter by before StartTime.

  • after_start_time (String) (defaults to: :unset) —

    Filter by after StartTime.

  • before_date_created (String) (defaults to: :unset) —

    Filter by before DateCreated.

  • after_date_created (String) (defaults to: :unset) —

    Filter by after DateCreated.

  • status (String) (defaults to: :unset) —

    Filter by status.

  • language_code (String) (defaults to: :unset) —

    Filter by Language Code.

  • source_sid (String) (defaults to: :unset) —

    Filter by SourceSid.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 162

def stream(service_sid: :unset, before_start_time: :unset, after_start_time: :unset, before_date_created: :unset, after_date_created: :unset, status: :unset, language_code: :unset, source_sid: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        service_sid: service_sid,
        before_start_time: before_start_time,
        after_start_time: after_start_time,
        before_date_created: before_date_created,
        after_date_created: after_date_created,
        status: status,
        language_code: language_code,
        source_sid: source_sid,
        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



285
286
287
 
# File 'lib/twilio-ruby/rest/intelligence/v2/transcript.rb', line 285

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