@connectedxm/admin-sdk 7.5.0 → 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 -1212
- package/api.ts +9696 -9696
- package/dist/api.d.ts +9696 -9696
- package/dist/api.js +9696 -9696
- package/dist/esm/api.d.ts +9696 -9696
- package/dist/esm/api.js +9696 -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/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/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 +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/EventsOnSiteApi.md
CHANGED
|
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getEventOnSite**](#geteventonsite) | **GET** /events/{eventId}/on-site | Get
|
|
8
|
-
|[**updateEventBadgeTemplate**](#updateeventbadgetemplate) | **PUT** /events/{eventId}/template | Update
|
|
9
|
-
|[**updateEventCheckinCode**](#updateeventcheckincode) | **POST** /events/{eventId}/on-site |
|
|
7
|
+
|[**getEventOnSite**](#geteventonsite) | **GET** /events/{eventId}/on-site | Get an event\'s on-site check-in settings|
|
|
8
|
+
|[**updateEventBadgeTemplate**](#updateeventbadgetemplate) | **PUT** /events/{eventId}/template | Update an event\'s badge template|
|
|
9
|
+
|[**updateEventCheckinCode**](#updateeventcheckincode) | **POST** /events/{eventId}/on-site | Regenerate an event\'s check-in code|
|
|
10
10
|
|
|
11
11
|
# **getEventOnSite**
|
|
12
12
|
> GetEventOnSite200Response getEventOnSite()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Returns the on-site check-in configuration for the given event, including its authentication code, or null if on-site check-in has not been set up yet; requires read access to events.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -62,7 +62,7 @@ const { status, data } = await apiInstance.getEventOnSite(
|
|
|
62
62
|
# **updateEventBadgeTemplate**
|
|
63
63
|
> UpdateEventCheckinCode200Response updateEventBadgeTemplate(body)
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
Replaces the on-site check-in badge template design for the given event, used to render printed attendee badges; requires read and update permission on events.
|
|
66
66
|
|
|
67
67
|
### Example
|
|
68
68
|
|
|
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.updateEventBadgeTemplate(
|
|
|
116
116
|
# **updateEventCheckinCode**
|
|
117
117
|
> UpdateEventCheckinCode200Response updateEventCheckinCode()
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
Generates a new on-site check-in code for the given event, used for badge printing and attendee check-in kiosks; requires read and update permission on events.
|
|
120
120
|
|
|
121
121
|
### Example
|
|
122
122
|
|
|
@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createEventPackage**](#createeventpackage) | **POST** /events/{eventId}/packages | Create
|
|
8
|
-
|[**deleteEventPackage**](#deleteeventpackage) | **DELETE** /events/{eventId}/packages/{packageId} | Delete
|
|
9
|
-
|[**getEventPackage**](#geteventpackage) | **GET** /events/{eventId}/packages/{packageId} | Get
|
|
10
|
-
|[**getEventPackages**](#geteventpackages) | **GET** /events/{eventId}/packages |
|
|
11
|
-
|[**updateEventPackage**](#updateeventpackage) | **PUT** /events/{eventId}/packages/{packageId} | Update
|
|
7
|
+
|[**createEventPackage**](#createeventpackage) | **POST** /events/{eventId}/packages | Create an event package|
|
|
8
|
+
|[**deleteEventPackage**](#deleteeventpackage) | **DELETE** /events/{eventId}/packages/{packageId} | Delete an event package|
|
|
9
|
+
|[**getEventPackage**](#geteventpackage) | **GET** /events/{eventId}/packages/{packageId} | Get a single event package|
|
|
10
|
+
|[**getEventPackages**](#geteventpackages) | **GET** /events/{eventId}/packages | List an event\'s packages|
|
|
11
|
+
|[**updateEventPackage**](#updateeventpackage) | **PUT** /events/{eventId}/packages/{packageId} | Update an event package|
|
|
12
12
|
|
|
13
13
|
# **createEventPackage**
|
|
14
14
|
> CreateEventPackage200Response createEventPackage()
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new package for the given event, bundling passes and other offerings that attendees can purchase together; requires read and update permission on events.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createEventPackage(
|
|
|
68
68
|
# **deleteEventPackage**
|
|
69
69
|
> CreateAccountInvitations200Response deleteEventPackage()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Permanently removes the specified package, along with its association to passes, from the given event; requires read and update permission on events.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.deleteEventPackage(
|
|
|
122
122
|
# **getEventPackage**
|
|
123
123
|
> CreateEventPackage200Response getEventPackage()
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Returns the details of a specific package belonging to the given event, identified by its package ID; requires read access to events.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.getEventPackage(
|
|
|
176
176
|
# **getEventPackages**
|
|
177
177
|
> GetEventPackages200Response getEventPackages()
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Returns a paginated list of packages belonging to the given event, with search and ordering support; requires read access to events.
|
|
180
180
|
|
|
181
181
|
### Example
|
|
182
182
|
|
|
@@ -239,7 +239,7 @@ const { status, data } = await apiInstance.getEventPackages(
|
|
|
239
239
|
# **updateEventPackage**
|
|
240
240
|
> CreateEventPackage200Response updateEventPackage()
|
|
241
241
|
|
|
242
|
-
|
|
242
|
+
Updates the details of an existing package for the given event, such as its name, description, or pricing; requires read and update permission on events.
|
|
243
243
|
|
|
244
244
|
### Example
|
|
245
245
|
|
|
@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createEventPackagePass**](#createeventpackagepass) | **POST** /events/{eventId}/packages/{packageId}/passes | Create
|
|
8
|
-
|[**deleteEventPackagePass**](#deleteeventpackagepass) | **DELETE** /events/{eventId}/packages/{packageId}/passes/{passId} | Delete
|
|
9
|
-
|[**getEventPackagePass**](#geteventpackagepass) | **GET** /events/{eventId}/packages/{packageId}/passes/{passId} | Get
|
|
10
|
-
|[**getEventPackagePasses**](#geteventpackagepasses) | **GET** /events/{eventId}/packages/{packageId}/passes |
|
|
11
|
-
|[**updateEventPackagePass**](#updateeventpackagepass) | **PUT** /events/{eventId}/packages/{packageId}/passes/{passId} | Update
|
|
7
|
+
|[**createEventPackagePass**](#createeventpackagepass) | **POST** /events/{eventId}/packages/{packageId}/passes | Create a pass for an event package|
|
|
8
|
+
|[**deleteEventPackagePass**](#deleteeventpackagepass) | **DELETE** /events/{eventId}/packages/{packageId}/passes/{passId} | Delete a pass from an event package|
|
|
9
|
+
|[**getEventPackagePass**](#geteventpackagepass) | **GET** /events/{eventId}/packages/{packageId}/passes/{passId} | Get a single pass in an event package|
|
|
10
|
+
|[**getEventPackagePasses**](#geteventpackagepasses) | **GET** /events/{eventId}/packages/{packageId}/passes | List the passes included in an event package|
|
|
11
|
+
|[**updateEventPackagePass**](#updateeventpackagepass) | **PUT** /events/{eventId}/packages/{packageId}/passes/{passId} | Update a pass within an event package|
|
|
12
12
|
|
|
13
13
|
# **createEventPackagePass**
|
|
14
14
|
> CreateEventPackagePass200Response createEventPackagePass(eventPackagePassCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new pass tied to the given event package, defining a purchasable pass option within that package; requires read and update permission on events.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -71,7 +71,7 @@ const { status, data } = await apiInstance.createEventPackagePass(
|
|
|
71
71
|
# **deleteEventPackagePass**
|
|
72
72
|
> CreateAccountInvitations200Response deleteEventPackagePass()
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
Permanently removes the specified pass from the given event package; requires read and update permission on events.
|
|
75
75
|
|
|
76
76
|
### Example
|
|
77
77
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.deleteEventPackagePass(
|
|
|
128
128
|
# **getEventPackagePass**
|
|
129
129
|
> CreateEventPackagePass200Response getEventPackagePass()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Returns the details of a specific pass belonging to the given event package, identified by its pass ID; requires read access to events.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -185,7 +185,7 @@ const { status, data } = await apiInstance.getEventPackagePass(
|
|
|
185
185
|
# **getEventPackagePasses**
|
|
186
186
|
> GetEventPackagePasses200Response getEventPackagePasses()
|
|
187
187
|
|
|
188
|
-
|
|
188
|
+
Returns a paginated list of passes belonging to the given event package, with optional search; requires read access to events.
|
|
189
189
|
|
|
190
190
|
### Example
|
|
191
191
|
|
|
@@ -251,7 +251,7 @@ const { status, data } = await apiInstance.getEventPackagePasses(
|
|
|
251
251
|
# **updateEventPackagePass**
|
|
252
252
|
> CreateEventPackagePass200Response updateEventPackagePass()
|
|
253
253
|
|
|
254
|
-
|
|
254
|
+
Updates the details of an existing pass in the given event package, such as its name, pricing, or availability; requires read and update permission on events.
|
|
255
255
|
|
|
256
256
|
### Example
|
|
257
257
|
|
|
@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteEventPackageTranslation**](#deleteeventpackagetranslation) | **DELETE** /events/{eventId}/packages/{packageId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventPackageTranslation**](#geteventpackagetranslation) | **GET** /events/{eventId}/packages/{packageId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventPackageTranslations**](#geteventpackagetranslations) | **GET** /events/{eventId}/packages/{packageId}/translations |
|
|
10
|
-
|[**updateEventPackageTranslation**](#updateeventpackagetranslation) | **PUT** /events/{eventId}/packages/{packageId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventPackageTranslation**](#deleteeventpackagetranslation) | **DELETE** /events/{eventId}/packages/{packageId}/translations/{locale} | Delete an event package translation|
|
|
8
|
+
|[**getEventPackageTranslation**](#geteventpackagetranslation) | **GET** /events/{eventId}/packages/{packageId}/translations/{locale} | Get an event package\'s translation for a locale|
|
|
9
|
+
|[**getEventPackageTranslations**](#geteventpackagetranslations) | **GET** /events/{eventId}/packages/{packageId}/translations | List an event package\'s translations|
|
|
10
|
+
|[**updateEventPackageTranslation**](#updateeventpackagetranslation) | **PUT** /events/{eventId}/packages/{packageId}/translations/{locale} | Update an event package translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventPackageTranslation**
|
|
13
13
|
> CreateAccountInvitations200Response deleteEventPackageTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the localized translation for the given event package in the specified locale; requires read and update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventPackageTranslation(
|
|
|
69
69
|
# **getEventPackageTranslation**
|
|
70
70
|
> GetEventPackageTranslation200Response getEventPackageTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Returns the localized text fields for the given event package in the specified locale; requires read access to events.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventPackageTranslation(
|
|
|
126
126
|
# **getEventPackageTranslations**
|
|
127
127
|
> GetEventPackageTranslations200Response getEventPackageTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of the locale translations available for the given event package, with search and ordering support; requires read access to events.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventPackageTranslations(
|
|
|
192
192
|
# **updateEventPackageTranslation**
|
|
193
193
|
> GetEventPackageTranslation200Response updateEventPackageTranslation(eventPackageTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Creates or updates the localized translation of an event package\'s content for the specified locale; requires read and update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
package/docs/EventsPagesApi.md
CHANGED
|
@@ -4,19 +4,19 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventPageImage**](#addeventpageimage) | **POST** /events/{eventId}/pages/{pageId}/images/{imageId} | Add
|
|
8
|
-
|[**createEventPage**](#createeventpage) | **POST** /events/{eventId}/pages | Create
|
|
9
|
-
|[**deleteEventPage**](#deleteeventpage) | **DELETE** /events/{eventId}/pages/{pageId} | Delete
|
|
10
|
-
|[**getEventPage**](#geteventpage) | **GET** /events/{eventId}/pages/{pageId} | Get
|
|
11
|
-
|[**getEventPageImages**](#geteventpageimages) | **GET** /events/{eventId}/pages/{pageId}/images |
|
|
12
|
-
|[**getEventPages**](#geteventpages) | **GET** /events/{eventId}/pages |
|
|
13
|
-
|[**removeEventPageImage**](#removeeventpageimage) | **DELETE** /events/{eventId}/pages/{pageId}/images/{imageId} | Remove
|
|
14
|
-
|[**updateEventPage**](#updateeventpage) | **PUT** /events/{eventId}/pages/{pageId} | Update
|
|
7
|
+
|[**addEventPageImage**](#addeventpageimage) | **POST** /events/{eventId}/pages/{pageId}/images/{imageId} | Add an image to an event page|
|
|
8
|
+
|[**createEventPage**](#createeventpage) | **POST** /events/{eventId}/pages | Create an event page|
|
|
9
|
+
|[**deleteEventPage**](#deleteeventpage) | **DELETE** /events/{eventId}/pages/{pageId} | Delete an event page|
|
|
10
|
+
|[**getEventPage**](#geteventpage) | **GET** /events/{eventId}/pages/{pageId} | Get an event page|
|
|
11
|
+
|[**getEventPageImages**](#geteventpageimages) | **GET** /events/{eventId}/pages/{pageId}/images | List an event page\'s images|
|
|
12
|
+
|[**getEventPages**](#geteventpages) | **GET** /events/{eventId}/pages | List an event\'s pages|
|
|
13
|
+
|[**removeEventPageImage**](#removeeventpageimage) | **DELETE** /events/{eventId}/pages/{pageId}/images/{imageId} | Remove an image from an event page|
|
|
14
|
+
|[**updateEventPage**](#updateeventpage) | **PUT** /events/{eventId}/pages/{pageId} | Update an event page|
|
|
15
15
|
|
|
16
16
|
# **addEventPageImage**
|
|
17
17
|
> CreateEventPage200Response addEventPageImage()
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Attaches an existing image to an event page\'s image gallery, requiring update permission on both events and storage.
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -73,7 +73,7 @@ const { status, data } = await apiInstance.addEventPageImage(
|
|
|
73
73
|
# **createEventPage**
|
|
74
74
|
> CreateEventPage200Response createEventPage(eventPageCreateInputs)
|
|
75
75
|
|
|
76
|
-
|
|
76
|
+
Creates a new custom content page for an event, assigning it a slug and sort order, and requires create permission on events.
|
|
77
77
|
|
|
78
78
|
### Example
|
|
79
79
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.createEventPage(
|
|
|
128
128
|
# **deleteEventPage**
|
|
129
129
|
> CreateAccountInvitations200Response deleteEventPage()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Deletes a custom content page from an event and re-sequences the sort order of the event\'s remaining pages, requiring update permission on events.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -182,7 +182,7 @@ const { status, data } = await apiInstance.deleteEventPage(
|
|
|
182
182
|
# **getEventPage**
|
|
183
183
|
> CreateEventPage200Response getEventPage()
|
|
184
184
|
|
|
185
|
-
|
|
185
|
+
Retrieves the details of a single page belonging to the specified event by its page ID; requires the \"read\" permission on the \"events\" module.
|
|
186
186
|
|
|
187
187
|
### Example
|
|
188
188
|
|
|
@@ -236,7 +236,7 @@ const { status, data } = await apiInstance.getEventPage(
|
|
|
236
236
|
# **getEventPageImages**
|
|
237
237
|
> GetEventPageImages200Response getEventPageImages()
|
|
238
238
|
|
|
239
|
-
|
|
239
|
+
Returns a paginated list of images attached to the specified event page, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"storage\" modules.
|
|
240
240
|
|
|
241
241
|
### Example
|
|
242
242
|
|
|
@@ -302,7 +302,7 @@ const { status, data } = await apiInstance.getEventPageImages(
|
|
|
302
302
|
# **getEventPages**
|
|
303
303
|
> GetEventPages200Response getEventPages()
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
Returns a paginated list of custom pages belonging to the specified event, supporting search and sorting; requires the \"read\" permission on the \"events\" module.
|
|
306
306
|
|
|
307
307
|
### Example
|
|
308
308
|
|
|
@@ -365,7 +365,7 @@ const { status, data } = await apiInstance.getEventPages(
|
|
|
365
365
|
# **removeEventPageImage**
|
|
366
366
|
> CreateEventPage200Response removeEventPageImage()
|
|
367
367
|
|
|
368
|
-
|
|
368
|
+
Detaches an image from an event page\'s image gallery without deleting the underlying image, requiring update permission on both events and storage.
|
|
369
369
|
|
|
370
370
|
### Example
|
|
371
371
|
|
|
@@ -422,7 +422,7 @@ const { status, data } = await apiInstance.removeEventPageImage(
|
|
|
422
422
|
# **updateEventPage**
|
|
423
423
|
> CreateEventPage200Response updateEventPage()
|
|
424
424
|
|
|
425
|
-
|
|
425
|
+
Updates the content, title, or sort order of an existing custom event page, re-sequencing other pages when the sort order changes, and requires update permission on events.
|
|
426
426
|
|
|
427
427
|
### Example
|
|
428
428
|
|
|
@@ -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
|
-
|[**deleteEventPageTranslation**](#deleteeventpagetranslation) | **DELETE** /events/{eventId}/pages/{pageId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventPageTranslation**](#geteventpagetranslation) | **GET** /events/{eventId}/pages/{pageId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventPageTranslations**](#geteventpagetranslations) | **GET** /events/{eventId}/pages/{pageId}/translations |
|
|
10
|
-
|[**updateEventPageTranslation**](#updateeventpagetranslation) | **PUT** /events/{eventId}/pages/{pageId}/translations/{locale} |
|
|
7
|
+
|[**deleteEventPageTranslation**](#deleteeventpagetranslation) | **DELETE** /events/{eventId}/pages/{pageId}/translations/{locale} | Delete an event page translation|
|
|
8
|
+
|[**getEventPageTranslation**](#geteventpagetranslation) | **GET** /events/{eventId}/pages/{pageId}/translations/{locale} | Get an event page\'s translation for a locale|
|
|
9
|
+
|[**getEventPageTranslations**](#geteventpagetranslations) | **GET** /events/{eventId}/pages/{pageId}/translations | List an event page\'s translations|
|
|
10
|
+
|[**updateEventPageTranslation**](#updateeventpagetranslation) | **PUT** /events/{eventId}/pages/{pageId}/translations/{locale} | Create or update an event page translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventPageTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventPageTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Deletes the translation for the given locale on an event page, requiring update permission on events; subsequent reads for that locale will fall back to the page\'s default content.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventPageTranslation(
|
|
|
69
69
|
# **getEventPageTranslation**
|
|
70
70
|
> GetEventPageTranslation200Response getEventPageTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Returns the localized content for the given event page in the specified locale, or null if no translation exists; requires read access to events.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventPageTranslation(
|
|
|
126
126
|
# **getEventPageTranslations**
|
|
127
127
|
> GetEventPageTranslations200Response getEventPageTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of translations for the specified event page, supporting search and sorting; requires the \"read\" permission on the \"events\" module.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventPageTranslations(
|
|
|
192
192
|
# **updateEventPageTranslation**
|
|
193
193
|
> SyncAccounts200Response updateEventPageTranslation(eventPageTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Upserts the localized content (e.g. title, subtitle, body) for an event page in the given locale, requiring update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
|
@@ -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
|
-
|[**createEventSessionAccess**](#createeventsessionaccess) | **POST** /events/{eventId}/sessions/{sessionId}/passes/{passId} |
|
|
8
|
-
|[**deleteEventSessionAccess**](#deleteeventsessionaccess) | **DELETE** /events/{eventId}/sessions/{sessionId}/passes/{passId} |
|
|
9
|
-
|[**getEventPassAccesses**](#geteventpassaccesses) | **GET** /events/{eventId}/passes/{passId}/accesses |
|
|
10
|
-
|[**updateEventSessionAccess**](#updateeventsessionaccess) | **PUT** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Update
|
|
11
|
-
|[**updateEventSessionAccessResponses**](#updateeventsessionaccessresponses) | **PUT** /events/{eventId}/sessions/{sessionId}/passes/{passId}/responses | Update
|
|
7
|
+
|[**createEventSessionAccess**](#createeventsessionaccess) | **POST** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Grant a pass access to a session|
|
|
8
|
+
|[**deleteEventSessionAccess**](#deleteeventsessionaccess) | **DELETE** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Revoke a pass\'s access to a session|
|
|
9
|
+
|[**getEventPassAccesses**](#geteventpassaccesses) | **GET** /events/{eventId}/passes/{passId}/accesses | List a pass\'s session accesses|
|
|
10
|
+
|[**updateEventSessionAccess**](#updateeventsessionaccess) | **PUT** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Update a pass\'s session access|
|
|
11
|
+
|[**updateEventSessionAccessResponses**](#updateeventsessionaccessresponses) | **PUT** /events/{eventId}/sessions/{sessionId}/passes/{passId}/responses | Update a pass\'s session access question responses|
|
|
12
12
|
|
|
13
13
|
# **createEventSessionAccess**
|
|
14
14
|
> GetEventSessionAccess200Response createEventSessionAccess()
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a session access record linking an attendee\'s pass to an event session, failing if session registration is not enabled, and requires update permission on attendees.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -70,7 +70,7 @@ const { status, data } = await apiInstance.createEventSessionAccess(
|
|
|
70
70
|
# **deleteEventSessionAccess**
|
|
71
71
|
> CreateAccountInvitations200Response deleteEventSessionAccess()
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
Permanently deletes the session access record linking a pass to an event session, requiring update permission on attendees.
|
|
74
74
|
|
|
75
75
|
### Example
|
|
76
76
|
|
|
@@ -127,7 +127,7 @@ const { status, data } = await apiInstance.deleteEventSessionAccess(
|
|
|
127
127
|
# **getEventPassAccesses**
|
|
128
128
|
> GetEventPassAccesses200Response getEventPassAccesses()
|
|
129
129
|
|
|
130
|
-
|
|
130
|
+
Returns a paginated list of session access records granted by the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
131
131
|
|
|
132
132
|
### Example
|
|
133
133
|
|
|
@@ -193,7 +193,7 @@ const { status, data } = await apiInstance.getEventPassAccesses(
|
|
|
193
193
|
# **updateEventSessionAccess**
|
|
194
194
|
> GetEventSessionAccess200Response updateEventSessionAccess(eventSessionAccessUpdateInputs)
|
|
195
195
|
|
|
196
|
-
|
|
196
|
+
Updates fields, such as status, on the session access record linking a pass to an event session, requiring update permission on attendees.
|
|
197
197
|
|
|
198
198
|
### Example
|
|
199
199
|
|
|
@@ -254,7 +254,7 @@ const { status, data } = await apiInstance.updateEventSessionAccess(
|
|
|
254
254
|
# **updateEventSessionAccessResponses**
|
|
255
255
|
> CreateAccountInvitations200Response updateEventSessionAccessResponses(requestBody)
|
|
256
256
|
|
|
257
|
-
|
|
257
|
+
Overwrites the registration question responses used to control a pass\'s access to a specific event session, requires read/update permission on attendees and read permission on events.
|
|
258
258
|
|
|
259
259
|
### Example
|
|
260
260
|
|
|
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add
|
|
8
|
-
|[**getEventPassAddOns**](#geteventpassaddons) | **GET** /events/{eventId}/passes/{passId}/addOns |
|
|
9
|
-
|[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove
|
|
7
|
+
|[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add an add-on to an attendee\'s pass|
|
|
8
|
+
|[**getEventPassAddOns**](#geteventpassaddons) | **GET** /events/{eventId}/passes/{passId}/addOns | List an event pass\'s add-ons|
|
|
9
|
+
|[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove an add-on from an attendee\'s pass|
|
|
10
10
|
|
|
11
11
|
# **addEventPassAddOn**
|
|
12
12
|
> CreateEventPass200Response addEventPassAddOn()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Attaches an event add-on purchase to the specified pass, requires read permission on events and read/update permission on attendees.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.addEventPassAddOn(
|
|
|
68
68
|
# **getEventPassAddOns**
|
|
69
69
|
> GetEventAddOns200Response getEventPassAddOns()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -134,7 +134,7 @@ const { status, data } = await apiInstance.getEventPassAddOns(
|
|
|
134
134
|
# **removeEventPassAddOn**
|
|
135
135
|
> CreateEventPass200Response removeEventPassAddOn()
|
|
136
136
|
|
|
137
|
-
|
|
137
|
+
Detaches a previously added event add-on purchase from the specified pass, requires read permission on events and read/update permission on attendees.
|
|
138
138
|
|
|
139
139
|
### Example
|
|
140
140
|
|
package/docs/EventsPassesApi.md
CHANGED
|
@@ -4,28 +4,28 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**approveEventPass**](#approveeventpass) | **PUT** /events/{eventId}/passes/{passId}/approve | Approve
|
|
8
|
-
|[**cancelEventPass**](#canceleventpass) | **PUT** /events/{eventId}/passes/{passId}/cancel | Cancel
|
|
9
|
-
|[**checkinEventPass**](#checkineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin |
|
|
10
|
-
|[**createEventPass**](#createeventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes | Create
|
|
11
|
-
|[**deleteEventPass**](#deleteeventpass) | **DELETE** /events/{eventId}/passes/{passId} | Delete
|
|
12
|
-
|[**denyEventPass**](#denyeventpass) | **PUT** /events/{eventId}/passes/{passId}/deny | Deny
|
|
13
|
-
|[**getEventPass**](#geteventpass) | **GET** /events/{eventId}/passes/{passId} | Get
|
|
14
|
-
|[**getEventPassMatches**](#geteventpassmatches) | **GET** /events/{eventId}/passes/{passId}/matches |
|
|
15
|
-
|[**getEventPassPayments**](#geteventpasspayments) | **GET** /events/{eventId}/passes/{passId}/payments |
|
|
16
|
-
|[**getEventPassTransferLogs**](#geteventpasstransferlogs) | **GET** /events/{eventId}/passes/{passId}/transfers/logs |
|
|
17
|
-
|[**getEventPasses**](#geteventpasses) | **GET** /events/{eventId}/passes |
|
|
18
|
-
|[**getEventPendingPasses**](#geteventpendingpasses) | **GET** /events/{eventId}/passes/pending |
|
|
19
|
-
|[**indexEventPasses**](#indexeventpasses) | **POST** /events/{eventId}/index-passes |
|
|
20
|
-
|[**transferEventPass**](#transfereventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes/{passId}/transfers | Transfer
|
|
21
|
-
|[**undoCheckinEventPass**](#undocheckineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin/undo | Undo
|
|
22
|
-
|[**updateEventPass**](#updateeventpass) | **PUT** /events/{eventId}/passes/{passId} | Update
|
|
23
|
-
|[**updateEventPassesReady**](#updateeventpassesready) | **POST** /events/{eventId}/passes/ready |
|
|
7
|
+
|[**approveEventPass**](#approveeventpass) | **PUT** /events/{eventId}/passes/{passId}/approve | Approve a pending event pass|
|
|
8
|
+
|[**cancelEventPass**](#canceleventpass) | **PUT** /events/{eventId}/passes/{passId}/cancel | Cancel an event pass|
|
|
9
|
+
|[**checkinEventPass**](#checkineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin | Check in an event pass|
|
|
10
|
+
|[**createEventPass**](#createeventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes | Create a pass for an event attendee|
|
|
11
|
+
|[**deleteEventPass**](#deleteeventpass) | **DELETE** /events/{eventId}/passes/{passId} | Delete an event pass|
|
|
12
|
+
|[**denyEventPass**](#denyeventpass) | **PUT** /events/{eventId}/passes/{passId}/deny | Deny a pending event pass|
|
|
13
|
+
|[**getEventPass**](#geteventpass) | **GET** /events/{eventId}/passes/{passId} | Get a single event pass|
|
|
14
|
+
|[**getEventPassMatches**](#geteventpassmatches) | **GET** /events/{eventId}/passes/{passId}/matches | List an event pass\'s networking matches|
|
|
15
|
+
|[**getEventPassPayments**](#geteventpasspayments) | **GET** /events/{eventId}/passes/{passId}/payments | List an event pass\'s payments|
|
|
16
|
+
|[**getEventPassTransferLogs**](#geteventpasstransferlogs) | **GET** /events/{eventId}/passes/{passId}/transfers/logs | List an event pass\'s transfer logs|
|
|
17
|
+
|[**getEventPasses**](#geteventpasses) | **GET** /events/{eventId}/passes | List an event\'s passes|
|
|
18
|
+
|[**getEventPendingPasses**](#geteventpendingpasses) | **GET** /events/{eventId}/passes/pending | List an event\'s pending passes|
|
|
19
|
+
|[**indexEventPasses**](#indexeventpasses) | **POST** /events/{eventId}/index-passes | Reindex an event\'s passes for search|
|
|
20
|
+
|[**transferEventPass**](#transfereventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes/{passId}/transfers | Transfer an event pass to another account|
|
|
21
|
+
|[**undoCheckinEventPass**](#undocheckineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin/undo | Undo an event pass check-in|
|
|
22
|
+
|[**updateEventPass**](#updateeventpass) | **PUT** /events/{eventId}/passes/{passId} | Update an event pass|
|
|
23
|
+
|[**updateEventPassesReady**](#updateeventpassesready) | **POST** /events/{eventId}/passes/ready | Mark all needs-info passes as ready|
|
|
24
24
|
|
|
25
25
|
# **approveEventPass**
|
|
26
26
|
> CreateEventPass200Response approveEventPass()
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Moves a pending event pass to the ready status so the attendee\'s registration is confirmed, optionally sending the approval email, requires read permission on events and read/update permission on attendees.
|
|
29
29
|
|
|
30
30
|
### Example
|
|
31
31
|
|
|
@@ -82,7 +82,7 @@ const { status, data } = await apiInstance.approveEventPass(
|
|
|
82
82
|
# **cancelEventPass**
|
|
83
83
|
> CreateEventPass200Response cancelEventPass()
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
Cancels an approved or active event pass/registration, requires the update permission on attendees, blocks the cancellation if the pass has active session accesses, and optionally sends a cancellation email to the attendee.
|
|
86
86
|
|
|
87
87
|
### Example
|
|
88
88
|
|
|
@@ -139,7 +139,7 @@ const { status, data } = await apiInstance.cancelEventPass(
|
|
|
139
139
|
# **checkinEventPass**
|
|
140
140
|
> CreateEventPass200Response checkinEventPass()
|
|
141
141
|
|
|
142
|
-
|
|
142
|
+
Marks the given event pass as checked in, resolving an alternate pass ID to its underlying record first, and requires read permission on events and attendees.
|
|
143
143
|
|
|
144
144
|
### Example
|
|
145
145
|
|
|
@@ -193,7 +193,7 @@ const { status, data } = await apiInstance.checkinEventPass(
|
|
|
193
193
|
# **createEventPass**
|
|
194
194
|
> CreateEventPass200Response createEventPass(eventPassCreateInputs)
|
|
195
195
|
|
|
196
|
-
|
|
196
|
+
Creates a new pass/registration purchase for the specified attendee on the given event using the provided pass details, and requires update permission on attendees.
|
|
197
197
|
|
|
198
198
|
### Example
|
|
199
199
|
|
|
@@ -251,7 +251,7 @@ const { status, data } = await apiInstance.createEventPass(
|
|
|
251
251
|
# **deleteEventPass**
|
|
252
252
|
> CreateAccountInvitations200Response deleteEventPass()
|
|
253
253
|
|
|
254
|
-
|
|
254
|
+
Permanently deletes an event pass/registration purchase, first removing any pending transfer linked to it, and requires the delete permission on attendees.
|
|
255
255
|
|
|
256
256
|
### Example
|
|
257
257
|
|
|
@@ -308,7 +308,7 @@ const { status, data } = await apiInstance.deleteEventPass(
|
|
|
308
308
|
# **denyEventPass**
|
|
309
309
|
> CreateEventPass200Response denyEventPass()
|
|
310
310
|
|
|
311
|
-
|
|
311
|
+
Denies a pass/registration that is in pending status by canceling it, optionally issuing a refund for its payment and sending a denial email, and requires update permission on attendees.
|
|
312
312
|
|
|
313
313
|
### Example
|
|
314
314
|
|
|
@@ -368,7 +368,7 @@ const { status, data } = await apiInstance.denyEventPass(
|
|
|
368
368
|
# **getEventPass**
|
|
369
369
|
> CreateEventPass200Response getEventPass()
|
|
370
370
|
|
|
371
|
-
|
|
371
|
+
Returns a single event pass (registration purchase) by ID for the given event, including its attendee and ticket details, and requires the read events and read attendees permissions.
|
|
372
372
|
|
|
373
373
|
### Example
|
|
374
374
|
|
|
@@ -422,7 +422,7 @@ const { status, data } = await apiInstance.getEventPass(
|
|
|
422
422
|
# **getEventPassMatches**
|
|
423
423
|
> GetEventPassMatches200Response getEventPassMatches()
|
|
424
424
|
|
|
425
|
-
|
|
425
|
+
Returns the networking or session matches associated with a specific event pass, optionally filtered by sessionId and roundId, and requires the read events and read attendees permissions.
|
|
426
426
|
|
|
427
427
|
### Example
|
|
428
428
|
|
|
@@ -482,7 +482,7 @@ const { status, data } = await apiInstance.getEventPassMatches(
|
|
|
482
482
|
# **getEventPassPayments**
|
|
483
483
|
> GetAccountPayments200Response getEventPassPayments()
|
|
484
484
|
|
|
485
|
-
|
|
485
|
+
Returns a paginated list of payments made for a specific event pass, and requires the read events, read attendees, and read payments permissions.
|
|
486
486
|
|
|
487
487
|
### Example
|
|
488
488
|
|
|
@@ -548,7 +548,7 @@ const { status, data } = await apiInstance.getEventPassPayments(
|
|
|
548
548
|
# **getEventPassTransferLogs**
|
|
549
549
|
> GetEventAttendeeTransfersLogs200Response getEventPassTransferLogs()
|
|
550
550
|
|
|
551
|
-
|
|
551
|
+
Returns a paginated history of ownership transfers for a specific event pass, and requires the read events and read attendees permissions.
|
|
552
552
|
|
|
553
553
|
### Example
|
|
554
554
|
|
|
@@ -614,7 +614,7 @@ const { status, data } = await apiInstance.getEventPassTransferLogs(
|
|
|
614
614
|
# **getEventPasses**
|
|
615
615
|
> GetEventAddOnPasses200Response getEventPasses()
|
|
616
616
|
|
|
617
|
-
|
|
617
|
+
Returns a paginated list of active (ready or needing info) passes purchased for the given event, optionally filtered by check-in status via the checkedIn parameter, and requires the read events and read attendees permissions.
|
|
618
618
|
|
|
619
619
|
### Example
|
|
620
620
|
|
|
@@ -680,7 +680,7 @@ const { status, data } = await apiInstance.getEventPasses(
|
|
|
680
680
|
# **getEventPendingPasses**
|
|
681
681
|
> GetEventAddOnPasses200Response getEventPendingPasses()
|
|
682
682
|
|
|
683
|
-
|
|
683
|
+
Returns a paginated list of passes for the given event that are still in pending status (payment or registration not yet completed), and requires the read events and read attendees permissions.
|
|
684
684
|
|
|
685
685
|
### Example
|
|
686
686
|
|
|
@@ -743,7 +743,7 @@ const { status, data } = await apiInstance.getEventPendingPasses(
|
|
|
743
743
|
# **indexEventPasses**
|
|
744
744
|
> IndexEventPasses200Response indexEventPasses()
|
|
745
745
|
|
|
746
|
-
|
|
746
|
+
Clears the cached search index for every pass belonging to the given event so it gets rebuilt, and requires update permission on events.
|
|
747
747
|
|
|
748
748
|
### Example
|
|
749
749
|
|
|
@@ -794,7 +794,7 @@ const { status, data } = await apiInstance.indexEventPasses(
|
|
|
794
794
|
# **transferEventPass**
|
|
795
795
|
> CreateAccountInvitations200Response transferEventPass()
|
|
796
796
|
|
|
797
|
-
|
|
797
|
+
Transfers ownership of an attendee\'s event pass to another specified account, and requires update permission on attendees.
|
|
798
798
|
|
|
799
799
|
### Example
|
|
800
800
|
|
|
@@ -854,7 +854,7 @@ const { status, data } = await apiInstance.transferEventPass(
|
|
|
854
854
|
# **undoCheckinEventPass**
|
|
855
855
|
> CreateEventPass200Response undoCheckinEventPass()
|
|
856
856
|
|
|
857
|
-
|
|
857
|
+
Reverses a previous check-in on the given event pass, marking it as not checked in, and requires read permission on events and attendees.
|
|
858
858
|
|
|
859
859
|
### Example
|
|
860
860
|
|
|
@@ -908,7 +908,7 @@ const { status, data } = await apiInstance.undoCheckinEventPass(
|
|
|
908
908
|
# **updateEventPass**
|
|
909
909
|
> CreateEventPass200Response updateEventPass(eventPassUpdateInputs)
|
|
910
910
|
|
|
911
|
-
|
|
911
|
+
Updates fields on an existing event pass/registration purchase, such as its ticket, coupon, or status, and requires update permission on attendees.
|
|
912
912
|
|
|
913
913
|
### Example
|
|
914
914
|
|
|
@@ -966,7 +966,7 @@ const { status, data } = await apiInstance.updateEventPass(
|
|
|
966
966
|
# **updateEventPassesReady**
|
|
967
967
|
> CreateAccountInvitations200Response updateEventPassesReady()
|
|
968
968
|
|
|
969
|
-
|
|
969
|
+
Bulk-updates every pass on the given event that currently has \"needs info\" status to \"ready\" status, and requires update permission on attendees.
|
|
970
970
|
|
|
971
971
|
### Example
|
|
972
972
|
|