@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
|
@@ -4,20 +4,20 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventReservationPass**](#addeventreservationpass) | **POST** /events/{eventId}/reservations/{reservationId}/passes/{passId} |
|
|
8
|
-
|[**createEventReservation**](#createeventreservation) | **POST** /events/{eventId}/reservations | Create
|
|
9
|
-
|[**deleteEventReservation**](#deleteeventreservation) | **DELETE** /events/{eventId}/reservations/{reservationId} | Delete
|
|
10
|
-
|[**getEventAttendeeReservations**](#geteventattendeereservations) | **GET** /events/{eventId}/attendees/{accountId}/reservations |
|
|
11
|
-
|[**getEventReservation**](#geteventreservation) | **GET** /events/{eventId}/reservations/{reservationId} | Get
|
|
12
|
-
|[**getEventReservationPasses**](#geteventreservationpasses) | **GET** /events/{eventId}/reservations/{reservationId}/passes |
|
|
13
|
-
|[**getEventReservations**](#geteventreservations) | **GET** /events/{eventId}/reservations |
|
|
14
|
-
|[**removeEventReservationPass**](#removeeventreservationpass) | **DELETE** /events/{eventId}/reservations/{reservationId}/passes/{passId} |
|
|
15
|
-
|[**updateEventReservation**](#updateeventreservation) | **PUT** /events/{eventId}/reservations/{reservationId} | Update
|
|
7
|
+
|[**addEventReservationPass**](#addeventreservationpass) | **POST** /events/{eventId}/reservations/{reservationId}/passes/{passId} | Attach a pass to a room reservation|
|
|
8
|
+
|[**createEventReservation**](#createeventreservation) | **POST** /events/{eventId}/reservations | Create a room type reservation for an event|
|
|
9
|
+
|[**deleteEventReservation**](#deleteeventreservation) | **DELETE** /events/{eventId}/reservations/{reservationId} | Delete an event room reservation|
|
|
10
|
+
|[**getEventAttendeeReservations**](#geteventattendeereservations) | **GET** /events/{eventId}/attendees/{accountId}/reservations | List an attendee\'s room reservations|
|
|
11
|
+
|[**getEventReservation**](#geteventreservation) | **GET** /events/{eventId}/reservations/{reservationId} | Get an event room reservation|
|
|
12
|
+
|[**getEventReservationPasses**](#geteventreservationpasses) | **GET** /events/{eventId}/reservations/{reservationId}/passes | List passes attached to a room reservation|
|
|
13
|
+
|[**getEventReservations**](#geteventreservations) | **GET** /events/{eventId}/reservations | List an event\'s room reservations|
|
|
14
|
+
|[**removeEventReservationPass**](#removeeventreservationpass) | **DELETE** /events/{eventId}/reservations/{reservationId}/passes/{passId} | Detach a pass from a room reservation|
|
|
15
|
+
|[**updateEventReservation**](#updateeventreservation) | **PUT** /events/{eventId}/reservations/{reservationId} | Update an event room reservation|
|
|
16
16
|
|
|
17
17
|
# **addEventReservationPass**
|
|
18
18
|
> CreateEventReservation200Response addEventReservationPass()
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Connects an existing event pass (purchase) to a room type reservation for an event, allowing that pass holder to occupy the room; the pass must currently be in a needsInfo, ready, or pending status, and this requires read and update permission on attendees.
|
|
21
21
|
|
|
22
22
|
### Example
|
|
23
23
|
|
|
@@ -77,7 +77,7 @@ const { status, data } = await apiInstance.addEventReservationPass(
|
|
|
77
77
|
# **createEventReservation**
|
|
78
78
|
> CreateEventReservation200Response createEventReservation(eventRoomTypeReservationCreateInputs)
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
Creates a new room reservation for an event, linking it to an event room type and room and optionally connecting existing passes to it, requiring read and update permission on attendees.
|
|
81
81
|
|
|
82
82
|
### Example
|
|
83
83
|
|
|
@@ -135,7 +135,7 @@ const { status, data } = await apiInstance.createEventReservation(
|
|
|
135
135
|
# **deleteEventReservation**
|
|
136
136
|
> CreateAccountInvitations200Response deleteEventReservation()
|
|
137
137
|
|
|
138
|
-
|
|
138
|
+
Permanently deletes a room type reservation from an event, requiring read and update permission on attendees.
|
|
139
139
|
|
|
140
140
|
### Example
|
|
141
141
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.deleteEventReservation(
|
|
|
192
192
|
# **getEventAttendeeReservations**
|
|
193
193
|
> GetEventAttendeeReservations200Response getEventAttendeeReservations()
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Returns a paginated list of room-type reservations belonging to the given attendee (account) for the specified event, with search and ordering support; requires read permission on events and attendees.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
|
@@ -258,7 +258,7 @@ const { status, data } = await apiInstance.getEventAttendeeReservations(
|
|
|
258
258
|
# **getEventReservation**
|
|
259
259
|
> CreateEventReservation200Response getEventReservation()
|
|
260
260
|
|
|
261
|
-
|
|
261
|
+
Returns a single room-type reservation for the specified event, identified by reservationId; requires read permission on events and attendees.
|
|
262
262
|
|
|
263
263
|
### Example
|
|
264
264
|
|
|
@@ -312,7 +312,7 @@ const { status, data } = await apiInstance.getEventReservation(
|
|
|
312
312
|
# **getEventReservationPasses**
|
|
313
313
|
> GetEventAddOnPasses200Response getEventReservationPasses()
|
|
314
314
|
|
|
315
|
-
|
|
315
|
+
Returns a paginated list of attendee passes associated with the given room-type reservation for the specified event, with search and ordering support; requires read permission on events and attendees.
|
|
316
316
|
|
|
317
317
|
### Example
|
|
318
318
|
|
|
@@ -378,7 +378,7 @@ const { status, data } = await apiInstance.getEventReservationPasses(
|
|
|
378
378
|
# **getEventReservations**
|
|
379
379
|
> GetEventAttendeeReservations200Response getEventReservations()
|
|
380
380
|
|
|
381
|
-
|
|
381
|
+
Returns a paginated list of room-type reservations for the specified event, with search and ordering support; requires read permission on events and attendees.
|
|
382
382
|
|
|
383
383
|
### Example
|
|
384
384
|
|
|
@@ -441,7 +441,7 @@ const { status, data } = await apiInstance.getEventReservations(
|
|
|
441
441
|
# **removeEventReservationPass**
|
|
442
442
|
> CreateEventReservation200Response removeEventReservationPass()
|
|
443
443
|
|
|
444
|
-
|
|
444
|
+
Disconnects an event pass (purchase) from a room type reservation for an event, freeing up that spot in the room, requiring read and update permission on attendees.
|
|
445
445
|
|
|
446
446
|
### Example
|
|
447
447
|
|
|
@@ -501,7 +501,7 @@ const { status, data } = await apiInstance.removeEventReservationPass(
|
|
|
501
501
|
# **updateEventReservation**
|
|
502
502
|
> CreateEventReservation200Response updateEventReservation(eventRoomTypeReservationUpdateInputs)
|
|
503
503
|
|
|
504
|
-
|
|
504
|
+
Updates an existing room type reservation for an event, such as its assigned room or room type, requiring read and update permission on attendees.
|
|
505
505
|
|
|
506
506
|
### Example
|
|
507
507
|
|
|
@@ -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
|
-
|[**createEventAttribute**](#createeventattribute) | **POST** /events/{eventId}/attributes | Create
|
|
8
|
-
|[**deleteEventAttribute**](#deleteeventattribute) | **DELETE** /events/{eventId}/attributes/{attributeId} | Delete
|
|
9
|
-
|[**getEventAttribute**](#geteventattribute) | **GET** /events/{eventId}/attributes/{attributeId} | Get
|
|
10
|
-
|[**getEventAttributes**](#geteventattributes) | **GET** /events/{eventId}/attributes |
|
|
11
|
-
|[**updateEventAttribute**](#updateeventattribute) | **PUT** /events/{eventId}/attributes/{attributeId} | Update
|
|
7
|
+
|[**createEventAttribute**](#createeventattribute) | **POST** /events/{eventId}/attributes | Create an event attribute|
|
|
8
|
+
|[**deleteEventAttribute**](#deleteeventattribute) | **DELETE** /events/{eventId}/attributes/{attributeId} | Delete an event attribute|
|
|
9
|
+
|[**getEventAttribute**](#geteventattribute) | **GET** /events/{eventId}/attributes/{attributeId} | Get an event attribute|
|
|
10
|
+
|[**getEventAttributes**](#geteventattributes) | **GET** /events/{eventId}/attributes | List an event\'s attributes|
|
|
11
|
+
|[**updateEventAttribute**](#updateeventattribute) | **PUT** /events/{eventId}/attributes/{attributeId} | Update an event attribute|
|
|
12
12
|
|
|
13
13
|
# **createEventAttribute**
|
|
14
14
|
> CreateEventAttribute200Response createEventAttribute(eventAttributeCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new named attribute on the given event, which can then be assigned to pass types to tag or categorize them; requires the \"update\" permission on events.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createEventAttribute(
|
|
|
68
68
|
# **deleteEventAttribute**
|
|
69
69
|
> CreateAccountInvitations200Response deleteEventAttribute()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Permanently deletes the specified attribute from the given event; requires the \"update\" permission on events.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.deleteEventAttribute(
|
|
|
122
122
|
# **getEventAttribute**
|
|
123
123
|
> CreateEventAttribute200Response getEventAttribute()
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Returns a single custom attribute definition belonging to the given event; requires \"read\" permission on events.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.getEventAttribute(
|
|
|
176
176
|
# **getEventAttributes**
|
|
177
177
|
> GetEventAttributes200Response getEventAttributes()
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Returns a paginated list of custom attribute definitions configured for the given event, with optional search and sort order; requires \"read\" permission on events.
|
|
180
180
|
|
|
181
181
|
### Example
|
|
182
182
|
|
|
@@ -239,7 +239,7 @@ const { status, data } = await apiInstance.getEventAttributes(
|
|
|
239
239
|
# **updateEventAttribute**
|
|
240
240
|
> CreateEventAttribute200Response updateEventAttribute(eventAttributeUpdateInputs)
|
|
241
241
|
|
|
242
|
-
|
|
242
|
+
Updates the name or other fields of the specified attribute on the given event; requires the \"update\" permission on events.
|
|
243
243
|
|
|
244
244
|
### Example
|
|
245
245
|
|
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventBenefit**](#addeventbenefit) | **POST** /events/{eventId}/benefits/{benefitId} | Add
|
|
8
|
-
|[**removeEventBenefit**](#removeeventbenefit) | **DELETE** /events/{eventId}/benefits/{benefitId} | Remove
|
|
7
|
+
|[**addEventBenefit**](#addeventbenefit) | **POST** /events/{eventId}/benefits/{benefitId} | Add a benefit to an event|
|
|
8
|
+
|[**removeEventBenefit**](#removeeventbenefit) | **DELETE** /events/{eventId}/benefits/{benefitId} | Remove a benefit from an event|
|
|
9
9
|
|
|
10
10
|
# **addEventBenefit**
|
|
11
11
|
> CreateBenefit200Response addEventBenefit()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Associates an existing benefit with the given event so it is granted to the event\'s attendees; requires \"update\" permission on both events and benefits.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -64,7 +64,7 @@ const { status, data } = await apiInstance.addEventBenefit(
|
|
|
64
64
|
# **removeEventBenefit**
|
|
65
65
|
> CreateBenefit200Response removeEventBenefit()
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
Disassociates the specified benefit from the given event so it is no longer granted to the event\'s attendees; requires \"update\" permission on both events and benefits.
|
|
68
68
|
|
|
69
69
|
### Example
|
|
70
70
|
|
package/docs/EventsBlocksApi.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
|
-
|[**addEventBlockSession**](#addeventblocksession) | **POST** /events/{eventId}/blocks/{blockId}/sessions/{sessionId} | Add
|
|
8
|
-
|[**createEventBlock**](#createeventblock) | **POST** /events/{eventId}/blocks | Create
|
|
9
|
-
|[**deleteEventBlock**](#deleteeventblock) | **DELETE** /events/{eventId}/blocks/{blockId} | Delete
|
|
10
|
-
|[**getEventBlock**](#geteventblock) | **GET** /events/{eventId}/blocks/{blockId} | Get
|
|
11
|
-
|[**getEventBlockSessions**](#geteventblocksessions) | **GET** /events/{eventId}/blocks/{blockId}/sessions |
|
|
12
|
-
|[**getEventBlocks**](#geteventblocks) | **GET** /events/{eventId}/blocks |
|
|
13
|
-
|[**removeEventBlockSession**](#removeeventblocksession) | **DELETE** /events/{eventId}/blocks/{blockId}/sessions/{sessionId} | Remove
|
|
14
|
-
|[**updateEventBlock**](#updateeventblock) | **PUT** /events/{eventId}/blocks/{blockId} | Update
|
|
7
|
+
|[**addEventBlockSession**](#addeventblocksession) | **POST** /events/{eventId}/blocks/{blockId}/sessions/{sessionId} | Add a session to an event block|
|
|
8
|
+
|[**createEventBlock**](#createeventblock) | **POST** /events/{eventId}/blocks | Create an event schedule block|
|
|
9
|
+
|[**deleteEventBlock**](#deleteeventblock) | **DELETE** /events/{eventId}/blocks/{blockId} | Delete an event schedule block|
|
|
10
|
+
|[**getEventBlock**](#geteventblock) | **GET** /events/{eventId}/blocks/{blockId} | Get an event schedule block|
|
|
11
|
+
|[**getEventBlockSessions**](#geteventblocksessions) | **GET** /events/{eventId}/blocks/{blockId}/sessions | List sessions in an event block|
|
|
12
|
+
|[**getEventBlocks**](#geteventblocks) | **GET** /events/{eventId}/blocks | List an event\'s agenda blocks|
|
|
13
|
+
|[**removeEventBlockSession**](#removeeventblocksession) | **DELETE** /events/{eventId}/blocks/{blockId}/sessions/{sessionId} | Remove a session from an event block|
|
|
14
|
+
|[**updateEventBlock**](#updateeventblock) | **PUT** /events/{eventId}/blocks/{blockId} | Update an event schedule block|
|
|
15
15
|
|
|
16
16
|
# **addEventBlockSession**
|
|
17
17
|
> CreateEventBlock200Response addEventBlockSession()
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Adds the specified session to the given block (a schedule grouping of selectable sessions) on the given event; requires the \"update\" permission on events.
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -73,7 +73,7 @@ const { status, data } = await apiInstance.addEventBlockSession(
|
|
|
73
73
|
# **createEventBlock**
|
|
74
74
|
> CreateEventBlock200Response createEventBlock(eventBlockCreateInputs)
|
|
75
75
|
|
|
76
|
-
|
|
76
|
+
Creates a new schedule block (a grouping of sessions, such as a day or track segment) for the given event and requires update permission on events.
|
|
77
77
|
|
|
78
78
|
### Example
|
|
79
79
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.createEventBlock(
|
|
|
128
128
|
# **deleteEventBlock**
|
|
129
129
|
> CreateAccountInvitations200Response deleteEventBlock()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Permanently deletes the specified schedule block from the given event and requires update permission on events.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -182,7 +182,7 @@ const { status, data } = await apiInstance.deleteEventBlock(
|
|
|
182
182
|
# **getEventBlock**
|
|
183
183
|
> CreateEventBlock200Response getEventBlock()
|
|
184
184
|
|
|
185
|
-
|
|
185
|
+
Returns a single schedule block (a grouping used to organize sessions) belonging to the given event; requires \"read\" permission on events.
|
|
186
186
|
|
|
187
187
|
### Example
|
|
188
188
|
|
|
@@ -236,7 +236,7 @@ const { status, data } = await apiInstance.getEventBlock(
|
|
|
236
236
|
# **getEventBlockSessions**
|
|
237
237
|
> GetEventActivationSessions200Response getEventBlockSessions()
|
|
238
238
|
|
|
239
|
-
|
|
239
|
+
Returns a paginated list of the sessions assigned to a specific agenda block on the given event, supporting search and `orderBy` sorting; requires \"read\" permission on events.
|
|
240
240
|
|
|
241
241
|
### Example
|
|
242
242
|
|
|
@@ -302,7 +302,7 @@ const { status, data } = await apiInstance.getEventBlockSessions(
|
|
|
302
302
|
# **getEventBlocks**
|
|
303
303
|
> GetEventBlocks200Response getEventBlocks()
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
Returns a paginated list of the blocks (agenda groupings used to organize sessions) defined for the given event, supporting search and `orderBy` sorting; requires \"read\" permission on events.
|
|
306
306
|
|
|
307
307
|
### Example
|
|
308
308
|
|
|
@@ -365,7 +365,7 @@ const { status, data } = await apiInstance.getEventBlocks(
|
|
|
365
365
|
# **removeEventBlockSession**
|
|
366
366
|
> CreateEventBlock200Response removeEventBlockSession()
|
|
367
367
|
|
|
368
|
-
|
|
368
|
+
Disconnects the specified session from the given event schedule block without deleting the session itself, and requires update permission on events.
|
|
369
369
|
|
|
370
370
|
### Example
|
|
371
371
|
|
|
@@ -422,7 +422,7 @@ const { status, data } = await apiInstance.removeEventBlockSession(
|
|
|
422
422
|
# **updateEventBlock**
|
|
423
423
|
> CreateEventBlock200Response updateEventBlock(eventBlockUpdateInputs)
|
|
424
424
|
|
|
425
|
-
|
|
425
|
+
Updates the fields of an existing schedule block on the given event, such as its name or image, and requires update permission on events.
|
|
426
426
|
|
|
427
427
|
### Example
|
|
428
428
|
|
package/docs/EventsBypassApi.md
CHANGED
|
@@ -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
|
-
|[**createEventRegistrationBypass**](#createeventregistrationbypass) | **POST** /events/{eventId}/bypass | Create
|
|
8
|
-
|[**deleteEventRegistrationBypass**](#deleteeventregistrationbypass) | **DELETE** /events/{eventId}/bypass/{bypassId} | Delete
|
|
9
|
-
|[**getEventRegistrationBypass**](#geteventregistrationbypass) | **GET** /events/{eventId}/bypass/{bypassId} | Get
|
|
10
|
-
|[**getEventRegistrationBypassList**](#geteventregistrationbypasslist) | **GET** /events/{eventId}/bypass |
|
|
11
|
-
|[**updateEventRegistrationBypass**](#updateeventregistrationbypass) | **PUT** /events/{eventId}/bypass/{bypassId} | Update
|
|
7
|
+
|[**createEventRegistrationBypass**](#createeventregistrationbypass) | **POST** /events/{eventId}/bypass | Create an event registration bypass|
|
|
8
|
+
|[**deleteEventRegistrationBypass**](#deleteeventregistrationbypass) | **DELETE** /events/{eventId}/bypass/{bypassId} | Delete an event registration bypass|
|
|
9
|
+
|[**getEventRegistrationBypass**](#geteventregistrationbypass) | **GET** /events/{eventId}/bypass/{bypassId} | Get a single registration bypass|
|
|
10
|
+
|[**getEventRegistrationBypassList**](#geteventregistrationbypasslist) | **GET** /events/{eventId}/bypass | List an event\'s registration bypasses|
|
|
11
|
+
|[**updateEventRegistrationBypass**](#updateeventregistrationbypass) | **PUT** /events/{eventId}/bypass/{bypassId} | Update an event registration bypass|
|
|
12
12
|
|
|
13
13
|
# **createEventRegistrationBypass**
|
|
14
14
|
> CreateEventRegistrationBypass200Response createEventRegistrationBypass(eventRegistrationBypassCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a registration bypass for the given event, allowing a specific account to skip normal registration requirements, and requires create permission on events.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createEventRegistrationBypass(
|
|
|
68
68
|
# **deleteEventRegistrationBypass**
|
|
69
69
|
> CreateAccountInvitations200Response deleteEventRegistrationBypass()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Permanently deletes the specified registration bypass from the given event and requires delete permission on events.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.deleteEventRegistrationBypass(
|
|
|
122
122
|
# **getEventRegistrationBypass**
|
|
123
123
|
> CreateEventRegistrationBypass200Response getEventRegistrationBypass()
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Retrieves one registration bypass record for the given event by its ID, showing which account it grants access to and which registration restriction (closed, before start, or after end) it bypasses; requires \"read\" permission on events.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.getEventRegistrationBypass(
|
|
|
176
176
|
# **getEventRegistrationBypassList**
|
|
177
177
|
> GetEventRegistrationBypassList200Response getEventRegistrationBypassList()
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Returns a paginated list of registration bypass records for the given event, which grant specific accounts the ability to register outside normal registration windows (before opening, after closing, or while registration is disabled), supporting search by account name/email and `orderBy` sorting; requires \"read\" permission on events.
|
|
180
180
|
|
|
181
181
|
### Example
|
|
182
182
|
|
|
@@ -239,7 +239,7 @@ const { status, data } = await apiInstance.getEventRegistrationBypassList(
|
|
|
239
239
|
# **updateEventRegistrationBypass**
|
|
240
240
|
> CreateEventRegistrationBypass200Response updateEventRegistrationBypass()
|
|
241
241
|
|
|
242
|
-
|
|
242
|
+
Updates the fields of an existing registration bypass on the given event, such as the associated account, and requires update permission on events.
|
|
243
243
|
|
|
244
244
|
### Example
|
|
245
245
|
|
package/docs/EventsCohostsApi.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
|
-
|[**addEventCoHost**](#addeventcohost) | **POST** /events/{eventId}/coHosts/{accountId} | Add
|
|
8
|
-
|[**getEventCoHosts**](#geteventcohosts) | **GET** /events/{eventId}/coHosts |
|
|
9
|
-
|[**removeEventCoHost**](#removeeventcohost) | **DELETE** /events/{eventId}/coHosts/{accountId} | Remove
|
|
7
|
+
|[**addEventCoHost**](#addeventcohost) | **POST** /events/{eventId}/coHosts/{accountId} | Add a co-host to an event|
|
|
8
|
+
|[**getEventCoHosts**](#geteventcohosts) | **GET** /events/{eventId}/coHosts | List an event\'s co-host accounts|
|
|
9
|
+
|[**removeEventCoHost**](#removeeventcohost) | **DELETE** /events/{eventId}/coHosts/{accountId} | Remove a co-host from an event|
|
|
10
10
|
|
|
11
11
|
# **addEventCoHost**
|
|
12
12
|
> CreateAccount200Response addEventCoHost()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Connects the specified account as a co-host of the given event and requires update permission on events; an account cannot be added as a co-host of itself.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addEventCoHost(
|
|
|
65
65
|
# **getEventCoHosts**
|
|
66
66
|
> GetAccounts200Response getEventCoHosts()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Returns a paginated list of accounts designated as co-hosts of the given event, supporting search and `orderBy` sorting; requires \"read\" permission on events.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getEventCoHosts(
|
|
|
128
128
|
# **removeEventCoHost**
|
|
129
129
|
> CreateAccount200Response removeEventCoHost()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Disconnects the specified account from the given event\'s co-host list and requires update permission on events.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
package/docs/EventsCouponsApi.md
CHANGED
|
@@ -4,25 +4,25 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventCouponTier**](#addeventcoupontier) | **POST** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Add
|
|
8
|
-
|[**createEventCoupon**](#createeventcoupon) | **POST** /events/{eventId}/coupons | Create
|
|
9
|
-
|[**createEventCouponVariants**](#createeventcouponvariants) | **POST** /events/{eventId}/coupons/{couponId}/variants | Create
|
|
10
|
-
|[**deleteEventCoupon**](#deleteeventcoupon) | **DELETE** /events/{eventId}/coupons/{couponId} | Delete
|
|
11
|
-
|[**deleteEventCouponVariants**](#deleteeventcouponvariants) | **DELETE** /events/{eventId}/coupons/{couponId}/variants | Delete
|
|
12
|
-
|[**getEventCoupon**](#geteventcoupon) | **GET** /events/{eventId}/coupons/{couponId} | Get
|
|
13
|
-
|[**getEventCouponPasses**](#geteventcouponpasses) | **GET** /events/{eventId}/coupons/{couponId}/passes |
|
|
14
|
-
|[**getEventCouponPayments**](#geteventcouponpayments) | **GET** /events/{eventId}/coupons/{couponId}/payments |
|
|
15
|
-
|[**getEventCouponTiers**](#geteventcoupontiers) | **GET** /events/{eventId}/coupons/{couponId}/tiers |
|
|
16
|
-
|[**getEventCouponVariants**](#geteventcouponvariants) | **GET** /events/{eventId}/coupons/{parentCouponId}/variants |
|
|
17
|
-
|[**getEventCoupons**](#geteventcoupons) | **GET** /events/{eventId}/coupons |
|
|
18
|
-
|[**removeEventCouponTier**](#removeeventcoupontier) | **DELETE** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Remove
|
|
19
|
-
|[**syncEventCouponToVariants**](#synceventcoupontovariants) | **PUT** /events/{eventId}/coupons/{couponId}/variants | Sync
|
|
20
|
-
|[**updateEventCoupon**](#updateeventcoupon) | **PUT** /events/{eventId}/coupons/{couponId} | Update
|
|
7
|
+
|[**addEventCouponTier**](#addeventcoupontier) | **POST** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Add tier to event coupon|
|
|
8
|
+
|[**createEventCoupon**](#createeventcoupon) | **POST** /events/{eventId}/coupons | Create an event coupon|
|
|
9
|
+
|[**createEventCouponVariants**](#createeventcouponvariants) | **POST** /events/{eventId}/coupons/{couponId}/variants | Create variant coupons from a parent coupon|
|
|
10
|
+
|[**deleteEventCoupon**](#deleteeventcoupon) | **DELETE** /events/{eventId}/coupons/{couponId} | Delete an event coupon|
|
|
11
|
+
|[**deleteEventCouponVariants**](#deleteeventcouponvariants) | **DELETE** /events/{eventId}/coupons/{couponId}/variants | Delete all variants of a coupon|
|
|
12
|
+
|[**getEventCoupon**](#geteventcoupon) | **GET** /events/{eventId}/coupons/{couponId} | Get a single event coupon|
|
|
13
|
+
|[**getEventCouponPasses**](#geteventcouponpasses) | **GET** /events/{eventId}/coupons/{couponId}/passes | List purchases made with a coupon|
|
|
14
|
+
|[**getEventCouponPayments**](#geteventcouponpayments) | **GET** /events/{eventId}/coupons/{couponId}/payments | List payments made with a coupon|
|
|
15
|
+
|[**getEventCouponTiers**](#geteventcoupontiers) | **GET** /events/{eventId}/coupons/{couponId}/tiers | List event coupon tiers|
|
|
16
|
+
|[**getEventCouponVariants**](#geteventcouponvariants) | **GET** /events/{eventId}/coupons/{parentCouponId}/variants | List a coupon\'s variants|
|
|
17
|
+
|[**getEventCoupons**](#geteventcoupons) | **GET** /events/{eventId}/coupons | List an event\'s coupons|
|
|
18
|
+
|[**removeEventCouponTier**](#removeeventcoupontier) | **DELETE** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Remove tier from event coupon|
|
|
19
|
+
|[**syncEventCouponToVariants**](#synceventcoupontovariants) | **PUT** /events/{eventId}/coupons/{couponId}/variants | Sync a coupon\'s fields to its variants|
|
|
20
|
+
|[**updateEventCoupon**](#updateeventcoupon) | **PUT** /events/{eventId}/coupons/{couponId} | Update an event coupon|
|
|
21
21
|
|
|
22
22
|
# **addEventCouponTier**
|
|
23
23
|
> CreateEventCoupon200Response addEventCouponTier()
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
Adds a ticket tier to an event coupon\'s allow-list or disallow-list; when allowed is true the tier is connected to the coupon\'s allowed tiers, otherwise to its disallowed tiers. Requires update permission on events.
|
|
26
26
|
|
|
27
27
|
### Example
|
|
28
28
|
|
|
@@ -82,7 +82,7 @@ const { status, data } = await apiInstance.addEventCouponTier(
|
|
|
82
82
|
# **createEventCoupon**
|
|
83
83
|
> CreateEventCoupon200Response createEventCoupon(eventCouponCreateInputs)
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
Creates a new discount coupon for the given event and requires update permission on events.
|
|
86
86
|
|
|
87
87
|
### Example
|
|
88
88
|
|
|
@@ -137,7 +137,7 @@ const { status, data } = await apiInstance.createEventCoupon(
|
|
|
137
137
|
# **createEventCouponVariants**
|
|
138
138
|
> CreateEventCouponVariants200Response createEventCouponVariants(eventVariantCouponCreateInputs)
|
|
139
139
|
|
|
140
|
-
|
|
140
|
+
Generates the given quantity of unique, randomly-coded variant coupons cloned from a parent coupon\'s settings, failing if the parent is itself a variant or is pre-paid; requires update permission on events.
|
|
141
141
|
|
|
142
142
|
### Example
|
|
143
143
|
|
|
@@ -195,7 +195,7 @@ const { status, data } = await apiInstance.createEventCouponVariants(
|
|
|
195
195
|
# **deleteEventCoupon**
|
|
196
196
|
> CreateAccountInvitations200Response deleteEventCoupon()
|
|
197
197
|
|
|
198
|
-
|
|
198
|
+
Permanently deletes a coupon from an event, failing if any purchases have already used the coupon; requires update permission on events.
|
|
199
199
|
|
|
200
200
|
### Example
|
|
201
201
|
|
|
@@ -249,7 +249,7 @@ const { status, data } = await apiInstance.deleteEventCoupon(
|
|
|
249
249
|
# **deleteEventCouponVariants**
|
|
250
250
|
> CreateAccountInvitations200Response deleteEventCouponVariants()
|
|
251
251
|
|
|
252
|
-
|
|
252
|
+
Deletes every variant coupon generated from a parent coupon, failing if the target is itself a variant or if any variant has already been used in a purchase; requires update permission on events.
|
|
253
253
|
|
|
254
254
|
### Example
|
|
255
255
|
|
|
@@ -303,7 +303,7 @@ const { status, data } = await apiInstance.deleteEventCouponVariants(
|
|
|
303
303
|
# **getEventCoupon**
|
|
304
304
|
> CreateEventCoupon200Response getEventCoupon()
|
|
305
305
|
|
|
306
|
-
|
|
306
|
+
Retrieves the details of one coupon (by ID or code) for the given event, including its discount configuration and pre-paid/group settings; requires \"read\" permission on events.
|
|
307
307
|
|
|
308
308
|
### Example
|
|
309
309
|
|
|
@@ -357,7 +357,7 @@ const { status, data } = await apiInstance.getEventCoupon(
|
|
|
357
357
|
# **getEventCouponPasses**
|
|
358
358
|
> GetEventAddOnPasses200Response getEventCouponPasses()
|
|
359
359
|
|
|
360
|
-
|
|
360
|
+
Returns a paginated list of pass purchases made using the given coupon (or any of its variants) on the event, supporting search by attendee name/email or purchase ID; requires \"read\" permission on both events and attendees.
|
|
361
361
|
|
|
362
362
|
### Example
|
|
363
363
|
|
|
@@ -423,7 +423,7 @@ const { status, data } = await apiInstance.getEventCouponPasses(
|
|
|
423
423
|
# **getEventCouponPayments**
|
|
424
424
|
> GetAccountPayments200Response getEventCouponPayments()
|
|
425
425
|
|
|
426
|
-
|
|
426
|
+
Returns a paginated list of payments on the given event that used the specified coupon, supporting search and `orderBy` sorting; requires \"read\" permission on both events and payments.
|
|
427
427
|
|
|
428
428
|
### Example
|
|
429
429
|
|
|
@@ -489,7 +489,7 @@ const { status, data } = await apiInstance.getEventCouponPayments(
|
|
|
489
489
|
# **getEventCouponTiers**
|
|
490
490
|
> GetAccountTiers200Response getEventCouponTiers()
|
|
491
491
|
|
|
492
|
-
|
|
492
|
+
Lists the ticket tiers currently on an event coupon\'s allow-list or disallow-list; the allowed flag selects which list to return (allowed tiers when true, disallowed tiers when false), with pagination, ordering, and search support.
|
|
493
493
|
|
|
494
494
|
### Example
|
|
495
495
|
|
|
@@ -558,7 +558,7 @@ const { status, data } = await apiInstance.getEventCouponTiers(
|
|
|
558
558
|
# **getEventCouponVariants**
|
|
559
559
|
> GetEventAttendeeCoupons200Response getEventCouponVariants()
|
|
560
560
|
|
|
561
|
-
|
|
561
|
+
Returns a paginated list of the child coupon variants belonging to the given parent coupon on the event, supporting search and `orderBy` sorting; requires \"read\" permission on events.
|
|
562
562
|
|
|
563
563
|
### Example
|
|
564
564
|
|
|
@@ -624,7 +624,7 @@ const { status, data } = await apiInstance.getEventCouponVariants(
|
|
|
624
624
|
# **getEventCoupons**
|
|
625
625
|
> GetEventAttendeeCoupons200Response getEventCoupons()
|
|
626
626
|
|
|
627
|
-
|
|
627
|
+
Returns a paginated list of coupons for the given event, filterable by `prePaid` (group-paid vs. standard coupons) and by `includeVariants` to include child coupon variants, with search and `orderBy` sorting; requires \"read\" permission on events.
|
|
628
628
|
|
|
629
629
|
### Example
|
|
630
630
|
|
|
@@ -693,7 +693,7 @@ const { status, data } = await apiInstance.getEventCoupons(
|
|
|
693
693
|
# **removeEventCouponTier**
|
|
694
694
|
> CreateEventCoupon200Response removeEventCouponTier()
|
|
695
695
|
|
|
696
|
-
|
|
696
|
+
Removes a ticket tier from an event coupon\'s allow-list or disallow-list; the allowed query flag selects which list to disconnect the tier from (allowed tiers when true, disallowed tiers when false). Requires update permission on events.
|
|
697
697
|
|
|
698
698
|
### Example
|
|
699
699
|
|
|
@@ -753,7 +753,7 @@ const { status, data } = await apiInstance.removeEventCouponTier(
|
|
|
753
753
|
# **syncEventCouponToVariants**
|
|
754
754
|
> CreateEventCoupon200Response syncEventCouponToVariants(eventVariantCouponSyncInputs)
|
|
755
755
|
|
|
756
|
-
|
|
756
|
+
Copies the given list of field values from a parent coupon onto all of its variant coupons, failing if the target is itself a variant; requires update permission on events.
|
|
757
757
|
|
|
758
758
|
### Example
|
|
759
759
|
|
|
@@ -811,7 +811,7 @@ const { status, data } = await apiInstance.syncEventCouponToVariants(
|
|
|
811
811
|
# **updateEventCoupon**
|
|
812
812
|
> CreateEventCoupon200Response updateEventCoupon(eventCouponUpdateInputs)
|
|
813
813
|
|
|
814
|
-
|
|
814
|
+
Updates the properties of an existing coupon on an event, such as its discount, active state, dates, and usage limits, blocking changes to the purchase limit on pre-paid coupons; requires update permission on events.
|
|
815
815
|
|
|
816
816
|
### Example
|
|
817
817
|
|
package/docs/EventsEmailsApi.md
CHANGED
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getEventEmail**](#geteventemail) | **GET** /events/{eventId}/emails/{type} | Get
|
|
8
|
-
|[**updateEventEmail**](#updateeventemail) | **PUT** /events/{eventId}/emails/{type} | Update
|
|
7
|
+
|[**getEventEmail**](#geteventemail) | **GET** /events/{eventId}/emails/{type} | Get an event\'s email configuration|
|
|
8
|
+
|[**updateEventEmail**](#updateeventemail) | **PUT** /events/{eventId}/emails/{type} | Update an event email template|
|
|
9
9
|
|
|
10
10
|
# **getEventEmail**
|
|
11
11
|
> GetEventEmail200Response getEventEmail()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, or denial; requires read permission on events.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -64,7 +64,7 @@ const { status, data } = await apiInstance.getEventEmail(
|
|
|
64
64
|
# **updateEventEmail**
|
|
65
65
|
> GetEventEmail200Response updateEventEmail(eventEmailUpdateInputs)
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
Updates the content of a specific automated email (by type, e.g. registration confirmation) sent for an event; requires update permission on events.
|
|
68
68
|
|
|
69
69
|
### Example
|
|
70
70
|
|
|
@@ -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
|
-
|[**deleteEventEmailTranslation**](#deleteeventemailtranslation) | **DELETE** /events/{eventId}/emails/{type}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventEmailTranslation**](#geteventemailtranslation) | **GET** /events/{eventId}/emails/{type}/translations/{locale} | Get
|
|
9
|
-
|[**getEventEmailTranslations**](#geteventemailtranslations) | **GET** /events/{eventId}/emails/{type}/translations |
|
|
10
|
-
|[**updateEventEmailTranslation**](#updateeventemailtranslation) | **PUT** /events/{eventId}/emails/{type}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventEmailTranslation**](#deleteeventemailtranslation) | **DELETE** /events/{eventId}/emails/{type}/translations/{locale} | Delete an event email translation|
|
|
8
|
+
|[**getEventEmailTranslation**](#geteventemailtranslation) | **GET** /events/{eventId}/emails/{type}/translations/{locale} | Get an event email\'s translation|
|
|
9
|
+
|[**getEventEmailTranslations**](#geteventemailtranslations) | **GET** /events/{eventId}/emails/{type}/translations | List an event email\'s translations|
|
|
10
|
+
|[**updateEventEmailTranslation**](#updateeventemailtranslation) | **PUT** /events/{eventId}/emails/{type}/translations/{locale} | Update an event email translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventEmailTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventEmailTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the translated content for a specific event email type in a given locale, reverting that locale to the email\'s default content; requires update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventEmailTranslation(
|
|
|
69
69
|
# **getEventEmailTranslation**
|
|
70
70
|
> GetEventEmailTranslation200Response getEventEmailTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Returns the localized translation (subject/body) for a specific event email type and locale, or null if no translation exists for that locale; requires read permission on events.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventEmailTranslation(
|
|
|
126
126
|
# **getEventEmailTranslations**
|
|
127
127
|
> GetEventEmailTranslations200Response getEventEmailTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of locale translations for a specific event email type, supporting page, pageSize, orderBy, and search filters; requires read permission on events.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventEmailTranslations(
|
|
|
192
192
|
# **updateEventEmailTranslation**
|
|
193
193
|
> SyncAccounts200Response updateEventEmailTranslation(eventEmailTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Creates or updates the translated subject and body content for a specific event email type in a given locale; requires update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|