@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,19 +4,19 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteEventFaqSectionQuestionTranslation**](#deleteeventfaqsectionquestiontranslation) | **DELETE** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations/{locale} | Delete
|
|
8
|
-
|[**deleteEventFaqSectionTranslation**](#deleteeventfaqsectiontranslation) | **DELETE** /events/{eventId}/faqs/{sectionId}/translations/{locale} | Delete
|
|
9
|
-
|[**getEventFaqSectionQuestionTranslation**](#geteventfaqsectionquestiontranslation) | **GET** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations/{locale} | Get
|
|
10
|
-
|[**getEventFaqSectionQuestionTranslations**](#geteventfaqsectionquestiontranslations) | **GET** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations |
|
|
11
|
-
|[**getEventFaqSectionTranslation**](#geteventfaqsectiontranslation) | **GET** /events/{eventId}/faqs/{sectionId}/translations/{locale} | Get
|
|
12
|
-
|[**getEventFaqSectionTranslations**](#geteventfaqsectiontranslations) | **GET** /events/{eventId}/faqs/{sectionId}/translations |
|
|
13
|
-
|[**updateEventFaqSectionQuestionTranslation**](#updateeventfaqsectionquestiontranslation) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations/{locale} | Update
|
|
14
|
-
|[**updateEventFaqSectionTranslation**](#updateeventfaqsectiontranslation) | **PUT** /events/{eventId}/faqs/{sectionId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventFaqSectionQuestionTranslation**](#deleteeventfaqsectionquestiontranslation) | **DELETE** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations/{locale} | Delete an event FAQ question translation|
|
|
8
|
+
|[**deleteEventFaqSectionTranslation**](#deleteeventfaqsectiontranslation) | **DELETE** /events/{eventId}/faqs/{sectionId}/translations/{locale} | Delete an event FAQ section translation|
|
|
9
|
+
|[**getEventFaqSectionQuestionTranslation**](#geteventfaqsectionquestiontranslation) | **GET** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations/{locale} | Get an event FAQ question\'s translation|
|
|
10
|
+
|[**getEventFaqSectionQuestionTranslations**](#geteventfaqsectionquestiontranslations) | **GET** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations | List an event FAQ question\'s translations|
|
|
11
|
+
|[**getEventFaqSectionTranslation**](#geteventfaqsectiontranslation) | **GET** /events/{eventId}/faqs/{sectionId}/translations/{locale} | Get an event FAQ section\'s translation|
|
|
12
|
+
|[**getEventFaqSectionTranslations**](#geteventfaqsectiontranslations) | **GET** /events/{eventId}/faqs/{sectionId}/translations | List an event FAQ section\'s translations|
|
|
13
|
+
|[**updateEventFaqSectionQuestionTranslation**](#updateeventfaqsectionquestiontranslation) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations/{locale} | Update an FAQ question\'s translation|
|
|
14
|
+
|[**updateEventFaqSectionTranslation**](#updateeventfaqsectiontranslation) | **PUT** /events/{eventId}/faqs/{sectionId}/translations/{locale} | Update an FAQ section\'s translation|
|
|
15
15
|
|
|
16
16
|
# **deleteEventFaqSectionQuestionTranslation**
|
|
17
17
|
> SyncAccounts200Response deleteEventFaqSectionQuestionTranslation()
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Removes the translated content for a specific FAQ question within an event\'s FAQ section in a given locale, reverting that locale to the question\'s default content; requires update permission on events.
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -76,7 +76,7 @@ const { status, data } = await apiInstance.deleteEventFaqSectionQuestionTranslat
|
|
|
76
76
|
# **deleteEventFaqSectionTranslation**
|
|
77
77
|
> SyncAccounts200Response deleteEventFaqSectionTranslation()
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
Removes the translated title and content for a specific FAQ section of an event in a given locale, reverting that locale to the section\'s default content; requires update permission on events.
|
|
80
80
|
|
|
81
81
|
### Example
|
|
82
82
|
|
|
@@ -133,7 +133,7 @@ const { status, data } = await apiInstance.deleteEventFaqSectionTranslation(
|
|
|
133
133
|
# **getEventFaqSectionQuestionTranslation**
|
|
134
134
|
> GetEventFaqSectionQuestionTranslation200Response getEventFaqSectionQuestionTranslation()
|
|
135
135
|
|
|
136
|
-
|
|
136
|
+
Returns the localized translation for a specific FAQ question within an event FAQ section and locale, 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.getEventFaqSectionQuestionTranslation
|
|
|
193
193
|
# **getEventFaqSectionQuestionTranslations**
|
|
194
194
|
> GetEventFaqSectionQuestionTranslations200Response getEventFaqSectionQuestionTranslations()
|
|
195
195
|
|
|
196
|
-
|
|
196
|
+
Returns a paginated list of locale translations for a specific FAQ question within an event FAQ section, supporting page, pageSize, orderBy, and search filters; requires read permission on events.
|
|
197
197
|
|
|
198
198
|
### Example
|
|
199
199
|
|
|
@@ -262,7 +262,7 @@ const { status, data } = await apiInstance.getEventFaqSectionQuestionTranslation
|
|
|
262
262
|
# **getEventFaqSectionTranslation**
|
|
263
263
|
> GetEventFaqSectionTranslation200Response getEventFaqSectionTranslation()
|
|
264
264
|
|
|
265
|
-
|
|
265
|
+
Returns the localized translation for a specific event FAQ section and locale, 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.getEventFaqSectionTranslation(
|
|
|
319
319
|
# **getEventFaqSectionTranslations**
|
|
320
320
|
> GetEventFaqSectionTranslations200Response getEventFaqSectionTranslations()
|
|
321
321
|
|
|
322
|
-
|
|
322
|
+
Returns a paginated list of locale translations for a specific event FAQ section, supporting page, pageSize, orderBy, and search filters; requires read permission on events.
|
|
323
323
|
|
|
324
324
|
### Example
|
|
325
325
|
|
|
@@ -385,7 +385,7 @@ const { status, data } = await apiInstance.getEventFaqSectionTranslations(
|
|
|
385
385
|
# **updateEventFaqSectionQuestionTranslation**
|
|
386
386
|
> SyncAccounts200Response updateEventFaqSectionQuestionTranslation(eventFaqSectionQuestionTranslationUpdateInputs)
|
|
387
387
|
|
|
388
|
-
|
|
388
|
+
Updates the translated text for a specific locale on a question within an event FAQ section, creating the translation if it does not already exist; requires the \"update\" permission on events.
|
|
389
389
|
|
|
390
390
|
### Example
|
|
391
391
|
|
|
@@ -449,7 +449,7 @@ const { status, data } = await apiInstance.updateEventFaqSectionQuestionTranslat
|
|
|
449
449
|
# **updateEventFaqSectionTranslation**
|
|
450
450
|
> SyncAccounts200Response updateEventFaqSectionTranslation(eventFaqSectionTranslationUpdateInputs)
|
|
451
451
|
|
|
452
|
-
|
|
452
|
+
Updates the translated text for a specific locale on an event FAQ section, creating the translation if it does not already exist; requires the \"update\" permission on events.
|
|
453
453
|
|
|
454
454
|
### Example
|
|
455
455
|
|
|
@@ -4,30 +4,30 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventFollowupAddOn**](#addeventfollowupaddon) | **POST** /events/{eventId}/followups/{followupId}/addOns/{addOnId} | Add
|
|
8
|
-
|[**addEventFollowupPassType**](#addeventfollowuppasstype) | **POST** /events/{eventId}/followups/{followupId}/passTypes/{passTypeId} | Add
|
|
9
|
-
|[**addEventFollowupQuestion**](#addeventfollowupquestion) | **POST** /events/{eventId}/followups/{followupId}/questions/{questionId} | Add
|
|
10
|
-
|[**addEventFollowupTier**](#addeventfollowuptier) | **POST** /events/{eventId}/followups/{followupId}/tiers/{tierId} |
|
|
11
|
-
|[**createEventFollowup**](#createeventfollowup) | **POST** /events/{eventId}/followups | Create
|
|
12
|
-
|[**deleteEventFollowup**](#deleteeventfollowup) | **DELETE** /events/{eventId}/followups/{followupId} | Delete
|
|
13
|
-
|[**getEventFollowup**](#geteventfollowup) | **GET** /events/{eventId}/followups/{followupId} | Get
|
|
14
|
-
|[**getEventFollowupAddOns**](#geteventfollowupaddons) | **GET** /events/{eventId}/followups/{followupId}/addOns |
|
|
15
|
-
|[**getEventFollowupPassTypes**](#geteventfollowuppasstypes) | **GET** /events/{eventId}/followups/{followupId}/passTypes |
|
|
16
|
-
|[**getEventFollowupQuestions**](#geteventfollowupquestions) | **GET** /events/{eventId}/followups/{followupId}/questions |
|
|
17
|
-
|[**getEventFollowupTiers**](#geteventfollowuptiers) | **GET** /events/{eventId}/followups/{followupId}/tiers |
|
|
18
|
-
|[**getEventFollowups**](#geteventfollowups) | **GET** /events/{eventId}/followups |
|
|
19
|
-
|[**removeEventFollowupAddOn**](#removeeventfollowupaddon) | **DELETE** /events/{eventId}/followups/{followupId}/addOns/{addOnId} | Remove
|
|
20
|
-
|[**removeEventFollowupPassType**](#removeeventfollowuppasstype) | **DELETE** /events/{eventId}/followups/{followupId}/passTypes/{passTypeId} | Remove
|
|
21
|
-
|[**removeEventFollowupQuestion**](#removeeventfollowupquestion) | **DELETE** /events/{eventId}/followups/{followupId}/questions/{questionId} | Remove
|
|
22
|
-
|[**removeEventFollowupTier**](#removeeventfollowuptier) | **DELETE** /events/{eventId}/followups/{followupId}/tiers/{tierId} | Remove
|
|
23
|
-
|[**reorderEventFollowupQuestions**](#reordereventfollowupquestions) | **PUT** /events/{eventId}/followups/{followupId}/questions/reorder | Reorder
|
|
24
|
-
|[**updateEventFollowup**](#updateeventfollowup) | **PUT** /events/{eventId}/followups/{followupId} | Update
|
|
25
|
-
|[**updateEventFollowupQuestion**](#updateeventfollowupquestion) | **PUT** /events/{eventId}/followups/{followupId}/questions/{questionId} | Update
|
|
7
|
+
|[**addEventFollowupAddOn**](#addeventfollowupaddon) | **POST** /events/{eventId}/followups/{followupId}/addOns/{addOnId} | Add an add-on to an event followup|
|
|
8
|
+
|[**addEventFollowupPassType**](#addeventfollowuppasstype) | **POST** /events/{eventId}/followups/{followupId}/passTypes/{passTypeId} | Add a pass type to an event followup|
|
|
9
|
+
|[**addEventFollowupQuestion**](#addeventfollowupquestion) | **POST** /events/{eventId}/followups/{followupId}/questions/{questionId} | Add a question to an event followup|
|
|
10
|
+
|[**addEventFollowupTier**](#addeventfollowuptier) | **POST** /events/{eventId}/followups/{followupId}/tiers/{tierId} | Set an account tier\'s access to an event followup|
|
|
11
|
+
|[**createEventFollowup**](#createeventfollowup) | **POST** /events/{eventId}/followups | Create an event followup|
|
|
12
|
+
|[**deleteEventFollowup**](#deleteeventfollowup) | **DELETE** /events/{eventId}/followups/{followupId} | Delete an event followup|
|
|
13
|
+
|[**getEventFollowup**](#geteventfollowup) | **GET** /events/{eventId}/followups/{followupId} | Get an event registration followup|
|
|
14
|
+
|[**getEventFollowupAddOns**](#geteventfollowupaddons) | **GET** /events/{eventId}/followups/{followupId}/addOns | List a followup\'s linked add-ons|
|
|
15
|
+
|[**getEventFollowupPassTypes**](#geteventfollowuppasstypes) | **GET** /events/{eventId}/followups/{followupId}/passTypes | List a followup\'s linked pass types|
|
|
16
|
+
|[**getEventFollowupQuestions**](#geteventfollowupquestions) | **GET** /events/{eventId}/followups/{followupId}/questions | List a followup\'s questions|
|
|
17
|
+
|[**getEventFollowupTiers**](#geteventfollowuptiers) | **GET** /events/{eventId}/followups/{followupId}/tiers | List account tiers allowed/disallowed for a followup|
|
|
18
|
+
|[**getEventFollowups**](#geteventfollowups) | **GET** /events/{eventId}/followups | List an event\'s registration followups|
|
|
19
|
+
|[**removeEventFollowupAddOn**](#removeeventfollowupaddon) | **DELETE** /events/{eventId}/followups/{followupId}/addOns/{addOnId} | Remove an add-on from an event followup|
|
|
20
|
+
|[**removeEventFollowupPassType**](#removeeventfollowuppasstype) | **DELETE** /events/{eventId}/followups/{followupId}/passTypes/{passTypeId} | Remove a pass type from an event followup|
|
|
21
|
+
|[**removeEventFollowupQuestion**](#removeeventfollowupquestion) | **DELETE** /events/{eventId}/followups/{followupId}/questions/{questionId} | Remove a question from an event followup|
|
|
22
|
+
|[**removeEventFollowupTier**](#removeeventfollowuptier) | **DELETE** /events/{eventId}/followups/{followupId}/tiers/{tierId} | Remove an account tier from a followup|
|
|
23
|
+
|[**reorderEventFollowupQuestions**](#reordereventfollowupquestions) | **PUT** /events/{eventId}/followups/{followupId}/questions/reorder | Reorder a followup\'s questions|
|
|
24
|
+
|[**updateEventFollowup**](#updateeventfollowup) | **PUT** /events/{eventId}/followups/{followupId} | Update an event followup|
|
|
25
|
+
|[**updateEventFollowupQuestion**](#updateeventfollowupquestion) | **PUT** /events/{eventId}/followups/{followupId}/questions/{questionId} | Update a followup question\'s sort order|
|
|
26
26
|
|
|
27
27
|
# **addEventFollowupAddOn**
|
|
28
28
|
> CreateEventFollowup200Response addEventFollowupAddOn()
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
Associates an existing event add-on with a registration followup so it can be offered to registrants after they register, requires \"update\" permission on events.
|
|
31
31
|
|
|
32
32
|
### Example
|
|
33
33
|
|
|
@@ -84,7 +84,7 @@ const { status, data } = await apiInstance.addEventFollowupAddOn(
|
|
|
84
84
|
# **addEventFollowupPassType**
|
|
85
85
|
> CreateEventFollowup200Response addEventFollowupPassType()
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
Associates an existing event pass type with a registration followup so it can be offered to registrants after they register, requires \"update\" permission on events.
|
|
88
88
|
|
|
89
89
|
### Example
|
|
90
90
|
|
|
@@ -141,7 +141,7 @@ const { status, data } = await apiInstance.addEventFollowupPassType(
|
|
|
141
141
|
# **addEventFollowupQuestion**
|
|
142
142
|
> CreateEventFollowup200Response addEventFollowupQuestion()
|
|
143
143
|
|
|
144
|
-
|
|
144
|
+
Associates an existing registration question with a followup so it is asked of registrants after they register, requires \"update\" permission on events.
|
|
145
145
|
|
|
146
146
|
### Example
|
|
147
147
|
|
|
@@ -198,7 +198,7 @@ const { status, data } = await apiInstance.addEventFollowupQuestion(
|
|
|
198
198
|
# **addEventFollowupTier**
|
|
199
199
|
> CreateEventFollowup200Response addEventFollowupTier()
|
|
200
200
|
|
|
201
|
-
|
|
201
|
+
Adds an account tier to a registration followup\'s allow or deny list, controlling whether members of that tier see the followup, requires \"update\" permission on events and \"read\" permission on tiers.
|
|
202
202
|
|
|
203
203
|
### Example
|
|
204
204
|
|
|
@@ -258,7 +258,7 @@ const { status, data } = await apiInstance.addEventFollowupTier(
|
|
|
258
258
|
# **createEventFollowup**
|
|
259
259
|
> CreateEventFollowup200Response createEventFollowup(eventFollowupCreateInputs)
|
|
260
260
|
|
|
261
|
-
|
|
261
|
+
Creates a new registration followup for an event, which is presented to registrants after they complete registration, requires \"update\" permission on events.
|
|
262
262
|
|
|
263
263
|
### Example
|
|
264
264
|
|
|
@@ -313,7 +313,7 @@ const { status, data } = await apiInstance.createEventFollowup(
|
|
|
313
313
|
# **deleteEventFollowup**
|
|
314
314
|
> CreateAccountInvitations200Response deleteEventFollowup()
|
|
315
315
|
|
|
316
|
-
|
|
316
|
+
Permanently deletes a registration followup from an event, requires \"update\" permission on events.
|
|
317
317
|
|
|
318
318
|
### Example
|
|
319
319
|
|
|
@@ -367,7 +367,7 @@ const { status, data } = await apiInstance.deleteEventFollowup(
|
|
|
367
367
|
# **getEventFollowup**
|
|
368
368
|
> CreateEventFollowup200Response getEventFollowup()
|
|
369
369
|
|
|
370
|
-
|
|
370
|
+
Returns the details of a single registration followup for the given event, identified by followup ID; requires read permission on events.
|
|
371
371
|
|
|
372
372
|
### Example
|
|
373
373
|
|
|
@@ -421,7 +421,7 @@ const { status, data } = await apiInstance.getEventFollowup(
|
|
|
421
421
|
# **getEventFollowupAddOns**
|
|
422
422
|
> GetEventAddOns200Response getEventFollowupAddOns()
|
|
423
423
|
|
|
424
|
-
|
|
424
|
+
Returns a paginated list of event add-ons associated with the given registration followup, supporting search and ordering; requires read permission on events.
|
|
425
425
|
|
|
426
426
|
### Example
|
|
427
427
|
|
|
@@ -487,7 +487,7 @@ const { status, data } = await apiInstance.getEventFollowupAddOns(
|
|
|
487
487
|
# **getEventFollowupPassTypes**
|
|
488
488
|
> GetEventAddOnPassTypes200Response getEventFollowupPassTypes()
|
|
489
489
|
|
|
490
|
-
|
|
490
|
+
Returns a paginated list of ticket pass types associated with the given registration followup, supporting search and ordering; requires read permission on events.
|
|
491
491
|
|
|
492
492
|
### Example
|
|
493
493
|
|
|
@@ -553,7 +553,7 @@ const { status, data } = await apiInstance.getEventFollowupPassTypes(
|
|
|
553
553
|
# **getEventFollowupQuestions**
|
|
554
554
|
> GetEventFollowupQuestions200Response getEventFollowupQuestions()
|
|
555
555
|
|
|
556
|
-
|
|
556
|
+
Returns a paginated list of registration questions attached to the given event followup, supporting search and ordering; requires read permission on events.
|
|
557
557
|
|
|
558
558
|
### Example
|
|
559
559
|
|
|
@@ -619,7 +619,7 @@ const { status, data } = await apiInstance.getEventFollowupQuestions(
|
|
|
619
619
|
# **getEventFollowupTiers**
|
|
620
620
|
> GetAccountTiers200Response getEventFollowupTiers()
|
|
621
621
|
|
|
622
|
-
|
|
622
|
+
Returns a paginated list of account tiers linked to the given registration followup, filtered by the allowed flag to show either permitted or restricted tiers; requires read permission on events and tiers.
|
|
623
623
|
|
|
624
624
|
### Example
|
|
625
625
|
|
|
@@ -688,7 +688,7 @@ const { status, data } = await apiInstance.getEventFollowupTiers(
|
|
|
688
688
|
# **getEventFollowups**
|
|
689
689
|
> GetEventPassQuestionFollowups200Response getEventFollowups()
|
|
690
690
|
|
|
691
|
-
|
|
691
|
+
Returns a paginated list of registration followups configured for the given event, supporting search and ordering; requires read permission on events.
|
|
692
692
|
|
|
693
693
|
### Example
|
|
694
694
|
|
|
@@ -751,7 +751,7 @@ const { status, data } = await apiInstance.getEventFollowups(
|
|
|
751
751
|
# **removeEventFollowupAddOn**
|
|
752
752
|
> CreateEventFollowup200Response removeEventFollowupAddOn()
|
|
753
753
|
|
|
754
|
-
|
|
754
|
+
Disassociates an event add-on from a registration followup so it is no longer offered to registrants after they register, requires \"update\" permission on events.
|
|
755
755
|
|
|
756
756
|
### Example
|
|
757
757
|
|
|
@@ -808,7 +808,7 @@ const { status, data } = await apiInstance.removeEventFollowupAddOn(
|
|
|
808
808
|
# **removeEventFollowupPassType**
|
|
809
809
|
> CreateEventFollowup200Response removeEventFollowupPassType()
|
|
810
810
|
|
|
811
|
-
|
|
811
|
+
Disassociates an event pass type from a registration followup so it is no longer offered to registrants after they register, requires \"update\" permission on events.
|
|
812
812
|
|
|
813
813
|
### Example
|
|
814
814
|
|
|
@@ -865,7 +865,7 @@ const { status, data } = await apiInstance.removeEventFollowupPassType(
|
|
|
865
865
|
# **removeEventFollowupQuestion**
|
|
866
866
|
> CreateEventFollowup200Response removeEventFollowupQuestion()
|
|
867
867
|
|
|
868
|
-
|
|
868
|
+
Disassociates a registration question from a followup so it is no longer asked of registrants after they register, requires \"update\" permission on events.
|
|
869
869
|
|
|
870
870
|
### Example
|
|
871
871
|
|
|
@@ -922,7 +922,7 @@ const { status, data } = await apiInstance.removeEventFollowupQuestion(
|
|
|
922
922
|
# **removeEventFollowupTier**
|
|
923
923
|
> CreateEventFollowup200Response removeEventFollowupTier()
|
|
924
924
|
|
|
925
|
-
|
|
925
|
+
Disconnects an account tier from an event followup\'s allowed or disallowed tier list, based on the `allowed` flag, restricting or freeing which account tiers can access the followup; requires update permission on events and read permission on tiers.
|
|
926
926
|
|
|
927
927
|
### Example
|
|
928
928
|
|
|
@@ -982,7 +982,7 @@ const { status, data } = await apiInstance.removeEventFollowupTier(
|
|
|
982
982
|
# **reorderEventFollowupQuestions**
|
|
983
983
|
> ReorderEventFollowupQuestions200Response reorderEventFollowupQuestions()
|
|
984
984
|
|
|
985
|
-
|
|
985
|
+
Sets the display order of an event followup\'s questions to match the given `questionIds` array, requiring update permission on events.
|
|
986
986
|
|
|
987
987
|
### Example
|
|
988
988
|
|
|
@@ -1039,7 +1039,7 @@ const { status, data } = await apiInstance.reorderEventFollowupQuestions(
|
|
|
1039
1039
|
# **updateEventFollowup**
|
|
1040
1040
|
> CreateEventFollowup200Response updateEventFollowup()
|
|
1041
1041
|
|
|
1042
|
-
|
|
1042
|
+
Updates the fields of a registration followup on the given event, such as its name and settings, requiring update permission on events.
|
|
1043
1043
|
|
|
1044
1044
|
### Example
|
|
1045
1045
|
|
|
@@ -1097,7 +1097,7 @@ const { status, data } = await apiInstance.updateEventFollowup(
|
|
|
1097
1097
|
# **updateEventFollowupQuestion**
|
|
1098
1098
|
> CreateEventFollowup200Response updateEventFollowupQuestion()
|
|
1099
1099
|
|
|
1100
|
-
|
|
1100
|
+
Updates the sort order of a single question within an event followup, requiring update permission on events.
|
|
1101
1101
|
|
|
1102
1102
|
### Example
|
|
1103
1103
|
|
|
@@ -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
|
-
|[**deleteEventFollowupTranslation**](#deleteeventfollowuptranslation) | **DELETE** /events/{eventId}/followups/{followupId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventFollowupTranslation**](#geteventfollowuptranslation) | **GET** /events/{eventId}/followups/{followupId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventFollowupTranslations**](#geteventfollowuptranslations) | **GET** /events/{eventId}/followups/{followupId}/translations |
|
|
10
|
-
|[**updateEventFollowupTranslation**](#updateeventfollowuptranslation) | **PUT** /events/{eventId}/followups/{followupId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventFollowupTranslation**](#deleteeventfollowuptranslation) | **DELETE** /events/{eventId}/followups/{followupId}/translations/{locale} | Delete a followup\'s translation|
|
|
8
|
+
|[**getEventFollowupTranslation**](#geteventfollowuptranslation) | **GET** /events/{eventId}/followups/{followupId}/translations/{locale} | Get a followup\'s translation for a locale|
|
|
9
|
+
|[**getEventFollowupTranslations**](#geteventfollowuptranslations) | **GET** /events/{eventId}/followups/{followupId}/translations | List a followup\'s translations|
|
|
10
|
+
|[**updateEventFollowupTranslation**](#updateeventfollowuptranslation) | **PUT** /events/{eventId}/followups/{followupId}/translations/{locale} | Update an event followup\'s translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventFollowupTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventFollowupTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Permanently removes the translated content for a specific locale on an event registration followup message; requires the \"update\" permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventFollowupTranslation(
|
|
|
69
69
|
# **getEventFollowupTranslation**
|
|
70
70
|
> GetEventFollowupTranslation200Response getEventFollowupTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Returns the translated content for a single event registration followup in the given locale, or null if no translation exists; requires read permission on events.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventFollowupTranslation(
|
|
|
126
126
|
# **getEventFollowupTranslations**
|
|
127
127
|
> GetEventFollowupTranslations200Response getEventFollowupTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of locale translations for the given event registration followup, supporting search and ordering; requires read permission on events.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventFollowupTranslations(
|
|
|
192
192
|
# **updateEventFollowupTranslation**
|
|
193
193
|
> SyncAccounts200Response updateEventFollowupTranslation(eventFollowupTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Updates the localized content (for the given locale) of a registration followup on an event, requires \"update\" permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
package/docs/EventsMatchesApi.md
CHANGED
|
@@ -4,28 +4,28 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventMatchPass**](#addeventmatchpass) | **POST** /events/{eventId}/rounds/{roundId}/matches/{matchId}/passes/{passId} |
|
|
8
|
-
|[**createEventMatch**](#createeventmatch) | **POST** /events/{eventId}/rounds/{roundId}/matches | Create
|
|
9
|
-
|[**createEventRound**](#createeventround) | **POST** /events/{eventId}/rounds | Create
|
|
10
|
-
|[**deleteEventMatch**](#deleteeventmatch) | **DELETE** /events/{eventId}/rounds/{roundId}/matches/{matchId} | Delete
|
|
11
|
-
|[**deleteEventRound**](#deleteeventround) | **DELETE** /events/{eventId}/rounds/{roundId} | Delete
|
|
12
|
-
|[**getEventRoundMatch**](#geteventroundmatch) | **GET** /events/{eventId}/rounds/{roundId}/matches/{matchId} | Get
|
|
13
|
-
|[**getEventRoundMatchPasses**](#geteventroundmatchpasses) | **GET** /events/{eventId}/rounds/{roundId}/matches/{matchId}/passes |
|
|
14
|
-
|[**getEventRoundMatches**](#geteventroundmatches) | **GET** /events/{eventId}/rounds/{roundId}/matches |
|
|
15
|
-
|[**getEventRoundPasses**](#geteventroundpasses) | **GET** /events/{eventId}/rounds/{roundId}/passes |
|
|
16
|
-
|[**getEventRoundQuestions**](#geteventroundquestions) | **GET** /events/{eventId}/rounds/{roundId}/questions |
|
|
17
|
-
|[**getEventRoundQuestionsSummary**](#geteventroundquestionssummary) | **GET** /events/{eventId}/rounds/{roundId}/questions/summary |
|
|
18
|
-
|[**getEventRounds**](#geteventrounds) | **GET** /events/{eventId}/rounds |
|
|
19
|
-
|[**getEventSessionsWithRounds**](#geteventsessionswithrounds) | **GET** /events/{eventId}/all-sessions/rounds |
|
|
20
|
-
|[**removeEventMatchPass**](#removeeventmatchpass) | **DELETE** /events/{eventId}/rounds/{roundId}/matches/{matchId}/passes/{passId} | Remove
|
|
21
|
-
|[**startEventRoundMatchmaking**](#starteventroundmatchmaking) | **POST** /events/{eventId}/rounds/{roundId}/start | Start
|
|
22
|
-
|[**updateEventMatch**](#updateeventmatch) | **PUT** /events/{eventId}/rounds/{roundId}/matches/{matchId} | Update
|
|
23
|
-
|[**updateEventRoundQuestion**](#updateeventroundquestion) | **PUT** /events/{eventId}/rounds/{roundId}/questions/{questionId} |
|
|
7
|
+
|[**addEventMatchPass**](#addeventmatchpass) | **POST** /events/{eventId}/rounds/{roundId}/matches/{matchId}/passes/{passId} | Assign a pass to a match|
|
|
8
|
+
|[**createEventMatch**](#createeventmatch) | **POST** /events/{eventId}/rounds/{roundId}/matches | Create a match within a round|
|
|
9
|
+
|[**createEventRound**](#createeventround) | **POST** /events/{eventId}/rounds | Create a matchmaking round for an event|
|
|
10
|
+
|[**deleteEventMatch**](#deleteeventmatch) | **DELETE** /events/{eventId}/rounds/{roundId}/matches/{matchId} | Delete a match from a round|
|
|
11
|
+
|[**deleteEventRound**](#deleteeventround) | **DELETE** /events/{eventId}/rounds/{roundId} | Delete a matchmaking round|
|
|
12
|
+
|[**getEventRoundMatch**](#geteventroundmatch) | **GET** /events/{eventId}/rounds/{roundId}/matches/{matchId} | Get a matchmaking round match|
|
|
13
|
+
|[**getEventRoundMatchPasses**](#geteventroundmatchpasses) | **GET** /events/{eventId}/rounds/{roundId}/matches/{matchId}/passes | List passes assigned to a match|
|
|
14
|
+
|[**getEventRoundMatches**](#geteventroundmatches) | **GET** /events/{eventId}/rounds/{roundId}/matches | List a round\'s networking matches|
|
|
15
|
+
|[**getEventRoundPasses**](#geteventroundpasses) | **GET** /events/{eventId}/rounds/{roundId}/passes | List a round\'s assigned or unassigned passes|
|
|
16
|
+
|[**getEventRoundQuestions**](#geteventroundquestions) | **GET** /events/{eventId}/rounds/{roundId}/questions | List an event\'s registration questions for a round|
|
|
17
|
+
|[**getEventRoundQuestionsSummary**](#geteventroundquestionssummary) | **GET** /events/{eventId}/rounds/{roundId}/questions/summary | Summarize a round\'s question matching types|
|
|
18
|
+
|[**getEventRounds**](#geteventrounds) | **GET** /events/{eventId}/rounds | List an event\'s networking rounds|
|
|
19
|
+
|[**getEventSessionsWithRounds**](#geteventsessionswithrounds) | **GET** /events/{eventId}/all-sessions/rounds | List event sessions that have networking rounds|
|
|
20
|
+
|[**removeEventMatchPass**](#removeeventmatchpass) | **DELETE** /events/{eventId}/rounds/{roundId}/matches/{matchId}/passes/{passId} | Remove a pass from a match|
|
|
21
|
+
|[**startEventRoundMatchmaking**](#starteventroundmatchmaking) | **POST** /events/{eventId}/rounds/{roundId}/start | Start matchmaking for an event round|
|
|
22
|
+
|[**updateEventMatch**](#updateeventmatch) | **PUT** /events/{eventId}/rounds/{roundId}/matches/{matchId} | Update an event round match|
|
|
23
|
+
|[**updateEventRoundQuestion**](#updateeventroundquestion) | **PUT** /events/{eventId}/rounds/{roundId}/questions/{questionId} | Set a registration question\'s matchmaking type for a round|
|
|
24
24
|
|
|
25
25
|
# **addEventMatchPass**
|
|
26
26
|
> CreateAccountInvitations200Response addEventMatchPass()
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Connects an attendee\'s pass to a match within an event round, disconnecting it from any other match in that round first, requiring update permission on attendees.
|
|
29
29
|
|
|
30
30
|
### Example
|
|
31
31
|
|
|
@@ -85,7 +85,7 @@ const { status, data } = await apiInstance.addEventMatchPass(
|
|
|
85
85
|
# **createEventMatch**
|
|
86
86
|
> CreateEventMatch200Response createEventMatch()
|
|
87
87
|
|
|
88
|
-
|
|
88
|
+
Creates a new match in the given event round, automatically assigning it the next sequential match number, requiring create permission on events.
|
|
89
89
|
|
|
90
90
|
### Example
|
|
91
91
|
|
|
@@ -139,7 +139,7 @@ const { status, data } = await apiInstance.createEventMatch(
|
|
|
139
139
|
# **createEventRound**
|
|
140
140
|
> CreateEventRound200Response createEventRound()
|
|
141
141
|
|
|
142
|
-
|
|
142
|
+
Creates a new round for the given event, automatically assigning it the next sequential round number, requiring update permission on events.
|
|
143
143
|
|
|
144
144
|
### Example
|
|
145
145
|
|
|
@@ -190,7 +190,7 @@ const { status, data } = await apiInstance.createEventRound(
|
|
|
190
190
|
# **deleteEventMatch**
|
|
191
191
|
> CreateAccountInvitations200Response deleteEventMatch()
|
|
192
192
|
|
|
193
|
-
|
|
193
|
+
Permanently deletes a single match from an event round, requiring update permission on events.
|
|
194
194
|
|
|
195
195
|
### Example
|
|
196
196
|
|
|
@@ -247,7 +247,7 @@ const { status, data } = await apiInstance.deleteEventMatch(
|
|
|
247
247
|
# **deleteEventRound**
|
|
248
248
|
> CreateAccountInvitations200Response deleteEventRound()
|
|
249
249
|
|
|
250
|
-
|
|
250
|
+
Permanently deletes a round, along with its matches, from an event, requiring update permission on events.
|
|
251
251
|
|
|
252
252
|
### Example
|
|
253
253
|
|
|
@@ -301,7 +301,7 @@ const { status, data } = await apiInstance.deleteEventRound(
|
|
|
301
301
|
# **getEventRoundMatch**
|
|
302
302
|
> CreateEventMatch200Response getEventRoundMatch()
|
|
303
303
|
|
|
304
|
-
|
|
304
|
+
Returns the details of a single match within a matchmaking round for the given event, identified by round ID and match ID; requires read permission on events.
|
|
305
305
|
|
|
306
306
|
### Example
|
|
307
307
|
|
|
@@ -358,7 +358,7 @@ const { status, data } = await apiInstance.getEventRoundMatch(
|
|
|
358
358
|
# **getEventRoundMatchPasses**
|
|
359
359
|
> GetEventAddOnPasses200Response getEventRoundMatchPasses()
|
|
360
360
|
|
|
361
|
-
|
|
361
|
+
Returns a paginated list of event passes (attendee purchases) assigned to a specific match within a networking round, with optional search; requires read access to events and attendees.
|
|
362
362
|
|
|
363
363
|
### Example
|
|
364
364
|
|
|
@@ -427,7 +427,7 @@ const { status, data } = await apiInstance.getEventRoundMatchPasses(
|
|
|
427
427
|
# **getEventRoundMatches**
|
|
428
428
|
> GetEventRoundMatches200Response getEventRoundMatches()
|
|
429
429
|
|
|
430
|
-
|
|
430
|
+
Returns a paginated list of matches (attendee pairings/groupings) generated for a networking round, with optional search and sort; requires read access to events.
|
|
431
431
|
|
|
432
432
|
### Example
|
|
433
433
|
|
|
@@ -493,7 +493,7 @@ const { status, data } = await apiInstance.getEventRoundMatches(
|
|
|
493
493
|
# **getEventRoundPasses**
|
|
494
494
|
> GetEventAddOnPasses200Response getEventRoundPasses()
|
|
495
495
|
|
|
496
|
-
|
|
496
|
+
Returns a paginated list of event passes eligible for a networking round, filterable by the `assigned` flag to show passes already matched into the round versus those still unmatched, with optional search; requires read access to events and attendees.
|
|
497
497
|
|
|
498
498
|
### Example
|
|
499
499
|
|
|
@@ -562,7 +562,7 @@ const { status, data } = await apiInstance.getEventRoundPasses(
|
|
|
562
562
|
# **getEventRoundQuestions**
|
|
563
563
|
> GetEventRoundQuestions200Response getEventRoundQuestions()
|
|
564
564
|
|
|
565
|
-
|
|
565
|
+
Returns a paginated list of the event\'s registration questions annotated with their matching-round status (e.g. included, weighted, or excluded) for the given round, with optional search; requires read access to events.
|
|
566
566
|
|
|
567
567
|
### Example
|
|
568
568
|
|
|
@@ -628,7 +628,7 @@ const { status, data } = await apiInstance.getEventRoundQuestions(
|
|
|
628
628
|
# **getEventRoundQuestionsSummary**
|
|
629
629
|
> GetEventRoundQuestionsSummary200Response getEventRoundQuestionsSummary()
|
|
630
630
|
|
|
631
|
-
|
|
631
|
+
Returns a map of registration question ID to its matchmaking type (e.g. how it is weighted or excluded) for the given networking round; requires read access to events.
|
|
632
632
|
|
|
633
633
|
### Example
|
|
634
634
|
|
|
@@ -682,7 +682,7 @@ const { status, data } = await apiInstance.getEventRoundQuestionsSummary(
|
|
|
682
682
|
# **getEventRounds**
|
|
683
683
|
> GetEventRounds200Response getEventRounds()
|
|
684
684
|
|
|
685
|
-
|
|
685
|
+
Returns all matchmaking/networking rounds configured for the given event; requires read access to events.
|
|
686
686
|
|
|
687
687
|
### Example
|
|
688
688
|
|
|
@@ -733,7 +733,7 @@ const { status, data } = await apiInstance.getEventRounds(
|
|
|
733
733
|
# **getEventSessionsWithRounds**
|
|
734
734
|
> GetBookingSpaceSlots200Response getEventSessionsWithRounds()
|
|
735
735
|
|
|
736
|
-
|
|
736
|
+
Returns every session for the event that has at least one networking round with matches, with each session\'s rounds embedded; requires read access to events.
|
|
737
737
|
|
|
738
738
|
### Example
|
|
739
739
|
|
|
@@ -784,7 +784,7 @@ const { status, data } = await apiInstance.getEventSessionsWithRounds(
|
|
|
784
784
|
# **removeEventMatchPass**
|
|
785
785
|
> CreateAccountInvitations200Response removeEventMatchPass()
|
|
786
786
|
|
|
787
|
-
|
|
787
|
+
Disconnects an attendee\'s pass from a match within an event round, requiring update permission on attendees.
|
|
788
788
|
|
|
789
789
|
### Example
|
|
790
790
|
|
|
@@ -844,7 +844,7 @@ const { status, data } = await apiInstance.removeEventMatchPass(
|
|
|
844
844
|
# **startEventRoundMatchmaking**
|
|
845
845
|
> CreateAccountInvitations200Response startEventRoundMatchmaking()
|
|
846
846
|
|
|
847
|
-
|
|
847
|
+
Kicks off automated matchmaking for the given round of an event, setting the target size for each generated match and queuing the matchmaking job for asynchronous processing; requires the round to have at least one question configured for matching and requires update permission on events.
|
|
848
848
|
|
|
849
849
|
### Example
|
|
850
850
|
|
|
@@ -901,7 +901,7 @@ const { status, data } = await apiInstance.startEventRoundMatchmaking(
|
|
|
901
901
|
# **updateEventMatch**
|
|
902
902
|
> CreateEventMatch200Response updateEventMatch(matchUpdateInputs)
|
|
903
903
|
|
|
904
|
-
|
|
904
|
+
Updates the fields (such as room or session assignment) of a single match belonging to a matchmaking round for an event, and requires update permission on events.
|
|
905
905
|
|
|
906
906
|
### Example
|
|
907
907
|
|
|
@@ -962,7 +962,7 @@ const { status, data } = await apiInstance.updateEventMatch(
|
|
|
962
962
|
# **updateEventRoundQuestion**
|
|
963
963
|
> UpdateEventRoundQuestion200Response updateEventRoundQuestion(roundEventQuestionUpdataInputs)
|
|
964
964
|
|
|
965
|
-
|
|
965
|
+
Sets how a specific event registration question is used by matchmaking for a given round (include, split, or exclude), creating the round-question link if it doesn\'t already exist, and requires update permission on events.
|
|
966
966
|
|
|
967
967
|
### Example
|
|
968
968
|
|