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 SID of the [Account](www.twilio.com/docs/iam/api/account) that created the UsageTrigger resource to fetch.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the UsageTrigger resource to fetch.



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

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

Delete the TriggerInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



280
281
282
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 280

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

#fetch ⇒ TriggerInstance

Fetch the TriggerInstance

Returns:



250
251
252
253
254
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 250

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



293
294
295
296
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 293

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

#to_s ⇒ Object

Provide a user friendly representation



286
287
288
289
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 286

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 we should use to call ‘callback_url`. Can be: `GET` or `POST` and the default is `POST`.

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

    The URL we should call using ‘callback_method` when the trigger fires.

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

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Returns:



265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 265

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