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

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

Defined Under Namespace

Classes: ConfiguredPluginContext, ConfiguredPluginInstance, ConfiguredPluginInstanceMetadata, ConfiguredPluginList, ConfiguredPluginListResponse, ConfiguredPluginPage, ConfiguredPluginPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ PluginConfigurationContext

Initialize the PluginConfigurationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The SID of the Flex Plugin Configuration resource to fetch.



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

def initialize(version, sid)
    super(version)
    

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

    # Dependents
    @plugins = nil
end

Instance Method Details

#fetch(flex_metadata: :unset) ⇒ PluginConfigurationInstance

Fetch the PluginConfigurationInstance

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_configuration.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)
    PluginConfigurationInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#fetch_with_metadata(flex_metadata: :unset) ⇒ PluginConfigurationInstance

Fetch the PluginConfigurationInstanceMetadata

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_configuration.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_configuration_instance = PluginConfigurationInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    PluginConfigurationInstanceMetadata.new(
        @version,
        plugin_configuration_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



337
338
339
340
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration.rb', line 337

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

#plugins(plugin_sid = :unset) ⇒ ConfiguredPluginList, ConfiguredPluginContext

Access the plugins

Returns:

Raises:

  • (ArgumentError) 


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration.rb', line 312

def plugins(plugin_sid=:unset)

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

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

    unless @plugins
        @plugins = ConfiguredPluginList.new(
            @version, configuration_sid: @solution[:sid], )
    end

 @plugins
end

#to_s ⇒ Object

Provide a user friendly representation



330
331
332
333
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration.rb', line 330

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