Class: Twilio::REST::FlexApi::V1::PluginContext::PluginVersionsList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, plugin_sid: nil) ⇒ PluginVersionsList

Initialize the PluginVersionsList

Parameters:

  • version (Version) —

    Version that contains the resource



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

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

Instance Method Details

#create(version: nil, plugin_url: nil, changelog: :unset, private: :unset, cli_version: :unset, validate_status: :unset, flex_metadata: :unset) ⇒ PluginVersionsInstance

Create the PluginVersionsInstance

Parameters:

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

    The Flex Plugin Version’s version.

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

    The URL of the Flex Plugin Version bundle

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

    The changelog of the Flex Plugin Version.

  • private (Boolean) (defaults to: :unset) —

    Whether this Flex Plugin Version requires authorization.

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

    The version of Flex Plugins CLI used to create this plugin

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

    The validation status of the plugin, indicating whether it has been validated

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

    The Flex-Metadata HTTP request header

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb', line 46

def create(
    version: nil, 
    plugin_url: nil, 
    changelog: :unset, 
    private: :unset, 
    cli_version: :unset, 
    validate_status: :unset, 
    flex_metadata: :unset
)

    data = Twilio::Values.of({
        'Version' => version,
        'PluginUrl' => plugin_url,
        'Changelog' => changelog,
        'Private' => private,
        'CliVersion' => cli_version,
        'ValidateStatus' => validate_status,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Flex-Metadata' => flex_metadata, })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    PluginVersionsInstance.new(
        @version,
        payload,
        plugin_sid: @solution[:plugin_sid],
    )
end

#create_with_metadata(version: nil, plugin_url: nil, changelog: :unset, private: :unset, cli_version: :unset, validate_status: :unset, flex_metadata: :unset) ⇒ PluginVersionsInstance

Create the PluginVersionsInstanceMetadata

Parameters:

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

    The Flex Plugin Version’s version.

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

    The URL of the Flex Plugin Version bundle

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

    The changelog of the Flex Plugin Version.

  • private (Boolean) (defaults to: :unset) —

    Whether this Flex Plugin Version requires authorization.

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

    The version of Flex Plugins CLI used to create this plugin

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

    The validation status of the plugin, indicating whether it has been validated

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

    The Flex-Metadata HTTP request header

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb', line 89

def create_with_metadata(
  version: nil, 
  plugin_url: nil, 
  changelog: :unset, 
  private: :unset, 
  cli_version: :unset, 
  validate_status: :unset, 
  flex_metadata: :unset
)

    data = Twilio::Values.of({
        'Version' => version,
        'PluginUrl' => plugin_url,
        'Changelog' => changelog,
        'Private' => private,
        'CliVersion' => cli_version,
        'ValidateStatus' => validate_status,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Flex-Metadata' => flex_metadata, })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    plugin_versions_instance = PluginVersionsInstance.new(
        @version,
        response.body,
        plugin_sid: @solution[:plugin_sid],
    )
    PluginVersionsInstanceMetadata.new(
        @version,
        plugin_versions_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



199
200
201
202
203
204
205
206
207
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb', line 199

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of PluginVersionsInstance



238
239
240
241
242
243
244
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb', line 238

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

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

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

Parameters:

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

    The Flex-Metadata HTTP request header

  • 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



141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb', line 141

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

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

Returns Array of up to limit results.

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



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb', line 181

def list_with_metadata(flex_metadata: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Flex-Metadata' => flex_metadata,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    PluginVersionsPageMetadata.new(@version, response, @solution, limits[:limit])
end

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

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

Parameters:

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

    The Flex-Metadata HTTP request header

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb', line 217

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,
    })
    headers = Twilio::Values.of({})
    
    

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

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

Parameters:

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

    The Flex-Metadata HTTP request header

  • 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



161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb', line 161

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



249
250
251
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb', line 249

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