@connectedxm/admin-sdk 6.17.4 → 6.18.1

package/docs/EventsSpeakersTranslationsApi.md

@@ -0,0 +1,252 @@
+# EventsSpeakersTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventSpeakerTranslation**](#deleteeventspeakertranslation) | **DELETE** /events/{eventId}/speakers/{speakerId}/translations/{locale} | Delete Event Speaker Translation|
+|[**getEventSpeakerTranslation**](#geteventspeakertranslation) | **GET** /events/{eventId}/speakers/{speakerId}/translations/{locale} | Get Event Speaker Translation|
+|[**getEventSpeakerTranslations**](#geteventspeakertranslations) | **GET** /events/{eventId}/speakers/{speakerId}/translations | Get Event Speaker Translations|
+|[**updateEventSpeakerTranslation**](#updateeventspeakertranslation) | **PUT** /events/{eventId}/speakers/{speakerId}/translations/{locale} | Update Event Speaker Translation|
+
+# **deleteEventSpeakerTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventSpeakerTranslation()
+
+Delete Event Speaker Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSpeakersTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSpeakersTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let speakerId: string; //The speaker identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventSpeakerTranslation(
+    eventId,
+    speakerId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **speakerId** | [**string**] | The speaker 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)
+
+# **getEventSpeakerTranslation**
+> GetEventSpeakerTranslation200Response getEventSpeakerTranslation()
+
+Get Event Speaker Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSpeakersTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSpeakersTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let speakerId: string; //The speaker identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventSpeakerTranslation(
+    eventId,
+    speakerId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **speakerId** | [**string**] | The speaker identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventSpeakerTranslation200Response**
+
+### 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)
+
+# **getEventSpeakerTranslations**
+> GetEventSpeakerTranslations200Response getEventSpeakerTranslations()
+
+Get Event Speaker Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSpeakersTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSpeakersTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let speakerId: string; //The speaker 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.getEventSpeakerTranslations(
+    eventId,
+    speakerId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **speakerId** | [**string**] | The speaker 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
+
+**GetEventSpeakerTranslations200Response**
+
+### 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)
+
+# **updateEventSpeakerTranslation**
+> UpdateAnnouncementTranslation200Response updateEventSpeakerTranslation(eventSpeakerTranslationUpdateInputs)
+
+Update Event Speaker Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSpeakersTranslationsApi,
+    Configuration,
+    EventSpeakerTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSpeakersTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let speakerId: string; //The speaker identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventSpeakerTranslationUpdateInputs: EventSpeakerTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventSpeakerTranslation(
+    eventId,
+    speakerId,
+    locale,
+    eventSpeakerTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventSpeakerTranslationUpdateInputs** | **EventSpeakerTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **speakerId** | [**string**] | The speaker 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/EventsSponsorshiplevelsTranslationsApi.md

@@ -0,0 +1,252 @@
+# EventsSponsorshiplevelsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventSponsorshipLevelTranslation**](#deleteeventsponsorshipleveltranslation) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId}/translations/{locale} | Delete Event Sponsorship Level Translation|
+|[**getEventSponsorshipLevelTranslation**](#geteventsponsorshipleveltranslation) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/translations/{locale} | Get Event Sponsorship Level Translation|
+|[**getEventSponsorshipLevelTranslations**](#geteventsponsorshipleveltranslations) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/translations | Get Event Sponsorship Level Translations|
+|[**updateEventSponsorshipLevelTranslation**](#updateeventsponsorshipleveltranslation) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/translations/{locale} | Update Event Sponsorship Level Translation|
+
+# **deleteEventSponsorshipLevelTranslation**
+> CreateAccountInvitations200Response deleteEventSponsorshipLevelTranslation()
+
+Delete Event Sponsorship Level Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshiplevelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshiplevelsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventSponsorshipLevelTranslation(
+    eventId,
+    levelId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level 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)
+
+# **getEventSponsorshipLevelTranslation**
+> GetEventSponsorshipLevelTranslation200Response getEventSponsorshipLevelTranslation()
+
+Get Event Sponsorship Level Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshiplevelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshiplevelsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventSponsorshipLevelTranslation(
+    eventId,
+    levelId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventSponsorshipLevelTranslation200Response**
+
+### 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)
+
+# **getEventSponsorshipLevelTranslations**
+> GetEventSponsorshipLevelTranslations200Response getEventSponsorshipLevelTranslations()
+
+Get Event Sponsorship Level Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshiplevelsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshiplevelsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level 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.getEventSponsorshipLevelTranslations(
+    eventId,
+    levelId,
+    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|
+| **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
+
+**GetEventSponsorshipLevelTranslations200Response**
+
+### 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)
+
+# **updateEventSponsorshipLevelTranslation**
+> GetEventSponsorshipLevelTranslation200Response updateEventSponsorshipLevelTranslation()
+
+Update Event Sponsorship Level Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshiplevelsTranslationsApi,
+    Configuration,
+    EventSponsorshipLevelTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshiplevelsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let translation: EventSponsorshipLevelTranslationUpdateInputs; //Filter by translation (default to undefined)
+
+const { status, data } = await apiInstance.updateEventSponsorshipLevelTranslation(
+    eventId,
+    levelId,
+    locale,
+    translation
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+| **translation** | **EventSponsorshipLevelTranslationUpdateInputs** | Filter by translation | defaults to undefined|
+
+
+### Return type
+
+**GetEventSponsorshipLevelTranslation200Response**
+
+### 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)
+