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) —

    The SID of the Account that created this Trigger resource.

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

    The SID of the Call resource to fetch.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 313

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 SID of the [Account](www.twilio.com/docs/iam/api/account) that the trigger monitors.

Returns:



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

def 
    @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to create the resource.

Returns:

  • (String) —

    The API version used to create the resource.



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

def api_version
    @properties['api_version']
end

#callback_method ⇒ String

Returns The HTTP method we use to call ‘callback_url`. Can be: `GET` or `POST`.

Returns:

  • (String) —

    The HTTP method we use to call ‘callback_url`. Can be: `GET` or `POST`.



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

def callback_method
    @properties['callback_method']
end

#callback_url ⇒ String

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

Returns:

  • (String) —

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



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

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:



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

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.



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

def current_value
    @properties['current_value']
end

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_fired ⇒ Time

Returns The date and time in GMT that the trigger was last fired specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_fired
    @properties['date_fired']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TriggerInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ TriggerInstance

Fetch the TriggerInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the trigger.

Returns:

  • (String) —

    The string that you assigned to describe the trigger.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



492
493
494
495
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 492

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

#recurring ⇒ Recurring

Returns:

  • (Recurring) 


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

def recurring
    @properties['recurring']
end

#sid ⇒ String

Returns The unique string that that we created to identify the UsageTrigger resource.

Returns:

  • (String) —

    The unique string that that we created to identify the UsageTrigger resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



485
486
487
488
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 485

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

#trigger_by ⇒ TriggerField

Returns:

  • (TriggerField) 


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

def trigger_by
    @properties['trigger_by']
end

#trigger_value ⇒ String

Returns The value at which the trigger will fire. Must be a positive, numeric value.

Returns:

  • (String) —

    The value at which the trigger will fire. Must be a positive, numeric value.



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

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 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:



470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 470

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 of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`.



432
433
434
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 432

def uri
    @properties['uri']
end

#usage_category ⇒ UsageCategory

Returns:

  • (UsageCategory) 


438
439
440
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 438

def usage_category
    @properties['usage_category']
end

#usage_record_uri ⇒ String

Returns The URI of the [UsageRecord](www.twilio.com/docs/usage/api/usage-record) resource this trigger watches, relative to ‘api.twilio.com`.

Returns:



444
445
446
 
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 444

def usage_record_uri
    @properties['usage_record_uri']
end