class Twilio::REST::Preview::DeployedDevices::FleetContext::CertificateList

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 help@twilio.com.

Public Class Methods

new(version, fleet_sid: nil) click to toggle source

Initialize the CertificateList @param [Version] version Version that contains the resource @param [String] fleet_sid Specifies the unique string identifier of the Fleet

that the given Certificate credential belongs to.

@return [CertificateList] CertificateList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb
23 def initialize(version, fleet_sid: nil)
24   super(version)
25 
26   # Path Solution
27   @solution = {fleet_sid: fleet_sid}
28   @uri = "/Fleets/#{@solution[:fleet_sid]}/Certificates"
29 end

Public Instance Methods

create(certificate_data: nil, friendly_name: :unset, device_sid: :unset) click to toggle source

Create the CertificateInstance @param [String] certificate_data Provides a URL encoded representation of the

public certificate in PEM format.

@param [String] friendly_name Provides a human readable descriptive text for

this Certificate credential, up to 256 characters long.

@param [String] device_sid Provides the unique string identifier of an existing

Device to become authenticated with this Certificate credential.

@return [CertificateInstance] Created CertificateInstance

   # File lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb
40 def create(certificate_data: nil, friendly_name: :unset, device_sid: :unset)
41   data = Twilio::Values.of({
42       'CertificateData' => certificate_data,
43       'FriendlyName' => friendly_name,
44       'DeviceSid' => device_sid,
45   })
46 
47   payload = @version.create('POST', @uri, data: data)
48 
49   CertificateInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], )
50 end
each() { |x| ... } click to toggle source

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

    # File lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb
 94 def each
 95   limits = @version.read_limits
 96 
 97   page = self.page(page_size: limits[:page_size], )
 98 
 99   @version.stream(page,
100                   limit: limits[:limit],
101                   page_limit: limits[:page_limit]).each {|x| yield x}
102 end
get_page(target_url) click to toggle source

Retrieve a single page of CertificateInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of CertificateInstance

    # File lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb
131 def get_page(target_url)
132   response = @version.domain.request(
133       'GET',
134       target_url
135   )
136   CertificatePage.new(@version, response, @solution)
137 end
list(device_sid: :unset, limit: nil, page_size: nil) click to toggle source

Lists CertificateInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [String] device_sid Filters the resulting list of Certificates by a

unique string identifier of an authenticated Device.

@param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size 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)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb
65 def list(device_sid: :unset, limit: nil, page_size: nil)
66   self.stream(device_sid: device_sid, limit: limit, page_size: page_size).entries
67 end
page(device_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of CertificateInstance records from the API. Request is executed immediately. @param [String] device_sid Filters the resulting list of Certificates by a

unique string identifier of an authenticated Device.

@param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of CertificateInstance

    # File lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb
113 def page(device_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
114   params = Twilio::Values.of({
115       'DeviceSid' => device_sid,
116       'PageToken' => page_token,
117       'Page' => page_number,
118       'PageSize' => page_size,
119   })
120 
121   response = @version.page('GET', @uri, params: params)
122 
123   CertificatePage.new(@version, response, @solution)
124 end
stream(device_sid: :unset, limit: nil, page_size: nil) click to toggle source

Streams CertificateInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [String] device_sid Filters the resulting list of Certificates by a

unique string identifier of an authenticated Device.

@param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size 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)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb
82 def stream(device_sid: :unset, limit: nil, page_size: nil)
83   limits = @version.read_limits(limit, page_size)
84 
85   page = self.page(device_sid: device_sid, page_size: limits[:page_size], )
86 
87   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
88 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb
141 def to_s
142   '#<Twilio.Preview.DeployedDevices.CertificateList>'
143 end