Scheduling infrastructure for absolutely everyone.
chore: clean up api v2 docs (#20668)
Keith Williamsad4aeee45b0e
diff --git a/apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.ts b/apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.tsindex d615a2faed2..b4cfc090218 100644--- a/apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.ts+++ b/apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.ts@@ -256,7 +256,8 @@ export class BookingsController_2024_08_13 {@UseGuards(ApiAuthGuard, BookingUidGuard)@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)@ApiOperation({- summary: "Mark a booking absence - provided authorization header refers to owner of the booking.",+ summary: "Mark a booking absence",+ description: "The provided authorization header refers to the owner of the booking.",})async markNoShow(@Param("bookingUid") bookingUid: string,@@ -277,8 +278,8 @@ export class BookingsController_2024_08_13 {@UseGuards(ApiAuthGuard, BookingUidGuard)@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)@ApiOperation({- summary:- "Automatically reassign booking to a new host automatically - provided authorization header refers to person who reassigned the booking.",+ summary: "Reassign a booking to auto-selected host",+ description: "The provided authorization header refers to the owner of the booking.",})async reassignBooking(@Param("bookingUid") bookingUid: string,@@ -298,8 +299,8 @@ export class BookingsController_2024_08_13 {@UseGuards(ApiAuthGuard, BookingUidGuard)@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)@ApiOperation({- summary:- "Reassign a booking to a specific user specified by the :userId - provided authorization header refers to person who reassigned the booking.",+ summary: "Reassign a booking to a specific host",+ description: "The provided authorization header refers to the owner of the booking.",})async reassignBookingToUser(@Param("bookingUid") bookingUid: string,@@ -326,8 +327,8 @@ export class BookingsController_2024_08_13 {@UseGuards(ApiAuthGuard, BookingUidGuard)@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)@ApiOperation({- summary:- "Confirm booking that requires a confirmation - provided authorization header refers to owner of the booking.",+ summary: "Confirm a booking",+ description: "The provided authorization header refers to the owner of the booking.",})async confirmBooking(@Param("bookingUid") bookingUid: string,@@ -347,8 +348,8 @@ export class BookingsController_2024_08_13 {@UseGuards(ApiAuthGuard, BookingUidGuard)@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)@ApiOperation({- summary:- "Decline booking that requires a confirmation - provided authorization header refers to owner of the booking.",+ summary: "Decline a booking",+ description: "The provided authorization header refers to the owner of the booking.",})async declineBooking(@Param("bookingUid") bookingUid: string,diff --git a/apps/api/v2/src/modules/organizations/conferencing/organizations-conferencing.controller.ts b/apps/api/v2/src/modules/organizations/conferencing/organizations-conferencing.controller.tsindex 0f5e6ef4198..936ed574151 100644--- a/apps/api/v2/src/modules/organizations/conferencing/organizations-conferencing.controller.ts+++ b/apps/api/v2/src/modules/organizations/conferencing/organizations-conferencing.controller.ts@@ -56,7 +56,7 @@ export type OAuthCallbackState = {path: "/v2/organizations/:orgId",version: API_VERSIONS_VALUES,})-@DocsTags("Organizations/Teams Conferencing")+@DocsTags("Orgs / Teams / Conferencing")export class OrganizationsConferencingController {constructor(private readonly conferencingService: ConferencingService,diff --git a/apps/api/v2/swagger/documentation.json b/apps/api/v2/swagger/documentation.jsonindex acf60144e3e..e468e4c167f 100644--- a/apps/api/v2/swagger/documentation.json+++ b/apps/api/v2/swagger/documentation.json@@ -2410,7 +2410,8 @@"name": "teamIds","required": false,"in": "query",- "description": "Filter by teamIds",+ "description": "Filter by teamIds. Team ids must be separated by a comma.",+ "example": "?teamIds=100,200","schema": {"type": "array","items": {@@ -3342,6 +3343,301 @@]}},+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/connect": {+ "post": {+ "operationId": "OrganizationsConferencingController_connectTeamApp",+ "summary": "Connect your conferencing application to a team",+ "parameters": [+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ },+ {+ "name": "orgId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ },+ {+ "name": "app",+ "required": true,+ "in": "path",+ "description": "Conferencing application type",+ "schema": {+ "enum": [+ "google-meet"+ ],+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ConferencingAppOutputResponseDto"+ }+ }+ }+ }+ },+ "tags": [+ "Orgs / Teams / Conferencing"+ ]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/oauth/auth-url": {+ "get": {+ "operationId": "OrganizationsConferencingController_getTeamOAuthUrl",+ "summary": "Get OAuth conferencing app's auth url for a team",+ "parameters": [+ {+ "name": "Authorization",+ "required": true,+ "in": "header",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "orgId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "app",+ "required": true,+ "in": "path",+ "description": "Conferencing application type",+ "schema": {+ "enum": [+ "zoom",+ "msteams"+ ],+ "type": "string"+ }+ },+ {+ "name": "returnTo",+ "required": true,+ "in": "query",+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "onErrorReturnTo",+ "required": true,+ "in": "query",+ "schema": {+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/GetConferencingAppsOauthUrlResponseDto"+ }+ }+ }+ }+ },+ "tags": [+ "Orgs / Teams / Conferencing"+ ]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing": {+ "get": {+ "operationId": "OrganizationsConferencingController_listTeamConferencingApps",+ "summary": "List team conferencing applications",+ "parameters": [+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ConferencingAppsOutputResponseDto"+ }+ }+ }+ }+ },+ "tags": [+ "Orgs / Teams / Conferencing"+ ]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/default": {+ "post": {+ "operationId": "OrganizationsConferencingController_setTeamDefaultApp",+ "summary": "Set team default conferencing application",+ "parameters": [+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ },+ {+ "name": "app",+ "required": true,+ "in": "path",+ "description": "Conferencing application type",+ "schema": {+ "enum": [+ "google-meet",+ "zoom",+ "msteams",+ "daily-video"+ ],+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/SetDefaultConferencingAppOutputResponseDto"+ }+ }+ }+ }+ },+ "tags": [+ "Orgs / Teams / Conferencing"+ ]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing/default": {+ "get": {+ "operationId": "OrganizationsConferencingController_getTeamDefaultApp",+ "summary": "Get team default conferencing application",+ "parameters": [+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ },+ {+ "name": "app",+ "required": true,+ "in": "path",+ "description": "Conferencing application type",+ "schema": {+ "enum": [+ "google-meet",+ "zoom",+ "msteams",+ "daily-video"+ ],+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/GetDefaultConferencingAppOutputResponseDto"+ }+ }+ }+ }+ },+ "tags": [+ "Orgs / Teams / Conferencing"+ ]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/disconnect": {+ "delete": {+ "operationId": "OrganizationsConferencingController_disconnectTeamApp",+ "summary": "Disconnect team conferencing application",+ "parameters": [+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ },+ {+ "name": "app",+ "required": true,+ "in": "path",+ "description": "Conferencing application type",+ "schema": {+ "enum": [+ "google-meet",+ "zoom",+ "msteams"+ ],+ "type": "string"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/DisconnectConferencingAppOutputResponseDto"+ }+ }+ }+ }+ },+ "tags": [+ "Orgs / Teams / Conferencing"+ ]+ }+ },"/v2/organizations/{orgId}/teams/{teamId}/event-types": {"post": {"operationId": "OrganizationsEventTypesController_createTeamEventType",@@ -6739,7 +7035,8 @@"/v2/bookings/{bookingUid}/mark-absent": {"post": {"operationId": "BookingsController_2024_08_13_markNoShow",- "summary": "Mark a booking absence - provided authorization header refers to owner of the booking.",+ "summary": "Mark a booking absence",+ "description": "The provided authorization header refers to the owner of the booking.","parameters": [{"name": "cal-api-version",@@ -6799,7 +7096,8 @@"/v2/bookings/{bookingUid}/reassign": {"post": {"operationId": "BookingsController_2024_08_13_reassignBooking",- "summary": "Automatically reassign booking to a new host automatically - provided authorization header refers to person who reassigned the booking.",+ "summary": "Reassign booking to auto-selected host",+ "description": "The provided authorization header refers to the owner of the booking.","parameters": [{"name": "cal-api-version",@@ -6849,7 +7147,8 @@"/v2/bookings/{bookingUid}/reassign/{userId}": {"post": {"operationId": "BookingsController_2024_08_13_reassignBookingToUser",- "summary": "Reassign a booking to a specific user specified by the :userId - provided authorization header refers to person who reassigned the booking.",+ "summary": "Reassign a booking to a specific host",+ "description": "The provided authorization header refers to the owner of the booking.","parameters": [{"name": "cal-api-version",@@ -6917,7 +7216,8 @@"/v2/bookings/{bookingUid}/confirm": {"post": {"operationId": "BookingsController_2024_08_13_confirmBooking",- "summary": "Confirm booking that requires a confirmation - provided authorization header refers to owner of the booking.",+ "summary": "Confirm a booking",+ "description": "The provided authorization header refers to the owner of the booking.","parameters": [{"name": "cal-api-version",@@ -6967,7 +7267,8 @@"/v2/bookings/{bookingUid}/decline": {"post": {"operationId": "BookingsController_2024_08_13_declineBooking",- "summary": "Decline booking that requires a confirmation - provided authorization header refers to owner of the booking.",+ "summary": "Decline a booking",+ "description": "The provided authorization header refers to the owner of the booking.","parameters": [{"name": "cal-api-version",@@ -8371,265 +8672,27 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/EventTypeWebhookOutputResponseDto"- }- }- }- }- },- "tags": [- "Event Types / Webhooks"- ]- }- },- "/v2/me": {- "get": {- "operationId": "MeController_getMe",- "summary": "Get my profile",- "parameters": [- {- "name": "Authorization",- "in": "header",- "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_ or managed user access token",- "required": true,- "schema": {- "type": "string"- }- }- ],- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/GetMeOutput"- }- }- }- }- },- "tags": [- "Me"- ]- },- "patch": {- "operationId": "MeController_updateMe",- "summary": "Update my profile",- "parameters": [- {- "name": "Authorization",- "in": "header",- "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_ or managed user access token",- "required": true,- "schema": {- "type": "string"- }- }- ],- "requestBody": {- "required": true,- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/UpdateManagedUserInput"- }- }- }- },- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/UpdateMeOutput"- }- }- }- }- },- "tags": [- "Me"- ]- }- },- "/v2/oauth-clients": {- "post": {- "operationId": "OAuthClientsController_createOAuthClient",- "summary": "Create an OAuth client",- "parameters": [- {- "name": "Authorization",- "in": "header",- "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",- "required": true,- "schema": {- "type": "string"- }- }- ],- "requestBody": {- "required": true,- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/CreateOAuthClientInput"- }- }- }- },- "responses": {- "201": {- "description": "Create an OAuth client",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/CreateOAuthClientResponseDto"- }- }- }- }- },- "tags": [- "OAuth Clients"- ]- },- "get": {- "operationId": "OAuthClientsController_getOAuthClients",- "summary": "Get all OAuth clients",- "parameters": [- {- "name": "Authorization",- "in": "header",- "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",- "required": true,- "schema": {- "type": "string"- }- }- ],- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/GetOAuthClientsResponseDto"- }- }- }- }- },- "tags": [- "OAuth Clients"- ]- }- },- "/v2/oauth-clients/{clientId}": {- "get": {- "operationId": "OAuthClientsController_getOAuthClientById",- "summary": "Get an OAuth client",- "parameters": [- {- "name": "Authorization",- "in": "header",- "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",- "required": true,- "schema": {- "type": "string"- }- },- {- "name": "clientId",- "required": true,- "in": "path",- "schema": {- "type": "string"- }- }- ],- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/GetOAuthClientResponseDto"- }- }- }- }- },- "tags": [- "OAuth Clients"- ]- },- "patch": {- "operationId": "OAuthClientsController_updateOAuthClient",- "summary": "Update an OAuth client",- "parameters": [- {- "name": "Authorization",- "in": "header",- "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",- "required": true,- "schema": {- "type": "string"- }- },- {- "name": "clientId",- "required": true,- "in": "path",- "schema": {- "type": "string"- }- }- ],- "requestBody": {- "required": true,- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/UpdateOAuthClientInput"- }- }- }- },- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/GetOAuthClientResponseDto"+ "$ref": "#/components/schemas/EventTypeWebhookOutputResponseDto"}}}}},"tags": [- "OAuth Clients"+ "Event Types / Webhooks"]- },- "delete": {- "operationId": "OAuthClientsController_deleteOAuthClient",- "summary": "Delete an OAuth client",+ }+ },+ "/v2/me": {+ "get": {+ "operationId": "MeController_getMe",+ "summary": "Get my profile","parameters": [{"name": "Authorization","in": "header",- "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",- "required": true,- "schema": {- "type": "string"- }- },- {- "name": "clientId",+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_ or managed user access token","required": true,- "in": "path","schema": {"type": "string"}@@ -8641,155 +8704,109 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/GetOAuthClientResponseDto"+ "$ref": "#/components/schemas/GetMeOutput"}}}}},"tags": [- "OAuth Clients"+ "Me"]- }- },- "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/connect": {- "post": {- "operationId": "OrganizationsConferencingController_connectTeamApp",- "summary": "Connect your conferencing application to a team",+ },+ "patch": {+ "operationId": "MeController_updateMe",+ "summary": "Update my profile","parameters": [{- "name": "teamId",- "required": true,- "in": "path",- "schema": {- "type": "number"- }- },- {- "name": "orgId",- "required": true,- "in": "path",- "schema": {- "type": "number"- }- },- {- "name": "app",+ "name": "Authorization",+ "in": "header",+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_ or managed user access token","required": true,- "in": "path",- "description": "Conferencing application type","schema": {- "enum": [- "google-meet"- ],"type": "string"}}],+ "requestBody": {+ "required": true,+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/UpdateManagedUserInput"+ }+ }+ }+ },"responses": {"200": {"description": "","content": {"application/json": {"schema": {- "$ref": "#/components/schemas/ConferencingAppOutputResponseDto"+ "$ref": "#/components/schemas/UpdateMeOutput"}}}}},"tags": [- "Organizations/Teams Conferencing"+ "Me"]}},- "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/oauth/auth-url": {- "get": {- "operationId": "OrganizationsConferencingController_getTeamOAuthUrl",- "summary": "Get OAuth conferencing app's auth url for a team",+ "/v2/oauth-clients": {+ "post": {+ "operationId": "OAuthClientsController_createOAuthClient",+ "summary": "Create an OAuth client","parameters": [{"name": "Authorization",- "required": true,"in": "header",- "schema": {- "type": "string"- }- },- {- "name": "teamId",- "required": true,- "in": "path",- "schema": {- "type": "string"- }- },- {- "name": "orgId",- "required": true,- "in": "path",- "schema": {- "type": "string"- }- },- {- "name": "app",- "required": true,- "in": "path",- "description": "Conferencing application type",- "schema": {- "enum": [- "zoom",- "msteams"- ],- "type": "string"- }- },- {- "name": "returnTo",- "required": true,- "in": "query",- "schema": {- "type": "string"- }- },- {- "name": "onErrorReturnTo",+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_","required": true,- "in": "query","schema": {"type": "string"}}],+ "requestBody": {+ "required": true,+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/CreateOAuthClientInput"+ }+ }+ }+ },"responses": {- "200": {- "description": "",+ "201": {+ "description": "Create an OAuth client","content": {"application/json": {"schema": {- "$ref": "#/components/schemas/GetConferencingAppsOauthUrlResponseDto"+ "$ref": "#/components/schemas/CreateOAuthClientResponseDto"}}}}},"tags": [- "Organizations/Teams Conferencing"+ "OAuth Clients"]- }- },- "/v2/organizations/{orgId}/teams/{teamId}/conferencing": {+ },"get": {- "operationId": "OrganizationsConferencingController_listTeamConferencingApps",- "summary": "List team conferencing applications",+ "operationId": "OAuthClientsController_getOAuthClients",+ "summary": "Get all OAuth clients","parameters": [{- "name": "teamId",+ "name": "Authorization",+ "in": "header",+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_","required": true,- "in": "path","schema": {- "type": "number"+ "type": "string"}}],@@ -8799,42 +8816,36 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/ConferencingAppsOutputResponseDto"+ "$ref": "#/components/schemas/GetOAuthClientsResponseDto"}}}}},"tags": [- "Organizations/Teams Conferencing"+ "OAuth Clients"]}},- "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/default": {- "post": {- "operationId": "OrganizationsConferencingController_setTeamDefaultApp",- "summary": "Set team default conferencing application",+ "/v2/oauth-clients/{clientId}": {+ "get": {+ "operationId": "OAuthClientsController_getOAuthClientById",+ "summary": "Get an OAuth client","parameters": [{- "name": "teamId",+ "name": "Authorization",+ "in": "header",+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_","required": true,- "in": "path","schema": {- "type": "number"+ "type": "string"}},{- "name": "app",+ "name": "clientId","required": true,"in": "path",- "description": "Conferencing application type","schema": {- "enum": [- "google-meet",- "zoom",- "msteams",- "daily-video"- ],"type": "string"}}@@ -8845,87 +8856,82 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/SetDefaultConferencingAppOutputResponseDto"+ "$ref": "#/components/schemas/GetOAuthClientResponseDto"}}}}},"tags": [- "Organizations/Teams Conferencing"+ "OAuth Clients"]- }- },- "/v2/organizations/{orgId}/teams/{teamId}/conferencing/default": {- "get": {- "operationId": "OrganizationsConferencingController_getTeamDefaultApp",- "summary": "Get team default conferencing application",+ },+ "patch": {+ "operationId": "OAuthClientsController_updateOAuthClient",+ "summary": "Update an OAuth client","parameters": [{- "name": "teamId",+ "name": "Authorization",+ "in": "header",+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_","required": true,- "in": "path","schema": {- "type": "number"+ "type": "string"}},{- "name": "app",+ "name": "clientId","required": true,"in": "path",- "description": "Conferencing application type","schema": {- "enum": [- "google-meet",- "zoom",- "msteams",- "daily-video"- ],"type": "string"}}],+ "requestBody": {+ "required": true,+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/UpdateOAuthClientInput"+ }+ }+ }+ },"responses": {"200": {"description": "","content": {"application/json": {"schema": {- "$ref": "#/components/schemas/GetDefaultConferencingAppOutputResponseDto"+ "$ref": "#/components/schemas/GetOAuthClientResponseDto"}}}}},"tags": [- "Organizations/Teams Conferencing"+ "OAuth Clients"]- }- },- "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/disconnect": {+ },"delete": {- "operationId": "OrganizationsConferencingController_disconnectTeamApp",- "summary": "Disconnect team conferencing application",+ "operationId": "OAuthClientsController_deleteOAuthClient",+ "summary": "Delete an OAuth client","parameters": [{- "name": "teamId",+ "name": "Authorization",+ "in": "header",+ "description": "value must be `Bearer <token>` where `<token>` is api key prefixed with cal_","required": true,- "in": "path","schema": {- "type": "number"+ "type": "string"}},{- "name": "app",+ "name": "clientId","required": true,"in": "path",- "description": "Conferencing application type","schema": {- "enum": [- "google-meet",- "zoom",- "msteams"- ],"type": "string"}}@@ -8936,14 +8942,14 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/DisconnectConferencingAppOutputResponseDto"+ "$ref": "#/components/schemas/GetOAuthClientResponseDto"}}}}},"tags": [- "Organizations/Teams Conferencing"+ "OAuth Clients"]}},diff --git a/docs/api-reference/v2/openapi.json b/docs/api-reference/v2/openapi.jsonindex 492334a1a30..b804f52bbff 100644--- a/docs/api-reference/v2/openapi.json+++ b/docs/api-reference/v2/openapi.json@@ -2310,7 +2310,8 @@"name": "teamIds","required": false,"in": "query",- "description": "Filter by teamIds",+ "description": "Filter by teamIds. Team ids must be separated by a comma.",+ "example": "?teamIds=100,200","schema": {"type": "array","items": {@@ -3199,40 +3200,21 @@"tags": ["Orgs / Teams / Bookings"]}},- "/v2/organizations/{orgId}/teams/{teamId}/event-types": {+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/connect": {"post": {- "operationId": "OrganizationsEventTypesController_createTeamEventType",- "summary": "Create an event type",+ "operationId": "OrganizationsConferencingController_connectTeamApp",+ "summary": "Connect your conferencing application to a team","parameters": [{- "name": "Authorization",- "in": "header",- "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",- "required": false,- "schema": {- "type": "string"- }- },- {- "name": "x-cal-secret-key",- "in": "header",- "description": "For platform customers - OAuth client secret key",- "required": false,- "schema": {- "type": "string"- }- },- {- "name": "x-cal-client-id",- "in": "header",- "description": "For platform customers - OAuth client ID",- "required": false,+ "name": "teamId",+ "required": true,+ "in": "path","schema": {- "type": "string"+ "type": "number"}},{- "name": "teamId",+ "name": "orgId","required": true,"in": "path","schema": {@@ -3240,93 +3222,84 @@}},{- "name": "orgId",+ "name": "app","required": true,"in": "path",+ "description": "Conferencing application type","schema": {- "type": "number"+ "enum": ["google-meet"],+ "type": "string"}}],- "requestBody": {- "required": true,- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/CreateTeamEventTypeInput_2024_06_14"- }- }- }- },"responses": {- "201": {+ "200": {"description": "","content": {"application/json": {"schema": {- "$ref": "#/components/schemas/CreateTeamEventTypeOutput"+ "$ref": "#/components/schemas/ConferencingAppOutputResponseDto"}}}}},- "tags": ["Orgs / Teams / Event Types"]- },+ "tags": ["Orgs / Teams / Conferencing"]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/oauth/auth-url": {"get": {- "operationId": "OrganizationsEventTypesController_getTeamEventTypes",- "summary": "Get a team event type",+ "operationId": "OrganizationsConferencingController_getTeamOAuthUrl",+ "summary": "Get OAuth conferencing app's auth url for a team","parameters": [{"name": "Authorization",+ "required": true,"in": "header",- "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",- "required": false,"schema": {"type": "string"}},{- "name": "x-cal-secret-key",- "in": "header",- "description": "For platform customers - OAuth client secret key",- "required": false,+ "name": "teamId",+ "required": true,+ "in": "path","schema": {"type": "string"}},{- "name": "x-cal-client-id",- "in": "header",- "description": "For platform customers - OAuth client ID",- "required": false,+ "name": "orgId",+ "required": true,+ "in": "path","schema": {"type": "string"}},{- "name": "teamId",+ "name": "app","required": true,"in": "path",+ "description": "Conferencing application type","schema": {- "type": "number"+ "enum": ["zoom", "msteams"],+ "type": "string"}},{- "name": "eventSlug",- "required": false,+ "name": "returnTo",+ "required": true,"in": "query",- "description": "Slug of team event type to return.","schema": {"type": "string"}},{- "name": "hostsLimit",- "required": false,+ "name": "onErrorReturnTo",+ "required": true,"in": "query",- "description": "Specifies the maximum number of hosts to include in the response. This limit helps optimize performance. If not provided, all Hosts will be fetched.","schema": {- "type": "number"+ "type": "string"}}],@@ -3336,47 +3309,127 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/GetTeamEventTypesOutput"+ "$ref": "#/components/schemas/GetConferencingAppsOauthUrlResponseDto"}}}}},- "tags": ["Orgs / Teams / Event Types"]+ "tags": ["Orgs / Teams / Conferencing"]}},- "/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}": {+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing": {"get": {- "operationId": "OrganizationsEventTypesController_getTeamEventType",- "summary": "Get an event type",+ "operationId": "OrganizationsConferencingController_listTeamConferencingApps",+ "summary": "List team conferencing applications","parameters": [{- "name": "Authorization",- "in": "header",- "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",- "required": false,+ "name": "teamId",+ "required": true,+ "in": "path","schema": {- "type": "string"+ "type": "number"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ConferencingAppsOutputResponseDto"+ }+ }+ }+ }+ },+ "tags": ["Orgs / Teams / Conferencing"]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/default": {+ "post": {+ "operationId": "OrganizationsConferencingController_setTeamDefaultApp",+ "summary": "Set team default conferencing application",+ "parameters": [+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"}},{- "name": "x-cal-secret-key",- "in": "header",- "description": "For platform customers - OAuth client secret key",- "required": false,+ "name": "app",+ "required": true,+ "in": "path",+ "description": "Conferencing application type","schema": {+ "enum": ["google-meet", "zoom", "msteams", "daily-video"],"type": "string"}+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/SetDefaultConferencingAppOutputResponseDto"+ }+ }+ }+ }+ },+ "tags": ["Orgs / Teams / Conferencing"]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing/default": {+ "get": {+ "operationId": "OrganizationsConferencingController_getTeamDefaultApp",+ "summary": "Get team default conferencing application",+ "parameters": [+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }},{- "name": "x-cal-client-id",- "in": "header",- "description": "For platform customers - OAuth client ID",- "required": false,+ "name": "app",+ "required": true,+ "in": "path",+ "description": "Conferencing application type","schema": {+ "enum": ["google-meet", "zoom", "msteams", "daily-video"],"type": "string"}- },+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/GetDefaultConferencingAppOutputResponseDto"+ }+ }+ }+ }+ },+ "tags": ["Orgs / Teams / Conferencing"]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/disconnect": {+ "delete": {+ "operationId": "OrganizationsConferencingController_disconnectTeamApp",+ "summary": "Disconnect team conferencing application",+ "parameters": [{"name": "teamId","required": true,@@ -3386,11 +3439,13 @@}},{- "name": "eventTypeId",+ "name": "app","required": true,"in": "path",+ "description": "Conferencing application type","schema": {- "type": "number"+ "enum": ["google-meet", "zoom", "msteams"],+ "type": "string"}}],@@ -3400,17 +3455,19 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/GetTeamEventTypeOutput"+ "$ref": "#/components/schemas/DisconnectConferencingAppOutputResponseDto"}}}}},- "tags": ["Orgs / Teams / Event Types"]- },- "patch": {- "operationId": "OrganizationsEventTypesController_updateTeamEventType",- "summary": "Update a team event type",+ "tags": ["Orgs / Teams / Conferencing"]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/event-types": {+ "post": {+ "operationId": "OrganizationsEventTypesController_createTeamEventType",+ "summary": "Create an event type","parameters": [{"name": "Authorization",@@ -3448,7 +3505,7 @@}},{- "name": "eventTypeId",+ "name": "orgId","required": true,"in": "path","schema": {@@ -3461,18 +3518,18 @@"content": {"application/json": {"schema": {- "$ref": "#/components/schemas/UpdateTeamEventTypeInput_2024_06_14"+ "$ref": "#/components/schemas/CreateTeamEventTypeInput_2024_06_14"}}}},"responses": {- "200": {+ "201": {"description": "","content": {"application/json": {"schema": {- "$ref": "#/components/schemas/UpdateTeamEventTypeOutput"+ "$ref": "#/components/schemas/CreateTeamEventTypeOutput"}}}@@ -3480,9 +3537,9 @@},"tags": ["Orgs / Teams / Event Types"]},- "delete": {- "operationId": "OrganizationsEventTypesController_deleteTeamEventType",- "summary": "Delete a team event type",+ "get": {+ "operationId": "OrganizationsEventTypesController_getTeamEventTypes",+ "summary": "Get a team event type","parameters": [{"name": "Authorization",@@ -3520,13 +3577,221 @@}},{- "name": "eventTypeId",- "required": true,- "in": "path",+ "name": "eventSlug",+ "required": false,+ "in": "query",+ "description": "Slug of team event type to return.","schema": {- "type": "number"+ "type": "string"}- }+ },+ {+ "name": "hostsLimit",+ "required": false,+ "in": "query",+ "description": "Specifies the maximum number of hosts to include in the response. This limit helps optimize performance. If not provided, all Hosts will be fetched.",+ "schema": {+ "type": "number"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/GetTeamEventTypesOutput"+ }+ }+ }+ }+ },+ "tags": ["Orgs / Teams / Event Types"]+ }+ },+ "/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}": {+ "get": {+ "operationId": "OrganizationsEventTypesController_getTeamEventType",+ "summary": "Get an event type",+ "parameters": [+ {+ "name": "Authorization",+ "in": "header",+ "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",+ "required": false,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "x-cal-secret-key",+ "in": "header",+ "description": "For platform customers - OAuth client secret key",+ "required": false,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "x-cal-client-id",+ "in": "header",+ "description": "For platform customers - OAuth client ID",+ "required": false,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ },+ {+ "name": "eventTypeId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/GetTeamEventTypeOutput"+ }+ }+ }+ }+ },+ "tags": ["Orgs / Teams / Event Types"]+ },+ "patch": {+ "operationId": "OrganizationsEventTypesController_updateTeamEventType",+ "summary": "Update a team event type",+ "parameters": [+ {+ "name": "Authorization",+ "in": "header",+ "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",+ "required": false,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "x-cal-secret-key",+ "in": "header",+ "description": "For platform customers - OAuth client secret key",+ "required": false,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "x-cal-client-id",+ "in": "header",+ "description": "For platform customers - OAuth client ID",+ "required": false,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ },+ {+ "name": "eventTypeId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ }+ ],+ "requestBody": {+ "required": true,+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/UpdateTeamEventTypeInput_2024_06_14"+ }+ }+ }+ },+ "responses": {+ "200": {+ "description": "",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/UpdateTeamEventTypeOutput"+ }+ }+ }+ }+ },+ "tags": ["Orgs / Teams / Event Types"]+ },+ "delete": {+ "operationId": "OrganizationsEventTypesController_deleteTeamEventType",+ "summary": "Delete a team event type",+ "parameters": [+ {+ "name": "Authorization",+ "in": "header",+ "description": "For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_",+ "required": false,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "x-cal-secret-key",+ "in": "header",+ "description": "For platform customers - OAuth client secret key",+ "required": false,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "x-cal-client-id",+ "in": "header",+ "description": "For platform customers - OAuth client ID",+ "required": false,+ "schema": {+ "type": "string"+ }+ },+ {+ "name": "teamId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ },+ {+ "name": "eventTypeId",+ "required": true,+ "in": "path",+ "schema": {+ "type": "number"+ }+ }],"responses": {"200": {@@ -6452,7 +6717,8 @@"/v2/bookings/{bookingUid}/mark-absent": {"post": {"operationId": "BookingsController_2024_08_13_markNoShow",- "summary": "Mark a booking absence - provided authorization header refers to owner of the booking.",+ "summary": "Mark a booking absence",+ "description": "The provided authorization header refers to the owner of the booking.","parameters": [{"name": "cal-api-version",@@ -6510,7 +6776,8 @@"/v2/bookings/{bookingUid}/reassign": {"post": {"operationId": "BookingsController_2024_08_13_reassignBooking",- "summary": "Automatically reassign booking to a new host automatically - provided authorization header refers to person who reassigned the booking.",+ "summary": "Reassign booking to auto-selected host",+ "description": "The provided authorization header refers to the owner of the booking.","parameters": [{"name": "cal-api-version",@@ -6558,7 +6825,8 @@"/v2/bookings/{bookingUid}/reassign/{userId}": {"post": {"operationId": "BookingsController_2024_08_13_reassignBookingToUser",- "summary": "Reassign a booking to a specific user specified by the :userId - provided authorization header refers to person who reassigned the booking.",+ "summary": "Reassign a booking to a specific host",+ "description": "The provided authorization header refers to the owner of the booking.","parameters": [{"name": "cal-api-version",@@ -6624,7 +6892,8 @@"/v2/bookings/{bookingUid}/confirm": {"post": {"operationId": "BookingsController_2024_08_13_confirmBooking",- "summary": "Confirm booking that requires a confirmation - provided authorization header refers to owner of the booking.",+ "summary": "Confirm a booking",+ "description": "The provided authorization header refers to the owner of the booking.","parameters": [{"name": "cal-api-version",@@ -6672,7 +6941,8 @@"/v2/bookings/{bookingUid}/decline": {"post": {"operationId": "BookingsController_2024_08_13_declineBooking",- "summary": "Decline booking that requires a confirmation - provided authorization header refers to owner of the booking.",+ "summary": "Decline a booking",+ "description": "The provided authorization header refers to the owner of the booking.","parameters": [{"name": "cal-api-version",@@ -8250,270 +8520,6 @@"tags": ["OAuth Clients"]}},- "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/connect": {- "post": {- "operationId": "OrganizationsConferencingController_connectTeamApp",- "summary": "Connect your conferencing application to a team",- "parameters": [- {- "name": "teamId",- "required": true,- "in": "path",- "schema": {- "type": "number"- }- },- {- "name": "orgId",- "required": true,- "in": "path",- "schema": {- "type": "number"- }- },- {- "name": "app",- "required": true,- "in": "path",- "description": "Conferencing application type",- "schema": {- "enum": ["google-meet"],- "type": "string"- }- }- ],- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/ConferencingAppOutputResponseDto"- }- }- }- }- },- "tags": ["Organizations/Teams Conferencing"]- }- },- "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/oauth/auth-url": {- "get": {- "operationId": "OrganizationsConferencingController_getTeamOAuthUrl",- "summary": "Get OAuth conferencing app's auth url for a team",- "parameters": [- {- "name": "Authorization",- "required": true,- "in": "header",- "schema": {- "type": "string"- }- },- {- "name": "teamId",- "required": true,- "in": "path",- "schema": {- "type": "string"- }- },- {- "name": "orgId",- "required": true,- "in": "path",- "schema": {- "type": "string"- }- },- {- "name": "app",- "required": true,- "in": "path",- "description": "Conferencing application type",- "schema": {- "enum": ["zoom", "msteams"],- "type": "string"- }- },- {- "name": "returnTo",- "required": true,- "in": "query",- "schema": {- "type": "string"- }- },- {- "name": "onErrorReturnTo",- "required": true,- "in": "query",- "schema": {- "type": "string"- }- }- ],- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/GetConferencingAppsOauthUrlResponseDto"- }- }- }- }- },- "tags": ["Organizations/Teams Conferencing"]- }- },- "/v2/organizations/{orgId}/teams/{teamId}/conferencing": {- "get": {- "operationId": "OrganizationsConferencingController_listTeamConferencingApps",- "summary": "List team conferencing applications",- "parameters": [- {- "name": "teamId",- "required": true,- "in": "path",- "schema": {- "type": "number"- }- }- ],- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/ConferencingAppsOutputResponseDto"- }- }- }- }- },- "tags": ["Organizations/Teams Conferencing"]- }- },- "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/default": {- "post": {- "operationId": "OrganizationsConferencingController_setTeamDefaultApp",- "summary": "Set team default conferencing application",- "parameters": [- {- "name": "teamId",- "required": true,- "in": "path",- "schema": {- "type": "number"- }- },- {- "name": "app",- "required": true,- "in": "path",- "description": "Conferencing application type",- "schema": {- "enum": ["google-meet", "zoom", "msteams", "daily-video"],- "type": "string"- }- }- ],- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/SetDefaultConferencingAppOutputResponseDto"- }- }- }- }- },- "tags": ["Organizations/Teams Conferencing"]- }- },- "/v2/organizations/{orgId}/teams/{teamId}/conferencing/default": {- "get": {- "operationId": "OrganizationsConferencingController_getTeamDefaultApp",- "summary": "Get team default conferencing application",- "parameters": [- {- "name": "teamId",- "required": true,- "in": "path",- "schema": {- "type": "number"- }- },- {- "name": "app",- "required": true,- "in": "path",- "description": "Conferencing application type",- "schema": {- "enum": ["google-meet", "zoom", "msteams", "daily-video"],- "type": "string"- }- }- ],- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/GetDefaultConferencingAppOutputResponseDto"- }- }- }- }- },- "tags": ["Organizations/Teams Conferencing"]- }- },- "/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/disconnect": {- "delete": {- "operationId": "OrganizationsConferencingController_disconnectTeamApp",- "summary": "Disconnect team conferencing application",- "parameters": [- {- "name": "teamId",- "required": true,- "in": "path",- "schema": {- "type": "number"- }- },- {- "name": "app",- "required": true,- "in": "path",- "description": "Conferencing application type",- "schema": {- "enum": ["google-meet", "zoom", "msteams"],- "type": "string"- }- }- ],- "responses": {- "200": {- "description": "",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/DisconnectConferencingAppOutputResponseDto"- }- }- }- }- },- "tags": ["Organizations/Teams Conferencing"]- }- },"/v2/schedules": {"post": {"operationId": "SchedulesController_2024_06_11_createSchedule",