@connectedxm/admin-sdk 6.17.4 → 6.20.0

package/docs/EventsFaqsTranslationsApi.md

@@ -0,0 +1,509 @@
+# EventsFaqsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventFaqSectionQuestionTranslation**](#deleteeventfaqsectionquestiontranslation) | **DELETE** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations/{locale} | Delete Event Faq Section Question Translation|
+|[**deleteEventFaqSectionTranslation**](#deleteeventfaqsectiontranslation) | **DELETE** /events/{eventId}/faqs/{sectionId}/translations/{locale} | Delete Event Faq Section Translation|
+|[**getEventFaqSectionQuestionTranslation**](#geteventfaqsectionquestiontranslation) | **GET** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations/{locale} | Get Event Faq Section Question Translation|
+|[**getEventFaqSectionQuestionTranslations**](#geteventfaqsectionquestiontranslations) | **GET** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations | Get Event Faq Section Question Translations|
+|[**getEventFaqSectionTranslation**](#geteventfaqsectiontranslation) | **GET** /events/{eventId}/faqs/{sectionId}/translations/{locale} | Get Event Faq Section Translation|
+|[**getEventFaqSectionTranslations**](#geteventfaqsectiontranslations) | **GET** /events/{eventId}/faqs/{sectionId}/translations | Get Event Faq Section Translations|
+|[**updateEventFaqSectionQuestionTranslation**](#updateeventfaqsectionquestiontranslation) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/{questionId}/translations/{locale} | Update Event Faq Section Question Translation|
+|[**updateEventFaqSectionTranslation**](#updateeventfaqsectiontranslation) | **PUT** /events/{eventId}/faqs/{sectionId}/translations/{locale} | Update Event Faq Section Translation|
+
+# **deleteEventFaqSectionQuestionTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventFaqSectionQuestionTranslation()
+
+Delete Event Faq Section Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFaqsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFaqsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sectionId: string; //The section 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.deleteEventFaqSectionQuestionTranslation(
+    eventId,
+    sectionId,
+    questionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **questionId** | [**string**] | The question 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)
+
+# **deleteEventFaqSectionTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventFaqSectionTranslation()
+
+Delete Event Faq Section Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFaqsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFaqsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventFaqSectionTranslation(
+    eventId,
+    sectionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section 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)
+
+# **getEventFaqSectionQuestionTranslation**
+> GetEventFaqSectionQuestionTranslation200Response getEventFaqSectionQuestionTranslation()
+
+Get Event Faq Section Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFaqsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFaqsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sectionId: string; //The section 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.getEventFaqSectionQuestionTranslation(
+    eventId,
+    sectionId,
+    questionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventFaqSectionQuestionTranslation200Response**
+
+### 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)
+
+# **getEventFaqSectionQuestionTranslations**
+> GetEventFaqSectionQuestionTranslations200Response getEventFaqSectionQuestionTranslations()
+
+Get Event Faq Section Question Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFaqsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFaqsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let questionId: string; //The question 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.getEventFaqSectionQuestionTranslations(
+    eventId,
+    sectionId,
+    questionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **questionId** | [**string**] | The question 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
+
+**GetEventFaqSectionQuestionTranslations200Response**
+
+### 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)
+
+# **getEventFaqSectionTranslation**
+> GetEventFaqSectionTranslation200Response getEventFaqSectionTranslation()
+
+Get Event Faq Section Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFaqsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFaqsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventFaqSectionTranslation(
+    eventId,
+    sectionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventFaqSectionTranslation200Response**
+
+### 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)
+
+# **getEventFaqSectionTranslations**
+> GetEventFaqSectionTranslations200Response getEventFaqSectionTranslations()
+
+Get Event Faq Section Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFaqsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFaqsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sectionId: string; //The section 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.getEventFaqSectionTranslations(
+    eventId,
+    sectionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section 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
+
+**GetEventFaqSectionTranslations200Response**
+
+### 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)
+
+# **updateEventFaqSectionQuestionTranslation**
+> UpdateAnnouncementTranslation200Response updateEventFaqSectionQuestionTranslation(eventFaqSectionQuestionTranslationUpdateInputs)
+
+Update Event Faq Section Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFaqsTranslationsApi,
+    Configuration,
+    EventFaqSectionQuestionTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFaqsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventFaqSectionQuestionTranslationUpdateInputs: EventFaqSectionQuestionTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventFaqSectionQuestionTranslation(
+    eventId,
+    sectionId,
+    questionId,
+    locale,
+    eventFaqSectionQuestionTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventFaqSectionQuestionTranslationUpdateInputs** | **EventFaqSectionQuestionTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **questionId** | [**string**] | The question 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)
+
+# **updateEventFaqSectionTranslation**
+> UpdateAnnouncementTranslation200Response updateEventFaqSectionTranslation(eventFaqSectionTranslationUpdateInputs)
+
+Update Event Faq Section Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFaqsTranslationsApi,
+    Configuration,
+    EventFaqSectionTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFaqsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventFaqSectionTranslationUpdateInputs: EventFaqSectionTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventFaqSectionTranslation(
+    eventId,
+    sectionId,
+    locale,
+    eventFaqSectionTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventFaqSectionTranslationUpdateInputs** | **EventFaqSectionTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section 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)
+