@connectedxm/admin-sdk 7.4.1 → 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 -1209
- package/api.ts +10059 -9672
- package/dist/api.d.ts +9869 -9672
- package/dist/api.js +9948 -9672
- package/dist/esm/api.d.ts +9869 -9672
- package/dist/esm/api.js +9948 -9672
- 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/Coupon.md +4 -0
- 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 +214 -22
- 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
|
@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createEventPassTypeRefundSchedule**](#createeventpasstyperefundschedule) | **POST** /events/{eventId}/passTypes/{passTypeId}/refundSchedules | Create
|
|
8
|
-
|[**deleteEventPassTypeRefundSchedule**](#deleteeventpasstyperefundschedule) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Delete
|
|
9
|
-
|[**getEventPassTypeRefundSchedule**](#geteventpasstyperefundschedule) | **GET** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Get
|
|
10
|
-
|[**getEventPassTypeRefundSchedules**](#geteventpasstyperefundschedules) | **GET** /events/{eventId}/passTypes/{passTypeId}/refundSchedules |
|
|
11
|
-
|[**updateEventPassTypeRefundSchedule**](#updateeventpasstyperefundschedule) | **PUT** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Update
|
|
7
|
+
|[**createEventPassTypeRefundSchedule**](#createeventpasstyperefundschedule) | **POST** /events/{eventId}/passTypes/{passTypeId}/refundSchedules | Create a pass type refund schedule|
|
|
8
|
+
|[**deleteEventPassTypeRefundSchedule**](#deleteeventpasstyperefundschedule) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Delete a pass type refund schedule|
|
|
9
|
+
|[**getEventPassTypeRefundSchedule**](#geteventpasstyperefundschedule) | **GET** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Get a pass type refund schedule|
|
|
10
|
+
|[**getEventPassTypeRefundSchedules**](#geteventpasstyperefundschedules) | **GET** /events/{eventId}/passTypes/{passTypeId}/refundSchedules | List a pass type\'s refund schedules|
|
|
11
|
+
|[**updateEventPassTypeRefundSchedule**](#updateeventpasstyperefundschedule) | **PUT** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Update a pass type refund schedule|
|
|
12
12
|
|
|
13
13
|
# **createEventPassTypeRefundSchedule**
|
|
14
14
|
> CreateEventPassType200Response createEventPassTypeRefundSchedule(passTypeRefundScheduleCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a time-windowed refund schedule for an event pass type, defining the refund terms available during that date range; requires update permission on events.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -71,7 +71,7 @@ const { status, data } = await apiInstance.createEventPassTypeRefundSchedule(
|
|
|
71
71
|
# **deleteEventPassTypeRefundSchedule**
|
|
72
72
|
> SyncAccounts200Response deleteEventPassTypeRefundSchedule()
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
Permanently removes a refund schedule from an event pass type by its schedule ID; requires update permission on events.
|
|
75
75
|
|
|
76
76
|
### Example
|
|
77
77
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.deleteEventPassTypeRefundSchedule(
|
|
|
128
128
|
# **getEventPassTypeRefundSchedule**
|
|
129
129
|
> GetEventPassTypeRefundSchedule200Response getEventPassTypeRefundSchedule()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Retrieves a single refund schedule entry for an event pass type by its ID, including the refund window and percentage; requires read access to the event.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -185,7 +185,7 @@ const { status, data } = await apiInstance.getEventPassTypeRefundSchedule(
|
|
|
185
185
|
# **getEventPassTypeRefundSchedules**
|
|
186
186
|
> GetEventPassTypeRefundSchedules200Response getEventPassTypeRefundSchedules()
|
|
187
187
|
|
|
188
|
-
|
|
188
|
+
Returns a paginated list of refund schedules configured for an event pass type, ordered by start date by default, and supports search and orderBy filters; requires read access to the event.
|
|
189
189
|
|
|
190
190
|
### Example
|
|
191
191
|
|
|
@@ -251,7 +251,7 @@ const { status, data } = await apiInstance.getEventPassTypeRefundSchedules(
|
|
|
251
251
|
# **updateEventPassTypeRefundSchedule**
|
|
252
252
|
> SyncAccounts200Response updateEventPassTypeRefundSchedule(passTypeRefundScheduleUpdateInputs)
|
|
253
253
|
|
|
254
|
-
|
|
254
|
+
Updates the date range and refund terms of an existing refund schedule on an event pass type; requires update permission on events.
|
|
255
255
|
|
|
256
256
|
### Example
|
|
257
257
|
|
|
@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteEventPassTypeTranslation**](#deleteeventpasstypetranslation) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventPassTypeTranslation**](#geteventpasstypetranslation) | **GET** /events/{eventId}/passTypes/{passTypeId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventPassTypeTranslations**](#geteventpasstypetranslations) | **GET** /events/{eventId}/passTypes/{passTypeId}/translations |
|
|
10
|
-
|[**updateEventPassTypeTranslation**](#updateeventpasstypetranslation) | **PUT** /events/{eventId}/passTypes/{passTypeId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventPassTypeTranslation**](#deleteeventpasstypetranslation) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/translations/{locale} | Delete an event pass type translation|
|
|
8
|
+
|[**getEventPassTypeTranslation**](#geteventpasstypetranslation) | **GET** /events/{eventId}/passTypes/{passTypeId}/translations/{locale} | Get a pass type\'s translation for a locale|
|
|
9
|
+
|[**getEventPassTypeTranslations**](#geteventpasstypetranslations) | **GET** /events/{eventId}/passTypes/{passTypeId}/translations | List a pass type\'s translations|
|
|
10
|
+
|[**updateEventPassTypeTranslation**](#updateeventpasstypetranslation) | **PUT** /events/{eventId}/passTypes/{passTypeId}/translations/{locale} | Update an event pass type translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventPassTypeTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventPassTypeTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Deletes the localized translation for an event pass type in the given locale; requires update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventPassTypeTranslation(
|
|
|
69
69
|
# **getEventPassTypeTranslation**
|
|
70
70
|
> GetEventPassTypeTranslation200Response getEventPassTypeTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Retrieves the localized text (such as name and description) for an event pass type in the given locale, returning null if no translation exists for that locale; requires read access to the event.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventPassTypeTranslation(
|
|
|
126
126
|
# **getEventPassTypeTranslations**
|
|
127
127
|
> GetEventPassTypeTranslations200Response getEventPassTypeTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of all locale translations that exist for an event pass type, with optional search and orderBy filters; requires read access to the event.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventPassTypeTranslations(
|
|
|
192
192
|
# **updateEventPassTypeTranslation**
|
|
193
193
|
> SyncAccounts200Response updateEventPassTypeTranslation(eventTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Creates or updates the localized translation (e.g. name, description) for an event pass type in the given locale; requires update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
|
@@ -4,33 +4,33 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventQuestionChoiceSubQuestion**](#addeventquestionchoicesubquestion) | **POST** /events/{eventId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Add
|
|
8
|
-
|[**attachEventQuestionSearchList**](#attacheventquestionsearchlist) | **PUT** /events/{eventId}/questions/{questionId}/searchlist | Attach
|
|
9
|
-
|[**createEventQuestion**](#createeventquestion) | **POST** /events/{eventId}/questions | Create
|
|
10
|
-
|[**createEventQuestionChoice**](#createeventquestionchoice) | **POST** /events/{eventId}/questions/{questionId}/choices | Create
|
|
11
|
-
|[**deleteEventQuestion**](#deleteeventquestion) | **DELETE** /events/{eventId}/questions/{questionId} | Delete
|
|
12
|
-
|[**deleteEventQuestionChoice**](#deleteeventquestionchoice) | **DELETE** /events/{eventId}/questions/{questionId}/choices/{choiceId} | Delete
|
|
13
|
-
|[**detachEventQuestionSearchList**](#detacheventquestionsearchlist) | **DELETE** /events/{eventId}/questions/{questionId}/searchlist | Detach
|
|
14
|
-
|[**getEventDashboardQuestions**](#geteventdashboardquestions) | **GET** /events/{eventId}/questions/dashboard |
|
|
15
|
-
|[**getEventQuestion**](#geteventquestion) | **GET** /events/{eventId}/questions/{questionId} | Get
|
|
16
|
-
|[**getEventQuestionChoice**](#geteventquestionchoice) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId} | Get
|
|
17
|
-
|[**getEventQuestionChoiceSubQuestions**](#geteventquestionchoicesubquestions) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/subQuestions |
|
|
18
|
-
|[**getEventQuestionChoices**](#geteventquestionchoices) | **GET** /events/{eventId}/questions/{questionId}/choices |
|
|
19
|
-
|[**getEventQuestionResponses**](#geteventquestionresponses) | **GET** /events/{eventId}/questions/{questionId}/responses |
|
|
20
|
-
|[**getEventQuestionSummaries**](#geteventquestionsummaries) | **GET** /events/{eventId}/questions/summary |
|
|
21
|
-
|[**getEventQuestionSummary**](#geteventquestionsummary) | **GET** /events/{eventId}/questions/{questionId}/summary | Get
|
|
22
|
-
|[**getEventQuestions**](#geteventquestions) | **GET** /events/{eventId}/questions |
|
|
23
|
-
|[**removeEventQuestionChoiceSubQuestion**](#removeeventquestionchoicesubquestion) | **DELETE** /events/{eventId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Remove
|
|
24
|
-
|[**reorderEventQuestionChoiceSubQuestions**](#reordereventquestionchoicesubquestions) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId}/subQuestions/reorder | Reorder
|
|
25
|
-
|[**reorderEventQuestionChoices**](#reordereventquestionchoices) | **PUT** /events/{eventId}/questions/{questionId}/choices/reorder | Reorder
|
|
26
|
-
|[**updateEventQuestion**](#updateeventquestion) | **PUT** /events/{eventId}/questions/{questionId} | Update
|
|
27
|
-
|[**updateEventQuestionChoice**](#updateeventquestionchoice) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId} | Update
|
|
28
|
-
|[**updateEventQuestionChoiceSubQuestion**](#updateeventquestionchoicesubquestion) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Update
|
|
7
|
+
|[**addEventQuestionChoiceSubQuestion**](#addeventquestionchoicesubquestion) | **POST** /events/{eventId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Add a sub-question to a question choice|
|
|
8
|
+
|[**attachEventQuestionSearchList**](#attacheventquestionsearchlist) | **PUT** /events/{eventId}/questions/{questionId}/searchlist | Attach a search list to a question|
|
|
9
|
+
|[**createEventQuestion**](#createeventquestion) | **POST** /events/{eventId}/questions | Create an event registration question|
|
|
10
|
+
|[**createEventQuestionChoice**](#createeventquestionchoice) | **POST** /events/{eventId}/questions/{questionId}/choices | Create a choice for an event question|
|
|
11
|
+
|[**deleteEventQuestion**](#deleteeventquestion) | **DELETE** /events/{eventId}/questions/{questionId} | Delete an event registration question|
|
|
12
|
+
|[**deleteEventQuestionChoice**](#deleteeventquestionchoice) | **DELETE** /events/{eventId}/questions/{questionId}/choices/{choiceId} | Delete a choice from an event question|
|
|
13
|
+
|[**detachEventQuestionSearchList**](#detacheventquestionsearchlist) | **DELETE** /events/{eventId}/questions/{questionId}/searchlist | Detach a search list from a question|
|
|
14
|
+
|[**getEventDashboardQuestions**](#geteventdashboardquestions) | **GET** /events/{eventId}/questions/dashboard | List registration questions shown on the event dashboard|
|
|
15
|
+
|[**getEventQuestion**](#geteventquestion) | **GET** /events/{eventId}/questions/{questionId} | Get a single registration question|
|
|
16
|
+
|[**getEventQuestionChoice**](#geteventquestionchoice) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId} | Get a single registration question choice|
|
|
17
|
+
|[**getEventQuestionChoiceSubQuestions**](#geteventquestionchoicesubquestions) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/subQuestions | List a question choice\'s sub-questions|
|
|
18
|
+
|[**getEventQuestionChoices**](#geteventquestionchoices) | **GET** /events/{eventId}/questions/{questionId}/choices | List a registration question\'s choices|
|
|
19
|
+
|[**getEventQuestionResponses**](#geteventquestionresponses) | **GET** /events/{eventId}/questions/{questionId}/responses | List responses to an event registration question|
|
|
20
|
+
|[**getEventQuestionSummaries**](#geteventquestionsummaries) | **GET** /events/{eventId}/questions/summary | List response summaries for an event\'s questions|
|
|
21
|
+
|[**getEventQuestionSummary**](#geteventquestionsummary) | **GET** /events/{eventId}/questions/{questionId}/summary | Get a registration question\'s response summary|
|
|
22
|
+
|[**getEventQuestions**](#geteventquestions) | **GET** /events/{eventId}/questions | List an event\'s registration questions|
|
|
23
|
+
|[**removeEventQuestionChoiceSubQuestion**](#removeeventquestionchoicesubquestion) | **DELETE** /events/{eventId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Remove a sub-question from a question choice|
|
|
24
|
+
|[**reorderEventQuestionChoiceSubQuestions**](#reordereventquestionchoicesubquestions) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId}/subQuestions/reorder | Reorder a question choice\'s sub-questions|
|
|
25
|
+
|[**reorderEventQuestionChoices**](#reordereventquestionchoices) | **PUT** /events/{eventId}/questions/{questionId}/choices/reorder | Reorder an event question\'s choices|
|
|
26
|
+
|[**updateEventQuestion**](#updateeventquestion) | **PUT** /events/{eventId}/questions/{questionId} | Update an event registration question|
|
|
27
|
+
|[**updateEventQuestionChoice**](#updateeventquestionchoice) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId} | Update a registration question choice|
|
|
28
|
+
|[**updateEventQuestionChoiceSubQuestion**](#updateeventquestionchoicesubquestion) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Update a question choice\'s sub-question|
|
|
29
29
|
|
|
30
30
|
# **addEventQuestionChoiceSubQuestion**
|
|
31
31
|
> CreateEventQuestionChoice200Response addEventQuestionChoiceSubQuestion()
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
Links an existing event question as a follow-up sub-question shown when the given choice is selected, appending it to the end of that choice\'s sub-question order; requires update permission on events.
|
|
34
34
|
|
|
35
35
|
### Example
|
|
36
36
|
|
|
@@ -90,7 +90,7 @@ const { status, data } = await apiInstance.addEventQuestionChoiceSubQuestion(
|
|
|
90
90
|
# **attachEventQuestionSearchList**
|
|
91
91
|
> CreateEventQuestion200Response attachEventQuestionSearchList(attachSearchListInputs)
|
|
92
92
|
|
|
93
|
-
|
|
93
|
+
Links an organization search list to a registration question so its values populate the question\'s selectable options, after verifying the search list exists and belongs to the organization; requires update permission on events.
|
|
94
94
|
|
|
95
95
|
### Example
|
|
96
96
|
|
|
@@ -148,7 +148,7 @@ const { status, data } = await apiInstance.attachEventQuestionSearchList(
|
|
|
148
148
|
# **createEventQuestion**
|
|
149
149
|
> CreateEventQuestion200Response createEventQuestion(eventQuestionCreateInputs)
|
|
150
150
|
|
|
151
|
-
|
|
151
|
+
Creates a new registration question for an event, optionally attaching it to a section, a follow-up question, or a parent question\'s choice; requires update permission on events.
|
|
152
152
|
|
|
153
153
|
### Example
|
|
154
154
|
|
|
@@ -203,7 +203,7 @@ const { status, data } = await apiInstance.createEventQuestion(
|
|
|
203
203
|
# **createEventQuestionChoice**
|
|
204
204
|
> CreateEventQuestionChoice200Response createEventQuestionChoice(eventQuestionChoiceCreateInputs)
|
|
205
205
|
|
|
206
|
-
|
|
206
|
+
Creates a new selectable choice (option) for a registration question, inserting it at the requested sort position among the question\'s existing choices (max 100 per question); requires update permission on events.
|
|
207
207
|
|
|
208
208
|
### Example
|
|
209
209
|
|
|
@@ -261,7 +261,7 @@ const { status, data } = await apiInstance.createEventQuestionChoice(
|
|
|
261
261
|
# **deleteEventQuestion**
|
|
262
262
|
> CreateAccountInvitations200Response deleteEventQuestion()
|
|
263
263
|
|
|
264
|
-
|
|
264
|
+
Permanently deletes a registration question from an event and re-sequences the sort order of the event\'s remaining questions; requires update permission on events.
|
|
265
265
|
|
|
266
266
|
### Example
|
|
267
267
|
|
|
@@ -321,7 +321,7 @@ const { status, data } = await apiInstance.deleteEventQuestion(
|
|
|
321
321
|
# **deleteEventQuestionChoice**
|
|
322
322
|
> CreateAccountInvitations200Response deleteEventQuestionChoice()
|
|
323
323
|
|
|
324
|
-
|
|
324
|
+
Permanently deletes a choice from a registration question and re-sequences the sort order of the question\'s remaining choices; blocked if the question is a checkbox type with existing responses, and requires update permission on events.
|
|
325
325
|
|
|
326
326
|
### Example
|
|
327
327
|
|
|
@@ -378,7 +378,7 @@ const { status, data } = await apiInstance.deleteEventQuestionChoice(
|
|
|
378
378
|
# **detachEventQuestionSearchList**
|
|
379
379
|
> CreateEventQuestion200Response detachEventQuestionSearchList()
|
|
380
380
|
|
|
381
|
-
|
|
381
|
+
Removes the currently attached organization search list from a registration question, clearing its search-list-backed options; requires update permission on events.
|
|
382
382
|
|
|
383
383
|
### Example
|
|
384
384
|
|
|
@@ -432,7 +432,7 @@ const { status, data } = await apiInstance.detachEventQuestionSearchList(
|
|
|
432
432
|
# **getEventDashboardQuestions**
|
|
433
433
|
> GetEventDashboardQuestions200Response getEventDashboardQuestions()
|
|
434
434
|
|
|
435
|
-
|
|
435
|
+
Returns the registration questions configured to appear on an event\'s dashboard, optionally filtered by search; requires read permission on events and dashboards.
|
|
436
436
|
|
|
437
437
|
### Example
|
|
438
438
|
|
|
@@ -483,7 +483,7 @@ const { status, data } = await apiInstance.getEventDashboardQuestions(
|
|
|
483
483
|
# **getEventQuestion**
|
|
484
484
|
> CreateEventQuestion200Response getEventQuestion()
|
|
485
485
|
|
|
486
|
-
|
|
486
|
+
Returns the details of a single registration question belonging to an event; requires read permission on events.
|
|
487
487
|
|
|
488
488
|
### Example
|
|
489
489
|
|
|
@@ -537,7 +537,7 @@ const { status, data } = await apiInstance.getEventQuestion(
|
|
|
537
537
|
# **getEventQuestionChoice**
|
|
538
538
|
> CreateEventQuestionChoice200Response getEventQuestionChoice()
|
|
539
539
|
|
|
540
|
-
|
|
540
|
+
Returns the details of a single answer choice belonging to a registration question on an event; requires read permission on events.
|
|
541
541
|
|
|
542
542
|
### Example
|
|
543
543
|
|
|
@@ -594,7 +594,7 @@ const { status, data } = await apiInstance.getEventQuestionChoice(
|
|
|
594
594
|
# **getEventQuestionChoiceSubQuestions**
|
|
595
595
|
> GetEventQuestionChoiceSubQuestions200Response getEventQuestionChoiceSubQuestions()
|
|
596
596
|
|
|
597
|
-
|
|
597
|
+
Returns a paginated list of follow-up sub-questions attached to a specific choice of a registration question on an event, filterable by search against the sub-question\'s name or label; requires read access to the event.
|
|
598
598
|
|
|
599
599
|
### Example
|
|
600
600
|
|
|
@@ -663,7 +663,7 @@ const { status, data } = await apiInstance.getEventQuestionChoiceSubQuestions(
|
|
|
663
663
|
# **getEventQuestionChoices**
|
|
664
664
|
> GetEventQuestionChoices200Response getEventQuestionChoices()
|
|
665
665
|
|
|
666
|
-
|
|
666
|
+
Returns a paginated list of selectable choices for a registration question on an event, ordered by sort order by default and filterable by a search term against the choice value; requires read access to the event.
|
|
667
667
|
|
|
668
668
|
### Example
|
|
669
669
|
|
|
@@ -729,7 +729,7 @@ const { status, data } = await apiInstance.getEventQuestionChoices(
|
|
|
729
729
|
# **getEventQuestionResponses**
|
|
730
730
|
> GetEventPassResponses200Response getEventQuestionResponses()
|
|
731
731
|
|
|
732
|
-
|
|
732
|
+
Returns a paginated list of attendee-submitted responses to a specific registration question on an event, limited to purchases in the needsInfo or ready status and filterable by search against the responding attendee\'s name or email; requires read access to the event.
|
|
733
733
|
|
|
734
734
|
### Example
|
|
735
735
|
|
|
@@ -795,7 +795,7 @@ const { status, data } = await apiInstance.getEventQuestionResponses(
|
|
|
795
795
|
# **getEventQuestionSummaries**
|
|
796
796
|
> GetEventQuestionSummaries200Response getEventQuestionSummaries()
|
|
797
797
|
|
|
798
|
-
|
|
798
|
+
Returns a paginated list of summary statistics (such as response counts) for every registration question on an event, ordered by the question\'s sort order; requires read access to the event.
|
|
799
799
|
|
|
800
800
|
### Example
|
|
801
801
|
|
|
@@ -858,7 +858,7 @@ const { status, data } = await apiInstance.getEventQuestionSummaries(
|
|
|
858
858
|
# **getEventQuestionSummary**
|
|
859
859
|
> GetEventQuestionSummary200Response getEventQuestionSummary()
|
|
860
860
|
|
|
861
|
-
|
|
861
|
+
Returns summary statistics for a single registration question on an event, such as the count of non-empty responses from purchases in the needsInfo or ready status; requires read access to the event.
|
|
862
862
|
|
|
863
863
|
### Example
|
|
864
864
|
|
|
@@ -912,7 +912,7 @@ const { status, data } = await apiInstance.getEventQuestionSummary(
|
|
|
912
912
|
# **getEventQuestions**
|
|
913
913
|
> GetEventQuestions200Response getEventQuestions()
|
|
914
914
|
|
|
915
|
-
|
|
915
|
+
Returns a paginated list of registration questions configured for an event, ordered by sort order by default and filterable by search against the question\'s name, label, or description; requires read access to the event.
|
|
916
916
|
|
|
917
917
|
### Example
|
|
918
918
|
|
|
@@ -975,7 +975,7 @@ const { status, data } = await apiInstance.getEventQuestions(
|
|
|
975
975
|
# **removeEventQuestionChoiceSubQuestion**
|
|
976
976
|
> CreateAccountInvitations200Response removeEventQuestionChoiceSubQuestion()
|
|
977
977
|
|
|
978
|
-
|
|
978
|
+
Unlinks a sub-question previously attached to a question choice and re-sequences the sort order of that choice\'s remaining sub-questions; requires update permission on events.
|
|
979
979
|
|
|
980
980
|
### Example
|
|
981
981
|
|
|
@@ -1035,7 +1035,7 @@ const { status, data } = await apiInstance.removeEventQuestionChoiceSubQuestion(
|
|
|
1035
1035
|
# **reorderEventQuestionChoiceSubQuestions**
|
|
1036
1036
|
> ReorderEventQuestionChoiceSubQuestions200Response reorderEventQuestionChoiceSubQuestions()
|
|
1037
1037
|
|
|
1038
|
-
|
|
1038
|
+
Sets the display order of the sub-questions attached to a registration question choice by supplying the full, reordered list of sub-question IDs; requires update permission on events and fails if the provided list does not exactly match the choice\'s existing sub-questions.
|
|
1039
1039
|
|
|
1040
1040
|
### Example
|
|
1041
1041
|
|
|
@@ -1095,7 +1095,7 @@ const { status, data } = await apiInstance.reorderEventQuestionChoiceSubQuestion
|
|
|
1095
1095
|
# **reorderEventQuestionChoices**
|
|
1096
1096
|
> ReorderEventQuestionChoices200Response reorderEventQuestionChoices()
|
|
1097
1097
|
|
|
1098
|
-
|
|
1098
|
+
Sets the sort order of a registration question\'s choices to match the given array of choice IDs; requires update permission on events.
|
|
1099
1099
|
|
|
1100
1100
|
### Example
|
|
1101
1101
|
|
|
@@ -1152,7 +1152,7 @@ const { status, data } = await apiInstance.reorderEventQuestionChoices(
|
|
|
1152
1152
|
# **updateEventQuestion**
|
|
1153
1153
|
> CreateEventQuestion200Response updateEventQuestion()
|
|
1154
1154
|
|
|
1155
|
-
|
|
1155
|
+
Updates the fields of a registration question on an event, such as its label, type, visibility, or linked search list, and requires update permission on events.
|
|
1156
1156
|
|
|
1157
1157
|
### Example
|
|
1158
1158
|
|
|
@@ -1210,7 +1210,7 @@ const { status, data } = await apiInstance.updateEventQuestion(
|
|
|
1210
1210
|
# **updateEventQuestionChoice**
|
|
1211
1211
|
> SyncAccounts200Response updateEventQuestionChoice()
|
|
1212
1212
|
|
|
1213
|
-
|
|
1213
|
+
Updates the fields of a single answer choice belonging to an event registration question, such as its label or value, and requires update permission on events.
|
|
1214
1214
|
|
|
1215
1215
|
### Example
|
|
1216
1216
|
|
|
@@ -1271,7 +1271,7 @@ const { status, data } = await apiInstance.updateEventQuestionChoice(
|
|
|
1271
1271
|
# **updateEventQuestionChoiceSubQuestion**
|
|
1272
1272
|
> CreateEventQuestionChoice200Response updateEventQuestionChoiceSubQuestion()
|
|
1273
1273
|
|
|
1274
|
-
|
|
1274
|
+
Updates a sub-question attached to a registration question choice, most notably its sort order relative to the choice\'s other sub-questions, and requires update permission on events.
|
|
1275
1275
|
|
|
1276
1276
|
### Example
|
|
1277
1277
|
|
|
@@ -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
|
-
|[**deleteEventQuestionChoiceTranslation**](#deleteeventquestionchoicetranslation) | **DELETE** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete
|
|
8
|
-
|[**deleteEventQuestionTranslation**](#deleteeventquestiontranslation) | **DELETE** /events/{eventId}/questions/{questionId}/translations/{locale} | Delete
|
|
9
|
-
|[**getEventQuestionChoiceTranslation**](#geteventquestionchoicetranslation) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get
|
|
10
|
-
|[**getEventQuestionChoiceTranslations**](#geteventquestionchoicetranslations) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations |
|
|
11
|
-
|[**getEventQuestionTranslation**](#geteventquestiontranslation) | **GET** /events/{eventId}/questions/{questionId}/translations/{locale} | Get
|
|
12
|
-
|[**getEventQuestionTranslations**](#geteventquestiontranslations) | **GET** /events/{eventId}/questions/{questionId}/translations |
|
|
13
|
-
|[**updateEventQuestionChoiceTranslation**](#updateeventquestionchoicetranslation) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update
|
|
14
|
-
|[**updateEventQuestionTranslation**](#updateeventquestiontranslation) | **PUT** /events/{eventId}/questions/{questionId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventQuestionChoiceTranslation**](#deleteeventquestionchoicetranslation) | **DELETE** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete a question choice translation|
|
|
8
|
+
|[**deleteEventQuestionTranslation**](#deleteeventquestiontranslation) | **DELETE** /events/{eventId}/questions/{questionId}/translations/{locale} | Delete an event question translation|
|
|
9
|
+
|[**getEventQuestionChoiceTranslation**](#geteventquestionchoicetranslation) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get a question choice\'s translation|
|
|
10
|
+
|[**getEventQuestionChoiceTranslations**](#geteventquestionchoicetranslations) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations | List a question choice\'s translations|
|
|
11
|
+
|[**getEventQuestionTranslation**](#geteventquestiontranslation) | **GET** /events/{eventId}/questions/{questionId}/translations/{locale} | Get a registration question\'s translation|
|
|
12
|
+
|[**getEventQuestionTranslations**](#geteventquestiontranslations) | **GET** /events/{eventId}/questions/{questionId}/translations | List a registration question\'s translations|
|
|
13
|
+
|[**updateEventQuestionChoiceTranslation**](#updateeventquestionchoicetranslation) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update a question choice translation|
|
|
14
|
+
|[**updateEventQuestionTranslation**](#updateeventquestiontranslation) | **PUT** /events/{eventId}/questions/{questionId}/translations/{locale} | Update an event question\'s translation|
|
|
15
15
|
|
|
16
16
|
# **deleteEventQuestionChoiceTranslation**
|
|
17
17
|
> SyncAccounts200Response deleteEventQuestionChoiceTranslation()
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Removes the translation for a specific locale from an answer choice of an event registration question; requires update permission on events.
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -76,7 +76,7 @@ const { status, data } = await apiInstance.deleteEventQuestionChoiceTranslation(
|
|
|
76
76
|
# **deleteEventQuestionTranslation**
|
|
77
77
|
> SyncAccounts200Response deleteEventQuestionTranslation()
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
Removes the translation for a specific locale from an event registration question; requires update permission on events.
|
|
80
80
|
|
|
81
81
|
### Example
|
|
82
82
|
|
|
@@ -133,7 +133,7 @@ const { status, data } = await apiInstance.deleteEventQuestionTranslation(
|
|
|
133
133
|
# **getEventQuestionChoiceTranslation**
|
|
134
134
|
> GetEventQuestionChoiceTranslation200Response getEventQuestionChoiceTranslation()
|
|
135
135
|
|
|
136
|
-
|
|
136
|
+
Returns the translation for a specific locale of a registration question choice on an event, or null if no translation exists for that locale; requires read permission on events.
|
|
137
137
|
|
|
138
138
|
### Example
|
|
139
139
|
|
|
@@ -193,7 +193,7 @@ const { status, data } = await apiInstance.getEventQuestionChoiceTranslation(
|
|
|
193
193
|
# **getEventQuestionChoiceTranslations**
|
|
194
194
|
> GetEventQuestionChoiceTranslations200Response getEventQuestionChoiceTranslations()
|
|
195
195
|
|
|
196
|
-
|
|
196
|
+
Returns a paginated list of locale translations for a specific registration question choice on an event, with optional search and ordering; requires read permission on events.
|
|
197
197
|
|
|
198
198
|
### Example
|
|
199
199
|
|
|
@@ -262,7 +262,7 @@ const { status, data } = await apiInstance.getEventQuestionChoiceTranslations(
|
|
|
262
262
|
# **getEventQuestionTranslation**
|
|
263
263
|
> GetEventQuestionTranslation200Response getEventQuestionTranslation()
|
|
264
264
|
|
|
265
|
-
|
|
265
|
+
Returns the translation for a specific locale of a registration question on an event, or null if no translation exists for that locale; requires read permission on events.
|
|
266
266
|
|
|
267
267
|
### Example
|
|
268
268
|
|
|
@@ -319,7 +319,7 @@ const { status, data } = await apiInstance.getEventQuestionTranslation(
|
|
|
319
319
|
# **getEventQuestionTranslations**
|
|
320
320
|
> GetEventQuestionTranslations200Response getEventQuestionTranslations()
|
|
321
321
|
|
|
322
|
-
|
|
322
|
+
Returns a paginated list of locale translations for a specific registration question on an event, with optional search and ordering; requires read permission on events.
|
|
323
323
|
|
|
324
324
|
### Example
|
|
325
325
|
|
|
@@ -385,7 +385,7 @@ const { status, data } = await apiInstance.getEventQuestionTranslations(
|
|
|
385
385
|
# **updateEventQuestionChoiceTranslation**
|
|
386
386
|
> SyncAccounts200Response updateEventQuestionChoiceTranslation(eventQuestionChoiceTranslationUpdateInputs)
|
|
387
387
|
|
|
388
|
-
|
|
388
|
+
Creates or updates the translation for a specific locale on an answer choice of an event registration question; requires update permission on events.
|
|
389
389
|
|
|
390
390
|
### Example
|
|
391
391
|
|
|
@@ -449,7 +449,7 @@ const { status, data } = await apiInstance.updateEventQuestionChoiceTranslation(
|
|
|
449
449
|
# **updateEventQuestionTranslation**
|
|
450
450
|
> SyncAccounts200Response updateEventQuestionTranslation(eventQuestionTranslationUpdateInputs)
|
|
451
451
|
|
|
452
|
-
|
|
452
|
+
Updates the translated text for a registration question in the given locale, creating the translation if it does not yet exist; requires update permission on events.
|
|
453
453
|
|
|
454
454
|
### Example
|
|
455
455
|
|
package/docs/EventsRoomsApi.md
CHANGED
|
@@ -4,20 +4,20 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addRoomToRoomType**](#addroomtoroomtype) | **POST** /events/{eventId}/roomTypes/{roomTypeId}/rooms | Add
|
|
8
|
-
|[**createRoom**](#createroom) | **POST** /events/{eventId}/rooms | Create
|
|
9
|
-
|[**deleteRoom**](#deleteroom) | **DELETE** /events/{eventId}/rooms/{roomId} | Delete
|
|
10
|
-
|[**getRoom**](#getroom) | **GET** /events/{eventId}/rooms/{roomId} | Get
|
|
11
|
-
|[**getRoomTypeRooms**](#getroomtyperooms) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/rooms |
|
|
12
|
-
|[**getRooms**](#getrooms) | **GET** /events/{eventId}/rooms |
|
|
13
|
-
|[**importRooms**](#importrooms) | **POST** /events/{eventId}/rooms/import |
|
|
14
|
-
|[**removeRoomFromRoomType**](#removeroomfromroomtype) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId}/rooms/{roomId} | Remove
|
|
15
|
-
|[**updateRoom**](#updateroom) | **PUT** /events/{eventId}/rooms/{roomId} | Update
|
|
7
|
+
|[**addRoomToRoomType**](#addroomtoroomtype) | **POST** /events/{eventId}/roomTypes/{roomTypeId}/rooms | Add a room to a room type|
|
|
8
|
+
|[**createRoom**](#createroom) | **POST** /events/{eventId}/rooms | Create an event room|
|
|
9
|
+
|[**deleteRoom**](#deleteroom) | **DELETE** /events/{eventId}/rooms/{roomId} | Delete an event room|
|
|
10
|
+
|[**getRoom**](#getroom) | **GET** /events/{eventId}/rooms/{roomId} | Get a single event room|
|
|
11
|
+
|[**getRoomTypeRooms**](#getroomtyperooms) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/rooms | List rooms belonging to a room type|
|
|
12
|
+
|[**getRooms**](#getrooms) | **GET** /events/{eventId}/rooms | List an event\'s rooms|
|
|
13
|
+
|[**importRooms**](#importrooms) | **POST** /events/{eventId}/rooms/import | Bulk import event rooms by name|
|
|
14
|
+
|[**removeRoomFromRoomType**](#removeroomfromroomtype) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId}/rooms/{roomId} | Remove a room from a room type|
|
|
15
|
+
|[**updateRoom**](#updateroom) | **PUT** /events/{eventId}/rooms/{roomId} | Update an event room|
|
|
16
16
|
|
|
17
17
|
# **addRoomToRoomType**
|
|
18
18
|
> CreateEventRoomType200Response addRoomToRoomType()
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Connects an existing event room to a room type, verifying the room belongs to the same event, and requires update permission on events.
|
|
21
21
|
|
|
22
22
|
### Example
|
|
23
23
|
|
|
@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.addRoomToRoomType(
|
|
|
74
74
|
# **createRoom**
|
|
75
75
|
> CreateRoom200Response createRoom(roomCreateInputs)
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
Creates a new room for an event, such as a physical or virtual space used for sessions, and requires update permission on events.
|
|
78
78
|
|
|
79
79
|
### Example
|
|
80
80
|
|
|
@@ -129,7 +129,7 @@ const { status, data } = await apiInstance.createRoom(
|
|
|
129
129
|
# **deleteRoom**
|
|
130
130
|
> CreateAccountInvitations200Response deleteRoom()
|
|
131
131
|
|
|
132
|
-
|
|
132
|
+
Permanently deletes a room from an event and requires update permission on events.
|
|
133
133
|
|
|
134
134
|
### Example
|
|
135
135
|
|
|
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.deleteRoom(
|
|
|
183
183
|
# **getRoom**
|
|
184
184
|
> CreateRoom200Response getRoom()
|
|
185
185
|
|
|
186
|
-
|
|
186
|
+
Returns the details of a single room belonging to an event, verifying the room belongs to the given event and organization before returning it; requires read access to the event.
|
|
187
187
|
|
|
188
188
|
### Example
|
|
189
189
|
|
|
@@ -237,7 +237,7 @@ const { status, data } = await apiInstance.getRoom(
|
|
|
237
237
|
# **getRoomTypeRooms**
|
|
238
238
|
> GetRoomTypeRooms200Response getRoomTypeRooms()
|
|
239
239
|
|
|
240
|
-
|
|
240
|
+
Returns a paginated list of rooms assigned to a specific room type on an event, ordered by room name by default and filterable by search against the room name; requires read access to the event.
|
|
241
241
|
|
|
242
242
|
### Example
|
|
243
243
|
|
|
@@ -303,7 +303,7 @@ const { status, data } = await apiInstance.getRoomTypeRooms(
|
|
|
303
303
|
# **getRooms**
|
|
304
304
|
> GetRoomTypeRooms200Response getRooms()
|
|
305
305
|
|
|
306
|
-
|
|
306
|
+
Returns a paginated list of rooms belonging to an event, ordered by room name by default and filterable by search against the room name; requires read access to the event.
|
|
307
307
|
|
|
308
308
|
### Example
|
|
309
309
|
|
|
@@ -366,7 +366,7 @@ const { status, data } = await apiInstance.getRooms(
|
|
|
366
366
|
# **importRooms**
|
|
367
367
|
> ImportRooms200Response importRooms()
|
|
368
368
|
|
|
369
|
-
|
|
369
|
+
Bulk-creates event rooms from a list of room names, skipping any names that already exist for the event, and optionally assigns the newly created rooms to a room type; requires update permission on events.
|
|
370
370
|
|
|
371
371
|
### Example
|
|
372
372
|
|
|
@@ -423,7 +423,7 @@ const { status, data } = await apiInstance.importRooms(
|
|
|
423
423
|
# **removeRoomFromRoomType**
|
|
424
424
|
> CreateEventRoomType200Response removeRoomFromRoomType()
|
|
425
425
|
|
|
426
|
-
|
|
426
|
+
Disconnects a room from a room type without deleting the room itself, and requires update permission on events.
|
|
427
427
|
|
|
428
428
|
### Example
|
|
429
429
|
|
|
@@ -480,7 +480,7 @@ const { status, data } = await apiInstance.removeRoomFromRoomType(
|
|
|
480
480
|
# **updateRoom**
|
|
481
481
|
> CreateRoom200Response updateRoom(roomUpdateInputs)
|
|
482
482
|
|
|
483
|
-
|
|
483
|
+
Updates the fields of an existing event room, such as its name or capacity, and requires update permission on events.
|
|
484
484
|
|
|
485
485
|
### Example
|
|
486
486
|
|