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

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/proxy/v1/service/session/participant.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) ⇒ ParticipantList

Initialize the ParticipantList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The SID of the resource's parent Service resource.

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

    The SID of the parent Session resource.


26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 26

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]}/Participants"
end

Instance Method Details

#create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset, fail_on_participant_conflict: :unset) ⇒ ParticipantInstance

Create the ParticipantInstance

Parameters:

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

    The phone number of the Participant.

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

    The string that you assigned to describe the participant. This value must be 255 characters or fewer. **This value should not have PII.**

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

    The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool.

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

    The SID of the Proxy Identifier to assign to the Participant.

  • fail_on_participant_conflict (Boolean) (defaults to: :unset) —
    Experimental

    For accounts with

    the ProxyAllowParticipantConflict account flag, setting to true enables per-request opt-in to allowing Proxy to reject a Participant create request that could cause the same Identifier/ProxyIdentifier pair to be active in multiple Sessions. Depending on the context, this could be a 409 error (Twilio error code 80623) or a 400 error (Twilio error code 80604). If not provided, requests will be allowed to succeed and a Debugger notification (80802) will be emitted. Having multiple, active Participants with the same Identifier/ProxyIdentifier pair causes calls and messages from affected Participants to be routed incorrectly. Please note, the default behavior for accounts without the ProxyAllowParticipantConflict flag is to reject the request as described. This will eventually be the default for all accounts.

Returns:


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 137

def create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset, fail_on_participant_conflict: :unset)
  data = Twilio::Values.of({
      'Identifier' => identifier,
      'FriendlyName' => friendly_name,
      'ProxyIdentifier' => proxy_identifier,
      'ProxyIdentifierSid' => proxy_identifier_sid,
      'FailOnParticipantConflict' => fail_on_participant_conflict,
  })

  payload = @version.create('POST', @uri, data: data)

  ParticipantInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      session_sid: @solution[:session_sid],
  )
end

#each ⇒ Object

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


72
73
74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 72

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ParticipantInstance


106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 106

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

#list(limit: nil, page_size: nil) ⇒ Array

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

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


45
46
47
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 45

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

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

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

Parameters:

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


89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 89

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

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

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

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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

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:

  • (Enumerable) —

    Enumerable that will yield up to limit results


60
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 60

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

  page = self.page(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


158
159
160
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb', line 158

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