@connectedxm/admin-sdk 7.4.1 → 7.5.1

package/docs/ActivitiesApi.md

@@ -4,20 +4,20 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**archiveActivity**](#archiveactivity) | **PUT** /activities/{activityId}/archive | Archive Activity|
-|[**createActivity**](#createactivity) | **POST** /activities | Create Activity|
-|[**deleteActivity**](#deleteactivity) | **DELETE** /activities/{activityId} | Delete Activity|
-|[**getActivities**](#getactivities) | **GET** /activities | Get Activities|
-|[**getActivity**](#getactivity) | **GET** /activities/{activityId} | Get Activity|
-|[**getActivityComments**](#getactivitycomments) | **GET** /activities/{activityId}/comments | Get Activity Comments|
-|[**getActivityLikes**](#getactivitylikes) | **GET** /activities/{activityId}/likes | Get Activity Likes|
-|[**publishActivity**](#publishactivity) | **PUT** /activities/{activityId}/publish | Publish Activity|
-|[**updateActivity**](#updateactivity) | **PUT** /activities/{activityId} | Update Activity|
+|[**archiveActivity**](#archiveactivity) | **PUT** /activities/{activityId}/archive | Archive a published activity|
+|[**createActivity**](#createactivity) | **POST** /activities | Create an activity post|
+|[**deleteActivity**](#deleteactivity) | **DELETE** /activities/{activityId} | Delete an activity|
+|[**getActivities**](#getactivities) | **GET** /activities | List activities|
+|[**getActivity**](#getactivity) | **GET** /activities/{activityId} | Get a single activity|
+|[**getActivityComments**](#getactivitycomments) | **GET** /activities/{activityId}/comments | List an activity\'s comments|
+|[**getActivityLikes**](#getactivitylikes) | **GET** /activities/{activityId}/likes | List an activity\'s likes|
+|[**publishActivity**](#publishactivity) | **PUT** /activities/{activityId}/publish | Publish an activity immediately|
+|[**updateActivity**](#updateactivity) | **PUT** /activities/{activityId} | Update an activity\'s details|
 
 # **archiveActivity**
 > CreateActivity200Response archiveActivity()
 
-Archive Activity endpoint
+Archives a currently published activity, removing it from active feeds while retaining its record; requires update permission on activities and fails if the activity has not already been published.
 
 ### Example
 
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.archiveActivity(
 # **createActivity**
 > CreateActivity200Response createActivity()
 
-Create Activity endpoint
+Creates a new activity feed post authored by the given account, optionally attaching an image via a base64 data URI; requires create permission on activities.
 
 ### Example
 
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.createActivity(
 # **deleteActivity**
 > CreateAccountInvitations200Response deleteActivity()
 
-Delete Activity endpoint
+Permanently deletes the specified activity post; requires delete permission on activities.
 
 ### Example
 
@@ -177,7 +177,7 @@ const { status, data } = await apiInstance.deleteActivity(
 # **getActivities**
 > GetAccountActivities200Response getActivities()
 
-Get Activities endpoint
+Returns a paginated list of activity feed posts for the organization, filterable by moderation status, featured flag, activity status, and whether to include global (cross-organization) activities, requiring read permission on activities.
 
 ### Example
 
@@ -249,7 +249,7 @@ const { status, data } = await apiInstance.getActivities(
 # **getActivity**
 > CreateActivity200Response getActivity()
 
-Get Activity endpoint
+Retrieves the details of a single activity feed post by its activityId, requiring read permission on activities.
 
 ### Example
 
@@ -300,7 +300,7 @@ const { status, data } = await apiInstance.getActivity(
 # **getActivityComments**
 > GetAccountActivities200Response getActivityComments()
 
-Get Activity Comments endpoint
+Returns a paginated list of comments left on the specified activity, supporting search and ordering, and requiring read permission on activities.
 
 ### Example
 
@@ -363,7 +363,7 @@ const { status, data } = await apiInstance.getActivityComments(
 # **getActivityLikes**
 > GetAccountLikes200Response getActivityLikes()
 
-Get Activity Likes endpoint
+Returns a paginated list of the accounts that liked the specified activity, supporting search and ordering, and requiring read permission on activities.
 
 ### Example
 
@@ -426,7 +426,7 @@ const { status, data } = await apiInstance.getActivityLikes(
 # **publishActivity**
 > CreateActivity200Response publishActivity()
 
-Publish Activity endpoint
+Publishes an activity right away, making it visible in feeds; requires update permission on activities and fails if the activity is already published or is currently scheduled for a future publish.
 
 ### Example
 
@@ -477,7 +477,7 @@ const { status, data } = await apiInstance.publishActivity(
 # **updateActivity**
 > CreateActivity200Response updateActivity(activityUpdateInputs)
 
-Update Activity endpoint
+Updates the content and settings of an existing activity post identified by activityId; requires update permission on activities.
 
 ### Example
 

package/docs/ActivitiesScheduleApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**cancelActivitySchedule**](#cancelactivityschedule) | **DELETE** /activities/{activityId}/schedule | Cancel Activity Schedule|
-|[**updateActivitySchedule**](#updateactivityschedule) | **PUT** /activities/{activityId}/schedule | Update Activity Schedule|
+|[**cancelActivitySchedule**](#cancelactivityschedule) | **DELETE** /activities/{activityId}/schedule | Cancel a scheduled activity|
+|[**updateActivitySchedule**](#updateactivityschedule) | **PUT** /activities/{activityId}/schedule | Schedule an activity to publish later|
 
 # **cancelActivitySchedule**
 > CreateActivity200Response cancelActivitySchedule()
 
-Cancel Activity Schedule endpoint
+Cancels a pending future publish schedule for an activity, removing the scheduled send and leaving the activity unpublished; requires update permission on activities and fails if the activity is not currently scheduled or has already been sent.
 
 ### Example
 
@@ -61,7 +61,7 @@ const { status, data } = await apiInstance.cancelActivitySchedule(
 # **updateActivitySchedule**
 > CreateActivity200Response updateActivitySchedule(body)
 
-Update Activity Schedule endpoint
+Sets or updates the future date and time at which an activity will automatically be published, creating the schedule if none exists or rescheduling an existing one; requires update permission on activities and the date must be in the future.
 
 ### Example
 

package/docs/AdvertisementsApi.md

@@ -4,18 +4,18 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**createAdvertisement**](#createadvertisement) | **POST** /advertisements | Create Advertisement|
-|[**deleteAdvertisement**](#deleteadvertisement) | **DELETE** /advertisements/{advertisementId} | Delete Advertisement|
-|[**getAdvertisement**](#getadvertisement) | **GET** /advertisements/{advertisementId} | Get Advertisement|
-|[**getAdvertisementClicks**](#getadvertisementclicks) | **GET** /advertisements/{advertisementId}/clicks | Get Advertisement Clicks|
-|[**getAdvertisementViews**](#getadvertisementviews) | **GET** /advertisements/{advertisementId}/views | Get Advertisement Views|
-|[**getAdvertisements**](#getadvertisements) | **GET** /advertisements | Get Advertisements|
-|[**updateAdvertisement**](#updateadvertisement) | **PUT** /advertisements/{advertisementId} | Update Advertisement|
+|[**createAdvertisement**](#createadvertisement) | **POST** /advertisements | Create an advertisement|
+|[**deleteAdvertisement**](#deleteadvertisement) | **DELETE** /advertisements/{advertisementId} | Delete an advertisement|
+|[**getAdvertisement**](#getadvertisement) | **GET** /advertisements/{advertisementId} | Get a single advertisement|
+|[**getAdvertisementClicks**](#getadvertisementclicks) | **GET** /advertisements/{advertisementId}/clicks | List an advertisement\'s clicks|
+|[**getAdvertisementViews**](#getadvertisementviews) | **GET** /advertisements/{advertisementId}/views | List an advertisement\'s view records|
+|[**getAdvertisements**](#getadvertisements) | **GET** /advertisements | List advertisements|
+|[**updateAdvertisement**](#updateadvertisement) | **PUT** /advertisements/{advertisementId} | Update an advertisement|
 
 # **createAdvertisement**
 > CreateAdvertisement200Response createAdvertisement(advertisementCreateInputs)
 
-Create Advertisement endpoint
+Creates a new advertisement record for the organization from the given details; requires create permission on advertisements.
 
 ### Example
 
@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.createAdvertisement(
 # **deleteAdvertisement**
 > CreateAccountInvitations200Response deleteAdvertisement()
 
-Delete Advertisement endpoint
+Permanently deletes the specified advertisement from the organization; requires delete permission on advertisements.
 
 ### Example
 
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.deleteAdvertisement(
 # **getAdvertisement**
 > CreateAdvertisement200Response getAdvertisement()
 
-Get Advertisement endpoint
+Retrieves the details of a single advertisement by its advertisementId, requiring read permission on advertisements.
 
 ### Example
 
@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.getAdvertisement(
 # **getAdvertisementClicks**
 > GetAdvertisementClicks200Response getAdvertisementClicks()
 
-Get Advertisement Clicks endpoint
+Returns a paginated list of click events recorded for the specified advertisement, supporting search and ordering, and requiring read permission on advertisements.
 
 ### Example
 
@@ -232,7 +232,7 @@ const { status, data } = await apiInstance.getAdvertisementClicks(
 # **getAdvertisementViews**
 > GetAdvertisementViews200Response getAdvertisementViews()
 
-Get Advertisement Views endpoint
+Returns a paginated list of view (impression) records for the given advertisement, supporting search and ordering; requires read permission on advertisements.
 
 ### Example
 
@@ -295,7 +295,7 @@ const { status, data } = await apiInstance.getAdvertisementViews(
 # **getAdvertisements**
 > GetAdvertisements200Response getAdvertisements()
 
-Get Advertisements endpoint
+Returns a paginated list of advertisements for the organization, supporting search and ordering, and requiring read permission on advertisements.
 
 ### Example
 
@@ -355,7 +355,7 @@ const { status, data } = await apiInstance.getAdvertisements(
 # **updateAdvertisement**
 > CreateAdvertisement200Response updateAdvertisement(advertisementUpdateInputs)
 
-Update Advertisement endpoint
+Updates the details of an existing advertisement identified by advertisementId; requires update permission on advertisements.
 
 ### Example
 

package/docs/AnnouncementsApi.md

@@ -4,19 +4,19 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**createAnnouncement**](#createannouncement) | **POST** /announcements | Create Announcement|
-|[**deleteAnnouncement**](#deleteannouncement) | **DELETE** /announcements/{announcementId} | Delete Announcement|
-|[**getAnnouncement**](#getannouncement) | **GET** /announcements/{announcementId} | Get Announcement|
-|[**getAnnouncementAudience**](#getannouncementaudience) | **GET** /announcements/{announcementId}/audience | Get Announcement Audience|
-|[**getAnnouncementEmailReceipts**](#getannouncementemailreceipts) | **GET** /announcements/{announcementId}/email-receipts | Get Announcement Email Receipts|
-|[**getAnnouncements**](#getannouncements) | **GET** /announcements | Get Announcements|
-|[**sendAnnouncementPreview**](#sendannouncementpreview) | **POST** /announcements/{announcementId}/preview | Send Announcement Preview|
-|[**updateAnnouncement**](#updateannouncement) | **PUT** /announcements/{announcementId} | Update Announcement|
+|[**createAnnouncement**](#createannouncement) | **POST** /announcements | Create an announcement|
+|[**deleteAnnouncement**](#deleteannouncement) | **DELETE** /announcements/{announcementId} | Delete an announcement|
+|[**getAnnouncement**](#getannouncement) | **GET** /announcements/{announcementId} | Get an announcement|
+|[**getAnnouncementAudience**](#getannouncementaudience) | **GET** /announcements/{announcementId}/audience | List an announcement\'s target audience|
+|[**getAnnouncementEmailReceipts**](#getannouncementemailreceipts) | **GET** /announcements/{announcementId}/email-receipts | List an announcement\'s email delivery receipts|
+|[**getAnnouncements**](#getannouncements) | **GET** /announcements | List announcements|
+|[**sendAnnouncementPreview**](#sendannouncementpreview) | **POST** /announcements/{announcementId}/preview | Send a preview of an announcement|
+|[**updateAnnouncement**](#updateannouncement) | **PUT** /announcements/{announcementId} | Update an announcement|
 
 # **createAnnouncement**
 > CreateAnnouncement200Response createAnnouncement(announcementCreateInputs)
 
-Create Announcement endpoint
+Creates a new announcement for the organization, requiring at least one audience target (event, group, tier, channel, account, or verified accounts) and requiring create permission on announcements; admins cannot assign the creator directly.
 
 ### Example
 
@@ -68,7 +68,7 @@ const { status, data } = await apiInstance.createAnnouncement(
 # **deleteAnnouncement**
 > CreateAccountInvitations200Response deleteAnnouncement()
 
-Delete Announcement endpoint
+Permanently deletes the given announcement from the organization; requires delete permission on announcements.
 
 ### Example
 
@@ -119,7 +119,7 @@ const { status, data } = await apiInstance.deleteAnnouncement(
 # **getAnnouncement**
 > CreateAnnouncement200Response getAnnouncement()
 
-Get Announcement endpoint
+Returns the details of a single announcement by its ID; requires read permission on announcements.
 
 ### Example
 
@@ -170,7 +170,7 @@ const { status, data } = await apiInstance.getAnnouncement(
 # **getAnnouncementAudience**
 > GetAnnouncementAudience200Response getAnnouncementAudience()
 
-Get Announcement Audience endpoint
+Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
 
 ### Example
 
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.getAnnouncementAudience(
 # **getAnnouncementEmailReceipts**
 > GetAcccountEmailReceipts200Response getAnnouncementEmailReceipts()
 
-Get Announcement Email Receipts endpoint
+Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
 
 ### Example
 
@@ -299,7 +299,7 @@ const { status, data } = await apiInstance.getAnnouncementEmailReceipts(
 # **getAnnouncements**
 > GetAnnouncements200Response getAnnouncements()
 
-Get Announcements endpoint
+Returns a paginated list of announcements for the organization, optionally filtered by event, group, tier, channel, account, sponsorship level, or verified-account status, with search and ordering support; requires read permission on announcements.
 
 ### Example
 
@@ -363,7 +363,7 @@ const { status, data } = await apiInstance.getAnnouncements(
 # **sendAnnouncementPreview**
 > CreateAccountInvitations200Response sendAnnouncementPreview()
 
-Send Announcement Preview endpoint
+Queues a preview send of the announcement\'s current content to a test recipient (identified by userId or accountId in the announcement), failing if the announcement has no HTML content yet; requires create permission on announcements.
 
 ### Example
 
@@ -414,7 +414,7 @@ const { status, data } = await apiInstance.sendAnnouncementPreview(
 # **updateAnnouncement**
 > CreateAnnouncement200Response updateAnnouncement(announcementUpdateInputs)
 
-Update Announcement endpoint
+Updates the fields (such as title, content, or audience targeting) of an existing announcement identified by ID or slug; requires update permission on announcements.
 
 ### Example
 

package/docs/AnnouncementsScheduleApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**cancelAnnouncementSchedule**](#cancelannouncementschedule) | **DELETE** /announcements/{announcementId}/schedule | Cancel Announcement Schedule|
-|[**updateAnnouncementSchedule**](#updateannouncementschedule) | **PUT** /announcements/{announcementId}/schedule | Update Announcement Schedule|
+|[**cancelAnnouncementSchedule**](#cancelannouncementschedule) | **DELETE** /announcements/{announcementId}/schedule | Cancel an announcement\'s scheduled send|
+|[**updateAnnouncementSchedule**](#updateannouncementschedule) | **PUT** /announcements/{announcementId}/schedule | Schedule or reschedule an announcement send|
 
 # **cancelAnnouncementSchedule**
 > CreateAnnouncement200Response cancelAnnouncementSchedule()
 
-Cancel Announcement Schedule endpoint
+Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
 
 ### Example
 
@@ -61,7 +61,7 @@ const { status, data } = await apiInstance.cancelAnnouncementSchedule(
 # **updateAnnouncementSchedule**
 > CreateAnnouncement200Response updateAnnouncementSchedule(body)
 
-Update Announcement Schedule endpoint
+Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
 
 ### Example
 

package/docs/AnnouncementsTranslationsApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**deleteAnnouncementTranslation**](#deleteannouncementtranslation) | **DELETE** /announcements/{announcementId}/translations/{locale} | Delete Announcement Translation|
-|[**getAnnouncementTranslation**](#getannouncementtranslation) | **GET** /announcements/{announcementId}/translations/{locale} | Get Announcement Translation|
-|[**getAnnouncementTranslations**](#getannouncementtranslations) | **GET** /announcements/{announcementId}/translations | Get Announcement Translations|
-|[**updateAnnouncementTranslation**](#updateannouncementtranslation) | **PUT** /announcements/{announcementId}/translations/{locale} | Update Announcement Translation|
+|[**deleteAnnouncementTranslation**](#deleteannouncementtranslation) | **DELETE** /announcements/{announcementId}/translations/{locale} | Delete an announcement translation|
+|[**getAnnouncementTranslation**](#getannouncementtranslation) | **GET** /announcements/{announcementId}/translations/{locale} | Get an announcement\'s translation for a locale|
+|[**getAnnouncementTranslations**](#getannouncementtranslations) | **GET** /announcements/{announcementId}/translations | List an announcement\'s translations|
+|[**updateAnnouncementTranslation**](#updateannouncementtranslation) | **PUT** /announcements/{announcementId}/translations/{locale} | Update an announcement translation|
 
 # **deleteAnnouncementTranslation**
 > SyncAccounts200Response deleteAnnouncementTranslation()
 
-Delete Announcement Translation endpoint
+Removes the translation for the given announcement in the specified locale; requires update permission on announcements.
 
 ### Example
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.deleteAnnouncementTranslation(
 # **getAnnouncementTranslation**
 > GetAnnouncementTranslation200Response getAnnouncementTranslation()
 
-Get Announcement Translation endpoint
+Returns the translated content (title, message, etc.) of an announcement for the specified locale, or null if no translation exists; requires read permission on announcements.
 
 ### Example
 
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.getAnnouncementTranslation(
 # **getAnnouncementTranslations**
 > GetAnnouncementTranslations200Response getAnnouncementTranslations()
 
-Get Announcement Translations endpoint
+Returns a paginated list of locale translations for the given announcement, supporting search and ordering; requires read permission on announcements.
 
 ### Example
 
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getAnnouncementTranslations(
 # **updateAnnouncementTranslation**
 > SyncAccounts200Response updateAnnouncementTranslation(announcementTranslationUpdateInputs)
 
-Update Announcement Translation endpoint
+Creates or updates the translated content (e.g. title, HTML body) for the given announcement in the specified locale; requires update permission on announcements.
 
 ### Example
 

package/docs/ApiLogsApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getAPILog**](#getapilog) | **GET** /logs/api/{logId} | Get A P I Log|
-|[**getAPILogs**](#getapilogs) | **GET** /logs/api | Get A P I Logs|
+|[**getAPILog**](#getapilog) | **GET** /logs/api/{logId} | Get an API request log entry|
+|[**getAPILogs**](#getapilogs) | **GET** /logs/api | List API request logs|
 
 # **getAPILog**
 > GetAPILog200Response getAPILog()
 
-Get A P I Log endpoint
+Returns the details of a single API request log entry by its ID, including request/response metadata; requires read permission on logs.
 
 ### Example
 
@@ -61,7 +61,7 @@ const { status, data } = await apiInstance.getAPILog(
 # **getAPILogs**
 > GetAPILogs200Response getAPILogs()
 
-Get A P I Logs endpoint
+Returns a paginated list of API request log entries for the organization within a date range, optionally filtered by HTTP method, status, source, user, or account, with search and ordering support; requires read permission on logs.
 
 ### Example
 

package/docs/AuthSessionsApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getAuthSession**](#getauthsession) | **GET** /logs/auth-sessions/{authSessionId} | Get Auth Session|
-|[**getAuthSessions**](#getauthsessions) | **GET** /logs/auth-sessions | Get Auth Sessions|
+|[**getAuthSession**](#getauthsession) | **GET** /logs/auth-sessions/{authSessionId} | Get an authentication session log entry|
+|[**getAuthSessions**](#getauthsessions) | **GET** /logs/auth-sessions | List authentication sessions|
 
 # **getAuthSession**
 > GetAuthSession200Response getAuthSession()
 
-Get Auth Session endpoint
+Returns the details of a single authentication session log entry by its ID; requires read permission on logs.
 
 ### Example
 
@@ -61,7 +61,7 @@ const { status, data } = await apiInstance.getAuthSession(
 # **getAuthSessions**
 > GetLoginAuthSessions200Response getAuthSessions()
 
-Get Auth Sessions endpoint
+Returns a paginated list of user authentication (login) sessions logged for the organization, supporting search and ordering; requires \"read\" permission on \"logs\".
 
 ### Example
 

package/docs/BenefitsApi.md

@@ -4,17 +4,17 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**createBenefit**](#createbenefit) | **POST** /benefits | Create Benefit|
-|[**deleteBenefit**](#deletebenefit) | **DELETE** /benefits/{benefitId} | Delete Benefit|
-|[**getBenefit**](#getbenefit) | **GET** /benefits/{benefitId} | Get Benefit|
-|[**getBenefitClicks**](#getbenefitclicks) | **GET** /benefits/{benefitId}/clicks | Get Benefit Clicks|
-|[**getBenefits**](#getbenefits) | **GET** /benefits | Get Benefits|
-|[**updateBenefit**](#updatebenefit) | **PUT** /benefits/{benefitId} | Update Benefit|
+|[**createBenefit**](#createbenefit) | **POST** /benefits | Create a benefit|
+|[**deleteBenefit**](#deletebenefit) | **DELETE** /benefits/{benefitId} | Delete a benefit|
+|[**getBenefit**](#getbenefit) | **GET** /benefits/{benefitId} | Get a benefit|
+|[**getBenefitClicks**](#getbenefitclicks) | **GET** /benefits/{benefitId}/clicks | List a benefit\'s click events|
+|[**getBenefits**](#getbenefits) | **GET** /benefits | List benefits|
+|[**updateBenefit**](#updatebenefit) | **PUT** /benefits/{benefitId} | Update a benefit|
 
 # **createBenefit**
 > CreateBenefit200Response createBenefit(benefitCreateInputs)
 
-Create Benefit endpoint
+Creates a new member benefit for the organization (or an event, when scoped), requiring the \"create\" permission on benefits; the created benefit is returned and its list cache is invalidated.
 
 ### Example
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.createBenefit(
 # **deleteBenefit**
 > CreateAccountInvitations200Response deleteBenefit()
 
-Delete Benefit endpoint
+Permanently deletes the benefit identified by benefitId, requiring the \"del\" permission on benefits, and clears the benefit from cached list and detail queries.
 
 ### Example
 
@@ -117,7 +117,7 @@ const { status, data } = await apiInstance.deleteBenefit(
 # **getBenefit**
 > CreateBenefit200Response getBenefit()
 
-Get Benefit endpoint
+Returns the details of a single benefit by its ID; requires \"read\" permission on \"benefits\".
 
 ### Example
 
@@ -168,7 +168,7 @@ const { status, data } = await apiInstance.getBenefit(
 # **getBenefitClicks**
 > GetBenefitClicks200Response getBenefitClicks()
 
-Get Benefit Clicks endpoint
+Returns a paginated list of click-tracking records for the given benefit, supporting search and ordering; requires \"read\" permission on \"benefits\".
 
 ### Example
 
@@ -231,7 +231,7 @@ const { status, data } = await apiInstance.getBenefitClicks(
 # **getBenefits**
 > GetBenefits200Response getBenefits()
 
-Get Benefits endpoint
+Returns a paginated list of benefits for the organization, optionally filtered to a specific event, with support for search and ordering; requires \"read\" permission on \"benefits\".
 
 ### Example
 
@@ -294,7 +294,7 @@ const { status, data } = await apiInstance.getBenefits(
 # **updateBenefit**
 > CreateBenefit200Response updateBenefit()
 
-Update Benefit endpoint
+Updates the fields of the benefit identified by benefitId, requiring the \"update\" permission on benefits, and returns the updated benefit.
 
 ### Example
 

package/docs/BenefitsTranslationsApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**deleteBenefitTranslation**](#deletebenefittranslation) | **DELETE** /benefits/{benefitId}/translations/{locale} | Delete Benefit Translation|
-|[**getBenefitTranslation**](#getbenefittranslation) | **GET** /benefits/{benefitId}/translations/{locale} | Get Benefit Translation|
-|[**getBenefitTranslations**](#getbenefittranslations) | **GET** /benefits/{benefitId}/translations | Get Benefit Translations|
-|[**updateBenefitTranslation**](#updatebenefittranslation) | **PUT** /benefits/{benefitId}/translations/{locale} | Update Benefit Translation|
+|[**deleteBenefitTranslation**](#deletebenefittranslation) | **DELETE** /benefits/{benefitId}/translations/{locale} | Delete a benefit translation|
+|[**getBenefitTranslation**](#getbenefittranslation) | **GET** /benefits/{benefitId}/translations/{locale} | Get a benefit\'s translation|
+|[**getBenefitTranslations**](#getbenefittranslations) | **GET** /benefits/{benefitId}/translations | List a benefit\'s translations|
+|[**updateBenefitTranslation**](#updatebenefittranslation) | **PUT** /benefits/{benefitId}/translations/{locale} | Update a benefit translation|
 
 # **deleteBenefitTranslation**
 > SyncAccounts200Response deleteBenefitTranslation()
 
-Delete Benefit Translation endpoint
+Removes the translation for the given benefit in the specified locale; requires update permission on benefits.
 
 ### Example
 
@@ -66,7 +66,7 @@ const { status, data } = await apiInstance.deleteBenefitTranslation(
 # **getBenefitTranslation**
 > GetBenefitTranslation200Response getBenefitTranslation()
 
-Get Benefit Translation endpoint
+Returns the translated text for a benefit in the given locale, or null if no translation exists for that locale; requires \"read\" permission on \"benefits\".
 
 ### Example
 
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.getBenefitTranslation(
 # **getBenefitTranslations**
 > GetBenefitTranslations200Response getBenefitTranslations()
 
-Get Benefit Translations endpoint
+Returns a paginated list of locale translations for the given benefit, supporting search and ordering; requires \"read\" permission on \"benefits\".
 
 ### Example
 
@@ -183,7 +183,7 @@ const { status, data } = await apiInstance.getBenefitTranslations(
 # **updateBenefitTranslation**
 > SyncAccounts200Response updateBenefitTranslation(benefitTranslationUpdateInputs)
 
-Update Benefit Translation endpoint
+Creates or updates the translated content (e.g. title, description) for the given benefit in the specified locale; requires update permission on benefits.
 
 ### Example