Class: Twilio::REST::Preview::DeployedDevices::FleetList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ FleetList

Initialize the FleetList



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

def initialize(version)
  super(version)

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

Instance Method Details

#create(friendly_name: :unset) ⇒ FleetInstance

Create the FleetInstance



33
34
35
36
37
38
39
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 33

def create(friendly_name: :unset)
  data = Twilio::Values.of({'FriendlyName' => friendly_name, })

  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.



79
80
81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 79

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.



113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 113

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

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



52
53
54
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 52

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



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 96

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)

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

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



67
68
69
70
71
72
73
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 67

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



123
124
125
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 123

def to_s
  '#<Twilio.Preview.DeployedDevices.FleetList>'
end