@connectedxm/admin-sdk 1.0.0

package/docs/BaseGroupMembership.md

@@ -0,0 +1,30 @@
+# BaseGroupMembership
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accountId** | **string** |  | [default to undefined]
+**account** | [**BaseAccount**](BaseAccount.md) |  | [default to undefined]
+**groupId** | **string** |  | [default to undefined]
+**group** | [**BaseGroup**](BaseGroup.md) |  | [default to undefined]
+**role** | [**GroupMembershipRole**](GroupMembershipRole.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseGroupMembership } from '@connectedxm/admin-sdk';
+
+const instance: BaseGroupMembership = {
+    accountId,
+    account,
+    groupId,
+    group,
+    role,
+    createdAt,
+};
+```
+
+[[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/BaseGroupRequest.md

@@ -0,0 +1,26 @@
+# BaseGroupRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**status** | [**GroupRequestStatus**](GroupRequestStatus.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseGroupRequest } from '@connectedxm/admin-sdk';
+
+const instance: BaseGroupRequest = {
+    id,
+    status,
+    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/BaseImage.md

@@ -0,0 +1,30 @@
+# BaseImage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**uri** | **string** |  | [default to undefined]
+**width** | **number** |  | [default to undefined]
+**height** | **number** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseImage } from '@connectedxm/admin-sdk';
+
+const instance: BaseImage = {
+    id,
+    name,
+    uri,
+    width,
+    height,
+    createdAt,
+};
+```
+
+[[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/BaseImport.md

@@ -0,0 +1,30 @@
+# BaseImport
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**overwrite** | **boolean** |  | [default to undefined]
+**userId** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseImport } from '@connectedxm/admin-sdk';
+
+const instance: BaseImport = {
+    id,
+    type,
+    overwrite,
+    userId,
+    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/BaseImportItem.md

@@ -0,0 +1,34 @@
+# BaseImportItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**importId** | **string** |  | [default to undefined]
+**values** | **string** |  | [default to undefined]
+**status** | [**ImportItemStatus**](ImportItemStatus.md) |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**debug** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseImportItem } from '@connectedxm/admin-sdk';
+
+const instance: BaseImportItem = {
+    id,
+    importId,
+    values,
+    status,
+    message,
+    debug,
+    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/BaseIntegration.md

@@ -0,0 +1,28 @@
+# BaseIntegration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | [**IntegrationType**](IntegrationType.md) |  | [default to undefined]
+**enabled** | **boolean** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseIntegration } from '@connectedxm/admin-sdk';
+
+const instance: BaseIntegration = {
+    id,
+    type,
+    enabled,
+    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/BaseInterest.md

@@ -0,0 +1,28 @@
+# BaseInterest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**featured** | **boolean** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**imageId** | **string** |  | [default to undefined]
+**image** | [**BaseImage**](BaseImage.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseInterest } from '@connectedxm/admin-sdk';
+
+const instance: BaseInterest = {
+    id,
+    featured,
+    name,
+    imageId,
+    image,
+};
+```
+
+[[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/BaseInvoice.md

@@ -0,0 +1,36 @@
+# BaseInvoice
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**alternateId** | **string** |  | [default to undefined]
+**dueDate** | **string** |  | [default to undefined]
+**sentDate** | **string** |  | [default to undefined]
+**status** | [**InvoiceStatus**](InvoiceStatus.md) |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**notes** | **string** |  | [default to undefined]
+**paymentIntegrationId** | **string** |  | [default to undefined]
+**paymentIntegration** | [**BasePaymentIntegration**](BasePaymentIntegration.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseInvoice } from '@connectedxm/admin-sdk';
+
+const instance: BaseInvoice = {
+    id,
+    alternateId,
+    dueDate,
+    sentDate,
+    status,
+    title,
+    notes,
+    paymentIntegrationId,
+    paymentIntegration,
+};
+```
+
+[[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/BaseInvoiceLineItem.md

@@ -0,0 +1,38 @@
+# BaseInvoiceLineItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**quantity** | **number** |  | [default to undefined]
+**amount** | **number** |  | [default to undefined]
+**taxCode** | **string** |  | [default to undefined]
+**taxIncluded** | **boolean** |  | [default to undefined]
+**taxLocation** | [**TaxLocationType**](TaxLocationType.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseInvoiceLineItem } from '@connectedxm/admin-sdk';
+
+const instance: BaseInvoiceLineItem = {
+    id,
+    name,
+    description,
+    quantity,
+    amount,
+    taxCode,
+    taxIncluded,
+    taxLocation,
+    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/BaseLead.md

@@ -0,0 +1,30 @@
+# BaseLead
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**firstName** | **string** |  | [default to undefined]
+**lastName** | **string** |  | [default to undefined]
+**shareAccount** | [**BaseLeadShareAccount**](BaseLeadShareAccount.md) |  | [default to undefined]
+**status** | [**LeadStatus**](LeadStatus.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseLead } from '@connectedxm/admin-sdk';
+
+const instance: BaseLead = {
+    id,
+    firstName,
+    lastName,
+    shareAccount,
+    status,
+    createdAt,
+};
+```
+
+[[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/BaseLeadShareAccount.md

@@ -0,0 +1,22 @@
+# BaseLeadShareAccount
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**image** | [**BaseImage**](BaseImage.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseLeadShareAccount } from '@connectedxm/admin-sdk';
+
+const instance: BaseLeadShareAccount = {
+    id,
+    image,
+};
+```
+
+[[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/BaseLevel.md

@@ -0,0 +1,36 @@
+# BaseLevel
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**slug** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**subtitle** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**color** | **string** |  | [default to undefined]
+**scale** | **number** |  | [default to undefined]
+**imageId** | **string** |  | [default to undefined]
+**image** | [**BaseImage**](BaseImage.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseLevel } from '@connectedxm/admin-sdk';
+
+const instance: BaseLevel = {
+    id,
+    slug,
+    name,
+    subtitle,
+    description,
+    color,
+    scale,
+    imageId,
+    image,
+};
+```
+
+[[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/BaseLike.md

@@ -0,0 +1,22 @@
+# BaseLike
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**activity** | [**BaseActivity**](BaseActivity.md) |  | [default to undefined]
+**account** | [**BaseAccount**](BaseAccount.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseLike } from '@connectedxm/admin-sdk';
+
+const instance: BaseLike = {
+    activity,
+    account,
+};
+```
+
+[[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/BaseLinkPreview.md

@@ -0,0 +1,36 @@
+# BaseLinkPreview
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [default to undefined]
+**siteName** | **string** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**image** | **string** |  | [default to undefined]
+**imageWidth** | **number** |  | [default to undefined]
+**imageHeight** | **number** |  | [default to undefined]
+**imageType** | **string** |  | [default to undefined]
+**favicon** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseLinkPreview } from '@connectedxm/admin-sdk';
+
+const instance: BaseLinkPreview = {
+    url,
+    siteName,
+    title,
+    description,
+    image,
+    imageWidth,
+    imageHeight,
+    imageType,
+    favicon,
+};
+```
+
+[[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/BaseLogin.md

@@ -0,0 +1,42 @@
+# BaseLogin
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sub** | **string** |  | [default to undefined]
+**userPoolId** | **string** |  | [default to undefined]
+**username** | **string** |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**enabled** | **boolean** |  | [default to undefined]
+**verified** | **boolean** |  | [default to undefined]
+**firstName** | **string** |  | [default to undefined]
+**lastName** | **string** |  | [default to undefined]
+**internalRefId** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseLogin } from '@connectedxm/admin-sdk';
+
+const instance: BaseLogin = {
+    sub,
+    userPoolId,
+    username,
+    email,
+    status,
+    enabled,
+    verified,
+    firstName,
+    lastName,
+    internalRefId,
+    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/BaseMatch.md

@@ -0,0 +1,28 @@
+# BaseMatch
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**round** | [**BaseRound**](BaseRound.md) |  | [default to undefined]
+**number** | **number** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseMatch } from '@connectedxm/admin-sdk';
+
+const instance: BaseMatch = {
+    id,
+    round,
+    number,
+    title,
+    description,
+};
+```
+
+[[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/BaseMatchPass.md

@@ -0,0 +1,30 @@
+# BaseMatchPass
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**alternateId** | **number** |  | [default to undefined]
+**ticket** | [**BaseEventPassType**](BaseEventPassType.md) |  | [default to undefined]
+**attendee** | [**BaseEventAttendee**](BaseEventAttendee.md) |  | [default to undefined]
+**responses** | [**Array<BaseRegistrationQuestionResponse>**](BaseRegistrationQuestionResponse.md) |  | [optional] [default to undefined]
+**accesses** | [**Array<BaseMatchPassAccessesInner>**](BaseMatchPassAccessesInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BaseMatchPass } from '@connectedxm/admin-sdk';
+
+const instance: BaseMatchPass = {
+    id,
+    alternateId,
+    ticket,
+    attendee,
+    responses,
+    accesses,
+};
+```
+
+[[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/BaseMatchPassAccessesInner.md

@@ -0,0 +1,20 @@
+# BaseMatchPassAccessesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**responses** | [**Array<BaseEventSessionQuestionResponse>**](BaseEventSessionQuestionResponse.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseMatchPassAccessesInner } from '@connectedxm/admin-sdk';
+
+const instance: BaseMatchPassAccessesInner = {
+    responses,
+};
+```
+
+[[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/BaseMeeting.md

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

@@ -0,0 +1,28 @@
+# BaseMeetingLink
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**passcode** | **string** |  | [default to undefined]
+**preset_name** | **string** |  | [default to undefined]
+**requireAuth** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseMeetingLink } from '@connectedxm/admin-sdk';
+
+const instance: BaseMeetingLink = {
+    id,
+    name,
+    passcode,
+    preset_name,
+    requireAuth,
+};
+```
+
+[[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/BaseMeetingRecording.md

@@ -0,0 +1,42 @@
+# BaseMeetingRecording
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**meeting_id** | **string** |  | [default to undefined]
+**download_url** | **string** |  | [default to undefined]
+**download_url_expiry** | **string** |  | [default to undefined]
+**file_size** | **number** |  | [default to undefined]
+**session_id** | **string** |  | [default to undefined]
+**output_file_name** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**invoked_time** | **string** |  | [default to undefined]
+**started_time** | **string** |  | [default to undefined]
+**stopped_time** | **string** |  | [default to undefined]
+**recording_duration** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseMeetingRecording } from '@connectedxm/admin-sdk';
+
+const instance: BaseMeetingRecording = {
+    id,
+    meeting_id,
+    download_url,
+    download_url_expiry,
+    file_size,
+    session_id,
+    output_file_name,
+    status,
+    invoked_time,
+    started_time,
+    stopped_time,
+    recording_duration,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)