@connectedxm/admin-sdk 7.5.0 → 7.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1212 -1212
- package/api.ts +9696 -9696
- package/dist/api.d.ts +9696 -9696
- package/dist/api.js +9696 -9696
- package/dist/esm/api.d.ts +9696 -9696
- package/dist/esm/api.js +9696 -9696
- package/docs/AccountsAddressesApi.md +10 -10
- package/docs/AccountsApi.md +42 -42
- package/docs/AccountsFollowersApi.md +6 -6
- package/docs/AccountsFollowingApi.md +6 -6
- package/docs/AccountsGroupsApi.md +6 -6
- package/docs/AccountsInterestsApi.md +6 -6
- package/docs/AccountsInvitationsApi.md +6 -6
- package/docs/AccountsLeadsApi.md +8 -8
- package/docs/AccountsTiersApi.md +8 -8
- package/docs/ActivitiesApi.md +18 -18
- package/docs/ActivitiesScheduleApi.md +4 -4
- package/docs/AdvertisementsApi.md +14 -14
- package/docs/AnnouncementsApi.md +16 -16
- package/docs/AnnouncementsScheduleApi.md +4 -4
- package/docs/AnnouncementsTranslationsApi.md +8 -8
- package/docs/ApiLogsApi.md +4 -4
- package/docs/AuthSessionsApi.md +4 -4
- package/docs/BenefitsApi.md +12 -12
- package/docs/BenefitsTranslationsApi.md +8 -8
- package/docs/BookingsApi.md +56 -56
- package/docs/BookingsAvailabilitiesApi.md +6 -6
- package/docs/BookingsBlackoutsApi.md +6 -6
- package/docs/BookingsPlacesApi.md +6 -6
- package/docs/BookingsPlacesTranslationsApi.md +4 -4
- package/docs/BookingsQuestionsApi.md +16 -16
- package/docs/BookingsQuestionsChoicesApi.md +12 -12
- package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
- package/docs/BookingsQuestionsTranslationsApi.md +8 -8
- package/docs/BookingsSpacesApi.md +6 -6
- package/docs/BookingsSpacesTranslationsApi.md +4 -4
- package/docs/ChannelsApi.md +58 -58
- package/docs/ChannelsTranslationsApi.md +24 -24
- package/docs/DashboardsApi.md +10 -10
- package/docs/DashboardsWidgetsApi.md +8 -8
- package/docs/EmailReceiptsApi.md +4 -4
- package/docs/EventsAccessApi.md +6 -6
- package/docs/EventsActivationsApi.md +22 -22
- package/docs/EventsActivationsSessionsApi.md +6 -6
- package/docs/EventsActivationsTranslationsApi.md +8 -8
- package/docs/EventsAddonsApi.md +24 -24
- package/docs/EventsAddonsTranslationsApi.md +8 -8
- package/docs/EventsApi.md +22 -22
- package/docs/EventsAttendeesApi.md +24 -24
- package/docs/EventsAttendeesPackagesApi.md +10 -10
- package/docs/EventsAttendeesReservationsApi.md +18 -18
- package/docs/EventsAttributesApi.md +10 -10
- package/docs/EventsBenefitsApi.md +4 -4
- package/docs/EventsBlocksApi.md +16 -16
- package/docs/EventsBypassApi.md +10 -10
- package/docs/EventsCohostsApi.md +6 -6
- package/docs/EventsCouponsApi.md +28 -28
- package/docs/EventsEmailsApi.md +4 -4
- package/docs/EventsEmailsTranslationsApi.md +8 -8
- package/docs/EventsFaqsApi.md +22 -22
- package/docs/EventsFaqsTranslationsApi.md +16 -16
- package/docs/EventsFollowupsApi.md +38 -38
- package/docs/EventsFollowupsTranslationsApi.md +8 -8
- package/docs/EventsMatchesApi.md +34 -34
- package/docs/EventsMediaApi.md +16 -16
- package/docs/EventsMediaTranslationsApi.md +8 -8
- package/docs/EventsOnSiteApi.md +6 -6
- package/docs/EventsPackagesApi.md +10 -10
- package/docs/EventsPackagesPassesApi.md +10 -10
- package/docs/EventsPackagesTranslationsApi.md +8 -8
- package/docs/EventsPagesApi.md +16 -16
- package/docs/EventsPagesTranslationsApi.md +8 -8
- package/docs/EventsPassesAccessesApi.md +10 -10
- package/docs/EventsPassesAddonsApi.md +6 -6
- package/docs/EventsPassesApi.md +34 -34
- package/docs/EventsPassesAttributesApi.md +6 -6
- package/docs/EventsPassesFollowupsApi.md +8 -8
- package/docs/EventsPassesResponsesApi.md +10 -10
- package/docs/EventsPasstypesApi.md +34 -34
- package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
- package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
- package/docs/EventsPasstypesTranslationsApi.md +8 -8
- package/docs/EventsQuestionsApi.md +44 -44
- package/docs/EventsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsRoomsApi.md +18 -18
- package/docs/EventsRoomtypesApi.md +24 -24
- package/docs/EventsRoomtypesTranslationsApi.md +8 -8
- package/docs/EventsSectionsApi.md +38 -38
- package/docs/EventsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsAccessesApi.md +6 -6
- package/docs/EventsSessionsApi.md +70 -70
- package/docs/EventsSessionsLocationsApi.md +16 -16
- package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
- package/docs/EventsSessionsMatchesApi.md +32 -32
- package/docs/EventsSessionsPricesApi.md +6 -6
- package/docs/EventsSessionsQuestionsApi.md +38 -38
- package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsSessionsSectionsApi.md +20 -20
- package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsTimesApi.md +16 -16
- package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
- package/docs/EventsSessionsTranslationsApi.md +8 -8
- package/docs/EventsSpeakersApi.md +16 -16
- package/docs/EventsSpeakersTranslationsApi.md +8 -8
- package/docs/EventsSponsorsApi.md +8 -8
- package/docs/EventsSponsorshiplevelsApi.md +12 -12
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
- package/docs/EventsSponsorshipsApi.md +12 -12
- package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
- package/docs/EventsTemplatesApi.md +2 -2
- package/docs/EventsTracksApi.md +22 -22
- package/docs/EventsTracksTranslationsApi.md +8 -8
- package/docs/EventsTransfersApi.md +4 -4
- package/docs/EventsTranslationsApi.md +8 -8
- package/docs/FilesApi.md +4 -4
- package/docs/GroupsApi.md +12 -12
- package/docs/GroupsEventsApi.md +6 -6
- package/docs/GroupsInterestsApi.md +6 -6
- package/docs/GroupsInvitationsApi.md +12 -12
- package/docs/GroupsMembersApi.md +8 -8
- package/docs/GroupsModeratorsApi.md +6 -6
- package/docs/GroupsRequestsApi.md +10 -10
- package/docs/GroupsSponsorsApi.md +6 -6
- package/docs/GroupsTranslationsApi.md +8 -8
- package/docs/ImportsApi.md +8 -8
- package/docs/InterestsApi.md +22 -22
- package/docs/InvoicesApi.md +20 -20
- package/docs/InvoicesLineitemsApi.md +6 -6
- package/docs/LoginsAccountsApi.md +6 -6
- package/docs/LoginsApi.md +16 -16
- package/docs/MeetingsApi.md +14 -14
- package/docs/MeetingsLinksApi.md +10 -10
- package/docs/MeetingsLivestreamsApi.md +12 -12
- package/docs/MeetingsParticipantsApi.md +12 -12
- package/docs/MeetingsPresetsApi.md +10 -10
- package/docs/MeetingsRecordingsApi.md +4 -4
- package/docs/MeetingsSessionsApi.md +16 -16
- package/docs/NotificationsApi.md +8 -8
- package/docs/OrganizationApi.md +18 -18
- package/docs/OrganizationAttributesApi.md +14 -14
- package/docs/OrganizationDomainsApi.md +6 -6
- package/docs/OrganizationIntegrationsApi.md +10 -10
- package/docs/OrganizationModulesApi.md +6 -6
- package/docs/OrganizationModulesCustomApi.md +10 -10
- package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
- package/docs/OrganizationModulesSettingsApi.md +4 -4
- package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
- package/docs/OrganizationModulesTiersApi.md +12 -12
- package/docs/OrganizationPaymentsApi.md +20 -20
- package/docs/OrganizationSideeffectsApi.md +8 -8
- package/docs/OrganizationTaxApi.md +22 -22
- package/docs/OrganizationTeammembersApi.md +10 -10
- package/docs/OrganizationUsersApi.md +6 -6
- package/docs/OrganizationWebhooksApi.md +12 -12
- package/docs/PaymentsApi.md +2 -2
- package/docs/PreferencesApi.md +4 -4
- package/docs/PushDevicesApi.md +6 -6
- package/docs/ReportsApi.md +22 -22
- package/docs/ReportsUsersApi.md +6 -6
- package/docs/SearchlistsApi.md +10 -10
- package/docs/SearchlistsValuesApi.md +14 -14
- package/docs/SelfApi.md +10 -10
- package/docs/SelfApikeysApi.md +8 -8
- package/docs/SelfImagesApi.md +4 -4
- package/docs/SeriesApi.md +18 -18
- package/docs/SeriesQuestionsApi.md +14 -14
- package/docs/SeriesQuestionsChoicesApi.md +8 -8
- package/docs/SeriesQuestionsTranslationsApi.md +4 -4
- package/docs/SeriesRegistrationsApi.md +18 -18
- package/docs/SeriesTranslationsApi.md +8 -8
- package/docs/SponsorsAccountsApi.md +6 -6
- package/docs/SponsorsApi.md +10 -10
- package/docs/SponsorsTranslationsApi.md +8 -8
- package/docs/StorageFilesApi.md +6 -6
- package/docs/StorageImagesApi.md +18 -18
- package/docs/StorageVideosApi.md +14 -14
- package/docs/StorageVideosCaptionsApi.md +10 -10
- package/docs/StreamsApi.md +14 -14
- package/docs/StreamsOutputsApi.md +10 -10
- package/docs/StreamsSessionsApi.md +12 -12
- package/docs/SupportApi.md +14 -14
- package/docs/SupportMessagesApi.md +4 -4
- package/docs/SupportNotesApi.md +6 -6
- package/docs/SurveysApi.md +12 -12
- package/docs/SurveysQuestionsApi.md +38 -38
- package/docs/SurveysQuestionsTranslationsApi.md +16 -16
- package/docs/SurveysSectionsApi.md +20 -20
- package/docs/SurveysSectionsTranslationsApi.md +8 -8
- package/docs/SurveysSessionsApi.md +4 -4
- package/docs/SurveysSubmissionsApi.md +14 -14
- package/docs/SurveysTranslationsApi.md +8 -8
- package/docs/ThreadsAccountsApi.md +8 -8
- package/docs/ThreadsApi.md +10 -10
- package/docs/ThreadsMessagesApi.md +12 -12
- package/docs/ThreadsMessagesFilesApi.md +6 -6
- package/docs/ThreadsMessagesImagesApi.md +6 -6
- package/docs/ThreadsMessagesReactionsApi.md +6 -6
- package/docs/ThreadsMessagesVideosApi.md +6 -6
- package/docs/ThreadsStorageApi.md +6 -6
- package/docs/TiersApi.md +20 -20
- package/package.json +1 -1
package/docs/BookingsApi.md
CHANGED
|
@@ -4,39 +4,39 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addBookingSpaceTier**](#addbookingspacetier) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/tiers/{tierId} | Add
|
|
8
|
-
|[**cancelBooking**](#cancelbooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/cancel | Cancel
|
|
9
|
-
|[**checkInBooking**](#checkinbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/checkin | Check
|
|
10
|
-
|[**createBooking**](#createbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings | Create
|
|
11
|
-
|[**deleteBooking**](#deletebooking) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Delete
|
|
12
|
-
|[**getBooking**](#getbooking) | **GET** /bookings/{bookingId} | Get
|
|
13
|
-
|[**getBookingPlace**](#getbookingplace) | **GET** /bookings/places/{placeId} | Get
|
|
14
|
-
|[**getBookingPlaceBookings**](#getbookingplacebookings) | **GET** /bookings/places/{placeId}/bookings |
|
|
15
|
-
|[**getBookingPlacePayments**](#getbookingplacepayments) | **GET** /bookings/places/{placeId}/payments |
|
|
16
|
-
|[**getBookingPlaceTranslation**](#getbookingplacetranslation) | **GET** /bookings/places/{placeId}/translations/{locale} | Get
|
|
17
|
-
|[**getBookingPlaceTranslations**](#getbookingplacetranslations) | **GET** /bookings/places/{placeId}/translations |
|
|
18
|
-
|[**getBookingPlaces**](#getbookingplaces) | **GET** /bookings/places |
|
|
19
|
-
|[**getBookingResponses**](#getbookingresponses) | **GET** /bookings/{bookingId}/responses |
|
|
20
|
-
|[**getBookingSpace**](#getbookingspace) | **GET** /bookings/places/{placeId}/spaces/{spaceId} | Get
|
|
21
|
-
|[**getBookingSpaceAvailabilities**](#getbookingspaceavailabilities) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/availabilities |
|
|
22
|
-
|[**getBookingSpaceAvailability**](#getbookingspaceavailability) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/blackouts/{availabilityId} | Get
|
|
23
|
-
|[**getBookingSpaceBlackout**](#getbookingspaceblackout) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/blackouts/{blackoutId} | Get
|
|
24
|
-
|[**getBookingSpaceBlackouts**](#getbookingspaceblackouts) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/blackouts |
|
|
25
|
-
|[**getBookingSpaceBookings**](#getbookingspacebookings) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/bookings |
|
|
26
|
-
|[**getBookingSpacePayments**](#getbookingspacepayments) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/payments |
|
|
27
|
-
|[**getBookingSpaceSlots**](#getbookingspaceslots) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/slots | Get
|
|
28
|
-
|[**getBookingSpaceTiers**](#getbookingspacetiers) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/tiers |
|
|
29
|
-
|[**getBookingSpaceTranslation**](#getbookingspacetranslation) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/translations/{locale} | Get
|
|
30
|
-
|[**getBookingSpaceTranslations**](#getbookingspacetranslations) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/translations |
|
|
31
|
-
|[**getBookingSpaces**](#getbookingspaces) | **GET** /bookings/places/{placeId}/spaces |
|
|
32
|
-
|[**removeBookingSpaceTier**](#removebookingspacetier) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/tiers/{tierId} | Remove
|
|
33
|
-
|[**undoCheckInBooking**](#undocheckinbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/checkin/undo | Undo
|
|
34
|
-
|[**updateBooking**](#updatebooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Update
|
|
7
|
+
|[**addBookingSpaceTier**](#addbookingspacetier) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/tiers/{tierId} | Add an account tier to a booking space|
|
|
8
|
+
|[**cancelBooking**](#cancelbooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/cancel | Cancel a booking|
|
|
9
|
+
|[**checkInBooking**](#checkinbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/checkin | Check in a booking|
|
|
10
|
+
|[**createBooking**](#createbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings | Create a booking for a space|
|
|
11
|
+
|[**deleteBooking**](#deletebooking) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Delete a booking|
|
|
12
|
+
|[**getBooking**](#getbooking) | **GET** /bookings/{bookingId} | Get a booking|
|
|
13
|
+
|[**getBookingPlace**](#getbookingplace) | **GET** /bookings/places/{placeId} | Get a booking place|
|
|
14
|
+
|[**getBookingPlaceBookings**](#getbookingplacebookings) | **GET** /bookings/places/{placeId}/bookings | List a booking place\'s bookings|
|
|
15
|
+
|[**getBookingPlacePayments**](#getbookingplacepayments) | **GET** /bookings/places/{placeId}/payments | List a booking place\'s payments|
|
|
16
|
+
|[**getBookingPlaceTranslation**](#getbookingplacetranslation) | **GET** /bookings/places/{placeId}/translations/{locale} | Get a booking place\'s translation|
|
|
17
|
+
|[**getBookingPlaceTranslations**](#getbookingplacetranslations) | **GET** /bookings/places/{placeId}/translations | List a booking place\'s translations|
|
|
18
|
+
|[**getBookingPlaces**](#getbookingplaces) | **GET** /bookings/places | List booking places|
|
|
19
|
+
|[**getBookingResponses**](#getbookingresponses) | **GET** /bookings/{bookingId}/responses | List a booking\'s question responses|
|
|
20
|
+
|[**getBookingSpace**](#getbookingspace) | **GET** /bookings/places/{placeId}/spaces/{spaceId} | Get a booking space|
|
|
21
|
+
|[**getBookingSpaceAvailabilities**](#getbookingspaceavailabilities) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/availabilities | List a booking space\'s weekly availability rules|
|
|
22
|
+
|[**getBookingSpaceAvailability**](#getbookingspaceavailability) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/blackouts/{availabilityId} | Get a booking space blackout by id|
|
|
23
|
+
|[**getBookingSpaceBlackout**](#getbookingspaceblackout) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/blackouts/{blackoutId} | Get a booking space blackout|
|
|
24
|
+
|[**getBookingSpaceBlackouts**](#getbookingspaceblackouts) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/blackouts | List a booking space\'s blackouts|
|
|
25
|
+
|[**getBookingSpaceBookings**](#getbookingspacebookings) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/bookings | List a booking space\'s bookings|
|
|
26
|
+
|[**getBookingSpacePayments**](#getbookingspacepayments) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/payments | List a booking space\'s payments|
|
|
27
|
+
|[**getBookingSpaceSlots**](#getbookingspaceslots) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/slots | Get a booking space\'s available slots|
|
|
28
|
+
|[**getBookingSpaceTiers**](#getbookingspacetiers) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/tiers | List a booking space\'s assigned tiers|
|
|
29
|
+
|[**getBookingSpaceTranslation**](#getbookingspacetranslation) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/translations/{locale} | Get a booking space\'s translation for a locale|
|
|
30
|
+
|[**getBookingSpaceTranslations**](#getbookingspacetranslations) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/translations | List a booking space\'s translations|
|
|
31
|
+
|[**getBookingSpaces**](#getbookingspaces) | **GET** /bookings/places/{placeId}/spaces | List a booking place\'s spaces|
|
|
32
|
+
|[**removeBookingSpaceTier**](#removebookingspacetier) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/tiers/{tierId} | Remove an account tier from a booking space|
|
|
33
|
+
|[**undoCheckInBooking**](#undocheckinbooking) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId}/checkin/undo | Undo a booking check-in|
|
|
34
|
+
|[**updateBooking**](#updatebooking) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/bookings/{bookingId} | Update a booking|
|
|
35
35
|
|
|
36
36
|
# **addBookingSpaceTier**
|
|
37
37
|
> CreateBookingSpace200Response addBookingSpaceTier()
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
Grants an account tier access to a booking space by adding it to the space\'s allowed tiers list, requiring the update bookings permission and read access to tiers.
|
|
40
40
|
|
|
41
41
|
### Example
|
|
42
42
|
|
|
@@ -93,7 +93,7 @@ const { status, data } = await apiInstance.addBookingSpaceTier(
|
|
|
93
93
|
# **cancelBooking**
|
|
94
94
|
> CreateBooking200Response cancelBooking()
|
|
95
95
|
|
|
96
|
-
|
|
96
|
+
Cancels an existing booking for a space, setting its status to canceled and triggering the booking cancellation side effect; requires the update bookings permission and only succeeds if the booking is currently ready or needs info.
|
|
97
97
|
|
|
98
98
|
### Example
|
|
99
99
|
|
|
@@ -150,7 +150,7 @@ const { status, data } = await apiInstance.cancelBooking(
|
|
|
150
150
|
# **checkInBooking**
|
|
151
151
|
> CreateBooking200Response checkInBooking()
|
|
152
152
|
|
|
153
|
-
|
|
153
|
+
Marks an existing booking as checked in by setting its checked-in timestamp, requires the update bookings permission, and fails if the booking is not in a ready or needs-info status or is already checked in.
|
|
154
154
|
|
|
155
155
|
### Example
|
|
156
156
|
|
|
@@ -207,7 +207,7 @@ const { status, data } = await apiInstance.checkInBooking(
|
|
|
207
207
|
# **createBooking**
|
|
208
208
|
> CreateBooking200Response createBooking(bookingCreateInputs)
|
|
209
209
|
|
|
210
|
-
|
|
210
|
+
Creates a new booking within the specified booking space on behalf of an account, using the provided booking details, and requires the create bookings permission.
|
|
211
211
|
|
|
212
212
|
### Example
|
|
213
213
|
|
|
@@ -265,7 +265,7 @@ const { status, data } = await apiInstance.createBooking(
|
|
|
265
265
|
# **deleteBooking**
|
|
266
266
|
> CreateAccountInvitations200Response deleteBooking()
|
|
267
267
|
|
|
268
|
-
|
|
268
|
+
Permanently deletes an existing booking from a booking space and requires the delete bookings permission.
|
|
269
269
|
|
|
270
270
|
### Example
|
|
271
271
|
|
|
@@ -322,7 +322,7 @@ const { status, data } = await apiInstance.deleteBooking(
|
|
|
322
322
|
# **getBooking**
|
|
323
323
|
> CreateBooking200Response getBooking()
|
|
324
324
|
|
|
325
|
-
|
|
325
|
+
Retrieves the full details of a single booking by ID, including the place, space, and time slot it belongs to; requires the \"read\" permission on \"bookings\".
|
|
326
326
|
|
|
327
327
|
### Example
|
|
328
328
|
|
|
@@ -373,7 +373,7 @@ const { status, data } = await apiInstance.getBooking(
|
|
|
373
373
|
# **getBookingPlace**
|
|
374
374
|
> CreateBookingPlace200Response getBookingPlace()
|
|
375
375
|
|
|
376
|
-
|
|
376
|
+
Retrieves a single booking place (a bookable venue or location) by ID or slug, including its address and configuration; requires the \"read\" permission on \"bookings\".
|
|
377
377
|
|
|
378
378
|
### Example
|
|
379
379
|
|
|
@@ -424,7 +424,7 @@ const { status, data } = await apiInstance.getBookingPlace(
|
|
|
424
424
|
# **getBookingPlaceBookings**
|
|
425
425
|
> GetAccountBookings200Response getBookingPlaceBookings()
|
|
426
426
|
|
|
427
|
-
|
|
427
|
+
Returns a paginated list of bookings made at a booking place, filterable by past/upcoming (`past`) and purchase status (`status`), and searchable by the booking account\'s name or email; requires the \"read\" permission on \"bookings\".
|
|
428
428
|
|
|
429
429
|
### Example
|
|
430
430
|
|
|
@@ -493,7 +493,7 @@ const { status, data } = await apiInstance.getBookingPlaceBookings(
|
|
|
493
493
|
# **getBookingPlacePayments**
|
|
494
494
|
> GetAccountPayments200Response getBookingPlacePayments()
|
|
495
495
|
|
|
496
|
-
|
|
496
|
+
Returns a paginated list of payments made for bookings at a booking place, searchable by the paying account\'s name or email; requires the \"read\" permission on \"bookings\" and \"read\" permission on \"payments\".
|
|
497
497
|
|
|
498
498
|
### Example
|
|
499
499
|
|
|
@@ -556,7 +556,7 @@ const { status, data } = await apiInstance.getBookingPlacePayments(
|
|
|
556
556
|
# **getBookingPlaceTranslation**
|
|
557
557
|
> GetBookingPlaceTranslation200Response getBookingPlaceTranslation()
|
|
558
558
|
|
|
559
|
-
|
|
559
|
+
Retrieves the translated name and description of a booking place in a specific locale, returning null if no translation exists for that locale; requires the \"read\" permission on \"bookings\".
|
|
560
560
|
|
|
561
561
|
### Example
|
|
562
562
|
|
|
@@ -610,7 +610,7 @@ const { status, data } = await apiInstance.getBookingPlaceTranslation(
|
|
|
610
610
|
# **getBookingPlaceTranslations**
|
|
611
611
|
> GetBookingPlaceTranslations200Response getBookingPlaceTranslations()
|
|
612
612
|
|
|
613
|
-
|
|
613
|
+
Returns a paginated list of locale translations for a booking place, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
614
614
|
|
|
615
615
|
### Example
|
|
616
616
|
|
|
@@ -673,7 +673,7 @@ const { status, data } = await apiInstance.getBookingPlaceTranslations(
|
|
|
673
673
|
# **getBookingPlaces**
|
|
674
674
|
> GetBookingPlaces200Response getBookingPlaces()
|
|
675
675
|
|
|
676
|
-
|
|
676
|
+
Returns a paginated list of an organization\'s booking places (bookable venues or locations), searchable by name, description, or address and sortable via orderBy; requires the \"read\" permission on \"bookings\".
|
|
677
677
|
|
|
678
678
|
### Example
|
|
679
679
|
|
|
@@ -733,7 +733,7 @@ const { status, data } = await apiInstance.getBookingPlaces(
|
|
|
733
733
|
# **getBookingResponses**
|
|
734
734
|
> GetBookingResponses200Response getBookingResponses()
|
|
735
735
|
|
|
736
|
-
|
|
736
|
+
Returns the answers an account submitted to a booking space\'s custom questions for a specific booking, ordered by question sort order; requires the \"read\" permission on \"bookings\".
|
|
737
737
|
|
|
738
738
|
### Example
|
|
739
739
|
|
|
@@ -784,7 +784,7 @@ const { status, data } = await apiInstance.getBookingResponses(
|
|
|
784
784
|
# **getBookingSpace**
|
|
785
785
|
> CreateBookingSpace200Response getBookingSpace()
|
|
786
786
|
|
|
787
|
-
|
|
787
|
+
Returns a single bookable space within a booking place by its id or slug; requires the \"read\" permission on \"bookings\".
|
|
788
788
|
|
|
789
789
|
### Example
|
|
790
790
|
|
|
@@ -838,7 +838,7 @@ const { status, data } = await apiInstance.getBookingSpace(
|
|
|
838
838
|
# **getBookingSpaceAvailabilities**
|
|
839
839
|
> GetBookingSpaceAvailabilities200Response getBookingSpaceAvailabilities()
|
|
840
840
|
|
|
841
|
-
|
|
841
|
+
Returns the recurring weekly availability windows configured for a booking space, i.e. the days and times the space can be booked; requires the \"read\" permission on \"bookings\".
|
|
842
842
|
|
|
843
843
|
### Example
|
|
844
844
|
|
|
@@ -892,7 +892,7 @@ const { status, data } = await apiInstance.getBookingSpaceAvailabilities(
|
|
|
892
892
|
# **getBookingSpaceAvailability**
|
|
893
893
|
> CreateBookingSpaceAvailability200Response getBookingSpaceAvailability()
|
|
894
894
|
|
|
895
|
-
|
|
895
|
+
Returns a single blackout record for a booking space by id, identifying a date/time range the space is unavailable for booking; requires the \"read\" permission on \"bookings\".
|
|
896
896
|
|
|
897
897
|
### Example
|
|
898
898
|
|
|
@@ -949,7 +949,7 @@ const { status, data } = await apiInstance.getBookingSpaceAvailability(
|
|
|
949
949
|
# **getBookingSpaceBlackout**
|
|
950
950
|
> CreateBookingSpaceBlackout200Response getBookingSpaceBlackout()
|
|
951
951
|
|
|
952
|
-
|
|
952
|
+
Returns a single blackout record for a booking space by id, i.e. a date/time range during which the space cannot be booked; requires the \"read\" permission on \"bookings\".
|
|
953
953
|
|
|
954
954
|
### Example
|
|
955
955
|
|
|
@@ -1006,7 +1006,7 @@ const { status, data } = await apiInstance.getBookingSpaceBlackout(
|
|
|
1006
1006
|
# **getBookingSpaceBlackouts**
|
|
1007
1007
|
> GetBookingSpaceBlackouts200Response getBookingSpaceBlackouts()
|
|
1008
1008
|
|
|
1009
|
-
|
|
1009
|
+
Returns a paginated list of blackout date/time ranges during which a booking space cannot be booked, filterable by past/upcoming via the \"past\" parameter and by search text; requires the \"read\" permission on \"bookings\".
|
|
1010
1010
|
|
|
1011
1011
|
### Example
|
|
1012
1012
|
|
|
@@ -1075,7 +1075,7 @@ const { status, data } = await apiInstance.getBookingSpaceBlackouts(
|
|
|
1075
1075
|
# **getBookingSpaceBookings**
|
|
1076
1076
|
> GetAccountBookings200Response getBookingSpaceBookings()
|
|
1077
1077
|
|
|
1078
|
-
|
|
1078
|
+
Returns a paginated list of bookings made for a booking space, filterable by past/upcoming, purchase status, and search text against the account\'s name or email; requires the \"read\" permission on \"bookings\".
|
|
1079
1079
|
|
|
1080
1080
|
### Example
|
|
1081
1081
|
|
|
@@ -1147,7 +1147,7 @@ const { status, data } = await apiInstance.getBookingSpaceBookings(
|
|
|
1147
1147
|
# **getBookingSpacePayments**
|
|
1148
1148
|
> GetAccountPayments200Response getBookingSpacePayments()
|
|
1149
1149
|
|
|
1150
|
-
|
|
1150
|
+
Returns a paginated list of payments made for bookings in a booking space, filterable by search text against the paying account\'s name or email; requires the \"read\" permission on \"bookings\" and \"payments\".
|
|
1151
1151
|
|
|
1152
1152
|
### Example
|
|
1153
1153
|
|
|
@@ -1219,7 +1219,7 @@ const { status, data } = await apiInstance.getBookingSpacePayments(
|
|
|
1219
1219
|
# **getBookingSpaceSlots**
|
|
1220
1220
|
> GetBookingSpaceSlots200Response getBookingSpaceSlots()
|
|
1221
1221
|
|
|
1222
|
-
|
|
1222
|
+
Returns the day-by-day list of bookable time slots for a booking space within the given place for the calendar month starting at firstDayOfMonth, requiring read permission on bookings.
|
|
1223
1223
|
|
|
1224
1224
|
### Example
|
|
1225
1225
|
|
|
@@ -1276,7 +1276,7 @@ const { status, data } = await apiInstance.getBookingSpaceSlots(
|
|
|
1276
1276
|
# **getBookingSpaceTiers**
|
|
1277
1277
|
> GetAccountTiers200Response getBookingSpaceTiers()
|
|
1278
1278
|
|
|
1279
|
-
|
|
1279
|
+
Returns a paginated, searchable list of membership tiers assigned to a booking space within the given place, requiring read permission on bookings and tiers.
|
|
1280
1280
|
|
|
1281
1281
|
### Example
|
|
1282
1282
|
|
|
@@ -1342,7 +1342,7 @@ const { status, data } = await apiInstance.getBookingSpaceTiers(
|
|
|
1342
1342
|
# **getBookingSpaceTranslation**
|
|
1343
1343
|
> GetBookingSpaceTranslation200Response getBookingSpaceTranslation()
|
|
1344
1344
|
|
|
1345
|
-
|
|
1345
|
+
Returns the localized name/description translation of a booking space for the given locale, or null if no translation exists, requiring read permission on bookings.
|
|
1346
1346
|
|
|
1347
1347
|
### Example
|
|
1348
1348
|
|
|
@@ -1399,7 +1399,7 @@ const { status, data } = await apiInstance.getBookingSpaceTranslation(
|
|
|
1399
1399
|
# **getBookingSpaceTranslations**
|
|
1400
1400
|
> GetBookingSpaceTranslations200Response getBookingSpaceTranslations()
|
|
1401
1401
|
|
|
1402
|
-
|
|
1402
|
+
Returns a paginated, searchable list of locale translations for a booking space within the given place, requiring read permission on bookings.
|
|
1403
1403
|
|
|
1404
1404
|
### Example
|
|
1405
1405
|
|
|
@@ -1465,7 +1465,7 @@ const { status, data } = await apiInstance.getBookingSpaceTranslations(
|
|
|
1465
1465
|
# **getBookingSpaces**
|
|
1466
1466
|
> GetBookingSpaces200Response getBookingSpaces()
|
|
1467
1467
|
|
|
1468
|
-
|
|
1468
|
+
Returns a paginated list of bookable spaces belonging to a booking place, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
1469
1469
|
|
|
1470
1470
|
### Example
|
|
1471
1471
|
|
|
@@ -1528,7 +1528,7 @@ const { status, data } = await apiInstance.getBookingSpaces(
|
|
|
1528
1528
|
# **removeBookingSpaceTier**
|
|
1529
1529
|
> CreateBookingSpace200Response removeBookingSpaceTier()
|
|
1530
1530
|
|
|
1531
|
-
|
|
1531
|
+
Revokes an account tier\'s access to a booking space by disconnecting it from the space\'s allowed tiers list, requiring the update bookings permission and read access to tiers.
|
|
1532
1532
|
|
|
1533
1533
|
### Example
|
|
1534
1534
|
|
|
@@ -1585,7 +1585,7 @@ const { status, data } = await apiInstance.removeBookingSpaceTier(
|
|
|
1585
1585
|
# **undoCheckInBooking**
|
|
1586
1586
|
> CreateBooking200Response undoCheckInBooking()
|
|
1587
1587
|
|
|
1588
|
-
|
|
1588
|
+
Reverts a previous check-in on a booking by clearing its checked-in timestamp and requires the update bookings permission.
|
|
1589
1589
|
|
|
1590
1590
|
### Example
|
|
1591
1591
|
|
|
@@ -1642,7 +1642,7 @@ const { status, data } = await apiInstance.undoCheckInBooking(
|
|
|
1642
1642
|
# **updateBooking**
|
|
1643
1643
|
> CreateBooking200Response updateBooking(bookingUpdateInputs)
|
|
1644
1644
|
|
|
1645
|
-
|
|
1645
|
+
Updates an existing booking for a bookable space within a place, identified by placeId, spaceId, and bookingId, requiring update permission on bookings.
|
|
1646
1646
|
|
|
1647
1647
|
### Example
|
|
1648
1648
|
|
|
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createBookingSpaceAvailability**](#createbookingspaceavailability) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/availabilities | Create
|
|
8
|
-
|[**deleteBookingSpaceAvailability**](#deletebookingspaceavailability) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/availabilities/{availabilityId} | Delete
|
|
9
|
-
|[**updateBookingSpaceAvailability**](#updatebookingspaceavailability) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/availabilities/{availabilityId} | Update
|
|
7
|
+
|[**createBookingSpaceAvailability**](#createbookingspaceavailability) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/availabilities | Create a booking space availability|
|
|
8
|
+
|[**deleteBookingSpaceAvailability**](#deletebookingspaceavailability) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/availabilities/{availabilityId} | Delete a booking space availability|
|
|
9
|
+
|[**updateBookingSpaceAvailability**](#updatebookingspaceavailability) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/availabilities/{availabilityId} | Update a booking space availability|
|
|
10
10
|
|
|
11
11
|
# **createBookingSpaceAvailability**
|
|
12
12
|
> CreateBookingSpaceAvailability200Response createBookingSpaceAvailability(bookingSpaceAvailabilityCreateInputs)
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Creates a recurring weekly availability window (day of week, start/end time) for the given booking space, requiring the \"update\" permission on bookings, and fails if the new window conflicts with an existing availability for that space.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.createBookingSpaceAvailability(
|
|
|
69
69
|
# **deleteBookingSpaceAvailability**
|
|
70
70
|
> CreateAccountInvitations200Response deleteBookingSpaceAvailability()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Permanently deletes the recurring availability window identified by availabilityId from the given booking space, requiring the \"update\" permission on bookings.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceAvailability(
|
|
|
126
126
|
# **updateBookingSpaceAvailability**
|
|
127
127
|
> CreateBookingSpaceAvailability200Response updateBookingSpaceAvailability()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Updates the day of week, start time, or end time of the availability window identified by availabilityId on the given booking space, requiring the \"update\" permission on bookings, and fails if the change conflicts with another existing availability.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createBookingSpaceBlackout**](#createbookingspaceblackout) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/blackouts | Create
|
|
8
|
-
|[**deleteBookingSpaceBlackout**](#deletebookingspaceblackout) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/blackouts/{blackoutId} | Delete
|
|
9
|
-
|[**updateBookingSpaceBlackout**](#updatebookingspaceblackout) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/blackouts/{blackoutId} | Update
|
|
7
|
+
|[**createBookingSpaceBlackout**](#createbookingspaceblackout) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/blackouts | Create a booking space blackout|
|
|
8
|
+
|[**deleteBookingSpaceBlackout**](#deletebookingspaceblackout) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/blackouts/{blackoutId} | Delete a booking space blackout|
|
|
9
|
+
|[**updateBookingSpaceBlackout**](#updatebookingspaceblackout) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/blackouts/{blackoutId} | Update a booking space blackout|
|
|
10
10
|
|
|
11
11
|
# **createBookingSpaceBlackout**
|
|
12
12
|
> CreateBookingSpaceBlackout200Response createBookingSpaceBlackout(bookingSpaceBlackoutCreateInputs)
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Creates a date/time range during which the given booking space is unavailable for bookings, requiring the \"update\" permission on bookings, and fails if the range overlaps an existing blackout for that space.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.createBookingSpaceBlackout(
|
|
|
69
69
|
# **deleteBookingSpaceBlackout**
|
|
70
70
|
> CreateAccountInvitations200Response deleteBookingSpaceBlackout()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Permanently deletes the blackout window identified by blackoutId from the given booking space, requiring the \"update\" permission on bookings.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceBlackout(
|
|
|
126
126
|
# **updateBookingSpaceBlackout**
|
|
127
127
|
> CreateBookingSpaceBlackout200Response updateBookingSpaceBlackout()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Updates the start or end time of the blackout window identified by blackoutId on the given booking space, requiring the \"update\" permission on bookings, and fails if the change overlaps another existing blackout.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createBookingPlace**](#createbookingplace) | **POST** /bookings/places | Create
|
|
8
|
-
|[**deleteBookingPlace**](#deletebookingplace) | **DELETE** /bookings/places/{placeId} | Delete
|
|
9
|
-
|[**updateBookingPlace**](#updatebookingplace) | **PUT** /bookings/places/{placeId} | Update
|
|
7
|
+
|[**createBookingPlace**](#createbookingplace) | **POST** /bookings/places | Create a booking place|
|
|
8
|
+
|[**deleteBookingPlace**](#deletebookingplace) | **DELETE** /bookings/places/{placeId} | Delete a booking place|
|
|
9
|
+
|[**updateBookingPlace**](#updatebookingplace) | **PUT** /bookings/places/{placeId} | Update a booking place|
|
|
10
10
|
|
|
11
11
|
# **createBookingPlace**
|
|
12
12
|
> CreateBookingPlace200Response createBookingPlace(bookingPlaceCreateInputs)
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Creates a new booking place (a bookable location such as a venue or facility) for the organization, requires the update bookings permission.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -63,7 +63,7 @@ const { status, data } = await apiInstance.createBookingPlace(
|
|
|
63
63
|
# **deleteBookingPlace**
|
|
64
64
|
> CreateAccountInvitations200Response deleteBookingPlace()
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
Permanently deletes a booking place from the organization by its ID, requires the update bookings permission.
|
|
67
67
|
|
|
68
68
|
### Example
|
|
69
69
|
|
|
@@ -114,7 +114,7 @@ const { status, data } = await apiInstance.deleteBookingPlace(
|
|
|
114
114
|
# **updateBookingPlace**
|
|
115
115
|
> CreateBookingPlace200Response updateBookingPlace()
|
|
116
116
|
|
|
117
|
-
|
|
117
|
+
Updates the details of an existing booking place by its ID, excluding its image and identifying/audit fields, requires the update bookings permission.
|
|
118
118
|
|
|
119
119
|
### Example
|
|
120
120
|
|
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteBookingPlaceTranslation**](#deletebookingplacetranslation) | **DELETE** /bookings/places/{placeId}/translations/{locale} | Delete
|
|
8
|
-
|[**updateBookingPlaceTranslation**](#updatebookingplacetranslation) | **PUT** /bookings/places/{placeId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteBookingPlaceTranslation**](#deletebookingplacetranslation) | **DELETE** /bookings/places/{placeId}/translations/{locale} | Delete a booking place translation|
|
|
8
|
+
|[**updateBookingPlaceTranslation**](#updatebookingplacetranslation) | **PUT** /bookings/places/{placeId}/translations/{locale} | Update a booking place\'s translation|
|
|
9
9
|
|
|
10
10
|
# **deleteBookingPlaceTranslation**
|
|
11
11
|
> SyncAccounts200Response deleteBookingPlaceTranslation()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Permanently deletes the translated content for the given locale on the specified booking place, requiring the \"update\" permission on bookings.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -64,7 +64,7 @@ const { status, data } = await apiInstance.deleteBookingPlaceTranslation(
|
|
|
64
64
|
# **updateBookingPlaceTranslation**
|
|
65
65
|
> SyncAccounts200Response updateBookingPlaceTranslation(bookingPlaceTranslationUpdateInputs)
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
Updates the translated fields (e.g. name, description) for a booking place in the given locale, requires the update bookings permission.
|
|
68
68
|
|
|
69
69
|
### Example
|
|
70
70
|
|
|
@@ -4,19 +4,19 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**attachBookingSpaceQuestionSearchList**](#attachbookingspacequestionsearchlist) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/searchlist | Attach
|
|
8
|
-
|[**createBookingSpaceQuestion**](#createbookingspacequestion) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/questions | Create
|
|
9
|
-
|[**deleteBookingSpaceQuestion**](#deletebookingspacequestion) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId} | Delete
|
|
10
|
-
|[**detachBookingSpaceQuestionSearchList**](#detachbookingspacequestionsearchlist) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/searchlist | Detach
|
|
11
|
-
|[**getBookingSpaceQuestion**](#getbookingspacequestion) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId} | Get
|
|
12
|
-
|[**getBookingSpaceQuestions**](#getbookingspacequestions) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions |
|
|
13
|
-
|[**reorderBookingSpaceQuestions**](#reorderbookingspacequestions) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/reorder | Reorder
|
|
14
|
-
|[**updateBookingSpaceQuestion**](#updatebookingspacequestion) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId} | Update
|
|
7
|
+
|[**attachBookingSpaceQuestionSearchList**](#attachbookingspacequestionsearchlist) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/searchlist | Attach a search list to a booking question|
|
|
8
|
+
|[**createBookingSpaceQuestion**](#createbookingspacequestion) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/questions | Create a booking space question|
|
|
9
|
+
|[**deleteBookingSpaceQuestion**](#deletebookingspacequestion) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId} | Delete a booking space question|
|
|
10
|
+
|[**detachBookingSpaceQuestionSearchList**](#detachbookingspacequestionsearchlist) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/searchlist | Detach a search list from a booking question|
|
|
11
|
+
|[**getBookingSpaceQuestion**](#getbookingspacequestion) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId} | Get a booking space question|
|
|
12
|
+
|[**getBookingSpaceQuestions**](#getbookingspacequestions) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions | List a booking space\'s custom questions|
|
|
13
|
+
|[**reorderBookingSpaceQuestions**](#reorderbookingspacequestions) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/reorder | Reorder a booking space\'s questions|
|
|
14
|
+
|[**updateBookingSpaceQuestion**](#updatebookingspacequestion) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId} | Update a booking space question|
|
|
15
15
|
|
|
16
16
|
# **attachBookingSpaceQuestionSearchList**
|
|
17
17
|
> CreateBookingSpaceQuestion200Response attachBookingSpaceQuestionSearchList(attachSearchListInputs)
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Links an existing search list to a booking space question so its options are sourced from that list, replacing any previously attached search list; requires update permission on bookings.
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -77,7 +77,7 @@ const { status, data } = await apiInstance.attachBookingSpaceQuestionSearchList(
|
|
|
77
77
|
# **createBookingSpaceQuestion**
|
|
78
78
|
> CreateBookingSpaceQuestion200Response createBookingSpaceQuestion(bookingSpaceQuestionCreateInputs)
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
Creates a new custom question (with optional choices) on a booking space, inserting it at the given sort order among the space\'s existing questions; requires update permission on bookings.
|
|
81
81
|
|
|
82
82
|
### Example
|
|
83
83
|
|
|
@@ -135,7 +135,7 @@ const { status, data } = await apiInstance.createBookingSpaceQuestion(
|
|
|
135
135
|
# **deleteBookingSpaceQuestion**
|
|
136
136
|
> CreateAccountInvitations200Response deleteBookingSpaceQuestion()
|
|
137
137
|
|
|
138
|
-
|
|
138
|
+
Permanently deletes a custom question from a booking space and re-sequences the sort order of the remaining questions; requires update permission on bookings.
|
|
139
139
|
|
|
140
140
|
### Example
|
|
141
141
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceQuestion(
|
|
|
192
192
|
# **detachBookingSpaceQuestionSearchList**
|
|
193
193
|
> CreateBookingSpaceQuestion200Response detachBookingSpaceQuestionSearchList()
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Removes the search list currently linked to a booking space question, clearing its source of predefined options; requires update permission on bookings.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
|
@@ -249,7 +249,7 @@ const { status, data } = await apiInstance.detachBookingSpaceQuestionSearchList(
|
|
|
249
249
|
# **getBookingSpaceQuestion**
|
|
250
250
|
> CreateBookingSpaceQuestion200Response getBookingSpaceQuestion()
|
|
251
251
|
|
|
252
|
-
|
|
252
|
+
Retrieves a single custom question configured for a booking space, including its label, type, and settings; requires the \"read\" permission on \"bookings\".
|
|
253
253
|
|
|
254
254
|
### Example
|
|
255
255
|
|
|
@@ -306,7 +306,7 @@ const { status, data } = await apiInstance.getBookingSpaceQuestion(
|
|
|
306
306
|
# **getBookingSpaceQuestions**
|
|
307
307
|
> GetBookingSpaceQuestions200Response getBookingSpaceQuestions()
|
|
308
308
|
|
|
309
|
-
|
|
309
|
+
Returns a paginated list of the custom questions configured for a booking space, supporting search over the question\'s name, label, and description and sorting via orderBy; requires the \"read\" permission on \"bookings\".
|
|
310
310
|
|
|
311
311
|
### Example
|
|
312
312
|
|
|
@@ -372,7 +372,7 @@ const { status, data } = await apiInstance.getBookingSpaceQuestions(
|
|
|
372
372
|
# **reorderBookingSpaceQuestions**
|
|
373
373
|
> ReorderBookingSpaceQuestions200Response reorderBookingSpaceQuestions()
|
|
374
374
|
|
|
375
|
-
|
|
375
|
+
Sets the display order of all questions on a booking space by supplying the complete ordered list of question IDs; every existing question must be included or the request is rejected, and requires update permission on bookings.
|
|
376
376
|
|
|
377
377
|
### Example
|
|
378
378
|
|
|
@@ -429,7 +429,7 @@ const { status, data } = await apiInstance.reorderBookingSpaceQuestions(
|
|
|
429
429
|
# **updateBookingSpaceQuestion**
|
|
430
430
|
> CreateBookingSpaceQuestion200Response updateBookingSpaceQuestion(bookingSpaceQuestionUpdateInputs)
|
|
431
431
|
|
|
432
|
-
|
|
432
|
+
Updates the properties of an existing booking space question, such as its name, label, description, or sort order, moving it among the space\'s other questions if the sort order changes; requires update permission on bookings.
|
|
433
433
|
|
|
434
434
|
### Example
|
|
435
435
|
|
|
@@ -4,17 +4,17 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createBookingSpaceQuestionChoice**](#createbookingspacequestionchoice) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices | Create
|
|
8
|
-
|[**deleteBookingSpaceQuestionChoice**](#deletebookingspacequestionchoice) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId} | Delete
|
|
9
|
-
|[**getBookingSpaceQuestionChoice**](#getbookingspacequestionchoice) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId} | Get
|
|
10
|
-
|[**getBookingSpaceQuestionChoices**](#getbookingspacequestionchoices) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices |
|
|
11
|
-
|[**reorderBookingSpaceQuestionChoices**](#reorderbookingspacequestionchoices) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/reorder | Reorder
|
|
12
|
-
|[**updateBookingSpaceQuestionChoice**](#updatebookingspacequestionchoice) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId} | Update
|
|
7
|
+
|[**createBookingSpaceQuestionChoice**](#createbookingspacequestionchoice) | **POST** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices | Create a booking space question choice|
|
|
8
|
+
|[**deleteBookingSpaceQuestionChoice**](#deletebookingspacequestionchoice) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId} | Delete a booking space question choice|
|
|
9
|
+
|[**getBookingSpaceQuestionChoice**](#getbookingspacequestionchoice) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId} | Get a booking space question choice|
|
|
10
|
+
|[**getBookingSpaceQuestionChoices**](#getbookingspacequestionchoices) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices | List a booking space question\'s choices|
|
|
11
|
+
|[**reorderBookingSpaceQuestionChoices**](#reorderbookingspacequestionchoices) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/reorder | Reorder a booking question\'s choices|
|
|
12
|
+
|[**updateBookingSpaceQuestionChoice**](#updatebookingspacequestionchoice) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId} | Update a booking space question choice|
|
|
13
13
|
|
|
14
14
|
# **createBookingSpaceQuestionChoice**
|
|
15
15
|
> CreateBookingSpaceQuestionChoice200Response createBookingSpaceQuestionChoice(bookingSpaceQuestionChoiceCreateInputs)
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Creates a new selectable choice for a multiple-choice question on a booking space, requires the update bookings permission.
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
|
@@ -75,7 +75,7 @@ const { status, data } = await apiInstance.createBookingSpaceQuestionChoice(
|
|
|
75
75
|
# **deleteBookingSpaceQuestionChoice**
|
|
76
76
|
> CreateAccountInvitations200Response deleteBookingSpaceQuestionChoice()
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
Permanently deletes a choice from a booking space question by its ID, requires the update bookings permission.
|
|
79
79
|
|
|
80
80
|
### Example
|
|
81
81
|
|
|
@@ -135,7 +135,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceQuestionChoice(
|
|
|
135
135
|
# **getBookingSpaceQuestionChoice**
|
|
136
136
|
> CreateBookingSpaceQuestionChoice200Response getBookingSpaceQuestionChoice()
|
|
137
137
|
|
|
138
|
-
|
|
138
|
+
Returns a single selectable answer choice for a question on a booking space, identified by place, space, question, and choice ID; requires \"read\" permission on \"bookings\".
|
|
139
139
|
|
|
140
140
|
### Example
|
|
141
141
|
|
|
@@ -195,7 +195,7 @@ const { status, data } = await apiInstance.getBookingSpaceQuestionChoice(
|
|
|
195
195
|
# **getBookingSpaceQuestionChoices**
|
|
196
196
|
> GetBookingSpaceQuestionChoices200Response getBookingSpaceQuestionChoices()
|
|
197
197
|
|
|
198
|
-
|
|
198
|
+
Returns a paginated list of selectable answer choices for a given question on a booking space, supporting search and ordering; requires \"read\" permission on \"bookings\".
|
|
199
199
|
|
|
200
200
|
### Example
|
|
201
201
|
|
|
@@ -264,7 +264,7 @@ const { status, data } = await apiInstance.getBookingSpaceQuestionChoices(
|
|
|
264
264
|
# **reorderBookingSpaceQuestionChoices**
|
|
265
265
|
> ReorderBookingSpaceQuestionChoices200Response reorderBookingSpaceQuestionChoices()
|
|
266
266
|
|
|
267
|
-
|
|
267
|
+
Sets the display order of a booking space question\'s choices by supplying the full list of choice IDs in the desired sequence, requires the update bookings permission.
|
|
268
268
|
|
|
269
269
|
### Example
|
|
270
270
|
|
|
@@ -324,7 +324,7 @@ const { status, data } = await apiInstance.reorderBookingSpaceQuestionChoices(
|
|
|
324
324
|
# **updateBookingSpaceQuestionChoice**
|
|
325
325
|
> CreateBookingSpaceQuestionChoice200Response updateBookingSpaceQuestionChoice(bookingSpaceQuestionChoiceUpdateInputs)
|
|
326
326
|
|
|
327
|
-
|
|
327
|
+
Updates the details of an existing choice on a booking space question by its ID, requires the update bookings permission.
|
|
328
328
|
|
|
329
329
|
### Example
|
|
330
330
|
|