Class: Twilio::REST::Intelligence::V3::ConversationList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ConversationList

Initialize the ConversationList

Parameters:

  • version (Version) —

    Version that contains the resource



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

def initialize(version)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    # Path Solution
    @solution = {  }
    @uri = "/Conversations"
    
end

Instance Method Details

#each ⇒ Object

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



161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/intelligence/v3/conversation.rb', line 161

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ConversationInstance



219
220
221
222
223
224
225
 
# File 'lib/twilio-ruby/rest/intelligence/v3/conversation.rb', line 219

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

#list(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    Token for pagination

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

    Filter by Conversations created before this timestamp.

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

    Filter by Conversations created after this timestamp.

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

    Filter by Conversation status.

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

    Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.

  • channels (Array[String]) (defaults to: :unset) —

    Filters Conversations that include one or more of the specified communication channels (‘OR` match).

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

    The configuration ‘id` used to generate the Conversation.

  • intelligence_configuration_ids (Array[String]) (defaults to: :unset) —

    Filters Conversations activated by one or more of the specified Intelligence Configuration IDs (‘OR` match).

  • operator_ids (Array[String]) (defaults to: :unset) —

    Filters Conversations to those where at least one of the specified Language Operators was executed (‘OR` match).

  • 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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/twilio-ruby/rest/intelligence/v3/conversation.rb', line 56

def list(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :unset, limit: nil, page_size: nil)
    self.stream(
        page_token: page_token,
        created_at_before: created_at_before,
        created_at_after: created_at_after,
        status: status,
        channel_id: channel_id,
        channels: channels,
        conversation_configuration_id: conversation_configuration_id,
        intelligence_configuration_ids: intelligence_configuration_ids,
        operator_ids: operator_ids,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/intelligence/v3/conversation.rb', line 132

def list_with_metadata(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'pageToken' => page_token,
        'createdAtBefore' =>  Twilio.serialize_iso8601_datetime(created_at_before),
        'createdAtAfter' =>  Twilio.serialize_iso8601_datetime(created_at_after),
        'status' => status,
        'channelId' => channel_id,
        
        'channels' =>  Twilio.serialize_list(channels) { |e| e },
        'conversationConfigurationId' => conversation_configuration_id,
        
        'intelligenceConfigurationIds' =>  Twilio.serialize_list(intelligence_configuration_ids) { |e| e },
        
        'operatorIds' =>  Twilio.serialize_list(operator_ids) { |e| e },
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

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

#page(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :unset, page_size: :unset) ⇒ Page

Returns Page of ConversationInstance.

Returns:

  • (Page) —

    Page of ConversationInstance



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/twilio-ruby/rest/intelligence/v3/conversation.rb', line 189

def page(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'pageToken' => page_token,
        'createdAtBefore' =>  Twilio.serialize_iso8601_datetime(created_at_before),
        'createdAtAfter' =>  Twilio.serialize_iso8601_datetime(created_at_after),
        'status' => status,
        'channelId' => channel_id,
        
        'channels' =>  Twilio.serialize_list(channels) { |e| e },
        'conversationConfigurationId' => conversation_configuration_id,
        
        'intelligenceConfigurationIds' =>  Twilio.serialize_list(intelligence_configuration_ids) { |e| e },
        
        'operatorIds' =>  Twilio.serialize_list(operator_ids) { |e| e },
                                    'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :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:

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

    Token for pagination

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

    Filter by Conversations created before this timestamp.

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

    Filter by Conversations created after this timestamp.

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

    Filter by Conversation status.

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

    Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.

  • channels (Array[String]) (defaults to: :unset) —

    Filters Conversations that include one or more of the specified communication channels (‘OR` match).

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

    The configuration ‘id` used to generate the Conversation.

  • intelligence_configuration_ids (Array[String]) (defaults to: :unset) —

    Filters Conversations activated by one or more of the specified Intelligence Configuration IDs (‘OR` match).

  • operator_ids (Array[String]) (defaults to: :unset) —

    Filters Conversations to those where at least one of the specified Language Operators was executed (‘OR` match).

  • 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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/intelligence/v3/conversation.rb', line 92

def stream(page_token: :unset, created_at_before: :unset, created_at_after: :unset, status: :unset, channel_id: :unset, channels: :unset, conversation_configuration_id: :unset, intelligence_configuration_ids: :unset, operator_ids: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        page_token: page_token,
        created_at_before: created_at_before,
        created_at_after: created_at_after,
        status: status,
        channel_id: channel_id,
        channels: channels,
        conversation_configuration_id: conversation_configuration_id,
        intelligence_configuration_ids: intelligence_configuration_ids,
        operator_ids: operator_ids,
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



230
231
232
 
# File 'lib/twilio-ruby/rest/intelligence/v3/conversation.rb', line 230

def to_s
    '#<Twilio.Intelligence.V3.ConversationList>'
end