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

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/plugin.rb,
lib/twilio-ruby/rest/flex_api/v1/plugin/plugin_versions.rb

Defined Under Namespace

Classes: PluginVersionsContext, PluginVersionsInstance, PluginVersionsInstanceMetadata, PluginVersionsList, PluginVersionsListResponse, PluginVersionsPage, PluginVersionsPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ PluginContext

Initialize the PluginContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The SID of the Flex Plugin resource to update.



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 247

def initialize(version, sid)
    super(version)
    

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/PluginService/Plugins/#{@solution[:sid]}"

    # Dependents
    @plugin_versions = nil
end

Instance Method Details

#fetch(flex_metadata: :unset) ⇒ PluginInstance

Fetch the PluginInstance

Parameters:

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

    The Flex-Metadata HTTP request header

Returns:



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 262

def fetch(
  flex_metadata: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Flex-Metadata' => flex_metadata, })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    PluginInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#fetch_with_metadata(flex_metadata: :unset) ⇒ PluginInstance

Fetch the PluginInstanceMetadata

Parameters:

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

    The Flex-Metadata HTTP request header

Returns:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 284

def fetch_with_metadata(
  flex_metadata: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Flex-Metadata' => flex_metadata, })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    plugin_instance = PluginInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    PluginInstanceMetadata.new(
        @version,
        plugin_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



405
406
407
408
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 405

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.FlexApi.V1.PluginContext #{context}>"
end

#plugin_versions(sid = :unset) ⇒ PluginVersionsList, PluginVersionsContext

Access the plugin_versions

Returns:

Raises:

  • (ArgumentError) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 380

def plugin_versions(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return PluginVersionsContext.new(@version, @solution[:sid],sid )
    end

    unless @plugin_versions
        @plugin_versions = PluginVersionsList.new(
            @version, plugin_sid: @solution[:sid], )
    end

 @plugin_versions
end

#to_s ⇒ Object

Provide a user friendly representation



398
399
400
401
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 398

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.FlexApi.V1.PluginContext #{context}>"
end

#update(friendly_name: :unset, description: :unset, flex_metadata: :unset) ⇒ PluginInstance

Update the PluginInstance

Parameters:

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

    The Flex Plugin’s friendly name.

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

    A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long

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

    The Flex-Metadata HTTP request header

Returns:



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 314

def update(
  friendly_name: :unset, 
  description: :unset, 
  flex_metadata: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Description' => description,
    })

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

#update_with_metadata(friendly_name: :unset, description: :unset, flex_metadata: :unset) ⇒ PluginInstance

Update the PluginInstanceMetadata

Parameters:

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

    The Flex Plugin’s friendly name.

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

    A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long

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

    The Flex-Metadata HTTP request header

Returns:



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 345

def update_with_metadata(
  friendly_name: :unset, 
  description: :unset, 
  flex_metadata: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Description' => description,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'Flex-Metadata' => flex_metadata, })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    plugin_instance = PluginInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    PluginInstanceMetadata.new(
        @version,
        plugin_instance,
        response.headers,
        response.status_code
    )
end