@connectedxm/admin-sdk 11.23.1 → 12.1.0

package/docs/AnnouncementsAudiencesApi.md

@@ -0,0 +1,698 @@
+# AnnouncementsAudiencesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createAnnouncementAudience**](#createannouncementaudience) | **POST** /announcements/audiences | Create an announcement audience|
+|[**createAnnouncementAudienceCondition**](#createannouncementaudiencecondition) | **POST** /announcements/audiences/{audienceId}/filters/{filterId}/conditions | Create an audience condition|
+|[**createAnnouncementAudienceFilter**](#createannouncementaudiencefilter) | **POST** /announcements/audiences/{audienceId}/filters | Create an audience filter group|
+|[**deleteAnnouncementAudience**](#deleteannouncementaudience) | **DELETE** /announcements/audiences/{audienceId} | Delete an announcement audience|
+|[**deleteAnnouncementAudienceCondition**](#deleteannouncementaudiencecondition) | **DELETE** /announcements/audiences/{audienceId}/filters/{filterId}/conditions/{conditionId} | Delete an audience condition|
+|[**deleteAnnouncementAudienceFilter**](#deleteannouncementaudiencefilter) | **DELETE** /announcements/audiences/{audienceId}/filters/{filterId} | Delete an audience filter group|
+|[**getAnnouncementAudience**](#getannouncementaudience) | **GET** /announcements/audiences/{audienceId} | Get an announcement audience|
+|[**getAnnouncementAudienceAccounts**](#getannouncementaudienceaccounts) | **GET** /announcements/audiences/{audienceId}/accounts | List the accounts in an announcement audience|
+|[**getAnnouncementAudiences**](#getannouncementaudiences) | **GET** /announcements/audiences | List announcement audiences|
+|[**updateAnnouncementAudience**](#updateannouncementaudience) | **PUT** /announcements/audiences/{audienceId} | Update an announcement audience|
+|[**updateAnnouncementAudienceCondition**](#updateannouncementaudiencecondition) | **PUT** /announcements/audiences/{audienceId}/filters/{filterId}/conditions/{conditionId} | Update an audience condition|
+|[**updateAnnouncementAudienceFilter**](#updateannouncementaudiencefilter) | **PUT** /announcements/audiences/{audienceId}/filters/{filterId} | Update an audience filter group|
+
+# **createAnnouncementAudience**
+> CreateAnnouncementAudience200Response createAnnouncementAudience(announcementAudienceCreateInputs)
+
+Creates an audience scoped to an event (eventId), a group (groupId), a channel (channelId), or the whole community (none); the scope cannot be changed afterwards; requires create permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration,
+    AnnouncementAudienceCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let announcementAudienceCreateInputs: AnnouncementAudienceCreateInputs; //
+
+const { status, data } = await apiInstance.createAnnouncementAudience(
+    announcementAudienceCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementAudienceCreateInputs** | **AnnouncementAudienceCreateInputs**|  | |
+
+
+### Return type
+
+**CreateAnnouncementAudience200Response**
+
+### 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)
+
+# **createAnnouncementAudienceCondition**
+> CreateAnnouncementAudienceCondition200Response createAnnouncementAudienceCondition(announcementAudienceConditionCreateInputs)
+
+Adds a condition to a filter group; each type requires its own reference (e.g. passTypeId for eventPassType), event conditions inside an event audience always use that event, and every reference must belong to the organization; requires update permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration,
+    AnnouncementAudienceConditionCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let audienceId: string; //The audience identifier (default to undefined)
+let filterId: string; //The filter identifier (default to undefined)
+let announcementAudienceConditionCreateInputs: AnnouncementAudienceConditionCreateInputs; //
+
+const { status, data } = await apiInstance.createAnnouncementAudienceCondition(
+    audienceId,
+    filterId,
+    announcementAudienceConditionCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementAudienceConditionCreateInputs** | **AnnouncementAudienceConditionCreateInputs**|  | |
+| **audienceId** | [**string**] | The audience identifier | defaults to undefined|
+| **filterId** | [**string**] | The filter identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAnnouncementAudienceCondition200Response**
+
+### 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)
+
+# **createAnnouncementAudienceFilter**
+> CreateAnnouncementAudienceFilter200Response createAnnouncementAudienceFilter(announcementAudienceFilterCreateInputs)
+
+Adds an AND/OR filter group to an audience, at the root or nested under parentFilterId (which must belong to the same audience); requires update permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration,
+    AnnouncementAudienceFilterCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let audienceId: string; //The audience identifier (default to undefined)
+let announcementAudienceFilterCreateInputs: AnnouncementAudienceFilterCreateInputs; //
+
+const { status, data } = await apiInstance.createAnnouncementAudienceFilter(
+    audienceId,
+    announcementAudienceFilterCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementAudienceFilterCreateInputs** | **AnnouncementAudienceFilterCreateInputs**|  | |
+| **audienceId** | [**string**] | The audience identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAnnouncementAudienceFilter200Response**
+
+### 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)
+
+# **deleteAnnouncementAudience**
+> CreateAccountInvitations200Response deleteAnnouncementAudience()
+
+Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let audienceId: string; //The audience identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteAnnouncementAudience(
+    audienceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **audienceId** | [**string**] | The audience 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)
+
+# **deleteAnnouncementAudienceCondition**
+> CreateAccountInvitations200Response deleteAnnouncementAudienceCondition()
+
+Removes a condition from its filter group; requires update permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let audienceId: string; //The audience identifier (default to undefined)
+let filterId: string; //The filter identifier (default to undefined)
+let conditionId: string; //The condition identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteAnnouncementAudienceCondition(
+    audienceId,
+    filterId,
+    conditionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **audienceId** | [**string**] | The audience identifier | defaults to undefined|
+| **filterId** | [**string**] | The filter identifier | defaults to undefined|
+| **conditionId** | [**string**] | The condition 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)
+
+# **deleteAnnouncementAudienceFilter**
+> CreateAccountInvitations200Response deleteAnnouncementAudienceFilter()
+
+Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let audienceId: string; //The audience identifier (default to undefined)
+let filterId: string; //The filter identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteAnnouncementAudienceFilter(
+    audienceId,
+    filterId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **audienceId** | [**string**] | The audience identifier | defaults to undefined|
+| **filterId** | [**string**] | The filter 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)
+
+# **getAnnouncementAudience**
+> CreateAnnouncementAudience200Response getAnnouncementAudience()
+
+Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let audienceId: string; //The audience identifier (default to undefined)
+
+const { status, data } = await apiInstance.getAnnouncementAudience(
+    audienceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **audienceId** | [**string**] | The audience identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAnnouncementAudience200Response**
+
+### 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)
+
+# **getAnnouncementAudienceAccounts**
+> GetAnnouncementAudienceAccounts200Response getAnnouncementAudienceAccounts()
+
+Returns a paginated preview of the accounts an audience currently matches, with the total in count; supports search and ordering; requires read permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let audienceId: string; //The audience 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.getAnnouncementAudienceAccounts(
+    audienceId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **audienceId** | [**string**] | The audience 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
+
+**GetAnnouncementAudienceAccounts200Response**
+
+### 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)
+
+# **getAnnouncementAudiences**
+> GetAnnouncementAudiences200Response getAnnouncementAudiences()
+
+Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration,
+    AnnouncementAudienceScope
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let scope: AnnouncementAudienceScope; //Filter by scope (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.getAnnouncementAudiences(
+    scope,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **scope** | **AnnouncementAudienceScope** | Filter by scope | (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|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAnnouncementAudiences200Response**
+
+### 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)
+
+# **updateAnnouncementAudience**
+> CreateAnnouncementAudience200Response updateAnnouncementAudience(announcementAudienceUpdateInputs)
+
+Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration,
+    AnnouncementAudienceUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let audienceId: string; //The audience identifier (default to undefined)
+let announcementAudienceUpdateInputs: AnnouncementAudienceUpdateInputs; //
+
+const { status, data } = await apiInstance.updateAnnouncementAudience(
+    audienceId,
+    announcementAudienceUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementAudienceUpdateInputs** | **AnnouncementAudienceUpdateInputs**|  | |
+| **audienceId** | [**string**] | The audience identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAnnouncementAudience200Response**
+
+### 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)
+
+# **updateAnnouncementAudienceCondition**
+> CreateAnnouncementAudienceCondition200Response updateAnnouncementAudienceCondition(announcementAudienceConditionUpdateInputs)
+
+Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration,
+    AnnouncementAudienceConditionUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let audienceId: string; //The audience identifier (default to undefined)
+let filterId: string; //The filter identifier (default to undefined)
+let conditionId: string; //The condition identifier (default to undefined)
+let announcementAudienceConditionUpdateInputs: AnnouncementAudienceConditionUpdateInputs; //
+
+const { status, data } = await apiInstance.updateAnnouncementAudienceCondition(
+    audienceId,
+    filterId,
+    conditionId,
+    announcementAudienceConditionUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementAudienceConditionUpdateInputs** | **AnnouncementAudienceConditionUpdateInputs**|  | |
+| **audienceId** | [**string**] | The audience identifier | defaults to undefined|
+| **filterId** | [**string**] | The filter identifier | defaults to undefined|
+| **conditionId** | [**string**] | The condition identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAnnouncementAudienceCondition200Response**
+
+### 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)
+
+# **updateAnnouncementAudienceFilter**
+> CreateAnnouncementAudienceFilter200Response updateAnnouncementAudienceFilter(announcementAudienceFilterUpdateInputs)
+
+Changes a filter group\'s operator or sort order; requires update permission on announcements.
+
+### Example
+
+```typescript
+import {
+    AnnouncementsAudiencesApi,
+    Configuration,
+    AnnouncementAudienceFilterUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsAudiencesApi(configuration);
+
+let audienceId: string; //The audience identifier (default to undefined)
+let filterId: string; //The filter identifier (default to undefined)
+let announcementAudienceFilterUpdateInputs: AnnouncementAudienceFilterUpdateInputs; //
+
+const { status, data } = await apiInstance.updateAnnouncementAudienceFilter(
+    audienceId,
+    filterId,
+    announcementAudienceFilterUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementAudienceFilterUpdateInputs** | **AnnouncementAudienceFilterUpdateInputs**|  | |
+| **audienceId** | [**string**] | The audience identifier | defaults to undefined|
+| **filterId** | [**string**] | The filter identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAnnouncementAudienceFilter200Response**
+
+### 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)
+