@connectedxm/admin-sdk 12.1.0 → 12.3.0

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 12.1.0
+ * The version of the OpenAPI document: 12.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 12.1.0
+ * The version of the OpenAPI document: 12.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 12.1.0
+ * The version of the OpenAPI document: 12.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 12.1.0
+ * The version of the OpenAPI document: 12.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 12.1.0
+ * The version of the OpenAPI document: 12.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 12.1.0
+ * The version of the OpenAPI document: 12.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/AnnouncementAudienceScope.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **groupId** | **string** |  | [optional] [default to undefined]
 **channelId** | **string** |  | [optional] [default to undefined]
 **archived** | **boolean** |  | [optional] [default to undefined]
+**featured** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -20,6 +21,7 @@ const instance: AnnouncementAudienceScope = {
     groupId,
     channelId,
     archived,
+    featured,
 };
 ```
 

package/docs/AnnouncementsApi.md

@@ -351,21 +351,26 @@ Returns a paginated list of announcements for the organization, optionally filte
 ```typescript
 import {
     AnnouncementsApi,
-    Configuration,
-    AnnouncementFilters
+    Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new AnnouncementsApi(configuration);
 
-let filters: AnnouncementFilters; //Filter by filters (optional) (default to undefined)
+let eventId: string; //Filter by eventId (optional) (default to undefined)
+let groupId: string; //Filter by groupId (optional) (default to undefined)
+let audienceId: string; //Filter by audienceId (optional) (default to undefined)
+let community: boolean; //Filter by community (optional) (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.getAnnouncements(
-    filters,
+    eventId,
+    groupId,
+    audienceId,
+    community,
     page,
     pageSize,
     orderBy,
@@ -377,7 +382,10 @@ const { status, data } = await apiInstance.getAnnouncements(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **filters** | **AnnouncementFilters** | Filter by filters | (optional) defaults to undefined|
+| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
+| **groupId** | [**string**] | Filter by groupId | (optional) defaults to undefined|
+| **audienceId** | [**string**] | Filter by audienceId | (optional) defaults to undefined|
+| **community** | [**boolean**] | Filter by community | (optional) 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|

package/docs/AnnouncementsAudiencesApi.md

@@ -461,28 +461,35 @@ const { status, data } = await apiInstance.getAnnouncementAudienceAccounts(
 # **getAnnouncementAudiences**
 > GetAnnouncementAudiences200Response getAnnouncementAudiences()
 
-Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
+Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones, or featured for starred ones only. requires read permission on announcements.
 
 ### Example
 
 ```typescript
 import {
     AnnouncementsAudiencesApi,
-    Configuration,
-    AnnouncementAudienceScope
+    Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new AnnouncementsAudiencesApi(configuration);
 
-let scope: AnnouncementAudienceScope; //Filter by scope (optional) (default to undefined)
+let eventId: string; //Filter by eventId (optional) (default to undefined)
+let groupId: string; //Filter by groupId (optional) (default to undefined)
+let channelId: string; //Filter by channelId (optional) (default to undefined)
+let archived: boolean; //Filter by archived (optional) (default to undefined)
+let featured: boolean; //Filter by featured (optional) (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.getAnnouncementAudiences(
-    scope,
+    eventId,
+    groupId,
+    channelId,
+    archived,
+    featured,
     page,
     pageSize,
     orderBy,
@@ -494,7 +501,11 @@ const { status, data } = await apiInstance.getAnnouncementAudiences(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **scope** | **AnnouncementAudienceScope** | Filter by scope | (optional) defaults to undefined|
+| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
+| **groupId** | [**string**] | Filter by groupId | (optional) defaults to undefined|
+| **channelId** | [**string**] | Filter by channelId | (optional) defaults to undefined|
+| **archived** | [**boolean**] | Filter by archived | (optional) defaults to undefined|
+| **featured** | [**boolean**] | Filter by featured | (optional) 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|

package/docs/BaseStandardReport.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **category** | **string** |  | [default to undefined]
 **name** | **string** |  | [default to undefined]
 **description** | **string** |  | [default to undefined]
-**dateType** | [**EventReportDateType**](EventReportDateType.md) |  | [default to undefined]
+**dateType** | [**EventReportDateType**](EventReportDateType.md) |  | [optional] [default to undefined]
 **favorite** | **boolean** |  | [default to undefined]
 **rowLink** | **string** |  | [optional] [default to undefined]
 

package/docs/CustomReportCreateInputs.md

@@ -13,6 +13,9 @@ Name | Type | Description | Notes
 **surveyId** | **string** |  | [optional] [default to undefined]
 **sessionId** | **string** |  | [optional] [default to undefined]
 **seriesId** | **string** |  | [optional] [default to undefined]
+**spaceId** | **string** |  | [optional] [default to undefined]
+**entityId** | **string** |  | [optional] [default to undefined]
+**since** | **string** |  | [optional] [default to undefined]
 **name** | **string** |  | [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 **gridState** | **string** |  | [optional] [default to undefined]
@@ -32,6 +35,9 @@ const instance: CustomReportCreateInputs = {
     surveyId,
     sessionId,
     seriesId,
+    spaceId,
+    entityId,
+    since,
     name,
     description,
     gridState,

package/docs/NotificationsApi.md

@@ -19,17 +19,20 @@ Returns the number of notifications for the current organization member, optiona
 ```typescript
 import {
     NotificationsApi,
-    Configuration,
-    NotificationFilters
+    Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new NotificationsApi(configuration);
 
-let filters: NotificationFilters; //Filter by filters (optional) (default to undefined)
+let read: boolean; //Filter by read (optional) (default to undefined)
+let source: AdminNotificationSource; //Filter by source (optional) (default to undefined)
+let type: AdminNotificationType; //Filter by type (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getNotificationCount(
-    filters
+    read,
+    source,
+    type
 );
 ```
 
@@ -37,7 +40,9 @@ const { status, data } = await apiInstance.getNotificationCount(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **filters** | **NotificationFilters** | Filter by filters | (optional) defaults to undefined|
+| **read** | [**boolean**] | Filter by read | (optional) defaults to undefined|
+| **source** | **AdminNotificationSource** | Filter by source | (optional) defaults to undefined|
+| **type** | **AdminNotificationType** | Filter by type | (optional) defaults to undefined|
 
 
 ### Return type
@@ -115,21 +120,24 @@ Returns a paginated list of notifications for the authenticated organization mem
 ```typescript
 import {
     NotificationsApi,
-    Configuration,
-    NotificationFilters
+    Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new NotificationsApi(configuration);
 
-let filters: NotificationFilters; //Filter by filters (optional) (default to undefined)
+let read: boolean; //Filter by read (optional) (default to undefined)
+let source: AdminNotificationSource; //Filter by source (optional) (default to undefined)
+let type: AdminNotificationType; //Filter by type (optional) (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.getNotifications(
-    filters,
+    read,
+    source,
+    type,
     page,
     pageSize,
     orderBy,
@@ -141,7 +149,9 @@ const { status, data } = await apiInstance.getNotifications(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **filters** | **NotificationFilters** | Filter by filters | (optional) defaults to undefined|
+| **read** | [**boolean**] | Filter by read | (optional) defaults to undefined|
+| **source** | **AdminNotificationSource** | Filter by source | (optional) defaults to undefined|
+| **type** | **AdminNotificationType** | Filter by type | (optional) 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|

package/docs/OrganizationApi.md

@@ -236,17 +236,26 @@ Performs a fuzzy, org-wide search using the given search term and optional filte
 ```typescript
 import {
     OrganizationApi,
-    Configuration,
-    SearchOrganizationFilters
+    Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new OrganizationApi(configuration);
 
-let filters: SearchOrganizationFilters; //Filter by filters (optional) (default to undefined)
+let accounts: boolean; //Filter by accounts (optional) (default to undefined)
+let events: boolean; //Filter by events (optional) (default to undefined)
+let groups: boolean; //Filter by groups (optional) (default to undefined)
+let channels: boolean; //Filter by channels (optional) (default to undefined)
+let contents: boolean; //Filter by contents (optional) (default to undefined)
+let threads: boolean; //Filter by threads (optional) (default to undefined)
 
 const { status, data } = await apiInstance.searchOrganization(
-    filters
+    accounts,
+    events,
+    groups,
+    channels,
+    contents,
+    threads
 );
 ```
 
@@ -254,7 +263,12 @@ const { status, data } = await apiInstance.searchOrganization(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **filters** | **SearchOrganizationFilters** | Filter by filters | (optional) defaults to undefined|
+| **accounts** | [**boolean**] | Filter by accounts | (optional) defaults to undefined|
+| **events** | [**boolean**] | Filter by events | (optional) defaults to undefined|
+| **groups** | [**boolean**] | Filter by groups | (optional) defaults to undefined|
+| **channels** | [**boolean**] | Filter by channels | (optional) defaults to undefined|
+| **contents** | [**boolean**] | Filter by contents | (optional) defaults to undefined|
+| **threads** | [**boolean**] | Filter by threads | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/ReportFilters.md

@@ -13,6 +13,9 @@ Name | Type | Description | Notes
 **surveyId** | **string** |  | [optional] [default to undefined]
 **sessionId** | **string** |  | [optional] [default to undefined]
 **seriesId** | **string** |  | [optional] [default to undefined]
+**spaceId** | **string** |  | [optional] [default to undefined]
+**entityId** | **string** |  | [optional] [default to undefined]
+**since** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -28,6 +31,9 @@ const instance: ReportFilters = {
     surveyId,
     sessionId,
     seriesId,
+    spaceId,
+    entityId,
+    since,
 };
 ```
 

package/docs/ReportsApi.md

@@ -340,21 +340,40 @@ Returns a paginated, searchable list of custom report configurations saved for t
 ```typescript
 import {
     ReportsApi,
-    Configuration,
-    ReportFilters
+    Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new ReportsApi(configuration);
 
-let filters: ReportFilters; //Filter by filters (optional) (default to undefined)
+let eventId: string; //Filter by eventId (optional) (default to undefined)
+let placeId: string; //Filter by placeId (optional) (default to undefined)
+let groupId: string; //Filter by groupId (optional) (default to undefined)
+let channelId: string; //Filter by channelId (optional) (default to undefined)
+let accountId: string; //Filter by accountId (optional) (default to undefined)
+let surveyId: string; //Filter by surveyId (optional) (default to undefined)
+let sessionId: string; //Filter by sessionId (optional) (default to undefined)
+let seriesId: string; //Filter by seriesId (optional) (default to undefined)
+let spaceId: string; //Filter by spaceId (optional) (default to undefined)
+let entityId: string; //Filter by entityId (optional) (default to undefined)
+let since: string; //Filter by since (optional) (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.getCustomReports(
-    filters,
+    eventId,
+    placeId,
+    groupId,
+    channelId,
+    accountId,
+    surveyId,
+    sessionId,
+    seriesId,
+    spaceId,
+    entityId,
+    since,
     page,
     pageSize,
     orderBy,
@@ -366,7 +385,17 @@ const { status, data } = await apiInstance.getCustomReports(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **filters** | **ReportFilters** | Filter by filters | (optional) defaults to undefined|
+| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
+| **placeId** | [**string**] | Filter by placeId | (optional) defaults to undefined|
+| **groupId** | [**string**] | Filter by groupId | (optional) defaults to undefined|
+| **channelId** | [**string**] | Filter by channelId | (optional) defaults to undefined|
+| **accountId** | [**string**] | Filter by accountId | (optional) defaults to undefined|
+| **surveyId** | [**string**] | Filter by surveyId | (optional) defaults to undefined|
+| **sessionId** | [**string**] | Filter by sessionId | (optional) defaults to undefined|
+| **seriesId** | [**string**] | Filter by seriesId | (optional) defaults to undefined|
+| **spaceId** | [**string**] | Filter by spaceId | (optional) defaults to undefined|
+| **entityId** | [**string**] | Filter by entityId | (optional) defaults to undefined|
+| **since** | [**string**] | Filter by since | (optional) 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|
@@ -404,19 +433,38 @@ Executes the named standard report definition with the given filters and automat
 ```typescript
 import {
     ReportsApi,
-    Configuration,
-    ReportFilters
+    Configuration
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new ReportsApi(configuration);
 
 let standard: string; //The standard identifier (default to undefined)
-let filters: ReportFilters; //Filter by filters (optional) (default to undefined)
+let eventId: string; //Filter by eventId (optional) (default to undefined)
+let placeId: string; //Filter by placeId (optional) (default to undefined)
+let groupId: string; //Filter by groupId (optional) (default to undefined)
+let channelId: string; //Filter by channelId (optional) (default to undefined)
+let accountId: string; //Filter by accountId (optional) (default to undefined)
+let surveyId: string; //Filter by surveyId (optional) (default to undefined)
+let sessionId: string; //Filter by sessionId (optional) (default to undefined)
+let seriesId: string; //Filter by seriesId (optional) (default to undefined)
+let spaceId: string; //Filter by spaceId (optional) (default to undefined)
+let entityId: string; //Filter by entityId (optional) (default to undefined)
+let since: string; //Filter by since (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getReport(
     standard,
-    filters
+    eventId,
+    placeId,
+    groupId,
+    channelId,
+    accountId,
+    surveyId,
+    sessionId,
+    seriesId,
+    spaceId,
+    entityId,
+    since
 );
 ```
 
@@ -425,7 +473,17 @@ const { status, data } = await apiInstance.getReport(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **standard** | [**string**] | The standard identifier | defaults to undefined|
-| **filters** | **ReportFilters** | Filter by filters | (optional) defaults to undefined|
+| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
+| **placeId** | [**string**] | Filter by placeId | (optional) defaults to undefined|
+| **groupId** | [**string**] | Filter by groupId | (optional) defaults to undefined|
+| **channelId** | [**string**] | Filter by channelId | (optional) defaults to undefined|
+| **accountId** | [**string**] | Filter by accountId | (optional) defaults to undefined|
+| **surveyId** | [**string**] | Filter by surveyId | (optional) defaults to undefined|
+| **sessionId** | [**string**] | Filter by sessionId | (optional) defaults to undefined|
+| **seriesId** | [**string**] | Filter by seriesId | (optional) defaults to undefined|
+| **spaceId** | [**string**] | Filter by spaceId | (optional) defaults to undefined|
+| **entityId** | [**string**] | Filter by entityId | (optional) defaults to undefined|
+| **since** | [**string**] | Filter by since | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/StandardReport.md

@@ -10,12 +10,12 @@ Name | Type | Description | Notes
 **category** | **string** |  | [default to undefined]
 **name** | **string** |  | [default to undefined]
 **description** | **string** |  | [default to undefined]
-**dateType** | [**EventReportDateType**](EventReportDateType.md) |  | [default to undefined]
+**dateType** | [**EventReportDateType**](EventReportDateType.md) |  | [optional] [default to undefined]
 **favorite** | **boolean** |  | [default to undefined]
 **rowLink** | **string** |  | [optional] [default to undefined]
 **rowData** | **Array<object>** |  | [default to undefined]
 **colDefs** | **Array<object>** |  | [default to undefined]
-**nextCursor** | **number** |  | [default to undefined]
+**nextCursor** | [**StandardReportAllOfNextCursor**](StandardReportAllOfNextCursor.md) |  | [default to undefined]
 
 ## Example
 

package/docs/StandardReportAllOfNextCursor.md

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

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "12.1.0",
+  "version": "12.3.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {