@connectedxm/admin-sdk 7.5.0 → 7.8.0
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/.openapi-generator/FILES +1 -0
- package/README.md +1215 -1212
- package/api.ts +9898 -9710
- package/dist/api.d.ts +9807 -9710
- package/dist/api.js +9842 -9696
- package/dist/esm/api.d.ts +9807 -9710
- package/dist/esm/api.js +9842 -9696
- package/docs/AccountsAddressesApi.md +10 -10
- package/docs/AccountsApi.md +42 -42
- package/docs/AccountsFollowersApi.md +6 -6
- package/docs/AccountsFollowingApi.md +6 -6
- package/docs/AccountsGroupsApi.md +6 -6
- package/docs/AccountsInterestsApi.md +6 -6
- package/docs/AccountsInvitationsApi.md +6 -6
- package/docs/AccountsLeadsApi.md +8 -8
- package/docs/AccountsTiersApi.md +8 -8
- package/docs/ActivitiesApi.md +18 -18
- package/docs/ActivitiesScheduleApi.md +4 -4
- package/docs/AdvertisementsApi.md +14 -14
- package/docs/AnnouncementsApi.md +16 -16
- package/docs/AnnouncementsScheduleApi.md +4 -4
- package/docs/AnnouncementsTranslationsApi.md +8 -8
- package/docs/ApiLogsApi.md +4 -4
- package/docs/AuthSessionsApi.md +4 -4
- package/docs/BaseEvent.md +6 -0
- package/docs/BaseEventSessionLocation.md +2 -0
- package/docs/BenefitsApi.md +12 -12
- package/docs/BenefitsTranslationsApi.md +8 -8
- package/docs/BookingsApi.md +56 -56
- package/docs/BookingsAvailabilitiesApi.md +6 -6
- package/docs/BookingsBlackoutsApi.md +6 -6
- package/docs/BookingsPlacesApi.md +6 -6
- package/docs/BookingsPlacesTranslationsApi.md +4 -4
- package/docs/BookingsQuestionsApi.md +16 -16
- package/docs/BookingsQuestionsChoicesApi.md +12 -12
- package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
- package/docs/BookingsQuestionsTranslationsApi.md +8 -8
- package/docs/BookingsSpacesApi.md +6 -6
- package/docs/BookingsSpacesTranslationsApi.md +4 -4
- package/docs/ChannelsApi.md +58 -58
- package/docs/ChannelsTranslationsApi.md +24 -24
- package/docs/DashboardsApi.md +10 -10
- package/docs/DashboardsWidgetsApi.md +8 -8
- package/docs/EmailReceiptsApi.md +4 -4
- package/docs/Event.md +10 -0
- package/docs/EventCreateInputs.md +0 -14
- package/docs/EventLocationInputs.md +38 -0
- package/docs/EventSessionLocation.md +6 -0
- package/docs/EventSessionLocationCreateInputs.md +2 -0
- package/docs/EventSessionLocationUpdateInputs.md +2 -0
- package/docs/EventUpdateInputs.md +0 -14
- 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 +130 -22
- package/docs/EventsAttendeesApi.md +24 -24
- package/docs/EventsAttendeesPackagesApi.md +10 -10
- package/docs/EventsAttendeesReservationsApi.md +18 -18
- package/docs/EventsAttributesApi.md +10 -10
- package/docs/EventsBenefitsApi.md +4 -4
- package/docs/EventsBlocksApi.md +16 -16
- package/docs/EventsBypassApi.md +10 -10
- package/docs/EventsCohostsApi.md +6 -6
- package/docs/EventsCouponsApi.md +28 -28
- package/docs/EventsEmailsApi.md +4 -4
- package/docs/EventsEmailsTranslationsApi.md +8 -8
- package/docs/EventsFaqsApi.md +22 -22
- package/docs/EventsFaqsTranslationsApi.md +16 -16
- package/docs/EventsFollowupsApi.md +38 -38
- package/docs/EventsFollowupsTranslationsApi.md +8 -8
- package/docs/EventsMatchesApi.md +34 -34
- package/docs/EventsMediaApi.md +16 -16
- package/docs/EventsMediaTranslationsApi.md +8 -8
- package/docs/EventsOnSiteApi.md +6 -6
- package/docs/EventsPackagesApi.md +10 -10
- package/docs/EventsPackagesPassesApi.md +10 -10
- package/docs/EventsPackagesTranslationsApi.md +8 -8
- package/docs/EventsPagesApi.md +16 -16
- package/docs/EventsPagesTranslationsApi.md +8 -8
- package/docs/EventsPassesAccessesApi.md +10 -10
- package/docs/EventsPassesAddonsApi.md +6 -6
- package/docs/EventsPassesApi.md +34 -34
- package/docs/EventsPassesAttributesApi.md +6 -6
- package/docs/EventsPassesFollowupsApi.md +8 -8
- package/docs/EventsPassesResponsesApi.md +10 -10
- package/docs/EventsPasstypesApi.md +34 -34
- package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
- package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
- package/docs/EventsPasstypesTranslationsApi.md +8 -8
- package/docs/EventsQuestionsApi.md +44 -44
- package/docs/EventsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsRoomsApi.md +18 -18
- package/docs/EventsRoomtypesApi.md +24 -24
- package/docs/EventsRoomtypesTranslationsApi.md +8 -8
- package/docs/EventsSectionsApi.md +38 -38
- package/docs/EventsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsAccessesApi.md +6 -6
- package/docs/EventsSessionsApi.md +70 -70
- package/docs/EventsSessionsLocationsApi.md +16 -16
- package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
- package/docs/EventsSessionsMatchesApi.md +32 -32
- package/docs/EventsSessionsPricesApi.md +6 -6
- package/docs/EventsSessionsQuestionsApi.md +38 -38
- package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsSessionsSectionsApi.md +20 -20
- package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsTimesApi.md +16 -16
- package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
- package/docs/EventsSessionsTranslationsApi.md +8 -8
- package/docs/EventsSpeakersApi.md +16 -16
- package/docs/EventsSpeakersTranslationsApi.md +8 -8
- package/docs/EventsSponsorsApi.md +8 -8
- package/docs/EventsSponsorshiplevelsApi.md +12 -12
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
- package/docs/EventsSponsorshipsApi.md +12 -12
- package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
- package/docs/EventsTemplatesApi.md +2 -2
- package/docs/EventsTracksApi.md +22 -22
- package/docs/EventsTracksTranslationsApi.md +8 -8
- package/docs/EventsTransfersApi.md +4 -4
- package/docs/EventsTranslationsApi.md +8 -8
- package/docs/FilesApi.md +4 -4
- package/docs/GroupsApi.md +12 -12
- package/docs/GroupsEventsApi.md +6 -6
- package/docs/GroupsInterestsApi.md +6 -6
- package/docs/GroupsInvitationsApi.md +12 -12
- package/docs/GroupsMembersApi.md +8 -8
- package/docs/GroupsModeratorsApi.md +6 -6
- package/docs/GroupsRequestsApi.md +10 -10
- package/docs/GroupsSponsorsApi.md +6 -6
- package/docs/GroupsTranslationsApi.md +8 -8
- package/docs/ImportsApi.md +8 -8
- package/docs/InterestsApi.md +22 -22
- package/docs/InvoicesApi.md +20 -20
- package/docs/InvoicesLineitemsApi.md +6 -6
- package/docs/LoginsAccountsApi.md +6 -6
- package/docs/LoginsApi.md +16 -16
- package/docs/MeetingsApi.md +14 -14
- package/docs/MeetingsLinksApi.md +10 -10
- package/docs/MeetingsLivestreamsApi.md +12 -12
- package/docs/MeetingsParticipantsApi.md +12 -12
- package/docs/MeetingsPresetsApi.md +10 -10
- package/docs/MeetingsRecordingsApi.md +4 -4
- package/docs/MeetingsSessionsApi.md +16 -16
- package/docs/NotificationsApi.md +8 -8
- package/docs/OrganizationApi.md +18 -18
- package/docs/OrganizationAttributesApi.md +14 -14
- package/docs/OrganizationDomainsApi.md +6 -6
- package/docs/OrganizationIntegrationsApi.md +10 -10
- package/docs/OrganizationModulesApi.md +6 -6
- package/docs/OrganizationModulesCustomApi.md +10 -10
- package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
- package/docs/OrganizationModulesSettingsApi.md +4 -4
- package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
- package/docs/OrganizationModulesTiersApi.md +12 -12
- package/docs/OrganizationPaymentsApi.md +20 -20
- package/docs/OrganizationSideeffectsApi.md +8 -8
- package/docs/OrganizationTaxApi.md +22 -22
- package/docs/OrganizationTeammembersApi.md +10 -10
- package/docs/OrganizationUsersApi.md +6 -6
- package/docs/OrganizationWebhooksApi.md +12 -12
- package/docs/PaymentsApi.md +2 -2
- package/docs/PreferencesApi.md +4 -4
- package/docs/PushDevicesApi.md +6 -6
- package/docs/ReportsApi.md +22 -22
- package/docs/ReportsUsersApi.md +6 -6
- package/docs/SearchlistsApi.md +10 -10
- package/docs/SearchlistsValuesApi.md +14 -14
- package/docs/SelfApi.md +10 -10
- package/docs/SelfApikeysApi.md +8 -8
- package/docs/SelfImagesApi.md +4 -4
- package/docs/SeriesApi.md +18 -18
- package/docs/SeriesQuestionsApi.md +14 -14
- package/docs/SeriesQuestionsChoicesApi.md +8 -8
- package/docs/SeriesQuestionsTranslationsApi.md +4 -4
- package/docs/SeriesRegistrationsApi.md +18 -18
- package/docs/SeriesTranslationsApi.md +8 -8
- package/docs/SponsorsAccountsApi.md +6 -6
- package/docs/SponsorsApi.md +10 -10
- package/docs/SponsorsTranslationsApi.md +8 -8
- package/docs/StorageFilesApi.md +6 -6
- package/docs/StorageImagesApi.md +18 -18
- package/docs/StorageVideosApi.md +14 -14
- package/docs/StorageVideosCaptionsApi.md +10 -10
- package/docs/StreamsApi.md +14 -14
- package/docs/StreamsOutputsApi.md +10 -10
- package/docs/StreamsSessionsApi.md +12 -12
- package/docs/SupportApi.md +14 -14
- package/docs/SupportMessagesApi.md +4 -4
- package/docs/SupportNotesApi.md +6 -6
- package/docs/SurveysApi.md +12 -12
- package/docs/SurveysQuestionsApi.md +38 -38
- package/docs/SurveysQuestionsTranslationsApi.md +16 -16
- package/docs/SurveysSectionsApi.md +20 -20
- package/docs/SurveysSectionsTranslationsApi.md +8 -8
- package/docs/SurveysSessionsApi.md +4 -4
- package/docs/SurveysSubmissionsApi.md +14 -14
- package/docs/SurveysTranslationsApi.md +8 -8
- package/docs/ThreadsAccountsApi.md +8 -8
- package/docs/ThreadsApi.md +10 -10
- package/docs/ThreadsMessagesApi.md +12 -12
- package/docs/ThreadsMessagesFilesApi.md +6 -6
- package/docs/ThreadsMessagesImagesApi.md +6 -6
- package/docs/ThreadsMessagesReactionsApi.md +6 -6
- package/docs/ThreadsMessagesVideosApi.md +6 -6
- package/docs/ThreadsStorageApi.md +6 -6
- package/docs/TiersApi.md +20 -20
- package/package.json +1 -1
package/docs/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
|
|
package/docs/EventsMediaApi.md
CHANGED
|
@@ -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
|
-
|[**addEventMediaItemPassType**](#addeventmediaitempasstype) | **POST** /events/{eventId}/media/{mediaItemId}/passTypes/{passTypeId} |
|
|
8
|
-
|[**createEventMediaItem**](#createeventmediaitem) | **POST** /events/{eventId}/media | Create
|
|
9
|
-
|[**deleteEventMediaItem**](#deleteeventmediaitem) | **DELETE** /events/{eventId}/media/{mediaItemId} | Delete
|
|
10
|
-
|[**getEventMediaItem**](#geteventmediaitem) | **GET** /events/{eventId}/media/{itemId} | Get
|
|
11
|
-
|[**getEventMediaItemPassTypes**](#geteventmediaitempasstypes) | **GET** /events/{eventId}/media/{mediaItemId}/passTypes |
|
|
12
|
-
|[**getEventMediaItems**](#geteventmediaitems) | **GET** /events/{eventId}/media |
|
|
13
|
-
|[**removeEventMediaItemPassType**](#removeeventmediaitempasstype) | **DELETE** /events/{eventId}/media/{mediaItemId}/passTypes/{passTypeId} | Remove
|
|
14
|
-
|[**updateEventMediaItem**](#updateeventmediaitem) | **PUT** /events/{eventId}/media/{mediaItemId} | Update
|
|
7
|
+
|[**addEventMediaItemPassType**](#addeventmediaitempasstype) | **POST** /events/{eventId}/media/{mediaItemId}/passTypes/{passTypeId} | Restrict an event media item to a pass type|
|
|
8
|
+
|[**createEventMediaItem**](#createeventmediaitem) | **POST** /events/{eventId}/media | Create an event media item|
|
|
9
|
+
|[**deleteEventMediaItem**](#deleteeventmediaitem) | **DELETE** /events/{eventId}/media/{mediaItemId} | Delete an event media item|
|
|
10
|
+
|[**getEventMediaItem**](#geteventmediaitem) | **GET** /events/{eventId}/media/{itemId} | Get a single event media item|
|
|
11
|
+
|[**getEventMediaItemPassTypes**](#geteventmediaitempasstypes) | **GET** /events/{eventId}/media/{mediaItemId}/passTypes | List pass types linked to a media item|
|
|
12
|
+
|[**getEventMediaItems**](#geteventmediaitems) | **GET** /events/{eventId}/media | List an event\'s media items|
|
|
13
|
+
|[**removeEventMediaItemPassType**](#removeeventmediaitempasstype) | **DELETE** /events/{eventId}/media/{mediaItemId}/passTypes/{passTypeId} | Remove a pass type restriction from an event media item|
|
|
14
|
+
|[**updateEventMediaItem**](#updateeventmediaitem) | **PUT** /events/{eventId}/media/{mediaItemId} | Update an event media item|
|
|
15
15
|
|
|
16
16
|
# **addEventMediaItemPassType**
|
|
17
17
|
> CreateEventMediaItem200Response addEventMediaItemPassType()
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Grants a specific pass type access to an event media item, restricting who can view it, and requires read and update permission on both events and storage.
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -73,7 +73,7 @@ const { status, data } = await apiInstance.addEventMediaItemPassType(
|
|
|
73
73
|
# **createEventMediaItem**
|
|
74
74
|
> CreateEventMediaItem200Response createEventMediaItem(eventMediaItemCreateInputs)
|
|
75
75
|
|
|
76
|
-
|
|
76
|
+
Creates a new media item (image, video, or file) in an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
77
77
|
|
|
78
78
|
### Example
|
|
79
79
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.createEventMediaItem(
|
|
|
128
128
|
# **deleteEventMediaItem**
|
|
129
129
|
> CreateAccountInvitations200Response deleteEventMediaItem()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Permanently removes a media item from an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -182,7 +182,7 @@ const { status, data } = await apiInstance.deleteEventMediaItem(
|
|
|
182
182
|
# **getEventMediaItem**
|
|
183
183
|
> CreateEventMediaItem200Response getEventMediaItem()
|
|
184
184
|
|
|
185
|
-
|
|
185
|
+
Returns the details of a single media item (e.g. an image, video, or file) belonging to the given event; requires read access to events and storage.
|
|
186
186
|
|
|
187
187
|
### Example
|
|
188
188
|
|
|
@@ -236,7 +236,7 @@ const { status, data } = await apiInstance.getEventMediaItem(
|
|
|
236
236
|
# **getEventMediaItemPassTypes**
|
|
237
237
|
> GetEventAddOnPassTypes200Response getEventMediaItemPassTypes()
|
|
238
238
|
|
|
239
|
-
|
|
239
|
+
Returns a paginated list of the event\'s pass types (ticket types) that are associated with a given media item, supporting search and ordering; requires read access to events and storage.
|
|
240
240
|
|
|
241
241
|
### Example
|
|
242
242
|
|
|
@@ -302,7 +302,7 @@ const { status, data } = await apiInstance.getEventMediaItemPassTypes(
|
|
|
302
302
|
# **getEventMediaItems**
|
|
303
303
|
> GetEventMediaItems200Response getEventMediaItems()
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
Returns a paginated list of media items (images, videos, or files) belonging to the given event, optionally filtered by media type, with search and ordering support; requires read access to events and storage.
|
|
306
306
|
|
|
307
307
|
### Example
|
|
308
308
|
|
|
@@ -368,7 +368,7 @@ const { status, data } = await apiInstance.getEventMediaItems(
|
|
|
368
368
|
# **removeEventMediaItemPassType**
|
|
369
369
|
> CreateEventMediaItem200Response removeEventMediaItemPassType()
|
|
370
370
|
|
|
371
|
-
|
|
371
|
+
Revokes a pass type\'s access to an event media item, and requires read and update permission on both events and storage.
|
|
372
372
|
|
|
373
373
|
### Example
|
|
374
374
|
|
|
@@ -425,7 +425,7 @@ const { status, data } = await apiInstance.removeEventMediaItemPassType(
|
|
|
425
425
|
# **updateEventMediaItem**
|
|
426
426
|
> CreateEventMediaItem200Response updateEventMediaItem(eventMediaItemUpdateInputs)
|
|
427
427
|
|
|
428
|
-
|
|
428
|
+
Updates the fields (such as name, type, or file references) of an existing media item in an event\'s media gallery, and requires read and update permission on both events and storage.
|
|
429
429
|
|
|
430
430
|
### Example
|
|
431
431
|
|
|
@@ -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
|
-
|[**deleteEventMediaItemTranslation**](#deleteeventmediaitemtranslation) | **DELETE** /events/{eventId}/media/{mediaItemId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventMediaItemTranslation**](#geteventmediaitemtranslation) | **GET** /events/{eventId}/media/{mediaId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventMediaItemTranslations**](#geteventmediaitemtranslations) | **GET** /events/{eventId}/media/{mediaId}/translations |
|
|
10
|
-
|[**updateEventMediaItemTranslation**](#updateeventmediaitemtranslation) | **PUT** /events/{eventId}/media/{mediaItemId}/translations/{locale} |
|
|
7
|
+
|[**deleteEventMediaItemTranslation**](#deleteeventmediaitemtranslation) | **DELETE** /events/{eventId}/media/{mediaItemId}/translations/{locale} | Delete an event media item\'s translation|
|
|
8
|
+
|[**getEventMediaItemTranslation**](#geteventmediaitemtranslation) | **GET** /events/{eventId}/media/{mediaId}/translations/{locale} | Get a media item\'s translation for a locale|
|
|
9
|
+
|[**getEventMediaItemTranslations**](#geteventmediaitemtranslations) | **GET** /events/{eventId}/media/{mediaId}/translations | List a media item\'s translations|
|
|
10
|
+
|[**updateEventMediaItemTranslation**](#updateeventmediaitemtranslation) | **PUT** /events/{eventId}/media/{mediaItemId}/translations/{locale} | Create or update an event media item\'s translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventMediaItemTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventMediaItemTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the translated content for a single locale from an event media item, and requires read and update permission on both events and storage.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventMediaItemTranslation(
|
|
|
69
69
|
# **getEventMediaItemTranslation**
|
|
70
70
|
> GetEventMediaItemTranslation200Response getEventMediaItemTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Returns the translated fields for a specific event media item in the given locale, or null if no translation exists for that locale; requires read access to events and storage.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventMediaItemTranslation(
|
|
|
126
126
|
# **getEventMediaItemTranslations**
|
|
127
127
|
> GetEventMediaItemTranslations200Response getEventMediaItemTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of locale translations available for a specific event media item, with optional search and sort; requires read access to events and storage.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventMediaItemTranslations(
|
|
|
192
192
|
# **updateEventMediaItemTranslation**
|
|
193
193
|
> UpdateEventMediaItemTranslation200Response updateEventMediaItemTranslation(eventMediaItemTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Creates or updates the translated content (such as title, alt text, or description) for a single locale on an event media item, and requires read and update permission on both events and storage.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
package/docs/EventsOnSiteApi.md
CHANGED
|
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getEventOnSite**](#geteventonsite) | **GET** /events/{eventId}/on-site | Get
|
|
8
|
-
|[**updateEventBadgeTemplate**](#updateeventbadgetemplate) | **PUT** /events/{eventId}/template | Update
|
|
9
|
-
|[**updateEventCheckinCode**](#updateeventcheckincode) | **POST** /events/{eventId}/on-site |
|
|
7
|
+
|[**getEventOnSite**](#geteventonsite) | **GET** /events/{eventId}/on-site | Get an event\'s on-site check-in settings|
|
|
8
|
+
|[**updateEventBadgeTemplate**](#updateeventbadgetemplate) | **PUT** /events/{eventId}/template | Update an event\'s badge template|
|
|
9
|
+
|[**updateEventCheckinCode**](#updateeventcheckincode) | **POST** /events/{eventId}/on-site | Regenerate an event\'s check-in code|
|
|
10
10
|
|
|
11
11
|
# **getEventOnSite**
|
|
12
12
|
> GetEventOnSite200Response getEventOnSite()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Returns the on-site check-in configuration for the given event, including its authentication code, or null if on-site check-in has not been set up yet; requires read access to events.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -62,7 +62,7 @@ const { status, data } = await apiInstance.getEventOnSite(
|
|
|
62
62
|
# **updateEventBadgeTemplate**
|
|
63
63
|
> UpdateEventCheckinCode200Response updateEventBadgeTemplate(body)
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
Replaces the on-site check-in badge template design for the given event, used to render printed attendee badges; requires read and update permission on events.
|
|
66
66
|
|
|
67
67
|
### Example
|
|
68
68
|
|
|
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.updateEventBadgeTemplate(
|
|
|
116
116
|
# **updateEventCheckinCode**
|
|
117
117
|
> UpdateEventCheckinCode200Response updateEventCheckinCode()
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
Generates a new on-site check-in code for the given event, used for badge printing and attendee check-in kiosks; requires read and update permission on events.
|
|
120
120
|
|
|
121
121
|
### Example
|
|
122
122
|
|
|
@@ -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
|
-
|[**createEventPackage**](#createeventpackage) | **POST** /events/{eventId}/packages | Create
|
|
8
|
-
|[**deleteEventPackage**](#deleteeventpackage) | **DELETE** /events/{eventId}/packages/{packageId} | Delete
|
|
9
|
-
|[**getEventPackage**](#geteventpackage) | **GET** /events/{eventId}/packages/{packageId} | Get
|
|
10
|
-
|[**getEventPackages**](#geteventpackages) | **GET** /events/{eventId}/packages |
|
|
11
|
-
|[**updateEventPackage**](#updateeventpackage) | **PUT** /events/{eventId}/packages/{packageId} | Update
|
|
7
|
+
|[**createEventPackage**](#createeventpackage) | **POST** /events/{eventId}/packages | Create an event package|
|
|
8
|
+
|[**deleteEventPackage**](#deleteeventpackage) | **DELETE** /events/{eventId}/packages/{packageId} | Delete an event package|
|
|
9
|
+
|[**getEventPackage**](#geteventpackage) | **GET** /events/{eventId}/packages/{packageId} | Get a single event package|
|
|
10
|
+
|[**getEventPackages**](#geteventpackages) | **GET** /events/{eventId}/packages | List an event\'s packages|
|
|
11
|
+
|[**updateEventPackage**](#updateeventpackage) | **PUT** /events/{eventId}/packages/{packageId} | Update an event package|
|
|
12
12
|
|
|
13
13
|
# **createEventPackage**
|
|
14
14
|
> CreateEventPackage200Response createEventPackage()
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new package for the given event, bundling passes and other offerings that attendees can purchase together; requires read and update permission on events.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createEventPackage(
|
|
|
68
68
|
# **deleteEventPackage**
|
|
69
69
|
> CreateAccountInvitations200Response deleteEventPackage()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Permanently removes the specified package, along with its association to passes, from the given event; requires read and update permission on events.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.deleteEventPackage(
|
|
|
122
122
|
# **getEventPackage**
|
|
123
123
|
> CreateEventPackage200Response getEventPackage()
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Returns the details of a specific package belonging to the given event, identified by its package ID; requires read access to events.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.getEventPackage(
|
|
|
176
176
|
# **getEventPackages**
|
|
177
177
|
> GetEventPackages200Response getEventPackages()
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Returns a paginated list of packages belonging to the given event, with search and ordering support; requires read access to events.
|
|
180
180
|
|
|
181
181
|
### Example
|
|
182
182
|
|
|
@@ -239,7 +239,7 @@ const { status, data } = await apiInstance.getEventPackages(
|
|
|
239
239
|
# **updateEventPackage**
|
|
240
240
|
> CreateEventPackage200Response updateEventPackage()
|
|
241
241
|
|
|
242
|
-
|
|
242
|
+
Updates the details of an existing package for the given event, such as its name, description, or pricing; requires read and update permission on events.
|
|
243
243
|
|
|
244
244
|
### Example
|
|
245
245
|
|
|
@@ -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
|
-
|[**createEventPackagePass**](#createeventpackagepass) | **POST** /events/{eventId}/packages/{packageId}/passes | Create
|
|
8
|
-
|[**deleteEventPackagePass**](#deleteeventpackagepass) | **DELETE** /events/{eventId}/packages/{packageId}/passes/{passId} | Delete
|
|
9
|
-
|[**getEventPackagePass**](#geteventpackagepass) | **GET** /events/{eventId}/packages/{packageId}/passes/{passId} | Get
|
|
10
|
-
|[**getEventPackagePasses**](#geteventpackagepasses) | **GET** /events/{eventId}/packages/{packageId}/passes |
|
|
11
|
-
|[**updateEventPackagePass**](#updateeventpackagepass) | **PUT** /events/{eventId}/packages/{packageId}/passes/{passId} | Update
|
|
7
|
+
|[**createEventPackagePass**](#createeventpackagepass) | **POST** /events/{eventId}/packages/{packageId}/passes | Create a pass for an event package|
|
|
8
|
+
|[**deleteEventPackagePass**](#deleteeventpackagepass) | **DELETE** /events/{eventId}/packages/{packageId}/passes/{passId} | Delete a pass from an event package|
|
|
9
|
+
|[**getEventPackagePass**](#geteventpackagepass) | **GET** /events/{eventId}/packages/{packageId}/passes/{passId} | Get a single pass in an event package|
|
|
10
|
+
|[**getEventPackagePasses**](#geteventpackagepasses) | **GET** /events/{eventId}/packages/{packageId}/passes | List the passes included in an event package|
|
|
11
|
+
|[**updateEventPackagePass**](#updateeventpackagepass) | **PUT** /events/{eventId}/packages/{packageId}/passes/{passId} | Update a pass within an event package|
|
|
12
12
|
|
|
13
13
|
# **createEventPackagePass**
|
|
14
14
|
> CreateEventPackagePass200Response createEventPackagePass(eventPackagePassCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new pass tied to the given event package, defining a purchasable pass option within that package; requires read and update permission on events.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -71,7 +71,7 @@ const { status, data } = await apiInstance.createEventPackagePass(
|
|
|
71
71
|
# **deleteEventPackagePass**
|
|
72
72
|
> CreateAccountInvitations200Response deleteEventPackagePass()
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
Permanently removes the specified pass from the given event package; requires read and update permission on events.
|
|
75
75
|
|
|
76
76
|
### Example
|
|
77
77
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.deleteEventPackagePass(
|
|
|
128
128
|
# **getEventPackagePass**
|
|
129
129
|
> CreateEventPackagePass200Response getEventPackagePass()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Returns the details of a specific pass belonging to the given event package, identified by its pass ID; requires read access to events.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -185,7 +185,7 @@ const { status, data } = await apiInstance.getEventPackagePass(
|
|
|
185
185
|
# **getEventPackagePasses**
|
|
186
186
|
> GetEventPackagePasses200Response getEventPackagePasses()
|
|
187
187
|
|
|
188
|
-
|
|
188
|
+
Returns a paginated list of passes belonging to the given event package, with optional search; requires read access to events.
|
|
189
189
|
|
|
190
190
|
### Example
|
|
191
191
|
|
|
@@ -251,7 +251,7 @@ const { status, data } = await apiInstance.getEventPackagePasses(
|
|
|
251
251
|
# **updateEventPackagePass**
|
|
252
252
|
> CreateEventPackagePass200Response updateEventPackagePass()
|
|
253
253
|
|
|
254
|
-
|
|
254
|
+
Updates the details of an existing pass in the given event package, such as its name, pricing, or availability; requires read and 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
|
-
|[**deleteEventPackageTranslation**](#deleteeventpackagetranslation) | **DELETE** /events/{eventId}/packages/{packageId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventPackageTranslation**](#geteventpackagetranslation) | **GET** /events/{eventId}/packages/{packageId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventPackageTranslations**](#geteventpackagetranslations) | **GET** /events/{eventId}/packages/{packageId}/translations |
|
|
10
|
-
|[**updateEventPackageTranslation**](#updateeventpackagetranslation) | **PUT** /events/{eventId}/packages/{packageId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventPackageTranslation**](#deleteeventpackagetranslation) | **DELETE** /events/{eventId}/packages/{packageId}/translations/{locale} | Delete an event package translation|
|
|
8
|
+
|[**getEventPackageTranslation**](#geteventpackagetranslation) | **GET** /events/{eventId}/packages/{packageId}/translations/{locale} | Get an event package\'s translation for a locale|
|
|
9
|
+
|[**getEventPackageTranslations**](#geteventpackagetranslations) | **GET** /events/{eventId}/packages/{packageId}/translations | List an event package\'s translations|
|
|
10
|
+
|[**updateEventPackageTranslation**](#updateeventpackagetranslation) | **PUT** /events/{eventId}/packages/{packageId}/translations/{locale} | Update an event package translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventPackageTranslation**
|
|
13
13
|
> CreateAccountInvitations200Response deleteEventPackageTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the localized translation for the given event package in the specified locale; requires read and update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventPackageTranslation(
|
|
|
69
69
|
# **getEventPackageTranslation**
|
|
70
70
|
> GetEventPackageTranslation200Response getEventPackageTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Returns the localized text fields for the given event package in the specified locale; requires read access to events.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventPackageTranslation(
|
|
|
126
126
|
# **getEventPackageTranslations**
|
|
127
127
|
> GetEventPackageTranslations200Response getEventPackageTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of the locale translations available for the given event package, with search and ordering support; requires read access to events.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventPackageTranslations(
|
|
|
192
192
|
# **updateEventPackageTranslation**
|
|
193
193
|
> GetEventPackageTranslation200Response updateEventPackageTranslation(eventPackageTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Creates or updates the localized translation of an event package\'s content for the specified locale; requires read and update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
package/docs/EventsPagesApi.md
CHANGED
|
@@ -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
|
-
|[**addEventPageImage**](#addeventpageimage) | **POST** /events/{eventId}/pages/{pageId}/images/{imageId} | Add
|
|
8
|
-
|[**createEventPage**](#createeventpage) | **POST** /events/{eventId}/pages | Create
|
|
9
|
-
|[**deleteEventPage**](#deleteeventpage) | **DELETE** /events/{eventId}/pages/{pageId} | Delete
|
|
10
|
-
|[**getEventPage**](#geteventpage) | **GET** /events/{eventId}/pages/{pageId} | Get
|
|
11
|
-
|[**getEventPageImages**](#geteventpageimages) | **GET** /events/{eventId}/pages/{pageId}/images |
|
|
12
|
-
|[**getEventPages**](#geteventpages) | **GET** /events/{eventId}/pages |
|
|
13
|
-
|[**removeEventPageImage**](#removeeventpageimage) | **DELETE** /events/{eventId}/pages/{pageId}/images/{imageId} | Remove
|
|
14
|
-
|[**updateEventPage**](#updateeventpage) | **PUT** /events/{eventId}/pages/{pageId} | Update
|
|
7
|
+
|[**addEventPageImage**](#addeventpageimage) | **POST** /events/{eventId}/pages/{pageId}/images/{imageId} | Add an image to an event page|
|
|
8
|
+
|[**createEventPage**](#createeventpage) | **POST** /events/{eventId}/pages | Create an event page|
|
|
9
|
+
|[**deleteEventPage**](#deleteeventpage) | **DELETE** /events/{eventId}/pages/{pageId} | Delete an event page|
|
|
10
|
+
|[**getEventPage**](#geteventpage) | **GET** /events/{eventId}/pages/{pageId} | Get an event page|
|
|
11
|
+
|[**getEventPageImages**](#geteventpageimages) | **GET** /events/{eventId}/pages/{pageId}/images | List an event page\'s images|
|
|
12
|
+
|[**getEventPages**](#geteventpages) | **GET** /events/{eventId}/pages | List an event\'s pages|
|
|
13
|
+
|[**removeEventPageImage**](#removeeventpageimage) | **DELETE** /events/{eventId}/pages/{pageId}/images/{imageId} | Remove an image from an event page|
|
|
14
|
+
|[**updateEventPage**](#updateeventpage) | **PUT** /events/{eventId}/pages/{pageId} | Update an event page|
|
|
15
15
|
|
|
16
16
|
# **addEventPageImage**
|
|
17
17
|
> CreateEventPage200Response addEventPageImage()
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Attaches an existing image to an event page\'s image gallery, requiring update permission on both events and storage.
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -73,7 +73,7 @@ const { status, data } = await apiInstance.addEventPageImage(
|
|
|
73
73
|
# **createEventPage**
|
|
74
74
|
> CreateEventPage200Response createEventPage(eventPageCreateInputs)
|
|
75
75
|
|
|
76
|
-
|
|
76
|
+
Creates a new custom content page for an event, assigning it a slug and sort order, and requires create permission on events.
|
|
77
77
|
|
|
78
78
|
### Example
|
|
79
79
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.createEventPage(
|
|
|
128
128
|
# **deleteEventPage**
|
|
129
129
|
> CreateAccountInvitations200Response deleteEventPage()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Deletes a custom content page from an event and re-sequences the sort order of the event\'s remaining pages, requiring update permission on events.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -182,7 +182,7 @@ const { status, data } = await apiInstance.deleteEventPage(
|
|
|
182
182
|
# **getEventPage**
|
|
183
183
|
> CreateEventPage200Response getEventPage()
|
|
184
184
|
|
|
185
|
-
|
|
185
|
+
Retrieves the details of a single page belonging to the specified event by its page ID; requires the \"read\" permission on the \"events\" module.
|
|
186
186
|
|
|
187
187
|
### Example
|
|
188
188
|
|
|
@@ -236,7 +236,7 @@ const { status, data } = await apiInstance.getEventPage(
|
|
|
236
236
|
# **getEventPageImages**
|
|
237
237
|
> GetEventPageImages200Response getEventPageImages()
|
|
238
238
|
|
|
239
|
-
|
|
239
|
+
Returns a paginated list of images attached to the specified event page, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"storage\" modules.
|
|
240
240
|
|
|
241
241
|
### Example
|
|
242
242
|
|
|
@@ -302,7 +302,7 @@ const { status, data } = await apiInstance.getEventPageImages(
|
|
|
302
302
|
# **getEventPages**
|
|
303
303
|
> GetEventPages200Response getEventPages()
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
Returns a paginated list of custom pages belonging to the specified event, supporting search and sorting; requires the \"read\" permission on the \"events\" module.
|
|
306
306
|
|
|
307
307
|
### Example
|
|
308
308
|
|
|
@@ -365,7 +365,7 @@ const { status, data } = await apiInstance.getEventPages(
|
|
|
365
365
|
# **removeEventPageImage**
|
|
366
366
|
> CreateEventPage200Response removeEventPageImage()
|
|
367
367
|
|
|
368
|
-
|
|
368
|
+
Detaches an image from an event page\'s image gallery without deleting the underlying image, requiring update permission on both events and storage.
|
|
369
369
|
|
|
370
370
|
### Example
|
|
371
371
|
|
|
@@ -422,7 +422,7 @@ const { status, data } = await apiInstance.removeEventPageImage(
|
|
|
422
422
|
# **updateEventPage**
|
|
423
423
|
> CreateEventPage200Response updateEventPage()
|
|
424
424
|
|
|
425
|
-
|
|
425
|
+
Updates the content, title, or sort order of an existing custom event page, re-sequencing other pages when the sort order changes, and requires update permission on events.
|
|
426
426
|
|
|
427
427
|
### Example
|
|
428
428
|
|