Class: Twilio::REST::Trunking::V1::TrunkContext::PhoneNumberList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, trunk_sid: nil) ⇒ PhoneNumberList

Initialize the PhoneNumberList



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

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

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

Instance Method Details

#create(phone_number_sid: nil) ⇒ PhoneNumberInstance

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



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/phone_number.rb', line 33

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

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

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

#each ⇒ Object

When passed a block, yields PhoneNumberInstance 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/phone_number.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 PhoneNumberInstance records from the API. Request is executed immediately.



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

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

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

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



62
63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.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 PhoneNumberInstance records from the API. Request is executed immediately.



113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.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
  )
  PhoneNumberPage.new(@version, response, @solution)
end

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

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



80
81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.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/phone_number.rb', line 142

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