Class: Twilio::REST::Api::V2010::AccountList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ AccountList

Initialize the AccountList



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 26

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/Accounts.json"
    
end

Instance Method Details

#create(friendly_name: :unset) ⇒ AccountInstance

Create the AccountInstance



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 37

def create(
    friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    AccountInstance.new(
        @version,
        payload,
    )
end

#each ⇒ Object

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



109
110
111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 109

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



150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 150

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

#list(friendly_name: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

Lists AccountInstance 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
78
79
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 72

def list(friendly_name: :unset, status: :unset, limit: nil, page_size: nil)
    self.stream(
        friendly_name: friendly_name,
        status: status,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(friendly_name: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 128

def page(friendly_name: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Status' => status,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

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

#stream(friendly_name: :unset, status: :unset, 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.



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 94

def stream(friendly_name: :unset, status: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        friendly_name: friendly_name,
        status: status,
        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



161
162
163
 
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 161

def to_s
    '#<Twilio.Api.V2010.AccountList>'
end