Class: Twilio::REST::Wireless::V1::SimContext::DataSessionList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sim_sid: nil) ⇒ DataSessionList

Initialize the DataSessionList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 22

def initialize(version, sim_sid: nil)
  super(version)

  # Path Solution
  @solution = {sim_sid: sim_sid}
  @uri = "/Sims/#{@solution[:sim_sid]}/DataSessions"
end

Instance Method Details

#each ⇒ Object

When passed a block, yields DataSessionInstance 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/wireless/v1/sim/data_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 DataSessionInstance records from the API. Request is executed immediately.



118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 118

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

#list(end_: :unset, start: :unset, limit: nil, page_size: nil) ⇒ Array

Lists DataSessionInstance 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
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 45

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

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

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 97

def page(end_: :unset, start: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'End' => Twilio.serialize_iso8601_datetime(end_),
      'Start' => Twilio.serialize_iso8601_datetime(start),
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  DataSessionPage.new(@version, response, @solution)
end

#stream(end_: :unset, start: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



64
65
66
67
68
69
70
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 64

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

  page = self.page(end_: end_, start: start, 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



128
129
130
 
# File 'lib/twilio-ruby/rest/wireless/v1/sim/data_session.rb', line 128

def to_s
  '#<Twilio.Wireless.V1.DataSessionList>'
end