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

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/supersim/v1/fleet.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ FleetList

Initialize the FleetList



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

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, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_enabled: :unset, sms_commands_url: :unset, sms_commands_method: :unset) ⇒ FleetInstance

Create the FleetInstance



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 46

def create(
  network_access_profile: nil, 
  unique_name: :unset, 
  data_enabled: :unset, 
  data_limit: :unset, 
  ip_commands_url: :unset, 
  ip_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,
        'IpCommandsUrl' => ip_commands_url,
        'IpCommandsMethod' => ip_commands_method,
        'SmsCommandsEnabled' => sms_commands_enabled,
        'SmsCommandsUrl' => sms_commands_url,
        'SmsCommandsMethod' => sms_commands_method,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    FleetInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(network_access_profile: nil, unique_name: :unset, data_enabled: :unset, data_limit: :unset, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_enabled: :unset, sms_commands_url: :unset, sms_commands_method: :unset) ⇒ FleetInstance

Create the FleetInstanceMetadata



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 95

def create_with_metadata(
  network_access_profile: nil, 
  unique_name: :unset, 
  data_enabled: :unset, 
  data_limit: :unset, 
  ip_commands_url: :unset, 
  ip_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,
        'IpCommandsUrl' => ip_commands_url,
        'IpCommandsMethod' => ip_commands_method,
        'SmsCommandsEnabled' => sms_commands_enabled,
        'SmsCommandsUrl' => sms_commands_url,
        'SmsCommandsMethod' => sms_commands_method,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    fleet_instance = FleetInstance.new(
        @version,
        response.body,
    )
    FleetInstanceMetadata.new(
        @version,
        fleet_instance,
        response.headers,
        response.status_code
    )
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.



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 213

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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



256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 256

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.



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

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

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



195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 195

def list_with_metadata(network_access_profile: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'NetworkAccessProfile' => network_access_profile,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    FleetPageMetadata.new(@version, response, @solution, limits[:limit])
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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 235

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,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(network_access_profile: :unset, 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.



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 171

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], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



267
268
269
 
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 267

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