Class: Twilio::REST::Preview::DeployedDevices::FleetContext::KeyList

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

Initialize the KeyList



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

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

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

Instance Method Details

#create(friendly_name: :unset, device_sid: :unset) ⇒ KeyInstance

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 39

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

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

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

#each ⇒ Object

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



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

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



132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 132

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

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

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



64
65
66
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 64

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

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

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 112

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

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

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



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

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

  page = self.page(device_sid: device_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



142
143
144
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 142

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