@connectedxm/admin-sdk 10.9.0 → 10.11.0

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 10.9.0
+ * The version of the OpenAPI document: 10.11.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 10.9.0
+ * The version of the OpenAPI document: 10.11.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 10.9.0
+ * The version of the OpenAPI document: 10.11.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 10.9.0
+ * The version of the OpenAPI document: 10.11.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 10.9.0
+ * The version of the OpenAPI document: 10.11.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 10.9.0
+ * The version of the OpenAPI document: 10.11.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/BadgeColorRuleType.md

@@ -0,0 +1,12 @@
+# BadgeColorRuleType
+
+
+## Enum
+
+* `Attribute` (value: `'attribute'`)
+
+* `Tier` (value: `'tier'`)
+
+* `PassType` (value: `'passType'`)
+
+[[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/BaseEventOnSiteBadgeColorRule.md

@@ -0,0 +1,36 @@
+# BaseEventOnSiteBadgeColorRule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**type** | [**BadgeColorRuleType**](BadgeColorRuleType.md) |  | [default to undefined]
+**color** | **string** |  | [default to undefined]
+**sortOrder** | **number** |  | [default to undefined]
+**attributeId** | **string** |  | [default to undefined]
+**attributeValue** | **string** |  | [default to undefined]
+**tierId** | **string** |  | [default to undefined]
+**passTypeId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseEventOnSiteBadgeColorRule } from '@connectedxm/admin-sdk';
+
+const instance: BaseEventOnSiteBadgeColorRule = {
+    id,
+    name,
+    type,
+    color,
+    sortOrder,
+    attributeId,
+    attributeValue,
+    tierId,
+    passTypeId,
+};
+```
+
+[[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/BaseOrganizationEntity.md

@@ -0,0 +1,30 @@
+# BaseOrganizationEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**legalName** | **string** |  | [default to undefined]
+**tradingName** | **string** |  | [default to undefined]
+**primary** | **boolean** |  | [default to undefined]
+**vatNumber** | **string** |  | [default to undefined]
+**vatCountry** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseOrganizationEntity } from '@connectedxm/admin-sdk';
+
+const instance: BaseOrganizationEntity = {
+    id,
+    legalName,
+    tradingName,
+    primary,
+    vatNumber,
+    vatCountry,
+};
+```
+
+[[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/CreateEventBadgeColorRule200Response.md

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

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

@@ -0,0 +1,34 @@
+# EventBadgeColorRuleCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**type** | [**BadgeColorRuleType**](BadgeColorRuleType.md) |  | [default to undefined]
+**color** | **string** |  | [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+**attributeId** | **string** |  | [optional] [default to undefined]
+**attributeValue** | **string** |  | [optional] [default to undefined]
+**tierId** | **string** |  | [optional] [default to undefined]
+**passTypeId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventBadgeColorRuleCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: EventBadgeColorRuleCreateInputs = {
+    name,
+    type,
+    color,
+    sortOrder,
+    attributeId,
+    attributeValue,
+    tierId,
+    passTypeId,
+};
+```
+
+[[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/EventBadgeColorRuleUpdateInputs.md

@@ -0,0 +1,34 @@
+# EventBadgeColorRuleUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**type** | [**BadgeColorRuleType**](BadgeColorRuleType.md) |  | [optional] [default to undefined]
+**color** | **string** |  | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+**attributeId** | **string** |  | [optional] [default to undefined]
+**attributeValue** | **string** |  | [optional] [default to undefined]
+**tierId** | **string** |  | [optional] [default to undefined]
+**passTypeId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EventBadgeColorRuleUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: EventBadgeColorRuleUpdateInputs = {
+    name,
+    type,
+    color,
+    sortOrder,
+    attributeId,
+    attributeValue,
+    tierId,
+    passTypeId,
+};
+```
+
+[[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

@@ -0,0 +1,46 @@
+# EventOnSiteBadgeColorRule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**type** | [**BadgeColorRuleType**](BadgeColorRuleType.md) |  | [default to undefined]
+**color** | **string** |  | [default to undefined]
+**sortOrder** | **number** |  | [default to undefined]
+**attributeId** | **string** |  | [default to undefined]
+**attributeValue** | **string** |  | [default to undefined]
+**tierId** | **string** |  | [default to undefined]
+**passTypeId** | **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]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { EventOnSiteBadgeColorRule } from '@connectedxm/admin-sdk';
+
+const instance: EventOnSiteBadgeColorRule = {
+    id,
+    name,
+    type,
+    color,
+    sortOrder,
+    attributeId,
+    attributeValue,
+    tierId,
+    passTypeId,
+    attribute,
+    tier,
+    passType,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/EventPassCreateInputs.md

@@ -9,7 +9,6 @@ Name | Type | Description | Notes
 **location** | **string** |  | [optional] [default to undefined]
 **ticketId** | **string** |  | [optional] [default to undefined]
 **usedAt** | **string** |  | [optional] [default to undefined]
-**badgeColor** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -21,7 +20,6 @@ const instance: EventPassCreateInputs = {
     location,
     ticketId,
     usedAt,
-    badgeColor,
 };
 ```
 

package/docs/EventPassUpdateInputs.md

@@ -10,7 +10,6 @@ Name | Type | Description | Notes
 **ticketId** | **string** |  | [optional] [default to undefined]
 **couponId** | **string** |  | [optional] [default to undefined]
 **usedAt** | **string** |  | [optional] [default to undefined]
-**badgeColor** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -23,7 +22,6 @@ const instance: EventPassUpdateInputs = {
     ticketId,
     couponId,
     usedAt,
-    badgeColor,
 };
 ```
 

package/docs/EventsOnSiteApi.md

@@ -4,10 +4,241 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**createEventBadgeColorRule**](#createeventbadgecolorrule) | **POST** /events/{eventId}/on-site/badge-colors | Create an event badge color rule|
+|[**deleteEventBadgeColorRule**](#deleteeventbadgecolorrule) | **DELETE** /events/{eventId}/on-site/badge-colors/{ruleId} | Delete an event badge color rule|
+|[**getEventBadgeColorRule**](#geteventbadgecolorrule) | **GET** /events/{eventId}/on-site/badge-colors/{ruleId} | Get an event badge color rule|
+|[**getEventBadgeColorRules**](#geteventbadgecolorrules) | **GET** /events/{eventId}/on-site/badge-colors | List an event\'s badge color rules|
 |[**getEventOnSite**](#geteventonsite) | **GET** /events/{eventId}/on-site | Get an event\'s on-site check-in settings|
+|[**updateEventBadgeColorRule**](#updateeventbadgecolorrule) | **PUT** /events/{eventId}/on-site/badge-colors/{ruleId} | Update an event badge color rule|
 |[**updateEventBadgeTemplate**](#updateeventbadgetemplate) | **PUT** /events/{eventId}/template | Update an event\'s badge template|
 |[**updateEventCheckinCode**](#updateeventcheckincode) | **POST** /events/{eventId}/on-site | Regenerate an event\'s check-in code|
 
+# **createEventBadgeColorRule**
+> CreateEventBadgeColorRule200Response createEventBadgeColorRule(eventBadgeColorRuleCreateInputs)
+
+Creates a new on-site badge color rule for the given event. Omitting sortOrder appends the rule after the last existing one; requires the \"update\" permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsOnSiteApi,
+    Configuration,
+    EventBadgeColorRuleCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsOnSiteApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let eventBadgeColorRuleCreateInputs: EventBadgeColorRuleCreateInputs; //
+
+const { status, data } = await apiInstance.createEventBadgeColorRule(
+    eventId,
+    eventBadgeColorRuleCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventBadgeColorRuleCreateInputs** | **EventBadgeColorRuleCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventBadgeColorRule200Response**
+
+### 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)
+
+# **deleteEventBadgeColorRule**
+> CreateAccountInvitations200Response deleteEventBadgeColorRule()
+
+Permanently deletes the specified on-site badge color rule from the given event; requires the \"update\" permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsOnSiteApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsOnSiteApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let ruleId: string; //The rule identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventBadgeColorRule(
+    eventId,
+    ruleId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **ruleId** | [**string**] | The rule 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)
+
+# **getEventBadgeColorRule**
+> CreateEventBadgeColorRule200Response getEventBadgeColorRule()
+
+Returns a single on-site badge color rule belonging to the given event; requires \"read\" permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsOnSiteApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsOnSiteApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let ruleId: string; //The rule identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventBadgeColorRule(
+    eventId,
+    ruleId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **ruleId** | [**string**] | The rule identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventBadgeColorRule200Response**
+
+### 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)
+
+# **getEventBadgeColorRules**
+> GetEventBadgeColorRules200Response getEventBadgeColorRules()
+
+Returns a paginated list of on-site badge color rules configured for the given event, with optional search and sort order; requires \"read\" permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsOnSiteApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsOnSiteApi(configuration);
+
+let eventId: string; //The event 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.getEventBadgeColorRules(
+    eventId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event 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
+
+**GetEventBadgeColorRules200Response**
+
+### 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)
+
 # **getEventOnSite**
 > GetEventOnSite200Response getEventOnSite()
 
@@ -52,6 +283,64 @@ const { status, data } = await apiInstance.getEventOnSite(
  - **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)
+
+# **updateEventBadgeColorRule**
+> CreateEventBadgeColorRule200Response updateEventBadgeColorRule(eventBadgeColorRuleUpdateInputs)
+
+Partially updates the specified on-site badge color rule. Changing type still nulls unused match branches on the backend, so send the new branch\'s ids when the type changes; requires the \"update\" permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsOnSiteApi,
+    Configuration,
+    EventBadgeColorRuleUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsOnSiteApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let ruleId: string; //The rule identifier (default to undefined)
+let eventBadgeColorRuleUpdateInputs: EventBadgeColorRuleUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventBadgeColorRule(
+    eventId,
+    ruleId,
+    eventBadgeColorRuleUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventBadgeColorRuleUpdateInputs** | **EventBadgeColorRuleUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **ruleId** | [**string**] | The rule identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventBadgeColorRule200Response**
+
+### 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 |
 |-------------|-------------|------------------|

package/docs/GetEventBadgeColorRules200Response.md

@@ -0,0 +1,26 @@
+# GetEventBadgeColorRules200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<EventOnSiteBadgeColorRule>**](EventOnSiteBadgeColorRule.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventBadgeColorRules200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetEventBadgeColorRules200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)