@connectedxm/admin-sdk 6.14.5 → 6.18.1

package/docs/AnnouncementsTranslationsApi.md

@@ -0,0 +1,240 @@
+# AnnouncementsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteAnnouncementTranslation**](#deleteannouncementtranslation) | **DELETE** /announcements/{announcementId}/translations/{locale} | Delete Announcement Translation|
+|[**getAnnouncementTranslation**](#getannouncementtranslation) | **GET** /announcements/{announcementId}/translations/{locale} | Get Announcement Translation|
+|[**getAnnouncementTranslations**](#getannouncementtranslations) | **GET** /announcements/{announcementId}/translations | Get Announcement Translations|
+|[**updateAnnouncementTranslation**](#updateannouncementtranslation) | **PUT** /announcements/{announcementId}/translations/{locale} | Update Announcement Translation|
+
+# **deleteAnnouncementTranslation**
+> UpdateAnnouncementTranslation200Response deleteAnnouncementTranslation()
+
+Delete Announcement Translation endpoint
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTranslationsApi(configuration);
+
+let announcementId: string; //The announcement identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteAnnouncementTranslation(
+    announcementId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementId** | [**string**] | The announcement 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)
+
+# **getAnnouncementTranslation**
+> GetAnnouncementTranslation200Response getAnnouncementTranslation()
+
+Get Announcement Translation endpoint
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTranslationsApi(configuration);
+
+let announcementId: string; //The announcement identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getAnnouncementTranslation(
+    announcementId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementId** | [**string**] | The announcement identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetAnnouncementTranslation200Response**
+
+### 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)
+
+# **getAnnouncementTranslations**
+> GetAnnouncementTranslations200Response getAnnouncementTranslations()
+
+Get Announcement Translations endpoint
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTranslationsApi(configuration);
+
+let announcementId: string; //The announcement 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.getAnnouncementTranslations(
+    announcementId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementId** | [**string**] | The announcement 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
+
+**GetAnnouncementTranslations200Response**
+
+### 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)
+
+# **updateAnnouncementTranslation**
+> UpdateAnnouncementTranslation200Response updateAnnouncementTranslation(announcementTranslationUpdateInputs)
+
+Update Announcement Translation endpoint
+
+### Example
+
+```typescript
+import {
+    AnnouncementsTranslationsApi,
+    Configuration,
+    AnnouncementTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AnnouncementsTranslationsApi(configuration);
+
+let announcementId: string; //The announcement identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let announcementTranslationUpdateInputs: AnnouncementTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateAnnouncementTranslation(
+    announcementId,
+    locale,
+    announcementTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **announcementTranslationUpdateInputs** | **AnnouncementTranslationUpdateInputs**|  | |
+| **announcementId** | [**string**] | The announcement 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/BaseSideEffect.md

@@ -10,12 +10,14 @@ Name | Type | Description | Notes
 **checkedInPassEventId** | **string** |  | [default to undefined]
 **newAccountTierId** | **string** |  | [default to undefined]
 **removedAccountTierId** | **string** |  | [default to undefined]
+**passWithQuestionChoiceId** | **string** |  | [default to undefined]
 **joinGroupId** | **string** |  | [default to undefined]
 **leaveGroupId** | **string** |  | [default to undefined]
 **addToTierId** | **string** |  | [default to undefined]
 **subscribeToChannelId** | **string** |  | [default to undefined]
 **sendWebhookId** | **string** |  | [default to undefined]
 **completeActivationId** | **string** |  | [default to undefined]
+**registerForSessionId** | **string** |  | [default to undefined]
 
 ## Example
 
@@ -28,12 +30,14 @@ const instance: BaseSideEffect = {
     checkedInPassEventId,
     newAccountTierId,
     removedAccountTierId,
+    passWithQuestionChoiceId,
     joinGroupId,
     leaveGroupId,
     addToTierId,
     subscribeToChannelId,
     sendWebhookId,
     completeActivationId,
+    registerForSessionId,
 };
 ```
 

package/docs/BenefitsTranslationsApi.md

@@ -0,0 +1,240 @@
+# BenefitsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteBenefitTranslation**](#deletebenefittranslation) | **DELETE** /benefits/{benefitId}/translations/{locale} | Delete Benefit Translation|
+|[**getBenefitTranslation**](#getbenefittranslation) | **GET** /benefits/{benefitId}/translations/{locale} | Get Benefit Translation|
+|[**getBenefitTranslations**](#getbenefittranslations) | **GET** /benefits/{benefitId}/translations | Get Benefit Translations|
+|[**updateBenefitTranslation**](#updatebenefittranslation) | **PUT** /benefits/{benefitId}/translations/{locale} | Update Benefit Translation|
+
+# **deleteBenefitTranslation**
+> UpdateAnnouncementTranslation200Response deleteBenefitTranslation()
+
+Delete Benefit Translation endpoint
+
+### Example
+
+```typescript
+import {
+    BenefitsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new BenefitsTranslationsApi(configuration);
+
+let benefitId: string; //The benefit identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteBenefitTranslation(
+    benefitId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **benefitId** | [**string**] | The benefit 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)
+
+# **getBenefitTranslation**
+> GetBenefitTranslation200Response getBenefitTranslation()
+
+Get Benefit Translation endpoint
+
+### Example
+
+```typescript
+import {
+    BenefitsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new BenefitsTranslationsApi(configuration);
+
+let benefitId: string; //The benefit identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getBenefitTranslation(
+    benefitId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **benefitId** | [**string**] | The benefit identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetBenefitTranslation200Response**
+
+### 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)
+
+# **getBenefitTranslations**
+> GetBenefitTranslations200Response getBenefitTranslations()
+
+Get Benefit Translations endpoint
+
+### Example
+
+```typescript
+import {
+    BenefitsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new BenefitsTranslationsApi(configuration);
+
+let benefitId: string; //The benefit 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.getBenefitTranslations(
+    benefitId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **benefitId** | [**string**] | The benefit 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
+
+**GetBenefitTranslations200Response**
+
+### 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)
+
+# **updateBenefitTranslation**
+> UpdateAnnouncementTranslation200Response updateBenefitTranslation(benefitTranslationUpdateInputs)
+
+Update Benefit Translation endpoint
+
+### Example
+
+```typescript
+import {
+    BenefitsTranslationsApi,
+    Configuration,
+    BenefitTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new BenefitsTranslationsApi(configuration);
+
+let benefitId: string; //The benefit identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let benefitTranslationUpdateInputs: BenefitTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateBenefitTranslation(
+    benefitId,
+    locale,
+    benefitTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **benefitTranslationUpdateInputs** | **BenefitTranslationUpdateInputs**|  | |
+| **benefitId** | [**string**] | The benefit 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/BookingSpace.md

@@ -22,6 +22,8 @@ Name | Type | Description | Notes
 **taxLocation** | [**TaxLocationType**](TaxLocationType.md) |  | [default to undefined]
 **confirmationBody** | **string** |  | [default to undefined]
 **confirmationReplyTo** | **string** |  | [default to undefined]
+**cancellationBody** | **string** |  | [default to undefined]
+**cancellationReplyTo** | **string** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 **updatedAt** | **string** |  | [default to undefined]
 
@@ -48,6 +50,8 @@ const instance: BookingSpace = {
     taxLocation,
     confirmationBody,
     confirmationReplyTo,
+    cancellationBody,
+    cancellationReplyTo,
     createdAt,
     updatedAt,
 };

package/docs/BookingSpaceCreateInputs.md

@@ -17,6 +17,8 @@ Name | Type | Description | Notes
 **visible** | **boolean** |  | [optional] [default to undefined]
 **confirmationBody** | **string** |  | [optional] [default to undefined]
 **confirmationReplyTo** | **string** |  | [optional] [default to undefined]
+**cancellationBody** | **string** |  | [optional] [default to undefined]
+**cancellationReplyTo** | **string** |  | [optional] [default to undefined]
 **taxCode** | **string** |  | [optional] [default to undefined]
 **taxIncluded** | **boolean** |  | [optional] [default to undefined]
 **taxLocation** | [**TaxLocationType**](TaxLocationType.md) |  | [optional] [default to undefined]
@@ -39,6 +41,8 @@ const instance: BookingSpaceCreateInputs = {
     visible,
     confirmationBody,
     confirmationReplyTo,
+    cancellationBody,
+    cancellationReplyTo,
     taxCode,
     taxIncluded,
     taxLocation,

package/docs/BookingSpaceTranslation.md

@@ -9,6 +9,8 @@ Name | Type | Description | Notes
 **locale** | **string** |  | [default to undefined]
 **name** | **string** |  | [default to undefined]
 **description** | **string** |  | [default to undefined]
+**confirmationBody** | **string** |  | [default to undefined]
+**cancellationBody** | **string** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 **updatedAt** | **string** |  | [default to undefined]
 
@@ -22,6 +24,8 @@ const instance: BookingSpaceTranslation = {
     locale,
     name,
     description,
+    confirmationBody,
+    cancellationBody,
     createdAt,
     updatedAt,
 };

package/docs/BookingSpaceTranslationUpdateInputs.md

@@ -7,6 +7,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **string** |  | [optional] [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
+**confirmationBody** | **string** |  | [optional] [default to undefined]
+**cancellationBody** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -16,6 +18,8 @@ import { BookingSpaceTranslationUpdateInputs } from '@connectedxm/admin-sdk';
 const instance: BookingSpaceTranslationUpdateInputs = {
     name,
     description,
+    confirmationBody,
+    cancellationBody,
 };
 ```
 

package/docs/BookingSpaceUpdateInputs.md

@@ -16,6 +16,8 @@ Name | Type | Description | Notes
 **visible** | **boolean** |  | [optional] [default to undefined]
 **confirmationBody** | **string** |  | [optional] [default to undefined]
 **confirmationReplyTo** | **string** |  | [optional] [default to undefined]
+**cancellationBody** | **string** |  | [optional] [default to undefined]
+**cancellationReplyTo** | **string** |  | [optional] [default to undefined]
 **taxCode** | **string** |  | [optional] [default to undefined]
 **taxIncluded** | **boolean** |  | [optional] [default to undefined]
 **taxLocation** | [**TaxLocationType**](TaxLocationType.md) |  | [optional] [default to undefined]
@@ -37,6 +39,8 @@ const instance: BookingSpaceUpdateInputs = {
     visible,
     confirmationBody,
     confirmationReplyTo,
+    cancellationBody,
+    cancellationReplyTo,
     taxCode,
     taxIncluded,
     taxLocation,