Class: Twilio::REST::Preview::DeployedDevices::FleetContext::CertificateList

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

Initialize the CertificateList

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 Certificate credential belongs to.



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

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

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

Instance Method Details

#create(certificate_data: nil, friendly_name: :unset, device_sid: :unset) ⇒ CertificateInstance

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

Parameters:

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

    Provides a URL encoded representation of the public certificate in PEM format.

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

    Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.

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

    Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.

Returns:



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

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

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

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

#each ⇒ Object

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



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 110

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CertificateInstance



151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 151

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

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

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

Parameters:

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

    Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.

  • 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



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

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

Parameters:

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

    Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.

  • 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 CertificateInstance



131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 131

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
  )
  CertificatePage.new(@version, response, @solution)
end

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

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

Parameters:

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

    Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.

  • 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



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 95

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



161
162
163
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 161

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