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

Inherits:
InstanceContext
  • 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, plugin_sid) ⇒ ConfiguredPluginContext

Initialize the ConfiguredPluginContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • configuration_sid (String) —

    The SID of the Flex Plugin Configuration the resource to belongs to.

  • plugin_sid (String) —

    The unique string that we created to identify the Flex Plugin resource.



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 170

def initialize(version, configuration_sid, plugin_sid)
    super(version)
    

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

    
end

Instance Method Details

#fetch(flex_metadata: :unset) ⇒ ConfiguredPluginInstance

Fetch the ConfiguredPluginInstance

Parameters:

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

    The Flex-Metadata HTTP request header

Returns:



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 184

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)
    ConfiguredPluginInstance.new(
        @version,
        payload,
        configuration_sid: @solution[:configuration_sid],
        plugin_sid: @solution[:plugin_sid],
    )
end

#fetch_with_metadata(flex_metadata: :unset) ⇒ ConfiguredPluginInstance

Fetch the ConfiguredPluginInstanceMetadata

Parameters:

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

    The Flex-Metadata HTTP request header

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 207

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)
    configured_plugin_instance = ConfiguredPluginInstance.new(
        @version,
        response.body,
        configuration_sid: @solution[:configuration_sid],
        plugin_sid: @solution[:plugin_sid],
    )
    ConfiguredPluginInstanceMetadata.new(
        @version,
        configured_plugin_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



242
243
244
245
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 242

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

#to_s ⇒ Object

Provide a user friendly representation



235
236
237
238
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin_configuration/configured_plugin.rb', line 235

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