@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
|
@@ -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
|
-
|[**deleteEventSponsorshipLevelTranslation**](#deleteeventsponsorshipleveltranslation) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventSponsorshipLevelTranslation**](#geteventsponsorshipleveltranslation) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventSponsorshipLevelTranslations**](#geteventsponsorshipleveltranslations) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/translations |
|
|
10
|
-
|[**updateEventSponsorshipLevelTranslation**](#updateeventsponsorshipleveltranslation) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventSponsorshipLevelTranslation**](#deleteeventsponsorshipleveltranslation) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId}/translations/{locale} | Delete a sponsorship level\'s translation|
|
|
8
|
+
|[**getEventSponsorshipLevelTranslation**](#geteventsponsorshipleveltranslation) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/translations/{locale} | Get a sponsorship level translation|
|
|
9
|
+
|[**getEventSponsorshipLevelTranslations**](#geteventsponsorshipleveltranslations) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/translations | List a sponsorship level\'s translations|
|
|
10
|
+
|[**updateEventSponsorshipLevelTranslation**](#updateeventsponsorshipleveltranslation) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/translations/{locale} | Update a sponsorship level\'s translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventSponsorshipLevelTranslation**
|
|
13
13
|
> CreateAccountInvitations200Response deleteEventSponsorshipLevelTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Deletes the localized translation for the given locale on an event sponsorship level, removing that language\'s translated fields; requires the update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventSponsorshipLevelTranslatio
|
|
|
69
69
|
# **getEventSponsorshipLevelTranslation**
|
|
70
70
|
> GetEventSponsorshipLevelTranslation200Response getEventSponsorshipLevelTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Returns the translation of an event sponsorship level for the specified locale; requires read permission on events.
|
|
73
73
|
|
|
74
74
|
### Example
|
|
75
75
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventSponsorshipLevelTranslation(
|
|
|
126
126
|
# **getEventSponsorshipLevelTranslations**
|
|
127
127
|
> GetEventSponsorshipLevelTranslations200Response getEventSponsorshipLevelTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of locale translations for the given event sponsorship level, supporting search and ordering; requires read permission on events.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventSponsorshipLevelTranslations(
|
|
|
192
192
|
# **updateEventSponsorshipLevelTranslation**
|
|
193
193
|
> GetEventSponsorshipLevelTranslation200Response updateEventSponsorshipLevelTranslation()
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Updates the translated fields (e.g. name, description) for a specific locale of an event sponsorship level, creating or overwriting that locale\'s translation; requires update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
|
@@ -4,17 +4,17 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createEventSponsorship**](#createeventsponsorship) | **POST** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships | Create
|
|
8
|
-
|[**deleteEventSponsorship**](#deleteeventsponsorship) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId} | Delete
|
|
9
|
-
|[**getEventSponsorship**](#geteventsponsorship) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId} | Get
|
|
10
|
-
|[**getEventSponsorships**](#geteventsponsorships) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships |
|
|
11
|
-
|[**reorderEventSponsorships**](#reordereventsponsorships) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/reorder | Reorder
|
|
12
|
-
|[**updateEventSponsorship**](#updateeventsponsorship) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId} | Update
|
|
7
|
+
|[**createEventSponsorship**](#createeventsponsorship) | **POST** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships | Create a sponsorship on a sponsorship level|
|
|
8
|
+
|[**deleteEventSponsorship**](#deleteeventsponsorship) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId} | Delete a sponsorship from a sponsorship level|
|
|
9
|
+
|[**getEventSponsorship**](#geteventsponsorship) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId} | Get a sponsorship within a level|
|
|
10
|
+
|[**getEventSponsorships**](#geteventsponsorships) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships | List sponsorships within a level|
|
|
11
|
+
|[**reorderEventSponsorships**](#reordereventsponsorships) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/reorder | Reorder sponsorships within a sponsorship level|
|
|
12
|
+
|[**updateEventSponsorship**](#updateeventsponsorship) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId} | Update an event sponsorship|
|
|
13
13
|
|
|
14
14
|
# **createEventSponsorship**
|
|
15
15
|
> CreateEventSponsorship200Response createEventSponsorship(eventSponsorshipCreateInputs)
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Creates a new sponsorship (a sponsor placed at a given sponsorship level) for an event; requires update permission on events.
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
|
@@ -72,7 +72,7 @@ const { status, data } = await apiInstance.createEventSponsorship(
|
|
|
72
72
|
# **deleteEventSponsorship**
|
|
73
73
|
> CreateAccountInvitations200Response deleteEventSponsorship()
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
Permanently deletes a sponsorship from the given event sponsorship level; requires update permission on events.
|
|
76
76
|
|
|
77
77
|
### Example
|
|
78
78
|
|
|
@@ -129,7 +129,7 @@ const { status, data } = await apiInstance.deleteEventSponsorship(
|
|
|
129
129
|
# **getEventSponsorship**
|
|
130
130
|
> CreateEventSponsorship200Response getEventSponsorship()
|
|
131
131
|
|
|
132
|
-
|
|
132
|
+
Returns a single sponsorship record (the sponsor assigned to a sponsorship level) for the given event; requires read permission on events.
|
|
133
133
|
|
|
134
134
|
### Example
|
|
135
135
|
|
|
@@ -186,7 +186,7 @@ const { status, data } = await apiInstance.getEventSponsorship(
|
|
|
186
186
|
# **getEventSponsorships**
|
|
187
187
|
> GetEventSponsorships200Response getEventSponsorships()
|
|
188
188
|
|
|
189
|
-
|
|
189
|
+
Returns a paginated list of sponsorships (sponsors assigned) under the given sponsorship level of an event, supporting search and ordering; requires read permission on events.
|
|
190
190
|
|
|
191
191
|
### Example
|
|
192
192
|
|
|
@@ -252,7 +252,7 @@ const { status, data } = await apiInstance.getEventSponsorships(
|
|
|
252
252
|
# **reorderEventSponsorships**
|
|
253
253
|
> ReorderEventSponsorships200Response reorderEventSponsorships()
|
|
254
254
|
|
|
255
|
-
|
|
255
|
+
Sets the display order of the sponsorships within an event sponsorship level by supplying the full ordered list of sponsorship IDs; requires update permission on events.
|
|
256
256
|
|
|
257
257
|
### Example
|
|
258
258
|
|
|
@@ -309,7 +309,7 @@ const { status, data } = await apiInstance.reorderEventSponsorships(
|
|
|
309
309
|
# **updateEventSponsorship**
|
|
310
310
|
> CreateEventSponsorship200Response updateEventSponsorship()
|
|
311
311
|
|
|
312
|
-
|
|
312
|
+
Updates the details of a sponsorship record at a given sponsorship level for an event, such as its name, description, or links, and requires update permission on events.
|
|
313
313
|
|
|
314
314
|
### Example
|
|
315
315
|
|
|
@@ -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
|
-
|[**deleteEventSponsorshipTranslation**](#deleteeventsponsorshiptranslation) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventSponsorshipTranslation**](#geteventsponsorshiptranslation) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventSponsorshipTranslations**](#geteventsponsorshiptranslations) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations |
|
|
10
|
-
|[**updateEventSponsorshipTranslation**](#updateeventsponsorshiptranslation) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventSponsorshipTranslation**](#deleteeventsponsorshiptranslation) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations/{locale} | Delete a sponsorship\'s translation|
|
|
8
|
+
|[**getEventSponsorshipTranslation**](#geteventsponsorshiptranslation) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations/{locale} | Get a sponsorship translation|
|
|
9
|
+
|[**getEventSponsorshipTranslations**](#geteventsponsorshiptranslations) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations | List a sponsorship\'s translations|
|
|
10
|
+
|[**updateEventSponsorshipTranslation**](#updateeventsponsorshiptranslation) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations/{locale} | Update a sponsorship\'s translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventSponsorshipTranslation**
|
|
13
13
|
> CreateAccountInvitations200Response deleteEventSponsorshipTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Deletes the translated fields for a specific locale of a sponsorship within an event sponsorship level; requires update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -72,7 +72,7 @@ const { status, data } = await apiInstance.deleteEventSponsorshipTranslation(
|
|
|
72
72
|
# **getEventSponsorshipTranslation**
|
|
73
73
|
> GetEventSponsorshipTranslation200Response getEventSponsorshipTranslation()
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
Returns the translation of a specific sponsorship, under a given sponsorship level of an event, for the specified locale; requires read permission on events.
|
|
76
76
|
|
|
77
77
|
### Example
|
|
78
78
|
|
|
@@ -132,7 +132,7 @@ const { status, data } = await apiInstance.getEventSponsorshipTranslation(
|
|
|
132
132
|
# **getEventSponsorshipTranslations**
|
|
133
133
|
> GetEventSponsorshipTranslations200Response getEventSponsorshipTranslations()
|
|
134
134
|
|
|
135
|
-
|
|
135
|
+
Returns a paginated list of locale translations for a specific sponsorship under a given sponsorship level of an event, supporting search and ordering; requires read permission on events.
|
|
136
136
|
|
|
137
137
|
### Example
|
|
138
138
|
|
|
@@ -201,7 +201,7 @@ const { status, data } = await apiInstance.getEventSponsorshipTranslations(
|
|
|
201
201
|
# **updateEventSponsorshipTranslation**
|
|
202
202
|
> GetEventSponsorshipTranslation200Response updateEventSponsorshipTranslation()
|
|
203
203
|
|
|
204
|
-
|
|
204
|
+
Updates the translated fields (e.g. name, description) for a specific locale of a sponsorship within an event sponsorship level, creating or overwriting that locale\'s translation; requires update permission on events.
|
|
205
205
|
|
|
206
206
|
### Example
|
|
207
207
|
|
|
@@ -4,12 +4,12 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getTemplates**](#gettemplates) | **GET** /events/templates |
|
|
7
|
+
|[**getTemplates**](#gettemplates) | **GET** /events/templates | List event templates|
|
|
8
8
|
|
|
9
9
|
# **getTemplates**
|
|
10
10
|
> GetAccountEvents200Response getTemplates()
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
Returns a paginated list of events marked as templates for the organization, supporting search and ordering; requires read permission on events.
|
|
13
13
|
|
|
14
14
|
### Example
|
|
15
15
|
|
package/docs/EventsTracksApi.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
|
-
|[**addEventTrackSession**](#addeventtracksession) | **POST** /events/{eventId}/tracks/{trackId}/sessions/{sessionId} | Add
|
|
8
|
-
|[**addEventTrackSponsor**](#addeventtracksponsor) | **POST** /events/{eventId}/tracks/{trackId}/sponsors/{sponsorId} | Add
|
|
9
|
-
|[**createEventTrack**](#createeventtrack) | **POST** /events/{eventId}/tracks | Create
|
|
10
|
-
|[**deleteEventTrack**](#deleteeventtrack) | **DELETE** /events/{eventId}/tracks/{trackId} | Delete
|
|
11
|
-
|[**getEventTrack**](#geteventtrack) | **GET** /events/{eventId}/tracks/{trackId} | Get
|
|
12
|
-
|[**getEventTrackSessions**](#geteventtracksessions) | **GET** /events/{eventId}/tracks/{trackId}/sessions |
|
|
13
|
-
|[**getEventTrackSponsors**](#geteventtracksponsors) | **GET** /events/{eventId}/tracks/{trackId}/sponsors |
|
|
14
|
-
|[**getEventTracks**](#geteventtracks) | **GET** /events/{eventId}/tracks |
|
|
15
|
-
|[**removeEventTrackSession**](#removeeventtracksession) | **DELETE** /events/{eventId}/tracks/{trackId}/sessions/{sessionId} | Remove
|
|
16
|
-
|[**removeEventTrackSponsor**](#removeeventtracksponsor) | **DELETE** /events/{eventId}/tracks/{trackId}/sponsors/{sponsorId} | Remove
|
|
17
|
-
|[**updateEventTrack**](#updateeventtrack) | **PUT** /events/{eventId}/tracks/{trackId} | Update
|
|
7
|
+
|[**addEventTrackSession**](#addeventtracksession) | **POST** /events/{eventId}/tracks/{trackId}/sessions/{sessionId} | Add a session to an event track|
|
|
8
|
+
|[**addEventTrackSponsor**](#addeventtracksponsor) | **POST** /events/{eventId}/tracks/{trackId}/sponsors/{sponsorId} | Add a sponsor to an event track|
|
|
9
|
+
|[**createEventTrack**](#createeventtrack) | **POST** /events/{eventId}/tracks | Create an event track|
|
|
10
|
+
|[**deleteEventTrack**](#deleteeventtrack) | **DELETE** /events/{eventId}/tracks/{trackId} | Delete an event track|
|
|
11
|
+
|[**getEventTrack**](#geteventtrack) | **GET** /events/{eventId}/tracks/{trackId} | Get an event track|
|
|
12
|
+
|[**getEventTrackSessions**](#geteventtracksessions) | **GET** /events/{eventId}/tracks/{trackId}/sessions | List sessions assigned to an event track|
|
|
13
|
+
|[**getEventTrackSponsors**](#geteventtracksponsors) | **GET** /events/{eventId}/tracks/{trackId}/sponsors | List an event track\'s sponsor accounts|
|
|
14
|
+
|[**getEventTracks**](#geteventtracks) | **GET** /events/{eventId}/tracks | List an event\'s tracks|
|
|
15
|
+
|[**removeEventTrackSession**](#removeeventtracksession) | **DELETE** /events/{eventId}/tracks/{trackId}/sessions/{sessionId} | Remove a session from an event track|
|
|
16
|
+
|[**removeEventTrackSponsor**](#removeeventtracksponsor) | **DELETE** /events/{eventId}/tracks/{trackId}/sponsors/{sponsorId} | Remove a sponsor from an event track|
|
|
17
|
+
|[**updateEventTrack**](#updateeventtrack) | **PUT** /events/{eventId}/tracks/{trackId} | Update an event track|
|
|
18
18
|
|
|
19
19
|
# **addEventTrackSession**
|
|
20
20
|
> CreateEventTrack200Response addEventTrackSession()
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
Associates an existing event session with the given track, and requires update permission on events.
|
|
23
23
|
|
|
24
24
|
### Example
|
|
25
25
|
|
|
@@ -76,7 +76,7 @@ const { status, data } = await apiInstance.addEventTrackSession(
|
|
|
76
76
|
# **addEventTrackSponsor**
|
|
77
77
|
> CreateEventTrack200Response addEventTrackSponsor()
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
Associates an account as a sponsor of the given event track, and requires update permission on both events and accounts.
|
|
80
80
|
|
|
81
81
|
### Example
|
|
82
82
|
|
|
@@ -133,7 +133,7 @@ const { status, data } = await apiInstance.addEventTrackSponsor(
|
|
|
133
133
|
# **createEventTrack**
|
|
134
134
|
> CreateEventTrack200Response createEventTrack(eventTrackCreateInputs)
|
|
135
135
|
|
|
136
|
-
|
|
136
|
+
Creates a new track (a grouping of sessions, such as a themed agenda path) for the given event, and requires update permission on events.
|
|
137
137
|
|
|
138
138
|
### Example
|
|
139
139
|
|
|
@@ -188,7 +188,7 @@ const { status, data } = await apiInstance.createEventTrack(
|
|
|
188
188
|
# **deleteEventTrack**
|
|
189
189
|
> CreateAccountInvitations200Response deleteEventTrack()
|
|
190
190
|
|
|
191
|
-
|
|
191
|
+
Permanently deletes a track from the given event, and requires update permission on events.
|
|
192
192
|
|
|
193
193
|
### Example
|
|
194
194
|
|
|
@@ -242,7 +242,7 @@ const { status, data } = await apiInstance.deleteEventTrack(
|
|
|
242
242
|
# **getEventTrack**
|
|
243
243
|
> CreateEventTrack200Response getEventTrack()
|
|
244
244
|
|
|
245
|
-
|
|
245
|
+
Retrieves the details of a single track belonging to an event, identified by track ID or slug; requires read permission on events.
|
|
246
246
|
|
|
247
247
|
### Example
|
|
248
248
|
|
|
@@ -296,7 +296,7 @@ const { status, data } = await apiInstance.getEventTrack(
|
|
|
296
296
|
# **getEventTrackSessions**
|
|
297
297
|
> GetEventActivationSessions200Response getEventTrackSessions()
|
|
298
298
|
|
|
299
|
-
|
|
299
|
+
Returns a paginated list of the sessions linked to the given event track, supporting search and ordering; requires read permission on events.
|
|
300
300
|
|
|
301
301
|
### Example
|
|
302
302
|
|
|
@@ -362,7 +362,7 @@ const { status, data } = await apiInstance.getEventTrackSessions(
|
|
|
362
362
|
# **getEventTrackSponsors**
|
|
363
363
|
> GetAccounts200Response getEventTrackSponsors()
|
|
364
364
|
|
|
365
|
-
|
|
365
|
+
Returns a paginated list of accounts sponsoring the given event track, supporting search and ordering; requires read permission on events and accounts.
|
|
366
366
|
|
|
367
367
|
### Example
|
|
368
368
|
|
|
@@ -428,7 +428,7 @@ const { status, data } = await apiInstance.getEventTrackSponsors(
|
|
|
428
428
|
# **getEventTracks**
|
|
429
429
|
> GetEventSessionTracks200Response getEventTracks()
|
|
430
430
|
|
|
431
|
-
|
|
431
|
+
Returns a paginated list of tracks (content categories/tags used to group sessions) for the given event, supporting search and ordering; requires read permission on events.
|
|
432
432
|
|
|
433
433
|
### Example
|
|
434
434
|
|
|
@@ -491,7 +491,7 @@ const { status, data } = await apiInstance.getEventTracks(
|
|
|
491
491
|
# **removeEventTrackSession**
|
|
492
492
|
> CreateEventTrack200Response removeEventTrackSession()
|
|
493
493
|
|
|
494
|
-
|
|
494
|
+
Removes the association between an event session and the given track, and requires update permission on events.
|
|
495
495
|
|
|
496
496
|
### Example
|
|
497
497
|
|
|
@@ -548,7 +548,7 @@ const { status, data } = await apiInstance.removeEventTrackSession(
|
|
|
548
548
|
# **removeEventTrackSponsor**
|
|
549
549
|
> CreateEventTrack200Response removeEventTrackSponsor()
|
|
550
550
|
|
|
551
|
-
|
|
551
|
+
Removes an account\'s sponsorship association from the given event track, and requires update permission on both events and accounts.
|
|
552
552
|
|
|
553
553
|
### Example
|
|
554
554
|
|
|
@@ -605,7 +605,7 @@ const { status, data } = await apiInstance.removeEventTrackSponsor(
|
|
|
605
605
|
# **updateEventTrack**
|
|
606
606
|
> CreateEventTrack200Response updateEventTrack(eventTrackUpdateInputs)
|
|
607
607
|
|
|
608
|
-
|
|
608
|
+
Updates the details of an existing track for the given event, such as its name or description, and requires update permission on events.
|
|
609
609
|
|
|
610
610
|
### Example
|
|
611
611
|
|
|
@@ -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
|
-
|[**deleteEventTrackTranslation**](#deleteeventtracktranslation) | **DELETE** /events/{eventId}/tracks/{trackId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventTrackTranslation**](#geteventtracktranslation) | **GET** /events/{eventId}/tracks/{trackId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventTrackTranslations**](#geteventtracktranslations) | **GET** /events/{eventId}/tracks/{trackId}/translations |
|
|
10
|
-
|[**updateEventTrackTranslation**](#updateeventtracktranslation) | **PUT** /events/{eventId}/tracks/{trackId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventTrackTranslation**](#deleteeventtracktranslation) | **DELETE** /events/{eventId}/tracks/{trackId}/translations/{locale} | Delete an event track translation|
|
|
8
|
+
|[**getEventTrackTranslation**](#geteventtracktranslation) | **GET** /events/{eventId}/tracks/{trackId}/translations/{locale} | Get an event track translation|
|
|
9
|
+
|[**getEventTrackTranslations**](#geteventtracktranslations) | **GET** /events/{eventId}/tracks/{trackId}/translations | List an event track\'s translations|
|
|
10
|
+
|[**updateEventTrackTranslation**](#updateeventtracktranslation) | **PUT** /events/{eventId}/tracks/{trackId}/translations/{locale} | Update an event track translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventTrackTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventTrackTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the translation of an event track for the specified locale, and requires update permission on events.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.deleteEventTrackTranslation(
|
|
|
69
69
|
# **getEventTrackTranslation**
|
|
70
70
|
> GetEventTrackTranslation200Response getEventTrackTranslation()
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Retrieves the localized translation of an event track for the given locale, returning 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.getEventTrackTranslation(
|
|
|
126
126
|
# **getEventTrackTranslations**
|
|
127
127
|
> GetEventTrackTranslations200Response getEventTrackTranslations()
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
Returns a paginated list of locale translations for the given event track, supporting search and ordering; requires read permission on events.
|
|
130
130
|
|
|
131
131
|
### Example
|
|
132
132
|
|
|
@@ -192,7 +192,7 @@ const { status, data } = await apiInstance.getEventTrackTranslations(
|
|
|
192
192
|
# **updateEventTrackTranslation**
|
|
193
193
|
> SyncAccounts200Response updateEventTrackTranslation(eventTrackTranslationUpdateInputs)
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
Creates or updates the translated name and description of an event track for the specified locale, and requires update permission on events.
|
|
196
196
|
|
|
197
197
|
### Example
|
|
198
198
|
|
|
@@ -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
|
-
|[**cancelEventPassTransfer**](#canceleventpasstransfer) | **DELETE** /events/{eventId}/transfers/{transferId} | Cancel
|
|
8
|
-
|[**getEventPassTransfers**](#geteventpasstransfers) | **GET** /events/{eventId}/transfers |
|
|
7
|
+
|[**cancelEventPassTransfer**](#canceleventpasstransfer) | **DELETE** /events/{eventId}/transfers/{transferId} | Cancel event pass transfer|
|
|
8
|
+
|[**getEventPassTransfers**](#geteventpasstransfers) | **GET** /events/{eventId}/transfers | List event pass transfers|
|
|
9
9
|
|
|
10
10
|
# **cancelEventPassTransfer**
|
|
11
11
|
> SyncAccounts200Response cancelEventPassTransfer()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Cancels a pending event pass transfer invite by deleting the transfer record, invalidating the recipient\'s claim link so the pass stays with its original owner. Requires update permission on attendees.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -64,7 +64,7 @@ const { status, data } = await apiInstance.cancelEventPassTransfer(
|
|
|
64
64
|
# **getEventPassTransfers**
|
|
65
65
|
> GetEventPassTransfers200Response getEventPassTransfers()
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
Lists pending pass transfer invites for an event, where an attendee has initiated sending their pass to a recipient by email; supports pagination, ordering, and search by recipient email or sender name/email.
|
|
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
|
-
|[**deleteEventTranslation**](#deleteeventtranslation) | **DELETE** /events/{eventId}/translations/{locale} | Delete
|
|
8
|
-
|[**getEventTranslation**](#geteventtranslation) | **GET** /events/{eventId}/translations/{locale} | Get
|
|
9
|
-
|[**getEventTranslations**](#geteventtranslations) | **GET** /events/{eventId}/translations |
|
|
10
|
-
|[**updateEventTranslation**](#updateeventtranslation) | **PUT** /events/{eventId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteEventTranslation**](#deleteeventtranslation) | **DELETE** /events/{eventId}/translations/{locale} | Delete an event translation|
|
|
8
|
+
|[**getEventTranslation**](#geteventtranslation) | **GET** /events/{eventId}/translations/{locale} | Get an event translation|
|
|
9
|
+
|[**getEventTranslations**](#geteventtranslations) | **GET** /events/{eventId}/translations | List an event\'s translations|
|
|
10
|
+
|[**updateEventTranslation**](#updateeventtranslation) | **PUT** /events/{eventId}/translations/{locale} | Update an event translation|
|
|
11
11
|
|
|
12
12
|
# **deleteEventTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteEventTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the translation for the given locale from an event, requiring the update events permission; the event\'s default-locale content is unaffected.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.deleteEventTranslation(
|
|
|
66
66
|
# **getEventTranslation**
|
|
67
67
|
> GetEventTranslation200Response getEventTranslation()
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
Retrieves the localized translation of an event for the given locale, returning null if no translation exists for that locale; requires read permission on events.
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
|
|
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.getEventTranslation(
|
|
|
120
120
|
# **getEventTranslations**
|
|
121
121
|
> GetEventTranslations200Response getEventTranslations()
|
|
122
122
|
|
|
123
|
-
|
|
123
|
+
Returns a paginated list of locale translations for the given event, supporting search and ordering; requires read permission on events.
|
|
124
124
|
|
|
125
125
|
### Example
|
|
126
126
|
|
|
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getEventTranslations(
|
|
|
183
183
|
# **updateEventTranslation**
|
|
184
184
|
> SyncAccounts200Response updateEventTranslation(eventTranslationUpdateInputs)
|
|
185
185
|
|
|
186
|
-
|
|
186
|
+
Creates or updates the translated fields (such as name and description) for an event in the given locale, requiring the update events permission.
|
|
187
187
|
|
|
188
188
|
### Example
|
|
189
189
|
|
package/docs/FilesApi.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
|
-
|[**deleteFile**](#deletefile) | **DELETE** /files/{fileId} | Delete
|
|
8
|
-
|[**updateFile**](#updatefile) | **PUT** /files/{fileId} | Update
|
|
7
|
+
|[**deleteFile**](#deletefile) | **DELETE** /files/{fileId} | Delete a file|
|
|
8
|
+
|[**updateFile**](#updatefile) | **PUT** /files/{fileId} | Update a file|
|
|
9
9
|
|
|
10
10
|
# **deleteFile**
|
|
11
11
|
> CreateAccountInvitations200Response deleteFile()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Permanently deletes a stored file and its underlying storage object, requiring the delete storage permission.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -61,7 +61,7 @@ const { status, data } = await apiInstance.deleteFile(
|
|
|
61
61
|
# **updateFile**
|
|
62
62
|
> UploadFile200Response updateFile(fileUpdateInputs)
|
|
63
63
|
|
|
64
|
-
|
|
64
|
+
Updates metadata for an existing stored file, such as its name, requiring the update storage permission.
|
|
65
65
|
|
|
66
66
|
### Example
|
|
67
67
|
|
package/docs/GroupsApi.md
CHANGED
|
@@ -4,17 +4,17 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createGroup**](#creategroup) | **POST** /groups | Create
|
|
8
|
-
|[**deleteGroup**](#deletegroup) | **DELETE** /groups/{groupId} | Delete
|
|
9
|
-
|[**getGroup**](#getgroup) | **GET** /groups/{groupId} | Get
|
|
10
|
-
|[**getGroupActivities**](#getgroupactivities) | **GET** /groups/{groupId}/activities |
|
|
11
|
-
|[**getGroups**](#getgroups) | **GET** /groups |
|
|
12
|
-
|[**updateGroup**](#updategroup) | **PUT** /groups/{groupId} | Update
|
|
7
|
+
|[**createGroup**](#creategroup) | **POST** /groups | Create a group|
|
|
8
|
+
|[**deleteGroup**](#deletegroup) | **DELETE** /groups/{groupId} | Delete a group|
|
|
9
|
+
|[**getGroup**](#getgroup) | **GET** /groups/{groupId} | Get a single group|
|
|
10
|
+
|[**getGroupActivities**](#getgroupactivities) | **GET** /groups/{groupId}/activities | List a group\'s activity feed|
|
|
11
|
+
|[**getGroups**](#getgroups) | **GET** /groups | List groups in the organization|
|
|
12
|
+
|[**updateGroup**](#updategroup) | **PUT** /groups/{groupId} | Update a group|
|
|
13
13
|
|
|
14
14
|
# **createGroup**
|
|
15
15
|
> CreateGroup200Response createGroup(groupCreateInputs)
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Creates a new group for the organization from the supplied group details and requires the \"create\" permission on groups.
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
|
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.createGroup(
|
|
|
66
66
|
# **deleteGroup**
|
|
67
67
|
> CreateAccountInvitations200Response deleteGroup()
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
Permanently deletes the specified group from the organization and requires the \"del\" permission on groups.
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
|
|
@@ -117,7 +117,7 @@ const { status, data } = await apiInstance.deleteGroup(
|
|
|
117
117
|
# **getGroup**
|
|
118
118
|
> CreateGroup200Response getGroup()
|
|
119
119
|
|
|
120
|
-
|
|
120
|
+
Returns the details of a single group by its ID or slug, including its configuration and metadata; requires read access to groups.
|
|
121
121
|
|
|
122
122
|
### Example
|
|
123
123
|
|
|
@@ -168,7 +168,7 @@ const { status, data } = await apiInstance.getGroup(
|
|
|
168
168
|
# **getGroupActivities**
|
|
169
169
|
> GetAccountActivities200Response getGroupActivities()
|
|
170
170
|
|
|
171
|
-
|
|
171
|
+
Returns a paginated list of activity posts belonging to the given group, filterable by moderation status and whether the activity is featured, and searchable by message text; requires read access to groups and activities.
|
|
172
172
|
|
|
173
173
|
### Example
|
|
174
174
|
|
|
@@ -237,7 +237,7 @@ const { status, data } = await apiInstance.getGroupActivities(
|
|
|
237
237
|
# **getGroups**
|
|
238
238
|
> GetGroups200Response getGroups()
|
|
239
239
|
|
|
240
|
-
|
|
240
|
+
Returns a paginated list of groups for the organization, filterable by access level (public or private) and whether the group is featured, with optional search and ordering; requires read access to groups.
|
|
241
241
|
|
|
242
242
|
### Example
|
|
243
243
|
|
|
@@ -303,7 +303,7 @@ const { status, data } = await apiInstance.getGroups(
|
|
|
303
303
|
# **updateGroup**
|
|
304
304
|
> CreateGroup200Response updateGroup(groupUpdateInputs)
|
|
305
305
|
|
|
306
|
-
|
|
306
|
+
Updates the details of an existing group identified by groupId and requires the \"update\" permission on groups.
|
|
307
307
|
|
|
308
308
|
### Example
|
|
309
309
|
|
package/docs/GroupsEventsApi.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
|
-
|[**addGroupEvent**](#addgroupevent) | **POST** /groups/{groupId}/events/{eventId} | Add
|
|
8
|
-
|[**getGroupEvents**](#getgroupevents) | **GET** /groups/{groupId}/events |
|
|
9
|
-
|[**removeGroupEvent**](#removegroupevent) | **DELETE** /groups/{groupId}/events/{eventId} | Remove
|
|
7
|
+
|[**addGroupEvent**](#addgroupevent) | **POST** /groups/{groupId}/events/{eventId} | Add an event to a group|
|
|
8
|
+
|[**getGroupEvents**](#getgroupevents) | **GET** /groups/{groupId}/events | List a group\'s events|
|
|
9
|
+
|[**removeGroupEvent**](#removegroupevent) | **DELETE** /groups/{groupId}/events/{eventId} | Remove an event from a group|
|
|
10
10
|
|
|
11
11
|
# **addGroupEvent**
|
|
12
12
|
> CreateGroup200Response addGroupEvent()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Associates an existing event with a group, requiring update permission on both groups and events; the group\'s cached data is refreshed and its events list is invalidated.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addGroupEvent(
|
|
|
65
65
|
# **getGroupEvents**
|
|
66
66
|
> GetAccountEvents200Response getGroupEvents()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Returns a paginated list of events associated with the given group, optionally filtered to past or upcoming events and by a search term, with sorting via orderBy; requires \"read\" permission on groups and events.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -131,7 +131,7 @@ const { status, data } = await apiInstance.getGroupEvents(
|
|
|
131
131
|
# **removeGroupEvent**
|
|
132
132
|
> CreateGroup200Response removeGroupEvent()
|
|
133
133
|
|
|
134
|
-
|
|
134
|
+
Disassociates an event from a group, requiring update permission on both groups and events; the group\'s cached data is refreshed and its events list is invalidated.
|
|
135
135
|
|
|
136
136
|
### Example
|
|
137
137
|
|
|
@@ -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
|
-
|[**addGroupInterest**](#addgroupinterest) | **POST** /groups/{groupId}/interests/{interestId} | Add
|
|
8
|
-
|[**getGroupInterests**](#getgroupinterests) | **GET** /groups/{groupId}/interests |
|
|
9
|
-
|[**removeGroupInterest**](#removegroupinterest) | **DELETE** /groups/{groupId}/interests/{accountId} | Remove
|
|
7
|
+
|[**addGroupInterest**](#addgroupinterest) | **POST** /groups/{groupId}/interests/{interestId} | Add an interest to a group|
|
|
8
|
+
|[**getGroupInterests**](#getgroupinterests) | **GET** /groups/{groupId}/interests | List a group\'s interests|
|
|
9
|
+
|[**removeGroupInterest**](#removegroupinterest) | **DELETE** /groups/{groupId}/interests/{accountId} | Remove an interest from a group|
|
|
10
10
|
|
|
11
11
|
# **addGroupInterest**
|
|
12
12
|
> CreateGroup200Response addGroupInterest()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list is invalidated.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addGroupInterest(
|
|
|
65
65
|
# **getGroupInterests**
|
|
66
66
|
> GetAccountInterests200Response getGroupInterests()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Returns a paginated list of interest tags associated with the given group, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on groups and interests.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
|
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getGroupInterests(
|
|
|
128
128
|
# **removeGroupInterest**
|
|
129
129
|
> CreateGroup200Response removeGroupInterest()
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list is invalidated.
|
|
132
132
|
|
|
133
133
|
### Example
|
|
134
134
|
|