Class: Twilio::REST::Monitor::V1::EventInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/monitor/v1/event.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ EventInstance

Initialize the EventInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Event resource.

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

    The SID of the Call resource to fetch.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 423

def initialize(version, payload , sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'actor_sid' => payload['actor_sid'],
        'actor_type' => payload['actor_type'],
        'description' => payload['description'],
        'event_data' => payload['event_data'],
        'event_date' => Twilio.deserialize_iso8601_datetime(payload['event_date']),
        'event_type' => payload['event_type'],
        'resource_sid' => payload['resource_sid'],
        'resource_type' => payload['resource_type'],
        'sid' => payload['sid'],
        'source' => payload['source'],
        'source_ip_address' => payload['source_ip_address'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { '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 created the Event resource.

Returns:



463
464
465
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 463

def 
    @properties['account_sid']
end

#actor_sid ⇒ String

Returns The SID of the actor that caused the event, if available. This can be either a User ID (matching the pattern ‘^US32$`) or an Account SID (matching the pattern `^AC32$`). If the actor’s SID isn’t available, this field will be null.

Returns:

  • (String) —

    The SID of the actor that caused the event, if available. This can be either a User ID (matching the pattern ‘^US32$`) or an Account SID (matching the pattern `^AC32$`). If the actor’s SID isn’t available, this field will be null.



469
470
471
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 469

def actor_sid
    @properties['actor_sid']
end

#actor_type ⇒ String

Returns The type of actor that caused the event. Can be: user for a change made by a logged-in user in the Twilio Console, account for an event caused by an API request by an authenticating Account, twilio-admin for an event caused by a Twilio employee, and so on.

Returns:

  • (String) —

    The type of actor that caused the event. Can be: user for a change made by a logged-in user in the Twilio Console, account for an event caused by an API request by an authenticating Account, twilio-admin for an event caused by a Twilio employee, and so on.



475
476
477
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 475

def actor_type
    @properties['actor_type']
end

#context ⇒ EventContext

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

Returns:



454
455
456
457
458
459
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 454

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

#description ⇒ String

Returns A description of the event. Can be null.

Returns:

  • (String) —

    A description of the event. Can be null.



481
482
483
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 481

def description
    @properties['description']
end

#event_data ⇒ Hash

Returns An object with additional data about the event. The contents depend on event_type. For example, event-types of the form RESOURCE.updated, this value contains a resource_properties dictionary that describes the previous and updated properties of the resource.

Returns:

  • (Hash) —

    An object with additional data about the event. The contents depend on event_type. For example, event-types of the form RESOURCE.updated, this value contains a resource_properties dictionary that describes the previous and updated properties of the resource.



487
488
489
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 487

def event_data
    @properties['event_data']
end

#event_date ⇒ Time

Returns The date and time in GMT when the event was recorded specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



493
494
495
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 493

def event_date
    @properties['event_date']
end

#event_type ⇒ String

Returns The event’s type. Event-types are typically in the form: RESOURCE_TYPE.ACTION, where RESOURCE_TYPE is the type of resource that was affected and ACTION is what happened to it. For example, phone-number.created. For a full list of all event-types, see the [Monitor Event Types](www.twilio.com/docs/usage/monitor-events#event-types).

Returns:

  • (String) —

    The event’s type. Event-types are typically in the form: RESOURCE_TYPE.ACTION, where RESOURCE_TYPE is the type of resource that was affected and ACTION is what happened to it. For example, phone-number.created. For a full list of all event-types, see the [Monitor Event Types](www.twilio.com/docs/usage/monitor-events#event-types).



499
500
501
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 499

def event_type
    @properties['event_type']
end

#fetch ⇒ EventInstance

Fetch the EventInstance

Returns:



548
549
550
551
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 548

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



562
563
564
565
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 562

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

#links ⇒ Hash

Returns The absolute URLs of related resources.

Returns:

  • (Hash) —

    The absolute URLs of related resources.



541
542
543
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 541

def links
    @properties['links']
end

#resource_sid ⇒ String

Returns The SID of the resource that was affected.

Returns:

  • (String) —

    The SID of the resource that was affected.



505
506
507
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 505

def resource_sid
    @properties['resource_sid']
end

#resource_type ⇒ String

Returns The type of resource that was affected. For a full list of all resource-types, see the [Monitor Event Types](www.twilio.com/docs/usage/monitor-events#event-types).

Returns:



511
512
513
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 511

def resource_type
    @properties['resource_type']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



517
518
519
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 517

def sid
    @properties['sid']
end

#source ⇒ String

Returns The originating system or interface that caused the event. Can be: web for events caused by user action in the Twilio Console, api for events caused by a request to our API, or twilio for events caused by an automated or internal Twilio system.

Returns:

  • (String) —

    The originating system or interface that caused the event. Can be: web for events caused by user action in the Twilio Console, api for events caused by a request to our API, or twilio for events caused by an automated or internal Twilio system.



523
524
525
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 523

def source
    @properties['source']
end

#source_ip_address ⇒ String

Returns The IP address of the source, if the source is outside the Twilio cloud. This value is null for events with source of twilio.

Returns:

  • (String) —

    The IP address of the source, if the source is outside the Twilio cloud. This value is null for events with source of twilio



529
530
531
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 529

def source_ip_address
    @properties['source_ip_address']
end

#to_s ⇒ Object

Provide a user friendly representation



555
556
557
558
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 555

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

#url ⇒ String

Returns The absolute URL of the resource that was affected. Can be null.

Returns:

  • (String) —

    The absolute URL of the resource that was affected. Can be null.



535
536
537
 
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 535

def url
    @properties['url']
end