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

Parameters:

  • version (Version) —

    Version that contains the resource

  • fleet_sid (String) (defaults to: nil) —

    Specifies the unique string identifier of the Fleet that the given Device belongs to.



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

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.

Parameters:

  • unique_name (String) (defaults to: :unset) —

    Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long.

  • friendly_name (String) (defaults to: :unset) —

    Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.

  • identity (String) (defaults to: :unset) —

    Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.

  • deployment_sid (String) (defaults to: :unset) —

    Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.

  • enabled (Boolean) (defaults to: :unset) —

    The enabled

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# 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.



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 116

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of DeviceInstance



157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 157

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.

Parameters:

  • deployment_sid (String) (defaults to: :unset) —

    Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



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

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.

Parameters:

  • deployment_sid (String) (defaults to: :unset) —

    Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of DeviceInstance



137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 137

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.

Parameters:

  • deployment_sid (String) (defaults to: :unset) —

    Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



101
102
103
104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 101

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



167
168
169
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 167

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