You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.ts
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -189,7 +189,7 @@ export class BookingsController_2024_08_13 {
189
189
2. uid of one of the recurring booking recurrences
190
190
191
191
3. uid of recurring booking which will return an array of all recurring booking recurrences (stored as recurringBookingUid on one of the individual recurrences).
192
-
192
+
193
193
If you are fetching a seated booking for an event type with 'show attendees' disabled, then to retrieve attendees in the response either set 'show attendees' to true on event type level or
194
194
you have to provide an authentication method of event type owner, host, team admin or owner or org admin or owner.
195
195
@@ -213,7 +213,7 @@ export class BookingsController_2024_08_13 {
213
213
@ApiOperation({
214
214
summary: "Get all the recordings for the booking",
215
215
description: `Fetches all the recordings for the booking \`:bookingUid\`
216
-
216
+
217
217
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
218
218
`,
219
219
})
@@ -229,9 +229,9 @@ export class BookingsController_2024_08_13 {
229
229
@Get("/:bookingUid/transcripts")
230
230
@UseGuards(BookingUidGuard)
231
231
@ApiOperation({
232
-
summary: "Get all the transcripts download links for the booking",
232
+
summary: "Get Cal Video real time transcript download links for the booking",
233
233
description: `Fetches all the transcripts download links for the booking \`:bookingUid\`
234
-
234
+
235
235
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
236
236
`,
237
237
})
@@ -279,7 +279,7 @@ export class BookingsController_2024_08_13 {
279
279
@ApiOperation({
280
280
summary: "Reschedule a booking",
281
281
description: `Reschedule a booking or seated booking
282
-
282
+
283
283
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
284
284
`,
285
285
})
@@ -321,19 +321,19 @@ export class BookingsController_2024_08_13 {
321
321
@ApiOperation({
322
322
summary: "Cancel a booking",
323
323
description: `:bookingUid can be :bookingUid of an usual booking, individual recurrence or recurring booking to cancel all recurrences.
324
-
324
+
325
325
\nCancelling normal bookings:
326
326
If the booking is not seated and not recurring, simply pass :bookingUid in the request URL \`/bookings/:bookingUid/cancel\` and optionally cancellationReason in the request body \`{"cancellationReason": "Will travel"}\`.
327
327
328
328
\nCancelling seated bookings:
329
329
It is possible to cancel specific seat within a booking as an attendee or all of the seats as the host.
330
330
\n1. As an attendee - provide :bookingUid in the request URL \`/bookings/:bookingUid/cancel\` and seatUid in the request body \`{"seatUid": "123-123-123"}\` . This will remove this particular attendance from the booking.
331
331
\n2. As the host or org admin of host - host can cancel booking for all attendees aka for every seat, this also applies to org admins. Provide :bookingUid in the request URL \`/bookings/:bookingUid/cancel\` and cancellationReason in the request body \`{"cancellationReason": "Will travel"}\` and \`Authorization: Bearer token\` request header where token is event type owner (host) credential. This will cancel the booking for all attendees.
332
-
332
+
333
333
\nCancelling recurring seated bookings:
334
334
For recurring seated bookings it is not possible to cancel all of them with 1 call
335
335
like with non-seated recurring bookings by providing recurring bookind uid - you have to cancel each recurrence booking by its bookingUid + seatUid.
336
-
336
+
337
337
If you are cancelling a seated booking for an event type with 'show attendees' disabled, then to retrieve attendees in the response either set 'show attendees' to true on event type level or
338
338
you have to provide an authentication method of event type owner, host, team admin or owner or org admin or owner.
339
339
@@ -374,7 +374,7 @@ export class BookingsController_2024_08_13 {
374
374
@ApiOperation({
375
375
summary: "Mark a booking absence",
376
376
description: `The provided authorization header refers to the owner of the booking.
377
-
377
+
378
378
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
379
379
`,
380
380
})
@@ -399,7 +399,7 @@ export class BookingsController_2024_08_13 {
399
399
@ApiOperation({
400
400
summary: "Reassign a booking to auto-selected host",
401
401
description: `Currently only supports reassigning host for round robin bookings. The provided authorization header refers to the owner of the booking.
402
-
402
+
403
403
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
404
404
`,
405
405
})
@@ -423,7 +423,7 @@ export class BookingsController_2024_08_13 {
423
423
@ApiOperation({
424
424
summary: "Reassign a booking to a specific host",
425
425
description: `Currently only supports reassigning host for round robin bookings. The provided authorization header refers to the owner of the booking.
426
-
426
+
427
427
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
428
428
`,
429
429
})
@@ -454,7 +454,7 @@ export class BookingsController_2024_08_13 {
454
454
@ApiOperation({
455
455
summary: "Confirm a booking",
456
456
description: `The provided authorization header refers to the owner of the booking.
457
-
457
+
458
458
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
459
459
`,
460
460
})
@@ -478,8 +478,8 @@ export class BookingsController_2024_08_13 {
478
478
@ApiOperation({
479
479
summary: "Decline a booking",
480
480
description: `The provided authorization header refers to the owner of the booking.
481
-
482
-
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
481
+
482
+
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
483
483
`,
484
484
})
485
485
asyncdeclineBooking(
@@ -502,8 +502,8 @@ export class BookingsController_2024_08_13 {
502
502
@ApiOperation({
503
503
summary: "Get 'Add to Calendar' links for a booking",
504
504
description: `Retrieve calendar links for a booking that can be used to add the event to various calendar services. Returns links for Google Calendar, Microsoft Office, Microsoft Outlook, and a downloadable ICS file.
505
-
506
-
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
505
+
506
+
<Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
0 commit comments