@connectedxm/admin-sdk 10.16.0 → 10.18.0

package/docs/EventsOnSiteApi.md

@@ -4,14 +4,80 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**addEventOnSiteLabelPassType**](#addeventonsitelabelpasstype) | **POST** /events/{eventId}/on-site/labels/{labelId}/passTypes/{passTypeId} | Assign a pass type to an on-site label|
 |[**createEventBadgeColorRule**](#createeventbadgecolorrule) | **POST** /events/{eventId}/on-site/badge-colors | Create an event badge color rule|
+|[**createEventOnSiteLabel**](#createeventonsitelabel) | **POST** /events/{eventId}/on-site/labels | Create an event on-site label|
 |[**deleteEventBadgeColorRule**](#deleteeventbadgecolorrule) | **DELETE** /events/{eventId}/on-site/badge-colors/{ruleId} | Delete an event badge color rule|
+|[**deleteEventOnSiteLabel**](#deleteeventonsitelabel) | **DELETE** /events/{eventId}/on-site/labels/{labelId} | Delete an event on-site label|
 |[**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|
+|[**getEventOnSiteLabel**](#geteventonsitelabel) | **GET** /events/{eventId}/on-site/labels/{labelId} | Get an event on-site label|
+|[**getEventOnSiteLabelPassTypes**](#geteventonsitelabelpasstypes) | **GET** /events/{eventId}/on-site/labels/{labelId}/passTypes | List pass types assigned to an on-site label|
+|[**getEventOnSiteLabels**](#geteventonsitelabels) | **GET** /events/{eventId}/on-site/labels | List an event\'s on-site labels|
+|[**removeEventOnSiteLabelPassType**](#removeeventonsitelabelpasstype) | **DELETE** /events/{eventId}/on-site/labels/{labelId}/passTypes/{passTypeId} | Unassign a pass type from an on-site label|
+|[**setEventOnSiteLabelDefault**](#seteventonsitelabeldefault) | **POST** /events/{eventId}/on-site/labels/{labelId}/default | Set an event on-site label as the default|
 |[**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|
+|[**updateEventOnSiteLabel**](#updateeventonsitelabel) | **PUT** /events/{eventId}/on-site/labels/{labelId} | Update an event on-site label|
+
+# **addEventOnSiteLabelPassType**
+> AddEventOnSiteLabelPassType200Response addEventOnSiteLabelPassType()
+
+Sets the given pass type\'s labelId to this label. Assignment is exclusive, so a pass type previously assigned to another label is silently moved; 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 labelId: string; //The label identifier (default to undefined)
+let passTypeId: string; //The passType identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventOnSiteLabelPassType(
+    eventId,
+    labelId,
+    passTypeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **labelId** | [**string**] | The label identifier | defaults to undefined|
+| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
+
+
+### Return type
+
+**AddEventOnSiteLabelPassType200Response**
+
+### 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)
 
 # **createEventBadgeColorRule**
 > CreateEventBadgeColorRule200Response createEventBadgeColorRule(eventBadgeColorRuleCreateInputs)
@@ -61,6 +127,61 @@ const { status, data } = await apiInstance.createEventBadgeColorRule(
  - **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)
+
+# **createEventOnSiteLabel**
+> CreateEventOnSiteLabel200Response createEventOnSiteLabel(eventOnSiteLabelCreateInputs)
+
+Creates a new on-site label for the given event. Omitting sortOrder appends the label after the last existing one. The API flags the new label as default when the event currently has none; requires the \"update\" permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsOnSiteApi,
+    Configuration,
+    EventOnSiteLabelCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsOnSiteApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let eventOnSiteLabelCreateInputs: EventOnSiteLabelCreateInputs; //
+
+const { status, data } = await apiInstance.createEventOnSiteLabel(
+    eventId,
+    eventOnSiteLabelCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventOnSiteLabelCreateInputs** | **EventOnSiteLabelCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventOnSiteLabel200Response**
+
+### 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 |
 |-------------|-------------|------------------|
@@ -101,6 +222,60 @@ const { status, data } = await apiInstance.deleteEventBadgeColorRule(
 | **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)
+
+# **deleteEventOnSiteLabel**
+> CreateAccountInvitations200Response deleteEventOnSiteLabel()
+
+Permanently deletes the specified on-site label 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 labelId: string; //The label identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventOnSiteLabel(
+    eventId,
+    labelId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **labelId** | [**string**] | The label identifier | defaults to undefined|
+
+
 ### Return type
 
 **CreateAccountInvitations200Response**
@@ -283,6 +458,300 @@ 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)
+
+# **getEventOnSiteLabel**
+> CreateEventOnSiteLabel200Response getEventOnSiteLabel()
+
+Returns a single on-site label 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 labelId: string; //The label identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventOnSiteLabel(
+    eventId,
+    labelId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **labelId** | [**string**] | The label identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventOnSiteLabel200Response**
+
+### 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)
+
+# **getEventOnSiteLabelPassTypes**
+> GetEventAddOnPassTypes200Response getEventOnSiteLabelPassTypes()
+
+Returns a paginated list of the event\'s pass types assigned to the given on-site label, supporting search and ordering; 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 labelId: string; //The label 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.getEventOnSiteLabelPassTypes(
+    eventId,
+    labelId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **labelId** | [**string**] | The label 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
+
+**GetEventAddOnPassTypes200Response**
+
+### 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)
+
+# **getEventOnSiteLabels**
+> GetEventOnSiteLabels200Response getEventOnSiteLabels()
+
+Returns the event\'s full set of on-site labels ordered by sortOrder. Pagination params are accepted but ignored by the API; 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.getEventOnSiteLabels(
+    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
+
+**GetEventOnSiteLabels200Response**
+
+### 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)
+
+# **removeEventOnSiteLabelPassType**
+> AddEventOnSiteLabelPassType200Response removeEventOnSiteLabelPassType()
+
+Clears the given pass type\'s labelId when it currently points at this label. Returns 400 if the pass type has since moved to another label; 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 labelId: string; //The label identifier (default to undefined)
+let passTypeId: string; //The passType identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventOnSiteLabelPassType(
+    eventId,
+    labelId,
+    passTypeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **labelId** | [**string**] | The label identifier | defaults to undefined|
+| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
+
+
+### Return type
+
+**AddEventOnSiteLabelPassType200Response**
+
+### 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)
+
+# **setEventOnSiteLabelDefault**
+> CreateEventOnSiteLabel200Response setEventOnSiteLabelDefault()
+
+Marks the specified label as the event\'s default print design, clearing the flag from whichever label held it before. Unassigned pass types fall through to this label; 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 labelId: string; //The label identifier (default to undefined)
+
+const { status, data } = await apiInstance.setEventOnSiteLabelDefault(
+    eventId,
+    labelId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **labelId** | [**string**] | The label identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventOnSiteLabel200Response**
+
+### 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 |
 |-------------|-------------|------------------|
@@ -453,3 +922,61 @@ const { status, data } = await apiInstance.updateEventCheckinCode(
 
 [[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)
 
+# **updateEventOnSiteLabel**
+> CreateEventOnSiteLabel200Response updateEventOnSiteLabel(eventOnSiteLabelUpdateInputs)
+
+Partially updates the specified on-site label. The default flag is not writable here — use SetEventOnSiteLabelDefault; requires the \"update\" permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsOnSiteApi,
+    Configuration,
+    EventOnSiteLabelUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsOnSiteApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let labelId: string; //The label identifier (default to undefined)
+let eventOnSiteLabelUpdateInputs: EventOnSiteLabelUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventOnSiteLabel(
+    eventId,
+    labelId,
+    eventOnSiteLabelUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventOnSiteLabelUpdateInputs** | **EventOnSiteLabelUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **labelId** | [**string**] | The label identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventOnSiteLabel200Response**
+
+### 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)
+