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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, fleet_sid: nil) ⇒ KeyList

Initialize the KeyList



28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 28

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

Create the KeyInstance



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 40

def create(
    friendly_name: :unset, 
    device_sid: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    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.



107
108
109
110
111
112
113
114
115
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 107

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.



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

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.



73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 73

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.



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

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: params)

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

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



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

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



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

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