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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, task_sid, sid) ⇒ ReservationContext

Initialize the ReservationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The workspace_sid

  • task_sid (String) —

    The task_sid

  • sid (String) —

    The sid



169
170
171
172
173
174
175
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 169

def initialize(version, workspace_sid, task_sid, sid)
  super(version)

  # Path Solution
  @solution = {workspace_sid: workspace_sid, task_sid: task_sid, sid: sid, }
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/Tasks/#{@solution[:task_sid]}/Reservations/#{@solution[:sid]}"
end

Instance Method Details

#fetch ⇒ ReservationInstance

Fetch a ReservationInstance

Returns:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 180

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  ReservationInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      task_sid: @solution[:task_sid],
      sid: @solution[:sid],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Taskrouter.V1.ReservationContext #{context}>"
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:



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
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
318
319
320
321
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb', line 255

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)
  data = Twilio::Values.of({
      'ReservationStatus' => reservation_status,
      'WorkerActivitySid' => worker_activity_sid,
      'Instruction' => instruction,
      'DequeuePostWorkActivitySid' => dequeue_post_work_activity_sid,
      'DequeueFrom' => dequeue_from,
      'DequeueRecord' => dequeue_record,
      'DequeueTimeout' => dequeue_timeout,
      'DequeueTo' => dequeue_to,
      'DequeueStatusCallbackUrl' => dequeue_status_callback_url,
      'CallFrom' => call_from,
      'CallRecord' => call_record,
      'CallTimeout' => call_timeout,
      'CallTo' => call_to,
      'CallUrl' => call_url,
      'CallStatusCallbackUrl' => call_status_callback_url,
      'CallAccept' => call_accept,
      'RedirectCallSid' => redirect_call_sid,
      'RedirectAccept' => redirect_accept,
      'RedirectUrl' => redirect_url,
      'To' => to,
      'From' => from,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
      'StatusCallbackEvent' => Twilio.serialize_list(status_callback_event) { |e| e },
      'Timeout' => timeout,
      'Record' => record,
      'Muted' => muted,
      'Beep' => beep,
      'StartConferenceOnEnter' => start_conference_on_enter,
      'EndConferenceOnExit' => end_conference_on_exit,
      'WaitUrl' => wait_url,
      'WaitMethod' => wait_method,
      'EarlyMedia' => early_media,
      'MaxParticipants' => max_participants,
      'ConferenceStatusCallback' => conference_status_callback,
      'ConferenceStatusCallbackMethod' => conference_status_callback_method,
      'ConferenceStatusCallbackEvent' => Twilio.serialize_list(conference_status_callback_event) { |e| e },
      'ConferenceRecord' => conference_record,
      'ConferenceTrim' => conference_trim,
      'RecordingChannels' => recording_channels,
      'RecordingStatusCallback' => recording_status_callback,
      'RecordingStatusCallbackMethod' => recording_status_callback_method,
      'ConferenceRecordingStatusCallback' => conference_recording_status_callback,
      'ConferenceRecordingStatusCallbackMethod' => conference_recording_status_callback_method,
      'Region' => region,
      'SipAuthUsername' => sip_auth_username,
      'SipAuthPassword' => sip_auth_password,
      'DequeueStatusCallbackEvent' => Twilio.serialize_list(dequeue_status_callback_event) { |e| e },
      'PostWorkActivitySid' => post_work_activity_sid,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  ReservationInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      task_sid: @solution[:task_sid],
      sid: @solution[:sid],
  )
end