@connectedxm/admin-sdk 12.2.0 → 12.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -0
- package/README.md +2 -2
- package/api.ts +488 -95
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +272 -46
- package/dist/api.js +244 -78
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +272 -46
- package/dist/esm/api.js +244 -78
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/AnnouncementsApi.md +13 -5
- package/docs/AnnouncementsAudiencesApi.md +16 -5
- package/docs/BaseStandardReport.md +1 -1
- package/docs/CustomReportCreateInputs.md +6 -0
- package/docs/NotificationsApi.md +20 -10
- package/docs/OrganizationApi.md +19 -5
- package/docs/ReportFilters.md +6 -0
- package/docs/ReportsApi.md +68 -10
- package/docs/StandardReport.md +2 -2
- package/docs/StandardReportAllOfNextCursor.md +18 -0
- package/package.json +1 -1
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.3.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 12.
|
|
8
|
+
* The version of the OpenAPI document: 12.3.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.3.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 12.
|
|
8
|
+
* The version of the OpenAPI document: 12.3.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.3.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 12.
|
|
7
|
+
* The version of the OpenAPI document: 12.3.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 12.
|
|
5
|
+
* The version of the OpenAPI document: 12.3.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2700,7 +2700,7 @@ export interface BaseStandardReport {
|
|
|
2700
2700
|
'category': string;
|
|
2701
2701
|
'name': string;
|
|
2702
2702
|
'description': string;
|
|
2703
|
-
'dateType'
|
|
2703
|
+
'dateType'?: EventReportDateType;
|
|
2704
2704
|
'favorite': boolean;
|
|
2705
2705
|
'rowLink'?: string;
|
|
2706
2706
|
}
|
|
@@ -4752,6 +4752,9 @@ export interface CustomReportCreateInputs {
|
|
|
4752
4752
|
'surveyId'?: string;
|
|
4753
4753
|
'sessionId'?: string;
|
|
4754
4754
|
'seriesId'?: string;
|
|
4755
|
+
'spaceId'?: string;
|
|
4756
|
+
'entityId'?: string;
|
|
4757
|
+
'since'?: string;
|
|
4755
4758
|
'name': string;
|
|
4756
4759
|
'description'?: string | null;
|
|
4757
4760
|
'gridState'?: string | null;
|
|
@@ -12336,6 +12339,9 @@ export interface ReportFilters {
|
|
|
12336
12339
|
'surveyId'?: string;
|
|
12337
12340
|
'sessionId'?: string;
|
|
12338
12341
|
'seriesId'?: string;
|
|
12342
|
+
'spaceId'?: string;
|
|
12343
|
+
'entityId'?: string;
|
|
12344
|
+
'since'?: string;
|
|
12339
12345
|
}
|
|
12340
12346
|
export declare enum ReportType {
|
|
12341
12347
|
Organization = "organization",
|
|
@@ -12957,13 +12963,17 @@ export interface StandardReport {
|
|
|
12957
12963
|
'category': string;
|
|
12958
12964
|
'name': string;
|
|
12959
12965
|
'description': string;
|
|
12960
|
-
'dateType'
|
|
12966
|
+
'dateType'?: EventReportDateType;
|
|
12961
12967
|
'favorite': boolean;
|
|
12962
12968
|
'rowLink'?: string;
|
|
12963
12969
|
'rowData': Array<object>;
|
|
12964
12970
|
'colDefs': Array<object>;
|
|
12965
|
-
'nextCursor':
|
|
12971
|
+
'nextCursor': StandardReportAllOfNextCursor | null;
|
|
12966
12972
|
}
|
|
12973
|
+
/**
|
|
12974
|
+
* @type StandardReportAllOfNextCursor
|
|
12975
|
+
*/
|
|
12976
|
+
export type StandardReportAllOfNextCursor = number | string;
|
|
12967
12977
|
export interface StartEventRoundMatchmakingRequest {
|
|
12968
12978
|
'targetMatchSize': number;
|
|
12969
12979
|
}
|
|
@@ -18516,7 +18526,10 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
|
|
|
18516
18526
|
/**
|
|
18517
18527
|
* Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
|
|
18518
18528
|
* @summary List announcements
|
|
18519
|
-
* @param {
|
|
18529
|
+
* @param {string} [eventId] Filter by eventId
|
|
18530
|
+
* @param {string} [groupId] Filter by groupId
|
|
18531
|
+
* @param {string} [audienceId] Filter by audienceId
|
|
18532
|
+
* @param {boolean} [community] Filter by community
|
|
18520
18533
|
* @param {number} [page] Page number
|
|
18521
18534
|
* @param {number} [pageSize] Number of items per page
|
|
18522
18535
|
* @param {string} [orderBy] Field to order by
|
|
@@ -18524,7 +18537,7 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
|
|
|
18524
18537
|
* @param {*} [options] Override http request option.
|
|
18525
18538
|
* @throws {RequiredError}
|
|
18526
18539
|
*/
|
|
18527
|
-
getAnnouncements: (
|
|
18540
|
+
getAnnouncements: (eventId?: string, groupId?: string, audienceId?: string, community?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18528
18541
|
/**
|
|
18529
18542
|
* Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
|
|
18530
18543
|
* @summary Send a preview of an announcement
|
|
@@ -18607,7 +18620,10 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
|
|
|
18607
18620
|
/**
|
|
18608
18621
|
* Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
|
|
18609
18622
|
* @summary List announcements
|
|
18610
|
-
* @param {
|
|
18623
|
+
* @param {string} [eventId] Filter by eventId
|
|
18624
|
+
* @param {string} [groupId] Filter by groupId
|
|
18625
|
+
* @param {string} [audienceId] Filter by audienceId
|
|
18626
|
+
* @param {boolean} [community] Filter by community
|
|
18611
18627
|
* @param {number} [page] Page number
|
|
18612
18628
|
* @param {number} [pageSize] Number of items per page
|
|
18613
18629
|
* @param {string} [orderBy] Field to order by
|
|
@@ -18615,7 +18631,7 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
|
|
|
18615
18631
|
* @param {*} [options] Override http request option.
|
|
18616
18632
|
* @throws {RequiredError}
|
|
18617
18633
|
*/
|
|
18618
|
-
getAnnouncements(
|
|
18634
|
+
getAnnouncements(eventId?: string, groupId?: string, audienceId?: string, community?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncements200Response>>;
|
|
18619
18635
|
/**
|
|
18620
18636
|
* Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
|
|
18621
18637
|
* @summary Send a preview of an announcement
|
|
@@ -18794,9 +18810,21 @@ export interface AnnouncementsApiGetAnnouncementRecipientsRequest {
|
|
|
18794
18810
|
*/
|
|
18795
18811
|
export interface AnnouncementsApiGetAnnouncementsRequest {
|
|
18796
18812
|
/**
|
|
18797
|
-
* Filter by
|
|
18813
|
+
* Filter by eventId
|
|
18814
|
+
*/
|
|
18815
|
+
readonly eventId?: string;
|
|
18816
|
+
/**
|
|
18817
|
+
* Filter by groupId
|
|
18818
|
+
*/
|
|
18819
|
+
readonly groupId?: string;
|
|
18820
|
+
/**
|
|
18821
|
+
* Filter by audienceId
|
|
18798
18822
|
*/
|
|
18799
|
-
readonly
|
|
18823
|
+
readonly audienceId?: string;
|
|
18824
|
+
/**
|
|
18825
|
+
* Filter by community
|
|
18826
|
+
*/
|
|
18827
|
+
readonly community?: boolean;
|
|
18800
18828
|
/**
|
|
18801
18829
|
* Page number
|
|
18802
18830
|
*/
|
|
@@ -18991,7 +19019,11 @@ export declare const AnnouncementsAudiencesApiAxiosParamCreator: (configuration?
|
|
|
18991
19019
|
/**
|
|
18992
19020
|
* 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.
|
|
18993
19021
|
* @summary List announcement audiences
|
|
18994
|
-
* @param {
|
|
19022
|
+
* @param {string} [eventId] Filter by eventId
|
|
19023
|
+
* @param {string} [groupId] Filter by groupId
|
|
19024
|
+
* @param {string} [channelId] Filter by channelId
|
|
19025
|
+
* @param {boolean} [archived] Filter by archived
|
|
19026
|
+
* @param {boolean} [featured] Filter by featured
|
|
18995
19027
|
* @param {number} [page] Page number
|
|
18996
19028
|
* @param {number} [pageSize] Number of items per page
|
|
18997
19029
|
* @param {string} [orderBy] Field to order by
|
|
@@ -18999,7 +19031,7 @@ export declare const AnnouncementsAudiencesApiAxiosParamCreator: (configuration?
|
|
|
18999
19031
|
* @param {*} [options] Override http request option.
|
|
19000
19032
|
* @throws {RequiredError}
|
|
19001
19033
|
*/
|
|
19002
|
-
getAnnouncementAudiences: (
|
|
19034
|
+
getAnnouncementAudiences: (eventId?: string, groupId?: string, channelId?: string, archived?: boolean, featured?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19003
19035
|
/**
|
|
19004
19036
|
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
19005
19037
|
* @summary Update an announcement audience
|
|
@@ -19112,7 +19144,11 @@ export declare const AnnouncementsAudiencesApiFp: (configuration?: Configuration
|
|
|
19112
19144
|
/**
|
|
19113
19145
|
* 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.
|
|
19114
19146
|
* @summary List announcement audiences
|
|
19115
|
-
* @param {
|
|
19147
|
+
* @param {string} [eventId] Filter by eventId
|
|
19148
|
+
* @param {string} [groupId] Filter by groupId
|
|
19149
|
+
* @param {string} [channelId] Filter by channelId
|
|
19150
|
+
* @param {boolean} [archived] Filter by archived
|
|
19151
|
+
* @param {boolean} [featured] Filter by featured
|
|
19116
19152
|
* @param {number} [page] Page number
|
|
19117
19153
|
* @param {number} [pageSize] Number of items per page
|
|
19118
19154
|
* @param {string} [orderBy] Field to order by
|
|
@@ -19120,7 +19156,7 @@ export declare const AnnouncementsAudiencesApiFp: (configuration?: Configuration
|
|
|
19120
19156
|
* @param {*} [options] Override http request option.
|
|
19121
19157
|
* @throws {RequiredError}
|
|
19122
19158
|
*/
|
|
19123
|
-
getAnnouncementAudiences(
|
|
19159
|
+
getAnnouncementAudiences(eventId?: string, groupId?: string, channelId?: string, archived?: boolean, featured?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudiences200Response>>;
|
|
19124
19160
|
/**
|
|
19125
19161
|
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
19126
19162
|
* @summary Update an announcement audience
|
|
@@ -19361,9 +19397,25 @@ export interface AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest
|
|
|
19361
19397
|
*/
|
|
19362
19398
|
export interface AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest {
|
|
19363
19399
|
/**
|
|
19364
|
-
* Filter by
|
|
19400
|
+
* Filter by eventId
|
|
19401
|
+
*/
|
|
19402
|
+
readonly eventId?: string;
|
|
19403
|
+
/**
|
|
19404
|
+
* Filter by groupId
|
|
19405
|
+
*/
|
|
19406
|
+
readonly groupId?: string;
|
|
19407
|
+
/**
|
|
19408
|
+
* Filter by channelId
|
|
19365
19409
|
*/
|
|
19366
|
-
readonly
|
|
19410
|
+
readonly channelId?: string;
|
|
19411
|
+
/**
|
|
19412
|
+
* Filter by archived
|
|
19413
|
+
*/
|
|
19414
|
+
readonly archived?: boolean;
|
|
19415
|
+
/**
|
|
19416
|
+
* Filter by featured
|
|
19417
|
+
*/
|
|
19418
|
+
readonly featured?: boolean;
|
|
19367
19419
|
/**
|
|
19368
19420
|
* Page number
|
|
19369
19421
|
*/
|
|
@@ -69433,11 +69485,13 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
69433
69485
|
/**
|
|
69434
69486
|
* Returns the number of notifications for the current organization member, optionally filtered by read/unread status, source, or notification type, no special permission is required beyond authentication since results are scoped to the caller.
|
|
69435
69487
|
* @summary Count the caller\'s notifications
|
|
69436
|
-
* @param {
|
|
69488
|
+
* @param {boolean} [read] Filter by read
|
|
69489
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
69490
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
69437
69491
|
* @param {*} [options] Override http request option.
|
|
69438
69492
|
* @throws {RequiredError}
|
|
69439
69493
|
*/
|
|
69440
|
-
getNotificationCount: (
|
|
69494
|
+
getNotificationCount: (read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69441
69495
|
/**
|
|
69442
69496
|
* Returns aggregate notification statistics for the authenticated organization member, including total and unread counts broken down by notification type and source; available to any authenticated organization member for their own notifications.
|
|
69443
69497
|
* @summary Get notification statistics
|
|
@@ -69448,7 +69502,9 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
69448
69502
|
/**
|
|
69449
69503
|
* Returns a paginated list of notifications for the authenticated organization member, filterable by read status, source, type, and search term; available to any authenticated organization member for their own notifications.
|
|
69450
69504
|
* @summary List the current member\'s notifications
|
|
69451
|
-
* @param {
|
|
69505
|
+
* @param {boolean} [read] Filter by read
|
|
69506
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
69507
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
69452
69508
|
* @param {number} [page] Page number
|
|
69453
69509
|
* @param {number} [pageSize] Number of items per page
|
|
69454
69510
|
* @param {string} [orderBy] Field to order by
|
|
@@ -69456,7 +69512,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
69456
69512
|
* @param {*} [options] Override http request option.
|
|
69457
69513
|
* @throws {RequiredError}
|
|
69458
69514
|
*/
|
|
69459
|
-
getNotifications: (
|
|
69515
|
+
getNotifications: (read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69460
69516
|
/**
|
|
69461
69517
|
* Marks the given list of notification IDs as read for the current organization member and returns the count of notifications updated.
|
|
69462
69518
|
* @summary Mark notifications as read
|
|
@@ -69473,11 +69529,13 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
69473
69529
|
/**
|
|
69474
69530
|
* Returns the number of notifications for the current organization member, optionally filtered by read/unread status, source, or notification type, no special permission is required beyond authentication since results are scoped to the caller.
|
|
69475
69531
|
* @summary Count the caller\'s notifications
|
|
69476
|
-
* @param {
|
|
69532
|
+
* @param {boolean} [read] Filter by read
|
|
69533
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
69534
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
69477
69535
|
* @param {*} [options] Override http request option.
|
|
69478
69536
|
* @throws {RequiredError}
|
|
69479
69537
|
*/
|
|
69480
|
-
getNotificationCount(
|
|
69538
|
+
getNotificationCount(read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncAccounts200Response>>;
|
|
69481
69539
|
/**
|
|
69482
69540
|
* Returns aggregate notification statistics for the authenticated organization member, including total and unread counts broken down by notification type and source; available to any authenticated organization member for their own notifications.
|
|
69483
69541
|
* @summary Get notification statistics
|
|
@@ -69488,7 +69546,9 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
69488
69546
|
/**
|
|
69489
69547
|
* Returns a paginated list of notifications for the authenticated organization member, filterable by read status, source, type, and search term; available to any authenticated organization member for their own notifications.
|
|
69490
69548
|
* @summary List the current member\'s notifications
|
|
69491
|
-
* @param {
|
|
69549
|
+
* @param {boolean} [read] Filter by read
|
|
69550
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
69551
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
69492
69552
|
* @param {number} [page] Page number
|
|
69493
69553
|
* @param {number} [pageSize] Number of items per page
|
|
69494
69554
|
* @param {string} [orderBy] Field to order by
|
|
@@ -69496,7 +69556,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
69496
69556
|
* @param {*} [options] Override http request option.
|
|
69497
69557
|
* @throws {RequiredError}
|
|
69498
69558
|
*/
|
|
69499
|
-
getNotifications(
|
|
69559
|
+
getNotifications(read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotifications200Response>>;
|
|
69500
69560
|
/**
|
|
69501
69561
|
* Marks the given list of notification IDs as read for the current organization member and returns the count of notifications updated.
|
|
69502
69562
|
* @summary Mark notifications as read
|
|
@@ -69547,18 +69607,34 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
69547
69607
|
*/
|
|
69548
69608
|
export interface NotificationsApiGetNotificationCountRequest {
|
|
69549
69609
|
/**
|
|
69550
|
-
* Filter by
|
|
69610
|
+
* Filter by read
|
|
69611
|
+
*/
|
|
69612
|
+
readonly read?: boolean;
|
|
69613
|
+
/**
|
|
69614
|
+
* Filter by source
|
|
69615
|
+
*/
|
|
69616
|
+
readonly source?: AdminNotificationSource;
|
|
69617
|
+
/**
|
|
69618
|
+
* Filter by type
|
|
69551
69619
|
*/
|
|
69552
|
-
readonly
|
|
69620
|
+
readonly type?: AdminNotificationType;
|
|
69553
69621
|
}
|
|
69554
69622
|
/**
|
|
69555
69623
|
* Request parameters for getNotifications operation in NotificationsApi.
|
|
69556
69624
|
*/
|
|
69557
69625
|
export interface NotificationsApiGetNotificationsRequest {
|
|
69558
69626
|
/**
|
|
69559
|
-
* Filter by
|
|
69627
|
+
* Filter by read
|
|
69560
69628
|
*/
|
|
69561
|
-
readonly
|
|
69629
|
+
readonly read?: boolean;
|
|
69630
|
+
/**
|
|
69631
|
+
* Filter by source
|
|
69632
|
+
*/
|
|
69633
|
+
readonly source?: AdminNotificationSource;
|
|
69634
|
+
/**
|
|
69635
|
+
* Filter by type
|
|
69636
|
+
*/
|
|
69637
|
+
readonly type?: AdminNotificationType;
|
|
69562
69638
|
/**
|
|
69563
69639
|
* Page number
|
|
69564
69640
|
*/
|
|
@@ -69661,11 +69737,16 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
69661
69737
|
/**
|
|
69662
69738
|
* Performs a fuzzy, org-wide search using the given search term and optional filters, returning matching records (e.g. accounts, events) as search fields; available to any authenticated user of the organization.
|
|
69663
69739
|
* @summary Search across the organization
|
|
69664
|
-
* @param {
|
|
69740
|
+
* @param {boolean} [accounts] Filter by accounts
|
|
69741
|
+
* @param {boolean} [events] Filter by events
|
|
69742
|
+
* @param {boolean} [groups] Filter by groups
|
|
69743
|
+
* @param {boolean} [channels] Filter by channels
|
|
69744
|
+
* @param {boolean} [contents] Filter by contents
|
|
69745
|
+
* @param {boolean} [threads] Filter by threads
|
|
69665
69746
|
* @param {*} [options] Override http request option.
|
|
69666
69747
|
* @throws {RequiredError}
|
|
69667
69748
|
*/
|
|
69668
|
-
searchOrganization: (
|
|
69749
|
+
searchOrganization: (accounts?: boolean, events?: boolean, groups?: boolean, channels?: boolean, contents?: boolean, threads?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69669
69750
|
/**
|
|
69670
69751
|
* Updates the current organization\'s core profile fields (such as name, contact details, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
69671
69752
|
* @summary Update the organization\'s profile
|
|
@@ -69743,11 +69824,16 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
69743
69824
|
/**
|
|
69744
69825
|
* Performs a fuzzy, org-wide search using the given search term and optional filters, returning matching records (e.g. accounts, events) as search fields; available to any authenticated user of the organization.
|
|
69745
69826
|
* @summary Search across the organization
|
|
69746
|
-
* @param {
|
|
69827
|
+
* @param {boolean} [accounts] Filter by accounts
|
|
69828
|
+
* @param {boolean} [events] Filter by events
|
|
69829
|
+
* @param {boolean} [groups] Filter by groups
|
|
69830
|
+
* @param {boolean} [channels] Filter by channels
|
|
69831
|
+
* @param {boolean} [contents] Filter by contents
|
|
69832
|
+
* @param {boolean} [threads] Filter by threads
|
|
69747
69833
|
* @param {*} [options] Override http request option.
|
|
69748
69834
|
* @throws {RequiredError}
|
|
69749
69835
|
*/
|
|
69750
|
-
searchOrganization(
|
|
69836
|
+
searchOrganization(accounts?: boolean, events?: boolean, groups?: boolean, channels?: boolean, contents?: boolean, threads?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchOrganization200Response>>;
|
|
69751
69837
|
/**
|
|
69752
69838
|
* Updates the current organization\'s core profile fields (such as name, contact details, and locales) and returns the updated organization record; requires update permission on the organization.
|
|
69753
69839
|
* @summary Update the organization\'s profile
|
|
@@ -69910,9 +69996,29 @@ export interface OrganizationApiGetOrganizationSystemLogsRequest {
|
|
|
69910
69996
|
*/
|
|
69911
69997
|
export interface OrganizationApiSearchOrganizationRequest {
|
|
69912
69998
|
/**
|
|
69913
|
-
* Filter by
|
|
69999
|
+
* Filter by accounts
|
|
70000
|
+
*/
|
|
70001
|
+
readonly accounts?: boolean;
|
|
70002
|
+
/**
|
|
70003
|
+
* Filter by events
|
|
69914
70004
|
*/
|
|
69915
|
-
readonly
|
|
70005
|
+
readonly events?: boolean;
|
|
70006
|
+
/**
|
|
70007
|
+
* Filter by groups
|
|
70008
|
+
*/
|
|
70009
|
+
readonly groups?: boolean;
|
|
70010
|
+
/**
|
|
70011
|
+
* Filter by channels
|
|
70012
|
+
*/
|
|
70013
|
+
readonly channels?: boolean;
|
|
70014
|
+
/**
|
|
70015
|
+
* Filter by contents
|
|
70016
|
+
*/
|
|
70017
|
+
readonly contents?: boolean;
|
|
70018
|
+
/**
|
|
70019
|
+
* Filter by threads
|
|
70020
|
+
*/
|
|
70021
|
+
readonly threads?: boolean;
|
|
69916
70022
|
}
|
|
69917
70023
|
/**
|
|
69918
70024
|
* Request parameters for updateOrganization operation in OrganizationApi.
|
|
@@ -75080,7 +75186,17 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
75080
75186
|
/**
|
|
75081
75187
|
* Returns a paginated, searchable list of custom report configurations saved for the current organization, matching on report name and supporting additional filters and sorting via orderBy; requires read permission on the reports resource.
|
|
75082
75188
|
* @summary List an organization\'s custom reports
|
|
75083
|
-
* @param {
|
|
75189
|
+
* @param {string} [eventId] Filter by eventId
|
|
75190
|
+
* @param {string} [placeId] Filter by placeId
|
|
75191
|
+
* @param {string} [groupId] Filter by groupId
|
|
75192
|
+
* @param {string} [channelId] Filter by channelId
|
|
75193
|
+
* @param {string} [accountId] Filter by accountId
|
|
75194
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
75195
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
75196
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
75197
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
75198
|
+
* @param {string} [entityId] Filter by entityId
|
|
75199
|
+
* @param {string} [since] Filter by since
|
|
75084
75200
|
* @param {number} [page] Page number
|
|
75085
75201
|
* @param {number} [pageSize] Number of items per page
|
|
75086
75202
|
* @param {string} [orderBy] Field to order by
|
|
@@ -75088,16 +75204,26 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
75088
75204
|
* @param {*} [options] Override http request option.
|
|
75089
75205
|
* @throws {RequiredError}
|
|
75090
75206
|
*/
|
|
75091
|
-
getCustomReports: (
|
|
75207
|
+
getCustomReports: (eventId?: string, placeId?: string, groupId?: string, channelId?: string, accountId?: string, surveyId?: string, sessionId?: string, seriesId?: string, spaceId?: string, entityId?: string, since?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75092
75208
|
/**
|
|
75093
75209
|
* Executes the named standard report definition with the given filters and automatically pages through cursor-based results to return the complete row set; access is restricted to the domain permissions declared by that specific standard report, in addition to read permission on the reports resource.
|
|
75094
75210
|
* @summary Run a standard report and fetch all its rows
|
|
75095
75211
|
* @param {string} standard The standard identifier
|
|
75096
|
-
* @param {
|
|
75212
|
+
* @param {string} [eventId] Filter by eventId
|
|
75213
|
+
* @param {string} [placeId] Filter by placeId
|
|
75214
|
+
* @param {string} [groupId] Filter by groupId
|
|
75215
|
+
* @param {string} [channelId] Filter by channelId
|
|
75216
|
+
* @param {string} [accountId] Filter by accountId
|
|
75217
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
75218
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
75219
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
75220
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
75221
|
+
* @param {string} [entityId] Filter by entityId
|
|
75222
|
+
* @param {string} [since] Filter by since
|
|
75097
75223
|
* @param {*} [options] Override http request option.
|
|
75098
75224
|
* @throws {RequiredError}
|
|
75099
75225
|
*/
|
|
75100
|
-
getReport: (standard: string,
|
|
75226
|
+
getReport: (standard: string, eventId?: string, placeId?: string, groupId?: string, channelId?: string, accountId?: string, surveyId?: string, sessionId?: string, seriesId?: string, spaceId?: string, entityId?: string, since?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75101
75227
|
/**
|
|
75102
75228
|
* Returns the list of standard reports available to the organization, filtered by report type and further filtered to only those reports whose required permission domains the caller can read; requires the `read:reports` permission.
|
|
75103
75229
|
* @summary List available standard reports
|
|
@@ -75182,7 +75308,17 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
75182
75308
|
/**
|
|
75183
75309
|
* Returns a paginated, searchable list of custom report configurations saved for the current organization, matching on report name and supporting additional filters and sorting via orderBy; requires read permission on the reports resource.
|
|
75184
75310
|
* @summary List an organization\'s custom reports
|
|
75185
|
-
* @param {
|
|
75311
|
+
* @param {string} [eventId] Filter by eventId
|
|
75312
|
+
* @param {string} [placeId] Filter by placeId
|
|
75313
|
+
* @param {string} [groupId] Filter by groupId
|
|
75314
|
+
* @param {string} [channelId] Filter by channelId
|
|
75315
|
+
* @param {string} [accountId] Filter by accountId
|
|
75316
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
75317
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
75318
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
75319
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
75320
|
+
* @param {string} [entityId] Filter by entityId
|
|
75321
|
+
* @param {string} [since] Filter by since
|
|
75186
75322
|
* @param {number} [page] Page number
|
|
75187
75323
|
* @param {number} [pageSize] Number of items per page
|
|
75188
75324
|
* @param {string} [orderBy] Field to order by
|
|
@@ -75190,16 +75326,26 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
75190
75326
|
* @param {*} [options] Override http request option.
|
|
75191
75327
|
* @throws {RequiredError}
|
|
75192
75328
|
*/
|
|
75193
|
-
getCustomReports(
|
|
75329
|
+
getCustomReports(eventId?: string, placeId?: string, groupId?: string, channelId?: string, accountId?: string, surveyId?: string, sessionId?: string, seriesId?: string, spaceId?: string, entityId?: string, since?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomReports200Response>>;
|
|
75194
75330
|
/**
|
|
75195
75331
|
* Executes the named standard report definition with the given filters and automatically pages through cursor-based results to return the complete row set; access is restricted to the domain permissions declared by that specific standard report, in addition to read permission on the reports resource.
|
|
75196
75332
|
* @summary Run a standard report and fetch all its rows
|
|
75197
75333
|
* @param {string} standard The standard identifier
|
|
75198
|
-
* @param {
|
|
75334
|
+
* @param {string} [eventId] Filter by eventId
|
|
75335
|
+
* @param {string} [placeId] Filter by placeId
|
|
75336
|
+
* @param {string} [groupId] Filter by groupId
|
|
75337
|
+
* @param {string} [channelId] Filter by channelId
|
|
75338
|
+
* @param {string} [accountId] Filter by accountId
|
|
75339
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
75340
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
75341
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
75342
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
75343
|
+
* @param {string} [entityId] Filter by entityId
|
|
75344
|
+
* @param {string} [since] Filter by since
|
|
75199
75345
|
* @param {*} [options] Override http request option.
|
|
75200
75346
|
* @throws {RequiredError}
|
|
75201
75347
|
*/
|
|
75202
|
-
getReport(standard: string,
|
|
75348
|
+
getReport(standard: string, eventId?: string, placeId?: string, groupId?: string, channelId?: string, accountId?: string, surveyId?: string, sessionId?: string, seriesId?: string, spaceId?: string, entityId?: string, since?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReport200Response>>;
|
|
75203
75349
|
/**
|
|
75204
75350
|
* Returns the list of standard reports available to the organization, filtered by report type and further filtered to only those reports whose required permission domains the caller can read; requires the `read:reports` permission.
|
|
75205
75351
|
* @summary List available standard reports
|
|
@@ -75381,9 +75527,49 @@ export interface ReportsApiGetCustomReportScheduleRequest {
|
|
|
75381
75527
|
*/
|
|
75382
75528
|
export interface ReportsApiGetCustomReportsRequest {
|
|
75383
75529
|
/**
|
|
75384
|
-
* Filter by
|
|
75530
|
+
* Filter by eventId
|
|
75531
|
+
*/
|
|
75532
|
+
readonly eventId?: string;
|
|
75533
|
+
/**
|
|
75534
|
+
* Filter by placeId
|
|
75535
|
+
*/
|
|
75536
|
+
readonly placeId?: string;
|
|
75537
|
+
/**
|
|
75538
|
+
* Filter by groupId
|
|
75539
|
+
*/
|
|
75540
|
+
readonly groupId?: string;
|
|
75541
|
+
/**
|
|
75542
|
+
* Filter by channelId
|
|
75543
|
+
*/
|
|
75544
|
+
readonly channelId?: string;
|
|
75545
|
+
/**
|
|
75546
|
+
* Filter by accountId
|
|
75547
|
+
*/
|
|
75548
|
+
readonly accountId?: string;
|
|
75549
|
+
/**
|
|
75550
|
+
* Filter by surveyId
|
|
75385
75551
|
*/
|
|
75386
|
-
readonly
|
|
75552
|
+
readonly surveyId?: string;
|
|
75553
|
+
/**
|
|
75554
|
+
* Filter by sessionId
|
|
75555
|
+
*/
|
|
75556
|
+
readonly sessionId?: string;
|
|
75557
|
+
/**
|
|
75558
|
+
* Filter by seriesId
|
|
75559
|
+
*/
|
|
75560
|
+
readonly seriesId?: string;
|
|
75561
|
+
/**
|
|
75562
|
+
* Filter by spaceId
|
|
75563
|
+
*/
|
|
75564
|
+
readonly spaceId?: string;
|
|
75565
|
+
/**
|
|
75566
|
+
* Filter by entityId
|
|
75567
|
+
*/
|
|
75568
|
+
readonly entityId?: string;
|
|
75569
|
+
/**
|
|
75570
|
+
* Filter by since
|
|
75571
|
+
*/
|
|
75572
|
+
readonly since?: string;
|
|
75387
75573
|
/**
|
|
75388
75574
|
* Page number
|
|
75389
75575
|
*/
|
|
@@ -75410,9 +75596,49 @@ export interface ReportsApiGetReportRequest {
|
|
|
75410
75596
|
*/
|
|
75411
75597
|
readonly standard: string;
|
|
75412
75598
|
/**
|
|
75413
|
-
* Filter by
|
|
75599
|
+
* Filter by eventId
|
|
75600
|
+
*/
|
|
75601
|
+
readonly eventId?: string;
|
|
75602
|
+
/**
|
|
75603
|
+
* Filter by placeId
|
|
75604
|
+
*/
|
|
75605
|
+
readonly placeId?: string;
|
|
75606
|
+
/**
|
|
75607
|
+
* Filter by groupId
|
|
75608
|
+
*/
|
|
75609
|
+
readonly groupId?: string;
|
|
75610
|
+
/**
|
|
75611
|
+
* Filter by channelId
|
|
75612
|
+
*/
|
|
75613
|
+
readonly channelId?: string;
|
|
75614
|
+
/**
|
|
75615
|
+
* Filter by accountId
|
|
75616
|
+
*/
|
|
75617
|
+
readonly accountId?: string;
|
|
75618
|
+
/**
|
|
75619
|
+
* Filter by surveyId
|
|
75620
|
+
*/
|
|
75621
|
+
readonly surveyId?: string;
|
|
75622
|
+
/**
|
|
75623
|
+
* Filter by sessionId
|
|
75624
|
+
*/
|
|
75625
|
+
readonly sessionId?: string;
|
|
75626
|
+
/**
|
|
75627
|
+
* Filter by seriesId
|
|
75628
|
+
*/
|
|
75629
|
+
readonly seriesId?: string;
|
|
75630
|
+
/**
|
|
75631
|
+
* Filter by spaceId
|
|
75632
|
+
*/
|
|
75633
|
+
readonly spaceId?: string;
|
|
75634
|
+
/**
|
|
75635
|
+
* Filter by entityId
|
|
75636
|
+
*/
|
|
75637
|
+
readonly entityId?: string;
|
|
75638
|
+
/**
|
|
75639
|
+
* Filter by since
|
|
75414
75640
|
*/
|
|
75415
|
-
readonly
|
|
75641
|
+
readonly since?: string;
|
|
75416
75642
|
}
|
|
75417
75643
|
/**
|
|
75418
75644
|
* Request parameters for getReports operation in ReportsApi.
|