Class: Twilio::REST::Trunking::V1::TrunkContext::CredentialListList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, trunk_sid: nil) ⇒ CredentialListList

Initialize the CredentialListList



21
22
23
24
25
26
27
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 21

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

  # Path Solution
  @solution = {trunk_sid: trunk_sid}
  @uri = "/Trunks/#{@solution[:trunk_sid]}/CredentialLists"
end

Instance Method Details

#create(credential_list_sid: nil) ⇒ CredentialListInstance

Create the CredentialListInstance



36
37
38
39
40
41
42
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 36

def create(credential_list_sid: nil)
  data = Twilio::Values.of({'CredentialListSid' => credential_list_sid, })

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

  CredentialListInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
end

#each ⇒ Object

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



82
83
84
85
86
87
88
89
90
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 82

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



116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 116

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

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

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



55
56
57
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 55

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



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 99

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)

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

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

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



70
71
72
73
74
75
76
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 70

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



126
127
128
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 126

def to_s
  '#<Twilio.Trunking.V1.CredentialListList>'
end