@connectedxm/admin-sdk 7.5.0 → 7.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1212 -1212
- package/api.ts +9696 -9696
- package/dist/api.d.ts +9696 -9696
- package/dist/api.js +9696 -9696
- package/dist/esm/api.d.ts +9696 -9696
- package/dist/esm/api.js +9696 -9696
- package/docs/AccountsAddressesApi.md +10 -10
- package/docs/AccountsApi.md +42 -42
- package/docs/AccountsFollowersApi.md +6 -6
- package/docs/AccountsFollowingApi.md +6 -6
- package/docs/AccountsGroupsApi.md +6 -6
- package/docs/AccountsInterestsApi.md +6 -6
- package/docs/AccountsInvitationsApi.md +6 -6
- package/docs/AccountsLeadsApi.md +8 -8
- package/docs/AccountsTiersApi.md +8 -8
- package/docs/ActivitiesApi.md +18 -18
- package/docs/ActivitiesScheduleApi.md +4 -4
- package/docs/AdvertisementsApi.md +14 -14
- package/docs/AnnouncementsApi.md +16 -16
- package/docs/AnnouncementsScheduleApi.md +4 -4
- package/docs/AnnouncementsTranslationsApi.md +8 -8
- package/docs/ApiLogsApi.md +4 -4
- package/docs/AuthSessionsApi.md +4 -4
- package/docs/BenefitsApi.md +12 -12
- package/docs/BenefitsTranslationsApi.md +8 -8
- package/docs/BookingsApi.md +56 -56
- package/docs/BookingsAvailabilitiesApi.md +6 -6
- package/docs/BookingsBlackoutsApi.md +6 -6
- package/docs/BookingsPlacesApi.md +6 -6
- package/docs/BookingsPlacesTranslationsApi.md +4 -4
- package/docs/BookingsQuestionsApi.md +16 -16
- package/docs/BookingsQuestionsChoicesApi.md +12 -12
- package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
- package/docs/BookingsQuestionsTranslationsApi.md +8 -8
- package/docs/BookingsSpacesApi.md +6 -6
- package/docs/BookingsSpacesTranslationsApi.md +4 -4
- package/docs/ChannelsApi.md +58 -58
- package/docs/ChannelsTranslationsApi.md +24 -24
- package/docs/DashboardsApi.md +10 -10
- package/docs/DashboardsWidgetsApi.md +8 -8
- package/docs/EmailReceiptsApi.md +4 -4
- package/docs/EventsAccessApi.md +6 -6
- package/docs/EventsActivationsApi.md +22 -22
- package/docs/EventsActivationsSessionsApi.md +6 -6
- package/docs/EventsActivationsTranslationsApi.md +8 -8
- package/docs/EventsAddonsApi.md +24 -24
- package/docs/EventsAddonsTranslationsApi.md +8 -8
- package/docs/EventsApi.md +22 -22
- package/docs/EventsAttendeesApi.md +24 -24
- package/docs/EventsAttendeesPackagesApi.md +10 -10
- package/docs/EventsAttendeesReservationsApi.md +18 -18
- package/docs/EventsAttributesApi.md +10 -10
- package/docs/EventsBenefitsApi.md +4 -4
- package/docs/EventsBlocksApi.md +16 -16
- package/docs/EventsBypassApi.md +10 -10
- package/docs/EventsCohostsApi.md +6 -6
- package/docs/EventsCouponsApi.md +28 -28
- package/docs/EventsEmailsApi.md +4 -4
- package/docs/EventsEmailsTranslationsApi.md +8 -8
- package/docs/EventsFaqsApi.md +22 -22
- package/docs/EventsFaqsTranslationsApi.md +16 -16
- package/docs/EventsFollowupsApi.md +38 -38
- package/docs/EventsFollowupsTranslationsApi.md +8 -8
- package/docs/EventsMatchesApi.md +34 -34
- package/docs/EventsMediaApi.md +16 -16
- package/docs/EventsMediaTranslationsApi.md +8 -8
- package/docs/EventsOnSiteApi.md +6 -6
- package/docs/EventsPackagesApi.md +10 -10
- package/docs/EventsPackagesPassesApi.md +10 -10
- package/docs/EventsPackagesTranslationsApi.md +8 -8
- package/docs/EventsPagesApi.md +16 -16
- package/docs/EventsPagesTranslationsApi.md +8 -8
- package/docs/EventsPassesAccessesApi.md +10 -10
- package/docs/EventsPassesAddonsApi.md +6 -6
- package/docs/EventsPassesApi.md +34 -34
- package/docs/EventsPassesAttributesApi.md +6 -6
- package/docs/EventsPassesFollowupsApi.md +8 -8
- package/docs/EventsPassesResponsesApi.md +10 -10
- package/docs/EventsPasstypesApi.md +34 -34
- package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
- package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
- package/docs/EventsPasstypesTranslationsApi.md +8 -8
- package/docs/EventsQuestionsApi.md +44 -44
- package/docs/EventsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsRoomsApi.md +18 -18
- package/docs/EventsRoomtypesApi.md +24 -24
- package/docs/EventsRoomtypesTranslationsApi.md +8 -8
- package/docs/EventsSectionsApi.md +38 -38
- package/docs/EventsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsAccessesApi.md +6 -6
- package/docs/EventsSessionsApi.md +70 -70
- package/docs/EventsSessionsLocationsApi.md +16 -16
- package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
- package/docs/EventsSessionsMatchesApi.md +32 -32
- package/docs/EventsSessionsPricesApi.md +6 -6
- package/docs/EventsSessionsQuestionsApi.md +38 -38
- package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
- package/docs/EventsSessionsSectionsApi.md +20 -20
- package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
- package/docs/EventsSessionsTimesApi.md +16 -16
- package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
- package/docs/EventsSessionsTranslationsApi.md +8 -8
- package/docs/EventsSpeakersApi.md +16 -16
- package/docs/EventsSpeakersTranslationsApi.md +8 -8
- package/docs/EventsSponsorsApi.md +8 -8
- package/docs/EventsSponsorshiplevelsApi.md +12 -12
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
- package/docs/EventsSponsorshipsApi.md +12 -12
- package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
- package/docs/EventsTemplatesApi.md +2 -2
- package/docs/EventsTracksApi.md +22 -22
- package/docs/EventsTracksTranslationsApi.md +8 -8
- package/docs/EventsTransfersApi.md +4 -4
- package/docs/EventsTranslationsApi.md +8 -8
- package/docs/FilesApi.md +4 -4
- package/docs/GroupsApi.md +12 -12
- package/docs/GroupsEventsApi.md +6 -6
- package/docs/GroupsInterestsApi.md +6 -6
- package/docs/GroupsInvitationsApi.md +12 -12
- package/docs/GroupsMembersApi.md +8 -8
- package/docs/GroupsModeratorsApi.md +6 -6
- package/docs/GroupsRequestsApi.md +10 -10
- package/docs/GroupsSponsorsApi.md +6 -6
- package/docs/GroupsTranslationsApi.md +8 -8
- package/docs/ImportsApi.md +8 -8
- package/docs/InterestsApi.md +22 -22
- package/docs/InvoicesApi.md +20 -20
- package/docs/InvoicesLineitemsApi.md +6 -6
- package/docs/LoginsAccountsApi.md +6 -6
- package/docs/LoginsApi.md +16 -16
- package/docs/MeetingsApi.md +14 -14
- package/docs/MeetingsLinksApi.md +10 -10
- package/docs/MeetingsLivestreamsApi.md +12 -12
- package/docs/MeetingsParticipantsApi.md +12 -12
- package/docs/MeetingsPresetsApi.md +10 -10
- package/docs/MeetingsRecordingsApi.md +4 -4
- package/docs/MeetingsSessionsApi.md +16 -16
- package/docs/NotificationsApi.md +8 -8
- package/docs/OrganizationApi.md +18 -18
- package/docs/OrganizationAttributesApi.md +14 -14
- package/docs/OrganizationDomainsApi.md +6 -6
- package/docs/OrganizationIntegrationsApi.md +10 -10
- package/docs/OrganizationModulesApi.md +6 -6
- package/docs/OrganizationModulesCustomApi.md +10 -10
- package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
- package/docs/OrganizationModulesSettingsApi.md +4 -4
- package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
- package/docs/OrganizationModulesTiersApi.md +12 -12
- package/docs/OrganizationPaymentsApi.md +20 -20
- package/docs/OrganizationSideeffectsApi.md +8 -8
- package/docs/OrganizationTaxApi.md +22 -22
- package/docs/OrganizationTeammembersApi.md +10 -10
- package/docs/OrganizationUsersApi.md +6 -6
- package/docs/OrganizationWebhooksApi.md +12 -12
- package/docs/PaymentsApi.md +2 -2
- package/docs/PreferencesApi.md +4 -4
- package/docs/PushDevicesApi.md +6 -6
- package/docs/ReportsApi.md +22 -22
- package/docs/ReportsUsersApi.md +6 -6
- package/docs/SearchlistsApi.md +10 -10
- package/docs/SearchlistsValuesApi.md +14 -14
- package/docs/SelfApi.md +10 -10
- package/docs/SelfApikeysApi.md +8 -8
- package/docs/SelfImagesApi.md +4 -4
- package/docs/SeriesApi.md +18 -18
- package/docs/SeriesQuestionsApi.md +14 -14
- package/docs/SeriesQuestionsChoicesApi.md +8 -8
- package/docs/SeriesQuestionsTranslationsApi.md +4 -4
- package/docs/SeriesRegistrationsApi.md +18 -18
- package/docs/SeriesTranslationsApi.md +8 -8
- package/docs/SponsorsAccountsApi.md +6 -6
- package/docs/SponsorsApi.md +10 -10
- package/docs/SponsorsTranslationsApi.md +8 -8
- package/docs/StorageFilesApi.md +6 -6
- package/docs/StorageImagesApi.md +18 -18
- package/docs/StorageVideosApi.md +14 -14
- package/docs/StorageVideosCaptionsApi.md +10 -10
- package/docs/StreamsApi.md +14 -14
- package/docs/StreamsOutputsApi.md +10 -10
- package/docs/StreamsSessionsApi.md +12 -12
- package/docs/SupportApi.md +14 -14
- package/docs/SupportMessagesApi.md +4 -4
- package/docs/SupportNotesApi.md +6 -6
- package/docs/SurveysApi.md +12 -12
- package/docs/SurveysQuestionsApi.md +38 -38
- package/docs/SurveysQuestionsTranslationsApi.md +16 -16
- package/docs/SurveysSectionsApi.md +20 -20
- package/docs/SurveysSectionsTranslationsApi.md +8 -8
- package/docs/SurveysSessionsApi.md +4 -4
- package/docs/SurveysSubmissionsApi.md +14 -14
- package/docs/SurveysTranslationsApi.md +8 -8
- package/docs/ThreadsAccountsApi.md +8 -8
- package/docs/ThreadsApi.md +10 -10
- package/docs/ThreadsMessagesApi.md +12 -12
- package/docs/ThreadsMessagesFilesApi.md +6 -6
- package/docs/ThreadsMessagesImagesApi.md +6 -6
- package/docs/ThreadsMessagesReactionsApi.md +6 -6
- package/docs/ThreadsMessagesVideosApi.md +6 -6
- package/docs/ThreadsStorageApi.md +6 -6
- package/docs/TiersApi.md +20 -20
- package/package.json +1 -1
|
@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**deleteVideoCaption**](#deletevideocaption) | **DELETE** /videos/{videoId}/captions/{language} | Delete
|
|
8
|
-
|[**downloadVideoCaption**](#downloadvideocaption) | **GET** /videos/{videoId}/captions/{language}/download | Download
|
|
9
|
-
|[**generateVideoCaptions**](#generatevideocaptions) | **POST** /videos/{videoId}/captions/{language}/generate |
|
|
10
|
-
|[**getVideoCaptions**](#getvideocaptions) | **GET** /videos/{videoId}/captions |
|
|
11
|
-
|[**uploadVideoCaptions**](#uploadvideocaptions) | **PUT** /videos/{videoId}/captions/{language} | Upload
|
|
7
|
+
|[**deleteVideoCaption**](#deletevideocaption) | **DELETE** /videos/{videoId}/captions/{language} | Delete a video\'s caption track|
|
|
8
|
+
|[**downloadVideoCaption**](#downloadvideocaption) | **GET** /videos/{videoId}/captions/{language}/download | Download a video\'s caption file|
|
|
9
|
+
|[**generateVideoCaptions**](#generatevideocaptions) | **POST** /videos/{videoId}/captions/{language}/generate | Auto-generate captions for a video|
|
|
10
|
+
|[**getVideoCaptions**](#getvideocaptions) | **GET** /videos/{videoId}/captions | List a video\'s captions|
|
|
11
|
+
|[**uploadVideoCaptions**](#uploadvideocaptions) | **PUT** /videos/{videoId}/captions/{language} | Upload a caption file for a video|
|
|
12
12
|
|
|
13
13
|
# **deleteVideoCaption**
|
|
14
14
|
> CreateAccountInvitations200Response deleteVideoCaption()
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Deletes the caption track for the given language from a video on Cloudflare Stream; requires the update and read permissions on the storage module.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.deleteVideoCaption(
|
|
|
67
67
|
# **downloadVideoCaption**
|
|
68
68
|
> SyncAccounts200Response downloadVideoCaption()
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
Fetches the caption track for the given language as a WebVTT (.vtt) file for a video; requires the read permission on the storage module.
|
|
71
71
|
|
|
72
72
|
### Example
|
|
73
73
|
|
|
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.downloadVideoCaption(
|
|
|
121
121
|
# **generateVideoCaptions**
|
|
122
122
|
> UploadVideoCaptions200Response generateVideoCaptions()
|
|
123
123
|
|
|
124
|
-
|
|
124
|
+
Triggers AI speech-to-text caption generation for a video in the given BCP 47 language (one of cs, nl, en, fr, de, it, ja, ko, pl, pt, ru, es); requires the update and read permissions on the storage module.
|
|
125
125
|
|
|
126
126
|
### Example
|
|
127
127
|
|
|
@@ -175,7 +175,7 @@ const { status, data } = await apiInstance.generateVideoCaptions(
|
|
|
175
175
|
# **getVideoCaptions**
|
|
176
176
|
> GetVideoCaptions200Response getVideoCaptions()
|
|
177
177
|
|
|
178
|
-
|
|
178
|
+
Returns a paginated list of caption/subtitle tracks uploaded or generated for the given video, with support for search and ordering; requires \"read\" permission on \"storage\".
|
|
179
179
|
|
|
180
180
|
### Example
|
|
181
181
|
|
|
@@ -238,7 +238,7 @@ const { status, data } = await apiInstance.getVideoCaptions(
|
|
|
238
238
|
# **uploadVideoCaptions**
|
|
239
239
|
> UploadVideoCaptions200Response uploadVideoCaptions()
|
|
240
240
|
|
|
241
|
-
|
|
241
|
+
Uploads a WebVTT caption file (as base64 or a data URI) for a video in the given language, creating or replacing the caption track on Cloudflare Stream; requires the update and read permissions on the storage module.
|
|
242
242
|
|
|
243
243
|
### Example
|
|
244
244
|
|
package/docs/StreamsApi.md
CHANGED
|
@@ -4,18 +4,18 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createStreamInput**](#createstreaminput) | **POST** /streams | Create
|
|
8
|
-
|[**deleteStreamInput**](#deletestreaminput) | **DELETE** /streams/{streamId} | Delete
|
|
9
|
-
|[**getStreamInput**](#getstreaminput) | **GET** /streams/{streamId} | Get
|
|
10
|
-
|[**getStreamInputs**](#getstreaminputs) | **GET** /streams |
|
|
11
|
-
|[**getStreamVideos**](#getstreamvideos) | **GET** /streams/{streamId}/videos |
|
|
12
|
-
|[**updateStream**](#updatestream) | **PUT** /streams/{streamId} | Update
|
|
13
|
-
|[**updateStreamInputConfig**](#updatestreaminputconfig) | **PUT** /streams/{streamId}/config | Update
|
|
7
|
+
|[**createStreamInput**](#createstreaminput) | **POST** /streams | Create a stream input|
|
|
8
|
+
|[**deleteStreamInput**](#deletestreaminput) | **DELETE** /streams/{streamId} | Delete a stream input|
|
|
9
|
+
|[**getStreamInput**](#getstreaminput) | **GET** /streams/{streamId} | Get a single stream input|
|
|
10
|
+
|[**getStreamInputs**](#getstreaminputs) | **GET** /streams | List an organization\'s stream inputs|
|
|
11
|
+
|[**getStreamVideos**](#getstreamvideos) | **GET** /streams/{streamId}/videos | List a stream\'s recorded videos|
|
|
12
|
+
|[**updateStream**](#updatestream) | **PUT** /streams/{streamId} | Update a stream input\'s settings|
|
|
13
|
+
|[**updateStreamInputConfig**](#updatestreaminputconfig) | **PUT** /streams/{streamId}/config | Update a stream input\'s recording configuration|
|
|
14
14
|
|
|
15
15
|
# **createStreamInput**
|
|
16
16
|
> CreateStreamInput200Response createStreamInput(streamInputCreateInputs)
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
Creates a new stream input record and a matching Cloudflare Stream live input configured for automatic recording, returning the input\'s connection details (RTMP/SRT/WebRTC URLs and keys); requires the read and create permissions on streams.
|
|
19
19
|
|
|
20
20
|
### Example
|
|
21
21
|
|
|
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.createStreamInput(
|
|
|
67
67
|
# **deleteStreamInput**
|
|
68
68
|
> CreateAccountInvitations200Response deleteStreamInput()
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
71
71
|
|
|
72
72
|
### Example
|
|
73
73
|
|
|
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.deleteStreamInput(
|
|
|
118
118
|
# **getStreamInput**
|
|
119
119
|
> CreateStreamInput200Response getStreamInput()
|
|
120
120
|
|
|
121
|
-
|
|
121
|
+
Returns details for a single stream input by ID, including its configuration for ingesting a live broadcast; requires read permission on streams.
|
|
122
122
|
|
|
123
123
|
### Example
|
|
124
124
|
|
|
@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.getStreamInput(
|
|
|
169
169
|
# **getStreamInputs**
|
|
170
170
|
> GetStreamInputs200Response getStreamInputs()
|
|
171
171
|
|
|
172
|
-
|
|
172
|
+
Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, and by free-text search; requires read permission on streams.
|
|
173
173
|
|
|
174
174
|
### Example
|
|
175
175
|
|
|
@@ -241,7 +241,7 @@ const { status, data } = await apiInstance.getStreamInputs(
|
|
|
241
241
|
# **getStreamVideos**
|
|
242
242
|
> GetStreamVideos200Response getStreamVideos()
|
|
243
243
|
|
|
244
|
-
|
|
244
|
+
Returns a paginated list of recorded videos associated with the given stream, with optional search and ordering, and requires \"read\" permission on both streams and storage.
|
|
245
245
|
|
|
246
246
|
### Example
|
|
247
247
|
|
|
@@ -304,7 +304,7 @@ const { status, data } = await apiInstance.getStreamVideos(
|
|
|
304
304
|
# **updateStream**
|
|
305
305
|
> CreateStreamInput200Response updateStream()
|
|
306
306
|
|
|
307
|
-
|
|
307
|
+
Updates the configurable fields (e.g. name, associated event/session/group, image) of an existing stream input (streamId); requires the read and update permissions on streams.
|
|
308
308
|
|
|
309
309
|
### Example
|
|
310
310
|
|
|
@@ -359,7 +359,7 @@ const { status, data } = await apiInstance.updateStream(
|
|
|
359
359
|
# **updateStreamInputConfig**
|
|
360
360
|
> CreateStreamInput200Response updateStreamInputConfig(streamInputUpdateInputs)
|
|
361
361
|
|
|
362
|
-
|
|
362
|
+
Updates Cloudflare recording settings (mode, signed URL requirement, recording retention days) for the given stream input (streamId); requires the update permission on streams. Note: the corresponding backend route has been removed, so this endpoint is currently non-functional.
|
|
363
363
|
|
|
364
364
|
### Example
|
|
365
365
|
|
|
@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createStreamInputOutput**](#createstreaminputoutput) | **POST** /streams/{streamId}/outputs |
|
|
8
|
-
|[**deleteStreamInputOutput**](#deletestreaminputoutput) | **DELETE** /streams/{streamId}/outputs/{outputId} | Delete
|
|
9
|
-
|[**getStreamInputOutput**](#getstreaminputoutput) | **GET** /streams/{streamId}/outputs/{output} | Get
|
|
10
|
-
|[**getStreamInputOutputs**](#getstreaminputoutputs) | **GET** /streams/{streamId}/outputs |
|
|
11
|
-
|[**updateStreamInputOutput**](#updatestreaminputoutput) | **PUT** /streams/{streamId}/outputs/{outputId} |
|
|
7
|
+
|[**createStreamInputOutput**](#createstreaminputoutput) | **POST** /streams/{streamId}/outputs | Add a restream output to a stream input|
|
|
8
|
+
|[**deleteStreamInputOutput**](#deletestreaminputoutput) | **DELETE** /streams/{streamId}/outputs/{outputId} | Delete a stream input\'s restream output|
|
|
9
|
+
|[**getStreamInputOutput**](#getstreaminputoutput) | **GET** /streams/{streamId}/outputs/{output} | Get a stream\'s output destination|
|
|
10
|
+
|[**getStreamInputOutputs**](#getstreaminputoutputs) | **GET** /streams/{streamId}/outputs | List a stream\'s output destinations|
|
|
11
|
+
|[**updateStreamInputOutput**](#updatestreaminputoutput) | **PUT** /streams/{streamId}/outputs/{outputId} | Enable or disable a stream output|
|
|
12
12
|
|
|
13
13
|
# **createStreamInputOutput**
|
|
14
14
|
> CreateStreamInputOutput200Response createStreamInputOutput(streamInputOutputCreateInputs)
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Creates a new output (e.g. an RTMP restream destination) on the Cloudflare live input for the given streamId, forwarding the live feed to an external URL and stream key; requires the read and create permissions on streams.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createStreamInputOutput(
|
|
|
68
68
|
# **deleteStreamInputOutput**
|
|
69
69
|
> CreateAccountInvitations200Response deleteStreamInputOutput()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Permanently removes the specified output (outputId) from the Cloudflare live input of the given stream (streamId), stopping that restream destination; requires the read and update permissions on streams.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.deleteStreamInputOutput(
|
|
|
122
122
|
# **getStreamInputOutput**
|
|
123
123
|
> CreateStreamInputOutput200Response getStreamInputOutput()
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Returns details for a single restream output (e.g. a third-party RTMP destination) configured on the given stream input; requires read permission on streams.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.getStreamInputOutput(
|
|
|
176
176
|
# **getStreamInputOutputs**
|
|
177
177
|
> GetStreamInputOutputs200Response getStreamInputOutputs()
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Returns the list of restream output destinations (e.g. third-party RTMP targets) configured for the given stream input; requires read permission on streams.
|
|
180
180
|
|
|
181
181
|
### Example
|
|
182
182
|
|
|
@@ -239,7 +239,7 @@ const { status, data } = await apiInstance.getStreamInputOutputs(
|
|
|
239
239
|
# **updateStreamInputOutput**
|
|
240
240
|
> CreateStreamInputOutput200Response updateStreamInputOutput()
|
|
241
241
|
|
|
242
|
-
|
|
242
|
+
Toggles the enabled state of the specified restream output (outputId) on a stream input\'s Cloudflare live input, starting or stopping that restream destination; requires the read and update permissions on streams.
|
|
243
243
|
|
|
244
244
|
### Example
|
|
245
245
|
|
|
@@ -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
|
-
|[**closeStreamSession**](#closestreamsession) | **PUT** /streams/{streamId}/sessions/{sessionId}/close | Close
|
|
8
|
-
|[**exportStreamSession**](#exportstreamsession) | **POST** /streams/{streamId}/sessions/{sessionId}/export |
|
|
9
|
-
|[**getStreamSession**](#getstreamsession) | **GET** /streams/{streamId}/sessions/{sessionId} | Get
|
|
10
|
-
|[**getStreamSessionChat**](#getstreamsessionchat) | **GET** /streams/{streamId}/sessions/{sessionId}/chat |
|
|
11
|
-
|[**getStreamSessionSubscriptions**](#getstreamsessionsubscriptions) | **GET** /streams/{streamId}/sessions/{sessionId}/subscriptions |
|
|
12
|
-
|[**getStreamSessions**](#getstreamsessions) | **GET** /streams/{streamId}/sessions |
|
|
7
|
+
|[**closeStreamSession**](#closestreamsession) | **PUT** /streams/{streamId}/sessions/{sessionId}/close | Close an active stream session|
|
|
8
|
+
|[**exportStreamSession**](#exportstreamsession) | **POST** /streams/{streamId}/sessions/{sessionId}/export | Request an export of a stream session|
|
|
9
|
+
|[**getStreamSession**](#getstreamsession) | **GET** /streams/{streamId}/sessions/{sessionId} | Get a single stream session|
|
|
10
|
+
|[**getStreamSessionChat**](#getstreamsessionchat) | **GET** /streams/{streamId}/sessions/{sessionId}/chat | List a stream session\'s chat messages|
|
|
11
|
+
|[**getStreamSessionSubscriptions**](#getstreamsessionsubscriptions) | **GET** /streams/{streamId}/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections|
|
|
12
|
+
|[**getStreamSessions**](#getstreamsessions) | **GET** /streams/{streamId}/sessions | List a stream\'s broadcast sessions|
|
|
13
13
|
|
|
14
14
|
# **closeStreamSession**
|
|
15
15
|
> CreateAccountInvitations200Response closeStreamSession()
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Ends the specified live session (sessionId) on a stream input, disconnecting all viewer subscriptions and marking the session as ended; requires the read and update permissions on streams.
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
|
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.closeStreamSession(
|
|
|
68
68
|
# **exportStreamSession**
|
|
69
69
|
> CreateAccountInvitations200Response exportStreamSession()
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
72
72
|
|
|
73
73
|
### Example
|
|
74
74
|
|
|
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.exportStreamSession(
|
|
|
122
122
|
# **getStreamSession**
|
|
123
123
|
> GetStreamSession200Response getStreamSession()
|
|
124
124
|
|
|
125
|
-
|
|
125
|
+
Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
126
126
|
|
|
127
127
|
### Example
|
|
128
128
|
|
|
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.getStreamSession(
|
|
|
176
176
|
# **getStreamSessionChat**
|
|
177
177
|
> GetStreamSessionChat200Response getStreamSessionChat()
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
|
|
180
180
|
|
|
181
181
|
### Example
|
|
182
182
|
|
|
@@ -230,7 +230,7 @@ const { status, data } = await apiInstance.getStreamSessionChat(
|
|
|
230
230
|
# **getStreamSessionSubscriptions**
|
|
231
231
|
> GetStreamSessionSubscriptions200Response getStreamSessionSubscriptions()
|
|
232
232
|
|
|
233
|
-
|
|
233
|
+
Returns a paginated list of viewer WebSocket subscriptions for the given stream session, each with its connection details, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
234
234
|
|
|
235
235
|
### Example
|
|
236
236
|
|
|
@@ -299,7 +299,7 @@ const { status, data } = await apiInstance.getStreamSessionSubscriptions(
|
|
|
299
299
|
# **getStreamSessions**
|
|
300
300
|
> GetStreamSessions200Response getStreamSessions()
|
|
301
301
|
|
|
302
|
-
|
|
302
|
+
Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
303
303
|
|
|
304
304
|
### Example
|
|
305
305
|
|
package/docs/SupportApi.md
CHANGED
|
@@ -4,18 +4,18 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createSupportTicket**](#createsupportticket) | **POST** /supportTickets | Create
|
|
8
|
-
|[**deleteSupportTicket**](#deletesupportticket) | **DELETE** /supportTickets/{supportTicketId} | Delete
|
|
9
|
-
|[**getSupportTicket**](#getsupportticket) | **GET** /supportTickets/{supportTicketId} | Get
|
|
10
|
-
|[**getSupportTicketActivity**](#getsupportticketactivity) | **GET** /supportTickets/{supportTicketId}/activityLog |
|
|
11
|
-
|[**getSupportTicketViewer**](#getsupportticketviewer) | **GET** /supportTickets/{supportTicketId}/viewer |
|
|
12
|
-
|[**getSupportTickets**](#getsupporttickets) | **GET** /supportTickets |
|
|
13
|
-
|[**updateSupportTicket**](#updatesupportticket) | **PUT** /supportTickets/{supportTicketId} | Update
|
|
7
|
+
|[**createSupportTicket**](#createsupportticket) | **POST** /supportTickets | Create a support ticket|
|
|
8
|
+
|[**deleteSupportTicket**](#deletesupportticket) | **DELETE** /supportTickets/{supportTicketId} | Delete a support ticket|
|
|
9
|
+
|[**getSupportTicket**](#getsupportticket) | **GET** /supportTickets/{supportTicketId} | Get a support ticket|
|
|
10
|
+
|[**getSupportTicketActivity**](#getsupportticketactivity) | **GET** /supportTickets/{supportTicketId}/activityLog | List a support ticket\'s activity log|
|
|
11
|
+
|[**getSupportTicketViewer**](#getsupportticketviewer) | **GET** /supportTickets/{supportTicketId}/viewer | List a support ticket\'s viewer/read records|
|
|
12
|
+
|[**getSupportTickets**](#getsupporttickets) | **GET** /supportTickets | List support tickets|
|
|
13
|
+
|[**updateSupportTicket**](#updatesupportticket) | **PUT** /supportTickets/{supportTicketId} | Update a support ticket|
|
|
14
14
|
|
|
15
15
|
# **createSupportTicket**
|
|
16
16
|
> CreateSupportTicket200Response createSupportTicket(supportTicketCreateInputs)
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
Creates a new support ticket for the organization, optionally associating it with an account; requires \"create\" permission on support.
|
|
19
19
|
|
|
20
20
|
### Example
|
|
21
21
|
|
|
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.createSupportTicket(
|
|
|
67
67
|
# **deleteSupportTicket**
|
|
68
68
|
> CreateAccountInvitations200Response deleteSupportTicket()
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
Permanently deletes the specified support ticket and its associated data; requires \"del\" permission on support.
|
|
71
71
|
|
|
72
72
|
### Example
|
|
73
73
|
|
|
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.deleteSupportTicket(
|
|
|
118
118
|
# **getSupportTicket**
|
|
119
119
|
> CreateSupportTicket200Response getSupportTicket()
|
|
120
120
|
|
|
121
|
-
|
|
121
|
+
Returns the full details of a single support ticket, including its event, activity logs, and current viewer/read state, requiring \"read\" permission on support.
|
|
122
122
|
|
|
123
123
|
### Example
|
|
124
124
|
|
|
@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.getSupportTicket(
|
|
|
169
169
|
# **getSupportTicketActivity**
|
|
170
170
|
> GetSupportTicketActivity200Response getSupportTicketActivity()
|
|
171
171
|
|
|
172
|
-
|
|
172
|
+
Returns the full activity log for the given support ticket (e.g. status changes and assignment events), ordered as specified, and requires \"read\" permission on support.
|
|
173
173
|
|
|
174
174
|
### Example
|
|
175
175
|
|
|
@@ -220,7 +220,7 @@ const { status, data } = await apiInstance.getSupportTicketActivity(
|
|
|
220
220
|
# **getSupportTicketViewer**
|
|
221
221
|
> GetSupportTicketViewer200Response getSupportTicketViewer()
|
|
222
222
|
|
|
223
|
-
|
|
223
|
+
Returns a paginated list of viewer records for the given support ticket, showing which org members have seen it and their last-read timestamp, optionally filtered to a single orgMembershipId, requiring \"read\" permission on support.
|
|
224
224
|
|
|
225
225
|
### Example
|
|
226
226
|
|
|
@@ -286,7 +286,7 @@ const { status, data } = await apiInstance.getSupportTicketViewer(
|
|
|
286
286
|
# **getSupportTickets**
|
|
287
287
|
> GetAccountSupportTickets200Response getSupportTickets()
|
|
288
288
|
|
|
289
|
-
|
|
289
|
+
Returns a paginated list of support tickets for the organization, filterable by type, state, and assignment (\"me\" or \"unassigned\" relative to the current admin), with optional search and ordering, requiring \"read\" permission on support.
|
|
290
290
|
|
|
291
291
|
### Example
|
|
292
292
|
|
|
@@ -355,7 +355,7 @@ const { status, data } = await apiInstance.getSupportTickets(
|
|
|
355
355
|
# **updateSupportTicket**
|
|
356
356
|
> CreateSupportTicket200Response updateSupportTicket(supportTicketUpdateInputs)
|
|
357
357
|
|
|
358
|
-
|
|
358
|
+
Updates fields on an existing support ticket, such as its state, type, or assignment; requires \"update\" permission on support.
|
|
359
359
|
|
|
360
360
|
### Example
|
|
361
361
|
|
|
@@ -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
|
-
|[**createSupportTicketMessage**](#createsupportticketmessage) | **POST** /supportTickets/{supportTicketId}/messages |
|
|
8
|
-
|[**getSupportTicketMessages**](#getsupportticketmessages) | **GET** /supportTickets/{supportTicketId}/messages |
|
|
7
|
+
|[**createSupportTicketMessage**](#createsupportticketmessage) | **POST** /supportTickets/{supportTicketId}/messages | Send a support ticket message|
|
|
8
|
+
|[**getSupportTicketMessages**](#getsupportticketmessages) | **GET** /supportTickets/{supportTicketId}/messages | List a support ticket\'s messages|
|
|
9
9
|
|
|
10
10
|
# **createSupportTicketMessage**
|
|
11
11
|
> CreateSupportTicketMessage200Response createSupportTicketMessage(supportTicketMessageCreateInputs)
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Posts a new message on the given support ticket\'s conversation thread, updating the ticket\'s last-message timestamp; requires \"update\" permission on support.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createSupportTicketMessage(
|
|
|
65
65
|
# **getSupportTicketMessages**
|
|
66
66
|
> GetSupportTicketMessages200Response getSupportTicketMessages()
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
Returns a paginated list of messages exchanged on the given support ticket, with optional search and ordering, requiring \"read\" permission on support.
|
|
69
69
|
|
|
70
70
|
### Example
|
|
71
71
|
|
package/docs/SupportNotesApi.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
|
-
|[**createSupportTicketNote**](#createsupportticketnote) | **POST** /supportTickets/{supportTicketId}/notes |
|
|
8
|
-
|[**deleteSupportTicketNote**](#deletesupportticketnote) | **DELETE** /supportTickets/{supportTicketId}/notes/{noteId} | Delete
|
|
9
|
-
|[**getSupportTicketNotes**](#getsupportticketnotes) | **GET** /supportTickets/{supportTicketId}/notes |
|
|
7
|
+
|[**createSupportTicketNote**](#createsupportticketnote) | **POST** /supportTickets/{supportTicketId}/notes | Add an internal note to a support ticket|
|
|
8
|
+
|[**deleteSupportTicketNote**](#deletesupportticketnote) | **DELETE** /supportTickets/{supportTicketId}/notes/{noteId} | Delete a support ticket\'s internal note|
|
|
9
|
+
|[**getSupportTicketNotes**](#getsupportticketnotes) | **GET** /supportTickets/{supportTicketId}/notes | List a support ticket\'s internal notes|
|
|
10
10
|
|
|
11
11
|
# **createSupportTicketNote**
|
|
12
12
|
> CreateSupportTicket200Response createSupportTicketNote(supportTicketNoteCreateInputs)
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Adds an admin-only internal note to the specified support ticket, recording the authoring admin; requires \"update\" permission on support.
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.createSupportTicketNote(
|
|
|
66
66
|
# **deleteSupportTicketNote**
|
|
67
67
|
> CreateAccountInvitations200Response deleteSupportTicketNote()
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
Permanently removes an internal note from the specified support ticket; requires \"update\" permission on support.
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
|
|
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.deleteSupportTicketNote(
|
|
|
120
120
|
# **getSupportTicketNotes**
|
|
121
121
|
> GetSupportTicketNotes200Response getSupportTicketNotes()
|
|
122
122
|
|
|
123
|
-
|
|
123
|
+
Returns a paginated list of internal notes added to the given support ticket by admin staff, with optional search and ordering, requiring \"read\" permission on support.
|
|
124
124
|
|
|
125
125
|
### Example
|
|
126
126
|
|
package/docs/SurveysApi.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
|
-
|[**createSurvey**](#createsurvey) | **POST** /surveys | Create
|
|
8
|
-
|[**deleteSurvey**](#deletesurvey) | **DELETE** /surveys/{surveyId} | Delete
|
|
9
|
-
|[**getSurvey**](#getsurvey) | **GET** /surveys/{surveyId} | Get
|
|
10
|
-
|[**getSurveySessions**](#getsurveysessions) | **GET** /surveys/{surveyId}/sessions |
|
|
11
|
-
|[**getSurveys**](#getsurveys) | **GET** /surveys |
|
|
12
|
-
|[**updateSurvey**](#updatesurvey) | **PUT** /surveys/{surveyId} | Update
|
|
7
|
+
|[**createSurvey**](#createsurvey) | **POST** /surveys | Create a survey|
|
|
8
|
+
|[**deleteSurvey**](#deletesurvey) | **DELETE** /surveys/{surveyId} | Delete a survey|
|
|
9
|
+
|[**getSurvey**](#getsurvey) | **GET** /surveys/{surveyId} | Get a survey|
|
|
10
|
+
|[**getSurveySessions**](#getsurveysessions) | **GET** /surveys/{surveyId}/sessions | List a survey\'s linked event sessions|
|
|
11
|
+
|[**getSurveys**](#getsurveys) | **GET** /surveys | List surveys|
|
|
12
|
+
|[**updateSurvey**](#updatesurvey) | **PUT** /surveys/{surveyId} | Update a survey|
|
|
13
13
|
|
|
14
14
|
# **createSurvey**
|
|
15
15
|
> CreateSurvey200Response createSurvey(surveyCreateInputs)
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Creates a new survey for the organization, optionally attaching it to an event (and, in turn, an event activation); requires the create surveys permission.
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
|
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.createSurvey(
|
|
|
66
66
|
# **deleteSurvey**
|
|
67
67
|
> CreateAccountInvitations200Response deleteSurvey()
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
Permanently deletes the survey identified by surveyId, including its sections, questions, and submissions; requires delete permission on surveys.
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
|
|
@@ -117,7 +117,7 @@ const { status, data } = await apiInstance.deleteSurvey(
|
|
|
117
117
|
# **getSurvey**
|
|
118
118
|
> CreateSurvey200Response getSurvey()
|
|
119
119
|
|
|
120
|
-
|
|
120
|
+
Retrieves a single survey by ID or slug, including its configuration and metadata, requiring read permission on surveys.
|
|
121
121
|
|
|
122
122
|
### Example
|
|
123
123
|
|
|
@@ -168,7 +168,7 @@ const { status, data } = await apiInstance.getSurvey(
|
|
|
168
168
|
# **getSurveySessions**
|
|
169
169
|
> GetEventActivationSessions200Response getSurveySessions()
|
|
170
170
|
|
|
171
|
-
|
|
171
|
+
Returns a paginated list of event sessions associated with the given survey, supporting search and ordering; requires read permission on surveys.
|
|
172
172
|
|
|
173
173
|
### Example
|
|
174
174
|
|
|
@@ -231,7 +231,7 @@ const { status, data } = await apiInstance.getSurveySessions(
|
|
|
231
231
|
# **getSurveys**
|
|
232
232
|
> GetSurveys200Response getSurveys()
|
|
233
233
|
|
|
234
|
-
|
|
234
|
+
Returns a paginated list of surveys for the organization, optionally filtered by event, session, or status, with search and ordering support, requiring read permission on surveys.
|
|
235
235
|
|
|
236
236
|
### Example
|
|
237
237
|
|
|
@@ -300,7 +300,7 @@ const { status, data } = await apiInstance.getSurveys(
|
|
|
300
300
|
# **updateSurvey**
|
|
301
301
|
> CreateSurvey200Response updateSurvey(surveyUpdateInputs)
|
|
302
302
|
|
|
303
|
-
|
|
303
|
+
Updates the survey identified by surveyId, including its details and optional event/activation linkage, and returns the updated survey; requires update permission on surveys.
|
|
304
304
|
|
|
305
305
|
### Example
|
|
306
306
|
|