@connectedxm/admin-sdk 8.1.3 → 8.2.0

package/docs/ChannelsApi.md

@@ -35,7 +35,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**updateChannelSubscriber**](#updatechannelsubscriber) | **PUT** /channels/{channelId}/subscribers/{accountId} | Update an account\'s channel subscription|
 
 # **addChannelSubscriber**
-> AddChannelSubscriber200Response addChannelSubscriber()
+> AddChannelSubscriber200Response addChannelSubscriber(addChannelSubscriberRequest)
 
 Adds the given account as a subscriber of the specified channel, requiring update permission on both channels and accounts.
 
@@ -44,18 +44,19 @@ Adds the given account as a subscriber of the specified channel, requiring updat
 ```typescript
 import {
     ChannelsApi,
-    Configuration
+    Configuration,
+    AddChannelSubscriberRequest
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new ChannelsApi(configuration);
 
 let channelId: string; //The channel identifier (default to undefined)
-let accountId: string; //Filter by accountId (default to undefined)
+let addChannelSubscriberRequest: AddChannelSubscriberRequest; //
 
 const { status, data } = await apiInstance.addChannelSubscriber(
     channelId,
-    accountId
+    addChannelSubscriberRequest
 );
 ```
 
@@ -63,8 +64,8 @@ const { status, data } = await apiInstance.addChannelSubscriber(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **addChannelSubscriberRequest** | **AddChannelSubscriberRequest**|  | |
 | **channelId** | [**string**] | The channel identifier | defaults to undefined|
-| **accountId** | [**string**] | Filter by accountId | defaults to undefined|
 
 
 ### Return type
@@ -77,7 +78,7 @@ const { status, data } = await apiInstance.addChannelSubscriber(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
@@ -250,7 +251,7 @@ const { status, data } = await apiInstance.createChannelContent(
 [[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)
 
 # **createChannelContentGuest**
-> CreateChannelContentGuest200Response createChannelContentGuest()
+> CreateChannelContentGuest200Response createChannelContentGuest(channelContentGuestCreateInputs)
 
 Adds a guest (such as a speaker or host) to a specific content item within a channel, requiring update permission on contents, and returns the created guest record.
 
@@ -268,12 +269,12 @@ const apiInstance = new ChannelsApi(configuration);
 
 let channelId: string; //The channel identifier (default to undefined)
 let contentId: string; //The content identifier (default to undefined)
-let contentGuest: ChannelContentGuestCreateInputs; //Filter by contentGuest (default to undefined)
+let channelContentGuestCreateInputs: ChannelContentGuestCreateInputs; //
 
 const { status, data } = await apiInstance.createChannelContentGuest(
     channelId,
     contentId,
-    contentGuest
+    channelContentGuestCreateInputs
 );
 ```
 
@@ -281,9 +282,9 @@ const { status, data } = await apiInstance.createChannelContentGuest(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **channelContentGuestCreateInputs** | **ChannelContentGuestCreateInputs**|  | |
 | **channelId** | [**string**] | The channel identifier | defaults to undefined|
 | **contentId** | [**string**] | The content identifier | defaults to undefined|
-| **contentGuest** | **ChannelContentGuestCreateInputs** | Filter by contentGuest | defaults to undefined|
 
 
 ### Return type
@@ -296,7 +297,7 @@ const { status, data } = await apiInstance.createChannelContentGuest(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
@@ -1439,7 +1440,7 @@ const { status, data } = await apiInstance.revertChannelContentToDraft(
 [[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)
 
 # **updateChannel**
-> CreateChannel200Response updateChannel()
+> CreateChannel200Response updateChannel(channelUpdateInputs)
 
 Updates the properties of an existing channel, such as its name and settings, requiring update permission on channels.
 
@@ -1456,11 +1457,11 @@ const configuration = new Configuration();
 const apiInstance = new ChannelsApi(configuration);
 
 let channelId: string; //The channel identifier (default to undefined)
-let channel: ChannelUpdateInputs; //Filter by channel (default to undefined)
+let channelUpdateInputs: ChannelUpdateInputs; //
 
 const { status, data } = await apiInstance.updateChannel(
     channelId,
-    channel
+    channelUpdateInputs
 );
 ```
 
@@ -1468,8 +1469,8 @@ const { status, data } = await apiInstance.updateChannel(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **channelUpdateInputs** | **ChannelUpdateInputs**|  | |
 | **channelId** | [**string**] | The channel identifier | defaults to undefined|
-| **channel** | **ChannelUpdateInputs** | Filter by channel | defaults to undefined|
 
 
 ### Return type
@@ -1482,7 +1483,7 @@ const { status, data } = await apiInstance.updateChannel(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
@@ -1552,7 +1553,7 @@ const { status, data } = await apiInstance.updateChannelContent(
 [[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)
 
 # **updateChannelContentGuest**
-> CreateChannelContentGuest200Response updateChannelContentGuest()
+> CreateChannelContentGuest200Response updateChannelContentGuest(channelContentGuestUpdateInputs)
 
 Updates a guest speaker or panelist record attached to a piece of channel content, such as their name, bio, title, company, or image, and requires update permission on contents.
 
@@ -1571,13 +1572,13 @@ const apiInstance = new ChannelsApi(configuration);
 let channelId: string; //The channel identifier (default to undefined)
 let contentId: string; //The content identifier (default to undefined)
 let guestId: string; //The guest identifier (default to undefined)
-let contentGuest: ChannelContentGuestUpdateInputs; //Filter by contentGuest (default to undefined)
+let channelContentGuestUpdateInputs: ChannelContentGuestUpdateInputs; //
 
 const { status, data } = await apiInstance.updateChannelContentGuest(
     channelId,
     contentId,
     guestId,
-    contentGuest
+    channelContentGuestUpdateInputs
 );
 ```
 
@@ -1585,10 +1586,10 @@ const { status, data } = await apiInstance.updateChannelContentGuest(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **channelContentGuestUpdateInputs** | **ChannelContentGuestUpdateInputs**|  | |
 | **channelId** | [**string**] | The channel identifier | defaults to undefined|
 | **contentId** | [**string**] | The content identifier | defaults to undefined|
 | **guestId** | [**string**] | The guest identifier | defaults to undefined|
-| **contentGuest** | **ChannelContentGuestUpdateInputs** | Filter by contentGuest | defaults to undefined|
 
 
 ### Return type
@@ -1601,7 +1602,7 @@ const { status, data } = await apiInstance.updateChannelContentGuest(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 

package/docs/CreateActivityRequest.md

@@ -0,0 +1,24 @@
+# CreateActivityRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accountId** | **string** |  | [default to undefined]
+**activity** | [**ActivityCreateInputs**](ActivityCreateInputs.md) |  | [default to undefined]
+**imageUri** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateActivityRequest } from '@connectedxm/admin-sdk';
+
+const instance: CreateActivityRequest = {
+    accountId,
+    activity,
+    imageUri,
+};
+```
+
+[[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/CreateEventSessionPriceRequest.md

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

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

@@ -0,0 +1,26 @@
+# CreateOrganizationSideEffectRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**triggerType** | [**SideEffectTriggerType**](SideEffectTriggerType.md) |  | [default to undefined]
+**triggerId** | **string** |  | [default to undefined]
+**actionType** | [**SideEffectActionType**](SideEffectActionType.md) |  | [default to undefined]
+**actionId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateOrganizationSideEffectRequest } from '@connectedxm/admin-sdk';
+
+const instance: CreateOrganizationSideEffectRequest = {
+    triggerType,
+    triggerId,
+    actionType,
+    actionId,
+};
+```
+
+[[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/CreateThreadMessageReactionRequest.md

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

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

@@ -9,7 +9,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**removeEventAccessUser**](#removeeventaccessuser) | **DELETE** /events/{eventId}/access-users/{userId} | Revoke a user\'s private event access|
 
 # **addEventAccessUser**
-> SyncAccounts200Response addEventAccessUser()
+> SyncAccounts200Response addEventAccessUser(addEventAccessUserRequest)
 
 Looks up an existing platform user by email and grants them admin access to manage a specific event, and requires update permission on events; fails if no user with that email exists.
 
@@ -18,18 +18,19 @@ Looks up an existing platform user by email and grants them admin access to mana
 ```typescript
 import {
     EventsAccessApi,
-    Configuration
+    Configuration,
+    AddEventAccessUserRequest
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new EventsAccessApi(configuration);
 
 let eventId: string; //The event identifier (default to undefined)
-let email: string; //Filter by email (default to undefined)
+let addEventAccessUserRequest: AddEventAccessUserRequest; //
 
 const { status, data } = await apiInstance.addEventAccessUser(
     eventId,
-    email
+    addEventAccessUserRequest
 );
 ```
 
@@ -37,8 +38,8 @@ const { status, data } = await apiInstance.addEventAccessUser(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **addEventAccessUserRequest** | **AddEventAccessUserRequest**|  | |
 | **eventId** | [**string**] | The event identifier | defaults to undefined|
-| **email** | [**string**] | Filter by email | defaults to undefined|
 
 
 ### Return type
@@ -51,7 +52,7 @@ const { status, data } = await apiInstance.addEventAccessUser(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 

package/docs/EventsAddonsApi.md

@@ -75,7 +75,7 @@ const { status, data } = await apiInstance.addEventAddOnPassType(
 [[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)
 
 # **addEventAddOnTier**
-> CreateEventAddOn200Response addEventAddOnTier()
+> CreateEventAddOn200Response addEventAddOnTier(addEventAddOnTierRequest)
 
 Adds the given account tier to the add-on\'s allowed or disallowed tier list, controlling whether members of that tier can purchase the event add-on, based on the `allowed` flag; requires the update permission on events.
 
@@ -84,7 +84,8 @@ Adds the given account tier to the add-on\'s allowed or disallowed tier list, co
 ```typescript
 import {
     EventsAddonsApi,
-    Configuration
+    Configuration,
+    AddEventAddOnTierRequest
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
@@ -93,13 +94,13 @@ const apiInstance = new EventsAddonsApi(configuration);
 let eventId: string; //The event identifier (default to undefined)
 let addOnId: string; //The addOn identifier (default to undefined)
 let tierId: string; //The tier identifier (default to undefined)
-let allowed: boolean; //Filter by allowed (default to undefined)
+let addEventAddOnTierRequest: AddEventAddOnTierRequest; //
 
 const { status, data } = await apiInstance.addEventAddOnTier(
     eventId,
     addOnId,
     tierId,
-    allowed
+    addEventAddOnTierRequest
 );
 ```
 
@@ -107,10 +108,10 @@ const { status, data } = await apiInstance.addEventAddOnTier(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **addEventAddOnTierRequest** | **AddEventAddOnTierRequest**|  | |
 | **eventId** | [**string**] | The event identifier | defaults to undefined|
 | **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
 | **tierId** | [**string**] | The tier identifier | defaults to undefined|
-| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
 
 
 ### Return type
@@ -123,7 +124,7 @@ const { status, data } = await apiInstance.addEventAddOnTier(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
@@ -679,7 +680,7 @@ const { status, data } = await apiInstance.removeEventAddOnTier(
 [[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)
 
 # **updateEventAddOn**
-> CreateEventAddOn200Response updateEventAddOn()
+> CreateEventAddOn200Response updateEventAddOn(eventAddOnUpdateInputs)
 
 Updates an existing add-on for an event, including its name, pricing, and related settings; if a new sortOrder is provided the other add-ons for the event are reordered around it, and this requires read and update permission on events.
 
@@ -697,12 +698,12 @@ const apiInstance = new EventsAddonsApi(configuration);
 
 let eventId: string; //The event identifier (default to undefined)
 let addOnId: string; //The addOn identifier (default to undefined)
-let addOn: EventAddOnUpdateInputs; //Filter by addOn (default to undefined)
+let eventAddOnUpdateInputs: EventAddOnUpdateInputs; //
 
 const { status, data } = await apiInstance.updateEventAddOn(
     eventId,
     addOnId,
-    addOn
+    eventAddOnUpdateInputs
 );
 ```
 
@@ -710,9 +711,9 @@ const { status, data } = await apiInstance.updateEventAddOn(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **eventAddOnUpdateInputs** | **EventAddOnUpdateInputs**|  | |
 | **eventId** | [**string**] | The event identifier | defaults to undefined|
 | **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
-| **addOn** | **EventAddOnUpdateInputs** | Filter by addOn | defaults to undefined|
 
 
 ### Return type
@@ -725,7 +726,7 @@ const { status, data } = await apiInstance.updateEventAddOn(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 

package/docs/EventsBypassApi.md

@@ -237,7 +237,7 @@ const { status, data } = await apiInstance.getEventRegistrationBypassList(
 [[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)
 
 # **updateEventRegistrationBypass**
-> CreateEventRegistrationBypass200Response updateEventRegistrationBypass()
+> CreateEventRegistrationBypass200Response updateEventRegistrationBypass(eventRegistrationBypassUpdateInputs)
 
 Updates the fields of an existing registration bypass on the given event, such as the associated account, and requires update permission on events.
 
@@ -255,12 +255,12 @@ const apiInstance = new EventsBypassApi(configuration);
 
 let eventId: string; //The event identifier (default to undefined)
 let bypassId: string; //The bypass identifier (default to undefined)
-let page: EventRegistrationBypassUpdateInputs; //Filter by page (default to undefined)
+let eventRegistrationBypassUpdateInputs: EventRegistrationBypassUpdateInputs; //
 
 const { status, data } = await apiInstance.updateEventRegistrationBypass(
     eventId,
     bypassId,
-    page
+    eventRegistrationBypassUpdateInputs
 );
 ```
 
@@ -268,9 +268,9 @@ const { status, data } = await apiInstance.updateEventRegistrationBypass(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **eventRegistrationBypassUpdateInputs** | **EventRegistrationBypassUpdateInputs**|  | |
 | **eventId** | [**string**] | The event identifier | defaults to undefined|
 | **bypassId** | [**string**] | The bypass identifier | defaults to undefined|
-| **page** | **EventRegistrationBypassUpdateInputs** | Filter by page | defaults to undefined|
 
 
 ### Return type
@@ -283,7 +283,7 @@ const { status, data } = await apiInstance.updateEventRegistrationBypass(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 

package/docs/EventsCouponsApi.md

@@ -20,7 +20,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**updateEventCoupon**](#updateeventcoupon) | **PUT** /events/{eventId}/coupons/{couponId} | Update an event coupon|
 
 # **addEventCouponTier**
-> CreateEventCoupon200Response addEventCouponTier()
+> CreateEventCoupon200Response addEventCouponTier(addEventAddOnTierRequest)
 
 Adds a ticket tier to an event coupon\'s allow-list or disallow-list; when allowed is true the tier is connected to the coupon\'s allowed tiers, otherwise to its disallowed tiers. Requires update permission on events.
 
@@ -29,7 +29,8 @@ Adds a ticket tier to an event coupon\'s allow-list or disallow-list; when allow
 ```typescript
 import {
     EventsCouponsApi,
-    Configuration
+    Configuration,
+    AddEventAddOnTierRequest
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
@@ -38,13 +39,13 @@ const apiInstance = new EventsCouponsApi(configuration);
 let eventId: string; //The event identifier (default to undefined)
 let couponId: string; //The coupon identifier (default to undefined)
 let tierId: string; //The tier identifier (default to undefined)
-let allowed: boolean; //Filter by allowed (default to undefined)
+let addEventAddOnTierRequest: AddEventAddOnTierRequest; //
 
 const { status, data } = await apiInstance.addEventCouponTier(
     eventId,
     couponId,
     tierId,
-    allowed
+    addEventAddOnTierRequest
 );
 ```
 
@@ -52,10 +53,10 @@ const { status, data } = await apiInstance.addEventCouponTier(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **addEventAddOnTierRequest** | **AddEventAddOnTierRequest**|  | |
 | **eventId** | [**string**] | The event identifier | defaults to undefined|
 | **couponId** | [**string**] | The coupon identifier | defaults to undefined|
 | **tierId** | [**string**] | The tier identifier | defaults to undefined|
-| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
 
 
 ### Return type
@@ -68,7 +69,7 @@ const { status, data } = await apiInstance.addEventCouponTier(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json