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.



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 304

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_sidString

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that the trigger monitors.

Returns:



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

def 
    @properties['account_sid']
end

#api_versionString

Returns The API version used to create the resource.

Returns:

  • (String)

    The API version used to create the resource.



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

def api_version
    @properties['api_version']
end

#callback_methodString

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`.



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

def callback_method
    @properties['callback_method']
end

#callback_urlString

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.



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

def callback_url
    @properties['callback_url']
end

#contextTriggerContext

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

Returns:



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

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

#current_valueString

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

Returns:

  • (String)

    The current value of the field the trigger is watching.



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

def current_value
    @properties['current_value']
end

#date_createdTime

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

Returns:



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

def date_created
    @properties['date_created']
end

#date_firedTime

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:



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

def date_fired
    @properties['date_fired']
end

#date_updatedTime

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:



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

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the TriggerInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetchTriggerInstance

Fetch the TriggerInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the trigger.

Returns:

  • (String)

    The string that you assigned to describe the trigger.



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

def friendly_name
    @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#recurringRecurring

Returns:

  • (Recurring)


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

def recurring
    @properties['recurring']
end

#sidString

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.



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

def sid
    @properties['sid']
end

#to_sObject

Provide a user friendly representation



476
477
478
479
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 476

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

#trigger_byTriggerField

Returns:

  • (TriggerField)


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

def trigger_by
    @properties['trigger_by']
end

#trigger_valueString

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.



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

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:



461
462
463
464
465
466
467
468
469
470
471
472
# File 'lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb', line 461

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

#uriString

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

Returns:

  • (String)

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



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

def uri
    @properties['uri']
end

#usage_categoryUsageCategory

Returns:

  • (UsageCategory)


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

def usage_category
    @properties['usage_category']
end

#usage_record_uriString

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

Returns:



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

def usage_record_uri
    @properties['usage_record_uri']
end