@connectedxm/admin-sdk 6.14.5 → 6.18.1

package/docs/EventsTranslationsApi.md

@@ -0,0 +1,240 @@
+# EventsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventTranslation**](#deleteeventtranslation) | **DELETE** /events/{eventId}/translations/{locale} | Delete Event Translation|
+|[**getEventTranslation**](#geteventtranslation) | **GET** /events/{eventId}/translations/{locale} | Get Event Translation|
+|[**getEventTranslations**](#geteventtranslations) | **GET** /events/{eventId}/translations | Get Event Translations|
+|[**updateEventTranslation**](#updateeventtranslation) | **PUT** /events/{eventId}/translations/{locale} | Update Event Translation|
+
+# **deleteEventTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventTranslation()
+
+Delete Event Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventTranslation(
+    eventId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event 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)
+
+# **getEventTranslation**
+> GetEventTranslation200Response getEventTranslation()
+
+Get Event Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventTranslation(
+    eventId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventTranslation200Response**
+
+### 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)
+
+# **getEventTranslations**
+> GetEventTranslations200Response getEventTranslations()
+
+Get Event Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTranslationsApi(configuration);
+
+let eventId: string; //The event 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.getEventTranslations(
+    eventId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event 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
+
+**GetEventTranslations200Response**
+
+### 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)
+
+# **updateEventTranslation**
+> UpdateAnnouncementTranslation200Response updateEventTranslation(eventTranslationUpdateInputs)
+
+Update Event Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTranslationsApi,
+    Configuration,
+    EventTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventTranslationUpdateInputs: EventTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventTranslation(
+    eventId,
+    locale,
+    eventTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventTranslationUpdateInputs** | **EventTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event 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/GetAnnouncementTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetAnnouncementTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**AnnouncementTranslation**](AnnouncementTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAnnouncementTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetAnnouncementTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetAnnouncementTranslations200Response.md

@@ -0,0 +1,26 @@
+# GetAnnouncementTranslations200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<AnnouncementTranslation>**](AnnouncementTranslation.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetAnnouncementTranslations200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetAnnouncementTranslations200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetBenefitTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetBenefitTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**BenefitTranslation**](BenefitTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetBenefitTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetBenefitTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetBenefitTranslations200Response.md

@@ -0,0 +1,26 @@
+# GetBenefitTranslations200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<BenefitTranslation>**](BenefitTranslation.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetBenefitTranslations200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetBenefitTranslations200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetBookingPlaceTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetBookingPlaceTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**BookingPlaceTranslation**](BookingPlaceTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetBookingPlaceTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetBookingPlaceTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetBookingPlaceTranslations200Response.md

@@ -0,0 +1,26 @@
+# GetBookingPlaceTranslations200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<BookingPlaceTranslation>**](BookingPlaceTranslation.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetBookingPlaceTranslations200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetBookingPlaceTranslations200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetBookingSpaceTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetBookingSpaceTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**BookingSpaceTranslation**](BookingSpaceTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetBookingSpaceTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetBookingSpaceTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetBookingSpaceTranslations200Response.md

@@ -0,0 +1,26 @@
+# GetBookingSpaceTranslations200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<BookingSpaceTranslation>**](BookingSpaceTranslation.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetBookingSpaceTranslations200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetBookingSpaceTranslations200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetChannelContentGuestTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetChannelContentGuestTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**ChannelContentGuestTranslation**](ChannelContentGuestTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetChannelContentGuestTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetChannelContentGuestTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetChannelContentGuestTranslations200Response.md

@@ -0,0 +1,26 @@
+# GetChannelContentGuestTranslations200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<ChannelContentGuestTranslation>**](ChannelContentGuestTranslation.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetChannelContentGuestTranslations200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetChannelContentGuestTranslations200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetChannelContentTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetChannelContentTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**ChannelContentTranslation**](ChannelContentTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetChannelContentTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetChannelContentTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetChannelContentTranslations200Response.md

@@ -0,0 +1,26 @@
+# GetChannelContentTranslations200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<ChannelContentTranslation>**](ChannelContentTranslation.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetChannelContentTranslations200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetChannelContentTranslations200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetChannelTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetChannelTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**ChannelTranslation**](ChannelTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetChannelTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetChannelTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetChannelTranslations200Response.md

@@ -0,0 +1,26 @@
+# GetChannelTranslations200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<ChannelTranslation>**](ChannelTranslation.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetChannelTranslations200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetChannelTranslations200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetCustomModuleTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetCustomModuleTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**CustomModuleTranslation**](CustomModuleTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetCustomModuleTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetCustomModuleTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetCustomModuleTranslations200Response.md

@@ -0,0 +1,26 @@
+# GetCustomModuleTranslations200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<CustomModuleTranslation>**](CustomModuleTranslation.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetCustomModuleTranslations200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetCustomModuleTranslations200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetEventActivationTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetEventActivationTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**ActivationTranslation**](ActivationTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventActivationTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetEventActivationTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)