Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::EventInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, 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.



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 290

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

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

Returns:



332
333
334
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 332

def 
    @properties['account_sid']
end

#actor_sid ⇒ String

Returns The SID of the resource that triggered the event.

Returns:

  • (String) —

    The SID of the resource that triggered the event.



338
339
340
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 338

def actor_sid
    @properties['actor_sid']
end

#actor_type ⇒ String

Returns The type of resource that triggered the event.

Returns:

  • (String) —

    The type of resource that triggered the event.



344
345
346
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 344

def actor_type
    @properties['actor_type']
end

#actor_url ⇒ String

Returns The absolute URL of the resource that triggered the event.

Returns:

  • (String) —

    The absolute URL of the resource that triggered the event.



350
351
352
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 350

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



323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 323

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

#description ⇒ String

Returns A description of the event.

Returns:

  • (String) —

    A description of the event.



356
357
358
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 356

def description
    @properties['description']
end

#event_data ⇒ Hash

Returns Data about the event. For more information, see [Event types](www.twilio.com/docs/taskrouter/api/event#event-types).

Returns:



362
363
364
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 362

def event_data
    @properties['event_data']
end

#event_date ⇒ Time

Returns The time the event was sent, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



368
369
370
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 368

def event_date
    @properties['event_date']
end

#event_date_ms ⇒ String

Returns The time the event was sent in milliseconds.

Returns:

  • (String) —

    The time the event was sent in milliseconds.



374
375
376
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 374

def event_date_ms
    @properties['event_date_ms']
end

#event_type ⇒ String

Returns The identifier for the event.

Returns:

  • (String) —

    The identifier for the event.



380
381
382
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 380

def event_type
    @properties['event_type']
end

#fetch ⇒ EventInstance

Fetch the EventInstance

Returns:



435
436
437
438
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 435

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



449
450
451
452
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 449

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

#resource_sid ⇒ String

Returns The SID of the object the event is most relevant to, such as a TaskSid, ReservationSid, or a WorkerSid.

Returns:

  • (String) —

    The SID of the object the event is most relevant to, such as a TaskSid, ReservationSid, or a WorkerSid.



386
387
388
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 386

def resource_sid
    @properties['resource_sid']
end

#resource_type ⇒ String

Returns The type of object the event is most relevant to, such as a Task, Reservation, or a Worker).

Returns:

  • (String) —

    The type of object the event is most relevant to, such as a Task, Reservation, or a Worker).



392
393
394
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 392

def resource_type
    @properties['resource_type']
end

#resource_url ⇒ String

Returns The URL of the resource the event is most relevant to.

Returns:

  • (String) —

    The URL of the resource the event is most relevant to.



398
399
400
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 398

def resource_url
    @properties['resource_url']
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.



404
405
406
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 404

def sid
    @properties['sid']
end

#source ⇒ String

Returns Where the Event originated.

Returns:

  • (String) —

    Where the Event originated.



410
411
412
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 410

def source
    @properties['source']
end

#source_ip_address ⇒ String

Returns The IP from which the Event originated.

Returns:

  • (String) —

    The IP from which the Event originated.



416
417
418
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 416

def source_ip_address
    @properties['source_ip_address']
end

#to_s ⇒ Object

Provide a user friendly representation



442
443
444
445
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 442

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

#url ⇒ String

Returns The absolute URL of the Event resource.

Returns:

  • (String) —

    The absolute URL of the Event resource.



422
423
424
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 422

def url
    @properties['url']
end

#workspace_sid ⇒ String

Returns The SID of the Workspace that contains the Event.

Returns:

  • (String) —

    The SID of the Workspace that contains the Event.



428
429
430
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 428

def workspace_sid
    @properties['workspace_sid']
end