Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskContext::ReservationInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, task_sid: nil, sid: nil) ⇒ ReservationInstance

Initialize the ReservationInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The ID of the Workspace that this task is contained within.

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

    The ID of the reserved Task

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

    The sid



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 341

def initialize(version, payload, workspace_sid: nil, task_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'reservation_status' => payload['reservation_status'],
      'sid' => payload['sid'],
      'task_sid' => payload['task_sid'],
      'worker_name' => payload['worker_name'],
      'worker_sid' => payload['worker_sid'],
      'workspace_sid' => payload['workspace_sid'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The ID of the Account that owns this Task.

Returns:

  • (String) —

    The ID of the Account that owns this Task



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

def 
  @properties['account_sid']
end

#context ⇒ ReservationContext

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

Returns:



372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 372

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ ReservationInstance

Fetch a ReservationInstance

Returns:



453
454
455
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 453

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



577
578
579
580
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 577

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



446
447
448
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 446

def links
  @properties['links']
end

#reservation_status ⇒ reservation.Status

Returns The current status of the reservation.

Returns:

  • (reservation.Status) —

    The current status of the reservation.



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

def reservation_status
  @properties['reservation_status']
end

#sid ⇒ String

Returns The unique ID of this Reservation.

Returns:

  • (String) —

    The unique ID of this Reservation.



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

def sid
  @properties['sid']
end

#task_sid ⇒ String

Returns The ID of the reserved Task.

Returns:

  • (String) —

    The ID of the reserved Task



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

def task_sid
  @properties['task_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



570
571
572
573
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 570

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

#update(reservation_status: :unset, worker_activity_sid: :unset, instruction: :unset, dequeue_post_work_activity_sid: :unset, dequeue_from: :unset, dequeue_record: :unset, dequeue_timeout: :unset, dequeue_to: :unset, dequeue_status_callback_url: :unset, call_from: :unset, call_record: :unset, call_timeout: :unset, call_to: :unset, call_url: :unset, call_status_callback_url: :unset, call_accept: :unset, redirect_call_sid: :unset, redirect_accept: :unset, redirect_url: :unset, to: :unset, from: :unset, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, conference_record: :unset, conference_trim: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, region: :unset, sip_auth_username: :unset, sip_auth_password: :unset, dequeue_status_callback_event: :unset, post_work_activity_sid: :unset) ⇒ ReservationInstance

Update the ReservationInstance

Parameters:

  • reservation_status (reservation.Status) (defaults to: :unset) —

    Yes

  • worker_activity_sid (String) (defaults to: :unset) —

    No

  • instruction (String) (defaults to: :unset) —

    Yes

  • dequeue_post_work_activity_sid (String) (defaults to: :unset) —

    No

  • dequeue_from (String) (defaults to: :unset) —

    Yes

  • dequeue_record (String) (defaults to: :unset) —

    No

  • dequeue_timeout (String) (defaults to: :unset) —

    No

  • dequeue_to (String) (defaults to: :unset) —

    No

  • dequeue_status_callback_url (String) (defaults to: :unset) —

    No

  • call_from (String) (defaults to: :unset) —

    Yes

  • call_record (String) (defaults to: :unset) —

    No

  • call_timeout (String) (defaults to: :unset) —

    No

  • call_to (String) (defaults to: :unset) —

    No

  • call_url (String) (defaults to: :unset) —

    Yes

  • call_status_callback_url (String) (defaults to: :unset) —

    No

  • call_accept (Boolean) (defaults to: :unset) —

    No

  • redirect_call_sid (String) (defaults to: :unset) —

    Yes

  • redirect_accept (Boolean) (defaults to: :unset) —

    No

  • redirect_url (String) (defaults to: :unset) —

    Yes

  • to (String) (defaults to: :unset) —

    No

  • from (String) (defaults to: :unset) —

    No

  • status_callback (String) (defaults to: :unset) —

    The status_callback

  • status_callback_method (String) (defaults to: :unset) —

    The status_callback_method

  • status_callback_event (reservation.CallStatus) (defaults to: :unset) —

    The status_callback_event

  • timeout (String) (defaults to: :unset) —

    No

  • record (Boolean) (defaults to: :unset) —

    The record

  • muted (Boolean) (defaults to: :unset) —

    The muted

  • beep (String) (defaults to: :unset) —

    The beep

  • start_conference_on_enter (Boolean) (defaults to: :unset) —

    The start_conference_on_enter

  • end_conference_on_exit (Boolean) (defaults to: :unset) —

    The end_conference_on_exit

  • wait_url (String) (defaults to: :unset) —

    The wait_url

  • wait_method (String) (defaults to: :unset) —

    The wait_method

  • early_media (Boolean) (defaults to: :unset) —

    The early_media

  • max_participants (String) (defaults to: :unset) —

    The max_participants

  • conference_status_callback (String) (defaults to: :unset) —

    The conference_status_callback

  • conference_status_callback_method (String) (defaults to: :unset) —

    The conference_status_callback_method

  • conference_status_callback_event (reservation.ConferenceEvent) (defaults to: :unset) —

    The conference_status_callback_event

  • conference_record (String) (defaults to: :unset) —

    The conference_record

  • conference_trim (String) (defaults to: :unset) —

    The conference_trim

  • recording_channels (String) (defaults to: :unset) —

    The recording_channels

  • recording_status_callback (String) (defaults to: :unset) —

    The recording_status_callback

  • recording_status_callback_method (String) (defaults to: :unset) —

    The recording_status_callback_method

  • conference_recording_status_callback (String) (defaults to: :unset) —

    The conference_recording_status_callback

  • conference_recording_status_callback_method (String) (defaults to: :unset) —

    The conference_recording_status_callback_method

  • region (String) (defaults to: :unset) —

    The region

  • sip_auth_username (String) (defaults to: :unset) —

    The sip_auth_username

  • sip_auth_password (String) (defaults to: :unset) —

    The sip_auth_password

  • dequeue_status_callback_event (String) (defaults to: :unset) —

    No

  • post_work_activity_sid (String) (defaults to: :unset) —

    No

Returns:



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 514

def update(reservation_status: :unset, worker_activity_sid: :unset, instruction: :unset, dequeue_post_work_activity_sid: :unset, dequeue_from: :unset, dequeue_record: :unset, dequeue_timeout: :unset, dequeue_to: :unset, dequeue_status_callback_url: :unset, call_from: :unset, call_record: :unset, call_timeout: :unset, call_to: :unset, call_url: :unset, call_status_callback_url: :unset, call_accept: :unset, redirect_call_sid: :unset, redirect_accept: :unset, redirect_url: :unset, to: :unset, from: :unset, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, conference_record: :unset, conference_trim: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, region: :unset, sip_auth_username: :unset, sip_auth_password: :unset, dequeue_status_callback_event: :unset, post_work_activity_sid: :unset)
  context.update(
      reservation_status: reservation_status,
      worker_activity_sid: worker_activity_sid,
      instruction: instruction,
      dequeue_post_work_activity_sid: dequeue_post_work_activity_sid,
      dequeue_from: dequeue_from,
      dequeue_record: dequeue_record,
      dequeue_timeout: dequeue_timeout,
      dequeue_to: dequeue_to,
      dequeue_status_callback_url: dequeue_status_callback_url,
      call_from: call_from,
      call_record: call_record,
      call_timeout: call_timeout,
      call_to: call_to,
      call_url: call_url,
      call_status_callback_url: call_status_callback_url,
      call_accept: call_accept,
      redirect_call_sid: redirect_call_sid,
      redirect_accept: redirect_accept,
      redirect_url: redirect_url,
      to: to,
      from: from,
      status_callback: status_callback,
      status_callback_method: status_callback_method,
      status_callback_event: status_callback_event,
      timeout: timeout,
      record: record,
      muted: muted,
      beep: beep,
      start_conference_on_enter: start_conference_on_enter,
      end_conference_on_exit: end_conference_on_exit,
      wait_url: wait_url,
      wait_method: wait_method,
      early_media: early_media,
      max_participants: max_participants,
      conference_status_callback: conference_status_callback,
      conference_status_callback_method: conference_status_callback_method,
      conference_status_callback_event: conference_status_callback_event,
      conference_record: conference_record,
      conference_trim: conference_trim,
      recording_channels: recording_channels,
      recording_status_callback: recording_status_callback,
      recording_status_callback_method: recording_status_callback_method,
      conference_recording_status_callback: conference_recording_status_callback,
      conference_recording_status_callback_method: conference_recording_status_callback_method,
      region: region,
      sip_auth_username: sip_auth_username,
      sip_auth_password: sip_auth_password,
      dequeue_status_callback_event: dequeue_status_callback_event,
      post_work_activity_sid: post_work_activity_sid,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



440
441
442
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 440

def url
  @properties['url']
end

#worker_name ⇒ String

Returns Human readable description of the Worker that is reserved.

Returns:

  • (String) —

    Human readable description of the Worker that is reserved



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

def worker_name
  @properties['worker_name']
end

#worker_sid ⇒ String

Returns The ID of the reserved Worker.

Returns:

  • (String) —

    The ID of the reserved Worker



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

def worker_sid
  @properties['worker_sid']
end

#workspace_sid ⇒ String

Returns The ID of the Workspace that this task is contained within.

Returns:

  • (String) —

    The ID of the Workspace that this task is contained within.



434
435
436
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 434

def workspace_sid
  @properties['workspace_sid']
end