@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
|
-
|[**deleteBookingSpaceQuestionChoiceTranslation**](#deletebookingspacequestionchoicetranslation) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete
|
|
8
|
-
|[**getBookingSpaceQuestionChoiceTranslation**](#getbookingspacequestionchoicetranslation) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get
|
|
9
|
-
|[**getBookingSpaceQuestionChoiceTranslations**](#getbookingspacequestionchoicetranslations) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId}/translations |
|
|
10
|
-
|[**updateBookingSpaceQuestionChoiceTranslation**](#updatebookingspacequestionchoicetranslation) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteBookingSpaceQuestionChoiceTranslation**](#deletebookingspacequestionchoicetranslation) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete a booking question choice\'s translation|
|
|
8
|
+
|[**getBookingSpaceQuestionChoiceTranslation**](#getbookingspacequestionchoicetranslation) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get a booking question choice\'s translation|
|
|
9
|
+
|[**getBookingSpaceQuestionChoiceTranslations**](#getbookingspacequestionchoicetranslations) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId}/translations | List a booking question choice\'s translations|
|
|
10
|
+
|[**updateBookingSpaceQuestionChoiceTranslation**](#updatebookingspacequestionchoicetranslation) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update a booking question choice\'s translation|
|
|
11
11
|
|
|
12
12
|
# **deleteBookingSpaceQuestionChoiceTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteBookingSpaceQuestionChoiceTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Removes the translation for a specific locale from a booking space question choice, requires the update bookings permission.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -75,7 +75,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceQuestionChoiceTrans
|
|
|
75
75
|
# **getBookingSpaceQuestionChoiceTranslation**
|
|
76
76
|
> GetBookingSpaceQuestionChoiceTranslation200Response getBookingSpaceQuestionChoiceTranslation()
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
Returns the translated text for a booking space question choice in the given locale, or null if no translation exists for that locale; requires \"read\" permission on \"bookings\".
|
|
79
79
|
|
|
80
80
|
### Example
|
|
81
81
|
|
|
@@ -138,7 +138,7 @@ const { status, data } = await apiInstance.getBookingSpaceQuestionChoiceTranslat
|
|
|
138
138
|
# **getBookingSpaceQuestionChoiceTranslations**
|
|
139
139
|
> GetBookingSpaceQuestionChoiceTranslations200Response getBookingSpaceQuestionChoiceTranslations()
|
|
140
140
|
|
|
141
|
-
|
|
141
|
+
Returns the list of locale translations for a single answer choice on a booking space question; requires \"read\" permission on \"bookings\".
|
|
142
142
|
|
|
143
143
|
### Example
|
|
144
144
|
|
|
@@ -198,7 +198,7 @@ const { status, data } = await apiInstance.getBookingSpaceQuestionChoiceTranslat
|
|
|
198
198
|
# **updateBookingSpaceQuestionChoiceTranslation**
|
|
199
199
|
> UpdateBookingSpaceQuestionChoiceTranslation200Response updateBookingSpaceQuestionChoiceTranslation(bookingSpaceQuestionChoiceTranslationUpdateInputs)
|
|
200
200
|
|
|
201
|
-
|
|
201
|
+
Updates the translated label for a booking space question choice in the given locale, requires the update bookings permission.
|
|
202
202
|
|
|
203
203
|
### Example
|
|
204
204
|
|
|
@@ -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
|
-
|[**deleteBookingSpaceQuestionTranslation**](#deletebookingspacequestiontranslation) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/translations/{locale} | Delete
|
|
8
|
-
|[**getBookingSpaceQuestionTranslation**](#getbookingspacequestiontranslation) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/translations/{locale} | Get
|
|
9
|
-
|[**getBookingSpaceQuestionTranslations**](#getbookingspacequestiontranslations) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/translations |
|
|
10
|
-
|[**updateBookingSpaceQuestionTranslation**](#updatebookingspacequestiontranslation) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteBookingSpaceQuestionTranslation**](#deletebookingspacequestiontranslation) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/translations/{locale} | Delete a booking question translation|
|
|
8
|
+
|[**getBookingSpaceQuestionTranslation**](#getbookingspacequestiontranslation) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/translations/{locale} | Get a booking question\'s translation|
|
|
9
|
+
|[**getBookingSpaceQuestionTranslations**](#getbookingspacequestiontranslations) | **GET** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/translations | List a booking question\'s translations|
|
|
10
|
+
|[**updateBookingSpaceQuestionTranslation**](#updatebookingspacequestiontranslation) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/questions/{questionId}/translations/{locale} | Update a booking question translation|
|
|
11
11
|
|
|
12
12
|
# **deleteBookingSpaceQuestionTranslation**
|
|
13
13
|
> SyncAccounts200Response deleteBookingSpaceQuestionTranslation()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Deletes the translation for the given locale on a booking space question, removing that language\'s localized label, description, and other translated fields; requires update permission on bookings.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -72,7 +72,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceQuestionTranslation
|
|
|
72
72
|
# **getBookingSpaceQuestionTranslation**
|
|
73
73
|
> GetBookingSpaceQuestionTranslation200Response getBookingSpaceQuestionTranslation()
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
Retrieves the translated label, description, and choices for a booking space question in a specific locale, returning null if no translation exists for that locale; requires the \"read\" permission on \"bookings\".
|
|
76
76
|
|
|
77
77
|
### Example
|
|
78
78
|
|
|
@@ -132,7 +132,7 @@ const { status, data } = await apiInstance.getBookingSpaceQuestionTranslation(
|
|
|
132
132
|
# **getBookingSpaceQuestionTranslations**
|
|
133
133
|
> GetBookingSpaceQuestionTranslations200Response getBookingSpaceQuestionTranslations()
|
|
134
134
|
|
|
135
|
-
|
|
135
|
+
Returns every locale translation available for a single booking space question, covering its label, description, and choice text; requires the \"read\" permission on \"bookings\".
|
|
136
136
|
|
|
137
137
|
### Example
|
|
138
138
|
|
|
@@ -189,7 +189,7 @@ const { status, data } = await apiInstance.getBookingSpaceQuestionTranslations(
|
|
|
189
189
|
# **updateBookingSpaceQuestionTranslation**
|
|
190
190
|
> UpdateBookingSpaceQuestionTranslation200Response updateBookingSpaceQuestionTranslation(bookingSpaceQuestionTranslationUpdateInputs)
|
|
191
191
|
|
|
192
|
-
|
|
192
|
+
Creates or updates the localized content (such as label and description) for a booking space question in the given locale; requires update permission on bookings.
|
|
193
193
|
|
|
194
194
|
### Example
|
|
195
195
|
|
|
@@ -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
|
-
|[**createBookingSpace**](#createbookingspace) | **POST** /bookings/places/{placeId}/spaces | Create
|
|
8
|
-
|[**deleteBookingSpace**](#deletebookingspace) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId} | Delete
|
|
9
|
-
|[**updateBookingSpace**](#updatebookingspace) | **PUT** /bookings/places/{placeId}/spaces/{spaceId} | Update
|
|
7
|
+
|[**createBookingSpace**](#createbookingspace) | **POST** /bookings/places/{placeId}/spaces | Create a booking space|
|
|
8
|
+
|[**deleteBookingSpace**](#deletebookingspace) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId} | Delete a booking space|
|
|
9
|
+
|[**updateBookingSpace**](#updatebookingspace) | **PUT** /bookings/places/{placeId}/spaces/{spaceId} | Update a booking space|
|
|
10
10
|
|
|
11
11
|
# **createBookingSpace**
|
|
12
12
|
> CreateBookingSpace200Response createBookingSpace(bookingSpaceCreateInputs)
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Creates a new bookable space within a booking place, requires the update bookings permission, and assigns the space a sort order relative to existing spaces if none is provided.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.createBookingSpace(
|
|
|
66
66
|
# **deleteBookingSpace**
|
|
67
67
|
> CreateAccountInvitations200Response deleteBookingSpace()
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
Deletes a booking space from a booking place, requires the update bookings permission, and fails if the space still has existing bookings.
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
|
|
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.deleteBookingSpace(
|
|
|
120
120
|
# **updateBookingSpace**
|
|
121
121
|
> CreateBookingSpace200Response updateBookingSpace()
|
|
122
122
|
|
|
123
|
-
|
|
123
|
+
Updates the attributes of an existing booking space within a booking place, such as its details and sort order, and requires the update bookings permission.
|
|
124
124
|
|
|
125
125
|
### Example
|
|
126
126
|
|
|
@@ -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
|
-
|[**deleteBookingSpaceTranslation**](#deletebookingspacetranslation) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/translations/{locale} | Delete
|
|
8
|
-
|[**updateBookingSpaceTranslation**](#updatebookingspacetranslation) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteBookingSpaceTranslation**](#deletebookingspacetranslation) | **DELETE** /bookings/places/{placeId}/spaces/{spaceId}/translations/{locale} | Delete a booking space translation|
|
|
8
|
+
|[**updateBookingSpaceTranslation**](#updatebookingspacetranslation) | **PUT** /bookings/places/{placeId}/spaces/{spaceId}/translations/{locale} | Update a booking space translation|
|
|
9
9
|
|
|
10
10
|
# **deleteBookingSpaceTranslation**
|
|
11
11
|
> SyncAccounts200Response deleteBookingSpaceTranslation()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Deletes the translation for the given locale on a booking space, removing that language\'s localized name and other translated fields; requires update permission on bookings.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.deleteBookingSpaceTranslation(
|
|
|
67
67
|
# **updateBookingSpaceTranslation**
|
|
68
68
|
> SyncAccounts200Response updateBookingSpaceTranslation(bookingSpaceTranslationUpdateInputs)
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
Creates or updates the localized content (such as name) for a booking space in the given locale; requires update permission on bookings.
|
|
71
71
|
|
|
72
72
|
### Example
|
|
73
73
|
|
package/docs/ChannelsApi.md
CHANGED
|
@@ -4,40 +4,40 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addChannelSubscriber**](#addchannelsubscriber) | **POST** /channels/{channelId}/subscribers |
|
|
8
|
-
|[**cancelChannelContentPublishSchedule**](#cancelchannelcontentpublishschedule) | **DELETE** /channels/{channelId}/contents/{contentId}/schedule | Cancel
|
|
9
|
-
|[**createChannel**](#createchannel) | **POST** /channels | Create
|
|
10
|
-
|[**createChannelContent**](#createchannelcontent) | **POST** /channels/{channelId}/contents | Create
|
|
11
|
-
|[**createChannelContentGuest**](#createchannelcontentguest) | **POST** /channels/{channelId}/contents/{contentId}/guests |
|
|
12
|
-
|[**deleteChannel**](#deletechannel) | **DELETE** /channels/{channelId} | Delete
|
|
13
|
-
|[**deleteChannelContent**](#deletechannelcontent) | **DELETE** /channels/{channelId}/contents/{contentId} | Delete
|
|
14
|
-
|[**deleteChannelContentGuest**](#deletechannelcontentguest) | **DELETE** /channels/{channelId}/contents/{contentId}/guests/{guestId} |
|
|
15
|
-
|[**getChannel**](#getchannel) | **GET** /channels/{channelId} | Get
|
|
16
|
-
|[**getChannelActivities**](#getchannelactivities) | **GET** /channels/{channelId}/activities |
|
|
17
|
-
|[**getChannelContent**](#getchannelcontent) | **GET** /channels/{channelId}/contents/{contentId} | Get
|
|
18
|
-
|[**getChannelContentActivities**](#getchannelcontentactivities) | **GET** /channels/{channelId}/contents/{contentId}/activities |
|
|
19
|
-
|[**getChannelContentGuest**](#getchannelcontentguest) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Get
|
|
20
|
-
|[**getChannelContentGuests**](#getchannelcontentguests) | **GET** /channels/{channelId}/contents/{contentId}/guests |
|
|
21
|
-
|[**getChannelContentLikes**](#getchannelcontentlikes) | **GET** /channels/{channelId}/contents/{contentId}/likes |
|
|
22
|
-
|[**getChannelContents**](#getchannelcontents) | **GET** /channels/{channelId}/contents |
|
|
23
|
-
|[**getChannelSubscriber**](#getchannelsubscriber) | **GET** /channels/{channelId}/subscribers/{accountId} | Get
|
|
24
|
-
|[**getChannelSubscribers**](#getchannelsubscribers) | **GET** /channels/{channelId}/subscribers |
|
|
25
|
-
|[**getChannels**](#getchannels) | **GET** /channels |
|
|
26
|
-
|[**getContents**](#getcontents) | **GET** /contents |
|
|
27
|
-
|[**getFeaturedChannels**](#getfeaturedchannels) | **GET** /channels/featured |
|
|
28
|
-
|[**removeAllChannelSubscribers**](#removeallchannelsubscribers) | **DELETE** /channels/{channelId}/subscribers | Remove
|
|
29
|
-
|[**removeChannelSubscriber**](#removechannelsubscriber) | **DELETE** /channels/{channelId}/subscribers/{accountId} | Remove
|
|
30
|
-
|[**revertChannelContentToDraft**](#revertchannelcontenttodraft) | **PUT** /channels/{channelId}/contents/{contentId}/revertToDraft | Revert
|
|
31
|
-
|[**updateChannel**](#updatechannel) | **PUT** /channels/{channelId} | Update
|
|
32
|
-
|[**updateChannelContent**](#updatechannelcontent) | **PUT** /channels/{channelId}/contents/{contentId} | Update
|
|
33
|
-
|[**updateChannelContentGuest**](#updatechannelcontentguest) | **PUT** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Update
|
|
34
|
-
|[**updateChannelContentPublishSchedule**](#updatechannelcontentpublishschedule) | **POST** /channels/{channelId}/contents/{contentId}/schedule |
|
|
35
|
-
|[**updateChannelSubscriber**](#updatechannelsubscriber) | **PUT** /channels/{channelId}/subscribers/{accountId} | Update
|
|
7
|
+
|[**addChannelSubscriber**](#addchannelsubscriber) | **POST** /channels/{channelId}/subscribers | Subscribe an account to a channel|
|
|
8
|
+
|[**cancelChannelContentPublishSchedule**](#cancelchannelcontentpublishschedule) | **DELETE** /channels/{channelId}/contents/{contentId}/schedule | Cancel a scheduled channel content publish|
|
|
9
|
+
|[**createChannel**](#createchannel) | **POST** /channels | Create a channel|
|
|
10
|
+
|[**createChannelContent**](#createchannelcontent) | **POST** /channels/{channelId}/contents | Create channel content|
|
|
11
|
+
|[**createChannelContentGuest**](#createchannelcontentguest) | **POST** /channels/{channelId}/contents/{contentId}/guests | Add a guest to channel content|
|
|
12
|
+
|[**deleteChannel**](#deletechannel) | **DELETE** /channels/{channelId} | Delete a channel|
|
|
13
|
+
|[**deleteChannelContent**](#deletechannelcontent) | **DELETE** /channels/{channelId}/contents/{contentId} | Delete channel content|
|
|
14
|
+
|[**deleteChannelContentGuest**](#deletechannelcontentguest) | **DELETE** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Remove a guest from channel content|
|
|
15
|
+
|[**getChannel**](#getchannel) | **GET** /channels/{channelId} | Get a channel|
|
|
16
|
+
|[**getChannelActivities**](#getchannelactivities) | **GET** /channels/{channelId}/activities | List a channel\'s activity feed|
|
|
17
|
+
|[**getChannelContent**](#getchannelcontent) | **GET** /channels/{channelId}/contents/{contentId} | Get a channel\'s content item|
|
|
18
|
+
|[**getChannelContentActivities**](#getchannelcontentactivities) | **GET** /channels/{channelId}/contents/{contentId}/activities | List a content item\'s activity feed|
|
|
19
|
+
|[**getChannelContentGuest**](#getchannelcontentguest) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Get a content item\'s guest|
|
|
20
|
+
|[**getChannelContentGuests**](#getchannelcontentguests) | **GET** /channels/{channelId}/contents/{contentId}/guests | List a content item\'s guests|
|
|
21
|
+
|[**getChannelContentLikes**](#getchannelcontentlikes) | **GET** /channels/{channelId}/contents/{contentId}/likes | List a content item\'s likes|
|
|
22
|
+
|[**getChannelContents**](#getchannelcontents) | **GET** /channels/{channelId}/contents | List a channel\'s content|
|
|
23
|
+
|[**getChannelSubscriber**](#getchannelsubscriber) | **GET** /channels/{channelId}/subscribers/{accountId} | Get a channel\'s subscriber|
|
|
24
|
+
|[**getChannelSubscribers**](#getchannelsubscribers) | **GET** /channels/{channelId}/subscribers | List a channel\'s subscribers|
|
|
25
|
+
|[**getChannels**](#getchannels) | **GET** /channels | List channels|
|
|
26
|
+
|[**getContents**](#getcontents) | **GET** /contents | List organization-wide channel content|
|
|
27
|
+
|[**getFeaturedChannels**](#getfeaturedchannels) | **GET** /channels/featured | List featured channels|
|
|
28
|
+
|[**removeAllChannelSubscribers**](#removeallchannelsubscribers) | **DELETE** /channels/{channelId}/subscribers | Remove all subscribers from a channel|
|
|
29
|
+
|[**removeChannelSubscriber**](#removechannelsubscriber) | **DELETE** /channels/{channelId}/subscribers/{accountId} | Remove a subscriber from a channel|
|
|
30
|
+
|[**revertChannelContentToDraft**](#revertchannelcontenttodraft) | **PUT** /channels/{channelId}/contents/{contentId}/revertToDraft | Revert channel content to draft|
|
|
31
|
+
|[**updateChannel**](#updatechannel) | **PUT** /channels/{channelId} | Update a channel|
|
|
32
|
+
|[**updateChannelContent**](#updatechannelcontent) | **PUT** /channels/{channelId}/contents/{contentId} | Update channel content|
|
|
33
|
+
|[**updateChannelContentGuest**](#updatechannelcontentguest) | **PUT** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Update a content guest|
|
|
34
|
+
|[**updateChannelContentPublishSchedule**](#updatechannelcontentpublishschedule) | **POST** /channels/{channelId}/contents/{contentId}/schedule | Schedule channel content for publishing|
|
|
35
|
+
|[**updateChannelSubscriber**](#updatechannelsubscriber) | **PUT** /channels/{channelId}/subscribers/{accountId} | Update an account\'s channel subscription|
|
|
36
36
|
|
|
37
37
|
# **addChannelSubscriber**
|
|
38
38
|
> AddChannelSubscriber200Response addChannelSubscriber()
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
Adds the given account as a subscriber of the specified channel, requiring update permission on both channels and accounts.
|
|
41
41
|
|
|
42
42
|
### Example
|
|
43
43
|
|
|
@@ -91,7 +91,7 @@ const { status, data } = await apiInstance.addChannelSubscriber(
|
|
|
91
91
|
# **cancelChannelContentPublishSchedule**
|
|
92
92
|
> CreateChannelContent200Response cancelChannelContentPublishSchedule()
|
|
93
93
|
|
|
94
|
-
|
|
94
|
+
Cancels the pending scheduled publish date for a piece of channel content, requiring update permission on contents.
|
|
95
95
|
|
|
96
96
|
### Example
|
|
97
97
|
|
|
@@ -145,7 +145,7 @@ const { status, data } = await apiInstance.cancelChannelContentPublishSchedule(
|
|
|
145
145
|
# **createChannel**
|
|
146
146
|
> CreateChannel200Response createChannel(channelCreateInputs)
|
|
147
147
|
|
|
148
|
-
|
|
148
|
+
Creates a new content channel for the organization, requiring create permission on channels.
|
|
149
149
|
|
|
150
150
|
### Example
|
|
151
151
|
|
|
@@ -197,7 +197,7 @@ const { status, data } = await apiInstance.createChannel(
|
|
|
197
197
|
# **createChannelContent**
|
|
198
198
|
> CreateChannelContent200Response createChannelContent(channelContentCreateInputs)
|
|
199
199
|
|
|
200
|
-
|
|
200
|
+
Creates a new content item (post) within the specified channel, requiring create permission on contents, and invalidates the channel\'s subscriber cache on success.
|
|
201
201
|
|
|
202
202
|
### Example
|
|
203
203
|
|
|
@@ -252,7 +252,7 @@ const { status, data } = await apiInstance.createChannelContent(
|
|
|
252
252
|
# **createChannelContentGuest**
|
|
253
253
|
> CreateChannelContentGuest200Response createChannelContentGuest()
|
|
254
254
|
|
|
255
|
-
|
|
255
|
+
Adds a guest (such as a speaker or host) to a specific content item within a channel, requiring update permission on contents, and returns the created guest record.
|
|
256
256
|
|
|
257
257
|
### Example
|
|
258
258
|
|
|
@@ -310,7 +310,7 @@ const { status, data } = await apiInstance.createChannelContentGuest(
|
|
|
310
310
|
# **deleteChannel**
|
|
311
311
|
> CreateAccountInvitations200Response deleteChannel()
|
|
312
312
|
|
|
313
|
-
|
|
313
|
+
Permanently deletes the specified channel and its association from the organization, requiring delete permission on channels.
|
|
314
314
|
|
|
315
315
|
### Example
|
|
316
316
|
|
|
@@ -361,7 +361,7 @@ const { status, data } = await apiInstance.deleteChannel(
|
|
|
361
361
|
# **deleteChannelContent**
|
|
362
362
|
> CreateAccountInvitations200Response deleteChannelContent()
|
|
363
363
|
|
|
364
|
-
|
|
364
|
+
Permanently deletes a specific content item from the given channel, requiring delete permission on contents.
|
|
365
365
|
|
|
366
366
|
### Example
|
|
367
367
|
|
|
@@ -415,7 +415,7 @@ const { status, data } = await apiInstance.deleteChannelContent(
|
|
|
415
415
|
# **deleteChannelContentGuest**
|
|
416
416
|
> CreateChannelContent200Response deleteChannelContentGuest()
|
|
417
417
|
|
|
418
|
-
|
|
418
|
+
Removes a specific guest (such as a speaker or host) from a content item within a channel, requiring update permission on contents.
|
|
419
419
|
|
|
420
420
|
### Example
|
|
421
421
|
|
|
@@ -472,7 +472,7 @@ const { status, data } = await apiInstance.deleteChannelContentGuest(
|
|
|
472
472
|
# **getChannel**
|
|
473
473
|
> CreateChannel200Response getChannel()
|
|
474
474
|
|
|
475
|
-
|
|
475
|
+
Retrieves a single channel by its ID or slug, requiring read permission on channels.
|
|
476
476
|
|
|
477
477
|
### Example
|
|
478
478
|
|
|
@@ -523,7 +523,7 @@ const { status, data } = await apiInstance.getChannel(
|
|
|
523
523
|
# **getChannelActivities**
|
|
524
524
|
> GetAccountActivities200Response getChannelActivities()
|
|
525
525
|
|
|
526
|
-
|
|
526
|
+
Returns a paginated list of activity records posted to the given channel, optionally filtered by activity status, search term, and sort order, requiring read permission on channels and activities.
|
|
527
527
|
|
|
528
528
|
### Example
|
|
529
529
|
|
|
@@ -589,7 +589,7 @@ const { status, data } = await apiInstance.getChannelActivities(
|
|
|
589
589
|
# **getChannelContent**
|
|
590
590
|
> CreateChannelContent200Response getChannelContent()
|
|
591
591
|
|
|
592
|
-
|
|
592
|
+
Retrieves a single piece of content belonging to the given channel by its content ID, requiring read permission on channels and contents.
|
|
593
593
|
|
|
594
594
|
### Example
|
|
595
595
|
|
|
@@ -643,7 +643,7 @@ const { status, data } = await apiInstance.getChannelContent(
|
|
|
643
643
|
# **getChannelContentActivities**
|
|
644
644
|
> GetAccountActivities200Response getChannelContentActivities()
|
|
645
645
|
|
|
646
|
-
|
|
646
|
+
Returns a paginated list of activity records posted on a specific content item within a channel, optionally filtered by activity status and search term, requiring read permission on channels, contents, and activities.
|
|
647
647
|
|
|
648
648
|
### Example
|
|
649
649
|
|
|
@@ -712,7 +712,7 @@ const { status, data } = await apiInstance.getChannelContentActivities(
|
|
|
712
712
|
# **getChannelContentGuest**
|
|
713
713
|
> CreateChannelContentGuest200Response getChannelContentGuest()
|
|
714
714
|
|
|
715
|
-
|
|
715
|
+
Retrieves a single guest record for a specific content item within a channel by guest ID, requiring read permission on channels and contents.
|
|
716
716
|
|
|
717
717
|
### Example
|
|
718
718
|
|
|
@@ -772,7 +772,7 @@ const { status, data } = await apiInstance.getChannelContentGuest(
|
|
|
772
772
|
# **getChannelContentGuests**
|
|
773
773
|
> GetChannelContentGuests200Response getChannelContentGuests()
|
|
774
774
|
|
|
775
|
-
|
|
775
|
+
Returns a paginated list of guests (e.g. speakers/panelists) associated with a specific content item within a channel, optionally filtered by search term and sort order, requiring read permission on channels and contents.
|
|
776
776
|
|
|
777
777
|
### Example
|
|
778
778
|
|
|
@@ -841,7 +841,7 @@ const { status, data } = await apiInstance.getChannelContentGuests(
|
|
|
841
841
|
# **getChannelContentLikes**
|
|
842
842
|
> GetChannelContentLikes200Response getChannelContentLikes()
|
|
843
843
|
|
|
844
|
-
|
|
844
|
+
Returns a paginated list of accounts that liked a specific content item within a channel, optionally filtered by search term and sort order, requiring read permission on channels and contents.
|
|
845
845
|
|
|
846
846
|
### Example
|
|
847
847
|
|
|
@@ -907,7 +907,7 @@ const { status, data } = await apiInstance.getChannelContentLikes(
|
|
|
907
907
|
# **getChannelContents**
|
|
908
908
|
> GetChannelContents200Response getChannelContents()
|
|
909
909
|
|
|
910
|
-
|
|
910
|
+
Returns a paginated list of content items belonging to the given channel, optionally filtered by featured status and search term, requiring read permission on channels and contents.
|
|
911
911
|
|
|
912
912
|
### Example
|
|
913
913
|
|
|
@@ -973,7 +973,7 @@ const { status, data } = await apiInstance.getChannelContents(
|
|
|
973
973
|
# **getChannelSubscriber**
|
|
974
974
|
> AddChannelSubscriber200Response getChannelSubscriber()
|
|
975
975
|
|
|
976
|
-
|
|
976
|
+
Retrieves a single subscription record for the given account on the given channel, requiring read permission on channels and accounts.
|
|
977
977
|
|
|
978
978
|
### Example
|
|
979
979
|
|
|
@@ -1027,7 +1027,7 @@ const { status, data } = await apiInstance.getChannelSubscriber(
|
|
|
1027
1027
|
# **getChannelSubscribers**
|
|
1028
1028
|
> GetChannelSubscribers200Response getChannelSubscribers()
|
|
1029
1029
|
|
|
1030
|
-
|
|
1030
|
+
Returns a paginated list of accounts subscribed to the given channel, optionally filtered by subscription status and searched by keyword; requires read permission on channels and accounts.
|
|
1031
1031
|
|
|
1032
1032
|
### Example
|
|
1033
1033
|
|
|
@@ -1093,7 +1093,7 @@ const { status, data } = await apiInstance.getChannelSubscribers(
|
|
|
1093
1093
|
# **getChannels**
|
|
1094
1094
|
> GetChannels200Response getChannels()
|
|
1095
1095
|
|
|
1096
|
-
|
|
1096
|
+
Returns a paginated list of channels for the organization, optionally filtered by search term and sort order, requiring read permission on channels.
|
|
1097
1097
|
|
|
1098
1098
|
### Example
|
|
1099
1099
|
|
|
@@ -1153,7 +1153,7 @@ const { status, data } = await apiInstance.getChannels(
|
|
|
1153
1153
|
# **getContents**
|
|
1154
1154
|
> GetChannelContents200Response getContents()
|
|
1155
1155
|
|
|
1156
|
-
|
|
1156
|
+
Returns a paginated list of content items (videos, audio, or articles) across all of the organization\'s channels, filterable by featured status, content type, and whether publish date is in the past or upcoming; requires read permission on contents.
|
|
1157
1157
|
|
|
1158
1158
|
### Example
|
|
1159
1159
|
|
|
@@ -1222,7 +1222,7 @@ const { status, data } = await apiInstance.getContents(
|
|
|
1222
1222
|
# **getFeaturedChannels**
|
|
1223
1223
|
> GetChannels200Response getFeaturedChannels()
|
|
1224
1224
|
|
|
1225
|
-
|
|
1225
|
+
Returns a paginated list of channels marked as featured for the organization; requires read permission on channels.
|
|
1226
1226
|
|
|
1227
1227
|
### Example
|
|
1228
1228
|
|
|
@@ -1282,7 +1282,7 @@ const { status, data } = await apiInstance.getFeaturedChannels(
|
|
|
1282
1282
|
# **removeAllChannelSubscribers**
|
|
1283
1283
|
> CreateChannel200Response removeAllChannelSubscribers()
|
|
1284
1284
|
|
|
1285
|
-
|
|
1285
|
+
Unsubscribes every account currently subscribed to the specified channel, requiring update and delete permission on channels and accounts.
|
|
1286
1286
|
|
|
1287
1287
|
### Example
|
|
1288
1288
|
|
|
@@ -1333,7 +1333,7 @@ const { status, data } = await apiInstance.removeAllChannelSubscribers(
|
|
|
1333
1333
|
# **removeChannelSubscriber**
|
|
1334
1334
|
> AddChannelSubscriber200Response removeChannelSubscriber()
|
|
1335
1335
|
|
|
1336
|
-
|
|
1336
|
+
Unsubscribes a specific account from the given channel, requiring update permission on channels and accounts.
|
|
1337
1337
|
|
|
1338
1338
|
### Example
|
|
1339
1339
|
|
|
@@ -1387,7 +1387,7 @@ const { status, data } = await apiInstance.removeChannelSubscriber(
|
|
|
1387
1387
|
# **revertChannelContentToDraft**
|
|
1388
1388
|
> CreateChannelContent200Response revertChannelContentToDraft()
|
|
1389
1389
|
|
|
1390
|
-
|
|
1390
|
+
Changes a published or scheduled content item back to draft status, unpublishing it, requiring update permission on contents.
|
|
1391
1391
|
|
|
1392
1392
|
### Example
|
|
1393
1393
|
|
|
@@ -1441,7 +1441,7 @@ const { status, data } = await apiInstance.revertChannelContentToDraft(
|
|
|
1441
1441
|
# **updateChannel**
|
|
1442
1442
|
> CreateChannel200Response updateChannel()
|
|
1443
1443
|
|
|
1444
|
-
|
|
1444
|
+
Updates the properties of an existing channel, such as its name and settings, requiring update permission on channels.
|
|
1445
1445
|
|
|
1446
1446
|
### Example
|
|
1447
1447
|
|
|
@@ -1496,7 +1496,7 @@ const { status, data } = await apiInstance.updateChannel(
|
|
|
1496
1496
|
# **updateChannelContent**
|
|
1497
1497
|
> CreateChannelContent200Response updateChannelContent(channelContentUpdateInputs)
|
|
1498
1498
|
|
|
1499
|
-
|
|
1499
|
+
Updates the fields of an existing content item within a channel, such as its title, body, or publish settings, requiring update permission on contents.
|
|
1500
1500
|
|
|
1501
1501
|
### Example
|
|
1502
1502
|
|
|
@@ -1554,7 +1554,7 @@ const { status, data } = await apiInstance.updateChannelContent(
|
|
|
1554
1554
|
# **updateChannelContentGuest**
|
|
1555
1555
|
> CreateChannelContentGuest200Response updateChannelContentGuest()
|
|
1556
1556
|
|
|
1557
|
-
|
|
1557
|
+
Updates a guest speaker or panelist record attached to a piece of channel content, such as their name, bio, title, company, or image, and requires update permission on contents.
|
|
1558
1558
|
|
|
1559
1559
|
### Example
|
|
1560
1560
|
|
|
@@ -1615,7 +1615,7 @@ const { status, data } = await apiInstance.updateChannelContentGuest(
|
|
|
1615
1615
|
# **updateChannelContentPublishSchedule**
|
|
1616
1616
|
> CreateChannelContent200Response updateChannelContentPublishSchedule(body)
|
|
1617
1617
|
|
|
1618
|
-
|
|
1618
|
+
Sets or updates the future publish date for a piece of channel content, and optionally triggers email and push notifications when it goes live; requires update permission on contents.
|
|
1619
1619
|
|
|
1620
1620
|
### Example
|
|
1621
1621
|
|
|
@@ -1672,7 +1672,7 @@ const { status, data } = await apiInstance.updateChannelContentPublishSchedule(
|
|
|
1672
1672
|
# **updateChannelSubscriber**
|
|
1673
1673
|
> AddChannelSubscriber200Response updateChannelSubscriber(channelSubscriberUpdateInputs)
|
|
1674
1674
|
|
|
1675
|
-
|
|
1675
|
+
Updates the subscription settings, such as the activity notification preference, for a given account\'s subscription to a channel; requires update permission on both channels and accounts.
|
|
1676
1676
|
|
|
1677
1677
|
### Example
|
|
1678
1678
|
|
|
@@ -4,23 +4,23 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteChannelContentGuestTranslation**](#deletechannelcontentguesttranslation) | **DELETE** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Delete
|
|
8
|
-
|[**deleteChannelContentTranslation**](#deletechannelcontenttranslation) | **DELETE** /channels/{channelId}/contents/{contentId}/translations/{locale} | Delete
|
|
9
|
-
|[**deleteChannelTranslation**](#deletechanneltranslation) | **DELETE** /channels/{channelId}/translations/{locale} | Delete
|
|
10
|
-
|[**getChannelContentGuestTranslation**](#getchannelcontentguesttranslation) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Get
|
|
11
|
-
|[**getChannelContentGuestTranslations**](#getchannelcontentguesttranslations) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations |
|
|
12
|
-
|[**getChannelContentTranslation**](#getchannelcontenttranslation) | **GET** /channels/{channelId}/contents/{contentId}/translations/{locale} | Get
|
|
13
|
-
|[**getChannelContentTranslations**](#getchannelcontenttranslations) | **GET** /channels/{channelId}/contents/{contentId}/translations |
|
|
14
|
-
|[**getChannelTranslation**](#getchanneltranslation) | **GET** /channels/{channelId}/translations/{locale} | Get
|
|
15
|
-
|[**getChannelTranslations**](#getchanneltranslations) | **GET** /channels/{channelId}/translations |
|
|
16
|
-
|[**updateChannelContentGuestTranslation**](#updatechannelcontentguesttranslation) | **PUT** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Update
|
|
17
|
-
|[**updateChannelContentTranslation**](#updatechannelcontenttranslation) | **PUT** /channels/{channelId}/contents/{contentId}/translations/{locale} | Update
|
|
18
|
-
|[**updateChannelTranslation**](#updatechanneltranslation) | **PUT** /channels/{channelId}/translations/{locale} | Update
|
|
7
|
+
|[**deleteChannelContentGuestTranslation**](#deletechannelcontentguesttranslation) | **DELETE** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Delete a channel content guest translation|
|
|
8
|
+
|[**deleteChannelContentTranslation**](#deletechannelcontenttranslation) | **DELETE** /channels/{channelId}/contents/{contentId}/translations/{locale} | Delete a channel content translation|
|
|
9
|
+
|[**deleteChannelTranslation**](#deletechanneltranslation) | **DELETE** /channels/{channelId}/translations/{locale} | Delete a channel translation|
|
|
10
|
+
|[**getChannelContentGuestTranslation**](#getchannelcontentguesttranslation) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Get a channel content guest\'s translation for a locale|
|
|
11
|
+
|[**getChannelContentGuestTranslations**](#getchannelcontentguesttranslations) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations | List a channel content guest\'s translations|
|
|
12
|
+
|[**getChannelContentTranslation**](#getchannelcontenttranslation) | **GET** /channels/{channelId}/contents/{contentId}/translations/{locale} | Get a channel content item\'s translation for a locale|
|
|
13
|
+
|[**getChannelContentTranslations**](#getchannelcontenttranslations) | **GET** /channels/{channelId}/contents/{contentId}/translations | List a channel content item\'s translations|
|
|
14
|
+
|[**getChannelTranslation**](#getchanneltranslation) | **GET** /channels/{channelId}/translations/{locale} | Get a channel\'s translation for a locale|
|
|
15
|
+
|[**getChannelTranslations**](#getchanneltranslations) | **GET** /channels/{channelId}/translations | List a channel\'s translations|
|
|
16
|
+
|[**updateChannelContentGuestTranslation**](#updatechannelcontentguesttranslation) | **PUT** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Update a channel content guest translation|
|
|
17
|
+
|[**updateChannelContentTranslation**](#updatechannelcontenttranslation) | **PUT** /channels/{channelId}/contents/{contentId}/translations/{locale} | Update a channel content translation|
|
|
18
|
+
|[**updateChannelTranslation**](#updatechanneltranslation) | **PUT** /channels/{channelId}/translations/{locale} | Update a channel translation|
|
|
19
19
|
|
|
20
20
|
# **deleteChannelContentGuestTranslation**
|
|
21
21
|
> SyncAccounts200Response deleteChannelContentGuestTranslation()
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
Removes the translation for a specific locale on a channel content item\'s guest speaker/author, requiring update permission on contents.
|
|
24
24
|
|
|
25
25
|
### Example
|
|
26
26
|
|
|
@@ -80,7 +80,7 @@ const { status, data } = await apiInstance.deleteChannelContentGuestTranslation(
|
|
|
80
80
|
# **deleteChannelContentTranslation**
|
|
81
81
|
> SyncAccounts200Response deleteChannelContentTranslation()
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
Removes the translation for a specific locale on a piece of channel content, requiring update permission on contents.
|
|
84
84
|
|
|
85
85
|
### Example
|
|
86
86
|
|
|
@@ -137,7 +137,7 @@ const { status, data } = await apiInstance.deleteChannelContentTranslation(
|
|
|
137
137
|
# **deleteChannelTranslation**
|
|
138
138
|
> SyncAccounts200Response deleteChannelTranslation()
|
|
139
139
|
|
|
140
|
-
|
|
140
|
+
Removes the translation for a specific locale on a channel\'s name/description, requiring update permission on channels.
|
|
141
141
|
|
|
142
142
|
### Example
|
|
143
143
|
|
|
@@ -191,7 +191,7 @@ const { status, data } = await apiInstance.deleteChannelTranslation(
|
|
|
191
191
|
# **getChannelContentGuestTranslation**
|
|
192
192
|
> GetChannelContentGuestTranslation200Response getChannelContentGuestTranslation()
|
|
193
193
|
|
|
194
|
-
|
|
194
|
+
Returns the localized translation of a channel content guest\'s fields for the given locale, or null if no translation exists, requiring read permission on channels and contents.
|
|
195
195
|
|
|
196
196
|
### Example
|
|
197
197
|
|
|
@@ -251,7 +251,7 @@ const { status, data } = await apiInstance.getChannelContentGuestTranslation(
|
|
|
251
251
|
# **getChannelContentGuestTranslations**
|
|
252
252
|
> GetChannelContentGuestTranslations200Response getChannelContentGuestTranslations()
|
|
253
253
|
|
|
254
|
-
|
|
254
|
+
Returns a paginated, searchable list of locale translations for a guest of a piece of channel content, requiring read permission on channels and contents.
|
|
255
255
|
|
|
256
256
|
### Example
|
|
257
257
|
|
|
@@ -320,7 +320,7 @@ const { status, data } = await apiInstance.getChannelContentGuestTranslations(
|
|
|
320
320
|
# **getChannelContentTranslation**
|
|
321
321
|
> GetChannelContentTranslation200Response getChannelContentTranslation()
|
|
322
322
|
|
|
323
|
-
|
|
323
|
+
Returns the localized translation of a channel content item\'s fields for the given locale, or null if no translation exists, requiring read permission on channels and contents.
|
|
324
324
|
|
|
325
325
|
### Example
|
|
326
326
|
|
|
@@ -377,7 +377,7 @@ const { status, data } = await apiInstance.getChannelContentTranslation(
|
|
|
377
377
|
# **getChannelContentTranslations**
|
|
378
378
|
> GetChannelContentTranslations200Response getChannelContentTranslations()
|
|
379
379
|
|
|
380
|
-
|
|
380
|
+
Returns a paginated, searchable list of locale translations for a piece of channel content, requiring read permission on channels and contents.
|
|
381
381
|
|
|
382
382
|
### Example
|
|
383
383
|
|
|
@@ -443,7 +443,7 @@ const { status, data } = await apiInstance.getChannelContentTranslations(
|
|
|
443
443
|
# **getChannelTranslation**
|
|
444
444
|
> GetChannelTranslation200Response getChannelTranslation()
|
|
445
445
|
|
|
446
|
-
|
|
446
|
+
Returns the localized translation of a channel\'s fields for the given locale, or null if no translation exists, requiring read permission on channels.
|
|
447
447
|
|
|
448
448
|
### Example
|
|
449
449
|
|
|
@@ -497,7 +497,7 @@ const { status, data } = await apiInstance.getChannelTranslation(
|
|
|
497
497
|
# **getChannelTranslations**
|
|
498
498
|
> GetChannelTranslations200Response getChannelTranslations()
|
|
499
499
|
|
|
500
|
-
|
|
500
|
+
Returns a paginated, searchable list of locale translations for a channel, requiring read permission on channels.
|
|
501
501
|
|
|
502
502
|
### Example
|
|
503
503
|
|
|
@@ -560,7 +560,7 @@ const { status, data } = await apiInstance.getChannelTranslations(
|
|
|
560
560
|
# **updateChannelContentGuestTranslation**
|
|
561
561
|
> UpdateChannelContentGuestTranslation200Response updateChannelContentGuestTranslation(channelContentGuestTranslationUpdateInputs)
|
|
562
562
|
|
|
563
|
-
|
|
563
|
+
Creates or updates the translation for a specific locale on a channel content item\'s guest speaker/author, requiring update permission on contents.
|
|
564
564
|
|
|
565
565
|
### Example
|
|
566
566
|
|
|
@@ -624,7 +624,7 @@ const { status, data } = await apiInstance.updateChannelContentGuestTranslation(
|
|
|
624
624
|
# **updateChannelContentTranslation**
|
|
625
625
|
> SyncAccounts200Response updateChannelContentTranslation(channelContentTranslationUpdateInputs)
|
|
626
626
|
|
|
627
|
-
|
|
627
|
+
Creates or updates the translation for a specific locale on a piece of channel content, requiring update permission on contents.
|
|
628
628
|
|
|
629
629
|
### Example
|
|
630
630
|
|
|
@@ -685,7 +685,7 @@ const { status, data } = await apiInstance.updateChannelContentTranslation(
|
|
|
685
685
|
# **updateChannelTranslation**
|
|
686
686
|
> UpdateChannelTranslation200Response updateChannelTranslation(channelTranslationUpdateInputs)
|
|
687
687
|
|
|
688
|
-
|
|
688
|
+
Creates or updates the translation for a specific locale on a channel\'s name/description, requiring update permission on channels.
|
|
689
689
|
|
|
690
690
|
### Example
|
|
691
691
|
|