Class: Twilio::REST::Api::V2010::AccountContext::SigningKeyList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/signing_key.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ SigningKeyList

Initialize the SigningKeyList



21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 21

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

  # Path Solution
  @solution = {account_sid: }
  @uri = "/Accounts/#{@solution[:account_sid]}/SigningKeys.json"
end

Instance Method Details

#each ⇒ Object

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



67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 67

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



101
102
103
104
105
106
107
 
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 101

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

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

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



40
41
42
 
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 40

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



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 84

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

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

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

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



55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 55

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



111
112
113
 
# File 'lib/twilio-ruby/rest/api/v2010/account/signing_key.rb', line 111

def to_s
  '#<Twilio.Api.V2010.SigningKeyList>'
end