@connectedxm/admin-sdk 11.1.0 → 11.3.0

package/docs/EventGroupCouponReminderUpdateInputs.md

@@ -0,0 +1,24 @@
+# EventGroupCouponReminderUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**startDate** | **string** |  | [optional] [default to undefined]
+**frequency** | [**GroupCouponReminderFrequency**](GroupCouponReminderFrequency.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventGroupCouponReminderUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: EventGroupCouponReminderUpdateInputs = {
+    enabled,
+    startDate,
+    frequency,
+};
+```
+
+[[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/EventOnSiteBadgeColorRule.md

@@ -14,9 +14,12 @@ Name | Type | Description | Notes
 **attributeValue** | **string** |  | [default to undefined]
 **tierId** | **string** |  | [default to undefined]
 **passTypeId** | **string** |  | [default to undefined]
+**passAttributeId** | **string** |  | [default to undefined]
+**passAttributeValue** | **string** |  | [default to undefined]
 **attribute** | [**BaseAccountAttribute**](BaseAccountAttribute.md) |  | [default to undefined]
 **tier** | [**BaseTier**](BaseTier.md) |  | [default to undefined]
 **passType** | [**BaseEventPassType**](BaseEventPassType.md) |  | [default to undefined]
+**passAttribute** | [**BaseEventAttribute**](BaseEventAttribute.md) |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 **updatedAt** | **string** |  | [default to undefined]
 
@@ -35,9 +38,12 @@ const instance: EventOnSiteBadgeColorRule = {
     attributeValue,
     tierId,
     passTypeId,
+    passAttributeId,
+    passAttributeValue,
     attribute,
     tier,
     passType,
+    passAttribute,
     createdAt,
     updatedAt,
 };

package/docs/EventsGroupcouponreminderApi.md

@@ -0,0 +1,115 @@
+# EventsGroupcouponreminderApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getEventGroupCouponReminder**](#geteventgroupcouponreminder) | **GET** /events/{eventId}/groupCouponReminder | Get an event\'s group coupon reminder schedule|
+|[**updateEventGroupCouponReminder**](#updateeventgroupcouponreminder) | **PUT** /events/{eventId}/groupCouponReminder | Update an event\'s group coupon reminder schedule|
+
+# **getEventGroupCouponReminder**
+> GetEventGroupCouponReminder200Response getEventGroupCouponReminder()
+
+Returns the per-event group coupon reminder configuration (enabled, start date, and frequency). A missing schedule is treated as off; requires read permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsGroupcouponreminderApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsGroupcouponreminderApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventGroupCouponReminder(
+    eventId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventGroupCouponReminder200Response**
+
+### 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)
+
+# **updateEventGroupCouponReminder**
+> GetEventGroupCouponReminder200Response updateEventGroupCouponReminder(eventGroupCouponReminderUpdateInputs)
+
+Partially updates the per-event group coupon reminder configuration. Pass null for startDate or frequency to clear the schedule; requires update permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsGroupcouponreminderApi,
+    Configuration,
+    EventGroupCouponReminderUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsGroupcouponreminderApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let eventGroupCouponReminderUpdateInputs: EventGroupCouponReminderUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventGroupCouponReminder(
+    eventId,
+    eventGroupCouponReminderUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventGroupCouponReminderUpdateInputs** | **EventGroupCouponReminderUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventGroupCouponReminder200Response**
+
+### 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/GetEventGroupCouponReminder200Response.md

@@ -0,0 +1,24 @@
+# GetEventGroupCouponReminder200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**EventGroupCouponReminder**](EventGroupCouponReminder.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventGroupCouponReminder200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetEventGroupCouponReminder200Response = {
+    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/GroupCouponReminderFrequency.md

@@ -0,0 +1,12 @@
+# GroupCouponReminderFrequency
+
+
+## Enum
+
+* `Weekly` (value: `'weekly'`)
+
+* `Monthly` (value: `'monthly'`)
+
+* `Quarterly` (value: `'quarterly'`)
+
+[[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/NotificationPreferences.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **transferEmail** | **boolean** |  | [default to undefined]
 **eventReminderEmail** | **boolean** |  | [default to undefined]
 **abandonedRegistrationEmail** | **boolean** |  | [default to undefined]
+**groupCouponReminderEmail** | **boolean** |  | [default to undefined]
 **bookingReminderEmail** | **boolean** |  | [default to undefined]
 **chatPush** | **boolean** |  | [default to undefined]
 **chatUnreadEmail** | **boolean** |  | [default to undefined]
@@ -37,6 +38,7 @@ const instance: NotificationPreferences = {
     transferEmail,
     eventReminderEmail,
     abandonedRegistrationEmail,
+    groupCouponReminderEmail,
     bookingReminderEmail,
     chatPush,
     chatUnreadEmail,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "11.1.0",
+  "version": "11.3.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {