Class: Twilio::REST::Accounts::V1::CredentialList::PublicKeyList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ PublicKeyList

Initialize the PublicKeyList

Parameters:

  • version (Version) —

    Version that contains the resource



17
18
19
20
21
22
23
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 17

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Credentials/PublicKeys"
end

Instance Method Details

#create(public_key: nil, friendly_name: :unset, account_sid: :unset) ⇒ PublicKeyInstance

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

Parameters:

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

    URL encoded representation of the public key, e.g. —–BEGIN PUBLIC KEY—–MIIBIjANB.pa9xQIDAQAB—–END PUBLIC KEY—–

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

    A human readable description of this resource, up to 64 characters.

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

    The Subaccount this Credential should be associated with. Needs to be a valid Subaccount of the account issuing the request

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 124

def create(public_key: nil, friendly_name: :unset, account_sid: :unset)
  data = Twilio::Values.of({
      'PublicKey' => public_key,
      'FriendlyName' => friendly_name,
      'AccountSid' => ,
  })

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

  PublicKeyInstance.new(
      @version,
      payload,
  )
end

#each ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 68

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of PublicKeyInstance



106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 106

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

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

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

Parameters:

  • 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



36
37
38
39
40
41
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 36

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

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

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

Parameters:

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



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 87

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

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

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

Parameters:

  • 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



54
55
56
57
58
59
60
61
62
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 54

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

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



145
146
147
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/public_key.rb', line 145

def to_s
  '#<Twilio.Accounts.V1.PublicKeyList>'
end