@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/DashboardsApi.md
CHANGED
|
@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createDashboard**](#createdashboard) | **POST** /dashboards | Create
|
|
8
|
-
|[**deleteDashboard**](#deletedashboard) | **DELETE** /dashboards/{dashboardId} | Delete
|
|
9
|
-
|[**getDashboard**](#getdashboard) | **GET** /dashboards/{dashboardId} | Get
|
|
10
|
-
|[**getDashboards**](#getdashboards) | **GET** /dashboards |
|
|
11
|
-
|[**updateDashboard**](#updatedashboard) | **PUT** /dashboards/{dashboardId} | Update
|
|
7
|
+
|[**createDashboard**](#createdashboard) | **POST** /dashboards | Create a dashboard|
|
|
8
|
+
|[**deleteDashboard**](#deletedashboard) | **DELETE** /dashboards/{dashboardId} | Delete a dashboard|
|
|
9
|
+
|[**getDashboard**](#getdashboard) | **GET** /dashboards/{dashboardId} | Get a dashboard|
|
|
10
|
+
|[**getDashboards**](#getdashboards) | **GET** /dashboards | List dashboards|
|
|
11
|
+
|[**updateDashboard**](#updatedashboard) | **PUT** /dashboards/{dashboardId} | Update a dashboard|
|
|
12
12
|
|
|
13
13
|
# **createDashboard**
|
|
14
14
|
> CreateDashboard200Response createDashboard(dashboardCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new analytics dashboard for the organization, optionally scoped to a specific event, and requires create permission on dashboards.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createDashboard(
|
|
|
65
65
|
# **deleteDashboard**
|
|
66
66
|
> SyncAccounts200Response deleteDashboard()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Permanently deletes an analytics dashboard, including its widgets, and requires delete permission on dashboards.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.deleteDashboard(
|
|
|
116
116
|
# **getDashboard**
|
|
117
117
|
> CreateDashboard200Response getDashboard()
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
Returns a single dashboard by ID, including its configuration; requires read permission on dashboards.
|
|
120
120
|
|
|
121
121
|
### Example
|
|
122
122
|
|
|
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getDashboard(
|
|
|
167
167
|
# **getDashboards**
|
|
168
168
|
> GetDashboards200Response getDashboards()
|
|
169
169
|
|
|
170
|
-
|
|
170
|
+
Returns a paginated list of the organization\'s dashboards, optionally filtered to those belonging to a specific event; requires read permission on dashboards.
|
|
171
171
|
|
|
172
172
|
### Example
|
|
173
173
|
|
|
@@ -230,7 +230,7 @@ const { status, data } = await apiInstance.getDashboards(
|
|
|
230
230
|
# **updateDashboard**
|
|
231
231
|
> CreateDashboard200Response updateDashboard(dashboardUpdateInputs)
|
|
232
232
|
|
|
233
|
-
|
|
233
|
+
Updates properties of an existing analytics dashboard, such as its name, and requires update permission on dashboards.
|
|
234
234
|
|
|
235
235
|
### Example
|
|
236
236
|
|
|
@@ -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
|
-
|[**createDashboardWidget**](#createdashboardwidget) | **POST** /dashboards/{dashboardId}/widgets |
|
|
8
|
-
|[**deleteDashboardWidget**](#deletedashboardwidget) | **DELETE** /dashboards/{dashboardId}/widgets/{widgetId} |
|
|
9
|
-
|[**getDashboardWidgets**](#getdashboardwidgets) | **GET** /dashboard/{dashboardId}/widgets |
|
|
10
|
-
|[**updateDashboardWidget**](#updatedashboardwidget) | **PUT** /dashboards/{dashboardId}/widgets/{widgetId} | Update
|
|
7
|
+
|[**createDashboardWidget**](#createdashboardwidget) | **POST** /dashboards/{dashboardId}/widgets | Add a widget to a dashboard|
|
|
8
|
+
|[**deleteDashboardWidget**](#deletedashboardwidget) | **DELETE** /dashboards/{dashboardId}/widgets/{widgetId} | Remove a widget from a dashboard|
|
|
9
|
+
|[**getDashboardWidgets**](#getdashboardwidgets) | **GET** /dashboard/{dashboardId}/widgets | List widgets available for a dashboard|
|
|
10
|
+
|[**updateDashboardWidget**](#updatedashboardwidget) | **PUT** /dashboards/{dashboardId}/widgets/{widgetId} | Update a dashboard widget|
|
|
11
11
|
|
|
12
12
|
# **createDashboardWidget**
|
|
13
13
|
> CreateDashboardWidget200Response createDashboardWidget(dashboardWidgetCreateInputs)
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Creates a new widget on a dashboard using a specified analytics endpoint and widget configuration, and requires update permission on dashboards.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.createDashboardWidget(
|
|
|
67
67
|
# **deleteDashboardWidget**
|
|
68
68
|
> SyncAccounts200Response deleteDashboardWidget()
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
Permanently deletes a single widget from a dashboard, and requires update permission on dashboards.
|
|
71
71
|
|
|
72
72
|
### Example
|
|
73
73
|
|
|
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.deleteDashboardWidget(
|
|
|
121
121
|
# **getDashboardWidgets**
|
|
122
122
|
> GetDashboardWidgets200Response getDashboardWidgets()
|
|
123
123
|
|
|
124
|
-
|
|
124
|
+
Returns the analytics widgets that can be added to the given dashboard, scoped to event or session widgets for event dashboards and organization widgets otherwise, optionally filtered by widget type; requires read permission on dashboards.
|
|
125
125
|
|
|
126
126
|
### Example
|
|
127
127
|
|
|
@@ -175,7 +175,7 @@ const { status, data } = await apiInstance.getDashboardWidgets(
|
|
|
175
175
|
# **updateDashboardWidget**
|
|
176
176
|
> CreateDashboardWidget200Response updateDashboardWidget(dashboardWidgetUpdateInputs)
|
|
177
177
|
|
|
178
|
-
|
|
178
|
+
Updates the configuration of an existing widget on a dashboard, such as its layout, title, or settings, and requires update permission on dashboards.
|
|
179
179
|
|
|
180
180
|
### Example
|
|
181
181
|
|
package/docs/EmailReceiptsApi.md
CHANGED
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getEmailReceipt**](#getemailreceipt) | **GET** /logs/email-receipts/{emailReceiptId} | Get
|
|
8
|
-
|[**getEmailReceipts**](#getemailreceipts) | **GET** /logs/email-receipts |
|
|
7
|
+
|[**getEmailReceipt**](#getemailreceipt) | **GET** /logs/email-receipts/{emailReceiptId} | Get an email receipt|
|
|
8
|
+
|[**getEmailReceipts**](#getemailreceipts) | **GET** /logs/email-receipts | List email receipts|
|
|
9
9
|
|
|
10
10
|
# **getEmailReceipt**
|
|
11
11
|
> GetEmailReceipt200Response getEmailReceipt()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Returns a single logged email receipt by ID, including its delivery status; requires read permission on logs.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -61,7 +61,7 @@ const { status, data } = await apiInstance.getEmailReceipt(
|
|
|
61
61
|
# **getEmailReceipts**
|
|
62
62
|
> GetEmailReceipts200Response getEmailReceipts()
|
|
63
63
|
|
|
64
|
-
|
|
64
|
+
Returns a paginated list of logged email receipts for the organization, optionally filtered by delivery status and searched by keyword; requires read permission on logs.
|
|
65
65
|
|
|
66
66
|
### Example
|
|
67
67
|
|
package/docs/EventsAccessApi.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
|
-
|[**addEventAccessUser**](#addeventaccessuser) | **POST** /events/{eventId}/access-users |
|
|
8
|
-
|[**getEventAccessUsers**](#geteventaccessusers) | **GET** /events/{eventId}/access-users |
|
|
9
|
-
|[**removeEventAccessUser**](#removeeventaccessuser) | **DELETE** /events/{eventId}/access-users/{userId} |
|
|
7
|
+
|[**addEventAccessUser**](#addeventaccessuser) | **POST** /events/{eventId}/access-users | Grant a user access to an event|
|
|
8
|
+
|[**getEventAccessUsers**](#geteventaccessusers) | **GET** /events/{eventId}/access-users | List an event\'s access users|
|
|
9
|
+
|[**removeEventAccessUser**](#removeeventaccessuser) | **DELETE** /events/{eventId}/access-users/{userId} | Revoke a user\'s private event access|
|
|
10
10
|
|
|
11
11
|
# **addEventAccessUser**
|
|
12
12
|
> SyncAccounts200Response addEventAccessUser()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Looks up an existing platform user by email and grants them admin access to manage a specific event, and requires update permission on events; fails if no user with that email exists.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addEventAccessUser(
|
|
|
65
65
|
# **getEventAccessUsers**
|
|
66
66
|
> GetEventAccessUsers200Response getEventAccessUsers()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Returns a paginated list of users granted access to the given private or restricted event, searchable by keyword; requires read permission on events.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getEventAccessUsers(
|
|
|
128
128
|
# **removeEventAccessUser**
|
|
129
129
|
> SyncAccounts200Response removeEventAccessUser()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Removes a user from the list of users explicitly granted access to a private event, revoking their ability to view or purchase it; requires update permission on events.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
|
@@ -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
|
-
|[**createEventActivation**](#createeventactivation) | **POST** /events/{eventId}/activations | Create
|
|
8
|
-
|[**createEventActivationCompletion**](#createeventactivationcompletion) | **POST** /events/{eventId}/activations/{activationId}/completions |
|
|
9
|
-
|[**deleteEventActivation**](#deleteeventactivation) | **DELETE** /events/{eventId}/activations/{activationId} | Delete
|
|
10
|
-
|[**deleteEventActivationCompletion**](#deleteeventactivationcompletion) | **DELETE** /events/{eventId}/activations/{activationId}/completions/{completionId} | Delete
|
|
11
|
-
|[**getEventActivation**](#geteventactivation) | **GET** /events/{eventId}/activations/{activationId} | Get
|
|
12
|
-
|[**getEventActivationCompletion**](#geteventactivationcompletion) | **GET** /events/{eventId}/activations/{activationId}/completions/{completionId} | Get
|
|
13
|
-
|[**getEventActivationCompletions**](#geteventactivationcompletions) | **GET** /events/{eventId}/activations/{activationId}/completions |
|
|
14
|
-
|[**getEventActivationSessions**](#geteventactivationsessions) | **GET** /events/{eventId}/activations/{activationId}/sessions |
|
|
15
|
-
|[**getEventActivations**](#geteventactivations) | **GET** /events/{eventId}/activations |
|
|
16
|
-
|[**updateEventActivation**](#updateeventactivation) | **PUT** /events/{eventId}/activations/{activationId} | Update
|
|
17
|
-
|[**updateEventActivationCompletion**](#updateeventactivationcompletion) | **PUT** /events/{eventId}/activations/{activationId}/completions/{completionId} | Update
|
|
7
|
+
|[**createEventActivation**](#createeventactivation) | **POST** /events/{eventId}/activations | Create an event activation|
|
|
8
|
+
|[**createEventActivationCompletion**](#createeventactivationcompletion) | **POST** /events/{eventId}/activations/{activationId}/completions | Record an attendee\'s activation completion|
|
|
9
|
+
|[**deleteEventActivation**](#deleteeventactivation) | **DELETE** /events/{eventId}/activations/{activationId} | Delete an event activation|
|
|
10
|
+
|[**deleteEventActivationCompletion**](#deleteeventactivationcompletion) | **DELETE** /events/{eventId}/activations/{activationId}/completions/{completionId} | Delete an activation completion record|
|
|
11
|
+
|[**getEventActivation**](#geteventactivation) | **GET** /events/{eventId}/activations/{activationId} | Get an event activation|
|
|
12
|
+
|[**getEventActivationCompletion**](#geteventactivationcompletion) | **GET** /events/{eventId}/activations/{activationId}/completions/{completionId} | Get an activation completion record|
|
|
13
|
+
|[**getEventActivationCompletions**](#geteventactivationcompletions) | **GET** /events/{eventId}/activations/{activationId}/completions | List completions for an activation|
|
|
14
|
+
|[**getEventActivationSessions**](#geteventactivationsessions) | **GET** /events/{eventId}/activations/{activationId}/sessions | List sessions linked to an activation|
|
|
15
|
+
|[**getEventActivations**](#geteventactivations) | **GET** /events/{eventId}/activations | List an event\'s activations|
|
|
16
|
+
|[**updateEventActivation**](#updateeventactivation) | **PUT** /events/{eventId}/activations/{activationId} | Update an event activation|
|
|
17
|
+
|[**updateEventActivationCompletion**](#updateeventactivationcompletion) | **PUT** /events/{eventId}/activations/{activationId}/completions/{completionId} | Update an activation completion\'s earned points|
|
|
18
18
|
|
|
19
19
|
# **createEventActivation**
|
|
20
20
|
> CreateEventActivation200Response createEventActivation(eventActivationCreateInputs)
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
Creates a new activation (e.g. a scavenger-hunt or reward task) on the given event, automatically assigning its display sort order if one is not provided; requires update permission on events.
|
|
23
23
|
|
|
24
24
|
### Example
|
|
25
25
|
|
|
@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.createEventActivation(
|
|
|
74
74
|
# **createEventActivationCompletion**
|
|
75
75
|
> CreateEventActivationCompletion200Response createEventActivationCompletion(eventActivationCompletionCreateInputs)
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
Marks an activation as completed for the pass given in the request body, awarding its points (or a specified earned-points amount for \"input\" reward types) and failing if that pass has already completed the activation; requires update permission on events.
|
|
78
78
|
|
|
79
79
|
### Example
|
|
80
80
|
|
|
@@ -132,7 +132,7 @@ const { status, data } = await apiInstance.createEventActivationCompletion(
|
|
|
132
132
|
# **deleteEventActivation**
|
|
133
133
|
> CreateAccountInvitations200Response deleteEventActivation()
|
|
134
134
|
|
|
135
|
-
|
|
135
|
+
Permanently deletes an activation from the given event, along with its association to any sessions; requires update permission on events.
|
|
136
136
|
|
|
137
137
|
### Example
|
|
138
138
|
|
|
@@ -186,7 +186,7 @@ const { status, data } = await apiInstance.deleteEventActivation(
|
|
|
186
186
|
# **deleteEventActivationCompletion**
|
|
187
187
|
> CreateAccountInvitations200Response deleteEventActivationCompletion()
|
|
188
188
|
|
|
189
|
-
|
|
189
|
+
Permanently removes a specific attendee\'s completion record for an event activation, effectively un-completing it; requires update permission on events.
|
|
190
190
|
|
|
191
191
|
### Example
|
|
192
192
|
|
|
@@ -243,7 +243,7 @@ const { status, data } = await apiInstance.deleteEventActivationCompletion(
|
|
|
243
243
|
# **getEventActivation**
|
|
244
244
|
> CreateEventActivation200Response getEventActivation()
|
|
245
245
|
|
|
246
|
-
|
|
246
|
+
Retrieves a single activation by ID or slug for the given event, including its configuration and reward details; requires read access to the event\'s events module.
|
|
247
247
|
|
|
248
248
|
### Example
|
|
249
249
|
|
|
@@ -297,7 +297,7 @@ const { status, data } = await apiInstance.getEventActivation(
|
|
|
297
297
|
# **getEventActivationCompletion**
|
|
298
298
|
> CreateEventActivationCompletion200Response getEventActivationCompletion()
|
|
299
299
|
|
|
300
|
-
|
|
300
|
+
Retrieves a single completion record for an event activation, showing the pass that completed it and the points earned; requires read access to the event\'s events module.
|
|
301
301
|
|
|
302
302
|
### Example
|
|
303
303
|
|
|
@@ -354,7 +354,7 @@ const { status, data } = await apiInstance.getEventActivationCompletion(
|
|
|
354
354
|
# **getEventActivationCompletions**
|
|
355
355
|
> GetEventActivationCompletions200Response getEventActivationCompletions()
|
|
356
356
|
|
|
357
|
-
|
|
357
|
+
Returns a paginated list of completion records for an event activation, searchable by the completing attendee\'s name, username, or email; requires read access to the event\'s events module.
|
|
358
358
|
|
|
359
359
|
### Example
|
|
360
360
|
|
|
@@ -420,7 +420,7 @@ const { status, data } = await apiInstance.getEventActivationCompletions(
|
|
|
420
420
|
# **getEventActivationSessions**
|
|
421
421
|
> GetEventActivationSessions200Response getEventActivationSessions()
|
|
422
422
|
|
|
423
|
-
|
|
423
|
+
Returns a paginated list of event sessions associated with the specified activation, supporting search and ordering; requires read access to the event\'s events module.
|
|
424
424
|
|
|
425
425
|
### Example
|
|
426
426
|
|
|
@@ -486,7 +486,7 @@ const { status, data } = await apiInstance.getEventActivationSessions(
|
|
|
486
486
|
# **getEventActivations**
|
|
487
487
|
> GetEventActivations200Response getEventActivations()
|
|
488
488
|
|
|
489
|
-
|
|
489
|
+
Returns a paginated list of activations configured for the given event, supporting search and ordering; requires read access to the event\'s events module.
|
|
490
490
|
|
|
491
491
|
### Example
|
|
492
492
|
|
|
@@ -549,7 +549,7 @@ const { status, data } = await apiInstance.getEventActivations(
|
|
|
549
549
|
# **updateEventActivation**
|
|
550
550
|
> CreateEventActivation200Response updateEventActivation(eventActivationUpdateInputs)
|
|
551
551
|
|
|
552
|
-
|
|
552
|
+
Updates the fields of a gamification activation for the given event, such as its name, points, or configuration; requires the update permission on events.
|
|
553
553
|
|
|
554
554
|
### Example
|
|
555
555
|
|
|
@@ -607,7 +607,7 @@ const { status, data } = await apiInstance.updateEventActivation(
|
|
|
607
607
|
# **updateEventActivationCompletion**
|
|
608
608
|
> CreateEventActivationCompletion200Response updateEventActivationCompletion(eventActivationCompletionUpdateInputs)
|
|
609
609
|
|
|
610
|
-
|
|
610
|
+
Updates the earned points on an existing completion record for the given event activation, identified by completion id; requires the update permission on events.
|
|
611
611
|
|
|
612
612
|
### Example
|
|
613
613
|
|
|
@@ -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
|
-
|[**addEventActivationSession**](#addeventactivationsession) | **POST** /events/{eventId}/activations/{activationId}/sessions/{sessionId} |
|
|
8
|
-
|[**removeEventActivationSession**](#removeeventactivationsession) | **DELETE** /events/{eventId}/activations/{activationId}/sessions/{sessionId} |
|
|
9
|
-
|[**removeEventActivationSessions**](#removeeventactivationsessions) | **DELETE** /events/{eventId}/activations/{activationId}/sessions |
|
|
7
|
+
|[**addEventActivationSession**](#addeventactivationsession) | **POST** /events/{eventId}/activations/{activationId}/sessions/{sessionId} | Attach a session to an activation|
|
|
8
|
+
|[**removeEventActivationSession**](#removeeventactivationsession) | **DELETE** /events/{eventId}/activations/{activationId}/sessions/{sessionId} | Detach a session from an activation|
|
|
9
|
+
|[**removeEventActivationSessions**](#removeeventactivationsessions) | **DELETE** /events/{eventId}/activations/{activationId}/sessions | Detach all sessions from an activation|
|
|
10
10
|
|
|
11
11
|
# **addEventActivationSession**
|
|
12
12
|
> CreateEventActivation200Response addEventActivationSession()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Links an existing event session to an activation so checking in to that session counts toward completing it, failing if the session is already connected to another activation or if the activation\'s reward type is \"input\"; requires update permission on events.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.addEventActivationSession(
|
|
|
68
68
|
# **removeEventActivationSession**
|
|
69
69
|
> CreateEventActivation200Response removeEventActivationSession()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Disconnects a single event session from an activation so checking in to it no longer counts toward completing the activation; requires update permission on events.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.removeEventActivationSession(
|
|
|
125
125
|
# **removeEventActivationSessions**
|
|
126
126
|
> CreateEventActivation200Response removeEventActivationSessions()
|
|
127
127
|
|
|
128
|
-
|
|
128
|
+
Disconnects every event session currently linked to an activation, clearing its session-based check-in requirements in a single call; requires update permission on events.
|
|
129
129
|
|
|
130
130
|
### Example
|
|
131
131
|
|
|
@@ -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
|
-
|[**deleteEventActivationTranslation**](#deleteeventactivationtranslation) | **DELETE** /events/{eventId}/activations/{activationId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventActivationTranslation**](#geteventactivationtranslation) | **GET** /events/{eventId}/activations/{activationId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventActivationTranslations**](#geteventactivationtranslations) | **GET** /events/{eventId}/activations/{activationId}/translations |
|
|
10
|
-
|[**updateEventActivationTranslation**](#updateeventactivationtranslation) | **PUT** /events/{eventId}/activations/{activationId}/translations/{locale} |
|
|
7
|
+
|[**deleteEventActivationTranslation**](#deleteeventactivationtranslation) | **DELETE** /events/{eventId}/activations/{activationId}/translations/{locale} | Delete an activation\'s translation|
|
|
8
|
+
|[**getEventActivationTranslation**](#geteventactivationtranslation) | **GET** /events/{eventId}/activations/{activationId}/translations/{locale} | Get an event activation\'s translation|
|
|
9
|
+
|[**getEventActivationTranslations**](#geteventactivationtranslations) | **GET** /events/{eventId}/activations/{activationId}/translations | List translations for an activation|
|
|
10
|
+
|[**updateEventActivationTranslation**](#updateeventactivationtranslation) | **PUT** /events/{eventId}/activations/{activationId}/translations/{locale} | Create or update an activation\'s translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventActivationTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventActivationTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the translated content for an event activation in the specified locale, deleting that locale\'s name and descriptions; requires update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventActivationTranslation(
|
|
|
69
69
|
# **getEventActivationTranslation**
|
|
70
70
|
> GetEventActivationTranslation200Response getEventActivationTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Returns the translated content for a given event activation in the specified locale, or null if no translation exists for that locale; requires read permission on events.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventActivationTranslation(
|
|
|
126
126
|
# **getEventActivationTranslations**
|
|
127
127
|
> GetEventActivationTranslations200Response getEventActivationTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of locale translations for the specified event activation, supporting search and ordering; requires read access to the event\'s events module.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventActivationTranslations(
|
|
|
192
192
|
# **updateEventActivationTranslation**
|
|
193
193
|
> UpdateEventActivationTranslation200Response updateEventActivationTranslation(eventActivationTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Upserts the translated name and descriptions for an event activation in the specified locale, creating the translation record if it does not already exist; requires update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
package/docs/EventsAddonsApi.md
CHANGED
|
@@ -4,23 +4,23 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventAddOnPassType**](#addeventaddonpasstype) | **POST** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} |
|
|
8
|
-
|[**addEventAddOnTier**](#addeventaddontier) | **POST** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} |
|
|
9
|
-
|[**createEventAddOn**](#createeventaddon) | **POST** /events/{eventId}/addOns | Create
|
|
10
|
-
|[**deleteEventAddOn**](#deleteeventaddon) | **DELETE** /events/{eventId}/addOns/{addOnId} | Delete
|
|
11
|
-
|[**getEventAddOn**](#geteventaddon) | **GET** /events/{eventId}/addOns/{addOnId} | Get
|
|
12
|
-
|[**getEventAddOnPassTypes**](#geteventaddonpasstypes) | **GET** /events/{eventId}/addOns/{addOnId}/passTypes |
|
|
13
|
-
|[**getEventAddOnPasses**](#geteventaddonpasses) | **GET** /events/{eventId}/addOns/{addOnId}/passes |
|
|
14
|
-
|[**getEventAddOnTiers**](#geteventaddontiers) | **GET** /events/{eventId}/addOns/{addOnId}/tiers |
|
|
15
|
-
|[**getEventAddOns**](#geteventaddons) | **GET** /events/{eventId}/addOns |
|
|
16
|
-
|[**removeEventAddOnPassType**](#removeeventaddonpasstype) | **DELETE** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} |
|
|
17
|
-
|[**removeEventAddOnTier**](#removeeventaddontier) | **DELETE** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} | Remove
|
|
18
|
-
|[**updateEventAddOn**](#updateeventaddon) | **PUT** /events/{eventId}/addOns/{addOnId} | Update
|
|
7
|
+
|[**addEventAddOnPassType**](#addeventaddonpasstype) | **POST** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} | Allow a pass type to purchase an add-on|
|
|
8
|
+
|[**addEventAddOnTier**](#addeventaddontier) | **POST** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} | Set an account tier\'s access to an add-on|
|
|
9
|
+
|[**createEventAddOn**](#createeventaddon) | **POST** /events/{eventId}/addOns | Create an event add-on|
|
|
10
|
+
|[**deleteEventAddOn**](#deleteeventaddon) | **DELETE** /events/{eventId}/addOns/{addOnId} | Delete an event add-on|
|
|
11
|
+
|[**getEventAddOn**](#geteventaddon) | **GET** /events/{eventId}/addOns/{addOnId} | Get an event add-on|
|
|
12
|
+
|[**getEventAddOnPassTypes**](#geteventaddonpasstypes) | **GET** /events/{eventId}/addOns/{addOnId}/passTypes | List pass types eligible for an add-on|
|
|
13
|
+
|[**getEventAddOnPasses**](#geteventaddonpasses) | **GET** /events/{eventId}/addOns/{addOnId}/passes | List purchases of an event add-on|
|
|
14
|
+
|[**getEventAddOnTiers**](#geteventaddontiers) | **GET** /events/{eventId}/addOns/{addOnId}/tiers | List account tiers allowed or disallowed for an add-on|
|
|
15
|
+
|[**getEventAddOns**](#geteventaddons) | **GET** /events/{eventId}/addOns | List an event\'s add-ons|
|
|
16
|
+
|[**removeEventAddOnPassType**](#removeeventaddonpasstype) | **DELETE** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} | Revoke a pass type\'s access to an add-on|
|
|
17
|
+
|[**removeEventAddOnTier**](#removeeventaddontier) | **DELETE** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} | Remove an account tier\'s access setting from an add-on|
|
|
18
|
+
|[**updateEventAddOn**](#updateeventaddon) | **PUT** /events/{eventId}/addOns/{addOnId} | Update an event add-on|
|
|
19
19
|
|
|
20
20
|
# **addEventAddOnPassType**
|
|
21
21
|
> CreateEventAddOn200Response addEventAddOnPassType()
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
Adds the given pass type to the add-on\'s allowed pass types, permitting attendees with that pass type to purchase the event add-on; requires the update permission on events.
|
|
24
24
|
|
|
25
25
|
### Example
|
|
26
26
|
|
|
@@ -77,7 +77,7 @@ const { status, data } = await apiInstance.addEventAddOnPassType(
|
|
|
77
77
|
# **addEventAddOnTier**
|
|
78
78
|
> CreateEventAddOn200Response addEventAddOnTier()
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
Adds the given account tier to the add-on\'s allowed or disallowed tier list, controlling whether members of that tier can purchase the event add-on, based on the `allowed` flag; requires the update permission on events.
|
|
81
81
|
|
|
82
82
|
### Example
|
|
83
83
|
|
|
@@ -137,7 +137,7 @@ const { status, data } = await apiInstance.addEventAddOnTier(
|
|
|
137
137
|
# **createEventAddOn**
|
|
138
138
|
> CreateEventAddOn200Response createEventAddOn(eventAddOnCreateInputs)
|
|
139
139
|
|
|
140
|
-
|
|
140
|
+
Creates a new purchasable add-on (e.g. merchandise, upgrade) for the given event; requires the update permission on events.
|
|
141
141
|
|
|
142
142
|
### Example
|
|
143
143
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.createEventAddOn(
|
|
|
192
192
|
# **deleteEventAddOn**
|
|
193
193
|
> CreateAccountInvitations200Response deleteEventAddOn()
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Permanently removes a purchasable add-on from the given event; requires the update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
|
@@ -246,7 +246,7 @@ const { status, data } = await apiInstance.deleteEventAddOn(
|
|
|
246
246
|
# **getEventAddOn**
|
|
247
247
|
> CreateEventAddOn200Response getEventAddOn()
|
|
248
248
|
|
|
249
|
-
|
|
249
|
+
Retrieves a single add-on by ID for the given event, including its pricing and configuration details; requires read access to the event\'s events module.
|
|
250
250
|
|
|
251
251
|
### Example
|
|
252
252
|
|
|
@@ -300,7 +300,7 @@ const { status, data } = await apiInstance.getEventAddOn(
|
|
|
300
300
|
# **getEventAddOnPassTypes**
|
|
301
301
|
> GetEventAddOnPassTypes200Response getEventAddOnPassTypes()
|
|
302
302
|
|
|
303
|
-
|
|
303
|
+
Returns a paginated list of the event\'s pass types (tickets) that the given add-on is available for, supporting search and ordering; requires read permission on events.
|
|
304
304
|
|
|
305
305
|
### Example
|
|
306
306
|
|
|
@@ -366,7 +366,7 @@ const { status, data } = await apiInstance.getEventAddOnPassTypes(
|
|
|
366
366
|
# **getEventAddOnPasses**
|
|
367
367
|
> GetEventAddOnPasses200Response getEventAddOnPasses()
|
|
368
368
|
|
|
369
|
-
|
|
369
|
+
Returns a paginated list of pass purchases (in needsInfo, ready, or pending status) that include the given add-on for the specified event, supporting search and ordering; requires read permission on events and attendees.
|
|
370
370
|
|
|
371
371
|
### Example
|
|
372
372
|
|
|
@@ -432,7 +432,7 @@ const { status, data } = await apiInstance.getEventAddOnPasses(
|
|
|
432
432
|
# **getEventAddOnTiers**
|
|
433
433
|
> GetAccountTiers200Response getEventAddOnTiers()
|
|
434
434
|
|
|
435
|
-
|
|
435
|
+
Returns a paginated list of account tiers that are either allowed or disallowed (per the required `allowed` flag) from purchasing the given event add-on, supporting search and ordering; requires read permission on events and tiers.
|
|
436
436
|
|
|
437
437
|
### Example
|
|
438
438
|
|
|
@@ -501,7 +501,7 @@ const { status, data } = await apiInstance.getEventAddOnTiers(
|
|
|
501
501
|
# **getEventAddOns**
|
|
502
502
|
> GetEventAddOns200Response getEventAddOns()
|
|
503
503
|
|
|
504
|
-
|
|
504
|
+
Returns a paginated list of add-ons configured for the specified event, supporting search and ordering; requires read permission on events.
|
|
505
505
|
|
|
506
506
|
### Example
|
|
507
507
|
|
|
@@ -564,7 +564,7 @@ const { status, data } = await apiInstance.getEventAddOns(
|
|
|
564
564
|
# **removeEventAddOnPassType**
|
|
565
565
|
> CreateEventAddOn200Response removeEventAddOnPassType()
|
|
566
566
|
|
|
567
|
-
|
|
567
|
+
Removes the given pass type from the add-on\'s allowed pass types, preventing attendees with that pass type from purchasing the event add-on; requires the update permission on events.
|
|
568
568
|
|
|
569
569
|
### Example
|
|
570
570
|
|
|
@@ -621,7 +621,7 @@ const { status, data } = await apiInstance.removeEventAddOnPassType(
|
|
|
621
621
|
# **removeEventAddOnTier**
|
|
622
622
|
> CreateEventAddOn200Response removeEventAddOnTier()
|
|
623
623
|
|
|
624
|
-
|
|
624
|
+
Removes the given account tier from the add-on\'s allowed or disallowed tier list (per the `allowed` flag), clearing that tier\'s explicit access rule for the event add-on; requires the update permission on events.
|
|
625
625
|
|
|
626
626
|
### Example
|
|
627
627
|
|
|
@@ -681,7 +681,7 @@ const { status, data } = await apiInstance.removeEventAddOnTier(
|
|
|
681
681
|
# **updateEventAddOn**
|
|
682
682
|
> CreateEventAddOn200Response updateEventAddOn()
|
|
683
683
|
|
|
684
|
-
|
|
684
|
+
Updates an existing add-on for an event, including its name, pricing, and related settings; if a new sortOrder is provided the other add-ons for the event are reordered around it, and this requires read and update permission on events.
|
|
685
685
|
|
|
686
686
|
### Example
|
|
687
687
|
|
|
@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteEventAddOnTranslation**](#deleteeventaddontranslation) | **DELETE** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventAddOnTranslation**](#geteventaddontranslation) | **GET** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventAddOnTranslations**](#geteventaddontranslations) | **GET** /events/{eventId}/addOns/{addOnId}/translations |
|
|
10
|
-
|[**updateEventAddOnTranslation**](#updateeventaddontranslation) | **PUT** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventAddOnTranslation**](#deleteeventaddontranslation) | **DELETE** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Delete an event add-on translation|
|
|
8
|
+
|[**getEventAddOnTranslation**](#geteventaddontranslation) | **GET** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Get an add-on translation for a locale|
|
|
9
|
+
|[**getEventAddOnTranslations**](#geteventaddontranslations) | **GET** /events/{eventId}/addOns/{addOnId}/translations | List translations for an add-on|
|
|
10
|
+
|[**updateEventAddOnTranslation**](#updateeventaddontranslation) | **PUT** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Update an event add-on translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventAddOnTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventAddOnTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the translation for a given locale from an event add-on, reverting that locale to the add-on\'s default content; requires the update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventAddOnTranslation(
|
|
|
69
69
|
# **getEventAddOnTranslation**
|
|
70
70
|
> GetEventAddOnTranslation200Response getEventAddOnTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Retrieves the translated text for a single event add-on in the specified locale, or null if no translation exists for that locale; requires read access to the event\'s events module.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventAddOnTranslation(
|
|
|
126
126
|
# **getEventAddOnTranslations**
|
|
127
127
|
> GetEventAddOnTranslations200Response getEventAddOnTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of locale translations for the specified event add-on, supporting search and ordering; requires read access to the event\'s events module.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventAddOnTranslations(
|
|
|
192
192
|
# **updateEventAddOnTranslation**
|
|
193
193
|
> UpdateEventAddOnTranslation200Response updateEventAddOnTranslation(eventAddOnTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Creates or updates the localized content (e.g. name, description) for an event add-on in the given locale; requires the update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|