Class: Twilio::REST::Api::V2010::AccountContext::IncomingPhoneNumberContext::AssignedAddOnList

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, resource_sid: nil) ⇒ AssignedAddOnList

Initialize the AssignedAddOnList



24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 24

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

  # Path Solution
  @solution = {account_sid: , resource_sid: resource_sid}
  @uri = "/Accounts/#{@solution[:account_sid]}/IncomingPhoneNumbers/#{@solution[:resource_sid]}/AssignedAddOns.json"
end

Instance Method Details

#create(installed_add_on_sid: nil) ⇒ AssignedAddOnInstance

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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 120

def create(installed_add_on_sid: nil)
  data = Twilio::Values.of({'InstalledAddOnSid' => installed_add_on_sid, })

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

  AssignedAddOnInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      resource_sid: @solution[:resource_sid],
  )
end

#each ⇒ Object

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



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

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



106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 106

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

#list(limit: nil, page_size: nil) ⇒ Array

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



43
44
45
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 43

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



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

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
  )
  AssignedAddOnPage.new(@version, response, @solution)
end

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

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



58
59
60
61
62
63
64
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb', line 58

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



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

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