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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ PhoneNumberList

Initialize the PhoneNumberList



27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 27

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

Create the PhoneNumberInstance



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 40

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.



103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 103

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.



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

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.



72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 72

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.



120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 120

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)

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

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

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



90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 90

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



149
150
151
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 149

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