@connectedxm/admin-sdk 1.0.0

package/docs/ActivityEntityInputs.md

@@ -0,0 +1,26 @@
+# ActivityEntityInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+**username** | **string** |  | [default to undefined]
+**href** | **string** |  | [default to undefined]
+**interest** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ActivityEntityInputs } from '@connectedxm/admin-sdk';
+
+const instance: ActivityEntityInputs = {
+    type,
+    username,
+    href,
+    interest,
+};
+```
+
+[[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/ActivityEntityType.md

@@ -0,0 +1,14 @@
+# ActivityEntityType
+
+
+## Enum
+
+* `Mention` (value: `'mention'`)
+
+* `Interest` (value: `'interest'`)
+
+* `Link` (value: `'link'`)
+
+* `Segment` (value: `'segment'`)
+
+[[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/ActivityPreference.md

@@ -0,0 +1,12 @@
+# ActivityPreference
+
+
+## Enum
+
+* `All` (value: `'all'`)
+
+* `Featured` (value: `'featured'`)
+
+* `None` (value: `'none'`)
+
+[[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/ActivityStatus.md

@@ -0,0 +1,14 @@
+# ActivityStatus
+
+
+## Enum
+
+* `Draft` (value: `'draft'`)
+
+* `Scheduled` (value: `'scheduled'`)
+
+* `Published` (value: `'published'`)
+
+* `Archived` (value: `'archived'`)
+
+[[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/ActivityUpdateInputs.md

@@ -0,0 +1,38 @@
+# ActivityUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accountId** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**entities** | [**Array<ActivityEntityInputs>**](ActivityEntityInputs.md) |  | [optional] [default to undefined]
+**moderation** | [**ModerationStatus**](ModerationStatus.md) |  | [optional] [default to undefined]
+**featured** | **boolean** |  | [optional] [default to undefined]
+**pinned** | **boolean** |  | [optional] [default to undefined]
+**imageId** | **string** |  | [optional] [default to undefined]
+**videoId** | **string** |  | [optional] [default to undefined]
+**meetingId** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ActivityUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: ActivityUpdateInputs = {
+    accountId,
+    message,
+    entities,
+    moderation,
+    featured,
+    pinned,
+    imageId,
+    videoId,
+    meetingId,
+    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/AddAccountGroup200Response.md

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

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

@@ -0,0 +1,30 @@
+# AdminNotificationPreferences
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**supportTicketMessageAdmin** | **boolean** |  | [default to undefined]
+**supportTicketMessageEmail** | **boolean** |  | [default to undefined]
+**supportTicketAssignedAdmin** | **boolean** |  | [default to undefined]
+**supportTicketAssignedEmail** | **boolean** |  | [default to undefined]
+**supportTicketCreatedAdmin** | **boolean** |  | [default to undefined]
+**supportTicketCreatedEmail** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AdminNotificationPreferences } from '@connectedxm/admin-sdk';
+
+const instance: AdminNotificationPreferences = {
+    supportTicketMessageAdmin,
+    supportTicketMessageEmail,
+    supportTicketAssignedAdmin,
+    supportTicketAssignedEmail,
+    supportTicketCreatedAdmin,
+    supportTicketCreatedEmail,
+};
+```
+
+[[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/AdminNotificationPreferencesUpdateInputs.md

@@ -0,0 +1,30 @@
+# AdminNotificationPreferencesUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**supportTicketMessageAdmin** | **boolean** |  | [optional] [default to undefined]
+**supportTicketMessageEmail** | **boolean** |  | [optional] [default to undefined]
+**supportTicketAssignedAdmin** | **boolean** |  | [optional] [default to undefined]
+**supportTicketAssignedEmail** | **boolean** |  | [optional] [default to undefined]
+**supportTicketCreatedAdmin** | **boolean** |  | [optional] [default to undefined]
+**supportTicketCreatedEmail** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminNotificationPreferencesUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AdminNotificationPreferencesUpdateInputs = {
+    supportTicketMessageAdmin,
+    supportTicketMessageEmail,
+    supportTicketAssignedAdmin,
+    supportTicketAssignedEmail,
+    supportTicketCreatedAdmin,
+    supportTicketCreatedEmail,
+};
+```
+
+[[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/AdminNotificationSource.md

@@ -0,0 +1,12 @@
+# AdminNotificationSource
+
+
+## Enum
+
+* `System` (value: `'SYSTEM'`)
+
+* `OrgMember` (value: `'ORG_MEMBER'`)
+
+* `Account` (value: `'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/AdminNotificationType.md

@@ -0,0 +1,12 @@
+# AdminNotificationType
+
+
+## Enum
+
+* `SupportTicketCreated` (value: `'SUPPORT_TICKET_CREATED'`)
+
+* `SupportTicketAssigned` (value: `'SUPPORT_TICKET_ASSIGNED'`)
+
+* `SupportTicketMessage` (value: `'SUPPORT_TICKET_MESSAGE'`)
+
+[[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/Advertisement.md

@@ -0,0 +1,30 @@
+# Advertisement
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | [**BaseAccount**](BaseAccount.md) |  | [default to undefined]
+**event** | [**BaseEvent**](BaseEvent.md) |  | [default to undefined]
+**eventOnly** | **boolean** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**_count** | [**AdvertisementCount**](AdvertisementCount.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Advertisement } from '@connectedxm/admin-sdk';
+
+const instance: Advertisement = {
+    account,
+    event,
+    eventOnly,
+    createdAt,
+    updatedAt,
+    _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)

package/docs/AdvertisementClick.md

@@ -0,0 +1,34 @@
+# AdvertisementClick
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**organizationId** | **string** |  | [default to undefined]
+**advertisementId** | **string** |  | [default to undefined]
+**advertisement** | [**BaseAdvertisement**](BaseAdvertisement.md) |  | [default to undefined]
+**accountId** | **string** |  | [default to undefined]
+**account** | [**BaseAccount**](BaseAccount.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AdvertisementClick } from '@connectedxm/admin-sdk';
+
+const instance: AdvertisementClick = {
+    id,
+    organizationId,
+    advertisementId,
+    advertisement,
+    accountId,
+    account,
+    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/AdvertisementCount.md

@@ -0,0 +1,22 @@
+# AdvertisementCount
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**views** | **number** |  | [default to undefined]
+**clicks** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AdvertisementCount } from '@connectedxm/admin-sdk';
+
+const instance: AdvertisementCount = {
+    views,
+    clicks,
+};
+```
+
+[[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/AdvertisementCreateInputs.md

@@ -0,0 +1,42 @@
+# AdvertisementCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**AdvertisementType**](AdvertisementType.md) |  | [default to undefined]
+**link** | **string** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**startDate** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**imageId** | **string** |  | [optional] [default to undefined]
+**endDate** | **string** |  | [optional] [default to undefined]
+**weight** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) |  | [optional] [default to undefined]
+**accountId** | **string** |  | [optional] [default to undefined]
+**eventId** | **string** |  | [optional] [default to undefined]
+**eventOnly** | **boolean** |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdvertisementCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AdvertisementCreateInputs = {
+    type,
+    link,
+    title,
+    startDate,
+    description,
+    imageId,
+    endDate,
+    weight,
+    accountId,
+    eventId,
+    eventOnly,
+    enabled,
+};
+```
+
+[[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/AdvertisementCreateInputsWeight.md

@@ -0,0 +1,18 @@
+# AdvertisementCreateInputsWeight
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { AdvertisementCreateInputsWeight } from '@connectedxm/admin-sdk';
+
+const instance: AdvertisementCreateInputsWeight = {
+};
+```
+
+[[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/AdvertisementType.md

@@ -0,0 +1,10 @@
+# AdvertisementType
+
+
+## Enum
+
+* `Square` (value: `'square'`)
+
+* `Rectangle` (value: `'rectangle'`)
+
+[[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/AdvertisementUpdateInputs.md

@@ -0,0 +1,42 @@
+# AdvertisementUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**AdvertisementType**](AdvertisementType.md) |  | [optional] [default to undefined]
+**link** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**imageId** | **string** |  | [optional] [default to undefined]
+**startDate** | **string** |  | [optional] [default to undefined]
+**endDate** | **string** |  | [optional] [default to undefined]
+**weight** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) |  | [optional] [default to undefined]
+**accountId** | **string** |  | [optional] [default to undefined]
+**eventId** | **string** |  | [optional] [default to undefined]
+**eventOnly** | **boolean** |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdvertisementUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AdvertisementUpdateInputs = {
+    type,
+    link,
+    title,
+    description,
+    imageId,
+    startDate,
+    endDate,
+    weight,
+    accountId,
+    eventId,
+    eventOnly,
+    enabled,
+};
+```
+
+[[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/AdvertisementView.md

@@ -0,0 +1,34 @@
+# AdvertisementView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**organizationId** | **string** |  | [default to undefined]
+**advertisementId** | **string** |  | [default to undefined]
+**advertisement** | [**Advertisement**](Advertisement.md) |  | [default to undefined]
+**accountId** | **string** |  | [default to undefined]
+**account** | [**Account**](Account.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AdvertisementView } from '@connectedxm/admin-sdk';
+
+const instance: AdvertisementView = {
+    id,
+    organizationId,
+    advertisementId,
+    advertisement,
+    accountId,
+    account,
+    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)