@connectedxm/admin-sdk 6.17.4 → 6.18.1

package/docs/ChannelsTranslationsApi.md

@@ -0,0 +1,742 @@
+# ChannelsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteChannelContentGuestTranslation**](#deletechannelcontentguesttranslation) | **DELETE** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Delete Channel Content Guest Translation|
+|[**deleteChannelContentTranslation**](#deletechannelcontenttranslation) | **DELETE** /channels/{channelId}/contents/{contentId}/translations/{locale} | Delete Channel Content Translation|
+|[**deleteChannelTranslation**](#deletechanneltranslation) | **DELETE** /channels/{channelId}/translations/{locale} | Delete Channel Translation|
+|[**getChannelContentGuestTranslation**](#getchannelcontentguesttranslation) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Get Channel Content Guest Translation|
+|[**getChannelContentGuestTranslations**](#getchannelcontentguesttranslations) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations | Get Channel Content Guest Translations|
+|[**getChannelContentTranslation**](#getchannelcontenttranslation) | **GET** /channels/{channelId}/contents/{contentId}/translations/{locale} | Get Channel Content Translation|
+|[**getChannelContentTranslations**](#getchannelcontenttranslations) | **GET** /channels/{channelId}/contents/{contentId}/translations | Get Channel Content Translations|
+|[**getChannelTranslation**](#getchanneltranslation) | **GET** /channels/{channelId}/translations/{locale} | Get Channel Translation|
+|[**getChannelTranslations**](#getchanneltranslations) | **GET** /channels/{channelId}/translations | Get Channel Translations|
+|[**updateChannelContentGuestTranslation**](#updatechannelcontentguesttranslation) | **PUT** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Update Channel Content Guest Translation|
+|[**updateChannelContentTranslation**](#updatechannelcontenttranslation) | **PUT** /channels/{channelId}/contents/{contentId}/translations/{locale} | Update Channel Content Translation|
+|[**updateChannelTranslation**](#updatechanneltranslation) | **PUT** /channels/{channelId}/translations/{locale} | Update Channel Translation|
+
+# **deleteChannelContentGuestTranslation**
+> UpdateAnnouncementTranslation200Response deleteChannelContentGuestTranslation()
+
+Delete Channel Content Guest Translation endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let guestId: string; //The guest identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteChannelContentGuestTranslation(
+    channelId,
+    contentId,
+    guestId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **guestId** | [**string**] | The guest identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateAnnouncementTranslation200Response**
+
+### 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)
+
+# **deleteChannelContentTranslation**
+> UpdateAnnouncementTranslation200Response deleteChannelContentTranslation()
+
+Delete Channel Content Translation endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteChannelContentTranslation(
+    channelId,
+    contentId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateAnnouncementTranslation200Response**
+
+### 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)
+
+# **deleteChannelTranslation**
+> UpdateAnnouncementTranslation200Response deleteChannelTranslation()
+
+Delete Channel Translation endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteChannelTranslation(
+    channelId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateAnnouncementTranslation200Response**
+
+### 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)
+
+# **getChannelContentGuestTranslation**
+> GetChannelContentGuestTranslation200Response getChannelContentGuestTranslation()
+
+Get Channel Content Guest Translation endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let guestId: string; //The guest identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getChannelContentGuestTranslation(
+    channelId,
+    contentId,
+    guestId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **guestId** | [**string**] | The guest identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetChannelContentGuestTranslation200Response**
+
+### 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)
+
+# **getChannelContentGuestTranslations**
+> GetChannelContentGuestTranslations200Response getChannelContentGuestTranslations()
+
+Get Channel Content Guest Translations endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let guestId: string; //The guest 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.getChannelContentGuestTranslations(
+    channelId,
+    contentId,
+    guestId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **guestId** | [**string**] | The guest 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
+
+**GetChannelContentGuestTranslations200Response**
+
+### 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)
+
+# **getChannelContentTranslation**
+> GetChannelContentTranslation200Response getChannelContentTranslation()
+
+Get Channel Content Translation endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getChannelContentTranslation(
+    channelId,
+    contentId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetChannelContentTranslation200Response**
+
+### 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)
+
+# **getChannelContentTranslations**
+> GetChannelContentTranslations200Response getChannelContentTranslations()
+
+Get Channel Content Translations endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content 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.getChannelContentTranslations(
+    channelId,
+    contentId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content 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
+
+**GetChannelContentTranslations200Response**
+
+### 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)
+
+# **getChannelTranslation**
+> GetChannelTranslation200Response getChannelTranslation()
+
+Get Channel Translation endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getChannelTranslation(
+    channelId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetChannelTranslation200Response**
+
+### 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)
+
+# **getChannelTranslations**
+> GetChannelTranslations200Response getChannelTranslations()
+
+Get Channel Translations endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel 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.getChannelTranslations(
+    channelId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel 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
+
+**GetChannelTranslations200Response**
+
+### 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)
+
+# **updateChannelContentGuestTranslation**
+> UpdateChannelContentGuestTranslation200Response updateChannelContentGuestTranslation(channelContentGuestTranslationUpdateInputs)
+
+Update Channel Content Guest Translation endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration,
+    ChannelContentGuestTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let guestId: string; //The guest identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let channelContentGuestTranslationUpdateInputs: ChannelContentGuestTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateChannelContentGuestTranslation(
+    channelId,
+    contentId,
+    guestId,
+    locale,
+    channelContentGuestTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelContentGuestTranslationUpdateInputs** | **ChannelContentGuestTranslationUpdateInputs**|  | |
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **guestId** | [**string**] | The guest identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateChannelContentGuestTranslation200Response**
+
+### 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)
+
+# **updateChannelContentTranslation**
+> UpdateAnnouncementTranslation200Response updateChannelContentTranslation(channelContentTranslationUpdateInputs)
+
+Update Channel Content Translation endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration,
+    ChannelContentTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let channelContentTranslationUpdateInputs: ChannelContentTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateChannelContentTranslation(
+    channelId,
+    contentId,
+    locale,
+    channelContentTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelContentTranslationUpdateInputs** | **ChannelContentTranslationUpdateInputs**|  | |
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateAnnouncementTranslation200Response**
+
+### 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)
+
+# **updateChannelTranslation**
+> UpdateChannelTranslation200Response updateChannelTranslation(channelTranslationUpdateInputs)
+
+Update Channel Translation endpoint
+
+### Example
+
+```typescript
+import {
+    ChannelsTranslationsApi,
+    Configuration,
+    ChannelTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsTranslationsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let channelTranslationUpdateInputs: ChannelTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateChannelTranslation(
+    channelId,
+    locale,
+    channelTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelTranslationUpdateInputs** | **ChannelTranslationUpdateInputs**|  | |
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateChannelTranslation200Response**
+
+### 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)
+