@connectedxm/admin-sdk 6.17.4 → 6.18.1

package/docs/NotificationsApi.md

@@ -10,7 +10,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**markNotificationsRead**](#marknotificationsread) | **PUT** /notifications/read | Mark Notifications Read|
 
 # **getNotificationCount**
-> DeleteDashboard200Response getNotificationCount()
+> UpdateAnnouncementTranslation200Response getNotificationCount()
 
 Get Notification Count endpoint
 
@@ -42,7 +42,7 @@ const { status, data } = await apiInstance.getNotificationCount(
 
 ### Return type
 
-**DeleteDashboard200Response**
+**UpdateAnnouncementTranslation200Response**
 
 ### Authorization
 
@@ -170,7 +170,7 @@ const { status, data } = await apiInstance.getNotifications(
 [[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)
 
 # **markNotificationsRead**
-> DeleteDashboard200Response markNotificationsRead()
+> UpdateAnnouncementTranslation200Response markNotificationsRead()
 
 Mark Notifications Read endpoint
 
@@ -201,7 +201,7 @@ const { status, data } = await apiInstance.markNotificationsRead(
 
 ### Return type
 
-**DeleteDashboard200Response**
+**UpdateAnnouncementTranslation200Response**
 
 ### Authorization
 

package/docs/OrganizationModulesCustomTranslationsApi.md

@@ -0,0 +1,240 @@
+# OrganizationModulesCustomTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteCustomModuleTranslation**](#deletecustommoduletranslation) | **DELETE** /organization/modules/custom/{moduleId}/translations/{locale} | Delete Custom Module Translation|
+|[**getCustomModuleTranslation**](#getcustommoduletranslation) | **GET** /organization/modules/custom/{moduleId}/translations/{locale} | Get Custom Module Translation|
+|[**getCustomModuleTranslations**](#getcustommoduletranslations) | **GET** /organization/modules/custom/{moduleId}/translations | Get Custom Module Translations|
+|[**updateCustomModuleTranslation**](#updatecustommoduletranslation) | **PUT** /organization/modules/custom/{moduleId}/translations/{locale} | Update Custom Module Translation|
+
+# **deleteCustomModuleTranslation**
+> CreateAccountInvitations200Response deleteCustomModuleTranslation()
+
+Delete Custom Module Translation endpoint
+
+### Example
+
+```typescript
+import {
+    OrganizationModulesCustomTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationModulesCustomTranslationsApi(configuration);
+
+let moduleId: string; //The module identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteCustomModuleTranslation(
+    moduleId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **moduleId** | [**string**] | The module 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)
+
+# **getCustomModuleTranslation**
+> GetCustomModuleTranslation200Response getCustomModuleTranslation()
+
+Get Custom Module Translation endpoint
+
+### Example
+
+```typescript
+import {
+    OrganizationModulesCustomTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationModulesCustomTranslationsApi(configuration);
+
+let moduleId: string; //The module identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getCustomModuleTranslation(
+    moduleId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **moduleId** | [**string**] | The module identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetCustomModuleTranslation200Response**
+
+### 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)
+
+# **getCustomModuleTranslations**
+> GetCustomModuleTranslations200Response getCustomModuleTranslations()
+
+Get Custom Module Translations endpoint
+
+### Example
+
+```typescript
+import {
+    OrganizationModulesCustomTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationModulesCustomTranslationsApi(configuration);
+
+let moduleId: string; //The module 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.getCustomModuleTranslations(
+    moduleId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **moduleId** | [**string**] | The module 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
+
+**GetCustomModuleTranslations200Response**
+
+### 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)
+
+# **updateCustomModuleTranslation**
+> GetCustomModuleTranslation200Response updateCustomModuleTranslation(customModuleTranslationUpdateInputs)
+
+Update Custom Module Translation endpoint
+
+### Example
+
+```typescript
+import {
+    OrganizationModulesCustomTranslationsApi,
+    Configuration,
+    CustomModuleTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationModulesCustomTranslationsApi(configuration);
+
+let moduleId: string; //The module identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let customModuleTranslationUpdateInputs: CustomModuleTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateCustomModuleTranslation(
+    moduleId,
+    locale,
+    customModuleTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **customModuleTranslationUpdateInputs** | **CustomModuleTranslationUpdateInputs**|  | |
+| **moduleId** | [**string**] | The module identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetCustomModuleTranslation200Response**
+
+### 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/OrganizationModulesSettingsTranslationsApi.md

@@ -0,0 +1,228 @@
+# OrganizationModulesSettingsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteOrganizationModuleSettingsTranslation**](#deleteorganizationmodulesettingstranslation) | **DELETE** /organization/module-settings/translations/{locale} | Delete Organization Module Settings Translation|
+|[**getOrganizationModuleSettingsTranslation**](#getorganizationmodulesettingstranslation) | **GET** /organization/module-settings/translations/{locale} | Get Organization Module Settings Translation|
+|[**getOrganizationModuleSettingsTranslations**](#getorganizationmodulesettingstranslations) | **GET** /organization/module-settings/translations | Get Organization Module Settings Translations|
+|[**updateOrganizationModuleSettingsTranslation**](#updateorganizationmodulesettingstranslation) | **PUT** /organization/module-settings/translations/{locale} | Update Organization Module Settings Translation|
+
+# **deleteOrganizationModuleSettingsTranslation**
+> UpdateAnnouncementTranslation200Response deleteOrganizationModuleSettingsTranslation()
+
+Delete Organization Module Settings Translation endpoint
+
+### Example
+
+```typescript
+import {
+    OrganizationModulesSettingsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationModulesSettingsTranslationsApi(configuration);
+
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteOrganizationModuleSettingsTranslation(
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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)
+
+# **getOrganizationModuleSettingsTranslation**
+> GetOrganizationModuleSettingsTranslation200Response getOrganizationModuleSettingsTranslation()
+
+Get Organization Module Settings Translation endpoint
+
+### Example
+
+```typescript
+import {
+    OrganizationModulesSettingsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationModulesSettingsTranslationsApi(configuration);
+
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getOrganizationModuleSettingsTranslation(
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetOrganizationModuleSettingsTranslation200Response**
+
+### 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)
+
+# **getOrganizationModuleSettingsTranslations**
+> GetOrganizationModuleSettingsTranslations200Response getOrganizationModuleSettingsTranslations()
+
+Get Organization Module Settings Translations endpoint
+
+### Example
+
+```typescript
+import {
+    OrganizationModulesSettingsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationModulesSettingsTranslationsApi(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.getOrganizationModuleSettingsTranslations(
+    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
+
+**GetOrganizationModuleSettingsTranslations200Response**
+
+### 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)
+
+# **updateOrganizationModuleSettingsTranslation**
+> UpdateAnnouncementTranslation200Response updateOrganizationModuleSettingsTranslation(organizationModuleSettingsTranslationUpdateInputs)
+
+Update Organization Module Settings Translation endpoint
+
+### Example
+
+```typescript
+import {
+    OrganizationModulesSettingsTranslationsApi,
+    Configuration,
+    OrganizationModuleSettingsTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new OrganizationModulesSettingsTranslationsApi(configuration);
+
+let locale: string; //The locale identifier (default to undefined)
+let organizationModuleSettingsTranslationUpdateInputs: OrganizationModuleSettingsTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateOrganizationModuleSettingsTranslation(
+    locale,
+    organizationModuleSettingsTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **organizationModuleSettingsTranslationUpdateInputs** | **OrganizationModuleSettingsTranslationUpdateInputs**|  | |
+| **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/OrganizationPaymentsApi.md

@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.createOrganizationPaymentIntegration(
 [[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)
 
 # **deleteOrganizationPaymentIntegration**
-> DeleteDashboard200Response deleteOrganizationPaymentIntegration()
+> UpdateAnnouncementTranslation200Response deleteOrganizationPaymentIntegration()
 
 Delete Organization Payment Integration endpoint
 
@@ -98,7 +98,7 @@ const { status, data } = await apiInstance.deleteOrganizationPaymentIntegration(
 
 ### Return type
 
-**DeleteDashboard200Response**
+**UpdateAnnouncementTranslation200Response**
 
 ### Authorization
 

package/docs/OrganizationTeammembersApi.md

@@ -114,7 +114,7 @@ const { status, data } = await apiInstance.deleteOrganizationTeamMember(
 [[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)
 
 # **getOrganizationTeamMember**
-> DeleteDashboard200Response getOrganizationTeamMember()
+> UpdateAnnouncementTranslation200Response getOrganizationTeamMember()
 
 Get Organization Team Member endpoint
 
@@ -145,7 +145,7 @@ const { status, data } = await apiInstance.getOrganizationTeamMember(
 
 ### Return type
 
-**DeleteDashboard200Response**
+**UpdateAnnouncementTranslation200Response**
 
 ### Authorization
 

package/docs/SeriesQuestionsTranslationsApi.md

@@ -0,0 +1,127 @@
+# SeriesQuestionsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getSeriesQuestionTranslation**](#getseriesquestiontranslation) | **GET** /series/{seriesId}/questions/{questionId}/translations/{locale} | Get Series Question Translation|
+|[**updateSeriesQuestionTranslation**](#updateseriesquestiontranslation) | **PUT** /series/{seriesId}/questions/{questionId}/translations/{locale} | Update Series Question Translation|
+
+# **getSeriesQuestionTranslation**
+> GetSeriesQuestionTranslation200Response getSeriesQuestionTranslation()
+
+Get Series Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsTranslationsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getSeriesQuestionTranslation(
+    seriesId,
+    questionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetSeriesQuestionTranslation200Response**
+
+### 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)
+
+# **updateSeriesQuestionTranslation**
+> UpdateSeriesQuestionTranslation200Response updateSeriesQuestionTranslation(seriesQuestionTranslationUpdateInputs)
+
+Update Series Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsTranslationsApi,
+    Configuration,
+    SeriesQuestionTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsTranslationsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let seriesQuestionTranslationUpdateInputs: SeriesQuestionTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateSeriesQuestionTranslation(
+    seriesId,
+    questionId,
+    locale,
+    seriesQuestionTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesQuestionTranslationUpdateInputs** | **SeriesQuestionTranslationUpdateInputs**|  | |
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateSeriesQuestionTranslation200Response**
+
+### 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)
+