@connectedxm/admin-sdk 12.1.0 → 12.3.0
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 +493 -99
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +277 -50
- package/dist/api.js +248 -82
- 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 +277 -50
- package/dist/esm/api.js +248 -82
- 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/AnnouncementAudienceScope.md +2 -0
- package/docs/AnnouncementsApi.md +13 -5
- package/docs/AnnouncementsAudiencesApi.md +17 -6
- 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/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.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -872,6 +872,7 @@ export interface AnnouncementAudienceScope {
|
|
|
872
872
|
'groupId'?: string;
|
|
873
873
|
'channelId'?: string;
|
|
874
874
|
'archived'?: boolean;
|
|
875
|
+
'featured'?: boolean;
|
|
875
876
|
}
|
|
876
877
|
export interface AnnouncementAudienceUpdateInputs {
|
|
877
878
|
'name'?: string;
|
|
@@ -2699,7 +2700,7 @@ export interface BaseStandardReport {
|
|
|
2699
2700
|
'category': string;
|
|
2700
2701
|
'name': string;
|
|
2701
2702
|
'description': string;
|
|
2702
|
-
'dateType'
|
|
2703
|
+
'dateType'?: EventReportDateType;
|
|
2703
2704
|
'favorite': boolean;
|
|
2704
2705
|
'rowLink'?: string;
|
|
2705
2706
|
}
|
|
@@ -4751,6 +4752,9 @@ export interface CustomReportCreateInputs {
|
|
|
4751
4752
|
'surveyId'?: string;
|
|
4752
4753
|
'sessionId'?: string;
|
|
4753
4754
|
'seriesId'?: string;
|
|
4755
|
+
'spaceId'?: string;
|
|
4756
|
+
'entityId'?: string;
|
|
4757
|
+
'since'?: string;
|
|
4754
4758
|
'name': string;
|
|
4755
4759
|
'description'?: string | null;
|
|
4756
4760
|
'gridState'?: string | null;
|
|
@@ -12335,6 +12339,9 @@ export interface ReportFilters {
|
|
|
12335
12339
|
'surveyId'?: string;
|
|
12336
12340
|
'sessionId'?: string;
|
|
12337
12341
|
'seriesId'?: string;
|
|
12342
|
+
'spaceId'?: string;
|
|
12343
|
+
'entityId'?: string;
|
|
12344
|
+
'since'?: string;
|
|
12338
12345
|
}
|
|
12339
12346
|
export declare enum ReportType {
|
|
12340
12347
|
Organization = "organization",
|
|
@@ -12956,13 +12963,17 @@ export interface StandardReport {
|
|
|
12956
12963
|
'category': string;
|
|
12957
12964
|
'name': string;
|
|
12958
12965
|
'description': string;
|
|
12959
|
-
'dateType'
|
|
12966
|
+
'dateType'?: EventReportDateType;
|
|
12960
12967
|
'favorite': boolean;
|
|
12961
12968
|
'rowLink'?: string;
|
|
12962
12969
|
'rowData': Array<object>;
|
|
12963
12970
|
'colDefs': Array<object>;
|
|
12964
|
-
'nextCursor':
|
|
12971
|
+
'nextCursor': StandardReportAllOfNextCursor | null;
|
|
12965
12972
|
}
|
|
12973
|
+
/**
|
|
12974
|
+
* @type StandardReportAllOfNextCursor
|
|
12975
|
+
*/
|
|
12976
|
+
export type StandardReportAllOfNextCursor = number | string;
|
|
12966
12977
|
export interface StartEventRoundMatchmakingRequest {
|
|
12967
12978
|
'targetMatchSize': number;
|
|
12968
12979
|
}
|
|
@@ -18515,7 +18526,10 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
|
|
|
18515
18526
|
/**
|
|
18516
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.
|
|
18517
18528
|
* @summary List announcements
|
|
18518
|
-
* @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
|
|
18519
18533
|
* @param {number} [page] Page number
|
|
18520
18534
|
* @param {number} [pageSize] Number of items per page
|
|
18521
18535
|
* @param {string} [orderBy] Field to order by
|
|
@@ -18523,7 +18537,7 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
|
|
|
18523
18537
|
* @param {*} [options] Override http request option.
|
|
18524
18538
|
* @throws {RequiredError}
|
|
18525
18539
|
*/
|
|
18526
|
-
getAnnouncements: (
|
|
18540
|
+
getAnnouncements: (eventId?: string, groupId?: string, audienceId?: string, community?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18527
18541
|
/**
|
|
18528
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.
|
|
18529
18543
|
* @summary Send a preview of an announcement
|
|
@@ -18606,7 +18620,10 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
|
|
|
18606
18620
|
/**
|
|
18607
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.
|
|
18608
18622
|
* @summary List announcements
|
|
18609
|
-
* @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
|
|
18610
18627
|
* @param {number} [page] Page number
|
|
18611
18628
|
* @param {number} [pageSize] Number of items per page
|
|
18612
18629
|
* @param {string} [orderBy] Field to order by
|
|
@@ -18614,7 +18631,7 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
|
|
|
18614
18631
|
* @param {*} [options] Override http request option.
|
|
18615
18632
|
* @throws {RequiredError}
|
|
18616
18633
|
*/
|
|
18617
|
-
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>>;
|
|
18618
18635
|
/**
|
|
18619
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.
|
|
18620
18637
|
* @summary Send a preview of an announcement
|
|
@@ -18793,9 +18810,21 @@ export interface AnnouncementsApiGetAnnouncementRecipientsRequest {
|
|
|
18793
18810
|
*/
|
|
18794
18811
|
export interface AnnouncementsApiGetAnnouncementsRequest {
|
|
18795
18812
|
/**
|
|
18796
|
-
* Filter by
|
|
18813
|
+
* Filter by eventId
|
|
18814
|
+
*/
|
|
18815
|
+
readonly eventId?: string;
|
|
18816
|
+
/**
|
|
18817
|
+
* Filter by groupId
|
|
18797
18818
|
*/
|
|
18798
|
-
readonly
|
|
18819
|
+
readonly groupId?: string;
|
|
18820
|
+
/**
|
|
18821
|
+
* Filter by audienceId
|
|
18822
|
+
*/
|
|
18823
|
+
readonly audienceId?: string;
|
|
18824
|
+
/**
|
|
18825
|
+
* Filter by community
|
|
18826
|
+
*/
|
|
18827
|
+
readonly community?: boolean;
|
|
18799
18828
|
/**
|
|
18800
18829
|
* Page number
|
|
18801
18830
|
*/
|
|
@@ -18988,9 +19017,13 @@ export declare const AnnouncementsAudiencesApiAxiosParamCreator: (configuration?
|
|
|
18988
19017
|
*/
|
|
18989
19018
|
getAnnouncementAudienceAccounts: (audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18990
19019
|
/**
|
|
18991
|
-
* 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.
|
|
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.
|
|
18992
19021
|
* @summary List announcement audiences
|
|
18993
|
-
* @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
|
|
18994
19027
|
* @param {number} [page] Page number
|
|
18995
19028
|
* @param {number} [pageSize] Number of items per page
|
|
18996
19029
|
* @param {string} [orderBy] Field to order by
|
|
@@ -18998,7 +19031,7 @@ export declare const AnnouncementsAudiencesApiAxiosParamCreator: (configuration?
|
|
|
18998
19031
|
* @param {*} [options] Override http request option.
|
|
18999
19032
|
* @throws {RequiredError}
|
|
19000
19033
|
*/
|
|
19001
|
-
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>;
|
|
19002
19035
|
/**
|
|
19003
19036
|
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
19004
19037
|
* @summary Update an announcement audience
|
|
@@ -19109,9 +19142,13 @@ export declare const AnnouncementsAudiencesApiFp: (configuration?: Configuration
|
|
|
19109
19142
|
*/
|
|
19110
19143
|
getAnnouncementAudienceAccounts(audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudienceAccounts200Response>>;
|
|
19111
19144
|
/**
|
|
19112
|
-
* 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.
|
|
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.
|
|
19113
19146
|
* @summary List announcement audiences
|
|
19114
|
-
* @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
|
|
19115
19152
|
* @param {number} [page] Page number
|
|
19116
19153
|
* @param {number} [pageSize] Number of items per page
|
|
19117
19154
|
* @param {string} [orderBy] Field to order by
|
|
@@ -19119,7 +19156,7 @@ export declare const AnnouncementsAudiencesApiFp: (configuration?: Configuration
|
|
|
19119
19156
|
* @param {*} [options] Override http request option.
|
|
19120
19157
|
* @throws {RequiredError}
|
|
19121
19158
|
*/
|
|
19122
|
-
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>>;
|
|
19123
19160
|
/**
|
|
19124
19161
|
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
19125
19162
|
* @summary Update an announcement audience
|
|
@@ -19220,7 +19257,7 @@ export declare const AnnouncementsAudiencesApiFactory: (configuration?: Configur
|
|
|
19220
19257
|
*/
|
|
19221
19258
|
getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudienceAccounts200Response>;
|
|
19222
19259
|
/**
|
|
19223
|
-
* 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.
|
|
19260
|
+
* 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.
|
|
19224
19261
|
* @summary List announcement audiences
|
|
19225
19262
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
19226
19263
|
* @param {*} [options] Override http request option.
|
|
@@ -19360,9 +19397,25 @@ export interface AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest
|
|
|
19360
19397
|
*/
|
|
19361
19398
|
export interface AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest {
|
|
19362
19399
|
/**
|
|
19363
|
-
* 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
|
|
19409
|
+
*/
|
|
19410
|
+
readonly channelId?: string;
|
|
19411
|
+
/**
|
|
19412
|
+
* Filter by archived
|
|
19413
|
+
*/
|
|
19414
|
+
readonly archived?: boolean;
|
|
19415
|
+
/**
|
|
19416
|
+
* Filter by featured
|
|
19364
19417
|
*/
|
|
19365
|
-
readonly
|
|
19418
|
+
readonly featured?: boolean;
|
|
19366
19419
|
/**
|
|
19367
19420
|
* Page number
|
|
19368
19421
|
*/
|
|
@@ -19491,7 +19544,7 @@ export declare class AnnouncementsAudiencesApi extends BaseAPI {
|
|
|
19491
19544
|
*/
|
|
19492
19545
|
getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudienceAccounts200Response, any, {}, any>>;
|
|
19493
19546
|
/**
|
|
19494
|
-
* 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.
|
|
19547
|
+
* 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.
|
|
19495
19548
|
* @summary List announcement audiences
|
|
19496
19549
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
19497
19550
|
* @param {*} [options] Override http request option.
|
|
@@ -69432,11 +69485,13 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
69432
69485
|
/**
|
|
69433
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.
|
|
69434
69487
|
* @summary Count the caller\'s notifications
|
|
69435
|
-
* @param {
|
|
69488
|
+
* @param {boolean} [read] Filter by read
|
|
69489
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
69490
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
69436
69491
|
* @param {*} [options] Override http request option.
|
|
69437
69492
|
* @throws {RequiredError}
|
|
69438
69493
|
*/
|
|
69439
|
-
getNotificationCount: (
|
|
69494
|
+
getNotificationCount: (read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69440
69495
|
/**
|
|
69441
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.
|
|
69442
69497
|
* @summary Get notification statistics
|
|
@@ -69447,7 +69502,9 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
69447
69502
|
/**
|
|
69448
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.
|
|
69449
69504
|
* @summary List the current member\'s notifications
|
|
69450
|
-
* @param {
|
|
69505
|
+
* @param {boolean} [read] Filter by read
|
|
69506
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
69507
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
69451
69508
|
* @param {number} [page] Page number
|
|
69452
69509
|
* @param {number} [pageSize] Number of items per page
|
|
69453
69510
|
* @param {string} [orderBy] Field to order by
|
|
@@ -69455,7 +69512,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
69455
69512
|
* @param {*} [options] Override http request option.
|
|
69456
69513
|
* @throws {RequiredError}
|
|
69457
69514
|
*/
|
|
69458
|
-
getNotifications: (
|
|
69515
|
+
getNotifications: (read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69459
69516
|
/**
|
|
69460
69517
|
* Marks the given list of notification IDs as read for the current organization member and returns the count of notifications updated.
|
|
69461
69518
|
* @summary Mark notifications as read
|
|
@@ -69472,11 +69529,13 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
69472
69529
|
/**
|
|
69473
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.
|
|
69474
69531
|
* @summary Count the caller\'s notifications
|
|
69475
|
-
* @param {
|
|
69532
|
+
* @param {boolean} [read] Filter by read
|
|
69533
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
69534
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
69476
69535
|
* @param {*} [options] Override http request option.
|
|
69477
69536
|
* @throws {RequiredError}
|
|
69478
69537
|
*/
|
|
69479
|
-
getNotificationCount(
|
|
69538
|
+
getNotificationCount(read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncAccounts200Response>>;
|
|
69480
69539
|
/**
|
|
69481
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.
|
|
69482
69541
|
* @summary Get notification statistics
|
|
@@ -69487,7 +69546,9 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
69487
69546
|
/**
|
|
69488
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.
|
|
69489
69548
|
* @summary List the current member\'s notifications
|
|
69490
|
-
* @param {
|
|
69549
|
+
* @param {boolean} [read] Filter by read
|
|
69550
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
69551
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
69491
69552
|
* @param {number} [page] Page number
|
|
69492
69553
|
* @param {number} [pageSize] Number of items per page
|
|
69493
69554
|
* @param {string} [orderBy] Field to order by
|
|
@@ -69495,7 +69556,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
69495
69556
|
* @param {*} [options] Override http request option.
|
|
69496
69557
|
* @throws {RequiredError}
|
|
69497
69558
|
*/
|
|
69498
|
-
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>>;
|
|
69499
69560
|
/**
|
|
69500
69561
|
* Marks the given list of notification IDs as read for the current organization member and returns the count of notifications updated.
|
|
69501
69562
|
* @summary Mark notifications as read
|
|
@@ -69546,18 +69607,34 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
69546
69607
|
*/
|
|
69547
69608
|
export interface NotificationsApiGetNotificationCountRequest {
|
|
69548
69609
|
/**
|
|
69549
|
-
* 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
|
|
69550
69619
|
*/
|
|
69551
|
-
readonly
|
|
69620
|
+
readonly type?: AdminNotificationType;
|
|
69552
69621
|
}
|
|
69553
69622
|
/**
|
|
69554
69623
|
* Request parameters for getNotifications operation in NotificationsApi.
|
|
69555
69624
|
*/
|
|
69556
69625
|
export interface NotificationsApiGetNotificationsRequest {
|
|
69557
69626
|
/**
|
|
69558
|
-
* Filter by
|
|
69627
|
+
* Filter by read
|
|
69628
|
+
*/
|
|
69629
|
+
readonly read?: boolean;
|
|
69630
|
+
/**
|
|
69631
|
+
* Filter by source
|
|
69559
69632
|
*/
|
|
69560
|
-
readonly
|
|
69633
|
+
readonly source?: AdminNotificationSource;
|
|
69634
|
+
/**
|
|
69635
|
+
* Filter by type
|
|
69636
|
+
*/
|
|
69637
|
+
readonly type?: AdminNotificationType;
|
|
69561
69638
|
/**
|
|
69562
69639
|
* Page number
|
|
69563
69640
|
*/
|
|
@@ -69660,11 +69737,16 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
69660
69737
|
/**
|
|
69661
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.
|
|
69662
69739
|
* @summary Search across the organization
|
|
69663
|
-
* @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
|
|
69664
69746
|
* @param {*} [options] Override http request option.
|
|
69665
69747
|
* @throws {RequiredError}
|
|
69666
69748
|
*/
|
|
69667
|
-
searchOrganization: (
|
|
69749
|
+
searchOrganization: (accounts?: boolean, events?: boolean, groups?: boolean, channels?: boolean, contents?: boolean, threads?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69668
69750
|
/**
|
|
69669
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.
|
|
69670
69752
|
* @summary Update the organization\'s profile
|
|
@@ -69742,11 +69824,16 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
69742
69824
|
/**
|
|
69743
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.
|
|
69744
69826
|
* @summary Search across the organization
|
|
69745
|
-
* @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
|
|
69746
69833
|
* @param {*} [options] Override http request option.
|
|
69747
69834
|
* @throws {RequiredError}
|
|
69748
69835
|
*/
|
|
69749
|
-
searchOrganization(
|
|
69836
|
+
searchOrganization(accounts?: boolean, events?: boolean, groups?: boolean, channels?: boolean, contents?: boolean, threads?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchOrganization200Response>>;
|
|
69750
69837
|
/**
|
|
69751
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.
|
|
69752
69839
|
* @summary Update the organization\'s profile
|
|
@@ -69909,9 +69996,29 @@ export interface OrganizationApiGetOrganizationSystemLogsRequest {
|
|
|
69909
69996
|
*/
|
|
69910
69997
|
export interface OrganizationApiSearchOrganizationRequest {
|
|
69911
69998
|
/**
|
|
69912
|
-
* Filter by
|
|
69999
|
+
* Filter by accounts
|
|
70000
|
+
*/
|
|
70001
|
+
readonly accounts?: boolean;
|
|
70002
|
+
/**
|
|
70003
|
+
* Filter by events
|
|
70004
|
+
*/
|
|
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
|
|
69913
70020
|
*/
|
|
69914
|
-
readonly
|
|
70021
|
+
readonly threads?: boolean;
|
|
69915
70022
|
}
|
|
69916
70023
|
/**
|
|
69917
70024
|
* Request parameters for updateOrganization operation in OrganizationApi.
|
|
@@ -75079,7 +75186,17 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
75079
75186
|
/**
|
|
75080
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.
|
|
75081
75188
|
* @summary List an organization\'s custom reports
|
|
75082
|
-
* @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
|
|
75083
75200
|
* @param {number} [page] Page number
|
|
75084
75201
|
* @param {number} [pageSize] Number of items per page
|
|
75085
75202
|
* @param {string} [orderBy] Field to order by
|
|
@@ -75087,16 +75204,26 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
75087
75204
|
* @param {*} [options] Override http request option.
|
|
75088
75205
|
* @throws {RequiredError}
|
|
75089
75206
|
*/
|
|
75090
|
-
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>;
|
|
75091
75208
|
/**
|
|
75092
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.
|
|
75093
75210
|
* @summary Run a standard report and fetch all its rows
|
|
75094
75211
|
* @param {string} standard The standard identifier
|
|
75095
|
-
* @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
|
|
75096
75223
|
* @param {*} [options] Override http request option.
|
|
75097
75224
|
* @throws {RequiredError}
|
|
75098
75225
|
*/
|
|
75099
|
-
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>;
|
|
75100
75227
|
/**
|
|
75101
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.
|
|
75102
75229
|
* @summary List available standard reports
|
|
@@ -75181,7 +75308,17 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
75181
75308
|
/**
|
|
75182
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.
|
|
75183
75310
|
* @summary List an organization\'s custom reports
|
|
75184
|
-
* @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
|
|
75185
75322
|
* @param {number} [page] Page number
|
|
75186
75323
|
* @param {number} [pageSize] Number of items per page
|
|
75187
75324
|
* @param {string} [orderBy] Field to order by
|
|
@@ -75189,16 +75326,26 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
75189
75326
|
* @param {*} [options] Override http request option.
|
|
75190
75327
|
* @throws {RequiredError}
|
|
75191
75328
|
*/
|
|
75192
|
-
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>>;
|
|
75193
75330
|
/**
|
|
75194
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.
|
|
75195
75332
|
* @summary Run a standard report and fetch all its rows
|
|
75196
75333
|
* @param {string} standard The standard identifier
|
|
75197
|
-
* @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
|
|
75198
75345
|
* @param {*} [options] Override http request option.
|
|
75199
75346
|
* @throws {RequiredError}
|
|
75200
75347
|
*/
|
|
75201
|
-
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>>;
|
|
75202
75349
|
/**
|
|
75203
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.
|
|
75204
75351
|
* @summary List available standard reports
|
|
@@ -75380,9 +75527,49 @@ export interface ReportsApiGetCustomReportScheduleRequest {
|
|
|
75380
75527
|
*/
|
|
75381
75528
|
export interface ReportsApiGetCustomReportsRequest {
|
|
75382
75529
|
/**
|
|
75383
|
-
* 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
|
|
75384
75551
|
*/
|
|
75385
|
-
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;
|
|
75386
75573
|
/**
|
|
75387
75574
|
* Page number
|
|
75388
75575
|
*/
|
|
@@ -75409,9 +75596,49 @@ export interface ReportsApiGetReportRequest {
|
|
|
75409
75596
|
*/
|
|
75410
75597
|
readonly standard: string;
|
|
75411
75598
|
/**
|
|
75412
|
-
* 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
|
|
75413
75640
|
*/
|
|
75414
|
-
readonly
|
|
75641
|
+
readonly since?: string;
|
|
75415
75642
|
}
|
|
75416
75643
|
/**
|
|
75417
75644
|
* Request parameters for getReports operation in ReportsApi.
|