@connectedxm/admin-sdk 6.17.4 → 6.20.0

package/docs/EventsEmailsTranslationsApi.md

@@ -0,0 +1,252 @@
+# EventsEmailsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventEmailTranslation**](#deleteeventemailtranslation) | **DELETE** /events/{eventId}/emails/{type}/translations/{locale} | Delete Event Email Translation|
+|[**getEventEmailTranslation**](#geteventemailtranslation) | **GET** /events/{eventId}/emails/{type}/translations/{locale} | Get Event Email Translation|
+|[**getEventEmailTranslations**](#geteventemailtranslations) | **GET** /events/{eventId}/emails/{type}/translations | Get Event Email Translations|
+|[**updateEventEmailTranslation**](#updateeventemailtranslation) | **PUT** /events/{eventId}/emails/{type}/translations/{locale} | Update Event Email Translation|
+
+# **deleteEventEmailTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventEmailTranslation()
+
+Delete Event Email Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsEmailsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsEmailsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let type: string; //The type identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventEmailTranslation(
+    eventId,
+    type,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **type** | [**string**] | The type 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)
+
+# **getEventEmailTranslation**
+> GetEventEmailTranslation200Response getEventEmailTranslation()
+
+Get Event Email Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsEmailsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsEmailsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let type: string; //The type identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventEmailTranslation(
+    eventId,
+    type,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **type** | [**string**] | The type identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventEmailTranslation200Response**
+
+### 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)
+
+# **getEventEmailTranslations**
+> GetEventEmailTranslations200Response getEventEmailTranslations()
+
+Get Event Email Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsEmailsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsEmailsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let type: string; //The type 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.getEventEmailTranslations(
+    eventId,
+    type,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **type** | [**string**] | The type 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
+
+**GetEventEmailTranslations200Response**
+
+### 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)
+
+# **updateEventEmailTranslation**
+> UpdateAnnouncementTranslation200Response updateEventEmailTranslation(eventEmailTranslationUpdateInputs)
+
+Update Event Email Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsEmailsTranslationsApi,
+    Configuration,
+    EventEmailTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsEmailsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let type: string; //The type identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventEmailTranslationUpdateInputs: EventEmailTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventEmailTranslation(
+    eventId,
+    type,
+    locale,
+    eventEmailTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventEmailTranslationUpdateInputs** | **EventEmailTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **type** | [**string**] | The type 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)
+