Class: Twilio::REST::Proxy::V1::ServiceContext::SessionList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ SessionList

Initialize the SessionList

Parameters:

  • version (Version) —

    Version that contains the resource



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

def initialize(version, service_sid: nil)
    super(version)
    # Path Solution
    @solution = { service_sid: service_sid }
    @uri = "/Services/#{@solution[:service_sid]}/Sessions"
    
end

Instance Method Details

#create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset) ⇒ SessionInstance

Create the SessionInstance

Parameters:

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

    An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**

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

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the ‘ttl` value.

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

    The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session’s last Interaction.

  • mode (Mode) (defaults to: :unset)
  • status (Status) (defaults to: :unset)
  • participants (Array[Hash]) (defaults to: :unset) —

    The Participant objects to include in the new session.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 43

def create(
    unique_name: :unset, 
    date_expiry: :unset, 
    ttl: :unset, 
    mode: :unset, 
    status: :unset, 
    participants: :unset
)

    data = Twilio::Values.of({
        'UniqueName' => unique_name,
        'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
        'Ttl' => ttl,
        'Mode' => mode,
        'Status' => status,
        'Participants' => Twilio.serialize_list(participants) { |e| Twilio.serialize_object(e) },
    })

    payload = @version.create('POST', @uri, data: data)
    SessionInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
    )
end

#each ⇒ Object

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



112
113
114
115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 112

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of SessionInstance



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

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

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

Lists SessionInstance 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



81
82
83
84
85
86
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 81

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 SessionInstance 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 SessionInstance



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/session.rb', line 129

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)

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

#stream(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:

  • 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



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

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



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

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