@connectedxm/admin-sdk 6.17.4 → 6.18.1

package/docs/EventsSessionsSectionsTranslationsApi.md

@@ -0,0 +1,264 @@
+# EventsSessionsSectionsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventSessionSectionTranslation**](#deleteeventsessionsectiontranslation) | **DELETE** /events/{eventId}/sessions/{sessionId}/sections/{sectionId}/translations/{locale} | Delete Event Session Section Translation|
+|[**getEventSessionSectionTranslation**](#geteventsessionsectiontranslation) | **GET** /events/{eventId}/sessions/{sessionId}/sections/{sectionId}/translations/{locale} | Get Event Session Section Translation|
+|[**getEventSessionSectionTranslations**](#geteventsessionsectiontranslations) | **GET** /events/{eventId}/sessions/{sessionId}/sections/{sectionId}/translations | Get Event Session Section Translations|
+|[**updateEventSessionSectionTranslation**](#updateeventsessionsectiontranslation) | **PUT** /events/{eventId}/sessions/{sessionId}/sections/{sectionId}/translations/{locale} | Update Event Session Section Translation|
+
+# **deleteEventSessionSectionTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventSessionSectionTranslation()
+
+Delete Event Session Section Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session 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.deleteEventSessionSectionTranslation(
+    eventId,
+    sessionId,
+    sectionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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)
+
+# **getEventSessionSectionTranslation**
+> GetEventSessionSectionTranslation200Response getEventSessionSectionTranslation()
+
+Get Event Session Section Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session 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.getEventSessionSectionTranslation(
+    eventId,
+    sessionId,
+    sectionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventSessionSectionTranslation200Response**
+
+### 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)
+
+# **getEventSessionSectionTranslations**
+> GetEventSessionSectionTranslations200Response getEventSessionSectionTranslations()
+
+Get Event Session Section Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session 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.getEventSessionSectionTranslations(
+    eventId,
+    sessionId,
+    sectionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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
+
+**GetEventSessionSectionTranslations200Response**
+
+### 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)
+
+# **updateEventSessionSectionTranslation**
+> UpdateAnnouncementTranslation200Response updateEventSessionSectionTranslation(eventSessionSectionTranslationUpdateInputs)
+
+Update Event Session Section Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsTranslationsApi,
+    Configuration,
+    EventSessionSectionTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventSessionSectionTranslationUpdateInputs: EventSessionSectionTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventSessionSectionTranslation(
+    eventId,
+    sessionId,
+    sectionId,
+    locale,
+    eventSessionSectionTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventSessionSectionTranslationUpdateInputs** | **EventSessionSectionTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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)
+

package/docs/EventsSessionsTranslationsApi.md

@@ -0,0 +1,252 @@
+# EventsSessionsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventSessionTranslation**](#deleteeventsessiontranslation) | **DELETE** /events/{eventId}/sessions/{sessionId}/translations/{locale} | Delete Event Session Translation|
+|[**getEventSessionTranslation**](#geteventsessiontranslation) | **GET** /events/{eventId}/sessions/{sessionId}/translations/{locale} | Get Event Session Translation|
+|[**getEventSessionTranslations**](#geteventsessiontranslations) | **GET** /events/{eventId}/sessions/{sessionId}/translations | Get Event Session Translations|
+|[**updateEventSessionTranslation**](#updateeventsessiontranslation) | **PUT** /events/{eventId}/sessions/{sessionId}/translations/{locale} | Update Event Session Translation|
+
+# **deleteEventSessionTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventSessionTranslation()
+
+Delete Event Session Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventSessionTranslation(
+    eventId,
+    sessionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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)
+
+# **getEventSessionTranslation**
+> GetEventSessionTranslation200Response getEventSessionTranslation()
+
+Get Event Session Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventSessionTranslation(
+    eventId,
+    sessionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventSessionTranslation200Response**
+
+### 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)
+
+# **getEventSessionTranslations**
+> GetEventSessionTranslations200Response getEventSessionTranslations()
+
+Get Event Session Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session 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.getEventSessionTranslations(
+    eventId,
+    sessionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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
+
+**GetEventSessionTranslations200Response**
+
+### 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)
+
+# **updateEventSessionTranslation**
+> UpdateAnnouncementTranslation200Response updateEventSessionTranslation(eventSessionTranslationUpdateInputs)
+
+Update Event Session Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTranslationsApi,
+    Configuration,
+    EventSessionTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventSessionTranslationUpdateInputs: EventSessionTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventSessionTranslation(
+    eventId,
+    sessionId,
+    locale,
+    eventSessionTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventSessionTranslationUpdateInputs** | **EventSessionTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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)
+