@connectedxm/admin-sdk 7.4.1 → 7.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1212 -1209
- package/api.ts +10059 -9672
- package/dist/api.d.ts +9869 -9672
- package/dist/api.js +9948 -9672
- package/dist/esm/api.d.ts +9869 -9672
- package/dist/esm/api.js +9948 -9672
- package/docs/AccountsAddressesApi.md +10 -10
- package/docs/AccountsApi.md +42 -42
- package/docs/AccountsFollowersApi.md +6 -6
- package/docs/AccountsFollowingApi.md +6 -6
- package/docs/AccountsGroupsApi.md +6 -6
- package/docs/AccountsInterestsApi.md +6 -6
- package/docs/AccountsInvitationsApi.md +6 -6
- package/docs/AccountsLeadsApi.md +8 -8
- package/docs/AccountsTiersApi.md +8 -8
- package/docs/ActivitiesApi.md +18 -18
- package/docs/ActivitiesScheduleApi.md +4 -4
- package/docs/AdvertisementsApi.md +14 -14
- package/docs/AnnouncementsApi.md +16 -16
- package/docs/AnnouncementsScheduleApi.md +4 -4
- package/docs/AnnouncementsTranslationsApi.md +8 -8
- package/docs/ApiLogsApi.md +4 -4
- package/docs/AuthSessionsApi.md +4 -4
- package/docs/BenefitsApi.md +12 -12
- package/docs/BenefitsTranslationsApi.md +8 -8
- package/docs/BookingsApi.md +56 -56
- package/docs/BookingsAvailabilitiesApi.md +6 -6
- package/docs/BookingsBlackoutsApi.md +6 -6
- package/docs/BookingsPlacesApi.md +6 -6
- package/docs/BookingsPlacesTranslationsApi.md +4 -4
- package/docs/BookingsQuestionsApi.md +16 -16
- package/docs/BookingsQuestionsChoicesApi.md +12 -12
- package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
- package/docs/BookingsQuestionsTranslationsApi.md +8 -8
- package/docs/BookingsSpacesApi.md +6 -6
- package/docs/BookingsSpacesTranslationsApi.md +4 -4
- package/docs/ChannelsApi.md +58 -58
- package/docs/ChannelsTranslationsApi.md +24 -24
- package/docs/Coupon.md +4 -0
- package/docs/DashboardsApi.md +10 -10
- package/docs/DashboardsWidgetsApi.md +8 -8
- package/docs/EmailReceiptsApi.md +4 -4
- package/docs/EventsAccessApi.md +6 -6
- package/docs/EventsActivationsApi.md +22 -22
- package/docs/EventsActivationsSessionsApi.md +6 -6
- package/docs/EventsActivationsTranslationsApi.md +8 -8
- package/docs/EventsAddonsApi.md +24 -24
- package/docs/EventsAddonsTranslationsApi.md +8 -8
- package/docs/EventsApi.md +22 -22
- package/docs/EventsAttendeesApi.md +24 -24
- package/docs/EventsAttendeesPackagesApi.md +10 -10
- package/docs/EventsAttendeesReservationsApi.md +18 -18
- package/docs/EventsAttributesApi.md +10 -10
- package/docs/EventsBenefitsApi.md +4 -4
- package/docs/EventsBlocksApi.md +16 -16
- package/docs/EventsBypassApi.md +10 -10
- package/docs/EventsCohostsApi.md +6 -6
- package/docs/EventsCouponsApi.md +214 -22
- package/docs/EventsEmailsApi.md +4 -4
- package/docs/EventsEmailsTranslationsApi.md +8 -8
- package/docs/EventsFaqsApi.md +22 -22
- package/docs/EventsFaqsTranslationsApi.md +16 -16
- package/docs/EventsFollowupsApi.md +38 -38
- package/docs/EventsFollowupsTranslationsApi.md +8 -8
- package/docs/EventsMatchesApi.md +34 -34
- package/docs/EventsMediaApi.md +16 -16
- package/docs/EventsMediaTranslationsApi.md +8 -8
- package/docs/EventsOnSiteApi.md +6 -6
- package/docs/EventsPackagesApi.md +10 -10
- package/docs/EventsPackagesPassesApi.md +10 -10
- package/docs/EventsPackagesTranslationsApi.md +8 -8
- package/docs/EventsPagesApi.md +16 -16
- package/docs/EventsPagesTranslationsApi.md +8 -8
- package/docs/EventsPassesAccessesApi.md +10 -10
- package/docs/EventsPassesAddonsApi.md +6 -6
- package/docs/EventsPassesApi.md +34 -34
- package/docs/EventsPassesAttributesApi.md +6 -6
- package/docs/EventsPassesFollowupsApi.md +8 -8
- package/docs/EventsPassesResponsesApi.md +10 -10
- package/docs/EventsPasstypesApi.md +34 -34
- package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
- package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
- package/docs/EventsPasstypesTranslationsApi.md +8 -8
- package/docs/EventsQuestionsApi.md +44 -44
- package/docs/EventsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsRoomsApi.md +18 -18
- package/docs/EventsRoomtypesApi.md +24 -24
- package/docs/EventsRoomtypesTranslationsApi.md +8 -8
- package/docs/EventsSectionsApi.md +38 -38
- package/docs/EventsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsAccessesApi.md +6 -6
- package/docs/EventsSessionsApi.md +70 -70
- package/docs/EventsSessionsLocationsApi.md +16 -16
- package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
- package/docs/EventsSessionsMatchesApi.md +32 -32
- package/docs/EventsSessionsPricesApi.md +6 -6
- package/docs/EventsSessionsQuestionsApi.md +38 -38
- package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsSessionsSectionsApi.md +20 -20
- package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsTimesApi.md +16 -16
- package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
- package/docs/EventsSessionsTranslationsApi.md +8 -8
- package/docs/EventsSpeakersApi.md +16 -16
- package/docs/EventsSpeakersTranslationsApi.md +8 -8
- package/docs/EventsSponsorsApi.md +8 -8
- package/docs/EventsSponsorshiplevelsApi.md +12 -12
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
- package/docs/EventsSponsorshipsApi.md +12 -12
- package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
- package/docs/EventsTemplatesApi.md +2 -2
- package/docs/EventsTracksApi.md +22 -22
- package/docs/EventsTracksTranslationsApi.md +8 -8
- package/docs/EventsTransfersApi.md +4 -4
- package/docs/EventsTranslationsApi.md +8 -8
- package/docs/FilesApi.md +4 -4
- package/docs/GroupsApi.md +12 -12
- package/docs/GroupsEventsApi.md +6 -6
- package/docs/GroupsInterestsApi.md +6 -6
- package/docs/GroupsInvitationsApi.md +12 -12
- package/docs/GroupsMembersApi.md +8 -8
- package/docs/GroupsModeratorsApi.md +6 -6
- package/docs/GroupsRequestsApi.md +10 -10
- package/docs/GroupsSponsorsApi.md +6 -6
- package/docs/GroupsTranslationsApi.md +8 -8
- package/docs/ImportsApi.md +8 -8
- package/docs/InterestsApi.md +22 -22
- package/docs/InvoicesApi.md +20 -20
- package/docs/InvoicesLineitemsApi.md +6 -6
- package/docs/LoginsAccountsApi.md +6 -6
- package/docs/LoginsApi.md +16 -16
- package/docs/MeetingsApi.md +14 -14
- package/docs/MeetingsLinksApi.md +10 -10
- package/docs/MeetingsLivestreamsApi.md +12 -12
- package/docs/MeetingsParticipantsApi.md +12 -12
- package/docs/MeetingsPresetsApi.md +10 -10
- package/docs/MeetingsRecordingsApi.md +4 -4
- package/docs/MeetingsSessionsApi.md +16 -16
- package/docs/NotificationsApi.md +8 -8
- package/docs/OrganizationApi.md +18 -18
- package/docs/OrganizationAttributesApi.md +14 -14
- package/docs/OrganizationDomainsApi.md +6 -6
- package/docs/OrganizationIntegrationsApi.md +10 -10
- package/docs/OrganizationModulesApi.md +6 -6
- package/docs/OrganizationModulesCustomApi.md +10 -10
- package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
- package/docs/OrganizationModulesSettingsApi.md +4 -4
- package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
- package/docs/OrganizationModulesTiersApi.md +12 -12
- package/docs/OrganizationPaymentsApi.md +20 -20
- package/docs/OrganizationSideeffectsApi.md +8 -8
- package/docs/OrganizationTaxApi.md +22 -22
- package/docs/OrganizationTeammembersApi.md +10 -10
- package/docs/OrganizationUsersApi.md +6 -6
- package/docs/OrganizationWebhooksApi.md +12 -12
- package/docs/PaymentsApi.md +2 -2
- package/docs/PreferencesApi.md +4 -4
- package/docs/PushDevicesApi.md +6 -6
- package/docs/ReportsApi.md +22 -22
- package/docs/ReportsUsersApi.md +6 -6
- package/docs/SearchlistsApi.md +10 -10
- package/docs/SearchlistsValuesApi.md +14 -14
- package/docs/SelfApi.md +10 -10
- package/docs/SelfApikeysApi.md +8 -8
- package/docs/SelfImagesApi.md +4 -4
- package/docs/SeriesApi.md +18 -18
- package/docs/SeriesQuestionsApi.md +14 -14
- package/docs/SeriesQuestionsChoicesApi.md +8 -8
- package/docs/SeriesQuestionsTranslationsApi.md +4 -4
- package/docs/SeriesRegistrationsApi.md +18 -18
- package/docs/SeriesTranslationsApi.md +8 -8
- package/docs/SponsorsAccountsApi.md +6 -6
- package/docs/SponsorsApi.md +10 -10
- package/docs/SponsorsTranslationsApi.md +8 -8
- package/docs/StorageFilesApi.md +6 -6
- package/docs/StorageImagesApi.md +18 -18
- package/docs/StorageVideosApi.md +14 -14
- package/docs/StorageVideosCaptionsApi.md +10 -10
- package/docs/StreamsApi.md +14 -14
- package/docs/StreamsOutputsApi.md +10 -10
- package/docs/StreamsSessionsApi.md +12 -12
- package/docs/SupportApi.md +14 -14
- package/docs/SupportMessagesApi.md +4 -4
- package/docs/SupportNotesApi.md +6 -6
- package/docs/SurveysApi.md +12 -12
- package/docs/SurveysQuestionsApi.md +38 -38
- package/docs/SurveysQuestionsTranslationsApi.md +16 -16
- package/docs/SurveysSectionsApi.md +20 -20
- package/docs/SurveysSectionsTranslationsApi.md +8 -8
- package/docs/SurveysSessionsApi.md +4 -4
- package/docs/SurveysSubmissionsApi.md +14 -14
- package/docs/SurveysTranslationsApi.md +8 -8
- package/docs/ThreadsAccountsApi.md +8 -8
- package/docs/ThreadsApi.md +10 -10
- package/docs/ThreadsMessagesApi.md +12 -12
- package/docs/ThreadsMessagesFilesApi.md +6 -6
- package/docs/ThreadsMessagesImagesApi.md +6 -6
- package/docs/ThreadsMessagesReactionsApi.md +6 -6
- package/docs/ThreadsMessagesVideosApi.md +6 -6
- package/docs/ThreadsStorageApi.md +6 -6
- package/docs/TiersApi.md +20 -20
- package/package.json +1 -1
package/docs/EventsApi.md
CHANGED
|
@@ -4,22 +4,22 @@ 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
|
-
|[**disableEventBuildMode**](#disableeventbuildmode) | **DELETE** /events/{eventId}/build-mode | Disable
|
|
11
|
-
|[**enableEventBuildMode**](#enableeventbuildmode) | **POST** /events/{eventId}/build-mode | Enable
|
|
12
|
-
|[**getEvent**](#getevent) | **GET** /events/{eventId} | Get
|
|
13
|
-
|[**getEventActivities**](#geteventactivities) | **GET** /events/{eventId}/activities |
|
|
14
|
-
|[**getEventPayments**](#geteventpayments) | **GET** /events/{eventId}/payments |
|
|
15
|
-
|[**getEventTiers**](#geteventtiers) | **GET** /events/{eventId}/tiers |
|
|
16
|
-
|[**getEvents**](#getevents) | **GET** /events |
|
|
17
|
-
|[**updateEvent**](#updateevent) | **PUT** /events/{eventId} | Update
|
|
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
|
+
|[**disableEventBuildMode**](#disableeventbuildmode) | **DELETE** /events/{eventId}/build-mode | Disable build mode for an event|
|
|
11
|
+
|[**enableEventBuildMode**](#enableeventbuildmode) | **POST** /events/{eventId}/build-mode | Enable build mode for an event|
|
|
12
|
+
|[**getEvent**](#getevent) | **GET** /events/{eventId} | Get an event|
|
|
13
|
+
|[**getEventActivities**](#geteventactivities) | **GET** /events/{eventId}/activities | List an event\'s activity feed|
|
|
14
|
+
|[**getEventPayments**](#geteventpayments) | **GET** /events/{eventId}/payments | List an event\'s payments|
|
|
15
|
+
|[**getEventTiers**](#geteventtiers) | **GET** /events/{eventId}/tiers | List an event\'s account tiers|
|
|
16
|
+
|[**getEvents**](#getevents) | **GET** /events | List events|
|
|
17
|
+
|[**updateEvent**](#updateevent) | **PUT** /events/{eventId} | Update an event|
|
|
18
18
|
|
|
19
19
|
# **cloneEvent**
|
|
20
20
|
> SyncAccounts200Response cloneEvent(cloneOptions)
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
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
23
|
|
|
24
24
|
### Example
|
|
25
25
|
|
|
@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.cloneEvent(
|
|
|
74
74
|
# **createEvent**
|
|
75
75
|
> CreateEvent200Response createEvent(eventCreateInputs)
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
Creates a new event for the organization from the given details, requiring the create events permission.
|
|
78
78
|
|
|
79
79
|
### Example
|
|
80
80
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.createEvent(
|
|
|
126
126
|
# **deleteEvent**
|
|
127
127
|
> CreateAccountInvitations200Response deleteEvent()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Permanently deletes the given event and its associated data, requiring the delete events permission.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -177,7 +177,7 @@ const { status, data } = await apiInstance.deleteEvent(
|
|
|
177
177
|
# **disableEventBuildMode**
|
|
178
178
|
> SyncAccounts200Response disableEventBuildMode()
|
|
179
179
|
|
|
180
|
-
|
|
180
|
+
Turns off build mode for an event ahead of its scheduled expiration, restoring normal access restrictions; requires the update events permission.
|
|
181
181
|
|
|
182
182
|
### Example
|
|
183
183
|
|
|
@@ -228,7 +228,7 @@ const { status, data } = await apiInstance.disableEventBuildMode(
|
|
|
228
228
|
# **enableEventBuildMode**
|
|
229
229
|
> SyncAccounts200Response enableEventBuildMode()
|
|
230
230
|
|
|
231
|
-
|
|
231
|
+
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
232
|
|
|
233
233
|
### Example
|
|
234
234
|
|
|
@@ -279,7 +279,7 @@ const { status, data } = await apiInstance.enableEventBuildMode(
|
|
|
279
279
|
# **getEvent**
|
|
280
280
|
> CreateEvent200Response getEvent()
|
|
281
281
|
|
|
282
|
-
|
|
282
|
+
Retrieves the full details of a single event by ID or slug; requires read permission on events.
|
|
283
283
|
|
|
284
284
|
### Example
|
|
285
285
|
|
|
@@ -330,7 +330,7 @@ const { status, data } = await apiInstance.getEvent(
|
|
|
330
330
|
# **getEventActivities**
|
|
331
331
|
> GetAccountActivities200Response getEventActivities()
|
|
332
332
|
|
|
333
|
-
|
|
333
|
+
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
334
|
|
|
335
335
|
### Example
|
|
336
336
|
|
|
@@ -399,7 +399,7 @@ const { status, data } = await apiInstance.getEventActivities(
|
|
|
399
399
|
# **getEventPayments**
|
|
400
400
|
> GetAccountPayments200Response getEventPayments()
|
|
401
401
|
|
|
402
|
-
|
|
402
|
+
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
403
|
|
|
404
404
|
### Example
|
|
405
405
|
|
|
@@ -462,7 +462,7 @@ const { status, data } = await apiInstance.getEventPayments(
|
|
|
462
462
|
# **getEventTiers**
|
|
463
463
|
> GetEventTiers200Response getEventTiers()
|
|
464
464
|
|
|
465
|
-
|
|
465
|
+
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
466
|
|
|
467
467
|
### Example
|
|
468
468
|
|
|
@@ -513,7 +513,7 @@ const { status, data } = await apiInstance.getEventTiers(
|
|
|
513
513
|
# **getEvents**
|
|
514
514
|
> GetEvents200Response getEvents()
|
|
515
515
|
|
|
516
|
-
|
|
516
|
+
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
517
|
|
|
518
518
|
### Example
|
|
519
519
|
|
|
@@ -579,7 +579,7 @@ const { status, data } = await apiInstance.getEvents(
|
|
|
579
579
|
# **updateEvent**
|
|
580
580
|
> CreateEvent200Response updateEvent(eventUpdateInputs)
|
|
581
581
|
|
|
582
|
-
|
|
582
|
+
Updates the details of an existing event with the given fields, requiring the update events permission.
|
|
583
583
|
|
|
584
584
|
### Example
|
|
585
585
|
|
|
@@ -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
|
|
|
@@ -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
|
|