@connectedxm/admin-sdk 7.5.0 → 7.8.0

package/docs/ReportsApi.md

@@ -4,22 +4,22 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**createCustomReport**](#createcustomreport) | **POST** /reports/{standard} | Create Custom Report|
-|[**deleteCustomReport**](#deletecustomreport) | **DELETE** /reports/custom/{reportId} | Delete Custom Report|
-|[**deleteCustomReportSchedule**](#deletecustomreportschedule) | **DELETE** /reports/custom/{reportId}/schedule | Delete Custom Report Schedule|
-|[**exportCustomReport**](#exportcustomreport) | **POST** /reports/custom/{reportId}/export | Export Custom Report|
-|[**getCustomReport**](#getcustomreport) | **GET** /reports/custom/{reportId} | Get Custom Report|
-|[**getCustomReportSchedule**](#getcustomreportschedule) | **GET** /reports/custom/{reportId}/schedule | Get Custom Report Schedule|
-|[**getCustomReports**](#getcustomreports) | **GET** /reports/custom | Get Custom Reports|
-|[**getReport**](#getreport) | **GET** /reports/{standard} | Get Report|
-|[**getReports**](#getreports) | **GET** /reports | Get Reports|
-|[**updateCustomReport**](#updatecustomreport) | **PUT** /reports/custom/{reportId} | Update Custom Report|
-|[**upsertCustomReportSchedule**](#upsertcustomreportschedule) | **POST** /reports/custom/{reportId}/schedule | Upsert Custom Report Schedule|
+|[**createCustomReport**](#createcustomreport) | **POST** /reports/{standard} | Create a custom report from a standard report|
+|[**deleteCustomReport**](#deletecustomreport) | **DELETE** /reports/custom/{reportId} | Delete a custom report|
+|[**deleteCustomReportSchedule**](#deletecustomreportschedule) | **DELETE** /reports/custom/{reportId}/schedule | Delete a custom report\'s schedule|
+|[**exportCustomReport**](#exportcustomreport) | **POST** /reports/custom/{reportId}/export | Export a custom report|
+|[**getCustomReport**](#getcustomreport) | **GET** /reports/custom/{reportId} | Get a custom report\'s configuration|
+|[**getCustomReportSchedule**](#getcustomreportschedule) | **GET** /reports/custom/{reportId}/schedule | Get a custom report\'s send schedule|
+|[**getCustomReports**](#getcustomreports) | **GET** /reports/custom | List an organization\'s custom reports|
+|[**getReport**](#getreport) | **GET** /reports/{standard} | Run a standard report and fetch all its rows|
+|[**getReports**](#getreports) | **GET** /reports | List available standard reports|
+|[**updateCustomReport**](#updatecustomreport) | **PUT** /reports/custom/{reportId} | Update a custom report|
+|[**upsertCustomReportSchedule**](#upsertcustomreportschedule) | **POST** /reports/custom/{reportId}/schedule | Create or update a custom report\'s schedule|
 
 # **createCustomReport**
 > GetCustomReport200Response createCustomReport(customReportCreateInputs)
 
-Create Custom Report endpoint
+Creates a new saved custom report based on the given standard report definition, with the caller\'s chosen name, filters, and columns, requires read and create permissions on reports.
 
 ### Example
 
@@ -74,7 +74,7 @@ const { status, data } = await apiInstance.createCustomReport(
 # **deleteCustomReport**
 > CreateAccountInvitations200Response deleteCustomReport()
 
-Delete Custom Report endpoint
+Permanently deletes a custom report by ID, along with its AWS EventBridge schedule if one exists; only the report\'s owning user may delete it, and this requires the delete permission on the reports domain.
 
 ### Example
 
@@ -125,7 +125,7 @@ const { status, data } = await apiInstance.deleteCustomReport(
 # **deleteCustomReportSchedule**
 > GetCustomReportSchedule200Response deleteCustomReportSchedule()
 
-Delete Custom Report Schedule endpoint
+Removes the recurring email schedule for a custom report, deleting the underlying AWS EventBridge schedule and clearing it from the report record; only the report owner or an authorized shared user may remove it, and this requires the update permission on the reports domain.
 
 ### Example
 
@@ -176,7 +176,7 @@ const { status, data } = await apiInstance.deleteCustomReportSchedule(
 # **exportCustomReport**
 > CreateAccountInvitations200Response exportCustomReport(customReportExportInputs)
 
-Export Custom Report endpoint
+Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
 
 ### Example
 
@@ -231,7 +231,7 @@ const { status, data } = await apiInstance.exportCustomReport(
 # **getCustomReport**
 > GetCustomReport200Response getCustomReport()
 
-Get Custom Report endpoint
+Retrieves the saved configuration for a single custom report by ID, including the underlying standard report it is built from and its settings; requires read permission on the reports resource.
 
 ### Example
 
@@ -282,7 +282,7 @@ const { status, data } = await apiInstance.getCustomReport(
 # **getCustomReportSchedule**
 > GetCustomReportSchedule200Response getCustomReportSchedule()
 
-Get Custom Report Schedule endpoint
+Retrieves the recurring email delivery schedule configured for a custom report, including its cron expression, timezone, and recipient emails, or null if no schedule is set; requires read permission on the reports resource.
 
 ### Example
 
@@ -333,7 +333,7 @@ const { status, data } = await apiInstance.getCustomReportSchedule(
 # **getCustomReports**
 > GetCustomReports200Response getCustomReports()
 
-Get Custom Reports endpoint
+Returns a paginated, searchable list of custom report configurations saved for the current organization, matching on report name and supporting additional filters and sorting via orderBy; requires read permission on the reports resource.
 
 ### Example
 
@@ -397,7 +397,7 @@ const { status, data } = await apiInstance.getCustomReports(
 # **getReport**
 > GetReport200Response getReport()
 
-Get Report endpoint
+Executes the named standard report definition with the given filters and automatically pages through cursor-based results to return the complete row set; access is restricted to the domain permissions declared by that specific standard report, in addition to read permission on the reports resource.
 
 ### Example
 
@@ -452,7 +452,7 @@ const { status, data } = await apiInstance.getReport(
 # **getReports**
 > GetReports200Response getReports()
 
-Get Reports endpoint
+Returns the list of standard reports available to the organization, filtered by report type and further filtered to only those reports whose required permission domains the caller can read; requires the `read:reports` permission.
 
 ### Example
 
@@ -503,7 +503,7 @@ const { status, data } = await apiInstance.getReports(
 # **updateCustomReport**
 > GetCustomReport200Response updateCustomReport()
 
-Update Custom Report endpoint
+Updates the configuration (filters, name, sharing settings, etc.) of an existing custom report; only the report owner, or a shared user when the report isn\'t restricted to specific users, may update it, and changing the shared setting itself is restricted to the owner, requiring the update permission on the reports domain.
 
 ### Example
 
@@ -558,7 +558,7 @@ const { status, data } = await apiInstance.updateCustomReport(
 # **upsertCustomReportSchedule**
 > UpsertCustomReportSchedule200Response upsertCustomReportSchedule(customReportScheduleInputs)
 
-Upsert Custom Report Schedule endpoint
+Creates or updates a recurring email schedule for a custom report by provisioning an AWS EventBridge schedule with the given cron/rate expression, timezone, and recipient emails; only the report owner or an authorized shared user may set the schedule, and this requires read permission on the reports domain plus any domains tied to the report\'s standard type.
 
 ### Example
 

package/docs/ReportsUsersApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**addCustomReportUser**](#addcustomreportuser) | **POST** /reports/custom/{reportId}/users | Add Custom Report User|
-|[**getCustomReportUsers**](#getcustomreportusers) | **GET** /reports/custom/{reportId}/users | Get Custom Report Users|
-|[**removeCustomReportUser**](#removecustomreportuser) | **DELETE** /reports/custom/{reportId}/users/{userId} | Remove Custom Report User|
+|[**addCustomReportUser**](#addcustomreportuser) | **POST** /reports/custom/{reportId}/users | Share a custom report with a user|
+|[**getCustomReportUsers**](#getcustomreportusers) | **GET** /reports/custom/{reportId}/users | List users shared on a custom report|
+|[**removeCustomReportUser**](#removecustomreportuser) | **DELETE** /reports/custom/{reportId}/users/{userId} | Unshare a custom report from a user|
 
 # **addCustomReportUser**
 > CreateAccountInvitations200Response addCustomReportUser()
 
-Add Custom Report User endpoint
+Grants another user access to a custom report by adding them to its shared users list; only the report\'s owner may add users, and this requires the update permission on the reports domain.
 
 ### Example
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.addCustomReportUser(
 # **getCustomReportUsers**
 > GetCustomReportUsers200Response getCustomReportUsers()
 
-Get Custom Report Users endpoint
+Returns the users a custom report has been shared with, identified by the custom report\'s ID; requires the `read:reports` permission.
 
 ### Example
 
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.getCustomReportUsers(
 # **removeCustomReportUser**
 > CreateAccountInvitations200Response removeCustomReportUser()
 
-Remove Custom Report User endpoint
+Revokes a user\'s shared access to a custom report by removing them from its shared users list; only the report\'s owner may remove users, and this requires the delete permission on the reports domain.
 
 ### Example
 

package/docs/SearchlistsApi.md

@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**createSearchList**](#createsearchlist) | **POST** /searchlists | Create Search List|
-|[**deleteSearchList**](#deletesearchlist) | **DELETE** /searchlists/{searchListId} | Delete Search List|
-|[**getSearchList**](#getsearchlist) | **GET** /searchlists/{searchListId} | Get Search List|
-|[**getSearchLists**](#getsearchlists) | **GET** /searchlists | Get Search Lists|
-|[**updateSearchList**](#updatesearchlist) | **PUT** /searchlists/{searchListId} | Update Search List|
+|[**createSearchList**](#createsearchlist) | **POST** /searchlists | Create a search list|
+|[**deleteSearchList**](#deletesearchlist) | **DELETE** /searchlists/{searchListId} | Delete a search list|
+|[**getSearchList**](#getsearchlist) | **GET** /searchlists/{searchListId} | Get a search list|
+|[**getSearchLists**](#getsearchlists) | **GET** /searchlists | List an organization\'s search lists|
+|[**updateSearchList**](#updatesearchlist) | **PUT** /searchlists/{searchListId} | Update a search list|
 
 # **createSearchList**
 > CreateSearchList200Response createSearchList(searchListCreateInputs)
 
-Create Search List endpoint
+Creates a new organization-scoped search list (a reusable named set of selectable values, e.g. for survey question options); fails if a search list with the same name already exists, and requires the create permission on the org domain.
 
 ### Example
 
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createSearchList(
 # **deleteSearchList**
 > CreateAccountInvitations200Response deleteSearchList()
 
-Delete Search List endpoint
+Permanently deletes a search list by ID; fails if the search list is currently referenced by any questions, sessions, or surveys, and requires the update permission on the org domain.
 
 ### Example
 
@@ -116,7 +116,7 @@ const { status, data } = await apiInstance.deleteSearchList(
 # **getSearchList**
 > CreateSearchList200Response getSearchList()
 
-Get Search List endpoint
+Returns a single search list by its ID, including its configuration; requires the `read:org` permission.
 
 ### Example
 
@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getSearchList(
 # **getSearchLists**
 > GetSearchLists200Response getSearchLists()
 
-Get Search Lists endpoint
+Returns a paginated, searchable list of search lists belonging to the organization, with optional page size, ordering, and search term filters; requires the `read:org` permission.
 
 ### Example
 
@@ -227,7 +227,7 @@ const { status, data } = await apiInstance.getSearchLists(
 # **updateSearchList**
 > CreateSearchList200Response updateSearchList(searchListUpdateInputs)
 
-Update Search List endpoint
+Updates a search list\'s properties such as its name; fails if renaming would collide with another existing search list\'s name, and requires the update permission on the org domain.
 
 ### Example
 

package/docs/SearchlistsValuesApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**bulkUploadSearchListValues**](#bulkuploadsearchlistvalues) | **POST** /searchlists/{searchListId}/values/bulk | Bulk Upload Search List Values|
-|[**createSearchListValue**](#createsearchlistvalue) | **POST** /searchlists/{searchListId}/values | Create Search List Value|
-|[**deleteSearchListValue**](#deletesearchlistvalue) | **DELETE** /searchlists/{searchListId}/values/{valueId} | Delete Search List Value|
-|[**getSearchListConnectedQuestions**](#getsearchlistconnectedquestions) | **GET** /searchlists/{searchListId}/questions | Get Search List Connected Questions|
-|[**getSearchListValue**](#getsearchlistvalue) | **GET** /searchlists/{searchListId}/values/{valueId} | Get Search List Value|
-|[**getSearchListValues**](#getsearchlistvalues) | **GET** /searchlists/{searchListId}/values | Get Search List Values|
-|[**updateSearchListValue**](#updatesearchlistvalue) | **PUT** /searchlists/{searchListId}/values/{valueId} | Update Search List Value|
+|[**bulkUploadSearchListValues**](#bulkuploadsearchlistvalues) | **POST** /searchlists/{searchListId}/values/bulk | Bulk upload values to a search list|
+|[**createSearchListValue**](#createsearchlistvalue) | **POST** /searchlists/{searchListId}/values | Create a search list value|
+|[**deleteSearchListValue**](#deletesearchlistvalue) | **DELETE** /searchlists/{searchListId}/values/{valueId} | Delete a search list value|
+|[**getSearchListConnectedQuestions**](#getsearchlistconnectedquestions) | **GET** /searchlists/{searchListId}/questions | List questions connected to a search list|
+|[**getSearchListValue**](#getsearchlistvalue) | **GET** /searchlists/{searchListId}/values/{valueId} | Get a search list value|
+|[**getSearchListValues**](#getsearchlistvalues) | **GET** /searchlists/{searchListId}/values | List a search list\'s values|
+|[**updateSearchListValue**](#updatesearchlistvalue) | **PUT** /searchlists/{searchListId}/values/{valueId} | Update a search list value|
 
 # **bulkUploadSearchListValues**
 > BulkUploadSearchListValues200Response bulkUploadSearchListValues()
 
-Bulk Upload Search List Values endpoint
+Creates many values on the given search list in a single request from an array of strings, skipping duplicates, and requires organization read and update permissions.
 
 ### Example
 
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.bulkUploadSearchListValues(
 # **createSearchListValue**
 > CreateSearchListValue200Response createSearchListValue(searchListValueCreateInputs)
 
-Create Search List Value endpoint
+Adds a new value to the specified search list, rejecting duplicate values within the same list, and requires organization read and update permissions.
 
 ### Example
 
@@ -124,7 +124,7 @@ const { status, data } = await apiInstance.createSearchListValue(
 # **deleteSearchListValue**
 > CreateAccountInvitations200Response deleteSearchListValue()
 
-Delete Search List Value endpoint
+Permanently removes a single value from the specified search list and requires organization read and update permissions.
 
 ### Example
 
@@ -178,7 +178,7 @@ const { status, data } = await apiInstance.deleteSearchListValue(
 # **getSearchListConnectedQuestions**
 > GetSearchListConnectedQuestions200Response getSearchListConnectedQuestions()
 
-Get Search List Connected Questions endpoint
+Returns a cursor-paginated list of the questions that reference the given search list, with optional page size, ordering, and search term filters; requires the `read:org` permission.
 
 ### Example
 
@@ -229,7 +229,7 @@ const { status, data } = await apiInstance.getSearchListConnectedQuestions(
 # **getSearchListValue**
 > CreateSearchListValue200Response getSearchListValue()
 
-Get Search List Value endpoint
+Returns a single value entry from a search list, identified by the search list ID and value ID; accessible to any authenticated admin user.
 
 ### Example
 
@@ -283,7 +283,7 @@ const { status, data } = await apiInstance.getSearchListValue(
 # **getSearchListValues**
 > GetSearchListValues200Response getSearchListValues()
 
-Get Search List Values endpoint
+Returns a paginated, searchable list of the value entries belonging to the given search list, with optional page size, ordering, and search term filters; accessible to any authenticated admin user.
 
 ### Example
 
@@ -346,7 +346,7 @@ const { status, data } = await apiInstance.getSearchListValues(
 # **updateSearchListValue**
 > CreateSearchListValue200Response updateSearchListValue(searchListValueUpdateInputs)
 
-Update Search List Value endpoint
+Updates the fields, such as the value text or priority, of an existing value on the specified search list and requires organization read and update permissions.
 
 ### Example
 

package/docs/SelfApi.md

@@ -4,16 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getSelf**](#getself) | **GET** /self | Get Self|
-|[**getSelfOrgMembership**](#getselforgmembership) | **GET** /self/organization-membership | Get Self Org Membership|
-|[**getSelfOrganizations**](#getselforganizations) | **GET** /self/organizations | Get Self Organizations|
-|[**selfLeaveOrganization**](#selfleaveorganization) | **DELETE** /self/organizations/{organizationId} | Self Leave Organization|
-|[**updateSelf**](#updateself) | **PUT** /self | Update Self|
+|[**getSelf**](#getself) | **GET** /self | Get the current user\'s profile|
+|[**getSelfOrgMembership**](#getselforgmembership) | **GET** /self/organization-membership | Get the current user\'s organization membership|
+|[**getSelfOrganizations**](#getselforganizations) | **GET** /self/organizations | List the current user\'s organizations|
+|[**selfLeaveOrganization**](#selfleaveorganization) | **DELETE** /self/organizations/{organizationId} | Leave an organization|
+|[**updateSelf**](#updateself) | **PUT** /self | Update the current user\'s profile|
 
 # **getSelf**
 > GetSelf200Response getSelf()
 
-Get Self endpoint
+Returns the profile of the currently authenticated user.
 
 ### Example
 
@@ -57,7 +57,7 @@ This endpoint does not have any parameters.
 # **getSelfOrgMembership**
 > AddOrganizationUser200Response getSelfOrgMembership()
 
-Get Self Org Membership endpoint
+Returns the authenticated user\'s membership record for the currently selected organization, including their role and status; no special permission is required beyond being signed in.
 
 ### Example
 
@@ -101,7 +101,7 @@ This endpoint does not have any parameters.
 # **getSelfOrganizations**
 > GetSelfOrganizations200Response getSelfOrganizations()
 
-Get Self Organizations endpoint
+Returns a paginated list of organizations the authenticated user belongs to, supporting search and ordering; no special permission is required beyond being signed in.
 
 ### Example
 
@@ -161,7 +161,7 @@ const { status, data } = await apiInstance.getSelfOrganizations(
 # **selfLeaveOrganization**
 > UpdateSelf200Response selfLeaveOrganization()
 
-Self Leave Organization endpoint
+Removes the authenticated user\'s membership from the given organization, and fails if that organization is the user\'s currently signed-in organization.
 
 ### Example
 
@@ -212,7 +212,7 @@ const { status, data } = await apiInstance.selfLeaveOrganization(
 # **updateSelf**
 > UpdateSelf200Response updateSelf(userUpdateInputs)
 
-Update Self endpoint
+Updates profile fields on the authenticated user\'s own account, such as name and contact details, and returns the updated user record.
 
 ### Example
 

package/docs/SelfApikeysApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**createSelfApiKey**](#createselfapikey) | **POST** /self/api-keys | Create Self Api Key|
-|[**deleteSelfApiKey**](#deleteselfapikey) | **DELETE** /self/api-keys/{apiKeyId} | Delete Self Api Key|
-|[**getSelfApiKey**](#getselfapikey) | **GET** /self/api-keys/{apiKeyId} | Get Self Api Key|
-|[**getSelfApiKeys**](#getselfapikeys) | **GET** /self/api-keys | Get Self Api Keys|
+|[**createSelfApiKey**](#createselfapikey) | **POST** /self/api-keys | Create an API key for the current user|
+|[**deleteSelfApiKey**](#deleteselfapikey) | **DELETE** /self/api-keys/{apiKeyId} | Delete an API key for the current user|
+|[**getSelfApiKey**](#getselfapikey) | **GET** /self/api-keys/{apiKeyId} | Get one of the current user\'s API keys|
+|[**getSelfApiKeys**](#getselfapikeys) | **GET** /self/api-keys | List the current user\'s API keys|
 
 # **createSelfApiKey**
 > CreateSelfApiKey200Response createSelfApiKey(userApiKeyCreateInputs)
 
-Create Self Api Key endpoint
+Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
 
 ### Example
 
@@ -64,7 +64,7 @@ const { status, data } = await apiInstance.createSelfApiKey(
 # **deleteSelfApiKey**
 > CreateAccountInvitations200Response deleteSelfApiKey()
 
-Delete Self Api Key endpoint
+Permanently revokes and removes the specified personal API key belonging to the authenticated user.
 
 ### Example
 
@@ -115,7 +115,7 @@ const { status, data } = await apiInstance.deleteSelfApiKey(
 # **getSelfApiKey**
 > CreateSelfApiKey200Response getSelfApiKey()
 
-Get Self Api Key endpoint
+Returns a single API key belonging to the authenticated user, identified by its API key ID; users can only access their own API keys.
 
 ### Example
 
@@ -166,7 +166,7 @@ const { status, data } = await apiInstance.getSelfApiKey(
 # **getSelfApiKeys**
 > GetSelfApiKeys200Response getSelfApiKeys()
 
-Get Self Api Keys endpoint
+Returns a paginated, searchable list of API keys belonging to the authenticated user, with optional page size, ordering, and search term filters.
 
 ### Example
 

package/docs/SelfImagesApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**deleteUserImage**](#deleteuserimage) | **DELETE** /self/image | Delete User Image|
-|[**updateUserImage**](#updateuserimage) | **PUT** /self/image | Update User Image|
+|[**deleteUserImage**](#deleteuserimage) | **DELETE** /self/image | Delete the current user\'s profile image|
+|[**updateUserImage**](#updateuserimage) | **PUT** /self/image | Update the current user\'s profile image|
 
 # **deleteUserImage**
 > UpdateSelf200Response deleteUserImage()
 
-Delete User Image endpoint
+Removes the authenticated user\'s profile picture, deleting the stored image from Cloudflare if one exists, and returns the updated user profile.
 
 ### Example
 
@@ -54,7 +54,7 @@ This endpoint does not have any parameters.
 # **updateUserImage**
 > UpdateSelf200Response updateUserImage(userImageUpdateInputs)
 
-Update User Image endpoint
+Uploads and sets a new profile picture for the authenticated user from a base64 image data URI in jpeg, png, heic, or heif format, and returns the updated user profile.
 
 ### Example
 

package/docs/SeriesApi.md

@@ -4,20 +4,20 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**addSeriesEvent**](#addseriesevent) | **POST** /series/{seriesId}/events/{eventId} | Add Series Event|
-|[**createSeries**](#createseries) | **POST** /series | Create Series|
-|[**deleteSeries**](#deleteseries) | **DELETE** /series/{seriesId} | Delete Series|
-|[**getSeries**](#getseries) | **GET** /series/{seriesId} | Get Series|
-|[**getSeriesEvents**](#getseriesevents) | **GET** /series/{seriesId}/events | Get Series Events|
-|[**getSeriesList**](#getserieslist) | **GET** /series | Get Series List|
-|[**getSeriesPayments**](#getseriespayments) | **GET** /series/{seriesId}/payments | Get Series Payments|
-|[**removeSeriesEvent**](#removeseriesevent) | **DELETE** /series/{seriesId}/events/{eventId} | Remove Series Event|
-|[**updateSeries**](#updateseries) | **PUT** /series/{seriesId} | Update Series|
+|[**addSeriesEvent**](#addseriesevent) | **POST** /series/{seriesId}/events/{eventId} | Add an event to a series|
+|[**createSeries**](#createseries) | **POST** /series | Create an event series|
+|[**deleteSeries**](#deleteseries) | **DELETE** /series/{seriesId} | Delete an event series|
+|[**getSeries**](#getseries) | **GET** /series/{seriesId} | Get a series|
+|[**getSeriesEvents**](#getseriesevents) | **GET** /series/{seriesId}/events | List the events in a series|
+|[**getSeriesList**](#getserieslist) | **GET** /series | List event series|
+|[**getSeriesPayments**](#getseriespayments) | **GET** /series/{seriesId}/payments | List a series\' payments|
+|[**removeSeriesEvent**](#removeseriesevent) | **DELETE** /series/{seriesId}/events/{eventId} | Remove an event from a series|
+|[**updateSeries**](#updateseries) | **PUT** /series/{seriesId} | Update an event series|
 
 # **addSeriesEvent**
 > CreateSeries200Response addSeriesEvent()
 
-Add Series Event endpoint
+Attaches an existing event to an event series so it appears as one of the series\' occurrences, requiring \"read\" and \"update\" permission on events.
 
 ### Example
 
@@ -71,7 +71,7 @@ const { status, data } = await apiInstance.addSeriesEvent(
 # **createSeries**
 > CreateSeries200Response createSeries(seriesCreateInputs)
 
-Create Series endpoint
+Creates a new event series for the organization from the given details, requiring \"read\" and \"create\" permission on events.
 
 ### Example
 
@@ -123,7 +123,7 @@ const { status, data } = await apiInstance.createSeries(
 # **deleteSeries**
 > CreateAccountInvitations200Response deleteSeries()
 
-Delete Series endpoint
+Permanently deletes an event series from the organization, requiring \"read\" and \"del\" permission on events.
 
 ### Example
 
@@ -174,7 +174,7 @@ const { status, data } = await apiInstance.deleteSeries(
 # **getSeries**
 > CreateSeries200Response getSeries()
 
-Get Series endpoint
+Returns the details of a single event series by its ID, and requires read access to events.
 
 ### Example
 
@@ -225,7 +225,7 @@ const { status, data } = await apiInstance.getSeries(
 # **getSeriesEvents**
 > GetAccountEvents200Response getSeriesEvents()
 
-Get Series Events endpoint
+Returns a paginated list of events belonging to a series, supporting search and ordering, and requires read access to events.
 
 ### Example
 
@@ -288,7 +288,7 @@ const { status, data } = await apiInstance.getSeriesEvents(
 # **getSeriesList**
 > GetSeriesList200Response getSeriesList()
 
-Get Series List endpoint
+Returns a paginated list of event series for the organization, supporting search and ordering, and requires read access to events.
 
 ### Example
 
@@ -348,7 +348,7 @@ const { status, data } = await apiInstance.getSeriesList(
 # **getSeriesPayments**
 > GetAccountPayments200Response getSeriesPayments()
 
-Get Series Payments endpoint
+Returns a paginated list of payments associated with a series, supporting search and ordering, and requires read access to both events and payments.
 
 ### Example
 
@@ -411,7 +411,7 @@ const { status, data } = await apiInstance.getSeriesPayments(
 # **removeSeriesEvent**
 > CreateSeries200Response removeSeriesEvent()
 
-Remove Series Event endpoint
+Detaches an event from an event series so it no longer appears as one of the series\' occurrences, requiring \"read\" and \"update\" permission on events.
 
 ### Example
 
@@ -465,7 +465,7 @@ const { status, data } = await apiInstance.removeSeriesEvent(
 # **updateSeries**
 > CreateSeries200Response updateSeries()
 
-Update Series endpoint
+Updates the details of an existing event series, excluding its id, image, and timestamps, requiring \"read\" and \"update\" permission on events.
 
 ### Example
 

package/docs/SeriesQuestionsApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**createSeriesQuestion**](#createseriesquestion) | **POST** /series/{seriesId}/questions | Create Series Question|
-|[**deleteSeriesQuestion**](#deleteseriesquestion) | **DELETE** /series/{seriesId}/questions/{questionId} | Delete Series Question|
-|[**getSeriesQuestion**](#getseriesquestion) | **GET** /series/{seriesId}/questions/{questionId} | Get Series Question|
-|[**getSeriesQuestionChoice**](#getseriesquestionchoice) | **GET** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Get Series Question Choice|
-|[**getSeriesQuestionChoices**](#getseriesquestionchoices) | **GET** /series/{seriesId}/questions/{questionId}/choices | Get Series Question Choices|
-|[**getSeriesQuestions**](#getseriesquestions) | **GET** /series/{seriesId}/questions | Get Series Questions|
-|[**updateSeriesQuestion**](#updateseriesquestion) | **PUT** /series/{seriesId}/questions/{questionId} | Update Series Question|
+|[**createSeriesQuestion**](#createseriesquestion) | **POST** /series/{seriesId}/questions | Create a registration question for a series|
+|[**deleteSeriesQuestion**](#deleteseriesquestion) | **DELETE** /series/{seriesId}/questions/{questionId} | Delete a series registration question|
+|[**getSeriesQuestion**](#getseriesquestion) | **GET** /series/{seriesId}/questions/{questionId} | Get a series registration question|
+|[**getSeriesQuestionChoice**](#getseriesquestionchoice) | **GET** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Get a series question choice|
+|[**getSeriesQuestionChoices**](#getseriesquestionchoices) | **GET** /series/{seriesId}/questions/{questionId}/choices | List a series question\'s choices|
+|[**getSeriesQuestions**](#getseriesquestions) | **GET** /series/{seriesId}/questions | List a series\' registration questions|
+|[**updateSeriesQuestion**](#updateseriesquestion) | **PUT** /series/{seriesId}/questions/{questionId} | Update a series registration question|
 
 # **createSeriesQuestion**
 > CreateSeriesQuestion200Response createSeriesQuestion(seriesQuestionCreateInputs)
 
-Create Series Question endpoint
+Creates a new registration question on the series, optionally with an initial list of answer choices, inserting it at the given sortOrder or appending it to the end; requires update permission on events.
 
 ### Example
 
@@ -70,7 +70,7 @@ const { status, data } = await apiInstance.createSeriesQuestion(
 # **deleteSeriesQuestion**
 > CreateAccountInvitations200Response deleteSeriesQuestion()
 
-Delete Series Question endpoint
+Permanently deletes a registration question from a series and re-sequences the sortOrder of the remaining questions; requires update permission on events.
 
 ### Example
 
@@ -124,7 +124,7 @@ const { status, data } = await apiInstance.deleteSeriesQuestion(
 # **getSeriesQuestion**
 > CreateSeriesQuestion200Response getSeriesQuestion()
 
-Get Series Question endpoint
+Returns a single registration question configured for the given series, identified by its question ID, requires the \"read\" permission on the events module.
 
 ### Example
 
@@ -178,7 +178,7 @@ const { status, data } = await apiInstance.getSeriesQuestion(
 # **getSeriesQuestionChoice**
 > CreateSeriesQuestionChoice200Response getSeriesQuestionChoice()
 
-Get Series Question Choice endpoint
+Returns a single answer choice for a series registration question, identified by its choice ID, requires the \"read\" permission on the events module.
 
 ### Example
 
@@ -235,7 +235,7 @@ const { status, data } = await apiInstance.getSeriesQuestionChoice(
 # **getSeriesQuestionChoices**
 > GetSeriesQuestionChoices200Response getSeriesQuestionChoices()
 
-Get Series Question Choices endpoint
+Returns a paginated list of answer choices belonging to a series registration question, supporting search and ordering, requires the \"read\" permission on the events module.
 
 ### Example
 
@@ -301,7 +301,7 @@ const { status, data } = await apiInstance.getSeriesQuestionChoices(
 # **getSeriesQuestions**
 > GetSeriesQuestions200Response getSeriesQuestions()
 
-Get Series Questions endpoint
+Returns a paginated list of registration questions configured for the given series, supporting search and ordering, requires the \"read\" permission on the events module.
 
 ### Example
 
@@ -364,7 +364,7 @@ const { status, data } = await apiInstance.getSeriesQuestions(
 # **updateSeriesQuestion**
 > CreateSeriesQuestion200Response updateSeriesQuestion()
 
-Update Series Question endpoint
+Updates the properties of a registration question on a series, such as its label, type, or required flag, and re-sequences sortOrder among sibling questions if a new sortOrder is supplied; requires update permission on events.
 
 ### Example