@connectedxm/admin-sdk 7.5.0 → 7.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -0
- package/README.md +1215 -1212
- package/api.ts +9898 -9710
- package/dist/api.d.ts +9807 -9710
- package/dist/api.js +9842 -9696
- package/dist/esm/api.d.ts +9807 -9710
- package/dist/esm/api.js +9842 -9696
- package/docs/AccountsAddressesApi.md +10 -10
- package/docs/AccountsApi.md +42 -42
- package/docs/AccountsFollowersApi.md +6 -6
- package/docs/AccountsFollowingApi.md +6 -6
- package/docs/AccountsGroupsApi.md +6 -6
- package/docs/AccountsInterestsApi.md +6 -6
- package/docs/AccountsInvitationsApi.md +6 -6
- package/docs/AccountsLeadsApi.md +8 -8
- package/docs/AccountsTiersApi.md +8 -8
- package/docs/ActivitiesApi.md +18 -18
- package/docs/ActivitiesScheduleApi.md +4 -4
- package/docs/AdvertisementsApi.md +14 -14
- package/docs/AnnouncementsApi.md +16 -16
- package/docs/AnnouncementsScheduleApi.md +4 -4
- package/docs/AnnouncementsTranslationsApi.md +8 -8
- package/docs/ApiLogsApi.md +4 -4
- package/docs/AuthSessionsApi.md +4 -4
- package/docs/BaseEvent.md +6 -0
- package/docs/BaseEventSessionLocation.md +2 -0
- package/docs/BenefitsApi.md +12 -12
- package/docs/BenefitsTranslationsApi.md +8 -8
- package/docs/BookingsApi.md +56 -56
- package/docs/BookingsAvailabilitiesApi.md +6 -6
- package/docs/BookingsBlackoutsApi.md +6 -6
- package/docs/BookingsPlacesApi.md +6 -6
- package/docs/BookingsPlacesTranslationsApi.md +4 -4
- package/docs/BookingsQuestionsApi.md +16 -16
- package/docs/BookingsQuestionsChoicesApi.md +12 -12
- package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
- package/docs/BookingsQuestionsTranslationsApi.md +8 -8
- package/docs/BookingsSpacesApi.md +6 -6
- package/docs/BookingsSpacesTranslationsApi.md +4 -4
- package/docs/ChannelsApi.md +58 -58
- package/docs/ChannelsTranslationsApi.md +24 -24
- package/docs/DashboardsApi.md +10 -10
- package/docs/DashboardsWidgetsApi.md +8 -8
- package/docs/EmailReceiptsApi.md +4 -4
- package/docs/Event.md +10 -0
- package/docs/EventCreateInputs.md +0 -14
- package/docs/EventLocationInputs.md +38 -0
- package/docs/EventSessionLocation.md +6 -0
- package/docs/EventSessionLocationCreateInputs.md +2 -0
- package/docs/EventSessionLocationUpdateInputs.md +2 -0
- package/docs/EventUpdateInputs.md +0 -14
- package/docs/EventsAccessApi.md +6 -6
- package/docs/EventsActivationsApi.md +22 -22
- package/docs/EventsActivationsSessionsApi.md +6 -6
- package/docs/EventsActivationsTranslationsApi.md +8 -8
- package/docs/EventsAddonsApi.md +24 -24
- package/docs/EventsAddonsTranslationsApi.md +8 -8
- package/docs/EventsApi.md +130 -22
- package/docs/EventsAttendeesApi.md +24 -24
- package/docs/EventsAttendeesPackagesApi.md +10 -10
- package/docs/EventsAttendeesReservationsApi.md +18 -18
- package/docs/EventsAttributesApi.md +10 -10
- package/docs/EventsBenefitsApi.md +4 -4
- package/docs/EventsBlocksApi.md +16 -16
- package/docs/EventsBypassApi.md +10 -10
- package/docs/EventsCohostsApi.md +6 -6
- package/docs/EventsCouponsApi.md +28 -28
- package/docs/EventsEmailsApi.md +4 -4
- package/docs/EventsEmailsTranslationsApi.md +8 -8
- package/docs/EventsFaqsApi.md +22 -22
- package/docs/EventsFaqsTranslationsApi.md +16 -16
- package/docs/EventsFollowupsApi.md +38 -38
- package/docs/EventsFollowupsTranslationsApi.md +8 -8
- package/docs/EventsMatchesApi.md +34 -34
- package/docs/EventsMediaApi.md +16 -16
- package/docs/EventsMediaTranslationsApi.md +8 -8
- package/docs/EventsOnSiteApi.md +6 -6
- package/docs/EventsPackagesApi.md +10 -10
- package/docs/EventsPackagesPassesApi.md +10 -10
- package/docs/EventsPackagesTranslationsApi.md +8 -8
- package/docs/EventsPagesApi.md +16 -16
- package/docs/EventsPagesTranslationsApi.md +8 -8
- package/docs/EventsPassesAccessesApi.md +10 -10
- package/docs/EventsPassesAddonsApi.md +6 -6
- package/docs/EventsPassesApi.md +34 -34
- package/docs/EventsPassesAttributesApi.md +6 -6
- package/docs/EventsPassesFollowupsApi.md +8 -8
- package/docs/EventsPassesResponsesApi.md +10 -10
- package/docs/EventsPasstypesApi.md +34 -34
- package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
- package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
- package/docs/EventsPasstypesTranslationsApi.md +8 -8
- package/docs/EventsQuestionsApi.md +44 -44
- package/docs/EventsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsRoomsApi.md +18 -18
- package/docs/EventsRoomtypesApi.md +24 -24
- package/docs/EventsRoomtypesTranslationsApi.md +8 -8
- package/docs/EventsSectionsApi.md +38 -38
- package/docs/EventsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsAccessesApi.md +6 -6
- package/docs/EventsSessionsApi.md +70 -70
- package/docs/EventsSessionsLocationsApi.md +16 -16
- package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
- package/docs/EventsSessionsMatchesApi.md +32 -32
- package/docs/EventsSessionsPricesApi.md +6 -6
- package/docs/EventsSessionsQuestionsApi.md +38 -38
- package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsSessionsSectionsApi.md +20 -20
- package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsTimesApi.md +16 -16
- package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
- package/docs/EventsSessionsTranslationsApi.md +8 -8
- package/docs/EventsSpeakersApi.md +16 -16
- package/docs/EventsSpeakersTranslationsApi.md +8 -8
- package/docs/EventsSponsorsApi.md +8 -8
- package/docs/EventsSponsorshiplevelsApi.md +12 -12
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
- package/docs/EventsSponsorshipsApi.md +12 -12
- package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
- package/docs/EventsTemplatesApi.md +2 -2
- package/docs/EventsTracksApi.md +22 -22
- package/docs/EventsTracksTranslationsApi.md +8 -8
- package/docs/EventsTransfersApi.md +4 -4
- package/docs/EventsTranslationsApi.md +8 -8
- package/docs/FilesApi.md +4 -4
- package/docs/GroupsApi.md +12 -12
- package/docs/GroupsEventsApi.md +6 -6
- package/docs/GroupsInterestsApi.md +6 -6
- package/docs/GroupsInvitationsApi.md +12 -12
- package/docs/GroupsMembersApi.md +8 -8
- package/docs/GroupsModeratorsApi.md +6 -6
- package/docs/GroupsRequestsApi.md +10 -10
- package/docs/GroupsSponsorsApi.md +6 -6
- package/docs/GroupsTranslationsApi.md +8 -8
- package/docs/ImportsApi.md +8 -8
- package/docs/InterestsApi.md +22 -22
- package/docs/InvoicesApi.md +20 -20
- package/docs/InvoicesLineitemsApi.md +6 -6
- package/docs/LoginsAccountsApi.md +6 -6
- package/docs/LoginsApi.md +16 -16
- package/docs/MeetingsApi.md +14 -14
- package/docs/MeetingsLinksApi.md +10 -10
- package/docs/MeetingsLivestreamsApi.md +12 -12
- package/docs/MeetingsParticipantsApi.md +12 -12
- package/docs/MeetingsPresetsApi.md +10 -10
- package/docs/MeetingsRecordingsApi.md +4 -4
- package/docs/MeetingsSessionsApi.md +16 -16
- package/docs/NotificationsApi.md +8 -8
- package/docs/OrganizationApi.md +18 -18
- package/docs/OrganizationAttributesApi.md +14 -14
- package/docs/OrganizationDomainsApi.md +6 -6
- package/docs/OrganizationIntegrationsApi.md +10 -10
- package/docs/OrganizationModulesApi.md +6 -6
- package/docs/OrganizationModulesCustomApi.md +10 -10
- package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
- package/docs/OrganizationModulesSettingsApi.md +4 -4
- package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
- package/docs/OrganizationModulesTiersApi.md +12 -12
- package/docs/OrganizationPaymentsApi.md +20 -20
- package/docs/OrganizationSideeffectsApi.md +8 -8
- package/docs/OrganizationTaxApi.md +22 -22
- package/docs/OrganizationTeammembersApi.md +10 -10
- package/docs/OrganizationUsersApi.md +6 -6
- package/docs/OrganizationWebhooksApi.md +12 -12
- package/docs/PaymentsApi.md +2 -2
- package/docs/PreferencesApi.md +4 -4
- package/docs/PushDevicesApi.md +6 -6
- package/docs/ReportsApi.md +22 -22
- package/docs/ReportsUsersApi.md +6 -6
- package/docs/SearchlistsApi.md +10 -10
- package/docs/SearchlistsValuesApi.md +14 -14
- package/docs/SelfApi.md +10 -10
- package/docs/SelfApikeysApi.md +8 -8
- package/docs/SelfImagesApi.md +4 -4
- package/docs/SeriesApi.md +18 -18
- package/docs/SeriesQuestionsApi.md +14 -14
- package/docs/SeriesQuestionsChoicesApi.md +8 -8
- package/docs/SeriesQuestionsTranslationsApi.md +4 -4
- package/docs/SeriesRegistrationsApi.md +18 -18
- package/docs/SeriesTranslationsApi.md +8 -8
- package/docs/SponsorsAccountsApi.md +6 -6
- package/docs/SponsorsApi.md +10 -10
- package/docs/SponsorsTranslationsApi.md +8 -8
- package/docs/StorageFilesApi.md +6 -6
- package/docs/StorageImagesApi.md +18 -18
- package/docs/StorageVideosApi.md +14 -14
- package/docs/StorageVideosCaptionsApi.md +10 -10
- package/docs/StreamsApi.md +14 -14
- package/docs/StreamsOutputsApi.md +10 -10
- package/docs/StreamsSessionsApi.md +12 -12
- package/docs/SupportApi.md +14 -14
- package/docs/SupportMessagesApi.md +4 -4
- package/docs/SupportNotesApi.md +6 -6
- package/docs/SurveysApi.md +12 -12
- package/docs/SurveysQuestionsApi.md +38 -38
- package/docs/SurveysQuestionsTranslationsApi.md +16 -16
- package/docs/SurveysSectionsApi.md +20 -20
- package/docs/SurveysSectionsTranslationsApi.md +8 -8
- package/docs/SurveysSessionsApi.md +4 -4
- package/docs/SurveysSubmissionsApi.md +14 -14
- package/docs/SurveysTranslationsApi.md +8 -8
- package/docs/ThreadsAccountsApi.md +8 -8
- package/docs/ThreadsApi.md +10 -10
- package/docs/ThreadsMessagesApi.md +12 -12
- package/docs/ThreadsMessagesFilesApi.md +6 -6
- package/docs/ThreadsMessagesImagesApi.md +6 -6
- package/docs/ThreadsMessagesReactionsApi.md +6 -6
- package/docs/ThreadsMessagesVideosApi.md +6 -6
- package/docs/ThreadsStorageApi.md +6 -6
- package/docs/TiersApi.md +20 -20
- package/package.json +1 -1
package/docs/EventsAddonsApi.md
CHANGED
|
@@ -4,23 +4,23 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventAddOnPassType**](#addeventaddonpasstype) | **POST** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} |
|
|
8
|
-
|[**addEventAddOnTier**](#addeventaddontier) | **POST** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} |
|
|
9
|
-
|[**createEventAddOn**](#createeventaddon) | **POST** /events/{eventId}/addOns | Create
|
|
10
|
-
|[**deleteEventAddOn**](#deleteeventaddon) | **DELETE** /events/{eventId}/addOns/{addOnId} | Delete
|
|
11
|
-
|[**getEventAddOn**](#geteventaddon) | **GET** /events/{eventId}/addOns/{addOnId} | Get
|
|
12
|
-
|[**getEventAddOnPassTypes**](#geteventaddonpasstypes) | **GET** /events/{eventId}/addOns/{addOnId}/passTypes |
|
|
13
|
-
|[**getEventAddOnPasses**](#geteventaddonpasses) | **GET** /events/{eventId}/addOns/{addOnId}/passes |
|
|
14
|
-
|[**getEventAddOnTiers**](#geteventaddontiers) | **GET** /events/{eventId}/addOns/{addOnId}/tiers |
|
|
15
|
-
|[**getEventAddOns**](#geteventaddons) | **GET** /events/{eventId}/addOns |
|
|
16
|
-
|[**removeEventAddOnPassType**](#removeeventaddonpasstype) | **DELETE** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} |
|
|
17
|
-
|[**removeEventAddOnTier**](#removeeventaddontier) | **DELETE** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} | Remove
|
|
18
|
-
|[**updateEventAddOn**](#updateeventaddon) | **PUT** /events/{eventId}/addOns/{addOnId} | Update
|
|
7
|
+
|[**addEventAddOnPassType**](#addeventaddonpasstype) | **POST** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} | Allow a pass type to purchase an add-on|
|
|
8
|
+
|[**addEventAddOnTier**](#addeventaddontier) | **POST** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} | Set an account tier\'s access to an add-on|
|
|
9
|
+
|[**createEventAddOn**](#createeventaddon) | **POST** /events/{eventId}/addOns | Create an event add-on|
|
|
10
|
+
|[**deleteEventAddOn**](#deleteeventaddon) | **DELETE** /events/{eventId}/addOns/{addOnId} | Delete an event add-on|
|
|
11
|
+
|[**getEventAddOn**](#geteventaddon) | **GET** /events/{eventId}/addOns/{addOnId} | Get an event add-on|
|
|
12
|
+
|[**getEventAddOnPassTypes**](#geteventaddonpasstypes) | **GET** /events/{eventId}/addOns/{addOnId}/passTypes | List pass types eligible for an add-on|
|
|
13
|
+
|[**getEventAddOnPasses**](#geteventaddonpasses) | **GET** /events/{eventId}/addOns/{addOnId}/passes | List purchases of an event add-on|
|
|
14
|
+
|[**getEventAddOnTiers**](#geteventaddontiers) | **GET** /events/{eventId}/addOns/{addOnId}/tiers | List account tiers allowed or disallowed for an add-on|
|
|
15
|
+
|[**getEventAddOns**](#geteventaddons) | **GET** /events/{eventId}/addOns | List an event\'s add-ons|
|
|
16
|
+
|[**removeEventAddOnPassType**](#removeeventaddonpasstype) | **DELETE** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} | Revoke a pass type\'s access to an add-on|
|
|
17
|
+
|[**removeEventAddOnTier**](#removeeventaddontier) | **DELETE** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} | Remove an account tier\'s access setting from an add-on|
|
|
18
|
+
|[**updateEventAddOn**](#updateeventaddon) | **PUT** /events/{eventId}/addOns/{addOnId} | Update an event add-on|
|
|
19
19
|
|
|
20
20
|
# **addEventAddOnPassType**
|
|
21
21
|
> CreateEventAddOn200Response addEventAddOnPassType()
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
Adds the given pass type to the add-on\'s allowed pass types, permitting attendees with that pass type to purchase the event add-on; requires the update permission on events.
|
|
24
24
|
|
|
25
25
|
### Example
|
|
26
26
|
|
|
@@ -77,7 +77,7 @@ const { status, data } = await apiInstance.addEventAddOnPassType(
|
|
|
77
77
|
# **addEventAddOnTier**
|
|
78
78
|
> CreateEventAddOn200Response addEventAddOnTier()
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
Adds the given account tier to the add-on\'s allowed or disallowed tier list, controlling whether members of that tier can purchase the event add-on, based on the `allowed` flag; requires the update permission on events.
|
|
81
81
|
|
|
82
82
|
### Example
|
|
83
83
|
|
|
@@ -137,7 +137,7 @@ const { status, data } = await apiInstance.addEventAddOnTier(
|
|
|
137
137
|
# **createEventAddOn**
|
|
138
138
|
> CreateEventAddOn200Response createEventAddOn(eventAddOnCreateInputs)
|
|
139
139
|
|
|
140
|
-
|
|
140
|
+
Creates a new purchasable add-on (e.g. merchandise, upgrade) for the given event; requires the update permission on events.
|
|
141
141
|
|
|
142
142
|
### Example
|
|
143
143
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.createEventAddOn(
|
|
|
192
192
|
# **deleteEventAddOn**
|
|
193
193
|
> CreateAccountInvitations200Response deleteEventAddOn()
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Permanently removes a purchasable add-on from the given event; requires the update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
|
@@ -246,7 +246,7 @@ const { status, data } = await apiInstance.deleteEventAddOn(
|
|
|
246
246
|
# **getEventAddOn**
|
|
247
247
|
> CreateEventAddOn200Response getEventAddOn()
|
|
248
248
|
|
|
249
|
-
|
|
249
|
+
Retrieves a single add-on by ID for the given event, including its pricing and configuration details; requires read access to the event\'s events module.
|
|
250
250
|
|
|
251
251
|
### Example
|
|
252
252
|
|
|
@@ -300,7 +300,7 @@ const { status, data } = await apiInstance.getEventAddOn(
|
|
|
300
300
|
# **getEventAddOnPassTypes**
|
|
301
301
|
> GetEventAddOnPassTypes200Response getEventAddOnPassTypes()
|
|
302
302
|
|
|
303
|
-
|
|
303
|
+
Returns a paginated list of the event\'s pass types (tickets) that the given add-on is available for, supporting search and ordering; requires read permission on events.
|
|
304
304
|
|
|
305
305
|
### Example
|
|
306
306
|
|
|
@@ -366,7 +366,7 @@ const { status, data } = await apiInstance.getEventAddOnPassTypes(
|
|
|
366
366
|
# **getEventAddOnPasses**
|
|
367
367
|
> GetEventAddOnPasses200Response getEventAddOnPasses()
|
|
368
368
|
|
|
369
|
-
|
|
369
|
+
Returns a paginated list of pass purchases (in needsInfo, ready, or pending status) that include the given add-on for the specified event, supporting search and ordering; requires read permission on events and attendees.
|
|
370
370
|
|
|
371
371
|
### Example
|
|
372
372
|
|
|
@@ -432,7 +432,7 @@ const { status, data } = await apiInstance.getEventAddOnPasses(
|
|
|
432
432
|
# **getEventAddOnTiers**
|
|
433
433
|
> GetAccountTiers200Response getEventAddOnTiers()
|
|
434
434
|
|
|
435
|
-
|
|
435
|
+
Returns a paginated list of account tiers that are either allowed or disallowed (per the required `allowed` flag) from purchasing the given event add-on, supporting search and ordering; requires read permission on events and tiers.
|
|
436
436
|
|
|
437
437
|
### Example
|
|
438
438
|
|
|
@@ -501,7 +501,7 @@ const { status, data } = await apiInstance.getEventAddOnTiers(
|
|
|
501
501
|
# **getEventAddOns**
|
|
502
502
|
> GetEventAddOns200Response getEventAddOns()
|
|
503
503
|
|
|
504
|
-
|
|
504
|
+
Returns a paginated list of add-ons configured for the specified event, supporting search and ordering; requires read permission on events.
|
|
505
505
|
|
|
506
506
|
### Example
|
|
507
507
|
|
|
@@ -564,7 +564,7 @@ const { status, data } = await apiInstance.getEventAddOns(
|
|
|
564
564
|
# **removeEventAddOnPassType**
|
|
565
565
|
> CreateEventAddOn200Response removeEventAddOnPassType()
|
|
566
566
|
|
|
567
|
-
|
|
567
|
+
Removes the given pass type from the add-on\'s allowed pass types, preventing attendees with that pass type from purchasing the event add-on; requires the update permission on events.
|
|
568
568
|
|
|
569
569
|
### Example
|
|
570
570
|
|
|
@@ -621,7 +621,7 @@ const { status, data } = await apiInstance.removeEventAddOnPassType(
|
|
|
621
621
|
# **removeEventAddOnTier**
|
|
622
622
|
> CreateEventAddOn200Response removeEventAddOnTier()
|
|
623
623
|
|
|
624
|
-
|
|
624
|
+
Removes the given account tier from the add-on\'s allowed or disallowed tier list (per the `allowed` flag), clearing that tier\'s explicit access rule for the event add-on; requires the update permission on events.
|
|
625
625
|
|
|
626
626
|
### Example
|
|
627
627
|
|
|
@@ -681,7 +681,7 @@ const { status, data } = await apiInstance.removeEventAddOnTier(
|
|
|
681
681
|
# **updateEventAddOn**
|
|
682
682
|
> CreateEventAddOn200Response updateEventAddOn()
|
|
683
683
|
|
|
684
|
-
|
|
684
|
+
Updates an existing add-on for an event, including its name, pricing, and related settings; if a new sortOrder is provided the other add-ons for the event are reordered around it, and this requires read and update permission on events.
|
|
685
685
|
|
|
686
686
|
### Example
|
|
687
687
|
|
|
@@ -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
|
-
|[**deleteEventAddOnTranslation**](#deleteeventaddontranslation) | **DELETE** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventAddOnTranslation**](#geteventaddontranslation) | **GET** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventAddOnTranslations**](#geteventaddontranslations) | **GET** /events/{eventId}/addOns/{addOnId}/translations |
|
|
10
|
-
|[**updateEventAddOnTranslation**](#updateeventaddontranslation) | **PUT** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventAddOnTranslation**](#deleteeventaddontranslation) | **DELETE** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Delete an event add-on translation|
|
|
8
|
+
|[**getEventAddOnTranslation**](#geteventaddontranslation) | **GET** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Get an add-on translation for a locale|
|
|
9
|
+
|[**getEventAddOnTranslations**](#geteventaddontranslations) | **GET** /events/{eventId}/addOns/{addOnId}/translations | List translations for an add-on|
|
|
10
|
+
|[**updateEventAddOnTranslation**](#updateeventaddontranslation) | **PUT** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Update an event add-on translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventAddOnTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventAddOnTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the translation for a given locale from an event add-on, reverting that locale to the add-on\'s default content; requires the update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventAddOnTranslation(
|
|
|
69
69
|
# **getEventAddOnTranslation**
|
|
70
70
|
> GetEventAddOnTranslation200Response getEventAddOnTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Retrieves the translated text for a single event add-on in the specified locale, or null if no translation exists for that locale; requires read access to the event\'s events module.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventAddOnTranslation(
|
|
|
126
126
|
# **getEventAddOnTranslations**
|
|
127
127
|
> GetEventAddOnTranslations200Response getEventAddOnTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of locale translations for the specified event add-on, supporting search and ordering; requires read access to the event\'s events module.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventAddOnTranslations(
|
|
|
192
192
|
# **updateEventAddOnTranslation**
|
|
193
193
|
> UpdateEventAddOnTranslation200Response updateEventAddOnTranslation(eventAddOnTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Creates or updates the localized content (e.g. name, description) for an event add-on in the given locale; requires the update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
package/docs/EventsApi.md
CHANGED
|
@@ -4,22 +4,24 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**cloneEvent**](#cloneevent) | **POST** /events/{eventId}/clone | Clone
|
|
8
|
-
|[**createEvent**](#createevent) | **POST** /events | Create
|
|
9
|
-
|[**deleteEvent**](#deleteevent) | **DELETE** /events/{eventId} | Delete
|
|
10
|
-
|[**
|
|
11
|
-
|[**
|
|
12
|
-
|[**
|
|
13
|
-
|[**
|
|
14
|
-
|[**
|
|
15
|
-
|[**
|
|
16
|
-
|[**
|
|
17
|
-
|[**
|
|
7
|
+
|[**cloneEvent**](#cloneevent) | **POST** /events/{eventId}/clone | Clone an event|
|
|
8
|
+
|[**createEvent**](#createevent) | **POST** /events | Create an event|
|
|
9
|
+
|[**deleteEvent**](#deleteevent) | **DELETE** /events/{eventId} | Delete an event|
|
|
10
|
+
|[**deleteEventLocation**](#deleteeventlocation) | **DELETE** /events/{eventId}/location | Delete an event\'s location|
|
|
11
|
+
|[**disableEventBuildMode**](#disableeventbuildmode) | **DELETE** /events/{eventId}/build-mode | Disable build mode for an event|
|
|
12
|
+
|[**enableEventBuildMode**](#enableeventbuildmode) | **POST** /events/{eventId}/build-mode | Enable build mode for an event|
|
|
13
|
+
|[**getEvent**](#getevent) | **GET** /events/{eventId} | Get an event|
|
|
14
|
+
|[**getEventActivities**](#geteventactivities) | **GET** /events/{eventId}/activities | List an event\'s activity feed|
|
|
15
|
+
|[**getEventPayments**](#geteventpayments) | **GET** /events/{eventId}/payments | List an event\'s payments|
|
|
16
|
+
|[**getEventTiers**](#geteventtiers) | **GET** /events/{eventId}/tiers | List an event\'s account tiers|
|
|
17
|
+
|[**getEvents**](#getevents) | **GET** /events | List events|
|
|
18
|
+
|[**setEventLocation**](#seteventlocation) | **PUT** /events/{eventId}/location | Set an event\'s location|
|
|
19
|
+
|[**updateEvent**](#updateevent) | **PUT** /events/{eventId} | Update an event|
|
|
18
20
|
|
|
19
21
|
# **cloneEvent**
|
|
20
22
|
> SyncAccounts200Response cloneEvent(cloneOptions)
|
|
21
23
|
|
|
22
|
-
|
|
24
|
+
Creates a new event as a copy of an existing one, using the given name and start date and letting the caller select which related resources (such as pass types, packages, add-ons, tracks, sessions, and onsite settings) are copied over; requires the create events permission.
|
|
23
25
|
|
|
24
26
|
### Example
|
|
25
27
|
|
|
@@ -74,7 +76,7 @@ const { status, data } = await apiInstance.cloneEvent(
|
|
|
74
76
|
# **createEvent**
|
|
75
77
|
> CreateEvent200Response createEvent(eventCreateInputs)
|
|
76
78
|
|
|
77
|
-
|
|
79
|
+
Creates a new event for the organization from the given details, requiring the create events permission.
|
|
78
80
|
|
|
79
81
|
### Example
|
|
80
82
|
|
|
@@ -126,7 +128,7 @@ const { status, data } = await apiInstance.createEvent(
|
|
|
126
128
|
# **deleteEvent**
|
|
127
129
|
> CreateAccountInvitations200Response deleteEvent()
|
|
128
130
|
|
|
129
|
-
|
|
131
|
+
Permanently deletes the given event and its associated data, requiring the delete events permission.
|
|
130
132
|
|
|
131
133
|
### Example
|
|
132
134
|
|
|
@@ -167,6 +169,57 @@ const { status, data } = await apiInstance.deleteEvent(
|
|
|
167
169
|
- **Accept**: application/json
|
|
168
170
|
|
|
169
171
|
|
|
172
|
+
### HTTP response details
|
|
173
|
+
| Status code | Description | Response headers |
|
|
174
|
+
|-------------|-------------|------------------|
|
|
175
|
+
|**200** | Successful response | - |
|
|
176
|
+
|
|
177
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
178
|
+
|
|
179
|
+
# **deleteEventLocation**
|
|
180
|
+
> CreateEvent200Response deleteEventLocation()
|
|
181
|
+
|
|
182
|
+
Clears the location details of an existing event, requiring the update events permission.
|
|
183
|
+
|
|
184
|
+
### Example
|
|
185
|
+
|
|
186
|
+
```typescript
|
|
187
|
+
import {
|
|
188
|
+
EventsApi,
|
|
189
|
+
Configuration
|
|
190
|
+
} from '@connectedxm/admin-sdk';
|
|
191
|
+
|
|
192
|
+
const configuration = new Configuration();
|
|
193
|
+
const apiInstance = new EventsApi(configuration);
|
|
194
|
+
|
|
195
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
196
|
+
|
|
197
|
+
const { status, data } = await apiInstance.deleteEventLocation(
|
|
198
|
+
eventId
|
|
199
|
+
);
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Parameters
|
|
203
|
+
|
|
204
|
+
|Name | Type | Description | Notes|
|
|
205
|
+
|------------- | ------------- | ------------- | -------------|
|
|
206
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
### Return type
|
|
210
|
+
|
|
211
|
+
**CreateEvent200Response**
|
|
212
|
+
|
|
213
|
+
### Authorization
|
|
214
|
+
|
|
215
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
216
|
+
|
|
217
|
+
### HTTP request headers
|
|
218
|
+
|
|
219
|
+
- **Content-Type**: Not defined
|
|
220
|
+
- **Accept**: application/json
|
|
221
|
+
|
|
222
|
+
|
|
170
223
|
### HTTP response details
|
|
171
224
|
| Status code | Description | Response headers |
|
|
172
225
|
|-------------|-------------|------------------|
|
|
@@ -177,7 +230,7 @@ const { status, data } = await apiInstance.deleteEvent(
|
|
|
177
230
|
# **disableEventBuildMode**
|
|
178
231
|
> SyncAccounts200Response disableEventBuildMode()
|
|
179
232
|
|
|
180
|
-
|
|
233
|
+
Turns off build mode for an event ahead of its scheduled expiration, restoring normal access restrictions; requires the update events permission.
|
|
181
234
|
|
|
182
235
|
### Example
|
|
183
236
|
|
|
@@ -228,7 +281,7 @@ const { status, data } = await apiInstance.disableEventBuildMode(
|
|
|
228
281
|
# **enableEventBuildMode**
|
|
229
282
|
> SyncAccounts200Response enableEventBuildMode()
|
|
230
283
|
|
|
231
|
-
|
|
284
|
+
Temporarily puts an event into build mode for 2 hours, allowing editing access while it is being configured, and returns the timestamp when build mode expires; requires the update events permission.
|
|
232
285
|
|
|
233
286
|
### Example
|
|
234
287
|
|
|
@@ -279,7 +332,7 @@ const { status, data } = await apiInstance.enableEventBuildMode(
|
|
|
279
332
|
# **getEvent**
|
|
280
333
|
> CreateEvent200Response getEvent()
|
|
281
334
|
|
|
282
|
-
|
|
335
|
+
Retrieves the full details of a single event by ID or slug; requires read permission on events.
|
|
283
336
|
|
|
284
337
|
### Example
|
|
285
338
|
|
|
@@ -330,7 +383,7 @@ const { status, data } = await apiInstance.getEvent(
|
|
|
330
383
|
# **getEventActivities**
|
|
331
384
|
> GetAccountActivities200Response getEventActivities()
|
|
332
385
|
|
|
333
|
-
|
|
386
|
+
Returns a paginated list of activities associated with the given event, filterable by featured flag and activity status, and supporting search and ordering; requires read permission on events and activities.
|
|
334
387
|
|
|
335
388
|
### Example
|
|
336
389
|
|
|
@@ -399,7 +452,7 @@ const { status, data } = await apiInstance.getEventActivities(
|
|
|
399
452
|
# **getEventPayments**
|
|
400
453
|
> GetAccountPayments200Response getEventPayments()
|
|
401
454
|
|
|
402
|
-
|
|
455
|
+
Returns a paginated list of payments made for the given event, optionally filtered by a search term matching the paying account\'s email or name and sorted via orderBy; requires \"read\" permission on events and payments.
|
|
403
456
|
|
|
404
457
|
### Example
|
|
405
458
|
|
|
@@ -462,7 +515,7 @@ const { status, data } = await apiInstance.getEventPayments(
|
|
|
462
515
|
# **getEventTiers**
|
|
463
516
|
> GetEventTiers200Response getEventTiers()
|
|
464
517
|
|
|
465
|
-
|
|
518
|
+
Returns the account tiers associated with the given event through its tickets, add-ons, and room types (including tiers that are explicitly disallowed for those items); requires \"read\" permission on events and accounts.
|
|
466
519
|
|
|
467
520
|
### Example
|
|
468
521
|
|
|
@@ -513,7 +566,7 @@ const { status, data } = await apiInstance.getEventTiers(
|
|
|
513
566
|
# **getEvents**
|
|
514
567
|
> GetEvents200Response getEvents()
|
|
515
568
|
|
|
516
|
-
|
|
569
|
+
Returns a paginated list of the organization\'s events, excluding templates, with optional filters for past vs. upcoming events, featured status, and a search term, plus sorting via orderBy; requires \"read\" permission on events.
|
|
517
570
|
|
|
518
571
|
### Example
|
|
519
572
|
|
|
@@ -569,6 +622,61 @@ const { status, data } = await apiInstance.getEvents(
|
|
|
569
622
|
- **Accept**: application/json
|
|
570
623
|
|
|
571
624
|
|
|
625
|
+
### HTTP response details
|
|
626
|
+
| Status code | Description | Response headers |
|
|
627
|
+
|-------------|-------------|------------------|
|
|
628
|
+
|**200** | Successful response | - |
|
|
629
|
+
|
|
630
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
631
|
+
|
|
632
|
+
# **setEventLocation**
|
|
633
|
+
> CreateEvent200Response setEventLocation(eventLocationInputs)
|
|
634
|
+
|
|
635
|
+
Sets or updates the location details of an existing event, requiring the update events permission.
|
|
636
|
+
|
|
637
|
+
### Example
|
|
638
|
+
|
|
639
|
+
```typescript
|
|
640
|
+
import {
|
|
641
|
+
EventsApi,
|
|
642
|
+
Configuration,
|
|
643
|
+
EventLocationInputs
|
|
644
|
+
} from '@connectedxm/admin-sdk';
|
|
645
|
+
|
|
646
|
+
const configuration = new Configuration();
|
|
647
|
+
const apiInstance = new EventsApi(configuration);
|
|
648
|
+
|
|
649
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
650
|
+
let eventLocationInputs: EventLocationInputs; //
|
|
651
|
+
|
|
652
|
+
const { status, data } = await apiInstance.setEventLocation(
|
|
653
|
+
eventId,
|
|
654
|
+
eventLocationInputs
|
|
655
|
+
);
|
|
656
|
+
```
|
|
657
|
+
|
|
658
|
+
### Parameters
|
|
659
|
+
|
|
660
|
+
|Name | Type | Description | Notes|
|
|
661
|
+
|------------- | ------------- | ------------- | -------------|
|
|
662
|
+
| **eventLocationInputs** | **EventLocationInputs**| | |
|
|
663
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
### Return type
|
|
667
|
+
|
|
668
|
+
**CreateEvent200Response**
|
|
669
|
+
|
|
670
|
+
### Authorization
|
|
671
|
+
|
|
672
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
673
|
+
|
|
674
|
+
### HTTP request headers
|
|
675
|
+
|
|
676
|
+
- **Content-Type**: application/json
|
|
677
|
+
- **Accept**: application/json
|
|
678
|
+
|
|
679
|
+
|
|
572
680
|
### HTTP response details
|
|
573
681
|
| Status code | Description | Response headers |
|
|
574
682
|
|-------------|-------------|------------------|
|
|
@@ -579,7 +687,7 @@ const { status, data } = await apiInstance.getEvents(
|
|
|
579
687
|
# **updateEvent**
|
|
580
688
|
> CreateEvent200Response updateEvent(eventUpdateInputs)
|
|
581
689
|
|
|
582
|
-
|
|
690
|
+
Updates the details of an existing event with the given fields, requiring the update events permission.
|
|
583
691
|
|
|
584
692
|
### Example
|
|
585
693
|
|
|
@@ -4,23 +4,23 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createEventAttendee**](#createeventattendee) | **POST** /events/{eventId}/attendees |
|
|
8
|
-
|[**deleteEventAttendee**](#deleteeventattendee) | **DELETE** /events/{eventId}/attendees/{accountId} | Delete
|
|
9
|
-
|[**getEventAttendee**](#geteventattendee) | **GET** /events/{eventId}/attendees/{accountId} | Get
|
|
10
|
-
|[**getEventAttendeeCoupons**](#geteventattendeecoupons) | **GET** /events/{eventId}/attendees/{accountId}/coupons |
|
|
11
|
-
|[**getEventAttendeePasses**](#geteventattendeepasses) | **GET** /events/{eventId}/attendees/{accountId}/passes |
|
|
12
|
-
|[**getEventAttendeePayments**](#geteventattendeepayments) | **GET** /events/{eventId}/attendees/{accountId}/payments |
|
|
13
|
-
|[**getEventAttendeeTransfersLogs**](#geteventattendeetransferslogs) | **GET** /events/{eventId}/attendees/{accountId}/transfers/logs |
|
|
14
|
-
|[**getEventAttendees**](#geteventattendees) | **GET** /events/{eventId}/attendees |
|
|
15
|
-
|[**getEventPassAttendeePasses**](#geteventpassattendeepasses) | **GET** /events/{eventId}/passes/{passId}/attendee/passes |
|
|
16
|
-
|[**resendRegistrationConfirmationEmail**](#resendregistrationconfirmationemail) | **POST** /events/{eventId}/attendees/{accountId}/resendEmail | Resend
|
|
17
|
-
|[**syncEventAttendees**](#synceventattendees) | **POST** /events/{eventId}/attendees/sync | Sync
|
|
18
|
-
|[**updateEventAttendee**](#updateeventattendee) | **PUT** /events/{eventId}/attendees/{accountId} | Update
|
|
7
|
+
|[**createEventAttendee**](#createeventattendee) | **POST** /events/{eventId}/attendees | Register an account as an event attendee|
|
|
8
|
+
|[**deleteEventAttendee**](#deleteeventattendee) | **DELETE** /events/{eventId}/attendees/{accountId} | Delete an event attendee\'s registration|
|
|
9
|
+
|[**getEventAttendee**](#geteventattendee) | **GET** /events/{eventId}/attendees/{accountId} | Get an event attendee\'s registration|
|
|
10
|
+
|[**getEventAttendeeCoupons**](#geteventattendeecoupons) | **GET** /events/{eventId}/attendees/{accountId}/coupons | List an event attendee\'s coupons|
|
|
11
|
+
|[**getEventAttendeePasses**](#geteventattendeepasses) | **GET** /events/{eventId}/attendees/{accountId}/passes | List an event attendee\'s pass purchases|
|
|
12
|
+
|[**getEventAttendeePayments**](#geteventattendeepayments) | **GET** /events/{eventId}/attendees/{accountId}/payments | List an event attendee\'s payments|
|
|
13
|
+
|[**getEventAttendeeTransfersLogs**](#geteventattendeetransferslogs) | **GET** /events/{eventId}/attendees/{accountId}/transfers/logs | List an attendee\'s pass transfer logs|
|
|
14
|
+
|[**getEventAttendees**](#geteventattendees) | **GET** /events/{eventId}/attendees | List an event\'s attendees|
|
|
15
|
+
|[**getEventPassAttendeePasses**](#geteventpassattendeepasses) | **GET** /events/{eventId}/passes/{passId}/attendee/passes | List attendee purchases of an event pass|
|
|
16
|
+
|[**resendRegistrationConfirmationEmail**](#resendregistrationconfirmationemail) | **POST** /events/{eventId}/attendees/{accountId}/resendEmail | Resend registration confirmation email|
|
|
17
|
+
|[**syncEventAttendees**](#synceventattendees) | **POST** /events/{eventId}/attendees/sync | Sync an event\'s attendees to accounts|
|
|
18
|
+
|[**updateEventAttendee**](#updateeventattendee) | **PUT** /events/{eventId}/attendees/{accountId} | Update an event attendee\'s registration|
|
|
19
19
|
|
|
20
20
|
# **createEventAttendee**
|
|
21
21
|
> CreateEventAttendee200Response createEventAttendee(eventAttendeeCreateInputs)
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
Creates a new registration linking an existing account to an event, effectively making that account an attendee of the event, requiring read and create permission on attendees.
|
|
24
24
|
|
|
25
25
|
### Example
|
|
26
26
|
|
|
@@ -75,7 +75,7 @@ const { status, data } = await apiInstance.createEventAttendee(
|
|
|
75
75
|
# **deleteEventAttendee**
|
|
76
76
|
> CreateEventAttendee200Response deleteEventAttendee()
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
Permanently deletes the registration record for the given account at the given event, removing them from the attendee list; requires the \"del\" permission on attendees.
|
|
79
79
|
|
|
80
80
|
### Example
|
|
81
81
|
|
|
@@ -129,7 +129,7 @@ const { status, data } = await apiInstance.deleteEventAttendee(
|
|
|
129
129
|
# **getEventAttendee**
|
|
130
130
|
> CreateEventAttendee200Response getEventAttendee()
|
|
131
131
|
|
|
132
|
-
|
|
132
|
+
Returns the registration details for a single attendee (account) of the given event, including their pass/purchase history; requires \"read\" permission on events and attendees.
|
|
133
133
|
|
|
134
134
|
### Example
|
|
135
135
|
|
|
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getEventAttendee(
|
|
|
183
183
|
# **getEventAttendeeCoupons**
|
|
184
184
|
> GetEventAttendeeCoupons200Response getEventAttendeeCoupons()
|
|
185
185
|
|
|
186
|
-
|
|
186
|
+
Returns a paginated list of coupons associated with a specific attendee\'s registration for an event, optionally filtered by paid/prePaid status, search term, and sort order; requires \"read\" permission on events and attendees.
|
|
187
187
|
|
|
188
188
|
### Example
|
|
189
189
|
|
|
@@ -252,7 +252,7 @@ const { status, data } = await apiInstance.getEventAttendeeCoupons(
|
|
|
252
252
|
# **getEventAttendeePasses**
|
|
253
253
|
> GetEventAddOnPasses200Response getEventAttendeePasses()
|
|
254
254
|
|
|
255
|
-
|
|
255
|
+
Returns a paginated list of pass purchases belonging to a specific attendee\'s registration for an event, optionally filtered by purchase status, search term, and sort order; requires \"read\" permission on events and attendees.
|
|
256
256
|
|
|
257
257
|
### Example
|
|
258
258
|
|
|
@@ -321,7 +321,7 @@ const { status, data } = await apiInstance.getEventAttendeePasses(
|
|
|
321
321
|
# **getEventAttendeePayments**
|
|
322
322
|
> GetAccountPayments200Response getEventAttendeePayments()
|
|
323
323
|
|
|
324
|
-
|
|
324
|
+
Returns a paginated list of payments made by a specific attendee for their event registration, with optional search and sort order; requires \"read\" permission on events, attendees, and payments.
|
|
325
325
|
|
|
326
326
|
### Example
|
|
327
327
|
|
|
@@ -387,7 +387,7 @@ const { status, data } = await apiInstance.getEventAttendeePayments(
|
|
|
387
387
|
# **getEventAttendeeTransfersLogs**
|
|
388
388
|
> GetEventAttendeeTransfersLogs200Response getEventAttendeeTransfersLogs()
|
|
389
389
|
|
|
390
|
-
|
|
390
|
+
Returns a paginated log of pass transfer activity (e.g. ownership changes) for a specific attendee\'s registration on an event, with optional search and sort order; requires \"read\" permission on events and attendees.
|
|
391
391
|
|
|
392
392
|
### Example
|
|
393
393
|
|
|
@@ -453,7 +453,7 @@ const { status, data } = await apiInstance.getEventAttendeeTransfersLogs(
|
|
|
453
453
|
# **getEventAttendees**
|
|
454
454
|
> GetAccountRegistrations200Response getEventAttendees()
|
|
455
455
|
|
|
456
|
-
|
|
456
|
+
Returns a paginated list of registered attendees for the given event, optionally filtered by purchase status and search term; requires \"read\" permission on events and attendees.
|
|
457
457
|
|
|
458
458
|
### Example
|
|
459
459
|
|
|
@@ -519,7 +519,7 @@ const { status, data } = await apiInstance.getEventAttendees(
|
|
|
519
519
|
# **getEventPassAttendeePasses**
|
|
520
520
|
> GetEventAddOnPasses200Response getEventPassAttendeePasses()
|
|
521
521
|
|
|
522
|
-
|
|
522
|
+
Returns a paginated list of attendee pass purchases for a specific event pass, optionally filtered by purchase status and search term; requires \"read\" permission on events and attendees.
|
|
523
523
|
|
|
524
524
|
### Example
|
|
525
525
|
|
|
@@ -588,7 +588,7 @@ const { status, data } = await apiInstance.getEventPassAttendeePasses(
|
|
|
588
588
|
# **resendRegistrationConfirmationEmail**
|
|
589
589
|
> CreateAccountInvitations200Response resendRegistrationConfirmationEmail()
|
|
590
590
|
|
|
591
|
-
|
|
591
|
+
Re-triggers the registration confirmation email for the given account\'s registration at the given event by replaying the \"registration.submitted\" side effect; requires the \"update\" permission on attendees.
|
|
592
592
|
|
|
593
593
|
### Example
|
|
594
594
|
|
|
@@ -642,7 +642,7 @@ const { status, data } = await apiInstance.resendRegistrationConfirmationEmail(
|
|
|
642
642
|
# **syncEventAttendees**
|
|
643
643
|
> SyncAccounts200Response syncEventAttendees()
|
|
644
644
|
|
|
645
|
-
|
|
645
|
+
Enqueues every attendee account registered for the given event for a background account-data sync job and returns the number of accounts enqueued; requires the \"read\" permission on attendees and \"update\" permission on accounts.
|
|
646
646
|
|
|
647
647
|
### Example
|
|
648
648
|
|
|
@@ -693,7 +693,7 @@ const { status, data } = await apiInstance.syncEventAttendees(
|
|
|
693
693
|
# **updateEventAttendee**
|
|
694
694
|
> CreateEventAttendee200Response updateEventAttendee(body)
|
|
695
695
|
|
|
696
|
-
|
|
696
|
+
Updates the registration record for the given account at the given event with the supplied fields, such as coupon or custom registration data; requires the \"update\" permission on attendees.
|
|
697
697
|
|
|
698
698
|
### Example
|
|
699
699
|
|
|
@@ -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
|
-
|[**createEventAttendeePackage**](#createeventattendeepackage) | **POST** /events/{eventId}/attendees/{accountId}/packages | Create
|
|
8
|
-
|[**deleteEventAttendeePackage**](#deleteeventattendeepackage) | **DELETE** /events/{eventId}/attendees/{accountId}/packages/{packageId} | Delete
|
|
9
|
-
|[**getEventAttendeePackage**](#geteventattendeepackage) | **GET** /events/{eventId}/attendees/{accountId}/packages/{packageId} | Get
|
|
10
|
-
|[**getEventAttendeePackages**](#geteventattendeepackages) | **GET** /events/{eventId}/attendees/{accountId}/packages |
|
|
11
|
-
|[**updateEventAttendeePackage**](#updateeventattendeepackage) | **PUT** /events/{eventId}/attendees/{accountId}/packages/{packageId} | Update
|
|
7
|
+
|[**createEventAttendeePackage**](#createeventattendeepackage) | **POST** /events/{eventId}/attendees/{accountId}/packages | Create a package for an event attendee|
|
|
8
|
+
|[**deleteEventAttendeePackage**](#deleteeventattendeepackage) | **DELETE** /events/{eventId}/attendees/{accountId}/packages/{packageId} | Delete an event attendee\'s package|
|
|
9
|
+
|[**getEventAttendeePackage**](#geteventattendeepackage) | **GET** /events/{eventId}/attendees/{accountId}/packages/{packageId} | Get an attendee\'s event package|
|
|
10
|
+
|[**getEventAttendeePackages**](#geteventattendeepackages) | **GET** /events/{eventId}/attendees/{accountId}/packages | List an attendee\'s event packages|
|
|
11
|
+
|[**updateEventAttendeePackage**](#updateeventattendeepackage) | **PUT** /events/{eventId}/attendees/{accountId}/packages/{packageId} | Update an event attendee\'s package|
|
|
12
12
|
|
|
13
13
|
# **createEventAttendeePackage**
|
|
14
14
|
> CreateEventAttendeePackage200Response createEventAttendeePackage()
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new attendee package (e.g. a bundled add-on/room package purchase) for the given account\'s registration at an event, requiring read and update permission on attendees.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -71,7 +71,7 @@ const { status, data } = await apiInstance.createEventAttendeePackage(
|
|
|
71
71
|
# **deleteEventAttendeePackage**
|
|
72
72
|
> SyncAccounts200Response deleteEventAttendeePackage()
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
Permanently deletes a specific attendee package purchase belonging to an account\'s registration at an event, requiring read and update permission on attendees.
|
|
75
75
|
|
|
76
76
|
### Example
|
|
77
77
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.deleteEventAttendeePackage(
|
|
|
128
128
|
# **getEventAttendeePackage**
|
|
129
129
|
> CreateEventAttendeePackage200Response getEventAttendeePackage()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Returns a single package purchased by the given attendee (account) for the specified event, identified by packageId; requires read permission on events and attendees.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -185,7 +185,7 @@ const { status, data } = await apiInstance.getEventAttendeePackage(
|
|
|
185
185
|
# **getEventAttendeePackages**
|
|
186
186
|
> GetEventAttendeePackages200Response getEventAttendeePackages()
|
|
187
187
|
|
|
188
|
-
|
|
188
|
+
Returns a paginated list of packages purchased by the given attendee (account) for the specified event, optionally filtered by purchase status, with search and ordering support; requires read permission on events and attendees.
|
|
189
189
|
|
|
190
190
|
### Example
|
|
191
191
|
|
|
@@ -254,7 +254,7 @@ const { status, data } = await apiInstance.getEventAttendeePackages(
|
|
|
254
254
|
# **updateEventAttendeePackage**
|
|
255
255
|
> CreateEventAttendeePackage200Response updateEventAttendeePackage()
|
|
256
256
|
|
|
257
|
-
|
|
257
|
+
Updates the details of an existing attendee package purchase for an account\'s registration at an event, requiring read and update permission on attendees.
|
|
258
258
|
|
|
259
259
|
### Example
|
|
260
260
|
|