@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.
Files changed (201) hide show
  1. package/README.md +1212 -1212
  2. package/api.ts +9696 -9696
  3. package/dist/api.d.ts +9696 -9696
  4. package/dist/api.js +9696 -9696
  5. package/dist/esm/api.d.ts +9696 -9696
  6. package/dist/esm/api.js +9696 -9696
  7. package/docs/AccountsAddressesApi.md +10 -10
  8. package/docs/AccountsApi.md +42 -42
  9. package/docs/AccountsFollowersApi.md +6 -6
  10. package/docs/AccountsFollowingApi.md +6 -6
  11. package/docs/AccountsGroupsApi.md +6 -6
  12. package/docs/AccountsInterestsApi.md +6 -6
  13. package/docs/AccountsInvitationsApi.md +6 -6
  14. package/docs/AccountsLeadsApi.md +8 -8
  15. package/docs/AccountsTiersApi.md +8 -8
  16. package/docs/ActivitiesApi.md +18 -18
  17. package/docs/ActivitiesScheduleApi.md +4 -4
  18. package/docs/AdvertisementsApi.md +14 -14
  19. package/docs/AnnouncementsApi.md +16 -16
  20. package/docs/AnnouncementsScheduleApi.md +4 -4
  21. package/docs/AnnouncementsTranslationsApi.md +8 -8
  22. package/docs/ApiLogsApi.md +4 -4
  23. package/docs/AuthSessionsApi.md +4 -4
  24. package/docs/BenefitsApi.md +12 -12
  25. package/docs/BenefitsTranslationsApi.md +8 -8
  26. package/docs/BookingsApi.md +56 -56
  27. package/docs/BookingsAvailabilitiesApi.md +6 -6
  28. package/docs/BookingsBlackoutsApi.md +6 -6
  29. package/docs/BookingsPlacesApi.md +6 -6
  30. package/docs/BookingsPlacesTranslationsApi.md +4 -4
  31. package/docs/BookingsQuestionsApi.md +16 -16
  32. package/docs/BookingsQuestionsChoicesApi.md +12 -12
  33. package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
  34. package/docs/BookingsQuestionsTranslationsApi.md +8 -8
  35. package/docs/BookingsSpacesApi.md +6 -6
  36. package/docs/BookingsSpacesTranslationsApi.md +4 -4
  37. package/docs/ChannelsApi.md +58 -58
  38. package/docs/ChannelsTranslationsApi.md +24 -24
  39. package/docs/DashboardsApi.md +10 -10
  40. package/docs/DashboardsWidgetsApi.md +8 -8
  41. package/docs/EmailReceiptsApi.md +4 -4
  42. package/docs/EventsAccessApi.md +6 -6
  43. package/docs/EventsActivationsApi.md +22 -22
  44. package/docs/EventsActivationsSessionsApi.md +6 -6
  45. package/docs/EventsActivationsTranslationsApi.md +8 -8
  46. package/docs/EventsAddonsApi.md +24 -24
  47. package/docs/EventsAddonsTranslationsApi.md +8 -8
  48. package/docs/EventsApi.md +22 -22
  49. package/docs/EventsAttendeesApi.md +24 -24
  50. package/docs/EventsAttendeesPackagesApi.md +10 -10
  51. package/docs/EventsAttendeesReservationsApi.md +18 -18
  52. package/docs/EventsAttributesApi.md +10 -10
  53. package/docs/EventsBenefitsApi.md +4 -4
  54. package/docs/EventsBlocksApi.md +16 -16
  55. package/docs/EventsBypassApi.md +10 -10
  56. package/docs/EventsCohostsApi.md +6 -6
  57. package/docs/EventsCouponsApi.md +28 -28
  58. package/docs/EventsEmailsApi.md +4 -4
  59. package/docs/EventsEmailsTranslationsApi.md +8 -8
  60. package/docs/EventsFaqsApi.md +22 -22
  61. package/docs/EventsFaqsTranslationsApi.md +16 -16
  62. package/docs/EventsFollowupsApi.md +38 -38
  63. package/docs/EventsFollowupsTranslationsApi.md +8 -8
  64. package/docs/EventsMatchesApi.md +34 -34
  65. package/docs/EventsMediaApi.md +16 -16
  66. package/docs/EventsMediaTranslationsApi.md +8 -8
  67. package/docs/EventsOnSiteApi.md +6 -6
  68. package/docs/EventsPackagesApi.md +10 -10
  69. package/docs/EventsPackagesPassesApi.md +10 -10
  70. package/docs/EventsPackagesTranslationsApi.md +8 -8
  71. package/docs/EventsPagesApi.md +16 -16
  72. package/docs/EventsPagesTranslationsApi.md +8 -8
  73. package/docs/EventsPassesAccessesApi.md +10 -10
  74. package/docs/EventsPassesAddonsApi.md +6 -6
  75. package/docs/EventsPassesApi.md +34 -34
  76. package/docs/EventsPassesAttributesApi.md +6 -6
  77. package/docs/EventsPassesFollowupsApi.md +8 -8
  78. package/docs/EventsPassesResponsesApi.md +10 -10
  79. package/docs/EventsPasstypesApi.md +34 -34
  80. package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
  81. package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
  82. package/docs/EventsPasstypesTranslationsApi.md +8 -8
  83. package/docs/EventsQuestionsApi.md +44 -44
  84. package/docs/EventsQuestionsTranslationsApi.md +16 -16
  85. package/docs/EventsRoomsApi.md +18 -18
  86. package/docs/EventsRoomtypesApi.md +24 -24
  87. package/docs/EventsRoomtypesTranslationsApi.md +8 -8
  88. package/docs/EventsSectionsApi.md +38 -38
  89. package/docs/EventsSectionsTranslationsApi.md +8 -8
  90. package/docs/EventsSessionsAccessesApi.md +6 -6
  91. package/docs/EventsSessionsApi.md +70 -70
  92. package/docs/EventsSessionsLocationsApi.md +16 -16
  93. package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
  94. package/docs/EventsSessionsMatchesApi.md +32 -32
  95. package/docs/EventsSessionsPricesApi.md +6 -6
  96. package/docs/EventsSessionsQuestionsApi.md +38 -38
  97. package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
  98. package/docs/EventsSessionsSectionsApi.md +20 -20
  99. package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
  100. package/docs/EventsSessionsTimesApi.md +16 -16
  101. package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
  102. package/docs/EventsSessionsTranslationsApi.md +8 -8
  103. package/docs/EventsSpeakersApi.md +16 -16
  104. package/docs/EventsSpeakersTranslationsApi.md +8 -8
  105. package/docs/EventsSponsorsApi.md +8 -8
  106. package/docs/EventsSponsorshiplevelsApi.md +12 -12
  107. package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
  108. package/docs/EventsSponsorshipsApi.md +12 -12
  109. package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
  110. package/docs/EventsTemplatesApi.md +2 -2
  111. package/docs/EventsTracksApi.md +22 -22
  112. package/docs/EventsTracksTranslationsApi.md +8 -8
  113. package/docs/EventsTransfersApi.md +4 -4
  114. package/docs/EventsTranslationsApi.md +8 -8
  115. package/docs/FilesApi.md +4 -4
  116. package/docs/GroupsApi.md +12 -12
  117. package/docs/GroupsEventsApi.md +6 -6
  118. package/docs/GroupsInterestsApi.md +6 -6
  119. package/docs/GroupsInvitationsApi.md +12 -12
  120. package/docs/GroupsMembersApi.md +8 -8
  121. package/docs/GroupsModeratorsApi.md +6 -6
  122. package/docs/GroupsRequestsApi.md +10 -10
  123. package/docs/GroupsSponsorsApi.md +6 -6
  124. package/docs/GroupsTranslationsApi.md +8 -8
  125. package/docs/ImportsApi.md +8 -8
  126. package/docs/InterestsApi.md +22 -22
  127. package/docs/InvoicesApi.md +20 -20
  128. package/docs/InvoicesLineitemsApi.md +6 -6
  129. package/docs/LoginsAccountsApi.md +6 -6
  130. package/docs/LoginsApi.md +16 -16
  131. package/docs/MeetingsApi.md +14 -14
  132. package/docs/MeetingsLinksApi.md +10 -10
  133. package/docs/MeetingsLivestreamsApi.md +12 -12
  134. package/docs/MeetingsParticipantsApi.md +12 -12
  135. package/docs/MeetingsPresetsApi.md +10 -10
  136. package/docs/MeetingsRecordingsApi.md +4 -4
  137. package/docs/MeetingsSessionsApi.md +16 -16
  138. package/docs/NotificationsApi.md +8 -8
  139. package/docs/OrganizationApi.md +18 -18
  140. package/docs/OrganizationAttributesApi.md +14 -14
  141. package/docs/OrganizationDomainsApi.md +6 -6
  142. package/docs/OrganizationIntegrationsApi.md +10 -10
  143. package/docs/OrganizationModulesApi.md +6 -6
  144. package/docs/OrganizationModulesCustomApi.md +10 -10
  145. package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
  146. package/docs/OrganizationModulesSettingsApi.md +4 -4
  147. package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
  148. package/docs/OrganizationModulesTiersApi.md +12 -12
  149. package/docs/OrganizationPaymentsApi.md +20 -20
  150. package/docs/OrganizationSideeffectsApi.md +8 -8
  151. package/docs/OrganizationTaxApi.md +22 -22
  152. package/docs/OrganizationTeammembersApi.md +10 -10
  153. package/docs/OrganizationUsersApi.md +6 -6
  154. package/docs/OrganizationWebhooksApi.md +12 -12
  155. package/docs/PaymentsApi.md +2 -2
  156. package/docs/PreferencesApi.md +4 -4
  157. package/docs/PushDevicesApi.md +6 -6
  158. package/docs/ReportsApi.md +22 -22
  159. package/docs/ReportsUsersApi.md +6 -6
  160. package/docs/SearchlistsApi.md +10 -10
  161. package/docs/SearchlistsValuesApi.md +14 -14
  162. package/docs/SelfApi.md +10 -10
  163. package/docs/SelfApikeysApi.md +8 -8
  164. package/docs/SelfImagesApi.md +4 -4
  165. package/docs/SeriesApi.md +18 -18
  166. package/docs/SeriesQuestionsApi.md +14 -14
  167. package/docs/SeriesQuestionsChoicesApi.md +8 -8
  168. package/docs/SeriesQuestionsTranslationsApi.md +4 -4
  169. package/docs/SeriesRegistrationsApi.md +18 -18
  170. package/docs/SeriesTranslationsApi.md +8 -8
  171. package/docs/SponsorsAccountsApi.md +6 -6
  172. package/docs/SponsorsApi.md +10 -10
  173. package/docs/SponsorsTranslationsApi.md +8 -8
  174. package/docs/StorageFilesApi.md +6 -6
  175. package/docs/StorageImagesApi.md +18 -18
  176. package/docs/StorageVideosApi.md +14 -14
  177. package/docs/StorageVideosCaptionsApi.md +10 -10
  178. package/docs/StreamsApi.md +14 -14
  179. package/docs/StreamsOutputsApi.md +10 -10
  180. package/docs/StreamsSessionsApi.md +12 -12
  181. package/docs/SupportApi.md +14 -14
  182. package/docs/SupportMessagesApi.md +4 -4
  183. package/docs/SupportNotesApi.md +6 -6
  184. package/docs/SurveysApi.md +12 -12
  185. package/docs/SurveysQuestionsApi.md +38 -38
  186. package/docs/SurveysQuestionsTranslationsApi.md +16 -16
  187. package/docs/SurveysSectionsApi.md +20 -20
  188. package/docs/SurveysSectionsTranslationsApi.md +8 -8
  189. package/docs/SurveysSessionsApi.md +4 -4
  190. package/docs/SurveysSubmissionsApi.md +14 -14
  191. package/docs/SurveysTranslationsApi.md +8 -8
  192. package/docs/ThreadsAccountsApi.md +8 -8
  193. package/docs/ThreadsApi.md +10 -10
  194. package/docs/ThreadsMessagesApi.md +12 -12
  195. package/docs/ThreadsMessagesFilesApi.md +6 -6
  196. package/docs/ThreadsMessagesImagesApi.md +6 -6
  197. package/docs/ThreadsMessagesReactionsApi.md +6 -6
  198. package/docs/ThreadsMessagesVideosApi.md +6 -6
  199. package/docs/ThreadsStorageApi.md +6 -6
  200. package/docs/TiersApi.md +20 -20
  201. package/package.json +1 -1
@@ -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
- |[**addLoginAccount**](#addloginaccount) | **POST** /logins/{username}/accounts/{accountId} | Add Login Account|
8
- |[**getLoginAccounts**](#getloginaccounts) | **GET** /logins/{username}/accounts | Get Login Accounts|
9
- |[**removeLoginAccount**](#removeloginaccount) | **DELETE** /logins/{username}/accounts/{accountId} | Remove Login Account|
7
+ |[**addLoginAccount**](#addloginaccount) | **POST** /logins/{username}/accounts/{accountId} | Link an account to a login|
8
+ |[**getLoginAccounts**](#getloginaccounts) | **GET** /logins/{username}/accounts | List a login\'s linked accounts|
9
+ |[**removeLoginAccount**](#removeloginaccount) | **DELETE** /logins/{username}/accounts/{accountId} | Unlink an account from a login|
10
10
 
11
11
  # **addLoginAccount**
12
12
  > GetLogin200Response addLoginAccount()
13
13
 
14
- Add Login Account endpoint
14
+ Connects the specified account to the given login username so the login can access that account, and requires the \"update\" permission on accounts.
15
15
 
16
16
  ### Example
17
17
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addLoginAccount(
65
65
  # **getLoginAccounts**
66
66
  > GetAccounts200Response getLoginAccounts()
67
67
 
68
- Get Login Accounts endpoint
68
+ Returns a paginated list of accounts associated with the given login username, with optional search and ordering; requires the read permission on accounts.
69
69
 
70
70
  ### Example
71
71
 
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getLoginAccounts(
128
128
  # **removeLoginAccount**
129
129
  > GetLogin200Response removeLoginAccount()
130
130
 
131
- Remove Login Account endpoint
131
+ Disconnects the specified account from the given login username, revoking that login\'s access to the account, and requires the \"update\" permission on accounts.
132
132
 
133
133
  ### Example
134
134
 
package/docs/LoginsApi.md CHANGED
@@ -4,19 +4,19 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**confirmLogin**](#confirmlogin) | **PUT** /logins/{username}/confirm | Confirm Login|
8
- |[**deleteLogin**](#deletelogin) | **DELETE** /logins/{username} | Delete Login|
9
- |[**getLogin**](#getlogin) | **GET** /logins/{username} | Get Login|
10
- |[**getLoginAuthSessions**](#getloginauthsessions) | **GET** /logins/{username}/auth-sessions | Get Login Auth Sessions|
11
- |[**getLoginDevices**](#getlogindevices) | **GET** /logins/{username}/devices | Get Login Devices|
12
- |[**getLogins**](#getlogins) | **GET** /logins | Get Logins|
13
- |[**updateLoginEmail**](#updateloginemail) | **PUT** /logins/{username}/email | Update Login Email|
14
- |[**updateLoginPassword**](#updateloginpassword) | **PUT** /logins/{username}/password | Update Login Password|
7
+ |[**confirmLogin**](#confirmlogin) | **PUT** /logins/{username}/confirm | Confirm a login|
8
+ |[**deleteLogin**](#deletelogin) | **DELETE** /logins/{username} | Delete a login|
9
+ |[**getLogin**](#getlogin) | **GET** /logins/{username} | Get a single login|
10
+ |[**getLoginAuthSessions**](#getloginauthsessions) | **GET** /logins/{username}/auth-sessions | List a login\'s auth sessions|
11
+ |[**getLoginDevices**](#getlogindevices) | **GET** /logins/{username}/devices | List a login\'s push devices|
12
+ |[**getLogins**](#getlogins) | **GET** /logins | List logins|
13
+ |[**updateLoginEmail**](#updateloginemail) | **PUT** /logins/{username}/email | Update a login\'s email|
14
+ |[**updateLoginPassword**](#updateloginpassword) | **PUT** /logins/{username}/password | Set a login\'s password|
15
15
 
16
16
  # **confirmLogin**
17
17
  > GetLogin200Response confirmLogin()
18
18
 
19
- Confirm Login endpoint
19
+ Manually confirms the Cognito user for the given login username and marks its email as verified, bypassing the normal self-service confirmation flow, and requires the \"update\" permission on accounts.
20
20
 
21
21
  ### Example
22
22
 
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.confirmLogin(
67
67
  # **deleteLogin**
68
68
  > GetLogin200Response deleteLogin()
69
69
 
70
- Delete Login endpoint
70
+ Permanently deletes the login with the given username, removing both its Cognito user and its database record, and requires the \"delete\" permission on accounts.
71
71
 
72
72
  ### Example
73
73
 
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.deleteLogin(
118
118
  # **getLogin**
119
119
  > GetLogin200Response getLogin()
120
120
 
121
- Get Login endpoint
121
+ Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
122
122
 
123
123
  ### Example
124
124
 
@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.getLogin(
169
169
  # **getLoginAuthSessions**
170
170
  > GetLoginAuthSessions200Response getLoginAuthSessions()
171
171
 
172
- Get Login Auth Sessions endpoint
172
+ Returns a paginated list of authentication sessions for the given login username, with optional search and ordering; requires the read permission on accounts.
173
173
 
174
174
  ### Example
175
175
 
@@ -232,7 +232,7 @@ const { status, data } = await apiInstance.getLoginAuthSessions(
232
232
  # **getLoginDevices**
233
233
  > GetLoginDevices200Response getLoginDevices()
234
234
 
235
- Get Login Devices endpoint
235
+ Returns a paginated list of registered push notification devices for the given login username, with optional search and ordering; requires the read permission on accounts.
236
236
 
237
237
  ### Example
238
238
 
@@ -295,7 +295,7 @@ const { status, data } = await apiInstance.getLoginDevices(
295
295
  # **getLogins**
296
296
  > GetLogins200Response getLogins()
297
297
 
298
- Get Logins endpoint
298
+ Returns a paginated list of logins for the organization, optionally filtered by linked account and with search and ordering support; requires the read permission on accounts.
299
299
 
300
300
  ### Example
301
301
 
@@ -358,7 +358,7 @@ const { status, data } = await apiInstance.getLogins(
358
358
  # **updateLoginEmail**
359
359
  > GetLogin200Response updateLoginEmail()
360
360
 
361
- Update Login Email endpoint
361
+ Changes the email address for the given login username in both the database and Cognito, marking the new email as verified, and requires the \"update\" permission on accounts.
362
362
 
363
363
  ### Example
364
364
 
@@ -412,7 +412,7 @@ const { status, data } = await apiInstance.updateLoginEmail(
412
412
  # **updateLoginPassword**
413
413
  > GetLogin200Response updateLoginPassword()
414
414
 
415
- Update Login Password endpoint
415
+ Sets a permanent new password for the Cognito login identified by username, requiring both read and update permissions on accounts; existing logins and login/logins list caches are invalidated on success.
416
416
 
417
417
  ### Example
418
418
 
@@ -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
- |[**addMeetingLivestream**](#addmeetinglivestream) | **POST** /meetings/{meetingId}/livestream | Add Meeting Livestream|
8
- |[**createMeeting**](#createmeeting) | **POST** /meetings | Create Meeting|
9
- |[**getMeeting**](#getmeeting) | **GET** /meetings/{meetingId} | Get Meeting|
10
- |[**getMeetingLivestream**](#getmeetinglivestream) | **GET** /meetings/{meetingId}/livestream | Get Meeting Livestream|
11
- |[**getMeetings**](#getmeetings) | **GET** /meetings | Get Meetings|
12
- |[**joinMeeting**](#joinmeeting) | **GET** /meetings/{meetingId}/join | Join Meeting|
13
- |[**updateMeeting**](#updatemeeting) | **PUT** /meetings/{meetingId} | Update Meeting|
7
+ |[**addMeetingLivestream**](#addmeetinglivestream) | **POST** /meetings/{meetingId}/livestream | Add a livestream to a meeting|
8
+ |[**createMeeting**](#createmeeting) | **POST** /meetings | Create a meeting|
9
+ |[**getMeeting**](#getmeeting) | **GET** /meetings/{meetingId} | Get a meeting|
10
+ |[**getMeetingLivestream**](#getmeetinglivestream) | **GET** /meetings/{meetingId}/livestream | Get a meeting\'s livestream|
11
+ |[**getMeetings**](#getmeetings) | **GET** /meetings | List meetings|
12
+ |[**joinMeeting**](#joinmeeting) | **GET** /meetings/{meetingId}/join | Join a meeting as the current admin|
13
+ |[**updateMeeting**](#updatemeeting) | **PUT** /meetings/{meetingId} | Update a meeting|
14
14
 
15
15
  # **addMeetingLivestream**
16
16
  > GetLivestream200Response addMeetingLivestream()
17
17
 
18
- Add Meeting Livestream endpoint
18
+ Creates and attaches a new livestream to the given meeting so it can be broadcast, requiring the \"create\" permission on meetings.
19
19
 
20
20
  ### Example
21
21
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.addMeetingLivestream(
66
66
  # **createMeeting**
67
67
  > CreateMeeting200Response createMeeting(meetingCreateInputs)
68
68
 
69
- Create Meeting endpoint
69
+ Creates a new video meeting for the organization, optionally linked to an event, event session, group, activity, or booking space, and configured with recording, chat, livestream, and AI settings, requiring the \"create\" permission on meetings.
70
70
 
71
71
  ### Example
72
72
 
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.createMeeting(
118
118
  # **getMeeting**
119
119
  > CreateMeeting200Response getMeeting()
120
120
 
121
- Get Meeting endpoint
121
+ Returns the details of a single meeting by its ID, requires the \"read\" permission on meetings.
122
122
 
123
123
  ### Example
124
124
 
@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.getMeeting(
169
169
  # **getMeetingLivestream**
170
170
  > GetLivestream200Response getMeetingLivestream()
171
171
 
172
- Get Meeting Livestream endpoint
172
+ Returns the livestream configuration associated with the given meeting, requires the \"read\" permission on meetings.
173
173
 
174
174
  ### Example
175
175
 
@@ -220,7 +220,7 @@ const { status, data } = await apiInstance.getMeetingLivestream(
220
220
  # **getMeetings**
221
221
  > GetMeetings200Response getMeetings()
222
222
 
223
- Get Meetings endpoint
223
+ Returns a paginated list of meetings for the organization, supports search and requires the \"read\" permission on meetings.
224
224
 
225
225
  ### Example
226
226
 
@@ -280,7 +280,7 @@ const { status, data } = await apiInstance.getMeetings(
280
280
  # **joinMeeting**
281
281
  > ImpersonateAccount200Response joinMeeting()
282
282
 
283
- Join Meeting endpoint
283
+ Generates a join token for the authenticated admin user to enter the given meeting as a participant, requiring the \"read\" permission on meetings.
284
284
 
285
285
  ### Example
286
286
 
@@ -331,7 +331,7 @@ const { status, data } = await apiInstance.joinMeeting(
331
331
  # **updateMeeting**
332
332
  > CreateMeeting200Response updateMeeting(meetingUpdateInputs)
333
333
 
334
- Update Meeting endpoint
334
+ Updates the settings of an existing meeting, such as its title, recording, chat, livestream, or AI configuration, requiring the \"update\" permission on meetings.
335
335
 
336
336
  ### Example
337
337
 
@@ -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
- |[**createMeetingLink**](#createmeetinglink) | **POST** /meetings/{meetingId}/links | Create Meeting Link|
8
- |[**deleteMeetingLink**](#deletemeetinglink) | **DELETE** /meetings/{meetingId}/links/{linkId} | Delete Meeting Link|
9
- |[**getMeetingLink**](#getmeetinglink) | **GET** /meetings/{meetingId}/links/{linkId} | Get Meeting Link|
10
- |[**getMeetingLinks**](#getmeetinglinks) | **GET** /meetings/{meetingId}/links | Get Meeting Links|
11
- |[**updateMeetingLink**](#updatemeetinglink) | **PUT** /meetings/{meetingId}/links/{linkId} | Update Meeting Link|
7
+ |[**createMeetingLink**](#createmeetinglink) | **POST** /meetings/{meetingId}/links | Create a shareable meeting link|
8
+ |[**deleteMeetingLink**](#deletemeetinglink) | **DELETE** /meetings/{meetingId}/links/{linkId} | Delete a meeting link|
9
+ |[**getMeetingLink**](#getmeetinglink) | **GET** /meetings/{meetingId}/links/{linkId} | Get a single meeting link|
10
+ |[**getMeetingLinks**](#getmeetinglinks) | **GET** /meetings/{meetingId}/links | List a meeting\'s join links|
11
+ |[**updateMeetingLink**](#updatemeetinglink) | **PUT** /meetings/{meetingId}/links/{linkId} | Update a meeting link|
12
12
 
13
13
  # **createMeetingLink**
14
14
  > CreateMeetingLink200Response createMeetingLink(meetingLinkCreateInputs)
15
15
 
16
- Create Meeting Link endpoint
16
+ Creates a passcode-protected shareable join link for a meeting, auto-generating a unique passcode and associating the given name and preset; requires create and read permissions on meetings.
17
17
 
18
18
  ### Example
19
19
 
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createMeetingLink(
68
68
  # **deleteMeetingLink**
69
69
  > CreateAccountInvitations200Response deleteMeetingLink()
70
70
 
71
- Delete Meeting Link endpoint
71
+ Permanently deletes a shareable meeting link identified by linkId from the given meeting, requiring both read and delete permissions on meetings.
72
72
 
73
73
  ### Example
74
74
 
@@ -122,7 +122,7 @@ const { status, data } = await apiInstance.deleteMeetingLink(
122
122
  # **getMeetingLink**
123
123
  > CreateMeetingLink200Response getMeetingLink()
124
124
 
125
- Get Meeting Link endpoint
125
+ Returns the details of one join link for the given meeting, including its passcode and configuration; requires the read permission on meetings.
126
126
 
127
127
  ### Example
128
128
 
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.getMeetingLink(
176
176
  # **getMeetingLinks**
177
177
  > GetMeetingLinks200Response getMeetingLinks()
178
178
 
179
- Get Meeting Links endpoint
179
+ Returns a paginated list of join links configured for the given meeting, with optional search by name; requires the read permission on meetings.
180
180
 
181
181
  ### Example
182
182
 
@@ -239,7 +239,7 @@ const { status, data } = await apiInstance.getMeetingLinks(
239
239
  # **updateMeetingLink**
240
240
  > CreateMeetingLink200Response updateMeetingLink(meetingLinkUpdateInputs)
241
241
 
242
- Update Meeting Link endpoint
242
+ Updates the name, preset, or auth requirement of an existing shareable meeting link identified by linkId, requiring both read and update permissions on meetings.
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
- |[**disableLivestream**](#disablelivestream) | **POST** /meetings/livestreams/{livestreamId}/disable | Disable Livestream|
8
- |[**enableLivestream**](#enablelivestream) | **POST** /meetings/livestreams/{livestreamId}/enable | Enable Livestream|
9
- |[**getLivestream**](#getlivestream) | **GET** /meetings/livestreams/{livestreamId} | Get Livestream|
10
- |[**getLivestreamSessions**](#getlivestreamsessions) | **GET** /meetings/livestreams/{livestreamId}/sessions | Get Livestream Sessions|
11
- |[**getLivestreams**](#getlivestreams) | **GET** /meetings/livestreams | Get Livestreams|
12
- |[**resetLivestreamStreamKey**](#resetlivestreamstreamkey) | **POST** /meetings/livestreams/{livestreamId}/reset-stream-key | Reset Livestream Stream Key|
7
+ |[**disableLivestream**](#disablelivestream) | **POST** /meetings/livestreams/{livestreamId}/disable | Disable a livestream|
8
+ |[**enableLivestream**](#enablelivestream) | **POST** /meetings/livestreams/{livestreamId}/enable | Enable a livestream|
9
+ |[**getLivestream**](#getlivestream) | **GET** /meetings/livestreams/{livestreamId} | Get a livestream|
10
+ |[**getLivestreamSessions**](#getlivestreamsessions) | **GET** /meetings/livestreams/{livestreamId}/sessions | List a livestream\'s sessions|
11
+ |[**getLivestreams**](#getlivestreams) | **GET** /meetings/livestreams | List livestreams|
12
+ |[**resetLivestreamStreamKey**](#resetlivestreamstreamkey) | **POST** /meetings/livestreams/{livestreamId}/reset-stream-key | Reset a livestream\'s stream key|
13
13
 
14
14
  # **disableLivestream**
15
15
  > GetLivestream200Response disableLivestream()
16
16
 
17
- Disable Livestream endpoint
17
+ Disables the livestream identified by livestreamId so it can no longer ingest or broadcast, requiring both read and create permissions on meetings.
18
18
 
19
19
  ### Example
20
20
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.disableLivestream(
65
65
  # **enableLivestream**
66
66
  > GetLivestream200Response enableLivestream()
67
67
 
68
- Enable Livestream endpoint
68
+ Enables the livestream identified by livestreamId so it can begin ingesting and broadcasting, requiring both read and create permissions on meetings.
69
69
 
70
70
  ### Example
71
71
 
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.enableLivestream(
116
116
  # **getLivestream**
117
117
  > GetLivestream200Response getLivestream()
118
118
 
119
- Get Livestream endpoint
119
+ Returns details for a single livestream by ID, including its Cloudflare RealtimeKit status and stream key; requires \"read\" permission on meetings.
120
120
 
121
121
  ### Example
122
122
 
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getLivestream(
167
167
  # **getLivestreamSessions**
168
168
  > GetLivestreamSessions200Response getLivestreamSessions()
169
169
 
170
- Get Livestream Sessions endpoint
170
+ Returns a paginated list of sessions that occurred on the given livestream, supporting page and pageSize parameters; requires \"read\" permission on meetings.
171
171
 
172
172
  ### Example
173
173
 
@@ -230,7 +230,7 @@ const { status, data } = await apiInstance.getLivestreamSessions(
230
230
  # **getLivestreams**
231
231
  > GetLivestreams200Response getLivestreams()
232
232
 
233
- Get Livestreams endpoint
233
+ Returns a paginated list of livestreams for the organization\'s meetings app, supporting page, pageSize, orderBy, and search parameters; requires \"read\" permission on meetings.
234
234
 
235
235
  ### Example
236
236
 
@@ -290,7 +290,7 @@ const { status, data } = await apiInstance.getLivestreams(
290
290
  # **resetLivestreamStreamKey**
291
291
  > GetLivestream200Response resetLivestreamStreamKey()
292
292
 
293
- Reset Livestream Stream Key endpoint
293
+ Rotates the ingest stream key for the livestream identified by livestreamId, invalidating the previous key, and requires both read and create permissions on meetings.
294
294
 
295
295
  ### Example
296
296
 
@@ -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
- |[**createMeetingParticipant**](#createmeetingparticipant) | **POST** /meetings/{meetingId}/participants | Create Meeting Participant|
8
- |[**deleteMeetingParticipant**](#deletemeetingparticipant) | **DELETE** /meetings/{meetingId}/participants/{participantId} | Delete Meeting Participant|
9
- |[**getMeetingParticipant**](#getmeetingparticipant) | **GET** /meetings/{meetingId}/participants/{participantId} | Get Meeting Participant|
10
- |[**getMeetingParticipants**](#getmeetingparticipants) | **GET** /meetings/{meetingId}/participants | Get Meeting Participants|
11
- |[**regenerateMeetingParticipantToken**](#regeneratemeetingparticipanttoken) | **POST** /meetings/{meetingId}/participants/{participantId}/regenerate | Regenerate Meeting Participant Token|
12
- |[**updateMeetingParticipant**](#updatemeetingparticipant) | **PUT** /meetings/{meetingId}/participants/{participantId} | Update Meeting Participant|
7
+ |[**createMeetingParticipant**](#createmeetingparticipant) | **POST** /meetings/{meetingId}/participants | Add a participant to a meeting|
8
+ |[**deleteMeetingParticipant**](#deletemeetingparticipant) | **DELETE** /meetings/{meetingId}/participants/{participantId} | Remove a participant from a meeting|
9
+ |[**getMeetingParticipant**](#getmeetingparticipant) | **GET** /meetings/{meetingId}/participants/{participantId} | Get a meeting participant|
10
+ |[**getMeetingParticipants**](#getmeetingparticipants) | **GET** /meetings/{meetingId}/participants | List a meeting\'s participants|
11
+ |[**regenerateMeetingParticipantToken**](#regeneratemeetingparticipanttoken) | **POST** /meetings/{meetingId}/participants/{participantId}/regenerate | Regenerate a participant\'s join token|
12
+ |[**updateMeetingParticipant**](#updatemeetingparticipant) | **PUT** /meetings/{meetingId}/participants/{participantId} | Update a meeting participant|
13
13
 
14
14
  # **createMeetingParticipant**
15
15
  > SyncAccounts200Response createMeetingParticipant(meetingParticipantCreateInputs)
16
16
 
17
- Create Meeting Participant endpoint
17
+ Adds a participant to the given meeting, assigning a role preset based on the meeting type and requester\'s admin status, and returns the participant along with a join token; requires read and create permissions on meetings.
18
18
 
19
19
  ### Example
20
20
 
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.createMeetingParticipant(
69
69
  # **deleteMeetingParticipant**
70
70
  > CreateAccountInvitations200Response deleteMeetingParticipant()
71
71
 
72
- Delete Meeting Participant endpoint
72
+ Removes the participant identified by participantId from the given meeting, revoking their access, and requires both read and delete permissions on meetings.
73
73
 
74
74
  ### Example
75
75
 
@@ -123,7 +123,7 @@ const { status, data } = await apiInstance.deleteMeetingParticipant(
123
123
  # **getMeetingParticipant**
124
124
  > GetMeetingParticipant200Response getMeetingParticipant()
125
125
 
126
- Get Meeting Participant endpoint
126
+ Returns details for a single participant in a meeting, including their peer ID, display name, join/leave times, and linked account (if not a guest); requires \"read\" permission on meetings.
127
127
 
128
128
  ### Example
129
129
 
@@ -177,7 +177,7 @@ const { status, data } = await apiInstance.getMeetingParticipant(
177
177
  # **getMeetingParticipants**
178
178
  > GetMeetingParticipants200Response getMeetingParticipants()
179
179
 
180
- Get Meeting Participants endpoint
180
+ Returns a paginated list of participants for the given meeting, each enriched with the linked account when the participant is not a guest, supporting page and pageSize parameters; requires \"read\" permission on meetings.
181
181
 
182
182
  ### Example
183
183
 
@@ -240,7 +240,7 @@ const { status, data } = await apiInstance.getMeetingParticipants(
240
240
  # **regenerateMeetingParticipantToken**
241
241
  > SyncAccounts200Response regenerateMeetingParticipantToken()
242
242
 
243
- Regenerate Meeting Participant Token endpoint
243
+ Issues a new authentication token for the participant identified by participantId in the given meeting, invalidating their previous token, and requires both read and create permissions on meetings.
244
244
 
245
245
  ### Example
246
246
 
@@ -294,7 +294,7 @@ const { status, data } = await apiInstance.regenerateMeetingParticipantToken(
294
294
  # **updateMeetingParticipant**
295
295
  > GetMeetingParticipant200Response updateMeetingParticipant(meetingParticipantUpdateInputs)
296
296
 
297
- Update Meeting Participant endpoint
297
+ Updates fields (such as name or role) on an existing participant of a meeting, requires the \"update\" permission on meetings, and refreshes the cached participant and participant list.
298
298
 
299
299
  ### Example
300
300
 
@@ -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
- |[**createPreset**](#createpreset) | **POST** /meetings/presets | Create Preset|
8
- |[**deletePreset**](#deletepreset) | **DELETE** /meetings/presets/{presetId} | Delete Preset|
9
- |[**getPreset**](#getpreset) | **GET** /meetings/presets/{presetId} | Get Preset|
10
- |[**getPresets**](#getpresets) | **GET** /meetings/presets | Get Presets|
11
- |[**updatePreset**](#updatepreset) | **PUT** /meetings/presets/{presetId} | Update Preset|
7
+ |[**createPreset**](#createpreset) | **POST** /meetings/presets | Create a meeting preset|
8
+ |[**deletePreset**](#deletepreset) | **DELETE** /meetings/presets/{presetId} | Delete a meeting preset|
9
+ |[**getPreset**](#getpreset) | **GET** /meetings/presets/{presetId} | Get a meeting preset|
10
+ |[**getPresets**](#getpresets) | **GET** /meetings/presets | List meeting presets|
11
+ |[**updatePreset**](#updatepreset) | **PUT** /meetings/presets/{presetId} | Update a meeting preset|
12
12
 
13
13
  # **createPreset**
14
14
  > CreatePreset200Response createPreset(meetingPresetCreateInputs)
15
15
 
16
- Create Preset endpoint
16
+ Creates a reusable meeting configuration preset (e.g. default recording, chat, and AI settings) for the organization, requiring the \"create\" permission on meetings.
17
17
 
18
18
  ### Example
19
19
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createPreset(
65
65
  # **deletePreset**
66
66
  > CreateAccountInvitations200Response deletePreset()
67
67
 
68
- Delete Preset endpoint
68
+ Permanently deletes a meeting configuration preset by ID, requiring the \"delete\" permission on meetings, and removes it from the cached preset list.
69
69
 
70
70
  ### Example
71
71
 
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.deletePreset(
116
116
  # **getPreset**
117
117
  > CreatePreset200Response getPreset()
118
118
 
119
- Get Preset endpoint
119
+ Returns details for a single meeting preset, an app-level resource defining participant roles, permissions, media settings, and UI configuration; requires \"read\" permission on meetings.
120
120
 
121
121
  ### Example
122
122
 
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getPreset(
167
167
  # **getPresets**
168
168
  > GetPresets200Response getPresets()
169
169
 
170
- Get Presets endpoint
170
+ Returns a paginated list of meeting presets defined for the organization\'s meetings app, supporting page, pageSize, and orderBy parameters; requires \"read\" permission on meetings.
171
171
 
172
172
  ### Example
173
173
 
@@ -227,7 +227,7 @@ const { status, data } = await apiInstance.getPresets(
227
227
  # **updatePreset**
228
228
  > CreatePreset200Response updatePreset(meetingPresetUpdateInputs)
229
229
 
230
- Update Preset endpoint
230
+ Updates the configuration of an existing meeting preset by ID, requiring the \"update\" permission on meetings, and refreshes the cached preset data.
231
231
 
232
232
  ### Example
233
233
 
@@ -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
- |[**getMeetingRecording**](#getmeetingrecording) | **GET** /meetings/recordings/{recordingId} | Get Meeting Recording|
8
- |[**getMeetingRecordings**](#getmeetingrecordings) | **GET** /meetings/recordings | Get Meeting Recordings|
7
+ |[**getMeetingRecording**](#getmeetingrecording) | **GET** /meetings/recordings/{recordingId} | Get a meeting recording|
8
+ |[**getMeetingRecordings**](#getmeetingrecordings) | **GET** /meetings/recordings | List meeting recordings|
9
9
 
10
10
  # **getMeetingRecording**
11
11
  > GetMeetingRecording200Response getMeetingRecording()
12
12
 
13
- Get Meeting Recording endpoint
13
+ Returns details for a single meeting recording by ID, including its storage location and status; requires \"read\" permission on meetings.
14
14
 
15
15
  ### Example
16
16
 
@@ -61,7 +61,7 @@ const { status, data } = await apiInstance.getMeetingRecording(
61
61
  # **getMeetingRecordings**
62
62
  > GetMeetingRecordings200Response getMeetingRecordings()
63
63
 
64
- Get Meeting Recordings endpoint
64
+ Returns a paginated list of meeting recordings for the organization, optionally filtered to a specific meeting via meetingId and narrowed with search, page, pageSize, and orderBy parameters; requires \"read\" permission on meetings.
65
65
 
66
66
  ### Example
67
67
 
@@ -4,19 +4,19 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**generateMeetingSessionSummary**](#generatemeetingsessionsummary) | **POST** /meetings/sessions/{sessionId}/summary | Generate Meeting Session Summary|
8
- |[**getMeetingSession**](#getmeetingsession) | **GET** /meetings/sessions/{sessionId} | Get Meeting Session|
9
- |[**getMeetingSessionMessages**](#getmeetingsessionmessages) | **GET** /meetings/sessions/{sessionId}/messages | Get Meeting Session Messages|
10
- |[**getMeetingSessionParticipant**](#getmeetingsessionparticipant) | **GET** /meetings/sessions/{sessionId}/participants/{participantId} | Get Meeting Session Participant|
11
- |[**getMeetingSessionParticipants**](#getmeetingsessionparticipants) | **GET** /meetings/sessions/{sessionId}/participants | Get Meeting Session Participants|
12
- |[**getMeetingSessionSummary**](#getmeetingsessionsummary) | **GET** /meetings/sessions/{sessionId}/summary | Get Meeting Session Summary|
13
- |[**getMeetingSessionTranscript**](#getmeetingsessiontranscript) | **GET** /meetings/sessions/{sessionId}/transcript | Get Meeting Session Transcript|
14
- |[**getMeetingSessions**](#getmeetingsessions) | **GET** /meetings/sessions | Get Meeting Sessions|
7
+ |[**generateMeetingSessionSummary**](#generatemeetingsessionsummary) | **POST** /meetings/sessions/{sessionId}/summary | Generate a meeting session summary|
8
+ |[**getMeetingSession**](#getmeetingsession) | **GET** /meetings/sessions/{sessionId} | Get a meeting session|
9
+ |[**getMeetingSessionMessages**](#getmeetingsessionmessages) | **GET** /meetings/sessions/{sessionId}/messages | Download a meeting session\'s chat messages|
10
+ |[**getMeetingSessionParticipant**](#getmeetingsessionparticipant) | **GET** /meetings/sessions/{sessionId}/participants/{participantId} | Get a meeting session participant|
11
+ |[**getMeetingSessionParticipants**](#getmeetingsessionparticipants) | **GET** /meetings/sessions/{sessionId}/participants | List a meeting session\'s participants|
12
+ |[**getMeetingSessionSummary**](#getmeetingsessionsummary) | **GET** /meetings/sessions/{sessionId}/summary | Get a meeting session\'s AI-generated summary|
13
+ |[**getMeetingSessionTranscript**](#getmeetingsessiontranscript) | **GET** /meetings/sessions/{sessionId}/transcript | Download a meeting session\'s transcript|
14
+ |[**getMeetingSessions**](#getmeetingsessions) | **GET** /meetings/sessions | List meeting sessions|
15
15
 
16
16
  # **generateMeetingSessionSummary**
17
17
  > SyncAccounts200Response generateMeetingSessionSummary()
18
18
 
19
- Generate Meeting Session Summary endpoint
19
+ Kicks off AI-generated summary creation for a completed meeting session using its transcript, requiring the \"create\" permission on meetings, and errors if the session has no transcript yet.
20
20
 
21
21
  ### Example
22
22
 
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.generateMeetingSessionSummary(
67
67
  # **getMeetingSession**
68
68
  > GetMeetingSession200Response getMeetingSession()
69
69
 
70
- Get Meeting Session endpoint
70
+ Returns details for a single meeting session by ID, representing one occurrence/run of a meeting; requires \"read\" permission on meetings.
71
71
 
72
72
  ### Example
73
73
 
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.getMeetingSession(
118
118
  # **getMeetingSessionMessages**
119
119
  > GetMeetingSessionMessages200Response getMeetingSessionMessages()
120
120
 
121
- Get Meeting Session Messages endpoint
121
+ Returns a downloadable transcript of the in-meeting chat messages sent during the given meeting session, requires the \"read\" permission on meetings.
122
122
 
123
123
  ### Example
124
124
 
@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.getMeetingSessionMessages(
169
169
  # **getMeetingSessionParticipant**
170
170
  > GetMeetingSessionParticipant200Response getMeetingSessionParticipant()
171
171
 
172
- Get Meeting Session Participant endpoint
172
+ Returns the details of a single participant within a specific meeting session, including their linked account information when the participant is a known user, requires the \"read\" permission on meetings.
173
173
 
174
174
  ### Example
175
175
 
@@ -223,7 +223,7 @@ const { status, data } = await apiInstance.getMeetingSessionParticipant(
223
223
  # **getMeetingSessionParticipants**
224
224
  > GetMeetingSessionParticipants200Response getMeetingSessionParticipants()
225
225
 
226
- Get Meeting Session Participants endpoint
226
+ Returns a paginated list of participants who joined the given meeting session, with each participant\'s linked account attached when they are a known user, supports search and requires the \"read\" permission on meetings.
227
227
 
228
228
  ### Example
229
229
 
@@ -286,7 +286,7 @@ const { status, data } = await apiInstance.getMeetingSessionParticipants(
286
286
  # **getMeetingSessionSummary**
287
287
  > GetMeetingSessionSummary200Response getMeetingSessionSummary()
288
288
 
289
- Get Meeting Session Summary endpoint
289
+ Returns the AI-generated summary for the given meeting session, requires the \"read\" permission on meetings.
290
290
 
291
291
  ### Example
292
292
 
@@ -337,7 +337,7 @@ const { status, data } = await apiInstance.getMeetingSessionSummary(
337
337
  # **getMeetingSessionTranscript**
338
338
  > GetMeetingSessionTranscript200Response getMeetingSessionTranscript()
339
339
 
340
- Get Meeting Session Transcript endpoint
340
+ Returns the speech-to-text transcript recorded for the given meeting session, requires the \"read\" permission on meetings.
341
341
 
342
342
  ### Example
343
343
 
@@ -388,7 +388,7 @@ const { status, data } = await apiInstance.getMeetingSessionTranscript(
388
388
  # **getMeetingSessions**
389
389
  > GetMeetingSessions200Response getMeetingSessions()
390
390
 
391
- Get Meeting Sessions endpoint
391
+ Returns a paginated list of meeting sessions across the organization, optionally filtered to a single meeting via meetingId and by search term, requires the \"read\" permission on meetings.
392
392
 
393
393
  ### Example
394
394
 
@@ -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
- |[**getNotificationCount**](#getnotificationcount) | **GET** /notifications/count | Get Notification Count|
8
- |[**getNotificationStats**](#getnotificationstats) | **GET** /notifications/stats | Get Notification Stats|
9
- |[**getNotifications**](#getnotifications) | **GET** /notifications | Get Notifications|
10
- |[**markNotificationsRead**](#marknotificationsread) | **PUT** /notifications/read | Mark Notifications Read|
7
+ |[**getNotificationCount**](#getnotificationcount) | **GET** /notifications/count | Count the caller\'s notifications|
8
+ |[**getNotificationStats**](#getnotificationstats) | **GET** /notifications/stats | Get notification statistics|
9
+ |[**getNotifications**](#getnotifications) | **GET** /notifications | List the current member\'s notifications|
10
+ |[**markNotificationsRead**](#marknotificationsread) | **PUT** /notifications/read | Mark notifications as read|
11
11
 
12
12
  # **getNotificationCount**
13
13
  > SyncAccounts200Response getNotificationCount()
14
14
 
15
- Get Notification Count endpoint
15
+ Returns the number of notifications for the current organization member, optionally filtered by read/unread status, source, or notification type, no special permission is required beyond authentication since results are scoped to the caller.
16
16
 
17
17
  ### Example
18
18
 
@@ -64,7 +64,7 @@ const { status, data } = await apiInstance.getNotificationCount(
64
64
  # **getNotificationStats**
65
65
  > GetNotificationStats200Response getNotificationStats()
66
66
 
67
- Get Notification Stats endpoint
67
+ Returns aggregate notification statistics for the authenticated organization member, including total and unread counts broken down by notification type and source; available to any authenticated organization member for their own notifications.
68
68
 
69
69
  ### Example
70
70
 
@@ -108,7 +108,7 @@ This endpoint does not have any parameters.
108
108
  # **getNotifications**
109
109
  > GetNotifications200Response getNotifications()
110
110
 
111
- Get Notifications endpoint
111
+ Returns a paginated list of notifications for the authenticated organization member, filterable by read status, source, type, and search term; available to any authenticated organization member for their own notifications.
112
112
 
113
113
  ### Example
114
114
 
@@ -172,7 +172,7 @@ const { status, data } = await apiInstance.getNotifications(
172
172
  # **markNotificationsRead**
173
173
  > SyncAccounts200Response markNotificationsRead()
174
174
 
175
- Mark Notifications Read endpoint
175
+ Marks the given list of notification IDs as read for the current organization member and returns the count of notifications updated.
176
176
 
177
177
  ### Example
178
178