@connectedxm/admin-sdk 6.17.4 → 6.20.0

package/docs/EventsSponsorshipsTranslationsApi.md

@@ -0,0 +1,264 @@
+# EventsSponsorshipsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventSponsorshipTranslation**](#deleteeventsponsorshiptranslation) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations/{locale} | Delete Event Sponsorship Translation|
+|[**getEventSponsorshipTranslation**](#geteventsponsorshiptranslation) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations/{locale} | Get Event Sponsorship Translation|
+|[**getEventSponsorshipTranslations**](#geteventsponsorshiptranslations) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations | Get Event Sponsorship Translations|
+|[**updateEventSponsorshipTranslation**](#updateeventsponsorshiptranslation) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId}/translations/{locale} | Update Event Sponsorship Translation|
+
+# **deleteEventSponsorshipTranslation**
+> CreateAccountInvitations200Response deleteEventSponsorshipTranslation()
+
+Delete Event Sponsorship Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshipsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshipsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level identifier (default to undefined)
+let sponsorshipId: string; //The sponsorship identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventSponsorshipTranslation(
+    eventId,
+    levelId,
+    sponsorshipId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+| **sponsorshipId** | [**string**] | The sponsorship identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountInvitations200Response**
+
+### 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)
+
+# **getEventSponsorshipTranslation**
+> GetEventSponsorshipTranslation200Response getEventSponsorshipTranslation()
+
+Get Event Sponsorship Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshipsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshipsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level identifier (default to undefined)
+let sponsorshipId: string; //The sponsorship identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventSponsorshipTranslation(
+    eventId,
+    levelId,
+    sponsorshipId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+| **sponsorshipId** | [**string**] | The sponsorship identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventSponsorshipTranslation200Response**
+
+### 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)
+
+# **getEventSponsorshipTranslations**
+> GetEventSponsorshipTranslations200Response getEventSponsorshipTranslations()
+
+Get Event Sponsorship Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshipsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshipsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level identifier (default to undefined)
+let sponsorshipId: string; //The sponsorship 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.getEventSponsorshipTranslations(
+    eventId,
+    levelId,
+    sponsorshipId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+| **sponsorshipId** | [**string**] | The sponsorship 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
+
+**GetEventSponsorshipTranslations200Response**
+
+### 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)
+
+# **updateEventSponsorshipTranslation**
+> GetEventSponsorshipTranslation200Response updateEventSponsorshipTranslation()
+
+Update Event Sponsorship Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshipsTranslationsApi,
+    Configuration,
+    EventSponsorshipTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshipsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level identifier (default to undefined)
+let sponsorshipId: string; //The sponsorship identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let translation: EventSponsorshipTranslationUpdateInputs; //Filter by translation (default to undefined)
+
+const { status, data } = await apiInstance.updateEventSponsorshipTranslation(
+    eventId,
+    levelId,
+    sponsorshipId,
+    locale,
+    translation
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+| **sponsorshipId** | [**string**] | The sponsorship identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+| **translation** | **EventSponsorshipTranslationUpdateInputs** | Filter by translation | defaults to undefined|
+
+
+### Return type
+
+**GetEventSponsorshipTranslation200Response**
+
+### 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)
+

package/docs/EventsTracksTranslationsApi.md

@@ -0,0 +1,252 @@
+# EventsTracksTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventTrackTranslation**](#deleteeventtracktranslation) | **DELETE** /events/{eventId}/tracks/{trackId}/translations/{locale} | Delete Event Track Translation|
+|[**getEventTrackTranslation**](#geteventtracktranslation) | **GET** /events/{eventId}/tracks/{trackId}/translations/{locale} | Get Event Track Translation|
+|[**getEventTrackTranslations**](#geteventtracktranslations) | **GET** /events/{eventId}/tracks/{trackId}/translations | Get Event Track Translations|
+|[**updateEventTrackTranslation**](#updateeventtracktranslation) | **PUT** /events/{eventId}/tracks/{trackId}/translations/{locale} | Update Event Track Translation|
+
+# **deleteEventTrackTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventTrackTranslation()
+
+Delete Event Track Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventTrackTranslation(
+    eventId,
+    trackId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track 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)
+
+# **getEventTrackTranslation**
+> GetEventTrackTranslation200Response getEventTrackTranslation()
+
+Get Event Track Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventTrackTranslation(
+    eventId,
+    trackId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventTrackTranslation200Response**
+
+### 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)
+
+# **getEventTrackTranslations**
+> GetEventTrackTranslations200Response getEventTrackTranslations()
+
+Get Event Track Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track 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.getEventTrackTranslations(
+    eventId,
+    trackId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track 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
+
+**GetEventTrackTranslations200Response**
+
+### 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)
+
+# **updateEventTrackTranslation**
+> UpdateAnnouncementTranslation200Response updateEventTrackTranslation(eventTrackTranslationUpdateInputs)
+
+Update Event Track Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksTranslationsApi,
+    Configuration,
+    EventTrackTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventTrackTranslationUpdateInputs: EventTrackTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventTrackTranslation(
+    eventId,
+    trackId,
+    locale,
+    eventTrackTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventTrackTranslationUpdateInputs** | **EventTrackTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track 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)
+