@connectedxm/admin-sdk 7.4.1 → 7.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1212 -1209
- package/api.ts +10059 -9672
- package/dist/api.d.ts +9869 -9672
- package/dist/api.js +9948 -9672
- package/dist/esm/api.d.ts +9869 -9672
- package/dist/esm/api.js +9948 -9672
- package/docs/AccountsAddressesApi.md +10 -10
- package/docs/AccountsApi.md +42 -42
- package/docs/AccountsFollowersApi.md +6 -6
- package/docs/AccountsFollowingApi.md +6 -6
- package/docs/AccountsGroupsApi.md +6 -6
- package/docs/AccountsInterestsApi.md +6 -6
- package/docs/AccountsInvitationsApi.md +6 -6
- package/docs/AccountsLeadsApi.md +8 -8
- package/docs/AccountsTiersApi.md +8 -8
- package/docs/ActivitiesApi.md +18 -18
- package/docs/ActivitiesScheduleApi.md +4 -4
- package/docs/AdvertisementsApi.md +14 -14
- package/docs/AnnouncementsApi.md +16 -16
- package/docs/AnnouncementsScheduleApi.md +4 -4
- package/docs/AnnouncementsTranslationsApi.md +8 -8
- package/docs/ApiLogsApi.md +4 -4
- package/docs/AuthSessionsApi.md +4 -4
- package/docs/BenefitsApi.md +12 -12
- package/docs/BenefitsTranslationsApi.md +8 -8
- package/docs/BookingsApi.md +56 -56
- package/docs/BookingsAvailabilitiesApi.md +6 -6
- package/docs/BookingsBlackoutsApi.md +6 -6
- package/docs/BookingsPlacesApi.md +6 -6
- package/docs/BookingsPlacesTranslationsApi.md +4 -4
- package/docs/BookingsQuestionsApi.md +16 -16
- package/docs/BookingsQuestionsChoicesApi.md +12 -12
- package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
- package/docs/BookingsQuestionsTranslationsApi.md +8 -8
- package/docs/BookingsSpacesApi.md +6 -6
- package/docs/BookingsSpacesTranslationsApi.md +4 -4
- package/docs/ChannelsApi.md +58 -58
- package/docs/ChannelsTranslationsApi.md +24 -24
- package/docs/Coupon.md +4 -0
- package/docs/DashboardsApi.md +10 -10
- package/docs/DashboardsWidgetsApi.md +8 -8
- package/docs/EmailReceiptsApi.md +4 -4
- package/docs/EventsAccessApi.md +6 -6
- package/docs/EventsActivationsApi.md +22 -22
- package/docs/EventsActivationsSessionsApi.md +6 -6
- package/docs/EventsActivationsTranslationsApi.md +8 -8
- package/docs/EventsAddonsApi.md +24 -24
- package/docs/EventsAddonsTranslationsApi.md +8 -8
- package/docs/EventsApi.md +22 -22
- package/docs/EventsAttendeesApi.md +24 -24
- package/docs/EventsAttendeesPackagesApi.md +10 -10
- package/docs/EventsAttendeesReservationsApi.md +18 -18
- package/docs/EventsAttributesApi.md +10 -10
- package/docs/EventsBenefitsApi.md +4 -4
- package/docs/EventsBlocksApi.md +16 -16
- package/docs/EventsBypassApi.md +10 -10
- package/docs/EventsCohostsApi.md +6 -6
- package/docs/EventsCouponsApi.md +214 -22
- package/docs/EventsEmailsApi.md +4 -4
- package/docs/EventsEmailsTranslationsApi.md +8 -8
- package/docs/EventsFaqsApi.md +22 -22
- package/docs/EventsFaqsTranslationsApi.md +16 -16
- package/docs/EventsFollowupsApi.md +38 -38
- package/docs/EventsFollowupsTranslationsApi.md +8 -8
- package/docs/EventsMatchesApi.md +34 -34
- package/docs/EventsMediaApi.md +16 -16
- package/docs/EventsMediaTranslationsApi.md +8 -8
- package/docs/EventsOnSiteApi.md +6 -6
- package/docs/EventsPackagesApi.md +10 -10
- package/docs/EventsPackagesPassesApi.md +10 -10
- package/docs/EventsPackagesTranslationsApi.md +8 -8
- package/docs/EventsPagesApi.md +16 -16
- package/docs/EventsPagesTranslationsApi.md +8 -8
- package/docs/EventsPassesAccessesApi.md +10 -10
- package/docs/EventsPassesAddonsApi.md +6 -6
- package/docs/EventsPassesApi.md +34 -34
- package/docs/EventsPassesAttributesApi.md +6 -6
- package/docs/EventsPassesFollowupsApi.md +8 -8
- package/docs/EventsPassesResponsesApi.md +10 -10
- package/docs/EventsPasstypesApi.md +34 -34
- package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
- package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
- package/docs/EventsPasstypesTranslationsApi.md +8 -8
- package/docs/EventsQuestionsApi.md +44 -44
- package/docs/EventsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsRoomsApi.md +18 -18
- package/docs/EventsRoomtypesApi.md +24 -24
- package/docs/EventsRoomtypesTranslationsApi.md +8 -8
- package/docs/EventsSectionsApi.md +38 -38
- package/docs/EventsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsAccessesApi.md +6 -6
- package/docs/EventsSessionsApi.md +70 -70
- package/docs/EventsSessionsLocationsApi.md +16 -16
- package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
- package/docs/EventsSessionsMatchesApi.md +32 -32
- package/docs/EventsSessionsPricesApi.md +6 -6
- package/docs/EventsSessionsQuestionsApi.md +38 -38
- package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsSessionsSectionsApi.md +20 -20
- package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsTimesApi.md +16 -16
- package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
- package/docs/EventsSessionsTranslationsApi.md +8 -8
- package/docs/EventsSpeakersApi.md +16 -16
- package/docs/EventsSpeakersTranslationsApi.md +8 -8
- package/docs/EventsSponsorsApi.md +8 -8
- package/docs/EventsSponsorshiplevelsApi.md +12 -12
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
- package/docs/EventsSponsorshipsApi.md +12 -12
- package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
- package/docs/EventsTemplatesApi.md +2 -2
- package/docs/EventsTracksApi.md +22 -22
- package/docs/EventsTracksTranslationsApi.md +8 -8
- package/docs/EventsTransfersApi.md +4 -4
- package/docs/EventsTranslationsApi.md +8 -8
- package/docs/FilesApi.md +4 -4
- package/docs/GroupsApi.md +12 -12
- package/docs/GroupsEventsApi.md +6 -6
- package/docs/GroupsInterestsApi.md +6 -6
- package/docs/GroupsInvitationsApi.md +12 -12
- package/docs/GroupsMembersApi.md +8 -8
- package/docs/GroupsModeratorsApi.md +6 -6
- package/docs/GroupsRequestsApi.md +10 -10
- package/docs/GroupsSponsorsApi.md +6 -6
- package/docs/GroupsTranslationsApi.md +8 -8
- package/docs/ImportsApi.md +8 -8
- package/docs/InterestsApi.md +22 -22
- package/docs/InvoicesApi.md +20 -20
- package/docs/InvoicesLineitemsApi.md +6 -6
- package/docs/LoginsAccountsApi.md +6 -6
- package/docs/LoginsApi.md +16 -16
- package/docs/MeetingsApi.md +14 -14
- package/docs/MeetingsLinksApi.md +10 -10
- package/docs/MeetingsLivestreamsApi.md +12 -12
- package/docs/MeetingsParticipantsApi.md +12 -12
- package/docs/MeetingsPresetsApi.md +10 -10
- package/docs/MeetingsRecordingsApi.md +4 -4
- package/docs/MeetingsSessionsApi.md +16 -16
- package/docs/NotificationsApi.md +8 -8
- package/docs/OrganizationApi.md +18 -18
- package/docs/OrganizationAttributesApi.md +14 -14
- package/docs/OrganizationDomainsApi.md +6 -6
- package/docs/OrganizationIntegrationsApi.md +10 -10
- package/docs/OrganizationModulesApi.md +6 -6
- package/docs/OrganizationModulesCustomApi.md +10 -10
- package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
- package/docs/OrganizationModulesSettingsApi.md +4 -4
- package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
- package/docs/OrganizationModulesTiersApi.md +12 -12
- package/docs/OrganizationPaymentsApi.md +20 -20
- package/docs/OrganizationSideeffectsApi.md +8 -8
- package/docs/OrganizationTaxApi.md +22 -22
- package/docs/OrganizationTeammembersApi.md +10 -10
- package/docs/OrganizationUsersApi.md +6 -6
- package/docs/OrganizationWebhooksApi.md +12 -12
- package/docs/PaymentsApi.md +2 -2
- package/docs/PreferencesApi.md +4 -4
- package/docs/PushDevicesApi.md +6 -6
- package/docs/ReportsApi.md +22 -22
- package/docs/ReportsUsersApi.md +6 -6
- package/docs/SearchlistsApi.md +10 -10
- package/docs/SearchlistsValuesApi.md +14 -14
- package/docs/SelfApi.md +10 -10
- package/docs/SelfApikeysApi.md +8 -8
- package/docs/SelfImagesApi.md +4 -4
- package/docs/SeriesApi.md +18 -18
- package/docs/SeriesQuestionsApi.md +14 -14
- package/docs/SeriesQuestionsChoicesApi.md +8 -8
- package/docs/SeriesQuestionsTranslationsApi.md +4 -4
- package/docs/SeriesRegistrationsApi.md +18 -18
- package/docs/SeriesTranslationsApi.md +8 -8
- package/docs/SponsorsAccountsApi.md +6 -6
- package/docs/SponsorsApi.md +10 -10
- package/docs/SponsorsTranslationsApi.md +8 -8
- package/docs/StorageFilesApi.md +6 -6
- package/docs/StorageImagesApi.md +18 -18
- package/docs/StorageVideosApi.md +14 -14
- package/docs/StorageVideosCaptionsApi.md +10 -10
- package/docs/StreamsApi.md +14 -14
- package/docs/StreamsOutputsApi.md +10 -10
- package/docs/StreamsSessionsApi.md +12 -12
- package/docs/SupportApi.md +14 -14
- package/docs/SupportMessagesApi.md +4 -4
- package/docs/SupportNotesApi.md +6 -6
- package/docs/SurveysApi.md +12 -12
- package/docs/SurveysQuestionsApi.md +38 -38
- package/docs/SurveysQuestionsTranslationsApi.md +16 -16
- package/docs/SurveysSectionsApi.md +20 -20
- package/docs/SurveysSectionsTranslationsApi.md +8 -8
- package/docs/SurveysSessionsApi.md +4 -4
- package/docs/SurveysSubmissionsApi.md +14 -14
- package/docs/SurveysTranslationsApi.md +8 -8
- package/docs/ThreadsAccountsApi.md +8 -8
- package/docs/ThreadsApi.md +10 -10
- package/docs/ThreadsMessagesApi.md +12 -12
- package/docs/ThreadsMessagesFilesApi.md +6 -6
- package/docs/ThreadsMessagesImagesApi.md +6 -6
- package/docs/ThreadsMessagesReactionsApi.md +6 -6
- package/docs/ThreadsMessagesVideosApi.md +6 -6
- package/docs/ThreadsStorageApi.md +6 -6
- package/docs/TiersApi.md +20 -20
- package/package.json +1 -1
package/docs/EventsBypassApi.md
CHANGED
|
@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createEventRegistrationBypass**](#createeventregistrationbypass) | **POST** /events/{eventId}/bypass | Create
|
|
8
|
-
|[**deleteEventRegistrationBypass**](#deleteeventregistrationbypass) | **DELETE** /events/{eventId}/bypass/{bypassId} | Delete
|
|
9
|
-
|[**getEventRegistrationBypass**](#geteventregistrationbypass) | **GET** /events/{eventId}/bypass/{bypassId} | Get
|
|
10
|
-
|[**getEventRegistrationBypassList**](#geteventregistrationbypasslist) | **GET** /events/{eventId}/bypass |
|
|
11
|
-
|[**updateEventRegistrationBypass**](#updateeventregistrationbypass) | **PUT** /events/{eventId}/bypass/{bypassId} | Update
|
|
7
|
+
|[**createEventRegistrationBypass**](#createeventregistrationbypass) | **POST** /events/{eventId}/bypass | Create an event registration bypass|
|
|
8
|
+
|[**deleteEventRegistrationBypass**](#deleteeventregistrationbypass) | **DELETE** /events/{eventId}/bypass/{bypassId} | Delete an event registration bypass|
|
|
9
|
+
|[**getEventRegistrationBypass**](#geteventregistrationbypass) | **GET** /events/{eventId}/bypass/{bypassId} | Get a single registration bypass|
|
|
10
|
+
|[**getEventRegistrationBypassList**](#geteventregistrationbypasslist) | **GET** /events/{eventId}/bypass | List an event\'s registration bypasses|
|
|
11
|
+
|[**updateEventRegistrationBypass**](#updateeventregistrationbypass) | **PUT** /events/{eventId}/bypass/{bypassId} | Update an event registration bypass|
|
|
12
12
|
|
|
13
13
|
# **createEventRegistrationBypass**
|
|
14
14
|
> CreateEventRegistrationBypass200Response createEventRegistrationBypass(eventRegistrationBypassCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a registration bypass for the given event, allowing a specific account to skip normal registration requirements, and requires create permission on events.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createEventRegistrationBypass(
|
|
|
68
68
|
# **deleteEventRegistrationBypass**
|
|
69
69
|
> CreateAccountInvitations200Response deleteEventRegistrationBypass()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Permanently deletes the specified registration bypass from the given event and requires delete permission on events.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.deleteEventRegistrationBypass(
|
|
|
122
122
|
# **getEventRegistrationBypass**
|
|
123
123
|
> CreateEventRegistrationBypass200Response getEventRegistrationBypass()
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Retrieves one registration bypass record for the given event by its ID, showing which account it grants access to and which registration restriction (closed, before start, or after end) it bypasses; requires \"read\" permission on events.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.getEventRegistrationBypass(
|
|
|
176
176
|
# **getEventRegistrationBypassList**
|
|
177
177
|
> GetEventRegistrationBypassList200Response getEventRegistrationBypassList()
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Returns a paginated list of registration bypass records for the given event, which grant specific accounts the ability to register outside normal registration windows (before opening, after closing, or while registration is disabled), supporting search by account name/email and `orderBy` sorting; requires \"read\" permission on events.
|
|
180
180
|
|
|
181
181
|
### Example
|
|
182
182
|
|
|
@@ -239,7 +239,7 @@ const { status, data } = await apiInstance.getEventRegistrationBypassList(
|
|
|
239
239
|
# **updateEventRegistrationBypass**
|
|
240
240
|
> CreateEventRegistrationBypass200Response updateEventRegistrationBypass()
|
|
241
241
|
|
|
242
|
-
|
|
242
|
+
Updates the fields of an existing registration bypass on the given event, such as the associated account, and requires update permission on events.
|
|
243
243
|
|
|
244
244
|
### Example
|
|
245
245
|
|
package/docs/EventsCohostsApi.md
CHANGED
|
@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventCoHost**](#addeventcohost) | **POST** /events/{eventId}/coHosts/{accountId} | Add
|
|
8
|
-
|[**getEventCoHosts**](#geteventcohosts) | **GET** /events/{eventId}/coHosts |
|
|
9
|
-
|[**removeEventCoHost**](#removeeventcohost) | **DELETE** /events/{eventId}/coHosts/{accountId} | Remove
|
|
7
|
+
|[**addEventCoHost**](#addeventcohost) | **POST** /events/{eventId}/coHosts/{accountId} | Add a co-host to an event|
|
|
8
|
+
|[**getEventCoHosts**](#geteventcohosts) | **GET** /events/{eventId}/coHosts | List an event\'s co-host accounts|
|
|
9
|
+
|[**removeEventCoHost**](#removeeventcohost) | **DELETE** /events/{eventId}/coHosts/{accountId} | Remove a co-host from an event|
|
|
10
10
|
|
|
11
11
|
# **addEventCoHost**
|
|
12
12
|
> CreateAccount200Response addEventCoHost()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Connects the specified account as a co-host of the given event and requires update permission on events; an account cannot be added as a co-host of itself.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addEventCoHost(
|
|
|
65
65
|
# **getEventCoHosts**
|
|
66
66
|
> GetAccounts200Response getEventCoHosts()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Returns a paginated list of accounts designated as co-hosts of the given event, supporting search and `orderBy` sorting; requires \"read\" permission on events.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getEventCoHosts(
|
|
|
128
128
|
# **removeEventCoHost**
|
|
129
129
|
> CreateAccount200Response removeEventCoHost()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Disconnects the specified account from the given event\'s co-host list and requires update permission on events.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|
package/docs/EventsCouponsApi.md
CHANGED
|
@@ -4,22 +4,85 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
8
|
-
|[**
|
|
9
|
-
|[**
|
|
10
|
-
|[**
|
|
11
|
-
|[**
|
|
12
|
-
|[**
|
|
13
|
-
|[**
|
|
14
|
-
|[**
|
|
15
|
-
|[**
|
|
16
|
-
|[**
|
|
17
|
-
|[**
|
|
7
|
+
|[**addEventCouponTier**](#addeventcoupontier) | **POST** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Add tier to event coupon|
|
|
8
|
+
|[**createEventCoupon**](#createeventcoupon) | **POST** /events/{eventId}/coupons | Create an event coupon|
|
|
9
|
+
|[**createEventCouponVariants**](#createeventcouponvariants) | **POST** /events/{eventId}/coupons/{couponId}/variants | Create variant coupons from a parent coupon|
|
|
10
|
+
|[**deleteEventCoupon**](#deleteeventcoupon) | **DELETE** /events/{eventId}/coupons/{couponId} | Delete an event coupon|
|
|
11
|
+
|[**deleteEventCouponVariants**](#deleteeventcouponvariants) | **DELETE** /events/{eventId}/coupons/{couponId}/variants | Delete all variants of a coupon|
|
|
12
|
+
|[**getEventCoupon**](#geteventcoupon) | **GET** /events/{eventId}/coupons/{couponId} | Get a single event coupon|
|
|
13
|
+
|[**getEventCouponPasses**](#geteventcouponpasses) | **GET** /events/{eventId}/coupons/{couponId}/passes | List purchases made with a coupon|
|
|
14
|
+
|[**getEventCouponPayments**](#geteventcouponpayments) | **GET** /events/{eventId}/coupons/{couponId}/payments | List payments made with a coupon|
|
|
15
|
+
|[**getEventCouponTiers**](#geteventcoupontiers) | **GET** /events/{eventId}/coupons/{couponId}/tiers | List event coupon tiers|
|
|
16
|
+
|[**getEventCouponVariants**](#geteventcouponvariants) | **GET** /events/{eventId}/coupons/{parentCouponId}/variants | List a coupon\'s variants|
|
|
17
|
+
|[**getEventCoupons**](#geteventcoupons) | **GET** /events/{eventId}/coupons | List an event\'s coupons|
|
|
18
|
+
|[**removeEventCouponTier**](#removeeventcoupontier) | **DELETE** /events/{eventId}/coupons/{couponId}/tiers/{tierId} | Remove tier from event coupon|
|
|
19
|
+
|[**syncEventCouponToVariants**](#synceventcoupontovariants) | **PUT** /events/{eventId}/coupons/{couponId}/variants | Sync a coupon\'s fields to its variants|
|
|
20
|
+
|[**updateEventCoupon**](#updateeventcoupon) | **PUT** /events/{eventId}/coupons/{couponId} | Update an event coupon|
|
|
21
|
+
|
|
22
|
+
# **addEventCouponTier**
|
|
23
|
+
> CreateEventCoupon200Response addEventCouponTier()
|
|
24
|
+
|
|
25
|
+
Adds a ticket tier to an event coupon\'s allow-list or disallow-list; when allowed is true the tier is connected to the coupon\'s allowed tiers, otherwise to its disallowed tiers. Requires update permission on events.
|
|
26
|
+
|
|
27
|
+
### Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import {
|
|
31
|
+
EventsCouponsApi,
|
|
32
|
+
Configuration
|
|
33
|
+
} from '@connectedxm/admin-sdk';
|
|
34
|
+
|
|
35
|
+
const configuration = new Configuration();
|
|
36
|
+
const apiInstance = new EventsCouponsApi(configuration);
|
|
37
|
+
|
|
38
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
39
|
+
let couponId: string; //The coupon identifier (default to undefined)
|
|
40
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
41
|
+
let allowed: boolean; //Filter by allowed (default to undefined)
|
|
42
|
+
|
|
43
|
+
const { status, data } = await apiInstance.addEventCouponTier(
|
|
44
|
+
eventId,
|
|
45
|
+
couponId,
|
|
46
|
+
tierId,
|
|
47
|
+
allowed
|
|
48
|
+
);
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
|Name | Type | Description | Notes|
|
|
54
|
+
|------------- | ------------- | ------------- | -------------|
|
|
55
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
56
|
+
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
|
|
57
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
58
|
+
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
**CreateEventCoupon200Response**
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: Not defined
|
|
72
|
+
- **Accept**: application/json
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### HTTP response details
|
|
76
|
+
| Status code | Description | Response headers |
|
|
77
|
+
|-------------|-------------|------------------|
|
|
78
|
+
|**200** | Successful response | - |
|
|
79
|
+
|
|
80
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
18
81
|
|
|
19
82
|
# **createEventCoupon**
|
|
20
83
|
> CreateEventCoupon200Response createEventCoupon(eventCouponCreateInputs)
|
|
21
84
|
|
|
22
|
-
|
|
85
|
+
Creates a new discount coupon for the given event and requires update permission on events.
|
|
23
86
|
|
|
24
87
|
### Example
|
|
25
88
|
|
|
@@ -74,7 +137,7 @@ const { status, data } = await apiInstance.createEventCoupon(
|
|
|
74
137
|
# **createEventCouponVariants**
|
|
75
138
|
> CreateEventCouponVariants200Response createEventCouponVariants(eventVariantCouponCreateInputs)
|
|
76
139
|
|
|
77
|
-
|
|
140
|
+
Generates the given quantity of unique, randomly-coded variant coupons cloned from a parent coupon\'s settings, failing if the parent is itself a variant or is pre-paid; requires update permission on events.
|
|
78
141
|
|
|
79
142
|
### Example
|
|
80
143
|
|
|
@@ -132,7 +195,7 @@ const { status, data } = await apiInstance.createEventCouponVariants(
|
|
|
132
195
|
# **deleteEventCoupon**
|
|
133
196
|
> CreateAccountInvitations200Response deleteEventCoupon()
|
|
134
197
|
|
|
135
|
-
|
|
198
|
+
Permanently deletes a coupon from an event, failing if any purchases have already used the coupon; requires update permission on events.
|
|
136
199
|
|
|
137
200
|
### Example
|
|
138
201
|
|
|
@@ -186,7 +249,7 @@ const { status, data } = await apiInstance.deleteEventCoupon(
|
|
|
186
249
|
# **deleteEventCouponVariants**
|
|
187
250
|
> CreateAccountInvitations200Response deleteEventCouponVariants()
|
|
188
251
|
|
|
189
|
-
|
|
252
|
+
Deletes every variant coupon generated from a parent coupon, failing if the target is itself a variant or if any variant has already been used in a purchase; requires update permission on events.
|
|
190
253
|
|
|
191
254
|
### Example
|
|
192
255
|
|
|
@@ -240,7 +303,7 @@ const { status, data } = await apiInstance.deleteEventCouponVariants(
|
|
|
240
303
|
# **getEventCoupon**
|
|
241
304
|
> CreateEventCoupon200Response getEventCoupon()
|
|
242
305
|
|
|
243
|
-
|
|
306
|
+
Retrieves the details of one coupon (by ID or code) for the given event, including its discount configuration and pre-paid/group settings; requires \"read\" permission on events.
|
|
244
307
|
|
|
245
308
|
### Example
|
|
246
309
|
|
|
@@ -294,7 +357,7 @@ const { status, data } = await apiInstance.getEventCoupon(
|
|
|
294
357
|
# **getEventCouponPasses**
|
|
295
358
|
> GetEventAddOnPasses200Response getEventCouponPasses()
|
|
296
359
|
|
|
297
|
-
|
|
360
|
+
Returns a paginated list of pass purchases made using the given coupon (or any of its variants) on the event, supporting search by attendee name/email or purchase ID; requires \"read\" permission on both events and attendees.
|
|
298
361
|
|
|
299
362
|
### Example
|
|
300
363
|
|
|
@@ -360,7 +423,7 @@ const { status, data } = await apiInstance.getEventCouponPasses(
|
|
|
360
423
|
# **getEventCouponPayments**
|
|
361
424
|
> GetAccountPayments200Response getEventCouponPayments()
|
|
362
425
|
|
|
363
|
-
|
|
426
|
+
Returns a paginated list of payments on the given event that used the specified coupon, supporting search and `orderBy` sorting; requires \"read\" permission on both events and payments.
|
|
364
427
|
|
|
365
428
|
### Example
|
|
366
429
|
|
|
@@ -416,6 +479,75 @@ const { status, data } = await apiInstance.getEventCouponPayments(
|
|
|
416
479
|
- **Accept**: application/json
|
|
417
480
|
|
|
418
481
|
|
|
482
|
+
### HTTP response details
|
|
483
|
+
| Status code | Description | Response headers |
|
|
484
|
+
|-------------|-------------|------------------|
|
|
485
|
+
|**200** | Successful response | - |
|
|
486
|
+
|
|
487
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
488
|
+
|
|
489
|
+
# **getEventCouponTiers**
|
|
490
|
+
> GetAccountTiers200Response getEventCouponTiers()
|
|
491
|
+
|
|
492
|
+
Lists the ticket tiers currently on an event coupon\'s allow-list or disallow-list; the allowed flag selects which list to return (allowed tiers when true, disallowed tiers when false), with pagination, ordering, and search support.
|
|
493
|
+
|
|
494
|
+
### Example
|
|
495
|
+
|
|
496
|
+
```typescript
|
|
497
|
+
import {
|
|
498
|
+
EventsCouponsApi,
|
|
499
|
+
Configuration
|
|
500
|
+
} from '@connectedxm/admin-sdk';
|
|
501
|
+
|
|
502
|
+
const configuration = new Configuration();
|
|
503
|
+
const apiInstance = new EventsCouponsApi(configuration);
|
|
504
|
+
|
|
505
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
506
|
+
let couponId: string; //The coupon identifier (default to undefined)
|
|
507
|
+
let allowed: boolean; //Filter by allowed (default to undefined)
|
|
508
|
+
let page: number; //Page number (optional) (default to 1)
|
|
509
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
510
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
511
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
512
|
+
|
|
513
|
+
const { status, data } = await apiInstance.getEventCouponTiers(
|
|
514
|
+
eventId,
|
|
515
|
+
couponId,
|
|
516
|
+
allowed,
|
|
517
|
+
page,
|
|
518
|
+
pageSize,
|
|
519
|
+
orderBy,
|
|
520
|
+
search
|
|
521
|
+
);
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
### Parameters
|
|
525
|
+
|
|
526
|
+
|Name | Type | Description | Notes|
|
|
527
|
+
|------------- | ------------- | ------------- | -------------|
|
|
528
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
529
|
+
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
|
|
530
|
+
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
|
|
531
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
532
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
533
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
534
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
### Return type
|
|
538
|
+
|
|
539
|
+
**GetAccountTiers200Response**
|
|
540
|
+
|
|
541
|
+
### Authorization
|
|
542
|
+
|
|
543
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
544
|
+
|
|
545
|
+
### HTTP request headers
|
|
546
|
+
|
|
547
|
+
- **Content-Type**: Not defined
|
|
548
|
+
- **Accept**: application/json
|
|
549
|
+
|
|
550
|
+
|
|
419
551
|
### HTTP response details
|
|
420
552
|
| Status code | Description | Response headers |
|
|
421
553
|
|-------------|-------------|------------------|
|
|
@@ -426,7 +558,7 @@ const { status, data } = await apiInstance.getEventCouponPayments(
|
|
|
426
558
|
# **getEventCouponVariants**
|
|
427
559
|
> GetEventAttendeeCoupons200Response getEventCouponVariants()
|
|
428
560
|
|
|
429
|
-
|
|
561
|
+
Returns a paginated list of the child coupon variants belonging to the given parent coupon on the event, supporting search and `orderBy` sorting; requires \"read\" permission on events.
|
|
430
562
|
|
|
431
563
|
### Example
|
|
432
564
|
|
|
@@ -492,7 +624,7 @@ const { status, data } = await apiInstance.getEventCouponVariants(
|
|
|
492
624
|
# **getEventCoupons**
|
|
493
625
|
> GetEventAttendeeCoupons200Response getEventCoupons()
|
|
494
626
|
|
|
495
|
-
|
|
627
|
+
Returns a paginated list of coupons for the given event, filterable by `prePaid` (group-paid vs. standard coupons) and by `includeVariants` to include child coupon variants, with search and `orderBy` sorting; requires \"read\" permission on events.
|
|
496
628
|
|
|
497
629
|
### Example
|
|
498
630
|
|
|
@@ -551,6 +683,66 @@ const { status, data } = await apiInstance.getEventCoupons(
|
|
|
551
683
|
- **Accept**: application/json
|
|
552
684
|
|
|
553
685
|
|
|
686
|
+
### HTTP response details
|
|
687
|
+
| Status code | Description | Response headers |
|
|
688
|
+
|-------------|-------------|------------------|
|
|
689
|
+
|**200** | Successful response | - |
|
|
690
|
+
|
|
691
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
692
|
+
|
|
693
|
+
# **removeEventCouponTier**
|
|
694
|
+
> CreateEventCoupon200Response removeEventCouponTier()
|
|
695
|
+
|
|
696
|
+
Removes a ticket tier from an event coupon\'s allow-list or disallow-list; the allowed query flag selects which list to disconnect the tier from (allowed tiers when true, disallowed tiers when false). Requires update permission on events.
|
|
697
|
+
|
|
698
|
+
### Example
|
|
699
|
+
|
|
700
|
+
```typescript
|
|
701
|
+
import {
|
|
702
|
+
EventsCouponsApi,
|
|
703
|
+
Configuration
|
|
704
|
+
} from '@connectedxm/admin-sdk';
|
|
705
|
+
|
|
706
|
+
const configuration = new Configuration();
|
|
707
|
+
const apiInstance = new EventsCouponsApi(configuration);
|
|
708
|
+
|
|
709
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
710
|
+
let couponId: string; //The coupon identifier (default to undefined)
|
|
711
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
712
|
+
let allowed: boolean; //Filter by allowed (default to undefined)
|
|
713
|
+
|
|
714
|
+
const { status, data } = await apiInstance.removeEventCouponTier(
|
|
715
|
+
eventId,
|
|
716
|
+
couponId,
|
|
717
|
+
tierId,
|
|
718
|
+
allowed
|
|
719
|
+
);
|
|
720
|
+
```
|
|
721
|
+
|
|
722
|
+
### Parameters
|
|
723
|
+
|
|
724
|
+
|Name | Type | Description | Notes|
|
|
725
|
+
|------------- | ------------- | ------------- | -------------|
|
|
726
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
727
|
+
| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
|
|
728
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
729
|
+
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
### Return type
|
|
733
|
+
|
|
734
|
+
**CreateEventCoupon200Response**
|
|
735
|
+
|
|
736
|
+
### Authorization
|
|
737
|
+
|
|
738
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
739
|
+
|
|
740
|
+
### HTTP request headers
|
|
741
|
+
|
|
742
|
+
- **Content-Type**: Not defined
|
|
743
|
+
- **Accept**: application/json
|
|
744
|
+
|
|
745
|
+
|
|
554
746
|
### HTTP response details
|
|
555
747
|
| Status code | Description | Response headers |
|
|
556
748
|
|-------------|-------------|------------------|
|
|
@@ -561,7 +753,7 @@ const { status, data } = await apiInstance.getEventCoupons(
|
|
|
561
753
|
# **syncEventCouponToVariants**
|
|
562
754
|
> CreateEventCoupon200Response syncEventCouponToVariants(eventVariantCouponSyncInputs)
|
|
563
755
|
|
|
564
|
-
|
|
756
|
+
Copies the given list of field values from a parent coupon onto all of its variant coupons, failing if the target is itself a variant; requires update permission on events.
|
|
565
757
|
|
|
566
758
|
### Example
|
|
567
759
|
|
|
@@ -619,7 +811,7 @@ const { status, data } = await apiInstance.syncEventCouponToVariants(
|
|
|
619
811
|
# **updateEventCoupon**
|
|
620
812
|
> CreateEventCoupon200Response updateEventCoupon(eventCouponUpdateInputs)
|
|
621
813
|
|
|
622
|
-
|
|
814
|
+
Updates the properties of an existing coupon on an event, such as its discount, active state, dates, and usage limits, blocking changes to the purchase limit on pre-paid coupons; requires update permission on events.
|
|
623
815
|
|
|
624
816
|
### Example
|
|
625
817
|
|
package/docs/EventsEmailsApi.md
CHANGED
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getEventEmail**](#geteventemail) | **GET** /events/{eventId}/emails/{type} | Get
|
|
8
|
-
|[**updateEventEmail**](#updateeventemail) | **PUT** /events/{eventId}/emails/{type} | Update
|
|
7
|
+
|[**getEventEmail**](#geteventemail) | **GET** /events/{eventId}/emails/{type} | Get an event\'s email configuration|
|
|
8
|
+
|[**updateEventEmail**](#updateeventemail) | **PUT** /events/{eventId}/emails/{type} | Update an event email template|
|
|
9
9
|
|
|
10
10
|
# **getEventEmail**
|
|
11
11
|
> GetEventEmail200Response getEventEmail()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Returns the configuration (body, reply-to, enabled state, calendar file setting) for a given event email type such as confirmation, cancellation, reminder, approval, or denial; requires read permission on events.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -64,7 +64,7 @@ const { status, data } = await apiInstance.getEventEmail(
|
|
|
64
64
|
# **updateEventEmail**
|
|
65
65
|
> GetEventEmail200Response updateEventEmail(eventEmailUpdateInputs)
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
Updates the content of a specific automated email (by type, e.g. registration confirmation) sent for an event; requires update permission on events.
|
|
68
68
|
|
|
69
69
|
### Example
|
|
70
70
|
|
|
@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteEventEmailTranslation**](#deleteeventemailtranslation) | **DELETE** /events/{eventId}/emails/{type}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventEmailTranslation**](#geteventemailtranslation) | **GET** /events/{eventId}/emails/{type}/translations/{locale} | Get
|
|
9
|
-
|[**getEventEmailTranslations**](#geteventemailtranslations) | **GET** /events/{eventId}/emails/{type}/translations |
|
|
10
|
-
|[**updateEventEmailTranslation**](#updateeventemailtranslation) | **PUT** /events/{eventId}/emails/{type}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventEmailTranslation**](#deleteeventemailtranslation) | **DELETE** /events/{eventId}/emails/{type}/translations/{locale} | Delete an event email translation|
|
|
8
|
+
|[**getEventEmailTranslation**](#geteventemailtranslation) | **GET** /events/{eventId}/emails/{type}/translations/{locale} | Get an event email\'s translation|
|
|
9
|
+
|[**getEventEmailTranslations**](#geteventemailtranslations) | **GET** /events/{eventId}/emails/{type}/translations | List an event email\'s translations|
|
|
10
|
+
|[**updateEventEmailTranslation**](#updateeventemailtranslation) | **PUT** /events/{eventId}/emails/{type}/translations/{locale} | Update an event email translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventEmailTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventEmailTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the translated content for a specific event email type in a given locale, reverting that locale to the email\'s default content; requires update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventEmailTranslation(
|
|
|
69
69
|
# **getEventEmailTranslation**
|
|
70
70
|
> GetEventEmailTranslation200Response getEventEmailTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Returns the localized translation (subject/body) for a specific event email type and locale, or null if no translation exists for that locale; requires read permission on events.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventEmailTranslation(
|
|
|
126
126
|
# **getEventEmailTranslations**
|
|
127
127
|
> GetEventEmailTranslations200Response getEventEmailTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of locale translations for a specific event email type, supporting page, pageSize, orderBy, and search filters; requires read permission on events.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventEmailTranslations(
|
|
|
192
192
|
# **updateEventEmailTranslation**
|
|
193
193
|
> SyncAccounts200Response updateEventEmailTranslation(eventEmailTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Creates or updates the translated subject and body content for a specific event email type in a given locale; requires update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
package/docs/EventsFaqsApi.md
CHANGED
|
@@ -4,22 +4,22 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createEventFaqSection**](#createeventfaqsection) | **POST** /events/{eventId}/faqs | Create
|
|
8
|
-
|[**createEventFaqSectionQuestion**](#createeventfaqsectionquestion) | **POST** /events/{eventId}/faqs/{sectionId}/questions |
|
|
9
|
-
|[**deleteEventFaqSection**](#deleteeventfaqsection) | **DELETE** /events/{eventId}/faqs/{sectionId} | Delete
|
|
10
|
-
|[**deleteEventFaqSectionQuestion**](#deleteeventfaqsectionquestion) | **DELETE** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Delete
|
|
11
|
-
|[**getEventFaqSection**](#geteventfaqsection) | **GET** /events/{eventId}/faqs/{sectionId} | Get
|
|
12
|
-
|[**getEventFaqSectionQuestion**](#geteventfaqsectionquestion) | **GET** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Get
|
|
13
|
-
|[**getEventFaqSectionQuestions**](#geteventfaqsectionquestions) | **GET** /events/{eventId}/faqs/{sectionId}/questions |
|
|
14
|
-
|[**getEventFaqSections**](#geteventfaqsections) | **GET** /events/{eventId}/faqs |
|
|
15
|
-
|[**reorderEventFaqSectionQuestions**](#reordereventfaqsectionquestions) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/reorder | Reorder
|
|
16
|
-
|[**updateEventFaqSection**](#updateeventfaqsection) | **PUT** /events/{eventId}/faqs/{sectionId} | Update
|
|
17
|
-
|[**updateEventFaqSectionQuestion**](#updateeventfaqsectionquestion) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Update
|
|
7
|
+
|[**createEventFaqSection**](#createeventfaqsection) | **POST** /events/{eventId}/faqs | Create an event FAQ section|
|
|
8
|
+
|[**createEventFaqSectionQuestion**](#createeventfaqsectionquestion) | **POST** /events/{eventId}/faqs/{sectionId}/questions | Add a question to an event FAQ section|
|
|
9
|
+
|[**deleteEventFaqSection**](#deleteeventfaqsection) | **DELETE** /events/{eventId}/faqs/{sectionId} | Delete an event FAQ section|
|
|
10
|
+
|[**deleteEventFaqSectionQuestion**](#deleteeventfaqsectionquestion) | **DELETE** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Delete a question from an event FAQ section|
|
|
11
|
+
|[**getEventFaqSection**](#geteventfaqsection) | **GET** /events/{eventId}/faqs/{sectionId} | Get an event FAQ section|
|
|
12
|
+
|[**getEventFaqSectionQuestion**](#geteventfaqsectionquestion) | **GET** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Get an event FAQ question|
|
|
13
|
+
|[**getEventFaqSectionQuestions**](#geteventfaqsectionquestions) | **GET** /events/{eventId}/faqs/{sectionId}/questions | List an event FAQ section\'s questions|
|
|
14
|
+
|[**getEventFaqSections**](#geteventfaqsections) | **GET** /events/{eventId}/faqs | List an event\'s FAQ sections|
|
|
15
|
+
|[**reorderEventFaqSectionQuestions**](#reordereventfaqsectionquestions) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/reorder | Reorder questions in an event FAQ section|
|
|
16
|
+
|[**updateEventFaqSection**](#updateeventfaqsection) | **PUT** /events/{eventId}/faqs/{sectionId} | Update an event FAQ section|
|
|
17
|
+
|[**updateEventFaqSectionQuestion**](#updateeventfaqsectionquestion) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Update a question in an event FAQ section|
|
|
18
18
|
|
|
19
19
|
# **createEventFaqSection**
|
|
20
20
|
> CreateEventFaqSection200Response createEventFaqSection(eventFaqSectionCreateInputs)
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
Creates a new FAQ section (a grouping of questions and answers) for the given event; requires the \"update\" permission on events.
|
|
23
23
|
|
|
24
24
|
### Example
|
|
25
25
|
|
|
@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.createEventFaqSection(
|
|
|
74
74
|
# **createEventFaqSectionQuestion**
|
|
75
75
|
> CreateEventFaqSectionQuestion200Response createEventFaqSectionQuestion(eventFaqSectionQuestionCreateInputs)
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
Creates a new question-and-answer entry within the specified FAQ section of an event; requires the \"update\" permission on events.
|
|
78
78
|
|
|
79
79
|
### Example
|
|
80
80
|
|
|
@@ -132,7 +132,7 @@ const { status, data } = await apiInstance.createEventFaqSectionQuestion(
|
|
|
132
132
|
# **deleteEventFaqSection**
|
|
133
133
|
> CreateAccountInvitations200Response deleteEventFaqSection()
|
|
134
134
|
|
|
135
|
-
|
|
135
|
+
Permanently deletes an FAQ section, including its questions, from the given event; requires the \"update\" permission on events.
|
|
136
136
|
|
|
137
137
|
### Example
|
|
138
138
|
|
|
@@ -186,7 +186,7 @@ const { status, data } = await apiInstance.deleteEventFaqSection(
|
|
|
186
186
|
# **deleteEventFaqSectionQuestion**
|
|
187
187
|
> CreateAccountInvitations200Response deleteEventFaqSectionQuestion()
|
|
188
188
|
|
|
189
|
-
|
|
189
|
+
Permanently deletes a single question-and-answer entry from the specified FAQ section of an event; requires the \"update\" permission on events.
|
|
190
190
|
|
|
191
191
|
### Example
|
|
192
192
|
|
|
@@ -243,7 +243,7 @@ const { status, data } = await apiInstance.deleteEventFaqSectionQuestion(
|
|
|
243
243
|
# **getEventFaqSection**
|
|
244
244
|
> CreateEventFaqSection200Response getEventFaqSection()
|
|
245
245
|
|
|
246
|
-
|
|
246
|
+
Returns the details of a single FAQ section belonging to an event, identified by section ID; requires read permission on events.
|
|
247
247
|
|
|
248
248
|
### Example
|
|
249
249
|
|
|
@@ -297,7 +297,7 @@ const { status, data } = await apiInstance.getEventFaqSection(
|
|
|
297
297
|
# **getEventFaqSectionQuestion**
|
|
298
298
|
> CreateEventFaqSectionQuestion200Response getEventFaqSectionQuestion()
|
|
299
299
|
|
|
300
|
-
|
|
300
|
+
Returns the details of a single question within an event FAQ section, identified by question ID; requires read permission on events.
|
|
301
301
|
|
|
302
302
|
### Example
|
|
303
303
|
|
|
@@ -354,7 +354,7 @@ const { status, data } = await apiInstance.getEventFaqSectionQuestion(
|
|
|
354
354
|
# **getEventFaqSectionQuestions**
|
|
355
355
|
> GetEventFaqSectionQuestions200Response getEventFaqSectionQuestions()
|
|
356
356
|
|
|
357
|
-
|
|
357
|
+
Returns a paginated list of questions belonging to a specific FAQ section of an event, supporting page, pageSize, orderBy, and search filters; requires read permission on events.
|
|
358
358
|
|
|
359
359
|
### Example
|
|
360
360
|
|
|
@@ -420,7 +420,7 @@ const { status, data } = await apiInstance.getEventFaqSectionQuestions(
|
|
|
420
420
|
# **getEventFaqSections**
|
|
421
421
|
> GetEventFaqSections200Response getEventFaqSections()
|
|
422
422
|
|
|
423
|
-
|
|
423
|
+
Returns a paginated list of FAQ sections for the given event, supporting search and ordering; requires read permission on events.
|
|
424
424
|
|
|
425
425
|
### Example
|
|
426
426
|
|
|
@@ -483,7 +483,7 @@ const { status, data } = await apiInstance.getEventFaqSections(
|
|
|
483
483
|
# **reorderEventFaqSectionQuestions**
|
|
484
484
|
> ReorderEventFaqSectionQuestions200Response reorderEventFaqSectionQuestions()
|
|
485
485
|
|
|
486
|
-
|
|
486
|
+
Updates the display order of questions within an event FAQ section by supplying the full list of question IDs in the desired order; requires the \"update\" permission on events.
|
|
487
487
|
|
|
488
488
|
### Example
|
|
489
489
|
|
|
@@ -540,7 +540,7 @@ const { status, data } = await apiInstance.reorderEventFaqSectionQuestions(
|
|
|
540
540
|
# **updateEventFaqSection**
|
|
541
541
|
> CreateEventFaqSection200Response updateEventFaqSection()
|
|
542
542
|
|
|
543
|
-
|
|
543
|
+
Updates the properties (such as title) of an existing FAQ section on the given event; requires the \"update\" permission on events.
|
|
544
544
|
|
|
545
545
|
### Example
|
|
546
546
|
|
|
@@ -598,7 +598,7 @@ const { status, data } = await apiInstance.updateEventFaqSection(
|
|
|
598
598
|
# **updateEventFaqSectionQuestion**
|
|
599
599
|
> CreateEventFaqSectionQuestion200Response updateEventFaqSectionQuestion()
|
|
600
600
|
|
|
601
|
-
|
|
601
|
+
Updates the question and/or answer text of an existing entry within the specified FAQ section of an event; requires the \"update\" permission on events.
|
|
602
602
|
|
|
603
603
|
### Example
|
|
604
604
|
|