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

Parameters:

  • version (Version) —

    Version that contains the resource



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

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

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

Parameters:

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

    A 34 character string that uniquely identifies the Add-on to be installed.

  • accept_terms_of_service (Boolean) (defaults to: nil) —

    A boolean that reflects your decision whether to accept the Terms of Service

  • configuration (Hash) (defaults to: :unset) —

    The JSON object representing the configuration of the new Add-on installation.

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

    The human-readable string that uniquely identifies this Add-on installation for an Account.

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# 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.



93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 93

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of InstalledAddOnInstance



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

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.

Parameters:

  • 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



66
67
68
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 66

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.

Parameters:

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



110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 110

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
  )
  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.

Parameters:

  • 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



81
82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on.rb', line 81

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/preview/marketplace/installed_add_on.rb', line 139

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