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

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The trunk_sid



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

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

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

Parameters:

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

    The credential_list_sid

Returns:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 33

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.



94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 94

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CredentialListInstance



132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 132

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.

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



62
63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 62

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.

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 CredentialListInstance



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

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
  )
  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.

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



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

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



142
143
144
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/credential_list.rb', line 142

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