Class: Twilio::REST::Api::V2010::AccountContext::OutgoingCallerIdList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil) ⇒ OutgoingCallerIdList

Initialize the OutgoingCallerIdList



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

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

  # Path Solution
  @solution = {account_sid: }
  @uri = "/Accounts/#{@solution[:account_sid]}/OutgoingCallerIds.json"
end

Instance Method Details

#each ⇒ Object

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



82
83
84
85
86
87
88
89
90
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 82

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



124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 124

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

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

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



42
43
44
45
46
47
48
49
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 42

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

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

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 103

def page(phone_number: :unset, friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PhoneNumber' => phone_number,
      'FriendlyName' => friendly_name,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  OutgoingCallerIdPage.new(@version, response, @solution)
end

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

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



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 66

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

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



134
135
136
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 134

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