lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb in twilio-ruby-5.28.0 vs lib/twilio-ruby/rest/taskrouter/v1/workspace/task/reservation.rb in twilio-ruby-5.29.0

- old
+ new

@@ -14,13 +14,13 @@ class TaskContext < InstanceContext class ReservationList < ListResource ## # Initialize the ReservationList # @param [Version] version Version that contains the resource - # @param [String] workspace_sid The ID of the Workspace that this task is + # @param [String] workspace_sid The SID of the Workspace that this task is # contained within. - # @param [String] task_sid The ID of the reserved Task + # @param [String] task_sid The SID of the reserved Task resource. # @return [ReservationList] ReservationList def initialize(version, workspace_sid: nil, task_sid: nil) super(version) # Path Solution @@ -31,11 +31,12 @@ ## # Lists ReservationInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [reservation.Status] reservation_status Returns the list of reservations - # for a task with a specified ReservationStatus + # for a task with a specified ReservationStatus. Can be: `pending`, `accepted`, + # `rejected`, or `timeout`. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit # @param [Integer] page_size Number of records to fetch per request, when # not set will use the default value of 50 records. If no page_size is defined # but a limit is defined, stream() will attempt to read the limit with the most @@ -48,11 +49,12 @@ ## # Streams ReservationInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [reservation.Status] reservation_status Returns the list of reservations - # for a task with a specified ReservationStatus + # for a task with a specified ReservationStatus. Can be: `pending`, `accepted`, + # `rejected`, or `timeout`. # @param [Integer] limit Upper limit for the number of records to return. stream() # guarantees to never return more than limit. Default is no limit. # @param [Integer] page_size Number of records to fetch per request, when # not set will use the default value of 50 records. If no page_size is defined # but a limit is defined, stream() will attempt to read the limit with the most @@ -82,11 +84,12 @@ ## # Retrieve a single page of ReservationInstance records from the API. # Request is executed immediately. # @param [reservation.Status] reservation_status Returns the list of reservations - # for a task with a specified ReservationStatus + # for a task with a specified ReservationStatus. Can be: `pending`, `accepted`, + # `rejected`, or `timeout`. # @param [String] page_token PageToken provided by the API # @param [Integer] page_number Page Number, this value is simply for client state # @param [Integer] page_size Number of records to return, defaults to 50 # @return [Page] Page of ReservationInstance def page(reservation_status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) @@ -160,13 +163,15 @@ class ReservationContext < InstanceContext ## # Initialize the ReservationContext # @param [Version] version Version that contains the resource - # @param [String] workspace_sid The workspace_sid - # @param [String] task_sid The task_sid - # @param [String] sid The sid + # @param [String] workspace_sid The SID of the Workspace with the TaskReservation + # resource to fetch. + # @param [String] task_sid The SID of the reserved Task resource with the + # TaskReservation resource to fetch. + # @param [String] sid The SID of the TaskReservation resource to fetch. # @return [ReservationContext] ReservationContext def initialize(version, workspace_sid, task_sid, sid) super(version) # Path Solution @@ -195,91 +200,136 @@ ) end ## # Update the ReservationInstance - # @param [reservation.Status] reservation_status New reservation status - # @param [String] worker_activity_sid New worker activity sid if rejecting a - # reservation - # @param [String] instruction Assignment instruction for reservation - # @param [String] dequeue_post_work_activity_sid New worker activity sid after - # executing a Dequeue instruction - # @param [String] dequeue_from Caller ID for the call to the worker when executing - # a Dequeue instruction - # @param [String] dequeue_record Attribute to record both legs of a call when - # executing a Dequeue instruction + # @param [reservation.Status] reservation_status The new status of the + # reservation. Can be: `pending`, `accepted`, `rejected`, or `timeout`. + # @param [String] worker_activity_sid The new worker activity SID if rejecting a + # reservation. + # @param [String] instruction The assignment instruction for reservation. + # @param [String] dequeue_post_work_activity_sid The SID of the Activity resource + # to start after executing a Dequeue instruction. + # @param [String] dequeue_from The Caller ID of the call to the worker when + # executing a Dequeue instruction. + # @param [String] dequeue_record Whether to record both legs of a call when + # executing a Dequeue instruction or which leg to record. # @param [String] dequeue_timeout Timeout for call when executing a Dequeue - # instruction - # @param [String] dequeue_to Contact URI of the worker when executing a Dequeue - # instruction - # @param [String] dequeue_status_callback_url Callback URL for completed call - # event when executing a Dequeue instruction - # @param [String] call_from Caller ID for the outbound call when executing a Call - # instruction - # @param [String] call_record Attribute to record both legs of a call when - # executing a Call instruction - # @param [String] call_timeout Timeout for call when executing a Call instruction - # @param [String] call_to Contact URI of the worker when executing a Call - # instruction + # instruction. + # @param [String] dequeue_to The Contact URI of the worker when executing a + # Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for + # Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) + # formatted phone number, depending on the destination. + # @param [String] dequeue_status_callback_url The Callback URL for completed call + # event when executing a Dequeue instruction. + # @param [String] call_from The Caller ID of the outbound call when executing a + # Call instruction. + # @param [String] call_record Whether to record both legs of a call when executing + # a Call instruction or which leg to record. + # @param [String] call_timeout Timeout for call when executing a Call instruction. + # @param [String] call_to The Contact URI of the worker when executing a Call + # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable + # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # phone number, depending on the destination. # @param [String] call_url TwiML URI executed on answering the worker's leg as a - # result of the Call instruction - # @param [String] call_status_callback_url Callback URL for completed call event - # when executing a Call instruction - # @param [Boolean] call_accept Flag to determine if reservation should be accepted - # when executing a Call instruction - # @param [String] redirect_call_sid Call sid of the call parked in the queue when - # executing a Redirect instruction - # @param [Boolean] redirect_accept Flag to determine if reservation should be - # accepted when executing a Redirect instruction + # result of the Call instruction. + # @param [String] call_status_callback_url The URL to call for the completed call + # event when executing a Call instruction. + # @param [Boolean] call_accept Whether to accept a reservation when executing a + # Call instruction. + # @param [String] redirect_call_sid The Call SID of the call parked in the queue + # when executing a Redirect instruction. + # @param [Boolean] redirect_accept Whether the reservation should be accepted when + # executing a Redirect instruction. # @param [String] redirect_url TwiML URI to redirect the call to when executing - # the Redirect instruction - # @param [String] to Contact URI of the worker when executing a Conference - # instruction - # @param [String] from Caller ID for the call to the worker when executing a - # Conference instruction - # @param [String] status_callback The status_callback - # @param [String] status_callback_method The status_callback_method - # @param [reservation.CallStatus] status_callback_event The status_callback_event - # @param [String] timeout Timeout for call when executing a Conference instruction - # @param [Boolean] record The record - # @param [Boolean] muted The muted - # @param [String] beep The beep - # @param [Boolean] start_conference_on_enter The start_conference_on_enter - # @param [Boolean] end_conference_on_exit The end_conference_on_exit - # @param [String] wait_url The wait_url - # @param [String] wait_method The wait_method - # @param [Boolean] early_media The early_media - # @param [String] max_participants The max_participants - # @param [String] conference_status_callback The conference_status_callback - # @param [String] conference_status_callback_method The - # conference_status_callback_method + # the Redirect instruction. + # @param [String] to The Contact URI of the worker when executing a Conference + # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable + # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # phone number, depending on the destination. + # @param [String] from The Caller ID of the call to the worker when executing a + # Conference instruction. + # @param [String] status_callback The URL we should call using the + # `status_callback_method` to send status information to your application. + # @param [String] status_callback_method The HTTP method we should use to call + # `status_callback`. Can be: `POST` or `GET` and the default is `POST`. + # @param [reservation.CallStatus] status_callback_event The call progress events + # that we will send to `status_callback`. Can be: `initiated`, `ringing`, + # `answered`, or `completed`. + # @param [String] timeout Timeout for call when executing a Conference + # instruction. + # @param [Boolean] record Whether to record the participant and their conferences, + # including the time between conferences. The default is `false`. + # @param [Boolean] muted Whether the agent is muted in the conference. The default + # is `false`. + # @param [String] beep Whether to play a notification beep when the participant + # joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. + # The default value is `true`. + # @param [Boolean] start_conference_on_enter Whether to start the conference when + # the participant joins, if it has not already started. The default is `true`. If + # `false` and the conference has not started, the participant is muted and hears + # background music until another participant starts the conference. + # @param [Boolean] end_conference_on_exit Whether to end the conference when the + # agent leaves. + # @param [String] wait_url The URL we should call using the `wait_method` for the + # music to play while participants are waiting for the conference to start. The + # default value is the URL of our standard hold music. [Learn more about hold + # music](https://www.twilio.com/labs/twimlets/holdmusic). + # @param [String] wait_method The HTTP method we should use to call `wait_url`. + # Can be `GET` or `POST` and the default is `POST`. When using a static audio + # file, this should be `GET` so that we can cache the file. + # @param [Boolean] early_media Whether to allow an agent to hear the state of the + # outbound call, including ringing or disconnect messages. The default is `true`. + # @param [String] max_participants The maximum number of participants in the + # conference. Can be a positive integer from `2` to `250`. The default value is + # `250`. + # @param [String] conference_status_callback The URL we should call using the + # `conference_status_callback_method` when the conference events in + # `conference_status_callback_event` occur. Only the value set by the first + # participant to join the conference is used. Subsequent + # `conference_status_callback` values are ignored. + # @param [String] conference_status_callback_method The HTTP method we should use + # to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to + # `POST`. # @param [reservation.ConferenceEvent] conference_status_callback_event The - # conference_status_callback_event - # @param [String] conference_record The conference_record - # @param [String] conference_trim The conference_trim - # @param [String] recording_channels The recording_channels - # @param [String] recording_status_callback The recording_status_callback - # @param [String] recording_status_callback_method The - # recording_status_callback_method - # @param [String] conference_recording_status_callback The - # conference_recording_status_callback - # @param [String] conference_recording_status_callback_method The - # conference_recording_status_callback_method - # @param [String] region The region - # @param [String] sip_auth_username The sip_auth_username - # @param [String] sip_auth_password The sip_auth_password - # @param [String] dequeue_status_callback_event Call progress events sent via - # webhooks as a result of a Dequeue instruction - # @param [String] post_work_activity_sid New worker activity sid after executing a - # Conference instruction - # @param [reservation.SupervisorMode] supervisor_mode Supervisor mode when - # executing the Supervise instruction - # @param [String] supervisor Supervisor sid/uri when executing the Supervise - # instruction - # @param [Boolean] end_conference_on_customer_exit The - # end_conference_on_customer_exit - # @param [Boolean] beep_on_customer_entrance The beep_on_customer_entrance + # conference status events that we will send to `conference_status_callback`. Can + # be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`. + # @param [String] conference_record Whether to record the conference the + # participant is joining or when to record the conference. Can be: `true`, + # `false`, `record-from-start`, and `do-not-record`. The default value is `false`. + # @param [String] conference_trim How to trim the leading and trailing silence + # from your recorded conference audio files. Can be: `trim-silence` or + # `do-not-trim` and defaults to `trim-silence`. + # @param [String] recording_channels The recording channels for the final + # recording. Can be: `mono` or `dual` and the default is `mono`. + # @param [String] recording_status_callback The URL that we should call using the + # `recording_status_callback_method` when the recording status changes. + # @param [String] recording_status_callback_method The HTTP method we should use + # when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults + # to `POST`. + # @param [String] conference_recording_status_callback The URL we should call + # using the `conference_recording_status_callback_method` when the conference + # recording is available. + # @param [String] conference_recording_status_callback_method The HTTP method we + # should use to call `conference_recording_status_callback`. Can be: `GET` or + # `POST` and defaults to `POST`. + # @param [String] region The + # [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`. + # @param [String] sip_auth_username The SIP username used for authentication. + # @param [String] sip_auth_password The SIP password for authentication. + # @param [String] dequeue_status_callback_event The Call progress events sent via + # webhooks as a result of a Dequeue instruction. + # @param [String] post_work_activity_sid The new worker activity SID after + # executing a Conference instruction. + # @param [reservation.SupervisorMode] supervisor_mode The Supervisor mode when + # executing the Supervise instruction. + # @param [String] supervisor The Supervisor SID/URI when executing the Supervise + # instruction. + # @param [Boolean] end_conference_on_customer_exit Whether to end the conference + # when the customer leaves. + # @param [Boolean] beep_on_customer_entrance Whether to play a notification beep + # when the customer joins. # @return [ReservationInstance] Updated ReservationInstance 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, supervisor_mode: :unset, supervisor: :unset, end_conference_on_customer_exit: :unset, beep_on_customer_entrance: :unset) data = Twilio::Values.of({ 'ReservationStatus' => reservation_status, 'WorkerActivitySid' => worker_activity_sid, @@ -369,14 +419,14 @@ class ReservationInstance < InstanceResource ## # Initialize the ReservationInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] workspace_sid The ID of the Workspace that this task is + # @param [String] workspace_sid The SID of the Workspace that this task is # contained within. - # @param [String] task_sid The ID of the reserved Task - # @param [String] sid The sid + # @param [String] task_sid The SID of the reserved Task resource. + # @param [String] sid The SID of the TaskReservation resource to fetch. # @return [ReservationInstance] ReservationInstance def initialize(version, payload, workspace_sid: nil, task_sid: nil, sid: nil) super(version) # Marshaled Properties @@ -418,71 +468,71 @@ end @instance_context end ## - # @return [String] The ID of the Account that owns this Task + # @return [String] The SID of the Account that created the resource def account_sid @properties['account_sid'] end ## - # @return [Time] The date_created + # @return [Time] The ISO 8601 date and time in GMT when the resource was created def date_created @properties['date_created'] end ## - # @return [Time] The date_updated + # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated def date_updated @properties['date_updated'] end ## - # @return [reservation.Status] The current status of the reservation. + # @return [reservation.Status] The current status of the reservation def reservation_status @properties['reservation_status'] end ## - # @return [String] The unique ID of this Reservation. + # @return [String] The unique string that identifies the resource def sid @properties['sid'] end ## - # @return [String] The ID of the reserved Task + # @return [String] The SID of the reserved Task resource def task_sid @properties['task_sid'] end ## - # @return [String] Human readable description of the Worker that is reserved + # @return [String] The friendly_name of the Worker that is reserved def worker_name @properties['worker_name'] end ## - # @return [String] The ID of the reserved Worker + # @return [String] The SID of the reserved Worker resource def worker_sid @properties['worker_sid'] end ## - # @return [String] The ID of the Workspace that this task is contained within. + # @return [String] The SID of the Workspace that this task is contained within. def workspace_sid @properties['workspace_sid'] end ## - # @return [String] The url + # @return [String] The absolute URL of the TaskReservation reservation def url @properties['url'] end ## - # @return [String] The links + # @return [String] The URLs of related resources def links @properties['links'] end ## @@ -492,90 +542,135 @@ context.fetch end ## # Update the ReservationInstance - # @param [reservation.Status] reservation_status New reservation status - # @param [String] worker_activity_sid New worker activity sid if rejecting a - # reservation - # @param [String] instruction Assignment instruction for reservation - # @param [String] dequeue_post_work_activity_sid New worker activity sid after - # executing a Dequeue instruction - # @param [String] dequeue_from Caller ID for the call to the worker when executing - # a Dequeue instruction - # @param [String] dequeue_record Attribute to record both legs of a call when - # executing a Dequeue instruction + # @param [reservation.Status] reservation_status The new status of the + # reservation. Can be: `pending`, `accepted`, `rejected`, or `timeout`. + # @param [String] worker_activity_sid The new worker activity SID if rejecting a + # reservation. + # @param [String] instruction The assignment instruction for reservation. + # @param [String] dequeue_post_work_activity_sid The SID of the Activity resource + # to start after executing a Dequeue instruction. + # @param [String] dequeue_from The Caller ID of the call to the worker when + # executing a Dequeue instruction. + # @param [String] dequeue_record Whether to record both legs of a call when + # executing a Dequeue instruction or which leg to record. # @param [String] dequeue_timeout Timeout for call when executing a Dequeue - # instruction - # @param [String] dequeue_to Contact URI of the worker when executing a Dequeue - # instruction - # @param [String] dequeue_status_callback_url Callback URL for completed call - # event when executing a Dequeue instruction - # @param [String] call_from Caller ID for the outbound call when executing a Call - # instruction - # @param [String] call_record Attribute to record both legs of a call when - # executing a Call instruction - # @param [String] call_timeout Timeout for call when executing a Call instruction - # @param [String] call_to Contact URI of the worker when executing a Call - # instruction + # instruction. + # @param [String] dequeue_to The Contact URI of the worker when executing a + # Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for + # Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) + # formatted phone number, depending on the destination. + # @param [String] dequeue_status_callback_url The Callback URL for completed call + # event when executing a Dequeue instruction. + # @param [String] call_from The Caller ID of the outbound call when executing a + # Call instruction. + # @param [String] call_record Whether to record both legs of a call when executing + # a Call instruction or which leg to record. + # @param [String] call_timeout Timeout for call when executing a Call instruction. + # @param [String] call_to The Contact URI of the worker when executing a Call + # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable + # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # phone number, depending on the destination. # @param [String] call_url TwiML URI executed on answering the worker's leg as a - # result of the Call instruction - # @param [String] call_status_callback_url Callback URL for completed call event - # when executing a Call instruction - # @param [Boolean] call_accept Flag to determine if reservation should be accepted - # when executing a Call instruction - # @param [String] redirect_call_sid Call sid of the call parked in the queue when - # executing a Redirect instruction - # @param [Boolean] redirect_accept Flag to determine if reservation should be - # accepted when executing a Redirect instruction + # result of the Call instruction. + # @param [String] call_status_callback_url The URL to call for the completed call + # event when executing a Call instruction. + # @param [Boolean] call_accept Whether to accept a reservation when executing a + # Call instruction. + # @param [String] redirect_call_sid The Call SID of the call parked in the queue + # when executing a Redirect instruction. + # @param [Boolean] redirect_accept Whether the reservation should be accepted when + # executing a Redirect instruction. # @param [String] redirect_url TwiML URI to redirect the call to when executing - # the Redirect instruction - # @param [String] to Contact URI of the worker when executing a Conference - # instruction - # @param [String] from Caller ID for the call to the worker when executing a - # Conference instruction - # @param [String] status_callback The status_callback - # @param [String] status_callback_method The status_callback_method - # @param [reservation.CallStatus] status_callback_event The status_callback_event - # @param [String] timeout Timeout for call when executing a Conference instruction - # @param [Boolean] record The record - # @param [Boolean] muted The muted - # @param [String] beep The beep - # @param [Boolean] start_conference_on_enter The start_conference_on_enter - # @param [Boolean] end_conference_on_exit The end_conference_on_exit - # @param [String] wait_url The wait_url - # @param [String] wait_method The wait_method - # @param [Boolean] early_media The early_media - # @param [String] max_participants The max_participants - # @param [String] conference_status_callback The conference_status_callback - # @param [String] conference_status_callback_method The - # conference_status_callback_method + # the Redirect instruction. + # @param [String] to The Contact URI of the worker when executing a Conference + # instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable + # SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted + # phone number, depending on the destination. + # @param [String] from The Caller ID of the call to the worker when executing a + # Conference instruction. + # @param [String] status_callback The URL we should call using the + # `status_callback_method` to send status information to your application. + # @param [String] status_callback_method The HTTP method we should use to call + # `status_callback`. Can be: `POST` or `GET` and the default is `POST`. + # @param [reservation.CallStatus] status_callback_event The call progress events + # that we will send to `status_callback`. Can be: `initiated`, `ringing`, + # `answered`, or `completed`. + # @param [String] timeout Timeout for call when executing a Conference + # instruction. + # @param [Boolean] record Whether to record the participant and their conferences, + # including the time between conferences. The default is `false`. + # @param [Boolean] muted Whether the agent is muted in the conference. The default + # is `false`. + # @param [String] beep Whether to play a notification beep when the participant + # joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. + # The default value is `true`. + # @param [Boolean] start_conference_on_enter Whether to start the conference when + # the participant joins, if it has not already started. The default is `true`. If + # `false` and the conference has not started, the participant is muted and hears + # background music until another participant starts the conference. + # @param [Boolean] end_conference_on_exit Whether to end the conference when the + # agent leaves. + # @param [String] wait_url The URL we should call using the `wait_method` for the + # music to play while participants are waiting for the conference to start. The + # default value is the URL of our standard hold music. [Learn more about hold + # music](https://www.twilio.com/labs/twimlets/holdmusic). + # @param [String] wait_method The HTTP method we should use to call `wait_url`. + # Can be `GET` or `POST` and the default is `POST`. When using a static audio + # file, this should be `GET` so that we can cache the file. + # @param [Boolean] early_media Whether to allow an agent to hear the state of the + # outbound call, including ringing or disconnect messages. The default is `true`. + # @param [String] max_participants The maximum number of participants in the + # conference. Can be a positive integer from `2` to `250`. The default value is + # `250`. + # @param [String] conference_status_callback The URL we should call using the + # `conference_status_callback_method` when the conference events in + # `conference_status_callback_event` occur. Only the value set by the first + # participant to join the conference is used. Subsequent + # `conference_status_callback` values are ignored. + # @param [String] conference_status_callback_method The HTTP method we should use + # to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to + # `POST`. # @param [reservation.ConferenceEvent] conference_status_callback_event The - # conference_status_callback_event - # @param [String] conference_record The conference_record - # @param [String] conference_trim The conference_trim - # @param [String] recording_channels The recording_channels - # @param [String] recording_status_callback The recording_status_callback - # @param [String] recording_status_callback_method The - # recording_status_callback_method - # @param [String] conference_recording_status_callback The - # conference_recording_status_callback - # @param [String] conference_recording_status_callback_method The - # conference_recording_status_callback_method - # @param [String] region The region - # @param [String] sip_auth_username The sip_auth_username - # @param [String] sip_auth_password The sip_auth_password - # @param [String] dequeue_status_callback_event Call progress events sent via - # webhooks as a result of a Dequeue instruction - # @param [String] post_work_activity_sid New worker activity sid after executing a - # Conference instruction - # @param [reservation.SupervisorMode] supervisor_mode Supervisor mode when - # executing the Supervise instruction - # @param [String] supervisor Supervisor sid/uri when executing the Supervise - # instruction - # @param [Boolean] end_conference_on_customer_exit The - # end_conference_on_customer_exit - # @param [Boolean] beep_on_customer_entrance The beep_on_customer_entrance + # conference status events that we will send to `conference_status_callback`. Can + # be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`. + # @param [String] conference_record Whether to record the conference the + # participant is joining or when to record the conference. Can be: `true`, + # `false`, `record-from-start`, and `do-not-record`. The default value is `false`. + # @param [String] conference_trim How to trim the leading and trailing silence + # from your recorded conference audio files. Can be: `trim-silence` or + # `do-not-trim` and defaults to `trim-silence`. + # @param [String] recording_channels The recording channels for the final + # recording. Can be: `mono` or `dual` and the default is `mono`. + # @param [String] recording_status_callback The URL that we should call using the + # `recording_status_callback_method` when the recording status changes. + # @param [String] recording_status_callback_method The HTTP method we should use + # when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults + # to `POST`. + # @param [String] conference_recording_status_callback The URL we should call + # using the `conference_recording_status_callback_method` when the conference + # recording is available. + # @param [String] conference_recording_status_callback_method The HTTP method we + # should use to call `conference_recording_status_callback`. Can be: `GET` or + # `POST` and defaults to `POST`. + # @param [String] region The + # [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`. + # @param [String] sip_auth_username The SIP username used for authentication. + # @param [String] sip_auth_password The SIP password for authentication. + # @param [String] dequeue_status_callback_event The Call progress events sent via + # webhooks as a result of a Dequeue instruction. + # @param [String] post_work_activity_sid The new worker activity SID after + # executing a Conference instruction. + # @param [reservation.SupervisorMode] supervisor_mode The Supervisor mode when + # executing the Supervise instruction. + # @param [String] supervisor The Supervisor SID/URI when executing the Supervise + # instruction. + # @param [Boolean] end_conference_on_customer_exit Whether to end the conference + # when the customer leaves. + # @param [Boolean] beep_on_customer_entrance Whether to play a notification beep + # when the customer joins. # @return [ReservationInstance] Updated ReservationInstance 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, supervisor_mode: :unset, supervisor: :unset, end_conference_on_customer_exit: :unset, beep_on_customer_entrance: :unset) context.update( reservation_status: reservation_status, worker_activity_sid: worker_activity_sid, \ No newline at end of file