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

Parameters:

  • version (Version)

    Version that contains the resource


18
19
20
21
22
23
24
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Accounts.json"
end

Instance Method Details

#create(friendly_name: :unset) ⇒ AccountInstance

Create the AccountInstance

Parameters:

  • friendly_name (String) (defaults to: :unset)

    A human readable description of the account to create, defaults to `SubAccount Created at HH:MM meridian`

Returns:


31
32
33
34
35
36
37
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 31

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

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

  AccountInstance.new(@version, payload, )
end

#eachObject

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


90
91
92
93
94
95
96
97
98
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 90

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.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of AccountInstance


130
131
132
133
134
135
136
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 130

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.

Parameters:

  • friendly_name (String) (defaults to: :unset)

    Only return the Account resources with friendly names that exactly match this name.

  • status (account.Status) (defaults to: :unset)

    Only return Account resources with the given status. Can be `closed`, `suspended` or `active`.

  • 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


54
55
56
57
58
59
60
61
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 54

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.

Parameters:

  • friendly_name (String) (defaults to: :unset)

    Only return the Account resources with friendly names that exactly match this name.

  • status (account.Status) (defaults to: :unset)

    Only return Account resources with the given status. Can be `closed`, `suspended` or `active`.

  • 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 AccountInstance


111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 111

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,
  })

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

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

#stream(friendly_name: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • friendly_name (String) (defaults to: :unset)

    Only return the Account resources with friendly names that exactly match this name.

  • status (account.Status) (defaults to: :unset)

    Only return Account resources with the given status. Can be `closed`, `suspended` or `active`.

  • 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


78
79
80
81
82
83
84
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 78

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_sObject

Provide a user friendly representation


140
141
142
# File 'lib/twilio-ruby/rest/api/v2010/account.rb', line 140

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