Class: Twilio::REST::FlexApi::V1::PluginConfigurationContext::ConfiguredPluginList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, configuration_sid: nil) ⇒ ConfiguredPluginList

Initialize the ConfiguredPluginList



28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 28

def initialize(version, configuration_sid: nil)
    super(version)
    # Path Solution
    @solution = { configuration_sid: configuration_sid }
    @uri = "/PluginService/Configurations/#{@solution[:configuration_sid]}/Plugins"
    
end

Instance Method Details

#each ⇒ Object

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



82
83
84
85
86
87
88
89
90
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 82

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



118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 118

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

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

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



48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 48

def list(flex_metadata: :unset, limit: nil, page_size: nil)
    self.stream(
        flex_metadata: flex_metadata,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(flex_metadata: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 100

def page(flex_metadata: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'Flex-Metadata' => flex_metadata,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

    response = @version.page('GET', @uri, params: params)

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

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

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



68
69
70
71
72
73
74
75
76
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 68

def stream(flex_metadata: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        flex_metadata: flex_metadata,
        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



129
130
131
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 129

def to_s
    '#<Twilio.FlexApi.V1.ConfiguredPluginList>'
end