Class: Twilio::REST::Proxy::V1::ServiceContext::PhoneNumberList

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ PhoneNumberList

Initialize the PhoneNumberList



23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 23

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

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

Instance Method Details

#create(sid: :unset, phone_number: :unset, is_reserved: :unset) ⇒ PhoneNumberInstance

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



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 45

def create(sid: :unset, phone_number: :unset, is_reserved: :unset)
  data = Twilio::Values.of({'Sid' => sid, 'PhoneNumber' => phone_number, 'IsReserved' => is_reserved, })

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

  PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_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.



95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 95

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.



131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 131

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.



68
69
70
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 68

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.



112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 112

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.



83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 83

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



141
142
143
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 141

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