Class: Twilio::REST::Preview::DeployedDevices::FleetContext::DeviceList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.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, fleet_sid: nil) ⇒ DeviceList

Initialize the DeviceList



23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 23

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

  # Path Solution
  @solution = {fleet_sid: fleet_sid}
  @uri = "/Fleets/#{@solution[:fleet_sid]}/Devices"
end

Instance Method Details

#create(unique_name: :unset, friendly_name: :unset, identity: :unset, deployment_sid: :unset, enabled: :unset) ⇒ DeviceInstance

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 45

def create(unique_name: :unset, friendly_name: :unset, identity: :unset, deployment_sid: :unset, enabled: :unset)
  data = Twilio::Values.of({
      'UniqueName' => unique_name,
      'FriendlyName' => friendly_name,
      'Identity' => identity,
      'DeploymentSid' => deployment_sid,
      'Enabled' => enabled,
  })

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

  DeviceInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], )
end

#each ⇒ Object

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



105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 105

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



144
145
146
147
148
149
150
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 144

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

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

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



76
77
78
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 76

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

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

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 124

def page(deployment_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'DeploymentSid' => deployment_sid,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  DevicePage.new(@version, response, @solution)
end

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

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



93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 93

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

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



154
155
156
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 154

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