Class: Twilio::REST::Preview::Marketplace::InstalledAddOnContext::InstalledAddOnExtensionList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.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, installed_add_on_sid: nil) ⇒ InstalledAddOnExtensionList

Initialize the InstalledAddOnExtensionList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The installed_add_on_sid



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

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

  # Path Solution
  @solution = {
      installed_add_on_sid: installed_add_on_sid
  }
  @uri = "/InstalledAddOns/#{@solution[:installed_add_on_sid]}/Extensions"
end

Instance Method Details

#each ⇒ Object

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



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

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of InstalledAddOnExtensionInstance



111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 111

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

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

Lists InstalledAddOnExtensionInstance 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



41
42
43
44
45
46
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 41

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 InstalledAddOnExtensionInstance 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 InstalledAddOnExtensionInstance



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

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

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

Streams InstalledAddOnExtensionInstance 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



59
60
61
62
63
64
65
66
67
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 59

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



121
122
123
 
# File 'lib/twilio-ruby/rest/preview/marketplace/installed_add_on/installed_add_on_extension.rb', line 121

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