@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,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createSeriesQuestionChoice**](#createseriesquestionchoice) | **POST** /series/{seriesId}/questions/{questionId}/choices | Create Series Question Choice|
8
- |[**deleteSeriesQuestionChoice**](#deleteseriesquestionchoice) | **DELETE** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Delete Series Question Choice|
9
- |[**reorderSeriesQuestionChoices**](#reorderseriesquestionchoices) | **PUT** /series/{seriesId}/questions/{questionId}/choices/reorder | Reorder Series Question Choices|
10
- |[**updateSeriesQuestionChoice**](#updateseriesquestionchoice) | **PUT** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Update Series Question Choice|
7
+ |[**createSeriesQuestionChoice**](#createseriesquestionchoice) | **POST** /series/{seriesId}/questions/{questionId}/choices | Add a choice to a series question|
8
+ |[**deleteSeriesQuestionChoice**](#deleteseriesquestionchoice) | **DELETE** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Delete a series question choice|
9
+ |[**reorderSeriesQuestionChoices**](#reorderseriesquestionchoices) | **PUT** /series/{seriesId}/questions/{questionId}/choices/reorder | Reorder a series question\'s choices|
10
+ |[**updateSeriesQuestionChoice**](#updateseriesquestionchoice) | **PUT** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Update a series question choice|
11
11
 
12
12
  # **createSeriesQuestionChoice**
13
13
  > CreateSeriesQuestionChoice200Response createSeriesQuestionChoice(seriesQuestionChoiceCreateInputs)
14
14
 
15
- Create Series Question Choice endpoint
15
+ Creates a new answer choice for a select/radio/checkbox question on a series, appending it to the end of the choice order unless a specific sortOrder is provided; requires update permission on events.
16
16
 
17
17
  ### Example
18
18
 
@@ -70,7 +70,7 @@ const { status, data } = await apiInstance.createSeriesQuestionChoice(
70
70
  # **deleteSeriesQuestionChoice**
71
71
  > CreateAccountInvitations200Response deleteSeriesQuestionChoice()
72
72
 
73
- Delete Series Question Choice endpoint
73
+ Permanently deletes an answer choice from a series question and re-sequences the sortOrder of the remaining choices; requires update permission on events.
74
74
 
75
75
  ### Example
76
76
 
@@ -127,7 +127,7 @@ const { status, data } = await apiInstance.deleteSeriesQuestionChoice(
127
127
  # **reorderSeriesQuestionChoices**
128
128
  > ReorderSeriesQuestionChoices200Response reorderSeriesQuestionChoices()
129
129
 
130
- Reorder Series Question Choices endpoint
130
+ Sets the display order of a series question\'s answer choices from a complete, ordered array of choice IDs; all existing choice IDs must be included or the request is rejected, and update permission on events is required.
131
131
 
132
132
  ### Example
133
133
 
@@ -184,7 +184,7 @@ const { status, data } = await apiInstance.reorderSeriesQuestionChoices(
184
184
  # **updateSeriesQuestionChoice**
185
185
  > CreateSeriesQuestionChoice200Response updateSeriesQuestionChoice()
186
186
 
187
- Update Series Question Choice endpoint
187
+ Updates the properties (such as label or value) of an existing answer choice on a series question, identified by seriesId, questionId, and choiceId; requires update permission on events.
188
188
 
189
189
  ### Example
190
190
 
@@ -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
- |[**getSeriesQuestionTranslation**](#getseriesquestiontranslation) | **GET** /series/{seriesId}/questions/{questionId}/translations/{locale} | Get Series Question Translation|
8
- |[**updateSeriesQuestionTranslation**](#updateseriesquestiontranslation) | **PUT** /series/{seriesId}/questions/{questionId}/translations/{locale} | Update Series Question Translation|
7
+ |[**getSeriesQuestionTranslation**](#getseriesquestiontranslation) | **GET** /series/{seriesId}/questions/{questionId}/translations/{locale} | Get a series question\'s translation|
8
+ |[**updateSeriesQuestionTranslation**](#updateseriesquestiontranslation) | **PUT** /series/{seriesId}/questions/{questionId}/translations/{locale} | Update a series question\'s translation|
9
9
 
10
10
  # **getSeriesQuestionTranslation**
11
11
  > GetSeriesQuestionTranslation200Response getSeriesQuestionTranslation()
12
12
 
13
- Get Series Question Translation endpoint
13
+ Returns the translated text for a series registration question in the given locale, requires the \"read\" permission on the events module.
14
14
 
15
15
  ### Example
16
16
 
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.getSeriesQuestionTranslation(
67
67
  # **updateSeriesQuestionTranslation**
68
68
  > UpdateSeriesQuestionTranslation200Response updateSeriesQuestionTranslation(seriesQuestionTranslationUpdateInputs)
69
69
 
70
- Update Series Question Translation endpoint
70
+ Creates or updates the localized text (e.g. label, description) for a series question in the given locale, upserting the translation record if it does not already exist; requires update permission on events.
71
71
 
72
72
  ### Example
73
73
 
@@ -4,20 +4,20 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**createSeriesRegistration**](#createseriesregistration) | **POST** /series/{seriesId}/registrations | Create Series Registration|
8
- |[**deleteSeriesRegistration**](#deleteseriesregistration) | **DELETE** /series/{seriesId}/registrations/{registrationId} | Delete Series Registration|
9
- |[**getSeriesRegistration**](#getseriesregistration) | **GET** /series/{seriesId}/registrations/{registrationId} | Get Series Registration|
10
- |[**getSeriesRegistrationPasses**](#getseriesregistrationpasses) | **GET** /series/{seriesId}/registrations/{registrationId}/passes | Get Series Registration Passes|
11
- |[**getSeriesRegistrationPayments**](#getseriesregistrationpayments) | **GET** /series/{seriesId}/registrations/{registrationId}/payments | Get Series Registration Payments|
12
- |[**getSeriesRegistrationResponses**](#getseriesregistrationresponses) | **GET** /series/{seriesId}/registrations/{registrationId}/responses | Get Series Registration Responses|
13
- |[**getSeriesRegistrations**](#getseriesregistrations) | **GET** /series/{seriesId}/registrations | Get Series Registrations|
14
- |[**updateSeriesRegistration**](#updateseriesregistration) | **PUT** /series/{seriesId}/registrations/{registrationId} | Update Series Registration|
15
- |[**updateSeriesRegistrationResponses**](#updateseriesregistrationresponses) | **PUT** /series/{seriesId}/registrations/{registrationId}/responses | Update Series Registration Responses|
7
+ |[**createSeriesRegistration**](#createseriesregistration) | **POST** /series/{seriesId}/registrations | Create a series registration|
8
+ |[**deleteSeriesRegistration**](#deleteseriesregistration) | **DELETE** /series/{seriesId}/registrations/{registrationId} | Delete a series registration|
9
+ |[**getSeriesRegistration**](#getseriesregistration) | **GET** /series/{seriesId}/registrations/{registrationId} | Get a series registration|
10
+ |[**getSeriesRegistrationPasses**](#getseriesregistrationpasses) | **GET** /series/{seriesId}/registrations/{registrationId}/passes | List a series registration\'s event passes|
11
+ |[**getSeriesRegistrationPayments**](#getseriesregistrationpayments) | **GET** /series/{seriesId}/registrations/{registrationId}/payments | List a series registration\'s payments|
12
+ |[**getSeriesRegistrationResponses**](#getseriesregistrationresponses) | **GET** /series/{seriesId}/registrations/{registrationId}/responses | Get a series registration\'s question responses|
13
+ |[**getSeriesRegistrations**](#getseriesregistrations) | **GET** /series/{seriesId}/registrations | List a series\' registrations|
14
+ |[**updateSeriesRegistration**](#updateseriesregistration) | **PUT** /series/{seriesId}/registrations/{registrationId} | Update a series registration\'s status|
15
+ |[**updateSeriesRegistrationResponses**](#updateseriesregistrationresponses) | **PUT** /series/{seriesId}/registrations/{registrationId}/responses | Update a series registration\'s question responses|
16
16
 
17
17
  # **createSeriesRegistration**
18
18
  > CreateSeriesRegistration200Response createSeriesRegistration(seriesRegistrationCreateInputs)
19
19
 
20
- Create Series Registration endpoint
20
+ Registers an account for a series (which must have registration enabled), creating the registration with a \"ready\" status when done by an admin; requires read and create permissions on events.
21
21
 
22
22
  ### Example
23
23
 
@@ -72,7 +72,7 @@ const { status, data } = await apiInstance.createSeriesRegistration(
72
72
  # **deleteSeriesRegistration**
73
73
  > CreateAccountInvitations200Response deleteSeriesRegistration()
74
74
 
75
- Delete Series Registration endpoint
75
+ Permanently deletes an account\'s registration for a series, identified by seriesId and registrationId; requires read and delete permissions on events.
76
76
 
77
77
  ### Example
78
78
 
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.deleteSeriesRegistration(
126
126
  # **getSeriesRegistration**
127
127
  > CreateSeriesRegistration200Response getSeriesRegistration()
128
128
 
129
- Get Series Registration endpoint
129
+ Returns a single registration record for the given series, identified by its registration ID, requires the \"read\" permission on the events module.
130
130
 
131
131
  ### Example
132
132
 
@@ -180,7 +180,7 @@ const { status, data } = await apiInstance.getSeriesRegistration(
180
180
  # **getSeriesRegistrationPasses**
181
181
  > GetEventAddOnPasses200Response getSeriesRegistrationPasses()
182
182
 
183
- Get Series Registration Passes endpoint
183
+ Returns a paginated list of event passes issued under a given series registration, supporting search and ordering, requires the \"read\" permission on both the events and attendees modules.
184
184
 
185
185
  ### Example
186
186
 
@@ -246,7 +246,7 @@ const { status, data } = await apiInstance.getSeriesRegistrationPasses(
246
246
  # **getSeriesRegistrationPayments**
247
247
  > GetAccountPayments200Response getSeriesRegistrationPayments()
248
248
 
249
- Get Series Registration Payments endpoint
249
+ Returns a paginated list of payment records associated with a given series registration, supporting search and ordering, requires the \"read\" permission on both the events and payments modules.
250
250
 
251
251
  ### Example
252
252
 
@@ -312,7 +312,7 @@ const { status, data } = await apiInstance.getSeriesRegistrationPayments(
312
312
  # **getSeriesRegistrationResponses**
313
313
  > GetSeriesRegistrationResponses200Response getSeriesRegistrationResponses()
314
314
 
315
- Get Series Registration Responses endpoint
315
+ Returns the registration question responses submitted for a given registration within a series, requiring read access to events and attendees.
316
316
 
317
317
  ### Example
318
318
 
@@ -366,7 +366,7 @@ const { status, data } = await apiInstance.getSeriesRegistrationResponses(
366
366
  # **getSeriesRegistrations**
367
367
  > GetSeriesRegistrations200Response getSeriesRegistrations()
368
368
 
369
- Get Series Registrations endpoint
369
+ Returns a paginated list of registrations for a series, supporting search, ordering, and filtering by purchase status, and requires read access to events.
370
370
 
371
371
  ### Example
372
372
 
@@ -432,7 +432,7 @@ const { status, data } = await apiInstance.getSeriesRegistrations(
432
432
  # **updateSeriesRegistration**
433
433
  > CreateSeriesRegistration200Response updateSeriesRegistration(seriesRegistrationUpdateInputs)
434
434
 
435
- Update Series Registration endpoint
435
+ Updates a registration under an event series, currently limited to changing its status, and requires \"update\" permission on events (as well as \"read\" permission on events).
436
436
 
437
437
  ### Example
438
438
 
@@ -490,7 +490,7 @@ const { status, data } = await apiInstance.updateSeriesRegistration(
490
490
  # **updateSeriesRegistrationResponses**
491
491
  > CreateAccountInvitations200Response updateSeriesRegistrationResponses(seriesRegistrationResponsesUpdateInputs)
492
492
 
493
- Update Series Registration Responses endpoint
493
+ Overwrites the registrant\'s question/answer responses for a registration on an event series, submitted on the registrant\'s behalf by an admin, and requires \"read\" permission on events plus \"read\" and \"update\" permission on attendees.
494
494
 
495
495
  ### Example
496
496
 
@@ -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
- |[**deleteSeriesTranslation**](#deleteseriestranslation) | **DELETE** /series/{seriesId}/translations/{locale} | Delete Series Translation|
8
- |[**getSeriesTranslation**](#getseriestranslation) | **GET** /series/{seriesId}/translations/{locale} | Get Series Translation|
9
- |[**getSeriesTranslations**](#getseriestranslations) | **GET** /series/{seriesId}/translations | Get Series Translations|
10
- |[**updateSeriesTranslation**](#updateseriestranslation) | **PUT** /series/{seriesId}/translations/{locale} | Update Series Translation|
7
+ |[**deleteSeriesTranslation**](#deleteseriestranslation) | **DELETE** /series/{seriesId}/translations/{locale} | Delete a series translation|
8
+ |[**getSeriesTranslation**](#getseriestranslation) | **GET** /series/{seriesId}/translations/{locale} | Get a series translation|
9
+ |[**getSeriesTranslations**](#getseriestranslations) | **GET** /series/{seriesId}/translations | List a series\' translations|
10
+ |[**updateSeriesTranslation**](#updateseriestranslation) | **PUT** /series/{seriesId}/translations/{locale} | Create or update a series translation|
11
11
 
12
12
  # **deleteSeriesTranslation**
13
13
  > SyncAccounts200Response deleteSeriesTranslation()
14
14
 
15
- Delete Series Translation endpoint
15
+ Deletes the translated content for an event series in the given locale, requiring \"read\" and \"del\" permission on events.
16
16
 
17
17
  ### Example
18
18
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.deleteSeriesTranslation(
66
66
  # **getSeriesTranslation**
67
67
  > GetSeriesTranslation200Response getSeriesTranslation()
68
68
 
69
- Get Series Translation endpoint
69
+ Returns the translated content for a series in the given locale, or null if no translation exists, and requires read access to events.
70
70
 
71
71
  ### Example
72
72
 
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.getSeriesTranslation(
120
120
  # **getSeriesTranslations**
121
121
  > GetSeriesTranslations200Response getSeriesTranslations()
122
122
 
123
- Get Series Translations endpoint
123
+ Returns a paginated list of locale translations available for a series, supporting search and ordering, and requires read access to events.
124
124
 
125
125
  ### Example
126
126
 
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getSeriesTranslations(
183
183
  # **updateSeriesTranslation**
184
184
  > SyncAccounts200Response updateSeriesTranslation(seriesTranslationUpdateInputs)
185
185
 
186
- Update Series Translation endpoint
186
+ Creates or updates the translated content for an event series in the given locale, requiring \"read\" and \"update\" permission on events.
187
187
 
188
188
  ### Example
189
189
 
@@ -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
- |[**addLevelAccount**](#addlevelaccount) | **POST** /levels/{levelId}/accounts/{accountId} | Add Level Account|
8
- |[**getLevelAccounts**](#getlevelaccounts) | **GET** /levels/{levelId}/accounts | Get Level Accounts|
9
- |[**removeLevelAccount**](#removelevelaccount) | **DELETE** /levels/{levelId}/accounts/{accountId} | Remove Level Account|
7
+ |[**addLevelAccount**](#addlevelaccount) | **POST** /levels/{levelId}/accounts/{accountId} | Add a sponsor account to a sponsorship level|
8
+ |[**getLevelAccounts**](#getlevelaccounts) | **GET** /levels/{levelId}/accounts | List accounts on a sponsorship level|
9
+ |[**removeLevelAccount**](#removelevelaccount) | **DELETE** /levels/{levelId}/accounts/{accountId} | Remove an account from a sponsorship level|
10
10
 
11
11
  # **addLevelAccount**
12
12
  > CreateLevel200Response addLevelAccount()
13
13
 
14
- Add Level Account endpoint
14
+ Attaches an account as a sponsor at the given sponsorship level, requiring \"read\" and \"update\" permission on both sponsors and accounts.
15
15
 
16
16
  ### Example
17
17
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addLevelAccount(
65
65
  # **getLevelAccounts**
66
66
  > GetAccounts200Response getLevelAccounts()
67
67
 
68
- Get Level Accounts endpoint
68
+ Returns a paginated list of accounts (sponsors) assigned to a sponsorship level, supporting search, and requires read access to both sponsors and accounts.
69
69
 
70
70
  ### Example
71
71
 
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getLevelAccounts(
128
128
  # **removeLevelAccount**
129
129
  > CreateLevel200Response removeLevelAccount()
130
130
 
131
- Remove Level Account endpoint
131
+ Removes the given account as a sponsor from the specified sponsorship level and returns the updated level; requires update permission on both sponsors and accounts.
132
132
 
133
133
  ### Example
134
134
 
@@ -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
- |[**createLevel**](#createlevel) | **POST** /levels | Create Level|
8
- |[**deleteLevel**](#deletelevel) | **DELETE** /levels/{levelId} | Delete Level|
9
- |[**getLevel**](#getlevel) | **GET** /levels/{sponsorshipLevelId} | Get Level|
10
- |[**getLevels**](#getlevels) | **GET** /levels | Get Levels|
11
- |[**updateLevel**](#updatelevel) | **PUT** /levels/{levelId} | Update Level|
7
+ |[**createLevel**](#createlevel) | **POST** /levels | Create a sponsorship level|
8
+ |[**deleteLevel**](#deletelevel) | **DELETE** /levels/{levelId} | Delete a sponsorship level|
9
+ |[**getLevel**](#getlevel) | **GET** /levels/{sponsorshipLevelId} | Get a sponsorship level|
10
+ |[**getLevels**](#getlevels) | **GET** /levels | List sponsorship levels|
11
+ |[**updateLevel**](#updatelevel) | **PUT** /levels/{levelId} | Update a sponsorship level|
12
12
 
13
13
  # **createLevel**
14
14
  > CreateLevel200Response createLevel(levelCreateInputs)
15
15
 
16
- Create Level endpoint
16
+ Creates a new sponsorship level for the organization from the provided details, requiring create permission on sponsors.
17
17
 
18
18
  ### Example
19
19
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createLevel(
65
65
  # **deleteLevel**
66
66
  > CreateAccountInvitations200Response deleteLevel()
67
67
 
68
- Delete Level endpoint
68
+ Permanently deletes the specified sponsorship level from the organization, requiring delete permission on sponsors.
69
69
 
70
70
  ### Example
71
71
 
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.deleteLevel(
116
116
  # **getLevel**
117
117
  > CreateLevel200Response getLevel()
118
118
 
119
- Get Level endpoint
119
+ Returns the details of a single sponsorship level by ID; requires \"read\" permission on \"sponsors\".
120
120
 
121
121
  ### Example
122
122
 
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getLevel(
167
167
  # **getLevels**
168
168
  > GetAccountLevels200Response getLevels()
169
169
 
170
- Get Levels endpoint
170
+ Returns a paginated list of the organization\'s sponsorship levels, with support for search and ordering; requires \"read\" permission on \"sponsors\".
171
171
 
172
172
  ### Example
173
173
 
@@ -227,7 +227,7 @@ const { status, data } = await apiInstance.getLevels(
227
227
  # **updateLevel**
228
228
  > CreateLevel200Response updateLevel()
229
229
 
230
- Update Level endpoint
230
+ Updates the details of an existing sponsorship level, such as its name, pricing, or benefits, requiring update permission on sponsors.
231
231
 
232
232
  ### Example
233
233
 
@@ -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
- |[**deleteLevelTranslation**](#deleteleveltranslation) | **DELETE** /levels/{levelId}/translations/{locale} | Delete Level Translation|
8
- |[**getLevelTranslation**](#getleveltranslation) | **GET** /levels/{levelId}/translations/{locale} | Get Level Translation|
9
- |[**getLevelTranslations**](#getleveltranslations) | **GET** /levels/{levelId}/translations | Get Level Translations|
10
- |[**updateLevelTranslation**](#updateleveltranslation) | **PUT** /levels/{levelId}/translations/{locale} | Update Level Translation|
7
+ |[**deleteLevelTranslation**](#deleteleveltranslation) | **DELETE** /levels/{levelId}/translations/{locale} | Delete a sponsorship level translation|
8
+ |[**getLevelTranslation**](#getleveltranslation) | **GET** /levels/{levelId}/translations/{locale} | Get a sponsorship level translation|
9
+ |[**getLevelTranslations**](#getleveltranslations) | **GET** /levels/{levelId}/translations | List a sponsorship level\'s translations|
10
+ |[**updateLevelTranslation**](#updateleveltranslation) | **PUT** /levels/{levelId}/translations/{locale} | Update a sponsorship level translation|
11
11
 
12
12
  # **deleteLevelTranslation**
13
13
  > SyncAccounts200Response deleteLevelTranslation()
14
14
 
15
- Delete Level Translation endpoint
15
+ Removes the translation for the given locale on the specified sponsorship level, requiring update permission on sponsors.
16
16
 
17
17
  ### Example
18
18
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.deleteLevelTranslation(
66
66
  # **getLevelTranslation**
67
67
  > GetLevelTranslation200Response getLevelTranslation()
68
68
 
69
- Get Level Translation endpoint
69
+ Returns the translated content for a sponsorship level in the given locale, or null if no translation exists, and requires read access to sponsors.
70
70
 
71
71
  ### Example
72
72
 
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.getLevelTranslation(
120
120
  # **getLevelTranslations**
121
121
  > GetLevelTranslations200Response getLevelTranslations()
122
122
 
123
- Get Level Translations endpoint
123
+ Returns a paginated list of locale translations for the given sponsorship level, supporting search and ordering; requires \"read\" permission on \"sponsors\".
124
124
 
125
125
  ### Example
126
126
 
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getLevelTranslations(
183
183
  # **updateLevelTranslation**
184
184
  > SyncAccounts200Response updateLevelTranslation(levelTranslationUpdateInputs)
185
185
 
186
- Update Level Translation endpoint
186
+ Creates or updates the localized name and description for a sponsorship level in the given locale, requiring update permission on sponsors.
187
187
 
188
188
  ### Example
189
189
 
@@ -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
- |[**getFile**](#getfile) | **GET** /files/{fileId} | Get File|
8
- |[**getFiles**](#getfiles) | **GET** /files | Get Files|
9
- |[**uploadFile**](#uploadfile) | **POST** /files | Upload File|
7
+ |[**getFile**](#getfile) | **GET** /files/{fileId} | Get a stored file|
8
+ |[**getFiles**](#getfiles) | **GET** /files | List stored files|
9
+ |[**uploadFile**](#uploadfile) | **POST** /files | Upload a file from a data URI|
10
10
 
11
11
  # **getFile**
12
12
  > UploadFile200Response getFile()
13
13
 
14
- Get File endpoint
14
+ Returns the details of a single uploaded file by ID; requires \"read\" permission on \"storage\".
15
15
 
16
16
  ### Example
17
17
 
@@ -62,7 +62,7 @@ const { status, data } = await apiInstance.getFile(
62
62
  # **getFiles**
63
63
  > GetFiles200Response getFiles()
64
64
 
65
- Get Files endpoint
65
+ Returns a paginated list of uploaded files for the organization, optionally filtered by source and searched/ordered; requires \"read\" permission on \"storage\".
66
66
 
67
67
  ### Example
68
68
 
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.getFiles(
125
125
  # **uploadFile**
126
126
  > UploadFile200Response uploadFile()
127
127
 
128
- Upload File endpoint
128
+ Uploads a file encoded as a base64 data URI directly to storage and records it, tagging it with the given source (\"admin\" or \"response\") and optional name, requiring create permission on storage.
129
129
 
130
130
  ### Example
131
131
 
@@ -4,20 +4,20 @@ All URIs are relative to *https://admin-api.connected.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**confirmImageUpload**](#confirmimageupload) | **POST** /images/{imageId}/confirm | Confirm Image Upload|
8
- |[**deleteImage**](#deleteimage) | **DELETE** /images/{imageId} | Delete Image|
9
- |[**deleteManyImages**](#deletemanyimages) | **POST** /images/delete | Delete Many Images|
10
- |[**getImage**](#getimage) | **GET** /images/{imageId} | Get Image|
11
- |[**getImageUsage**](#getimageusage) | **GET** /images/{imageId}/usage | Get Image Usage|
12
- |[**getImages**](#getimages) | **GET** /images | Get Images|
13
- |[**requestImageDirectUpload**](#requestimagedirectupload) | **POST** /images/direct-upload | Request Image Direct Upload|
14
- |[**switchImage**](#switchimage) | **PUT** /images/{imageId}/switch | Switch Image|
15
- |[**updateImage**](#updateimage) | **PUT** /images/{imageId} | Update Image|
7
+ |[**confirmImageUpload**](#confirmimageupload) | **POST** /images/{imageId}/confirm | Confirm a completed direct image upload|
8
+ |[**deleteImage**](#deleteimage) | **DELETE** /images/{imageId} | Delete an image|
9
+ |[**deleteManyImages**](#deletemanyimages) | **POST** /images/delete | Delete multiple images|
10
+ |[**getImage**](#getimage) | **GET** /images/{imageId} | Get an image|
11
+ |[**getImageUsage**](#getimageusage) | **GET** /images/{imageId}/usage | Get an image\'s usage|
12
+ |[**getImages**](#getimages) | **GET** /images | List stored images|
13
+ |[**requestImageDirectUpload**](#requestimagedirectupload) | **POST** /images/direct-upload | Request a direct image upload URL|
14
+ |[**switchImage**](#switchimage) | **PUT** /images/{imageId}/switch | Replace an image\'s file contents|
15
+ |[**updateImage**](#updateimage) | **PUT** /images/{imageId} | Update an image\'s metadata|
16
16
 
17
17
  # **confirmImageUpload**
18
18
  > GetImage200Response confirmImageUpload()
19
19
 
20
- Confirm Image Upload endpoint
20
+ Verifies that a previously requested direct upload has finished landing on storage and finalizes the image record, requiring create permission on storage.
21
21
 
22
22
  ### Example
23
23
 
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.confirmImageUpload(
68
68
  # **deleteImage**
69
69
  > CreateAccountInvitations200Response deleteImage()
70
70
 
71
- Delete Image endpoint
71
+ Permanently deletes the specified image from storage and the CDN, requiring delete permission on storage.
72
72
 
73
73
  ### Example
74
74
 
@@ -119,7 +119,7 @@ const { status, data } = await apiInstance.deleteImage(
119
119
  # **deleteManyImages**
120
120
  > CreateAccountInvitations200Response deleteManyImages(deleteManyImagesInput)
121
121
 
122
- Delete Many Images endpoint
122
+ Permanently deletes up to 50 images identified by their IDs from storage and the CDN in a single request, requiring delete permission on storage.
123
123
 
124
124
  ### Example
125
125
 
@@ -171,7 +171,7 @@ const { status, data } = await apiInstance.deleteManyImages(
171
171
  # **getImage**
172
172
  > GetImage200Response getImage()
173
173
 
174
- Get Image endpoint
174
+ Returns the details of a single stored image by ID; requires \"read\" permission on \"storage\".
175
175
 
176
176
  ### Example
177
177
 
@@ -222,7 +222,7 @@ const { status, data } = await apiInstance.getImage(
222
222
  # **getImageUsage**
223
223
  > GetImageUsage200Response getImageUsage()
224
224
 
225
- Get Image Usage endpoint
225
+ Returns the accounts, events, sessions, and other resources that reference the given image, so it can be checked for usage before deletion; requires \"read\" permission on \"storage\".
226
226
 
227
227
  ### Example
228
228
 
@@ -273,7 +273,7 @@ const { status, data } = await apiInstance.getImageUsage(
273
273
  # **getImages**
274
274
  > GetImages200Response getImages()
275
275
 
276
- Get Images endpoint
276
+ Returns a paginated list of the organization\'s stored images, optionally filtered by image type and searched/ordered; requires \"read\" permission on \"storage\".
277
277
 
278
278
  ### Example
279
279
 
@@ -336,7 +336,7 @@ const { status, data } = await apiInstance.getImages(
336
336
  # **requestImageDirectUpload**
337
337
  > RequestImageDirectUpload200Response requestImageDirectUpload(imageDirectUploadInputs)
338
338
 
339
- Request Image Direct Upload endpoint
339
+ Creates an unconfirmed image record and returns a one-time Cloudflare upload URL so the client can upload the raw image bytes directly, bypassing the API; requires the create and read permissions on the storage module, and the image must be confirmed afterward before it is finalized.
340
340
 
341
341
  ### Example
342
342
 
@@ -388,7 +388,7 @@ const { status, data } = await apiInstance.requestImageDirectUpload(
388
388
  # **switchImage**
389
389
  > GetImage200Response switchImage()
390
390
 
391
- Switch Image endpoint
391
+ Replaces the underlying file for an existing image record with a newly uploaded image (jpeg, png, heic, or heif), re-deriving its dimensions and moderation level while keeping the same image ID; requires the update and read permissions on the storage module.
392
392
 
393
393
  ### Example
394
394
 
@@ -442,7 +442,7 @@ const { status, data } = await apiInstance.switchImage(
442
442
  # **updateImage**
443
443
  > GetImage200Response updateImage(imageUpdateInputs)
444
444
 
445
- Update Image endpoint
445
+ Updates the name, description, and/or type of an existing image record without altering its underlying file; requires the update and read permissions on the storage module.
446
446
 
447
447
  ### Example
448
448
 
@@ -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
- |[**deleteManyVideos**](#deletemanyvideos) | **POST** /videos/delete | Delete Many Videos|
8
- |[**deleteVideo**](#deletevideo) | **DELETE** /videos/{videoId} | Delete Video|
9
- |[**getVideo**](#getvideo) | **GET** /videos/{videoId} | Get Video|
10
- |[**getVideoDownloadStatus**](#getvideodownloadstatus) | **GET** /videos/{videoId}/downloads | Get Video Download Status|
11
- |[**getVideos**](#getvideos) | **GET** /videos | Get Videos|
12
- |[**initiateVideoDownload**](#initiatevideodownload) | **POST** /videos/{videoId}/downloads | Initiate Video Download|
13
- |[**updateVideo**](#updatevideo) | **PUT** /videos/{videoId} | Update Video|
7
+ |[**deleteManyVideos**](#deletemanyvideos) | **POST** /videos/delete | Delete multiple videos|
8
+ |[**deleteVideo**](#deletevideo) | **DELETE** /videos/{videoId} | Delete a video|
9
+ |[**getVideo**](#getvideo) | **GET** /videos/{videoId} | Get a video|
10
+ |[**getVideoDownloadStatus**](#getvideodownloadstatus) | **GET** /videos/{videoId}/downloads | Get a video\'s MP4 download status|
11
+ |[**getVideos**](#getvideos) | **GET** /videos | List an organization\'s videos|
12
+ |[**initiateVideoDownload**](#initiatevideodownload) | **POST** /videos/{videoId}/downloads | Start MP4 download preparation for a video|
13
+ |[**updateVideo**](#updatevideo) | **PUT** /videos/{videoId} | Update a video\'s metadata|
14
14
 
15
15
  # **deleteManyVideos**
16
16
  > CreateAccountInvitations200Response deleteManyVideos(deleteManyVideosInput)
17
17
 
18
- Delete Many Videos endpoint
18
+ Deletes up to 10 videos at once, removing each from Cloudflare Stream and the database; requires the delete and read permissions on the storage module.
19
19
 
20
20
  ### Example
21
21
 
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.deleteManyVideos(
67
67
  # **deleteVideo**
68
68
  > CreateAccountInvitations200Response deleteVideo()
69
69
 
70
- Delete Video endpoint
70
+ Deletes a single video, removing it from Cloudflare Stream and the database; requires the delete and read permissions on the storage module.
71
71
 
72
72
  ### Example
73
73
 
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.deleteVideo(
118
118
  # **getVideo**
119
119
  > GetVideo200Response getVideo()
120
120
 
121
- Get Video endpoint
121
+ Returns the details of a single stored video by ID; requires \"read\" permission on \"storage\".
122
122
 
123
123
  ### Example
124
124
 
@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.getVideo(
169
169
  # **getVideoDownloadStatus**
170
170
  > SyncAccounts200Response getVideoDownloadStatus()
171
171
 
172
- Get Video Download Status endpoint
172
+ Returns the current status of a Cloudflare Stream MP4 download preparation for the given video, including percent complete and, once ready, the download URL; requires read permission on storage.
173
173
 
174
174
  ### Example
175
175
 
@@ -220,7 +220,7 @@ const { status, data } = await apiInstance.getVideoDownloadStatus(
220
220
  # **getVideos**
221
221
  > GetStreamVideos200Response getVideos()
222
222
 
223
- Get Videos endpoint
223
+ Returns a paginated list of the organization\'s uploaded and recorded videos, filterable by source (e.g. upload origin) and free-text search, and orderable via the orderBy param; requires read permission on storage.
224
224
 
225
225
  ### Example
226
226
 
@@ -283,7 +283,7 @@ const { status, data } = await apiInstance.getVideos(
283
283
  # **initiateVideoDownload**
284
284
  > SyncAccounts200Response initiateVideoDownload()
285
285
 
286
- Initiate Video Download endpoint
286
+ Requests Cloudflare Stream to begin generating a downloadable MP4 rendition of the video and stores the resulting download URL once ready; requires the update and read permissions on the storage module.
287
287
 
288
288
  ### Example
289
289
 
@@ -334,7 +334,7 @@ const { status, data } = await apiInstance.initiateVideoDownload(
334
334
  # **updateVideo**
335
335
  > GetVideo200Response updateVideo(videoUpdateInputs)
336
336
 
337
- Update Video endpoint
337
+ Updates the name and/or thumbnail timestamp percentage of a video (identified by videoId) and syncs the change to the underlying Cloudflare Stream asset; requires the update permission on storage.
338
338
 
339
339
  ### Example
340
340