@connectedxm/admin-sdk 7.5.0 → 7.8.0

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 (211) hide show
  1. package/.openapi-generator/FILES +1 -0
  2. package/README.md +1215 -1212
  3. package/api.ts +9898 -9710
  4. package/dist/api.d.ts +9807 -9710
  5. package/dist/api.js +9842 -9696
  6. package/dist/esm/api.d.ts +9807 -9710
  7. package/dist/esm/api.js +9842 -9696
  8. package/docs/AccountsAddressesApi.md +10 -10
  9. package/docs/AccountsApi.md +42 -42
  10. package/docs/AccountsFollowersApi.md +6 -6
  11. package/docs/AccountsFollowingApi.md +6 -6
  12. package/docs/AccountsGroupsApi.md +6 -6
  13. package/docs/AccountsInterestsApi.md +6 -6
  14. package/docs/AccountsInvitationsApi.md +6 -6
  15. package/docs/AccountsLeadsApi.md +8 -8
  16. package/docs/AccountsTiersApi.md +8 -8
  17. package/docs/ActivitiesApi.md +18 -18
  18. package/docs/ActivitiesScheduleApi.md +4 -4
  19. package/docs/AdvertisementsApi.md +14 -14
  20. package/docs/AnnouncementsApi.md +16 -16
  21. package/docs/AnnouncementsScheduleApi.md +4 -4
  22. package/docs/AnnouncementsTranslationsApi.md +8 -8
  23. package/docs/ApiLogsApi.md +4 -4
  24. package/docs/AuthSessionsApi.md +4 -4
  25. package/docs/BaseEvent.md +6 -0
  26. package/docs/BaseEventSessionLocation.md +2 -0
  27. package/docs/BenefitsApi.md +12 -12
  28. package/docs/BenefitsTranslationsApi.md +8 -8
  29. package/docs/BookingsApi.md +56 -56
  30. package/docs/BookingsAvailabilitiesApi.md +6 -6
  31. package/docs/BookingsBlackoutsApi.md +6 -6
  32. package/docs/BookingsPlacesApi.md +6 -6
  33. package/docs/BookingsPlacesTranslationsApi.md +4 -4
  34. package/docs/BookingsQuestionsApi.md +16 -16
  35. package/docs/BookingsQuestionsChoicesApi.md +12 -12
  36. package/docs/BookingsQuestionsChoicesTranslationsApi.md +8 -8
  37. package/docs/BookingsQuestionsTranslationsApi.md +8 -8
  38. package/docs/BookingsSpacesApi.md +6 -6
  39. package/docs/BookingsSpacesTranslationsApi.md +4 -4
  40. package/docs/ChannelsApi.md +58 -58
  41. package/docs/ChannelsTranslationsApi.md +24 -24
  42. package/docs/DashboardsApi.md +10 -10
  43. package/docs/DashboardsWidgetsApi.md +8 -8
  44. package/docs/EmailReceiptsApi.md +4 -4
  45. package/docs/Event.md +10 -0
  46. package/docs/EventCreateInputs.md +0 -14
  47. package/docs/EventLocationInputs.md +38 -0
  48. package/docs/EventSessionLocation.md +6 -0
  49. package/docs/EventSessionLocationCreateInputs.md +2 -0
  50. package/docs/EventSessionLocationUpdateInputs.md +2 -0
  51. package/docs/EventUpdateInputs.md +0 -14
  52. package/docs/EventsAccessApi.md +6 -6
  53. package/docs/EventsActivationsApi.md +22 -22
  54. package/docs/EventsActivationsSessionsApi.md +6 -6
  55. package/docs/EventsActivationsTranslationsApi.md +8 -8
  56. package/docs/EventsAddonsApi.md +24 -24
  57. package/docs/EventsAddonsTranslationsApi.md +8 -8
  58. package/docs/EventsApi.md +130 -22
  59. package/docs/EventsAttendeesApi.md +24 -24
  60. package/docs/EventsAttendeesPackagesApi.md +10 -10
  61. package/docs/EventsAttendeesReservationsApi.md +18 -18
  62. package/docs/EventsAttributesApi.md +10 -10
  63. package/docs/EventsBenefitsApi.md +4 -4
  64. package/docs/EventsBlocksApi.md +16 -16
  65. package/docs/EventsBypassApi.md +10 -10
  66. package/docs/EventsCohostsApi.md +6 -6
  67. package/docs/EventsCouponsApi.md +28 -28
  68. package/docs/EventsEmailsApi.md +4 -4
  69. package/docs/EventsEmailsTranslationsApi.md +8 -8
  70. package/docs/EventsFaqsApi.md +22 -22
  71. package/docs/EventsFaqsTranslationsApi.md +16 -16
  72. package/docs/EventsFollowupsApi.md +38 -38
  73. package/docs/EventsFollowupsTranslationsApi.md +8 -8
  74. package/docs/EventsMatchesApi.md +34 -34
  75. package/docs/EventsMediaApi.md +16 -16
  76. package/docs/EventsMediaTranslationsApi.md +8 -8
  77. package/docs/EventsOnSiteApi.md +6 -6
  78. package/docs/EventsPackagesApi.md +10 -10
  79. package/docs/EventsPackagesPassesApi.md +10 -10
  80. package/docs/EventsPackagesTranslationsApi.md +8 -8
  81. package/docs/EventsPagesApi.md +16 -16
  82. package/docs/EventsPagesTranslationsApi.md +8 -8
  83. package/docs/EventsPassesAccessesApi.md +10 -10
  84. package/docs/EventsPassesAddonsApi.md +6 -6
  85. package/docs/EventsPassesApi.md +34 -34
  86. package/docs/EventsPassesAttributesApi.md +6 -6
  87. package/docs/EventsPassesFollowupsApi.md +8 -8
  88. package/docs/EventsPassesResponsesApi.md +10 -10
  89. package/docs/EventsPasstypesApi.md +34 -34
  90. package/docs/EventsPasstypesPriceschedulesApi.md +10 -10
  91. package/docs/EventsPasstypesRefundschedulesApi.md +10 -10
  92. package/docs/EventsPasstypesTranslationsApi.md +8 -8
  93. package/docs/EventsQuestionsApi.md +44 -44
  94. package/docs/EventsQuestionsTranslationsApi.md +16 -16
  95. package/docs/EventsRoomsApi.md +18 -18
  96. package/docs/EventsRoomtypesApi.md +24 -24
  97. package/docs/EventsRoomtypesTranslationsApi.md +8 -8
  98. package/docs/EventsSectionsApi.md +38 -38
  99. package/docs/EventsSectionsTranslationsApi.md +8 -8
  100. package/docs/EventsSessionsAccessesApi.md +6 -6
  101. package/docs/EventsSessionsApi.md +70 -70
  102. package/docs/EventsSessionsLocationsApi.md +16 -16
  103. package/docs/EventsSessionsLocationsTranslationsApi.md +8 -8
  104. package/docs/EventsSessionsMatchesApi.md +32 -32
  105. package/docs/EventsSessionsPricesApi.md +6 -6
  106. package/docs/EventsSessionsQuestionsApi.md +38 -38
  107. package/docs/EventsSessionsQuestionsTranslationsApi.md +16 -16
  108. package/docs/EventsSessionsSectionsApi.md +20 -20
  109. package/docs/EventsSessionsSectionsTranslationsApi.md +8 -8
  110. package/docs/EventsSessionsTimesApi.md +16 -16
  111. package/docs/EventsSessionsTimesTranslationsApi.md +8 -8
  112. package/docs/EventsSessionsTranslationsApi.md +8 -8
  113. package/docs/EventsSpeakersApi.md +16 -16
  114. package/docs/EventsSpeakersTranslationsApi.md +8 -8
  115. package/docs/EventsSponsorsApi.md +8 -8
  116. package/docs/EventsSponsorshiplevelsApi.md +12 -12
  117. package/docs/EventsSponsorshiplevelsTranslationsApi.md +8 -8
  118. package/docs/EventsSponsorshipsApi.md +12 -12
  119. package/docs/EventsSponsorshipsTranslationsApi.md +8 -8
  120. package/docs/EventsTemplatesApi.md +2 -2
  121. package/docs/EventsTracksApi.md +22 -22
  122. package/docs/EventsTracksTranslationsApi.md +8 -8
  123. package/docs/EventsTransfersApi.md +4 -4
  124. package/docs/EventsTranslationsApi.md +8 -8
  125. package/docs/FilesApi.md +4 -4
  126. package/docs/GroupsApi.md +12 -12
  127. package/docs/GroupsEventsApi.md +6 -6
  128. package/docs/GroupsInterestsApi.md +6 -6
  129. package/docs/GroupsInvitationsApi.md +12 -12
  130. package/docs/GroupsMembersApi.md +8 -8
  131. package/docs/GroupsModeratorsApi.md +6 -6
  132. package/docs/GroupsRequestsApi.md +10 -10
  133. package/docs/GroupsSponsorsApi.md +6 -6
  134. package/docs/GroupsTranslationsApi.md +8 -8
  135. package/docs/ImportsApi.md +8 -8
  136. package/docs/InterestsApi.md +22 -22
  137. package/docs/InvoicesApi.md +20 -20
  138. package/docs/InvoicesLineitemsApi.md +6 -6
  139. package/docs/LoginsAccountsApi.md +6 -6
  140. package/docs/LoginsApi.md +16 -16
  141. package/docs/MeetingsApi.md +14 -14
  142. package/docs/MeetingsLinksApi.md +10 -10
  143. package/docs/MeetingsLivestreamsApi.md +12 -12
  144. package/docs/MeetingsParticipantsApi.md +12 -12
  145. package/docs/MeetingsPresetsApi.md +10 -10
  146. package/docs/MeetingsRecordingsApi.md +4 -4
  147. package/docs/MeetingsSessionsApi.md +16 -16
  148. package/docs/NotificationsApi.md +8 -8
  149. package/docs/OrganizationApi.md +18 -18
  150. package/docs/OrganizationAttributesApi.md +14 -14
  151. package/docs/OrganizationDomainsApi.md +6 -6
  152. package/docs/OrganizationIntegrationsApi.md +10 -10
  153. package/docs/OrganizationModulesApi.md +6 -6
  154. package/docs/OrganizationModulesCustomApi.md +10 -10
  155. package/docs/OrganizationModulesCustomTranslationsApi.md +8 -8
  156. package/docs/OrganizationModulesSettingsApi.md +4 -4
  157. package/docs/OrganizationModulesSettingsTranslationsApi.md +8 -8
  158. package/docs/OrganizationModulesTiersApi.md +12 -12
  159. package/docs/OrganizationPaymentsApi.md +20 -20
  160. package/docs/OrganizationSideeffectsApi.md +8 -8
  161. package/docs/OrganizationTaxApi.md +22 -22
  162. package/docs/OrganizationTeammembersApi.md +10 -10
  163. package/docs/OrganizationUsersApi.md +6 -6
  164. package/docs/OrganizationWebhooksApi.md +12 -12
  165. package/docs/PaymentsApi.md +2 -2
  166. package/docs/PreferencesApi.md +4 -4
  167. package/docs/PushDevicesApi.md +6 -6
  168. package/docs/ReportsApi.md +22 -22
  169. package/docs/ReportsUsersApi.md +6 -6
  170. package/docs/SearchlistsApi.md +10 -10
  171. package/docs/SearchlistsValuesApi.md +14 -14
  172. package/docs/SelfApi.md +10 -10
  173. package/docs/SelfApikeysApi.md +8 -8
  174. package/docs/SelfImagesApi.md +4 -4
  175. package/docs/SeriesApi.md +18 -18
  176. package/docs/SeriesQuestionsApi.md +14 -14
  177. package/docs/SeriesQuestionsChoicesApi.md +8 -8
  178. package/docs/SeriesQuestionsTranslationsApi.md +4 -4
  179. package/docs/SeriesRegistrationsApi.md +18 -18
  180. package/docs/SeriesTranslationsApi.md +8 -8
  181. package/docs/SponsorsAccountsApi.md +6 -6
  182. package/docs/SponsorsApi.md +10 -10
  183. package/docs/SponsorsTranslationsApi.md +8 -8
  184. package/docs/StorageFilesApi.md +6 -6
  185. package/docs/StorageImagesApi.md +18 -18
  186. package/docs/StorageVideosApi.md +14 -14
  187. package/docs/StorageVideosCaptionsApi.md +10 -10
  188. package/docs/StreamsApi.md +14 -14
  189. package/docs/StreamsOutputsApi.md +10 -10
  190. package/docs/StreamsSessionsApi.md +12 -12
  191. package/docs/SupportApi.md +14 -14
  192. package/docs/SupportMessagesApi.md +4 -4
  193. package/docs/SupportNotesApi.md +6 -6
  194. package/docs/SurveysApi.md +12 -12
  195. package/docs/SurveysQuestionsApi.md +38 -38
  196. package/docs/SurveysQuestionsTranslationsApi.md +16 -16
  197. package/docs/SurveysSectionsApi.md +20 -20
  198. package/docs/SurveysSectionsTranslationsApi.md +8 -8
  199. package/docs/SurveysSessionsApi.md +4 -4
  200. package/docs/SurveysSubmissionsApi.md +14 -14
  201. package/docs/SurveysTranslationsApi.md +8 -8
  202. package/docs/ThreadsAccountsApi.md +8 -8
  203. package/docs/ThreadsApi.md +10 -10
  204. package/docs/ThreadsMessagesApi.md +12 -12
  205. package/docs/ThreadsMessagesFilesApi.md +6 -6
  206. package/docs/ThreadsMessagesImagesApi.md +6 -6
  207. package/docs/ThreadsMessagesReactionsApi.md +6 -6
  208. package/docs/ThreadsMessagesVideosApi.md +6 -6
  209. package/docs/ThreadsStorageApi.md +6 -6
  210. package/docs/TiersApi.md +20 -20
  211. 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
- |[**deleteSurveyTranslation**](#deletesurveytranslation) | **DELETE** /surveys/{surveyId}/translations/{locale} | Delete Survey Translation|
8
- |[**getSurveyTranslation**](#getsurveytranslation) | **GET** /surveys/{surveyId}/translations/{locale} | Get Survey Translation|
9
- |[**getSurveyTranslations**](#getsurveytranslations) | **GET** /surveys/{surveyId}/translations | Get Survey Translations|
10
- |[**updateSurveyTranslation**](#updatesurveytranslation) | **PUT** /surveys/{surveyId}/translations/{locale} | Update Survey Translation|
7
+ |[**deleteSurveyTranslation**](#deletesurveytranslation) | **DELETE** /surveys/{surveyId}/translations/{locale} | Delete a survey\'s translation|
8
+ |[**getSurveyTranslation**](#getsurveytranslation) | **GET** /surveys/{surveyId}/translations/{locale} | Get a survey\'s translation for a locale|
9
+ |[**getSurveyTranslations**](#getsurveytranslations) | **GET** /surveys/{surveyId}/translations | List a survey\'s translations|
10
+ |[**updateSurveyTranslation**](#updatesurveytranslation) | **PUT** /surveys/{surveyId}/translations/{locale} | Create or update a survey\'s translation|
11
11
 
12
12
  # **deleteSurveyTranslation**
13
13
  > SyncAccounts200Response deleteSurveyTranslation()
14
14
 
15
- Delete Survey Translation endpoint
15
+ Removes the translated content for a survey in the given locale, leaving the survey\'s default-locale content unaffected; requires the update surveys permission.
16
16
 
17
17
  ### Example
18
18
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.deleteSurveyTranslation(
66
66
  # **getSurveyTranslation**
67
67
  > GetSurveyTranslation200Response getSurveyTranslation()
68
68
 
69
- Get Survey Translation endpoint
69
+ Retrieves the translated text fields for a survey in a specific locale, returning null if no translation exists for that locale, requiring read permission on surveys.
70
70
 
71
71
  ### Example
72
72
 
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.getSurveyTranslation(
120
120
  # **getSurveyTranslations**
121
121
  > GetSurveyTranslations200Response getSurveyTranslations()
122
122
 
123
- Get Survey Translations endpoint
123
+ Returns a paginated list of the locale translations available for a survey, with optional search and ordering, requiring read permission on surveys.
124
124
 
125
125
  ### Example
126
126
 
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getSurveyTranslations(
183
183
  # **updateSurveyTranslation**
184
184
  > SyncAccounts200Response updateSurveyTranslation(surveyTranslationUpdateInputs)
185
185
 
186
- Update Survey Translation endpoint
186
+ Upserts the translated content (such as name and description) for a survey in the given locale, creating the translation if it does not already exist; requires the update surveys permission.
187
187
 
188
188
  ### Example
189
189
 
@@ -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
- |[**addThreadAccounts**](#addthreadaccounts) | **POST** /threads/{threadId}/accounts | Add Thread Accounts|
8
- |[**deleteThreadAccount**](#deletethreadaccount) | **DELETE** /threads/{threadId}/accounts/{threadAccountId} | Delete Thread Account|
9
- |[**getThreadAccounts**](#getthreadaccounts) | **GET** /threads/{threadId}/accounts | Get Thread Accounts|
10
- |[**updateThreadAccount**](#updatethreadaccount) | **PUT** /threads/{threadId}/accounts/{threadAccountId} | Update Thread Account|
7
+ |[**addThreadAccounts**](#addthreadaccounts) | **POST** /threads/{threadId}/accounts | Add accounts to a thread|
8
+ |[**deleteThreadAccount**](#deletethreadaccount) | **DELETE** /threads/{threadId}/accounts/{threadAccountId} | Remove an account from a thread|
9
+ |[**getThreadAccounts**](#getthreadaccounts) | **GET** /threads/{threadId}/accounts | List a thread\'s participant accounts|
10
+ |[**updateThreadAccount**](#updatethreadaccount) | **PUT** /threads/{threadId}/accounts/{threadAccountId} | Update a thread participant|
11
11
 
12
12
  # **addThreadAccounts**
13
13
  > AddThreadAccounts200Response addThreadAccounts(threadAccountsAddInputs)
14
14
 
15
- Add Thread Accounts endpoint
15
+ Adds the given account IDs as participants of the thread identified by threadId, restoring any that previously left, up to a 32-participant limit; not allowed on direct message threads and requires update permission on threads.
16
16
 
17
17
  ### Example
18
18
 
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.addThreadAccounts(
67
67
  # **deleteThreadAccount**
68
68
  > CreateAccountInvitations200Response deleteThreadAccount()
69
69
 
70
- Delete Thread Account endpoint
70
+ Soft-removes the participant identified by threadAccountId from the thread identified by threadId by marking them as having left, preserving their message history; requires update permission on threads.
71
71
 
72
72
  ### Example
73
73
 
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.deleteThreadAccount(
121
121
  # **getThreadAccounts**
122
122
  > GetThreadAccounts200Response getThreadAccounts()
123
123
 
124
- Get Thread Accounts endpoint
124
+ Returns a paginated list of accounts participating in the given thread, supporting search and ordering; requires read permission on threads and accounts.
125
125
 
126
126
  ### Example
127
127
 
@@ -184,7 +184,7 @@ const { status, data } = await apiInstance.getThreadAccounts(
184
184
  # **updateThreadAccount**
185
185
  > UpdateThreadAccount200Response updateThreadAccount(threadAccountUpdateInputs)
186
186
 
187
- Update Thread Account endpoint
187
+ Updates participant-level metadata (such as notification preference or blocked status) for the thread account identified by threadAccountId within the thread identified by threadId; requires update permission on threads and accounts.
188
188
 
189
189
  ### Example
190
190
 
@@ -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
- |[**createThread**](#createthread) | **POST** /threads | Create Thread|
8
- |[**deleteThread**](#deletethread) | **DELETE** /threads/{threadId} | Delete Thread|
9
- |[**getThread**](#getthread) | **GET** /threads/{threadId} | Get Thread|
10
- |[**getThreads**](#getthreads) | **GET** /threads | Get Threads|
11
- |[**updateThread**](#updatethread) | **PUT** /threads/{threadId} | Update Thread|
7
+ |[**createThread**](#createthread) | **POST** /threads | Create a new message thread|
8
+ |[**deleteThread**](#deletethread) | **DELETE** /threads/{threadId} | Delete a thread|
9
+ |[**getThread**](#getthread) | **GET** /threads/{threadId} | Get a thread|
10
+ |[**getThreads**](#getthreads) | **GET** /threads | List threads|
11
+ |[**updateThread**](#updatethread) | **PUT** /threads/{threadId} | Update a thread\'s details|
12
12
 
13
13
  # **createThread**
14
14
  > CreateThread200Response createThread(threadCreateInputs)
15
15
 
16
- Create Thread endpoint
16
+ Creates a new thread for direct or group messaging between accounts; requires the \"read\" and \"create\" permissions on threads.
17
17
 
18
18
  ### Example
19
19
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createThread(
65
65
  # **deleteThread**
66
66
  > CreateAccountInvitations200Response deleteThread()
67
67
 
68
- Delete Thread endpoint
68
+ Permanently deletes a thread and its associated data as part of admin moderation; requires the \"read\" and \"del\" permissions on threads.
69
69
 
70
70
  ### Example
71
71
 
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.deleteThread(
116
116
  # **getThread**
117
117
  > CreateThread200Response getThread()
118
118
 
119
- Get Thread endpoint
119
+ Returns the details of a single thread by id, including its participants and metadata; requires read permission on threads.
120
120
 
121
121
  ### Example
122
122
 
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getThread(
167
167
  # **getThreads**
168
168
  > GetAccountThreads200Response getThreads()
169
169
 
170
- Get Threads endpoint
170
+ Returns a paginated list of an organization\'s message threads for admin moderation, with optional filtering by thread type and search; requires read permission on threads.
171
171
 
172
172
  ### Example
173
173
 
@@ -230,7 +230,7 @@ const { status, data } = await apiInstance.getThreads(
230
230
  # **updateThread**
231
231
  > CreateThread200Response updateThread(threadUpdateInputs)
232
232
 
233
- Update Thread endpoint
233
+ Updates properties of an existing thread, such as its name or type; requires the \"read\" and \"update\" permissions on threads.
234
234
 
235
235
  ### Example
236
236
 
@@ -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
- |[**createThreadMessage**](#createthreadmessage) | **POST** /threads/{threadId}/messages | Create Thread Message|
8
- |[**deleteThreadMessage**](#deletethreadmessage) | **DELETE** /threads/{threadId}/messages/{messageId} | Delete Thread Message|
9
- |[**getThreadMessage**](#getthreadmessage) | **GET** /threads/{threadId}/messages/{messageId} | Get Thread Message|
10
- |[**getThreadMessages**](#getthreadmessages) | **GET** /threads/{threadId}/messages | Get Thread Messages|
11
- |[**getThreadMessagesPoll**](#getthreadmessagespoll) | **GET** /threads/{threadId}/messages/poll | Get Thread Messages Poll|
12
- |[**updateThreadMessage**](#updatethreadmessage) | **PUT** /threads/{threadId}/messages/{messageId} | Update Thread Message|
7
+ |[**createThreadMessage**](#createthreadmessage) | **POST** /threads/{threadId}/messages | Post a new message to a thread|
8
+ |[**deleteThreadMessage**](#deletethreadmessage) | **DELETE** /threads/{threadId}/messages/{messageId} | Delete a message from a thread|
9
+ |[**getThreadMessage**](#getthreadmessage) | **GET** /threads/{threadId}/messages/{messageId} | Get a single thread message|
10
+ |[**getThreadMessages**](#getthreadmessages) | **GET** /threads/{threadId}/messages | List a thread\'s messages|
11
+ |[**getThreadMessagesPoll**](#getthreadmessagespoll) | **GET** /threads/{threadId}/messages/poll | Poll a thread for new messages|
12
+ |[**updateThreadMessage**](#updatethreadmessage) | **PUT** /threads/{threadId}/messages/{messageId} | Edit a thread message|
13
13
 
14
14
  # **createThreadMessage**
15
15
  > CreateThreadMessage200Response createThreadMessage(threadMessageCreateInputs)
16
16
 
17
- Create Thread Message endpoint
17
+ Creates a new message in the specified thread on behalf of the given account; requires the \"read\" and \"update\" permissions on threads.
18
18
 
19
19
  ### Example
20
20
 
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.createThreadMessage(
69
69
  # **deleteThreadMessage**
70
70
  > CreateThreadMessage200Response deleteThreadMessage()
71
71
 
72
- Delete Thread Message endpoint
72
+ Deletes a message from a thread, soft-deleting it if it has reply children or removing it outright otherwise; requires the \"read\" and \"del\" permissions on threads.
73
73
 
74
74
  ### Example
75
75
 
@@ -123,7 +123,7 @@ const { status, data } = await apiInstance.deleteThreadMessage(
123
123
  # **getThreadMessage**
124
124
  > CreateThreadMessage200Response getThreadMessage()
125
125
 
126
- Get Thread Message endpoint
126
+ Returns a single message from the given thread by its ID; requires read permission on threads.
127
127
 
128
128
  ### Example
129
129
 
@@ -177,7 +177,7 @@ const { status, data } = await apiInstance.getThreadMessage(
177
177
  # **getThreadMessages**
178
178
  > GetThreadMessages200Response getThreadMessages()
179
179
 
180
- Get Thread Messages endpoint
180
+ Returns a cursor-paginated list of messages in the given thread, ordered by send time, with optional search; requires read permission on threads.
181
181
 
182
182
  ### Example
183
183
 
@@ -228,7 +228,7 @@ const { status, data } = await apiInstance.getThreadMessages(
228
228
  # **getThreadMessagesPoll**
229
229
  > GetThreadMessages200Response getThreadMessagesPoll()
230
230
 
231
- Get Thread Messages Poll endpoint
231
+ Returns any messages sent in the given thread after the provided lastMessageId, for lightweight polling-based updates; requires read permission on threads.
232
232
 
233
233
  ### Example
234
234
 
@@ -282,7 +282,7 @@ const { status, data } = await apiInstance.getThreadMessagesPoll(
282
282
  # **updateThreadMessage**
283
283
  > CreateThreadMessage200Response updateThreadMessage(threadMessageUpdateInputs)
284
284
 
285
- Update Thread Message endpoint
285
+ Updates the content of an existing message within a thread; requires the \"read\" and \"update\" permissions on threads.
286
286
 
287
287
  ### Example
288
288
 
@@ -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
- |[**createThreadMessageFile**](#createthreadmessagefile) | **POST** /threads/{threadId}/messages/{messageId}/files/{fileId} | Create Thread Message File|
8
- |[**deleteThreadMessageFile**](#deletethreadmessagefile) | **DELETE** /threads/{threadId}/messages/{messageId}/files/{fileId} | Delete Thread Message File|
9
- |[**getThreadMessageFiles**](#getthreadmessagefiles) | **GET** /threads/{threadId}/messages/{messageId}/files | Get Thread Message Files|
7
+ |[**createThreadMessageFile**](#createthreadmessagefile) | **POST** /threads/{threadId}/messages/{messageId}/files/{fileId} | Attach a file to a thread message|
8
+ |[**deleteThreadMessageFile**](#deletethreadmessagefile) | **DELETE** /threads/{threadId}/messages/{messageId}/files/{fileId} | Remove a file from a thread message|
9
+ |[**getThreadMessageFiles**](#getthreadmessagefiles) | **GET** /threads/{threadId}/messages/{messageId}/files | List a thread message\'s attached files|
10
10
 
11
11
  # **createThreadMessageFile**
12
12
  > CreateThreadMessage200Response createThreadMessageFile()
13
13
 
14
- Create Thread Message File endpoint
14
+ Connects an existing uploaded file, identified by fileId, to the thread message identified by messageId within the given threadId and returns the updated message; requires update permission on threads and storage.
15
15
 
16
16
  ### Example
17
17
 
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createThreadMessageFile(
68
68
  # **deleteThreadMessageFile**
69
69
  > CreateAccountInvitations200Response deleteThreadMessageFile()
70
70
 
71
- Delete Thread Message File endpoint
71
+ Disconnects the file identified by fileId from the thread message identified by messageId within the given threadId, without deleting the underlying file; requires update permission on threads and storage.
72
72
 
73
73
  ### Example
74
74
 
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.deleteThreadMessageFile(
125
125
  # **getThreadMessageFiles**
126
126
  > GetThreadMessageFiles200Response getThreadMessageFiles()
127
127
 
128
- Get Thread Message Files endpoint
128
+ Returns a paginated list of files attached to the given thread message, supporting search and ordering; requires read permission on threads and storage.
129
129
 
130
130
  ### Example
131
131
 
@@ -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
- |[**createThreadMessageImage**](#createthreadmessageimage) | **POST** /threads/{threadId}/messages/{messageId}/images/{imageId} | Create Thread Message Image|
8
- |[**deleteThreadMessageImage**](#deletethreadmessageimage) | **DELETE** /threads/{threadId}/messages/{messageId}/images/{imageId} | Delete Thread Message Image|
9
- |[**getThreadMessageImages**](#getthreadmessageimages) | **GET** /threads/{threadId}/messages/{messageId}/images | Get Thread Message Images|
7
+ |[**createThreadMessageImage**](#createthreadmessageimage) | **POST** /threads/{threadId}/messages/{messageId}/images/{imageId} | Attach an image to a thread message|
8
+ |[**deleteThreadMessageImage**](#deletethreadmessageimage) | **DELETE** /threads/{threadId}/messages/{messageId}/images/{imageId} | Remove an image from a thread message|
9
+ |[**getThreadMessageImages**](#getthreadmessageimages) | **GET** /threads/{threadId}/messages/{messageId}/images | List a thread message\'s attached images|
10
10
 
11
11
  # **createThreadMessageImage**
12
12
  > CreateThreadMessage200Response createThreadMessageImage()
13
13
 
14
- Create Thread Message Image endpoint
14
+ Connects an existing uploaded image, identified by imageId, to the thread message identified by messageId within the given threadId and returns the updated message; requires update permission on threads and storage.
15
15
 
16
16
  ### Example
17
17
 
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createThreadMessageImage(
68
68
  # **deleteThreadMessageImage**
69
69
  > CreateAccountInvitations200Response deleteThreadMessageImage()
70
70
 
71
- Delete Thread Message Image endpoint
71
+ Disconnects the image identified by imageId from the thread message identified by messageId within the given threadId, without deleting the underlying image; requires update permission on threads and storage.
72
72
 
73
73
  ### Example
74
74
 
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.deleteThreadMessageImage(
125
125
  # **getThreadMessageImages**
126
126
  > GetThreadMessageImages200Response getThreadMessageImages()
127
127
 
128
- Get Thread Message Images endpoint
128
+ Returns a paginated list of images attached to the given thread message, supporting search and ordering; requires read permission on threads and storage.
129
129
 
130
130
  ### Example
131
131
 
@@ -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
- |[**createThreadMessageReaction**](#createthreadmessagereaction) | **POST** /threads/{threadId}/messages/{messageId}/reactions | Create Thread Message Reaction|
8
- |[**deleteThreadMessageReaction**](#deletethreadmessagereaction) | **DELETE** /threads/{threadId}/messages/{messageId}/reactions/{reactionId} | Delete Thread Message Reaction|
9
- |[**getThreadMessageReactions**](#getthreadmessagereactions) | **GET** /threads/{threadId}/messages/{messageId}/reactions | Get Thread Message Reactions|
7
+ |[**createThreadMessageReaction**](#createthreadmessagereaction) | **POST** /threads/{threadId}/messages/{messageId}/reactions | Add a reaction to a thread message|
8
+ |[**deleteThreadMessageReaction**](#deletethreadmessagereaction) | **DELETE** /threads/{threadId}/messages/{messageId}/reactions/{reactionId} | Remove a reaction from a thread message|
9
+ |[**getThreadMessageReactions**](#getthreadmessagereactions) | **GET** /threads/{threadId}/messages/{messageId}/reactions | List a thread message\'s reactions|
10
10
 
11
11
  # **createThreadMessageReaction**
12
12
  > CreateThreadMessageReaction200Response createThreadMessageReaction()
13
13
 
14
- Create Thread Message Reaction endpoint
14
+ Creates an emoji reaction from the given accountId on the thread message identified by messageId within the given threadId and returns the created reaction; requires update permission on threads.
15
15
 
16
16
  ### Example
17
17
 
@@ -72,7 +72,7 @@ const { status, data } = await apiInstance.createThreadMessageReaction(
72
72
  # **deleteThreadMessageReaction**
73
73
  > CreateAccountInvitations200Response deleteThreadMessageReaction()
74
74
 
75
- Delete Thread Message Reaction endpoint
75
+ Deletes a specific emoji reaction from a message in a thread; requires the \"read\" and \"update\" permissions on threads.
76
76
 
77
77
  ### Example
78
78
 
@@ -129,7 +129,7 @@ const { status, data } = await apiInstance.deleteThreadMessageReaction(
129
129
  # **getThreadMessageReactions**
130
130
  > GetThreadMessageReactions200Response getThreadMessageReactions()
131
131
 
132
- Get Thread Message Reactions endpoint
132
+ Returns a paginated list of reactions left on the given thread message, supporting ordering; requires read permission on threads.
133
133
 
134
134
  ### Example
135
135
 
@@ -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
- |[**createThreadMessageVideo**](#createthreadmessagevideo) | **POST** /threads/{threadId}/messages/{messageId}/videos/{videoId} | Create Thread Message Video|
8
- |[**deleteThreadMessageVideo**](#deletethreadmessagevideo) | **DELETE** /threads/{threadId}/messages/{messageId}/videos/{videoId} | Delete Thread Message Video|
9
- |[**getThreadMessageVideos**](#getthreadmessagevideos) | **GET** /threads/{threadId}/messages/{messageId}/videos | Get Thread Message Videos|
7
+ |[**createThreadMessageVideo**](#createthreadmessagevideo) | **POST** /threads/{threadId}/messages/{messageId}/videos/{videoId} | Attach a video to a thread message|
8
+ |[**deleteThreadMessageVideo**](#deletethreadmessagevideo) | **DELETE** /threads/{threadId}/messages/{messageId}/videos/{videoId} | Detach a video from a thread message|
9
+ |[**getThreadMessageVideos**](#getthreadmessagevideos) | **GET** /threads/{threadId}/messages/{messageId}/videos | List a thread message\'s attached videos|
10
10
 
11
11
  # **createThreadMessageVideo**
12
12
  > CreateThreadMessage200Response createThreadMessageVideo()
13
13
 
14
- Create Thread Message Video endpoint
14
+ Connects an existing uploaded video to a message in a thread; requires the \"read\" and \"update\" permissions on both threads and storage.
15
15
 
16
16
  ### Example
17
17
 
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createThreadMessageVideo(
68
68
  # **deleteThreadMessageVideo**
69
69
  > CreateAccountInvitations200Response deleteThreadMessageVideo()
70
70
 
71
- Delete Thread Message Video endpoint
71
+ Disconnects a previously attached video from a message in a thread without deleting the underlying video file; requires the \"read\" and \"update\" permissions on both threads and storage.
72
72
 
73
73
  ### Example
74
74
 
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.deleteThreadMessageVideo(
125
125
  # **getThreadMessageVideos**
126
126
  > GetThreadMessageVideos200Response getThreadMessageVideos()
127
127
 
128
- Get Thread Message Videos endpoint
128
+ Returns a paginated list of videos attached to the given thread message, supporting search and ordering; requires read permission on threads and storage.
129
129
 
130
130
  ### Example
131
131
 
@@ -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
- |[**getThreadStorageFiles**](#getthreadstoragefiles) | **GET** /threads/{threadId}/storage/files | Get Thread Storage Files|
8
- |[**getThreadStorageImages**](#getthreadstorageimages) | **GET** /threads/{threadId}/storage/images | Get Thread Storage Images|
9
- |[**getThreadStorageVideos**](#getthreadstoragevideos) | **GET** /threads/{threadId}/storage/videos | Get Thread Storage Videos|
7
+ |[**getThreadStorageFiles**](#getthreadstoragefiles) | **GET** /threads/{threadId}/storage/files | List a thread\'s stored files|
8
+ |[**getThreadStorageImages**](#getthreadstorageimages) | **GET** /threads/{threadId}/storage/images | List images shared in a thread|
9
+ |[**getThreadStorageVideos**](#getthreadstoragevideos) | **GET** /threads/{threadId}/storage/videos | List videos shared in a thread|
10
10
 
11
11
  # **getThreadStorageFiles**
12
12
  > GetFiles200Response getThreadStorageFiles()
13
13
 
14
- Get Thread Storage Files endpoint
14
+ Returns a paginated list of files stored in the given thread\'s shared storage, supporting search; requires read permission on threads.
15
15
 
16
16
  ### Example
17
17
 
@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.getThreadStorageFiles(
74
74
  # **getThreadStorageImages**
75
75
  > GetEventPageImages200Response getThreadStorageImages()
76
76
 
77
- Get Thread Storage Images endpoint
77
+ Returns a paginated list of images attached to messages within the given thread, supporting search by image id, name, or description; requires read permission on threads.
78
78
 
79
79
  ### Example
80
80
 
@@ -137,7 +137,7 @@ const { status, data } = await apiInstance.getThreadStorageImages(
137
137
  # **getThreadStorageVideos**
138
138
  > GetStreamVideos200Response getThreadStorageVideos()
139
139
 
140
- Get Thread Storage Videos endpoint
140
+ Returns a paginated list of videos attached to messages within the given thread, supporting search by video id, name, or description; requires read permission on threads.
141
141
 
142
142
  ### Example
143
143
 
package/docs/TiersApi.md CHANGED
@@ -4,21 +4,21 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createTier**](#createtier) | **POST** /tiers | Create Tier|
8
- |[**deleteTier**](#deletetier) | **DELETE** /tiers/{tierId} | Delete Tier|
9
- |[**getTier**](#gettier) | **GET** /tiers/{tierId} | Get Tier|
10
- |[**getTierAccounts**](#gettieraccounts) | **GET** /tiers/{tierId}/accounts | Get Tier Accounts|
11
- |[**getTierImport**](#gettierimport) | **GET** /tiers/{tierId}/imports/{importId} | Get Tier Import|
12
- |[**getTierImportItems**](#gettierimportitems) | **GET** /tiers/{tierId}/imports/{importId}/items | Get Tier Import Items|
13
- |[**getTierImports**](#gettierimports) | **GET** /tiers/{tierId}/imports | Get Tier Imports|
14
- |[**getTiers**](#gettiers) | **GET** /tiers | Get Tiers|
15
- |[**removeTierAccounts**](#removetieraccounts) | **DELETE** /tiers/{tierId}/accounts | Remove Tier Accounts|
16
- |[**updateTier**](#updatetier) | **PUT** /tiers/{tierId} | Update Tier|
7
+ |[**createTier**](#createtier) | **POST** /tiers | Create a new account tier|
8
+ |[**deleteTier**](#deletetier) | **DELETE** /tiers/{tierId} | Delete an account tier|
9
+ |[**getTier**](#gettier) | **GET** /tiers/{tierId} | Get an account tier|
10
+ |[**getTierAccounts**](#gettieraccounts) | **GET** /tiers/{tierId}/accounts | List accounts assigned to a tier|
11
+ |[**getTierImport**](#gettierimport) | **GET** /tiers/{tierId}/imports/{importId} | Get an account tier import|
12
+ |[**getTierImportItems**](#gettierimportitems) | **GET** /tiers/{tierId}/imports/{importId}/items | List rows of an account tier import|
13
+ |[**getTierImports**](#gettierimports) | **GET** /tiers/{tierId}/imports | List account tier imports|
14
+ |[**getTiers**](#gettiers) | **GET** /tiers | List account tiers|
15
+ |[**removeTierAccounts**](#removetieraccounts) | **DELETE** /tiers/{tierId}/accounts | Remove all accounts from a tier|
16
+ |[**updateTier**](#updatetier) | **PUT** /tiers/{tierId} | Update an account tier|
17
17
 
18
18
  # **createTier**
19
19
  > CreateTier200Response createTier(tierCreateInputs)
20
20
 
21
- Create Tier endpoint
21
+ Creates a new account tier (membership level) for the organization, used to group accounts for access or pricing purposes; requires the \"read\" and \"create\" permissions on tiers.
22
22
 
23
23
  ### Example
24
24
 
@@ -70,7 +70,7 @@ const { status, data } = await apiInstance.createTier(
70
70
  # **deleteTier**
71
71
  > CreateAccountInvitations200Response deleteTier()
72
72
 
73
- Delete Tier endpoint
73
+ Permanently deletes the specified account tier from the organization, requiring the delete permission on tiers.
74
74
 
75
75
  ### Example
76
76
 
@@ -121,7 +121,7 @@ const { status, data } = await apiInstance.deleteTier(
121
121
  # **getTier**
122
122
  > CreateTier200Response getTier()
123
123
 
124
- Get Tier endpoint
124
+ Returns the details of a single account tier by id; requires read permission on tiers.
125
125
 
126
126
  ### Example
127
127
 
@@ -172,7 +172,7 @@ const { status, data } = await apiInstance.getTier(
172
172
  # **getTierAccounts**
173
173
  > GetAccounts200Response getTierAccounts()
174
174
 
175
- Get Tier Accounts endpoint
175
+ Returns a paginated list of accounts assigned to the given account tier, supporting search; requires read permission on both tiers and accounts.
176
176
 
177
177
  ### Example
178
178
 
@@ -235,7 +235,7 @@ const { status, data } = await apiInstance.getTierAccounts(
235
235
  # **getTierImport**
236
236
  > GetImport200Response getTierImport()
237
237
 
238
- Get Tier Import endpoint
238
+ Returns the details and status of a single account-tier bulk import job by id for the given tier; requires read permission on tiers.
239
239
 
240
240
  ### Example
241
241
 
@@ -289,7 +289,7 @@ const { status, data } = await apiInstance.getTierImport(
289
289
  # **getTierImportItems**
290
290
  > GetImportItems200Response getTierImportItems()
291
291
 
292
- Get Tier Import Items endpoint
292
+ Returns a paginated list of individual row items belonging to a given account-tier import job, including their processing status, supporting search; requires read permission on tiers.
293
293
 
294
294
  ### Example
295
295
 
@@ -355,7 +355,7 @@ const { status, data } = await apiInstance.getTierImportItems(
355
355
  # **getTierImports**
356
356
  > GetImports200Response getTierImports()
357
357
 
358
- Get Tier Imports endpoint
358
+ Returns a paginated list of bulk import jobs used to assign accounts to the given account tier, supporting search; requires read permission on tiers.
359
359
 
360
360
  ### Example
361
361
 
@@ -418,7 +418,7 @@ const { status, data } = await apiInstance.getTierImports(
418
418
  # **getTiers**
419
419
  > GetAccountTiers200Response getTiers()
420
420
 
421
- Get Tiers endpoint
421
+ Returns a paginated list of an organization\'s account tiers, optionally filtered by type (external or internal) and search; requires read permission on tiers.
422
422
 
423
423
  ### Example
424
424
 
@@ -481,7 +481,7 @@ const { status, data } = await apiInstance.getTiers(
481
481
  # **removeTierAccounts**
482
482
  > CreateTier200Response removeTierAccounts()
483
483
 
484
- Remove Tier Accounts endpoint
484
+ Unassigns every account currently associated with the given tier, clearing its account list entirely, and requires read/update permission on accounts plus read/delete permission on tiers.
485
485
 
486
486
  ### Example
487
487
 
@@ -532,7 +532,7 @@ const { status, data } = await apiInstance.removeTierAccounts(
532
532
  # **updateTier**
533
533
  > CreateTier200Response updateTier(tierUpdateInputs)
534
534
 
535
- Update Tier endpoint
535
+ Updates the fields of an existing account tier identified by tierId, requiring read and update permission on tiers.
536
536
 
537
537
  ### Example
538
538
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "7.5.0",
3
+ "version": "7.8.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {