@connectedxm/admin-sdk 6.17.4 → 6.18.1

package/docs/EventsFollowupsTranslationsApi.md

@@ -0,0 +1,252 @@
+# EventsFollowupsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventFollowupTranslation**](#deleteeventfollowuptranslation) | **DELETE** /events/{eventId}/followups/{followupId}/translations/{locale} | Delete Event Followup Translation|
+|[**getEventFollowupTranslation**](#geteventfollowuptranslation) | **GET** /events/{eventId}/followups/{followupId}/translations/{locale} | Get Event Followup Translation|
+|[**getEventFollowupTranslations**](#geteventfollowuptranslations) | **GET** /events/{eventId}/followups/{followupId}/translations | Get Event Followup Translations|
+|[**updateEventFollowupTranslation**](#updateeventfollowuptranslation) | **PUT** /events/{eventId}/followups/{followupId}/translations/{locale} | Update Event Followup Translation|
+
+# **deleteEventFollowupTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventFollowupTranslation()
+
+Delete Event Followup Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFollowupsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFollowupsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let followupId: string; //The followup identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventFollowupTranslation(
+    eventId,
+    followupId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **followupId** | [**string**] | The followup 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)
+
+# **getEventFollowupTranslation**
+> GetEventFollowupTranslation200Response getEventFollowupTranslation()
+
+Get Event Followup Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFollowupsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFollowupsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let followupId: string; //The followup identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventFollowupTranslation(
+    eventId,
+    followupId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **followupId** | [**string**] | The followup identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventFollowupTranslation200Response**
+
+### 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)
+
+# **getEventFollowupTranslations**
+> GetEventFollowupTranslations200Response getEventFollowupTranslations()
+
+Get Event Followup Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFollowupsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFollowupsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let followupId: string; //The followup 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.getEventFollowupTranslations(
+    eventId,
+    followupId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **followupId** | [**string**] | The followup 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
+
+**GetEventFollowupTranslations200Response**
+
+### 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)
+
+# **updateEventFollowupTranslation**
+> UpdateAnnouncementTranslation200Response updateEventFollowupTranslation(eventFollowupTranslationUpdateInputs)
+
+Update Event Followup Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsFollowupsTranslationsApi,
+    Configuration,
+    EventFollowupTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsFollowupsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let followupId: string; //The followup identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventFollowupTranslationUpdateInputs: EventFollowupTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventFollowupTranslation(
+    eventId,
+    followupId,
+    locale,
+    eventFollowupTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventFollowupTranslationUpdateInputs** | **EventFollowupTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **followupId** | [**string**] | The followup 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/EventsMediaTranslationsApi.md

@@ -0,0 +1,252 @@
+# EventsMediaTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventMediaItemTranslation**](#deleteeventmediaitemtranslation) | **DELETE** /events/{eventId}/media/{mediaItemId}/translations/{locale} | Delete Event Media Item Translation|
+|[**getEventMediaItemTranslation**](#geteventmediaitemtranslation) | **GET** /events/{eventId}/media/{mediaId}/translations/{locale} | Get Event Media Item Translation|
+|[**getEventMediaItemTranslations**](#geteventmediaitemtranslations) | **GET** /events/{eventId}/media/{mediaId}/translations | Get Event Media Item Translations|
+|[**updateEventMediaItemTranslation**](#updateeventmediaitemtranslation) | **PUT** /events/{eventId}/media/{mediaItemId}/translations/{locale} | Update Event Media Item Translation|
+
+# **deleteEventMediaItemTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventMediaItemTranslation()
+
+Delete Event Media Item Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsMediaTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsMediaTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let mediaItemId: string; //The mediaItem identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventMediaItemTranslation(
+    eventId,
+    mediaItemId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **mediaItemId** | [**string**] | The mediaItem 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)
+
+# **getEventMediaItemTranslation**
+> GetEventMediaItemTranslation200Response getEventMediaItemTranslation()
+
+Get Event Media Item Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsMediaTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsMediaTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let mediaId: string; //The media identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventMediaItemTranslation(
+    eventId,
+    mediaId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **mediaId** | [**string**] | The media identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventMediaItemTranslation200Response**
+
+### 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)
+
+# **getEventMediaItemTranslations**
+> GetEventMediaItemTranslations200Response getEventMediaItemTranslations()
+
+Get Event Media Item Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsMediaTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsMediaTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let mediaId: string; //The media 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.getEventMediaItemTranslations(
+    eventId,
+    mediaId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **mediaId** | [**string**] | The media 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
+
+**GetEventMediaItemTranslations200Response**
+
+### 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)
+
+# **updateEventMediaItemTranslation**
+> UpdateEventMediaItemTranslation200Response updateEventMediaItemTranslation(eventMediaItemTranslationUpdateInputs)
+
+Update Event Media Item Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsMediaTranslationsApi,
+    Configuration,
+    EventMediaItemTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsMediaTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let mediaItemId: string; //The mediaItem identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventMediaItemTranslationUpdateInputs: EventMediaItemTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventMediaItemTranslation(
+    eventId,
+    mediaItemId,
+    locale,
+    eventMediaItemTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventMediaItemTranslationUpdateInputs** | **EventMediaItemTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **mediaItemId** | [**string**] | The mediaItem identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateEventMediaItemTranslation200Response**
+
+### 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)
+