@connectedxm/admin-sdk 6.17.4 → 6.20.0

package/docs/SeriesTranslationsApi.md

@@ -0,0 +1,240 @@
+# SeriesTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteSeriesTranslation**](#deleteseriestranslation) | **DELETE** /series/{seriesId}/translations/{locale} | Delete Series Translation|
+|[**getSeriesTranslation**](#getseriestranslation) | **GET** /series/{seriesId}/translations/{locale} | Get Series Translation|
+|[**getSeriesTranslations**](#getseriestranslations) | **GET** /series/{seriesId}/translations | Get Series Translations|
+|[**updateSeriesTranslation**](#updateseriestranslation) | **PUT** /series/{seriesId}/translations/{locale} | Update Series Translation|
+
+# **deleteSeriesTranslation**
+> UpdateAnnouncementTranslation200Response deleteSeriesTranslation()
+
+Delete Series Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesTranslationsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteSeriesTranslation(
+    seriesId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series 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)
+
+# **getSeriesTranslation**
+> GetSeriesTranslation200Response getSeriesTranslation()
+
+Get Series Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesTranslationsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getSeriesTranslation(
+    seriesId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetSeriesTranslation200Response**
+
+### 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)
+
+# **getSeriesTranslations**
+> GetSeriesTranslations200Response getSeriesTranslations()
+
+Get Series Translations endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesTranslationsApi(configuration);
+
+let seriesId: string; //The series 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.getSeriesTranslations(
+    seriesId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series 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
+
+**GetSeriesTranslations200Response**
+
+### 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)
+
+# **updateSeriesTranslation**
+> UpdateAnnouncementTranslation200Response updateSeriesTranslation(seriesTranslationUpdateInputs)
+
+Update Series Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesTranslationsApi,
+    Configuration,
+    SeriesTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesTranslationsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let seriesTranslationUpdateInputs: SeriesTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateSeriesTranslation(
+    seriesId,
+    locale,
+    seriesTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesTranslationUpdateInputs** | **SeriesTranslationUpdateInputs**|  | |
+| **seriesId** | [**string**] | The series 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)
+

package/docs/SponsorsTranslationsApi.md

@@ -0,0 +1,240 @@
+# SponsorsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteLevelTranslation**](#deleteleveltranslation) | **DELETE** /levels/{levelId}/translations/{locale} | Delete Level Translation|
+|[**getLevelTranslation**](#getleveltranslation) | **GET** /levels/{levelId}/translations/{locale} | Get Level Translation|
+|[**getLevelTranslations**](#getleveltranslations) | **GET** /levels/{levelId}/translations | Get Level Translations|
+|[**updateLevelTranslation**](#updateleveltranslation) | **PUT** /levels/{levelId}/translations/{locale} | Update Level Translation|
+
+# **deleteLevelTranslation**
+> UpdateAnnouncementTranslation200Response deleteLevelTranslation()
+
+Delete Level Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SponsorsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SponsorsTranslationsApi(configuration);
+
+let levelId: string; //The level identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteLevelTranslation(
+    levelId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **levelId** | [**string**] | The level 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)
+
+# **getLevelTranslation**
+> GetLevelTranslation200Response getLevelTranslation()
+
+Get Level Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SponsorsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SponsorsTranslationsApi(configuration);
+
+let levelId: string; //The level identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getLevelTranslation(
+    levelId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetLevelTranslation200Response**
+
+### 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)
+
+# **getLevelTranslations**
+> GetLevelTranslations200Response getLevelTranslations()
+
+Get Level Translations endpoint
+
+### Example
+
+```typescript
+import {
+    SponsorsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SponsorsTranslationsApi(configuration);
+
+let levelId: string; //The level 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.getLevelTranslations(
+    levelId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **levelId** | [**string**] | The level 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
+
+**GetLevelTranslations200Response**
+
+### 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)
+
+# **updateLevelTranslation**
+> UpdateAnnouncementTranslation200Response updateLevelTranslation(levelTranslationUpdateInputs)
+
+Update Level Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SponsorsTranslationsApi,
+    Configuration,
+    LevelTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SponsorsTranslationsApi(configuration);
+
+let levelId: string; //The level identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let levelTranslationUpdateInputs: LevelTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateLevelTranslation(
+    levelId,
+    locale,
+    levelTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **levelTranslationUpdateInputs** | **LevelTranslationUpdateInputs**|  | |
+| **levelId** | [**string**] | The level 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)
+

package/docs/StorageVideosApi.md

@@ -167,7 +167,7 @@ const { status, data } = await apiInstance.getVideo(
 [[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)
 
 # **getVideoDownloadStatus**
-> DeleteDashboard200Response getVideoDownloadStatus()
+> UpdateAnnouncementTranslation200Response getVideoDownloadStatus()
 
 Get Video Download Status endpoint
 
@@ -198,7 +198,7 @@ const { status, data } = await apiInstance.getVideoDownloadStatus(
 
 ### Return type
 
-**DeleteDashboard200Response**
+**UpdateAnnouncementTranslation200Response**
 
 ### Authorization
 
@@ -281,7 +281,7 @@ const { status, data } = await apiInstance.getVideos(
 [[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)
 
 # **initiateVideoDownload**
-> DeleteDashboard200Response initiateVideoDownload()
+> UpdateAnnouncementTranslation200Response initiateVideoDownload()
 
 Initiate Video Download endpoint
 
@@ -312,7 +312,7 @@ const { status, data } = await apiInstance.initiateVideoDownload(
 
 ### Return type
 
-**DeleteDashboard200Response**
+**UpdateAnnouncementTranslation200Response**
 
 ### Authorization
 

package/docs/StorageVideosCaptionsApi.md

@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.deleteVideoCaption(
 [[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)
 
 # **downloadVideoCaption**
-> DeleteDashboard200Response downloadVideoCaption()
+> UpdateAnnouncementTranslation200Response downloadVideoCaption()
 
 Download Video Caption endpoint
 
@@ -99,7 +99,7 @@ const { status, data } = await apiInstance.downloadVideoCaption(
 
 ### Return type
 
-**DeleteDashboard200Response**
+**UpdateAnnouncementTranslation200Response**
 
 ### Authorization
 

package/docs/SupportedLocale.md

@@ -35,8 +35,6 @@
 
 * `Nl` (value: `'nl'`)
 
-* `En` (value: `'en'`)
-
 * `Et` (value: `'et'`)
 
 * `Fi` (value: `'fi'`)

package/docs/SurveysQuestionsApi.md

@@ -1034,7 +1034,7 @@ const { status, data } = await apiInstance.updateSurveyQuestion(
 [[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)
 
 # **updateSurveyQuestionChoice**
-> DeleteDashboard200Response updateSurveyQuestionChoice()
+> UpdateAnnouncementTranslation200Response updateSurveyQuestionChoice()
 
 Update Survey Question Choice endpoint
 
@@ -1075,7 +1075,7 @@ const { status, data } = await apiInstance.updateSurveyQuestionChoice(
 
 ### Return type
 
-**DeleteDashboard200Response**
+**UpdateAnnouncementTranslation200Response**
 
 ### Authorization