@connectedxm/admin-sdk 1.0.0

package/docs/EventsOnSiteApi.md

@@ -0,0 +1,344 @@
+# EventsOnSiteApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getEventOnSite**](#geteventonsite) | **GET** /events/{eventId}/on-site | Get Event On Site|
+|[**getEventZplTemplateBadgeField**](#geteventzpltemplatebadgefield) | **GET** /events/{eventId}/zpl-template/fields/{fieldId} | Get Event Zpl Template Badge Field|
+|[**getEventZplTemplateBadgeFields**](#geteventzpltemplatebadgefields) | **GET** /events/{eventId}/zpl-template/fields | Get Event Zpl Template Badge Fields|
+|[**updateEventCheckinCode**](#updateeventcheckincode) | **POST** /events/{eventId}/on-site | Update Event Checkin Code|
+|[**updateEventZplTemplate**](#updateeventzpltemplate) | **PUT** /events/{eventId}/zpl-template | Update Event Zpl Template|
+|[**updateEventZplTemplateBadgeField**](#updateeventzpltemplatebadgefield) | **PUT** /events/{eventId}/zpl-template/fields/{fieldId} | Update Event Zpl Template Badge Field|
+
+# **getEventOnSite**
+> GetEventOnSite200Response getEventOnSite()
+
+Get Event On Site endpoint
+
+### 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)
+
+const { status, data } = await apiInstance.getEventOnSite(
+    eventId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventOnSite200Response**
+
+### 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)
+
+# **getEventZplTemplateBadgeField**
+> CreateAccountAddress200Response getEventZplTemplateBadgeField()
+
+Get Event Zpl Template Badge Field endpoint
+
+### 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 fieldId: string; //The field identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventZplTemplateBadgeField(
+    eventId,
+    fieldId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **fieldId** | [**string**] | The field identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **getEventZplTemplateBadgeFields**
+> GetAccountInvitations200Response getEventZplTemplateBadgeFields()
+
+Get Event Zpl Template Badge Fields endpoint
+
+### 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.getEventZplTemplateBadgeFields(
+    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
+
+**GetAccountInvitations200Response**
+
+### 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)
+
+# **updateEventCheckinCode**
+> UpdateEventCheckinCode200Response updateEventCheckinCode()
+
+Update Event Checkin Code endpoint
+
+### 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)
+
+const { status, data } = await apiInstance.updateEventCheckinCode(
+    eventId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateEventCheckinCode200Response**
+
+### 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)
+
+# **updateEventZplTemplate**
+> UpdateEventCheckinCode200Response updateEventZplTemplate()
+
+Update Event Zpl Template endpoint
+
+### 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 zplTemplate: string; //Filter by zplTemplate (default to undefined)
+
+const { status, data } = await apiInstance.updateEventZplTemplate(
+    eventId,
+    zplTemplate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **zplTemplate** | [**string**] | Filter by zplTemplate | defaults to undefined|
+
+
+### Return type
+
+**UpdateEventCheckinCode200Response**
+
+### 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)
+
+# **updateEventZplTemplateBadgeField**
+> CreateAccountAddress200Response updateEventZplTemplateBadgeField()
+
+Update Event Zpl Template Badge Field endpoint
+
+### Example
+
+```typescript
+import {
+    EventsOnSiteApi,
+    Configuration,
+    EventBadgeFieldUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsOnSiteApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let fieldId: string; //The field identifier (default to undefined)
+let field: EventBadgeFieldUpdateInputs; //Filter by field (default to undefined)
+
+const { status, data } = await apiInstance.updateEventZplTemplateBadgeField(
+    eventId,
+    fieldId,
+    field
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **fieldId** | [**string**] | The field identifier | defaults to undefined|
+| **field** | **EventBadgeFieldUpdateInputs** | Filter by field | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+

package/docs/EventsPackagesApi.md

@@ -0,0 +1,296 @@
+# EventsPackagesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createEventPackage**](#createeventpackage) | **POST** /events/{eventId}/packages | Create Event Package|
+|[**deleteEventPackage**](#deleteeventpackage) | **DELETE** /events/{eventId}/packages/{packageId} | Delete Event Package|
+|[**getEventPackage**](#geteventpackage) | **GET** /events/{eventId}/packages/{packageId} | Get Event Package|
+|[**getEventPackages**](#geteventpackages) | **GET** /events/{eventId}/packages | Get Event Packages|
+|[**updateEventPackage**](#updateeventpackage) | **PUT** /events/{eventId}/packages/{packageId} | Update Event Package|
+
+# **createEventPackage**
+> CreateEventPackage200Response createEventPackage()
+
+Create Event Package endpoint
+
+### Example
+
+```typescript
+import {
+    EventsPackagesApi,
+    Configuration,
+    EventPackageCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPackagesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let _package: EventPackageCreateInputs; //Filter by package (default to undefined)
+
+const { status, data } = await apiInstance.createEventPackage(
+    eventId,
+    _package
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **_package** | **EventPackageCreateInputs** | Filter by package | defaults to undefined|
+
+
+### Return type
+
+**CreateEventPackage200Response**
+
+### 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)
+
+# **deleteEventPackage**
+> CreateAccountInvitations200Response deleteEventPackage()
+
+Delete Event Package endpoint
+
+### Example
+
+```typescript
+import {
+    EventsPackagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPackagesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let packageId: string; //The package identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventPackage(
+    eventId,
+    packageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **packageId** | [**string**] | The package 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)
+
+# **getEventPackage**
+> CreateEventPackage200Response getEventPackage()
+
+Get Event Package endpoint
+
+### Example
+
+```typescript
+import {
+    EventsPackagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPackagesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let packageId: string; //The package identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventPackage(
+    eventId,
+    packageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **packageId** | [**string**] | The package identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventPackage200Response**
+
+### 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)
+
+# **getEventPackages**
+> GetEventPackages200Response getEventPackages()
+
+Get Event Packages endpoint
+
+### Example
+
+```typescript
+import {
+    EventsPackagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPackagesApi(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.getEventPackages(
+    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
+
+**GetEventPackages200Response**
+
+### 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)
+
+# **updateEventPackage**
+> CreateEventPackage200Response updateEventPackage()
+
+Update Event Package endpoint
+
+### Example
+
+```typescript
+import {
+    EventsPackagesApi,
+    Configuration,
+    EventPackageUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPackagesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let packageId: string; //The package identifier (default to undefined)
+let _package: EventPackageUpdateInputs; //Filter by package (default to undefined)
+
+const { status, data } = await apiInstance.updateEventPackage(
+    eventId,
+    packageId,
+    _package
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **packageId** | [**string**] | The package identifier | defaults to undefined|
+| **_package** | **EventPackageUpdateInputs** | Filter by package | defaults to undefined|
+
+
+### Return type
+
+**CreateEventPackage200Response**
+
+### 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)
+