Class: Twilio::REST::Api::V2010::AccountContext::UsageList::TriggerContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ TriggerContext

Initialize the TriggerContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The account_sid

  • sid (String) —

    The usage-trigger Sid that uniquely identifies this resource



237
238
239
240
241
242
243
244
245
246
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 237

def initialize(version, , sid)
  super(version)

  # Path Solution
  @solution = {
      account_sid: ,
      sid: sid,
  }
  @uri = "/Accounts/#{@solution[:account_sid]}/Usage/Triggers/#{@solution[:sid]}.json"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the TriggerInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



301
302
303
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 301

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ TriggerInstance

Fetch a TriggerInstance

Returns:



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 251

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  TriggerInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



307
308
309
310
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 307

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

#update(callback_method: :unset, callback_url: :unset, friendly_name: :unset) ⇒ TriggerInstance

Update the TriggerInstance

Parameters:

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

    The HTTP method Twilio will use when making a request to the CallbackUrl. GET or POST.

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

    Twilio will make a request to this url when the trigger fires.

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

    A user-specified, human-readable name for the trigger.

Returns:



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 277

def update(callback_method: :unset, callback_url: :unset, friendly_name: :unset)
  data = Twilio::Values.of({
      'CallbackMethod' => callback_method,
      'CallbackUrl' => callback_url,
      'FriendlyName' => friendly_name,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  TriggerInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end