@connectedxm/admin-sdk 11.23.1 → 12.0.0

package/docs/AnnouncementAudienceFilter.md

@@ -0,0 +1,32 @@
+# AnnouncementAudienceFilter
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**parentFilterId** | **string** |  | [default to undefined]
+**operator** | [**AnnouncementAudienceOperator**](AnnouncementAudienceOperator.md) |  | [default to undefined]
+**sortOrder** | **number** |  | [default to undefined]
+**conditions** | [**Array<AnnouncementAudienceCondition>**](AnnouncementAudienceCondition.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementAudienceFilter } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementAudienceFilter = {
+    id,
+    parentFilterId,
+    operator,
+    sortOrder,
+    conditions,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementAudienceFilterCreateInputs.md

@@ -0,0 +1,24 @@
+# AnnouncementAudienceFilterCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parentFilterId** | **string** |  | [optional] [default to undefined]
+**operator** | [**AnnouncementAudienceOperator**](AnnouncementAudienceOperator.md) |  | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementAudienceFilterCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementAudienceFilterCreateInputs = {
+    parentFilterId,
+    operator,
+    sortOrder,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementAudienceFilterUpdateInputs.md

@@ -0,0 +1,22 @@
+# AnnouncementAudienceFilterUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operator** | [**AnnouncementAudienceOperator**](AnnouncementAudienceOperator.md) |  | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementAudienceFilterUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementAudienceFilterUpdateInputs = {
+    operator,
+    sortOrder,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementAudienceOperator.md

@@ -0,0 +1,10 @@
+# AnnouncementAudienceOperator
+
+
+## Enum
+
+* `And` (value: `'AND'`)
+
+* `Or` (value: `'OR'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementAudienceReference.md

@@ -0,0 +1,26 @@
+# AnnouncementAudienceReference
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**groupId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementAudienceReference } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementAudienceReference = {
+    id,
+    name,
+    eventId,
+    groupId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementAudienceScope.md

@@ -0,0 +1,24 @@
+# AnnouncementAudienceScope
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**eventId** | **string** |  | [optional] [default to undefined]
+**groupId** | **string** |  | [optional] [default to undefined]
+**channelId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementAudienceScope } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementAudienceScope = {
+    eventId,
+    groupId,
+    channelId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementAudienceUpdateInputs.md

@@ -0,0 +1,24 @@
+# AnnouncementAudienceUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**operator** | [**AnnouncementAudienceOperator**](AnnouncementAudienceOperator.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementAudienceUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementAudienceUpdateInputs = {
+    name,
+    description,
+    operator,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementCreateInputs.md

@@ -5,20 +5,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** |  | [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
 **html** | **string** |  | [optional] [default to undefined]
+**templateId** | **string** |  | [optional] [default to undefined]
 **slug** | **string** |  | [optional] [default to undefined]
 **creatorId** | **string** |  | [optional] [default to undefined]
 **eventId** | **string** |  | [optional] [default to undefined]
 **groupId** | **string** |  | [optional] [default to undefined]
-**tierId** | **string** |  | [optional] [default to undefined]
-**channelId** | **string** |  | [optional] [default to undefined]
-**accountId** | **string** |  | [optional] [default to undefined]
-**verifiedAccounts** | **boolean** |  | [optional] [default to undefined]
-**sponsorshipLevelId** | **string** |  | [optional] [default to undefined]
+**audienceId** | **string** |  | [optional] [default to undefined]
 **email** | **boolean** |  | [optional] [default to undefined]
 **push** | **boolean** |  | [optional] [default to undefined]
-**filters** | [**EventAnnouncementFilters**](EventAnnouncementFilters.md) |  | [optional] [default to undefined]
 **includePasses** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
@@ -29,18 +25,14 @@ import { AnnouncementCreateInputs } from '@connectedxm/admin-sdk';
 const instance: AnnouncementCreateInputs = {
     title,
     html,
+    templateId,
     slug,
     creatorId,
     eventId,
     groupId,
-    tierId,
-    channelId,
-    accountId,
-    verifiedAccounts,
-    sponsorshipLevelId,
+    audienceId,
     email,
     push,
-    filters,
     includePasses,
 };
 ```

package/docs/AnnouncementFilters.md

@@ -5,13 +5,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**verifiedAccounts** | **boolean** |  | [optional] [default to undefined]
 **eventId** | **string** |  | [optional] [default to undefined]
 **groupId** | **string** |  | [optional] [default to undefined]
-**tierId** | **string** |  | [optional] [default to undefined]
-**channelId** | **string** |  | [optional] [default to undefined]
-**accountId** | **string** |  | [optional] [default to undefined]
-**sponsorshipLevelId** | **string** |  | [optional] [default to undefined]
+**audienceId** | **string** |  | [optional] [default to undefined]
+**community** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -19,13 +16,10 @@ Name | Type | Description | Notes
 import { AnnouncementFilters } from '@connectedxm/admin-sdk';
 
 const instance: AnnouncementFilters = {
-    verifiedAccounts,
     eventId,
     groupId,
-    tierId,
-    channelId,
-    accountId,
-    sponsorshipLevelId,
+    audienceId,
+    community,
 };
 ```
 

package/docs/AnnouncementMergeField.md

@@ -0,0 +1,24 @@
+# AnnouncementMergeField
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** |  | [default to undefined]
+**label** | **string** |  | [default to undefined]
+**group** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementMergeField } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementMergeField = {
+    token,
+    label,
+    group,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementTemplate.md

@@ -0,0 +1,32 @@
+# AnnouncementTemplate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**html** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementTemplate } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementTemplate = {
+    id,
+    name,
+    description,
+    title,
+    html,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementTemplateCreateInputs.md

@@ -0,0 +1,26 @@
+# AnnouncementTemplateCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**html** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementTemplateCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementTemplateCreateInputs = {
+    name,
+    description,
+    title,
+    html,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementTemplateTranslation.md

@@ -0,0 +1,30 @@
+# AnnouncementTemplateTranslation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**locale** | **string** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**html** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementTemplateTranslation } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementTemplateTranslation = {
+    id,
+    locale,
+    title,
+    html,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementTemplateTranslationUpdateInputs.md

@@ -0,0 +1,22 @@
+# AnnouncementTemplateTranslationUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** |  | [optional] [default to undefined]
+**html** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementTemplateTranslationUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementTemplateTranslationUpdateInputs = {
+    title,
+    html,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementTemplateUpdateInputs.md

@@ -0,0 +1,26 @@
+# AnnouncementTemplateUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**html** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementTemplateUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementTemplateUpdateInputs = {
+    name,
+    description,
+    title,
+    html,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AnnouncementUpdateInputs.md

@@ -8,9 +8,9 @@ Name | Type | Description | Notes
 **title** | **string** |  | [optional] [default to undefined]
 **html** | **string** |  | [optional] [default to undefined]
 **slug** | **string** |  | [optional] [default to undefined]
+**audienceId** | **string** |  | [optional] [default to undefined]
 **email** | **boolean** |  | [optional] [default to undefined]
 **push** | **boolean** |  | [optional] [default to undefined]
-**filters** | [**EventAnnouncementFilters**](EventAnnouncementFilters.md) |  | [optional] [default to undefined]
 **includePasses** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
@@ -22,9 +22,9 @@ const instance: AnnouncementUpdateInputs = {
     title,
     html,
     slug,
+    audienceId,
     email,
     push,
-    filters,
     includePasses,
 };
 ```

package/docs/AnnouncementsApi.md

@@ -7,8 +7,9 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**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|
+|[**getAnnouncementMergeFields**](#getannouncementmergefields) | **GET** /announcements/merge-fields | List announcement merge fields|
+|[**getAnnouncementRecipients**](#getannouncementrecipients) | **GET** /announcements/{announcementId}/audience | List an announcement\'s recipients|
 |[**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|
@@ -16,7 +17,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 # **createAnnouncement**
 > CreateAnnouncement200Response createAnnouncement(announcementCreateInputs)
 
-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.
+Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
 
 ### Example
 
@@ -167,10 +168,10 @@ const { status, data } = await apiInstance.getAnnouncement(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **getAnnouncementAudience**
-> GetAnnouncementAudience200Response getAnnouncementAudience()
+# **getAnnouncementEmailReceipts**
+> GetAcccountEmailReceipts200Response getAnnouncementEmailReceipts()
 
-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.
+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
 
@@ -184,13 +185,15 @@ const configuration = new Configuration();
 const apiInstance = new AnnouncementsApi(configuration);
 
 let announcementId: string; //The announcement identifier (default to undefined)
+let status: EmailReceiptStatus; //Filter by status (optional) (default to undefined)
 let page: number; //Page number (optional) (default to 1)
 let pageSize: number; //Number of items per page (optional) (default to 25)
 let orderBy: string; //Field to order by (optional) (default to undefined)
 let search: string; //Search query (optional) (default to undefined)
 
-const { status, data } = await apiInstance.getAnnouncementAudience(
+const { status, data } = await apiInstance.getAnnouncementEmailReceipts(
     announcementId,
+    status,
     page,
     pageSize,
     orderBy,
@@ -203,6 +206,7 @@ const { status, data } = await apiInstance.getAnnouncementAudience(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **announcementId** | [**string**] | The announcement identifier | defaults to undefined|
+| **status** | **EmailReceiptStatus** | Filter by status | (optional) defaults to undefined|
 | **page** | [**number**] | Page number | (optional) defaults to 1|
 | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
 | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
@@ -211,7 +215,7 @@ const { status, data } = await apiInstance.getAnnouncementAudience(
 
 ### Return type
 
-**GetAnnouncementAudience200Response**
+**GetAcccountEmailReceipts200Response**
 
 ### Authorization
 
@@ -230,10 +234,54 @@ const { status, data } = await apiInstance.getAnnouncementAudience(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **getAnnouncementEmailReceipts**
-> GetAcccountEmailReceipts200Response getAnnouncementEmailReceipts()
+# **getAnnouncementMergeFields**
+> GetAnnouncementMergeFields200Response getAnnouncementMergeFields()
 
-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.
+Returns the merge fields an announcement can use: the core account fields plus every account attribute that isn\'t admin-only, ordered by attribute sort order; requires read permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsApi(configuration);
+
+const { status, data } = await apiInstance.getAnnouncementMergeFields();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetAnnouncementMergeFields200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getAnnouncementRecipients**
+> GetAnnouncementAudienceAccounts200Response getAnnouncementRecipients()
+
+Returns a paginated list of the accounts an announcement reaches: its audience when it has one, otherwise everyone in its event, group or community, excluding banned accounts; supports search and ordering; requires read permission on announcements.
 
 ### Example
 
@@ -247,15 +295,13 @@ const configuration = new Configuration();
 const apiInstance = new AnnouncementsApi(configuration);
 
 let announcementId: string; //The announcement identifier (default to undefined)
-let status: EmailReceiptStatus; //Filter by status (optional) (default to undefined)
 let page: number; //Page number (optional) (default to 1)
 let pageSize: number; //Number of items per page (optional) (default to 25)
 let orderBy: string; //Field to order by (optional) (default to undefined)
 let search: string; //Search query (optional) (default to undefined)
 
-const { status, data } = await apiInstance.getAnnouncementEmailReceipts(
+const { status, data } = await apiInstance.getAnnouncementRecipients(
     announcementId,
-    status,
     page,
     pageSize,
     orderBy,
@@ -268,7 +314,6 @@ const { status, data } = await apiInstance.getAnnouncementEmailReceipts(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **announcementId** | [**string**] | The announcement identifier | defaults to undefined|
-| **status** | **EmailReceiptStatus** | Filter by status | (optional) defaults to undefined|
 | **page** | [**number**] | Page number | (optional) defaults to 1|
 | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
 | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
@@ -277,7 +322,7 @@ const { status, data } = await apiInstance.getAnnouncementEmailReceipts(
 
 ### Return type
 
-**GetAcccountEmailReceipts200Response**
+**GetAnnouncementAudienceAccounts200Response**
 
 ### Authorization
 
@@ -299,7 +344,7 @@ const { status, data } = await apiInstance.getAnnouncementEmailReceipts(
 # **getAnnouncements**
 > GetAnnouncements200Response getAnnouncements()
 
-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.
+Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
 
 ### Example
 
@@ -363,23 +408,26 @@ const { status, data } = await apiInstance.getAnnouncements(
 # **sendAnnouncementPreview**
 > CreateAccountInvitations200Response sendAnnouncementPreview()
 
-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.
+Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
 
 ### Example
 
 ```typescript
 import {
     AnnouncementsApi,
-    Configuration
+    Configuration,
+    SendAnnouncementPreviewRequest
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new AnnouncementsApi(configuration);
 
 let announcementId: string; //The announcement identifier (default to undefined)
+let sendAnnouncementPreviewRequest: SendAnnouncementPreviewRequest; // (optional)
 
 const { status, data } = await apiInstance.sendAnnouncementPreview(
-    announcementId
+    announcementId,
+    sendAnnouncementPreviewRequest
 );
 ```
 
@@ -387,6 +435,7 @@ const { status, data } = await apiInstance.sendAnnouncementPreview(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **sendAnnouncementPreviewRequest** | **SendAnnouncementPreviewRequest**|  | |
 | **announcementId** | [**string**] | The announcement identifier | defaults to undefined|
 
 
@@ -400,7 +449,7 @@ const { status, data } = await apiInstance.sendAnnouncementPreview(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json