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, PluginVersionsList, PluginVersionsPage

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.



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 168

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:



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

def fetch(
    flex_metadata: :unset
)

    
    headers = Twilio::Values.of({ 'Flex-Metadata' => flex_metadata, })
    payload = @version.fetch('GET', @uri, headers: headers)
    PluginInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



252
253
254
255
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 252

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) 


227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 227

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



245
246
247
248
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 245

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:



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/twilio-ruby/rest/flex_api/v1/plugin.rb', line 202

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

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

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