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



239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 239

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 254

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 276

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



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

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

Raises:

  • (ArgumentError) 


372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 372

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



390
391
392
393
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 390

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 306

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 337

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