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

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) (defaults to: nil) —

    The unique id of the Account responsible for this Caller Id.



19
20
21
22
23
24
25
26
27
 
# 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.



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

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of OutgoingCallerIdInstance



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

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.

Parameters:

  • phone_number (String) (defaults to: :unset) —

    Only show the caller id resource that exactly matches this phone number

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

    Only show the caller id resource that exactly matches this name

  • 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



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

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.

Parameters:

  • phone_number (String) (defaults to: :unset) —

    Only show the caller id resource that exactly matches this phone number

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

    Only show the caller id resource that exactly matches this name

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 107

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.

Parameters:

  • phone_number (String) (defaults to: :unset) —

    Only show the caller id resource that exactly matches this phone number

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

    Only show the caller id resource that exactly matches this name

  • 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



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

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



138
139
140
 
# File 'lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb', line 138

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