Class: Twilio::REST::Preview::Marketplace::InstalledAddOnList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ InstalledAddOnList

Initialize the InstalledAddOnList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/InstalledAddOns"
end

Instance Method Details

#create(available_add_on_sid: nil, accept_terms_of_service: nil, configuration: :unset, unique_name: :unset) ⇒ InstalledAddOnInstance

Create the InstalledAddOnInstance



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 38

def create(available_add_on_sid: nil, accept_terms_of_service: nil, configuration: :unset, unique_name: :unset)
  data = Twilio::Values.of({
      'AvailableAddOnSid' => available_add_on_sid,
      'AcceptTermsOfService' => accept_terms_of_service,
      'Configuration' => Twilio.serialize_object(configuration),
      'UniqueName' => unique_name,
  })

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

  InstalledAddOnInstance.new(@version, payload, )
end

#each ⇒ Object

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



89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 89

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



123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 123

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

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

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



62
63
64
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 62

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



106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 106

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: params)

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

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

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



77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 77

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



133
134
135
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 133

def to_s
  '#<Twilio.Preview.Marketplace.InstalledAddOnList>'
end