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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ TriggerInstance

Initialize the TriggerInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil) —

    A 34 character string that uniquely identifies this resource.

  • sid (String) (defaults to: nil) —

    The usage-trigger Sid that uniquely identifies this resource



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 297

def initialize(version, payload, account_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'api_version' => payload['api_version'],
      'callback_method' => payload['callback_method'],
      'callback_url' => payload['callback_url'],
      'current_value' => payload['current_value'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_fired' => Twilio.deserialize_rfc2822(payload['date_fired']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'recurring' => payload['recurring'],
      'sid' => payload['sid'],
      'trigger_by' => payload['trigger_by'],
      'trigger_value' => payload['trigger_value'],
      'uri' => payload['uri'],
      'usage_category' => payload['usage_category'],
      'usage_record_uri' => payload['usage_record_uri'],
  }

  # Context
  @instance_context = nil
  @params = {'account_sid' => , 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The account this trigger monitors.

Returns:

  • (String) —

    The account this trigger monitors.



338
339
340
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 338

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The api_version.

Returns:

  • (String) —

    The api_version



344
345
346
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 344

def api_version
  @properties['api_version']
end

#callback_method ⇒ String

Returns HTTP method to use with callback_url.

Returns:

  • (String) —

    HTTP method to use with callback_url



350
351
352
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 350

def callback_method
  @properties['callback_method']
end

#callback_url ⇒ String

Returns URL Twilio will request when the trigger fires.

Returns:

  • (String) —

    URL Twilio will request when the trigger fires



356
357
358
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 356

def callback_url
  @properties['callback_url']
end

#context ⇒ TriggerContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 329

def context
  unless @instance_context
    @instance_context = TriggerContext.new(@version, @params['account_sid'], @params['sid'], )
  end
  @instance_context
end

#current_value ⇒ String

Returns The current value of the field the trigger is watching.

Returns:

  • (String) —

    The current value of the field the trigger is watching.



362
363
364
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 362

def current_value
  @properties['current_value']
end

#date_created ⇒ Time

Returns The date this resource was created.

Returns:

  • (Time) —

    The date this resource was created



368
369
370
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 368

def date_created
  @properties['date_created']
end

#date_fired ⇒ Time

Returns The date the trigger was last fired.

Returns:

  • (Time) —

    The date the trigger was last fired



374
375
376
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 374

def date_fired
  @properties['date_fired']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



380
381
382
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 380

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TriggerInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



459
460
461
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 459

def delete
  context.delete
end

#fetch ⇒ TriggerInstance

Fetch a TriggerInstance

Returns:



435
436
437
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 435

def fetch
  context.fetch
end

#friendly_name ⇒ String

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

Returns:

  • (String) —

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



386
387
388
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 386

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



472
473
474
475
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 472

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.TriggerInstance #{values}>"
end

#recurring ⇒ trigger.Recurring

Returns How this trigger recurs.

Returns:

  • (trigger.Recurring) —

    How this trigger recurs



392
393
394
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 392

def recurring
  @properties['recurring']
end

#sid ⇒ String

Returns The trigger’s unique Sid.

Returns:

  • (String) —

    The trigger’s unique Sid



398
399
400
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 398

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



465
466
467
468
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 465

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.TriggerInstance #{values}>"
end

#trigger_by ⇒ trigger.TriggerField

Returns The field in the UsageRecord that fires the trigger.

Returns:

  • (trigger.TriggerField) —

    The field in the UsageRecord that fires the trigger



404
405
406
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 404

def trigger_by
  @properties['trigger_by']
end

#trigger_value ⇒ String

Returns the value at which the trigger will fire.

Returns:

  • (String) —

    the value at which the trigger will fire



410
411
412
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 410

def trigger_value
  @properties['trigger_value']
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:



448
449
450
451
452
453
454
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 448

def update(callback_method: :unset, callback_url: :unset, friendly_name: :unset)
  context.update(
      callback_method: callback_method,
      callback_url: callback_url,
      friendly_name: friendly_name,
  )
end

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



416
417
418
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 416

def uri
  @properties['uri']
end

#usage_category ⇒ trigger.UsageCategory

Returns The usage category the trigger watches.

Returns:

  • (trigger.UsageCategory) —

    The usage category the trigger watches



422
423
424
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 422

def usage_category
  @properties['usage_category']
end

#usage_record_uri ⇒ String

Returns The URI of the UsageRecord this trigger is watching.

Returns:

  • (String) —

    The URI of the UsageRecord this trigger is watching



428
429
430
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 428

def usage_record_uri
  @properties['usage_record_uri']
end