@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
package/docs/EventsPassesApi.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
|
-
|[**approveEventPass**](#approveeventpass) | **PUT** /events/{eventId}/passes/{passId}/approve | Approve
|
|
8
|
-
|[**cancelEventPass**](#canceleventpass) | **PUT** /events/{eventId}/passes/{passId}/cancel | Cancel
|
|
9
|
-
|[**checkinEventPass**](#checkineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin |
|
|
10
|
-
|[**createEventPass**](#createeventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes | Create
|
|
11
|
-
|[**deleteEventPass**](#deleteeventpass) | **DELETE** /events/{eventId}/passes/{passId} | Delete
|
|
12
|
-
|[**denyEventPass**](#denyeventpass) | **PUT** /events/{eventId}/passes/{passId}/deny | Deny
|
|
13
|
-
|[**getEventPass**](#geteventpass) | **GET** /events/{eventId}/passes/{passId} | Get
|
|
14
|
-
|[**getEventPassMatches**](#geteventpassmatches) | **GET** /events/{eventId}/passes/{passId}/matches |
|
|
15
|
-
|[**getEventPassPayments**](#geteventpasspayments) | **GET** /events/{eventId}/passes/{passId}/payments |
|
|
16
|
-
|[**getEventPassTransferLogs**](#geteventpasstransferlogs) | **GET** /events/{eventId}/passes/{passId}/transfers/logs |
|
|
17
|
-
|[**getEventPasses**](#geteventpasses) | **GET** /events/{eventId}/passes |
|
|
18
|
-
|[**getEventPendingPasses**](#geteventpendingpasses) | **GET** /events/{eventId}/passes/pending |
|
|
19
|
-
|[**indexEventPasses**](#indexeventpasses) | **POST** /events/{eventId}/index-passes |
|
|
20
|
-
|[**transferEventPass**](#transfereventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes/{passId}/transfers | Transfer
|
|
21
|
-
|[**undoCheckinEventPass**](#undocheckineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin/undo | Undo
|
|
22
|
-
|[**updateEventPass**](#updateeventpass) | **PUT** /events/{eventId}/passes/{passId} | Update
|
|
23
|
-
|[**updateEventPassesReady**](#updateeventpassesready) | **POST** /events/{eventId}/passes/ready |
|
|
7
|
+
|[**approveEventPass**](#approveeventpass) | **PUT** /events/{eventId}/passes/{passId}/approve | Approve a pending event pass|
|
|
8
|
+
|[**cancelEventPass**](#canceleventpass) | **PUT** /events/{eventId}/passes/{passId}/cancel | Cancel an event pass|
|
|
9
|
+
|[**checkinEventPass**](#checkineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin | Check in an event pass|
|
|
10
|
+
|[**createEventPass**](#createeventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes | Create a pass for an event attendee|
|
|
11
|
+
|[**deleteEventPass**](#deleteeventpass) | **DELETE** /events/{eventId}/passes/{passId} | Delete an event pass|
|
|
12
|
+
|[**denyEventPass**](#denyeventpass) | **PUT** /events/{eventId}/passes/{passId}/deny | Deny a pending event pass|
|
|
13
|
+
|[**getEventPass**](#geteventpass) | **GET** /events/{eventId}/passes/{passId} | Get a single event pass|
|
|
14
|
+
|[**getEventPassMatches**](#geteventpassmatches) | **GET** /events/{eventId}/passes/{passId}/matches | List an event pass\'s networking matches|
|
|
15
|
+
|[**getEventPassPayments**](#geteventpasspayments) | **GET** /events/{eventId}/passes/{passId}/payments | List an event pass\'s payments|
|
|
16
|
+
|[**getEventPassTransferLogs**](#geteventpasstransferlogs) | **GET** /events/{eventId}/passes/{passId}/transfers/logs | List an event pass\'s transfer logs|
|
|
17
|
+
|[**getEventPasses**](#geteventpasses) | **GET** /events/{eventId}/passes | List an event\'s passes|
|
|
18
|
+
|[**getEventPendingPasses**](#geteventpendingpasses) | **GET** /events/{eventId}/passes/pending | List an event\'s pending passes|
|
|
19
|
+
|[**indexEventPasses**](#indexeventpasses) | **POST** /events/{eventId}/index-passes | Reindex an event\'s passes for search|
|
|
20
|
+
|[**transferEventPass**](#transfereventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes/{passId}/transfers | Transfer an event pass to another account|
|
|
21
|
+
|[**undoCheckinEventPass**](#undocheckineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin/undo | Undo an event pass check-in|
|
|
22
|
+
|[**updateEventPass**](#updateeventpass) | **PUT** /events/{eventId}/passes/{passId} | Update an event pass|
|
|
23
|
+
|[**updateEventPassesReady**](#updateeventpassesready) | **POST** /events/{eventId}/passes/ready | Mark all needs-info passes as ready|
|
|
24
24
|
|
|
25
25
|
# **approveEventPass**
|
|
26
26
|
> CreateEventPass200Response approveEventPass()
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Moves a pending event pass to the ready status so the attendee\'s registration is confirmed, optionally sending the approval email, requires read permission on events and read/update permission on attendees.
|
|
29
29
|
|
|
30
30
|
### Example
|
|
31
31
|
|
|
@@ -82,7 +82,7 @@ const { status, data } = await apiInstance.approveEventPass(
|
|
|
82
82
|
# **cancelEventPass**
|
|
83
83
|
> CreateEventPass200Response cancelEventPass()
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
Cancels an approved or active event pass/registration, requires the update permission on attendees, blocks the cancellation if the pass has active session accesses, and optionally sends a cancellation email to the attendee.
|
|
86
86
|
|
|
87
87
|
### Example
|
|
88
88
|
|
|
@@ -139,7 +139,7 @@ const { status, data } = await apiInstance.cancelEventPass(
|
|
|
139
139
|
# **checkinEventPass**
|
|
140
140
|
> CreateEventPass200Response checkinEventPass()
|
|
141
141
|
|
|
142
|
-
|
|
142
|
+
Marks the given event pass as checked in, resolving an alternate pass ID to its underlying record first, and requires read permission on events and attendees.
|
|
143
143
|
|
|
144
144
|
### Example
|
|
145
145
|
|
|
@@ -193,7 +193,7 @@ const { status, data } = await apiInstance.checkinEventPass(
|
|
|
193
193
|
# **createEventPass**
|
|
194
194
|
> CreateEventPass200Response createEventPass(eventPassCreateInputs)
|
|
195
195
|
|
|
196
|
-
|
|
196
|
+
Creates a new pass/registration purchase for the specified attendee on the given event using the provided pass details, and requires update permission on attendees.
|
|
197
197
|
|
|
198
198
|
### Example
|
|
199
199
|
|
|
@@ -251,7 +251,7 @@ const { status, data } = await apiInstance.createEventPass(
|
|
|
251
251
|
# **deleteEventPass**
|
|
252
252
|
> CreateAccountInvitations200Response deleteEventPass()
|
|
253
253
|
|
|
254
|
-
|
|
254
|
+
Permanently deletes an event pass/registration purchase, first removing any pending transfer linked to it, and requires the delete permission on attendees.
|
|
255
255
|
|
|
256
256
|
### Example
|
|
257
257
|
|
|
@@ -308,7 +308,7 @@ const { status, data } = await apiInstance.deleteEventPass(
|
|
|
308
308
|
# **denyEventPass**
|
|
309
309
|
> CreateEventPass200Response denyEventPass()
|
|
310
310
|
|
|
311
|
-
|
|
311
|
+
Denies a pass/registration that is in pending status by canceling it, optionally issuing a refund for its payment and sending a denial email, and requires update permission on attendees.
|
|
312
312
|
|
|
313
313
|
### Example
|
|
314
314
|
|
|
@@ -368,7 +368,7 @@ const { status, data } = await apiInstance.denyEventPass(
|
|
|
368
368
|
# **getEventPass**
|
|
369
369
|
> CreateEventPass200Response getEventPass()
|
|
370
370
|
|
|
371
|
-
|
|
371
|
+
Returns a single event pass (registration purchase) by ID for the given event, including its attendee and ticket details, and requires the read events and read attendees permissions.
|
|
372
372
|
|
|
373
373
|
### Example
|
|
374
374
|
|
|
@@ -422,7 +422,7 @@ const { status, data } = await apiInstance.getEventPass(
|
|
|
422
422
|
# **getEventPassMatches**
|
|
423
423
|
> GetEventPassMatches200Response getEventPassMatches()
|
|
424
424
|
|
|
425
|
-
|
|
425
|
+
Returns the networking or session matches associated with a specific event pass, optionally filtered by sessionId and roundId, and requires the read events and read attendees permissions.
|
|
426
426
|
|
|
427
427
|
### Example
|
|
428
428
|
|
|
@@ -482,7 +482,7 @@ const { status, data } = await apiInstance.getEventPassMatches(
|
|
|
482
482
|
# **getEventPassPayments**
|
|
483
483
|
> GetAccountPayments200Response getEventPassPayments()
|
|
484
484
|
|
|
485
|
-
|
|
485
|
+
Returns a paginated list of payments made for a specific event pass, and requires the read events, read attendees, and read payments permissions.
|
|
486
486
|
|
|
487
487
|
### Example
|
|
488
488
|
|
|
@@ -548,7 +548,7 @@ const { status, data } = await apiInstance.getEventPassPayments(
|
|
|
548
548
|
# **getEventPassTransferLogs**
|
|
549
549
|
> GetEventAttendeeTransfersLogs200Response getEventPassTransferLogs()
|
|
550
550
|
|
|
551
|
-
|
|
551
|
+
Returns a paginated history of ownership transfers for a specific event pass, and requires the read events and read attendees permissions.
|
|
552
552
|
|
|
553
553
|
### Example
|
|
554
554
|
|
|
@@ -614,7 +614,7 @@ const { status, data } = await apiInstance.getEventPassTransferLogs(
|
|
|
614
614
|
# **getEventPasses**
|
|
615
615
|
> GetEventAddOnPasses200Response getEventPasses()
|
|
616
616
|
|
|
617
|
-
|
|
617
|
+
Returns a paginated list of active (ready or needing info) passes purchased for the given event, optionally filtered by check-in status via the checkedIn parameter, and requires the read events and read attendees permissions.
|
|
618
618
|
|
|
619
619
|
### Example
|
|
620
620
|
|
|
@@ -680,7 +680,7 @@ const { status, data } = await apiInstance.getEventPasses(
|
|
|
680
680
|
# **getEventPendingPasses**
|
|
681
681
|
> GetEventAddOnPasses200Response getEventPendingPasses()
|
|
682
682
|
|
|
683
|
-
|
|
683
|
+
Returns a paginated list of passes for the given event that are still in pending status (payment or registration not yet completed), and requires the read events and read attendees permissions.
|
|
684
684
|
|
|
685
685
|
### Example
|
|
686
686
|
|
|
@@ -743,7 +743,7 @@ const { status, data } = await apiInstance.getEventPendingPasses(
|
|
|
743
743
|
# **indexEventPasses**
|
|
744
744
|
> IndexEventPasses200Response indexEventPasses()
|
|
745
745
|
|
|
746
|
-
|
|
746
|
+
Clears the cached search index for every pass belonging to the given event so it gets rebuilt, and requires update permission on events.
|
|
747
747
|
|
|
748
748
|
### Example
|
|
749
749
|
|
|
@@ -794,7 +794,7 @@ const { status, data } = await apiInstance.indexEventPasses(
|
|
|
794
794
|
# **transferEventPass**
|
|
795
795
|
> CreateAccountInvitations200Response transferEventPass()
|
|
796
796
|
|
|
797
|
-
|
|
797
|
+
Transfers ownership of an attendee\'s event pass to another specified account, and requires update permission on attendees.
|
|
798
798
|
|
|
799
799
|
### Example
|
|
800
800
|
|
|
@@ -854,7 +854,7 @@ const { status, data } = await apiInstance.transferEventPass(
|
|
|
854
854
|
# **undoCheckinEventPass**
|
|
855
855
|
> CreateEventPass200Response undoCheckinEventPass()
|
|
856
856
|
|
|
857
|
-
|
|
857
|
+
Reverses a previous check-in on the given event pass, marking it as not checked in, and requires read permission on events and attendees.
|
|
858
858
|
|
|
859
859
|
### Example
|
|
860
860
|
|
|
@@ -908,7 +908,7 @@ const { status, data } = await apiInstance.undoCheckinEventPass(
|
|
|
908
908
|
# **updateEventPass**
|
|
909
909
|
> CreateEventPass200Response updateEventPass(eventPassUpdateInputs)
|
|
910
910
|
|
|
911
|
-
|
|
911
|
+
Updates fields on an existing event pass/registration purchase, such as its ticket, coupon, or status, and requires update permission on attendees.
|
|
912
912
|
|
|
913
913
|
### Example
|
|
914
914
|
|
|
@@ -966,7 +966,7 @@ const { status, data } = await apiInstance.updateEventPass(
|
|
|
966
966
|
# **updateEventPassesReady**
|
|
967
967
|
> CreateAccountInvitations200Response updateEventPassesReady()
|
|
968
968
|
|
|
969
|
-
|
|
969
|
+
Bulk-updates every pass on the given event that currently has \"needs info\" status to \"ready\" status, and requires update permission on attendees.
|
|
970
970
|
|
|
971
971
|
### Example
|
|
972
972
|
|
|
@@ -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
|
-
|[**getEventPassAttributes**](#geteventpassattributes) | **GET** /events/{eventId}/passes/{passId}/attributes |
|
|
8
|
-
|[**removeEventPassAttribute**](#removeeventpassattribute) | **DELETE** /events/{eventId}/passes/{passId}/attributes/{attributeId} | Remove
|
|
9
|
-
|[**updateEventPassAttributes**](#updateeventpassattributes) | **PUT** /events/{eventId}/passes/{passId}/attributes |
|
|
7
|
+
|[**getEventPassAttributes**](#geteventpassattributes) | **GET** /events/{eventId}/passes/{passId}/attributes | List an event pass\'s attributes|
|
|
8
|
+
|[**removeEventPassAttribute**](#removeeventpassattribute) | **DELETE** /events/{eventId}/passes/{passId}/attributes/{attributeId} | Remove a custom attribute from a pass|
|
|
9
|
+
|[**updateEventPassAttributes**](#updateeventpassattributes) | **PUT** /events/{eventId}/passes/{passId}/attributes | Set custom attribute values on a pass|
|
|
10
10
|
|
|
11
11
|
# **getEventPassAttributes**
|
|
12
12
|
> GetEventPassAttributes200Response getEventPassAttributes()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Returns the list of custom attributes assigned to the specified event pass, supporting sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -77,7 +77,7 @@ const { status, data } = await apiInstance.getEventPassAttributes(
|
|
|
77
77
|
# **removeEventPassAttribute**
|
|
78
78
|
> RemoveEventPassAttribute200Response removeEventPassAttribute()
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
81
81
|
|
|
82
82
|
### Example
|
|
83
83
|
|
|
@@ -134,7 +134,7 @@ const { status, data } = await apiInstance.removeEventPassAttribute(
|
|
|
134
134
|
# **updateEventPassAttributes**
|
|
135
135
|
> UpdateEventPassAttributes200Response updateEventPassAttributes(passAttributesUpdateInputs)
|
|
136
136
|
|
|
137
|
-
|
|
137
|
+
Creates or updates one or more custom attribute values (attributeId/value pairs) on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
138
138
|
|
|
139
139
|
### Example
|
|
140
140
|
|
|
@@ -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
|
-
|[**getEventPassQuestionFollowups**](#geteventpassquestionfollowups) | **GET** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups |
|
|
8
|
-
|[**getEventPassQuestionSections**](#geteventpassquestionsections) | **GET** /events/{eventId}/attendees/{accountId}/passes/{passId}/sections |
|
|
9
|
-
|[**updateEventPassFollowupResponses**](#updateeventpassfollowupresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups | Update
|
|
10
|
-
|[**updateEventPassSingleFollowupResponses**](#updateeventpasssinglefollowupresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups/{followupId} | Update
|
|
7
|
+
|[**getEventPassQuestionFollowups**](#geteventpassquestionfollowups) | **GET** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups | List an attendee pass\'s followup questions|
|
|
8
|
+
|[**getEventPassQuestionSections**](#geteventpassquestionsections) | **GET** /events/{eventId}/attendees/{accountId}/passes/{passId}/sections | List an attendee pass\'s registration sections|
|
|
9
|
+
|[**updateEventPassFollowupResponses**](#updateeventpassfollowupresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups | Update all followup question responses for a pass|
|
|
10
|
+
|[**updateEventPassSingleFollowupResponses**](#updateeventpasssinglefollowupresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups/{followupId} | Update responses for one followup on a pass|
|
|
11
11
|
|
|
12
12
|
# **getEventPassQuestionFollowups**
|
|
13
13
|
> GetEventPassQuestionFollowups200Response getEventPassQuestionFollowups()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Returns the followup question forms and their questions/choices applicable to the specified attendee\'s event pass, based on the event\'s configured followups; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -81,7 +81,7 @@ const { status, data } = await apiInstance.getEventPassQuestionFollowups(
|
|
|
81
81
|
# **getEventPassQuestionSections**
|
|
82
82
|
> GetEventPassQuestionSections200Response getEventPassQuestionSections()
|
|
83
83
|
|
|
84
|
-
|
|
84
|
+
Returns the registration question sections and their questions/choices applicable to the specified attendee\'s event pass, based on the event\'s configured registration sections; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
85
85
|
|
|
86
86
|
### Example
|
|
87
87
|
|
|
@@ -150,7 +150,7 @@ const { status, data } = await apiInstance.getEventPassQuestionSections(
|
|
|
150
150
|
# **updateEventPassFollowupResponses**
|
|
151
151
|
> CreateAccountInvitations200Response updateEventPassFollowupResponses()
|
|
152
152
|
|
|
153
|
-
|
|
153
|
+
Bulk-updates the responses to an attendee\'s pending followup questions for the given event pass, requires read permission on events and read/update permission on attendees.
|
|
154
154
|
|
|
155
155
|
### Example
|
|
156
156
|
|
|
@@ -210,7 +210,7 @@ const { status, data } = await apiInstance.updateEventPassFollowupResponses(
|
|
|
210
210
|
# **updateEventPassSingleFollowupResponses**
|
|
211
211
|
> CreateAccountInvitations200Response updateEventPassSingleFollowupResponses()
|
|
212
212
|
|
|
213
|
-
|
|
213
|
+
Updates an attendee\'s question responses for a single specified followup on the given event pass, requires read permission on events and read/update permission on attendees.
|
|
214
214
|
|
|
215
215
|
### Example
|
|
216
216
|
|
|
@@ -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
|
-
|[**getEventPassResponse**](#geteventpassresponse) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId} | Get
|
|
8
|
-
|[**getEventPassResponseChanges**](#geteventpassresponsechanges) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId}/changes |
|
|
9
|
-
|[**getEventPassResponses**](#geteventpassresponses) | **GET** /events/{eventId}/passes/{passId}/responses |
|
|
10
|
-
|[**updateEventPassResponse**](#updateeventpassresponse) | **PUT** /events/{eventId}/passes/{passId}/responses/{questionId} | Update
|
|
11
|
-
|[**updateEventPassResponses**](#updateeventpassresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/responses | Update
|
|
7
|
+
|[**getEventPassResponse**](#geteventpassresponse) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId} | Get an event pass\'s response to a question|
|
|
8
|
+
|[**getEventPassResponseChanges**](#geteventpassresponsechanges) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId}/changes | List a pass response\'s edit history|
|
|
9
|
+
|[**getEventPassResponses**](#geteventpassresponses) | **GET** /events/{eventId}/passes/{passId}/responses | List a pass\'s registration question responses|
|
|
10
|
+
|[**updateEventPassResponse**](#updateeventpassresponse) | **PUT** /events/{eventId}/passes/{passId}/responses/{questionId} | Update a single registration question response|
|
|
11
|
+
|[**updateEventPassResponses**](#updateeventpassresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/responses | Update all registration question responses for a pass|
|
|
12
12
|
|
|
13
13
|
# **getEventPassResponse**
|
|
14
14
|
> GetEventPassResponse200Response getEventPassResponse()
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Retrieves a single registration question response recorded for the specified event pass, identified by question ID; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -70,7 +70,7 @@ const { status, data } = await apiInstance.getEventPassResponse(
|
|
|
70
70
|
# **getEventPassResponseChanges**
|
|
71
71
|
> GetEventPassResponseChanges200Response getEventPassResponseChanges()
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
Returns a paginated list of edits made to a single registration question response on an event pass, including the old and new values for each change, and requires the read events and read attendees permissions.
|
|
74
74
|
|
|
75
75
|
### Example
|
|
76
76
|
|
|
@@ -139,7 +139,7 @@ const { status, data } = await apiInstance.getEventPassResponseChanges(
|
|
|
139
139
|
# **getEventPassResponses**
|
|
140
140
|
> GetEventPassResponses200Response getEventPassResponses()
|
|
141
141
|
|
|
142
|
-
|
|
142
|
+
Returns a paginated list of registration question responses submitted for a specific event pass, supports search by response value, and requires the read events and read attendees permissions.
|
|
143
143
|
|
|
144
144
|
### Example
|
|
145
145
|
|
|
@@ -205,7 +205,7 @@ const { status, data } = await apiInstance.getEventPassResponses(
|
|
|
205
205
|
# **updateEventPassResponse**
|
|
206
206
|
> GetEventPassResponse200Response updateEventPassResponse(updateEventPassResponseInputs)
|
|
207
207
|
|
|
208
|
-
|
|
208
|
+
Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
209
209
|
|
|
210
210
|
### Example
|
|
211
211
|
|
|
@@ -266,7 +266,7 @@ const { status, data } = await apiInstance.updateEventPassResponse(
|
|
|
266
266
|
# **updateEventPassResponses**
|
|
267
267
|
> CreateAccountInvitations200Response updateEventPassResponses(updateEventPassResponsesInputs)
|
|
268
268
|
|
|
269
|
-
|
|
269
|
+
Bulk-updates an attendee\'s registration question responses for the given event pass, requires read permission on events and read/update permission on attendees.
|
|
270
270
|
|
|
271
271
|
### Example
|
|
272
272
|
|
|
@@ -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
|
-
|[**addEventPassTypeAddOn**](#addeventpasstypeaddon) | **POST** /events/{eventId}/passTypes/{passTypeId}/addOns/{addOnId} | Add
|
|
8
|
-
|[**addEventPassTypeGroupPassTier**](#addeventpasstypegrouppasstier) | **POST** /events/{eventId}/passTypes/{passTypeId}/groupPassTiers/{tierId} |
|
|
9
|
-
|[**addEventPassTypeTier**](#addeventpasstypetier) | **POST** /events/{eventId}/passTypes/{passTypeId}/tiers/{tierId} | Add
|
|
10
|
-
|[**createEventPassType**](#createeventpasstype) | **POST** /events/{eventId}/passTypes | Create
|
|
11
|
-
|[**deleteEventPassType**](#deleteeventpasstype) | **DELETE** /events/{eventId}/passTypes/{passTypeId} | Delete
|
|
12
|
-
|[**eventGetPassTypeCoupons**](#eventgetpasstypecoupons) | **GET** /events/{eventId}/passTypes/{passTypeId}/coupons |
|
|
13
|
-
|[**getEventPassType**](#geteventpasstype) | **GET** /events/{eventId}/passTypes/{passTypeId} | Get
|
|
14
|
-
|[**getEventPassTypeAddOns**](#geteventpasstypeaddons) | **GET** /events/{eventId}/passTypes/{passTypeId}/addOns |
|
|
15
|
-
|[**getEventPassTypeGroupPassTiers**](#geteventpasstypegrouppasstiers) | **GET** /events/{eventId}/passTypes/{passTypeId}/groupPassTiers |
|
|
16
|
-
|[**getEventPassTypePasses**](#geteventpasstypepasses) | **GET** /events/{eventId}/passTypes/{passTypeId}/passes |
|
|
17
|
-
|[**getEventPassTypePayments**](#geteventpasstypepayments) | **GET** /events/{eventId}/passTypes/{passTypeId}/payments |
|
|
18
|
-
|[**getEventPassTypeTiers**](#geteventpasstypetiers) | **GET** /events/{eventId}/passTypes/{passTypeId}/tiers |
|
|
19
|
-
|[**getEventPassTypes**](#geteventpasstypes) | **GET** /events/{eventId}/passTypes |
|
|
20
|
-
|[**removeEventPassTypeAddOn**](#removeeventpasstypeaddon) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/addOns/{addOnId} | Remove
|
|
21
|
-
|[**removeEventPassTypeGroupPassTier**](#removeeventpasstypegrouppasstier) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/groupPassTiers/{tierId} | Remove
|
|
22
|
-
|[**removeEventPassTypeTier**](#removeeventpasstypetier) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/tiers/{tierId} | Remove
|
|
23
|
-
|[**updateEventPassType**](#updateeventpasstype) | **PUT** /events/{eventId}/passTypes/{passTypeId} | Update
|
|
7
|
+
|[**addEventPassTypeAddOn**](#addeventpasstypeaddon) | **POST** /events/{eventId}/passTypes/{passTypeId}/addOns/{addOnId} | Add an add-on to a pass type|
|
|
8
|
+
|[**addEventPassTypeGroupPassTier**](#addeventpasstypegrouppasstier) | **POST** /events/{eventId}/passTypes/{passTypeId}/groupPassTiers/{tierId} | Allow a tier to purchase a group pass type|
|
|
9
|
+
|[**addEventPassTypeTier**](#addeventpasstypetier) | **POST** /events/{eventId}/passTypes/{passTypeId}/tiers/{tierId} | Add an account tier to a pass type\'s tier list|
|
|
10
|
+
|[**createEventPassType**](#createeventpasstype) | **POST** /events/{eventId}/passTypes | Create an event pass type|
|
|
11
|
+
|[**deleteEventPassType**](#deleteeventpasstype) | **DELETE** /events/{eventId}/passTypes/{passTypeId} | Delete an event pass type|
|
|
12
|
+
|[**eventGetPassTypeCoupons**](#eventgetpasstypecoupons) | **GET** /events/{eventId}/passTypes/{passTypeId}/coupons | List an event pass type\'s coupons|
|
|
13
|
+
|[**getEventPassType**](#geteventpasstype) | **GET** /events/{eventId}/passTypes/{passTypeId} | Get a single event pass type|
|
|
14
|
+
|[**getEventPassTypeAddOns**](#geteventpasstypeaddons) | **GET** /events/{eventId}/passTypes/{passTypeId}/addOns | List an event pass type\'s add-ons|
|
|
15
|
+
|[**getEventPassTypeGroupPassTiers**](#geteventpasstypegrouppasstiers) | **GET** /events/{eventId}/passTypes/{passTypeId}/groupPassTiers | List an event pass type\'s group pass tiers|
|
|
16
|
+
|[**getEventPassTypePasses**](#geteventpasstypepasses) | **GET** /events/{eventId}/passTypes/{passTypeId}/passes | List passes purchased for an event pass type|
|
|
17
|
+
|[**getEventPassTypePayments**](#geteventpasstypepayments) | **GET** /events/{eventId}/passTypes/{passTypeId}/payments | List payments for a pass type|
|
|
18
|
+
|[**getEventPassTypeTiers**](#geteventpasstypetiers) | **GET** /events/{eventId}/passTypes/{passTypeId}/tiers | List account tiers allowed/disallowed for a pass type|
|
|
19
|
+
|[**getEventPassTypes**](#geteventpasstypes) | **GET** /events/{eventId}/passTypes | List an event\'s pass types|
|
|
20
|
+
|[**removeEventPassTypeAddOn**](#removeeventpasstypeaddon) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/addOns/{addOnId} | Remove an add-on from a pass type|
|
|
21
|
+
|[**removeEventPassTypeGroupPassTier**](#removeeventpasstypegrouppasstier) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/groupPassTiers/{tierId} | Remove an account tier from a pass type\'s group tiers|
|
|
22
|
+
|[**removeEventPassTypeTier**](#removeeventpasstypetier) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/tiers/{tierId} | Remove an account tier from a pass type\'s tier list|
|
|
23
|
+
|[**updateEventPassType**](#updateeventpasstype) | **PUT** /events/{eventId}/passTypes/{passTypeId} | Update an event pass type|
|
|
24
24
|
|
|
25
25
|
# **addEventPassTypeAddOn**
|
|
26
26
|
> CreateEventPassType200Response addEventPassTypeAddOn()
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Associates an existing event add-on with a pass type so it can be purchased alongside that pass; requires update permission on events.
|
|
29
29
|
|
|
30
30
|
### Example
|
|
31
31
|
|
|
@@ -82,7 +82,7 @@ const { status, data } = await apiInstance.addEventPassTypeAddOn(
|
|
|
82
82
|
# **addEventPassTypeGroupPassTier**
|
|
83
83
|
> CreateEventPassType200Response addEventPassTypeGroupPassTier()
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
Adds an account tier to the list of tiers allowed to purchase a pass type as a group pass, rejecting the request if the tier has already been added; requires update permission on events and read permission on tiers.
|
|
86
86
|
|
|
87
87
|
### Example
|
|
88
88
|
|
|
@@ -139,7 +139,7 @@ const { status, data } = await apiInstance.addEventPassTypeGroupPassTier(
|
|
|
139
139
|
# **addEventPassTypeTier**
|
|
140
140
|
> CreateEventPassType200Response addEventPassTypeTier()
|
|
141
141
|
|
|
142
|
-
|
|
142
|
+
Adds an account tier to either the allowed or disallowed tier list of an event pass type depending on the `allowed` flag, restricting or permitting which account tiers may purchase that pass type; requires update permission on events.
|
|
143
143
|
|
|
144
144
|
### Example
|
|
145
145
|
|
|
@@ -199,7 +199,7 @@ const { status, data } = await apiInstance.addEventPassTypeTier(
|
|
|
199
199
|
# **createEventPassType**
|
|
200
200
|
> CreateEventPassType200Response createEventPassType(passTypeCreateInputs)
|
|
201
201
|
|
|
202
|
-
|
|
202
|
+
Creates a new pass type (ticket type) for the given event using the provided details, such as name, pricing, and availability; requires update permission on events.
|
|
203
203
|
|
|
204
204
|
### Example
|
|
205
205
|
|
|
@@ -254,7 +254,7 @@ const { status, data } = await apiInstance.createEventPassType(
|
|
|
254
254
|
# **deleteEventPassType**
|
|
255
255
|
> CreateAccountInvitations200Response deleteEventPassType()
|
|
256
256
|
|
|
257
|
-
|
|
257
|
+
Permanently deletes a pass type from the given event; requires update permission on events.
|
|
258
258
|
|
|
259
259
|
### Example
|
|
260
260
|
|
|
@@ -308,7 +308,7 @@ const { status, data } = await apiInstance.deleteEventPassType(
|
|
|
308
308
|
# **eventGetPassTypeCoupons**
|
|
309
309
|
> GetEventAttendeeCoupons200Response eventGetPassTypeCoupons()
|
|
310
310
|
|
|
311
|
-
|
|
311
|
+
Returns a paginated list of coupons that apply to an event pass type, with optional search and orderBy filters; requires read access to the event.
|
|
312
312
|
|
|
313
313
|
### Example
|
|
314
314
|
|
|
@@ -374,7 +374,7 @@ const { status, data } = await apiInstance.eventGetPassTypeCoupons(
|
|
|
374
374
|
# **getEventPassType**
|
|
375
375
|
> CreateEventPassType200Response getEventPassType()
|
|
376
376
|
|
|
377
|
-
|
|
377
|
+
Retrieves the full details of a single pass type belonging to an event, identified by its ID; requires read access to the event.
|
|
378
378
|
|
|
379
379
|
### Example
|
|
380
380
|
|
|
@@ -428,7 +428,7 @@ const { status, data } = await apiInstance.getEventPassType(
|
|
|
428
428
|
# **getEventPassTypeAddOns**
|
|
429
429
|
> GetEventAddOns200Response getEventPassTypeAddOns()
|
|
430
430
|
|
|
431
|
-
|
|
431
|
+
Returns a paginated list of add-ons linked to an event pass type, with optional search and orderBy filters; requires read access to the event.
|
|
432
432
|
|
|
433
433
|
### Example
|
|
434
434
|
|
|
@@ -494,7 +494,7 @@ const { status, data } = await apiInstance.getEventPassTypeAddOns(
|
|
|
494
494
|
# **getEventPassTypeGroupPassTiers**
|
|
495
495
|
> GetAccountTiers200Response getEventPassTypeGroupPassTiers()
|
|
496
496
|
|
|
497
|
-
|
|
497
|
+
Returns a paginated list of the registration tiers allowed to purchase an event pass type as part of a group pass, with optional search and orderBy filters; requires read access to the event and to tiers.
|
|
498
498
|
|
|
499
499
|
### Example
|
|
500
500
|
|
|
@@ -560,7 +560,7 @@ const { status, data } = await apiInstance.getEventPassTypeGroupPassTiers(
|
|
|
560
560
|
# **getEventPassTypePasses**
|
|
561
561
|
> GetEventAddOnPasses200Response getEventPassTypePasses()
|
|
562
562
|
|
|
563
|
-
|
|
563
|
+
Returns a paginated list of purchased passes for a given event pass type, optionally filtered to only checked-in or not-checked-in passes, with search and orderBy support; requires read access to the event and to attendees.
|
|
564
564
|
|
|
565
565
|
### Example
|
|
566
566
|
|
|
@@ -629,7 +629,7 @@ const { status, data } = await apiInstance.getEventPassTypePasses(
|
|
|
629
629
|
# **getEventPassTypePayments**
|
|
630
630
|
> GetAccountPayments200Response getEventPassTypePayments()
|
|
631
631
|
|
|
632
|
-
|
|
632
|
+
Returns a paginated list of payments made for a specific pass type on an event, supporting search and ordering; requires read permission on events and payments.
|
|
633
633
|
|
|
634
634
|
### Example
|
|
635
635
|
|
|
@@ -695,7 +695,7 @@ const { status, data } = await apiInstance.getEventPassTypePayments(
|
|
|
695
695
|
# **getEventPassTypeTiers**
|
|
696
696
|
> GetAccountTiers200Response getEventPassTypeTiers()
|
|
697
697
|
|
|
698
|
-
|
|
698
|
+
Returns a paginated list of account tiers associated with a pass type, filtered by the `allowed` flag to either the tiers permitted to purchase the pass type or those explicitly disallowed, with optional search; requires read permission on events and tiers.
|
|
699
699
|
|
|
700
700
|
### Example
|
|
701
701
|
|
|
@@ -764,7 +764,7 @@ const { status, data } = await apiInstance.getEventPassTypeTiers(
|
|
|
764
764
|
# **getEventPassTypes**
|
|
765
765
|
> GetEventAddOnPassTypes200Response getEventPassTypes()
|
|
766
766
|
|
|
767
|
-
|
|
767
|
+
Returns a paginated list of pass types (tickets) for an event, ordered by sort order and price by default, with optional search and custom ordering; requires read permission on events.
|
|
768
768
|
|
|
769
769
|
### Example
|
|
770
770
|
|
|
@@ -827,7 +827,7 @@ const { status, data } = await apiInstance.getEventPassTypes(
|
|
|
827
827
|
# **removeEventPassTypeAddOn**
|
|
828
828
|
> CreateEventPassType200Response removeEventPassTypeAddOn()
|
|
829
829
|
|
|
830
|
-
|
|
830
|
+
Detaches an add-on from an event pass type so it is no longer offered alongside that pass type; requires update permission on events.
|
|
831
831
|
|
|
832
832
|
### Example
|
|
833
833
|
|
|
@@ -884,7 +884,7 @@ const { status, data } = await apiInstance.removeEventPassTypeAddOn(
|
|
|
884
884
|
# **removeEventPassTypeGroupPassTier**
|
|
885
885
|
> CreateEventPassType200Response removeEventPassTypeGroupPassTier()
|
|
886
886
|
|
|
887
|
-
|
|
887
|
+
Removes an account tier from the list of tiers allowed to purchase an event pass type as a group pass; requires update permission on events.
|
|
888
888
|
|
|
889
889
|
### Example
|
|
890
890
|
|
|
@@ -941,7 +941,7 @@ const { status, data } = await apiInstance.removeEventPassTypeGroupPassTier(
|
|
|
941
941
|
# **removeEventPassTypeTier**
|
|
942
942
|
> CreateEventPassType200Response removeEventPassTypeTier()
|
|
943
943
|
|
|
944
|
-
|
|
944
|
+
Removes an account tier from either the allowed or disallowed tier list of an event pass type depending on the `allowed` flag; requires update permission on events.
|
|
945
945
|
|
|
946
946
|
### Example
|
|
947
947
|
|
|
@@ -1001,7 +1001,7 @@ const { status, data } = await apiInstance.removeEventPassTypeTier(
|
|
|
1001
1001
|
# **updateEventPassType**
|
|
1002
1002
|
> CreateEventPassType200Response updateEventPassType()
|
|
1003
1003
|
|
|
1004
|
-
|
|
1004
|
+
Updates the details of an existing pass type on the given event, such as its name, pricing, or availability; requires update permission on events.
|
|
1005
1005
|
|
|
1006
1006
|
### Example
|
|
1007
1007
|
|
|
@@ -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
|
-
|[**createEventPassTypePriceSchedule**](#createeventpasstypepriceschedule) | **POST** /events/{eventId}/passTypes/{passTypeId}/priceSchedules | Create
|
|
8
|
-
|[**deleteEventPassTypePriceSchedule**](#deleteeventpasstypepriceschedule) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Delete
|
|
9
|
-
|[**getEventPassTypePriceSchedule**](#geteventpasstypepriceschedule) | **GET** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Get
|
|
10
|
-
|[**getEventPassTypePriceSchedules**](#geteventpasstypepriceschedules) | **GET** /events/{eventId}/passTypes/{passTypeId}/priceSchedules |
|
|
11
|
-
|[**updateEventPassTypePriceSchedule**](#updateeventpasstypepriceschedule) | **PUT** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Update
|
|
7
|
+
|[**createEventPassTypePriceSchedule**](#createeventpasstypepriceschedule) | **POST** /events/{eventId}/passTypes/{passTypeId}/priceSchedules | Create a pass type price schedule|
|
|
8
|
+
|[**deleteEventPassTypePriceSchedule**](#deleteeventpasstypepriceschedule) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Delete a pass type price schedule|
|
|
9
|
+
|[**getEventPassTypePriceSchedule**](#geteventpasstypepriceschedule) | **GET** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Get a single pass type price schedule|
|
|
10
|
+
|[**getEventPassTypePriceSchedules**](#geteventpasstypepriceschedules) | **GET** /events/{eventId}/passTypes/{passTypeId}/priceSchedules | List a pass type\'s price schedules|
|
|
11
|
+
|[**updateEventPassTypePriceSchedule**](#updateeventpasstypepriceschedule) | **PUT** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Update a pass type price schedule|
|
|
12
12
|
|
|
13
13
|
# **createEventPassTypePriceSchedule**
|
|
14
14
|
> CreateEventPassType200Response createEventPassTypePriceSchedule(passTypePriceScheduleCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a time-windowed price schedule for an event pass type, rejecting the request if its date range overlaps an existing schedule; requires update permission on events.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -71,7 +71,7 @@ const { status, data } = await apiInstance.createEventPassTypePriceSchedule(
|
|
|
71
71
|
# **deleteEventPassTypePriceSchedule**
|
|
72
72
|
> SyncAccounts200Response deleteEventPassTypePriceSchedule()
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
Permanently removes a price schedule from an event pass type by its schedule ID; requires update permission on events.
|
|
75
75
|
|
|
76
76
|
### Example
|
|
77
77
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.deleteEventPassTypePriceSchedule(
|
|
|
128
128
|
# **getEventPassTypePriceSchedule**
|
|
129
129
|
> GetEventPassTypePriceSchedule200Response getEventPassTypePriceSchedule()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Returns a single scheduled price change for a specific event pass type, including its scheduled date and new price, and requires the read events permission.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -185,7 +185,7 @@ const { status, data } = await apiInstance.getEventPassTypePriceSchedule(
|
|
|
185
185
|
# **getEventPassTypePriceSchedules**
|
|
186
186
|
> GetEventPassTypePriceSchedules200Response getEventPassTypePriceSchedules()
|
|
187
187
|
|
|
188
|
-
|
|
188
|
+
Returns a paginated list of scheduled price changes for a specific event pass type, used to automate price increases or discounts on set dates, and requires the read events permission.
|
|
189
189
|
|
|
190
190
|
### Example
|
|
191
191
|
|
|
@@ -251,7 +251,7 @@ const { status, data } = await apiInstance.getEventPassTypePriceSchedules(
|
|
|
251
251
|
# **updateEventPassTypePriceSchedule**
|
|
252
252
|
> SyncAccounts200Response updateEventPassTypePriceSchedule(passTypePriceScheduleUpdateInputs)
|
|
253
253
|
|
|
254
|
-
|
|
254
|
+
Updates the date range and price of an existing price schedule on an event pass type, rejecting the request if the new date range overlaps another schedule; requires update permission on events.
|
|
255
255
|
|
|
256
256
|
### Example
|
|
257
257
|
|