@connectedxm/admin-sdk 11.23.1 → 12.1.0

package/docs/AnnouncementsTemplatesApi.md

@@ -0,0 +1,281 @@
+# AnnouncementsTemplatesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createAnnouncementTemplate**](#createannouncementtemplate) | **POST** /announcements/templates | Create an announcement template|
+|[**deleteAnnouncementTemplate**](#deleteannouncementtemplate) | **DELETE** /announcements/templates/{templateId} | Delete an announcement template|
+|[**getAnnouncementTemplate**](#getannouncementtemplate) | **GET** /announcements/templates/{templateId} | Get an announcement template|
+|[**getAnnouncementTemplates**](#getannouncementtemplates) | **GET** /announcements/templates | List announcement templates|
+|[**updateAnnouncementTemplate**](#updateannouncementtemplate) | **PUT** /announcements/templates/{templateId} | Update an announcement template|
+
+# **createAnnouncementTemplate**
+> CreateAnnouncementTemplate200Response createAnnouncementTemplate(announcementTemplateCreateInputs)
+
+Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTemplatesApi,
+    Configuration,
+    AnnouncementTemplateCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTemplatesApi(configuration);
+
+let announcementTemplateCreateInputs: AnnouncementTemplateCreateInputs; //
+
+const { status, data } = await apiInstance.createAnnouncementTemplate(
+    announcementTemplateCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementTemplateCreateInputs** | **AnnouncementTemplateCreateInputs**|  | |
+
+
+### Return type
+
+**CreateAnnouncementTemplate200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+
+# **deleteAnnouncementTemplate**
+> CreateAccountInvitations200Response deleteAnnouncementTemplate()
+
+Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTemplatesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTemplatesApi(configuration);
+
+let templateId: string; //The template identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteAnnouncementTemplate(
+    templateId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **templateId** | [**string**] | The template identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountInvitations200Response**
+
+### 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)
+
+# **getAnnouncementTemplate**
+> CreateAnnouncementTemplate200Response getAnnouncementTemplate()
+
+Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTemplatesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTemplatesApi(configuration);
+
+let templateId: string; //The template identifier (default to undefined)
+
+const { status, data } = await apiInstance.getAnnouncementTemplate(
+    templateId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **templateId** | [**string**] | The template identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAnnouncementTemplate200Response**
+
+### 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)
+
+# **getAnnouncementTemplates**
+> GetAnnouncementTemplates200Response getAnnouncementTemplates()
+
+Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTemplatesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTemplatesApi(configuration);
+
+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.getAnnouncementTemplates(
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAnnouncementTemplates200Response**
+
+### 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)
+
+# **updateAnnouncementTemplate**
+> CreateAnnouncementTemplate200Response updateAnnouncementTemplate(announcementTemplateUpdateInputs)
+
+Updates a template\'s name, description, default subject or HTML body. Announcements already created from the template keep their copied content; requires update permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTemplatesApi,
+    Configuration,
+    AnnouncementTemplateUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTemplatesApi(configuration);
+
+let templateId: string; //The template identifier (default to undefined)
+let announcementTemplateUpdateInputs: AnnouncementTemplateUpdateInputs; //
+
+const { status, data } = await apiInstance.updateAnnouncementTemplate(
+    templateId,
+    announcementTemplateUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementTemplateUpdateInputs** | **AnnouncementTemplateUpdateInputs**|  | |
+| **templateId** | [**string**] | The template identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAnnouncementTemplate200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+

package/docs/AnnouncementsTemplatesTranslationsApi.md

@@ -0,0 +1,240 @@
+# AnnouncementsTemplatesTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteAnnouncementTemplateTranslation**](#deleteannouncementtemplatetranslation) | **DELETE** /announcements/templates/{templateId}/translations/{locale} | Delete an announcement template translation|
+|[**getAnnouncementTemplateTranslation**](#getannouncementtemplatetranslation) | **GET** /announcements/templates/{templateId}/translations/{locale} | Get an announcement template\'s translation for a locale|
+|[**getAnnouncementTemplateTranslations**](#getannouncementtemplatetranslations) | **GET** /announcements/templates/{templateId}/translations | List an announcement template\'s translations|
+|[**updateAnnouncementTemplateTranslation**](#updateannouncementtemplatetranslation) | **PUT** /announcements/templates/{templateId}/translations/{locale} | Update an announcement template translation|
+
+# **deleteAnnouncementTemplateTranslation**
+> CreateAccountInvitations200Response deleteAnnouncementTemplateTranslation()
+
+Removes the translation of a template in the specified locale; requires update permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTemplatesTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTemplatesTranslationsApi(configuration);
+
+let templateId: string; //The template identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteAnnouncementTemplateTranslation(
+    templateId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **templateId** | [**string**] | The template identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountInvitations200Response**
+
+### 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)
+
+# **getAnnouncementTemplateTranslation**
+> GetAnnouncementTemplateTranslation200Response getAnnouncementTemplateTranslation()
+
+Returns the translated subject and HTML body of an announcement template for the specified locale, or null if no translation exists; requires read permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTemplatesTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTemplatesTranslationsApi(configuration);
+
+let templateId: string; //The template identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getAnnouncementTemplateTranslation(
+    templateId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **templateId** | [**string**] | The template identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetAnnouncementTemplateTranslation200Response**
+
+### 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)
+
+# **getAnnouncementTemplateTranslations**
+> GetAnnouncementTemplateTranslations200Response getAnnouncementTemplateTranslations()
+
+Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTemplatesTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTemplatesTranslationsApi(configuration);
+
+let templateId: string; //The template identifier (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.getAnnouncementTemplateTranslations(
+    templateId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **templateId** | [**string**] | The template identifier | 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|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAnnouncementTemplateTranslations200Response**
+
+### 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)
+
+# **updateAnnouncementTemplateTranslation**
+> UpdateAnnouncementTemplateTranslation200Response updateAnnouncementTemplateTranslation(announcementTemplateTranslationUpdateInputs)
+
+Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTemplatesTranslationsApi,
+    Configuration,
+    AnnouncementTemplateTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTemplatesTranslationsApi(configuration);
+
+let templateId: string; //The template identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let announcementTemplateTranslationUpdateInputs: AnnouncementTemplateTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateAnnouncementTemplateTranslation(
+    templateId,
+    locale,
+    announcementTemplateTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementTemplateTranslationUpdateInputs** | **AnnouncementTemplateTranslationUpdateInputs**|  | |
+| **templateId** | [**string**] | The template identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateAnnouncementTemplateTranslation200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+

package/docs/BaseAnnouncement.md

@@ -13,15 +13,14 @@ Name | Type | Description | Notes
 **push** | **boolean** |  | [default to undefined]
 **sms** | **boolean** |  | [default to undefined]
 **includePasses** | **boolean** |  | [default to undefined]
-**accountId** | **string** |  | [default to undefined]
 **creatorId** | **string** |  | [default to undefined]
 **eventId** | **string** |  | [default to undefined]
 **groupId** | **string** |  | [default to undefined]
-**tierId** | **string** |  | [default to undefined]
-**channelId** | **string** |  | [default to undefined]
-**ticketId** | **string** |  | [default to undefined]
+**audienceId** | **string** |  | [default to undefined]
 **userId** | **string** |  | [default to undefined]
 **schedule** | [**BaseSchedule**](BaseSchedule.md) |  | [default to undefined]
+**sentAt** | **string** |  | [default to undefined]
+**recipientCount** | **number** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 
 ## Example
@@ -38,15 +37,14 @@ const instance: BaseAnnouncement = {
     push,
     sms,
     includePasses,
-    accountId,
     creatorId,
     eventId,
     groupId,
-    tierId,
-    channelId,
-    ticketId,
+    audienceId,
     userId,
     schedule,
+    sentAt,
+    recipientCount,
     createdAt,
 };
 ```

package/docs/BaseAnnouncementAudience.md

@@ -0,0 +1,40 @@
+# BaseAnnouncementAudience
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**groupId** | **string** |  | [default to undefined]
+**channelId** | **string** |  | [default to undefined]
+**operator** | [**AnnouncementAudienceOperator**](AnnouncementAudienceOperator.md) |  | [default to undefined]
+**featured** | **boolean** |  | [default to undefined]
+**archived** | **boolean** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseAnnouncementAudience } from '@connectedxm/admin-sdk';
+
+const instance: BaseAnnouncementAudience = {
+    id,
+    name,
+    description,
+    eventId,
+    groupId,
+    channelId,
+    operator,
+    featured,
+    archived,
+    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/CreateAnnouncementAudience200Response.md

@@ -0,0 +1,24 @@
+# CreateAnnouncementAudience200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**AnnouncementAudience**](AnnouncementAudience.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateAnnouncementAudience200Response } from '@connectedxm/admin-sdk';
+
+const instance: CreateAnnouncementAudience200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/CreateAnnouncementAudienceCondition200Response.md

@@ -0,0 +1,24 @@
+# CreateAnnouncementAudienceCondition200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**AnnouncementAudienceCondition**](AnnouncementAudienceCondition.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateAnnouncementAudienceCondition200Response } from '@connectedxm/admin-sdk';
+
+const instance: CreateAnnouncementAudienceCondition200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/CreateAnnouncementAudienceFilter200Response.md

@@ -0,0 +1,24 @@
+# CreateAnnouncementAudienceFilter200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**AnnouncementAudienceFilter**](AnnouncementAudienceFilter.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateAnnouncementAudienceFilter200Response } from '@connectedxm/admin-sdk';
+
+const instance: CreateAnnouncementAudienceFilter200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/CreateAnnouncementTemplate200Response.md

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