Class: Twilio::REST::Proxy::V1::ServiceContext::SessionContext::InteractionList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, session_sid: nil) ⇒ InteractionList

Initialize the InteractionList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The unique SID identifier of the Service.

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

    The unique SID identifier of the Session.



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 22

def initialize(version, service_sid: nil, session_sid: nil)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, session_sid: session_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Interactions"
end

Instance Method Details

#each ⇒ Object

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



97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 97

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of InteractionInstance



145
146
147
148
149
150
151
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 145

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

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

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

Parameters:

  • inbound_participant_status (interaction.ResourceStatus) (defaults to: :unset) —

    The Inbound Participant Status of this Interaction. One of ‘accepted`, `answered`, `busy`, `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`, `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.

  • outbound_participant_status (interaction.ResourceStatus) (defaults to: :unset) —

    The Outbound Participant Status of this Interaction. One of ‘accepted`, `answered`, `busy`, `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`, `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.

  • 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



51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 51

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

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

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

Parameters:

  • inbound_participant_status (interaction.ResourceStatus) (defaults to: :unset) —

    The Inbound Participant Status of this Interaction. One of ‘accepted`, `answered`, `busy`, `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`, `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.

  • outbound_participant_status (interaction.ResourceStatus) (defaults to: :unset) —

    The Outbound Participant Status of this Interaction. One of ‘accepted`, `answered`, `busy`, `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`, `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.

  • 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 InteractionInstance



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 124

def page(inbound_participant_status: :unset, outbound_participant_status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'InboundParticipantStatus' => inbound_participant_status,
      'OutboundParticipantStatus' => outbound_participant_status,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  InteractionPage.new(@version, response, @solution)
end

#stream(inbound_participant_status: :unset, outbound_participant_status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams InteractionInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • inbound_participant_status (interaction.ResourceStatus) (defaults to: :unset) —

    The Inbound Participant Status of this Interaction. One of ‘accepted`, `answered`, `busy`, `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`, `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.

  • outbound_participant_status (interaction.ResourceStatus) (defaults to: :unset) —

    The Outbound Participant Status of this Interaction. One of ‘accepted`, `answered`, `busy`, `canceled`, `completed`, `deleted`, `delivered`, `delivery-unknown`, `failed`, `in-progress`, `initiated`, `no-answer`, `queued`, `received`, `receiving`, `ringing`, `scheduled`, `sending`, `sent`, `undelivered` or `unknown`.

  • 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



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 81

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

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



155
156
157
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb', line 155

def to_s
  '#<Twilio.Proxy.V1.InteractionList>'
end