Class: Twilio::REST::Supersim::V1::FleetList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/supersim/v1/fleet.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) ⇒ FleetList

Initialize the FleetList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Fleets"
end

Instance Method Details

#create(network_access_profile: nil, unique_name: :unset, data_enabled: :unset, data_limit: :unset, commands_enabled: :unset, commands_url: :unset, commands_method: :unset, sms_commands_enabled: :unset, sms_commands_url: :unset, sms_commands_method: :unset) ⇒ FleetInstance

Create the FleetInstance



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 63

def create(network_access_profile: nil, unique_name: :unset, data_enabled: :unset, data_limit: :unset, commands_enabled: :unset, commands_url: :unset, commands_method: :unset, sms_commands_enabled: :unset, sms_commands_url: :unset, sms_commands_method: :unset)
  data = Twilio::Values.of({
      'NetworkAccessProfile' => network_access_profile,
      'UniqueName' => unique_name,
      'DataEnabled' => data_enabled,
      'DataLimit' => data_limit,
      'CommandsEnabled' => commands_enabled,
      'CommandsUrl' => commands_url,
      'CommandsMethod' => commands_method,
      'SmsCommandsEnabled' => sms_commands_enabled,
      'SmsCommandsUrl' => sms_commands_url,
      'SmsCommandsMethod' => sms_commands_method,
  })

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

  FleetInstance.new(@version, payload, )
end

#each ⇒ Object

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



130
131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 130

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



168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 168

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

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

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



96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 96

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

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

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



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 150

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

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

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

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

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



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

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

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



178
179
180
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 178

def to_s
  '#<Twilio.Supersim.V1.FleetList>'
end