Class: Twilio::REST::Assistants::V1::SessionList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SessionList

Initialize the SessionList



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

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

Instance Method Details

#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.



76
77
78
79
80
81
82
83
84
 
# File 'lib/twilio-ruby/rest/assistants/v1/session.rb', line 76

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.



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

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.



45
46
47
48
49
50
 
# File 'lib/twilio-ruby/rest/assistants/v1/session.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 SessionInstance records from the API. Request is executed immediately.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/assistants/v1/session.rb', line 93

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

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

    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.



63
64
65
66
67
68
69
70
 
# File 'lib/twilio-ruby/rest/assistants/v1/session.rb', line 63

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



124
125
126
 
# File 'lib/twilio-ruby/rest/assistants/v1/session.rb', line 124

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