@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/api.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.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -9616,7 +9616,10 @@ const AnnouncementsApiAxiosParamCreator = function (configuration) {
|
|
|
9616
9616
|
/**
|
|
9617
9617
|
* 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.
|
|
9618
9618
|
* @summary List announcements
|
|
9619
|
-
* @param {
|
|
9619
|
+
* @param {string} [eventId] Filter by eventId
|
|
9620
|
+
* @param {string} [groupId] Filter by groupId
|
|
9621
|
+
* @param {string} [audienceId] Filter by audienceId
|
|
9622
|
+
* @param {boolean} [community] Filter by community
|
|
9620
9623
|
* @param {number} [page] Page number
|
|
9621
9624
|
* @param {number} [pageSize] Number of items per page
|
|
9622
9625
|
* @param {string} [orderBy] Field to order by
|
|
@@ -9624,7 +9627,7 @@ const AnnouncementsApiAxiosParamCreator = function (configuration) {
|
|
|
9624
9627
|
* @param {*} [options] Override http request option.
|
|
9625
9628
|
* @throws {RequiredError}
|
|
9626
9629
|
*/
|
|
9627
|
-
getAnnouncements: (
|
|
9630
|
+
getAnnouncements: (eventId_1, groupId_1, audienceId_1, community_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [eventId_1, groupId_1, audienceId_1, community_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (eventId, groupId, audienceId, community, page, pageSize, orderBy, search, options = {}) {
|
|
9628
9631
|
const localVarPath = `/announcements`;
|
|
9629
9632
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9630
9633
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -9639,10 +9642,17 @@ const AnnouncementsApiAxiosParamCreator = function (configuration) {
|
|
|
9639
9642
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
9640
9643
|
// authentication OrganizationId required
|
|
9641
9644
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
9642
|
-
if (
|
|
9643
|
-
|
|
9644
|
-
|
|
9645
|
-
|
|
9645
|
+
if (eventId !== undefined) {
|
|
9646
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
9647
|
+
}
|
|
9648
|
+
if (groupId !== undefined) {
|
|
9649
|
+
localVarQueryParameter['groupId'] = groupId;
|
|
9650
|
+
}
|
|
9651
|
+
if (audienceId !== undefined) {
|
|
9652
|
+
localVarQueryParameter['audienceId'] = audienceId;
|
|
9653
|
+
}
|
|
9654
|
+
if (community !== undefined) {
|
|
9655
|
+
localVarQueryParameter['community'] = community;
|
|
9646
9656
|
}
|
|
9647
9657
|
if (page !== undefined) {
|
|
9648
9658
|
localVarQueryParameter['page'] = page;
|
|
@@ -9857,7 +9867,10 @@ const AnnouncementsApiFp = function (configuration) {
|
|
|
9857
9867
|
/**
|
|
9858
9868
|
* 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.
|
|
9859
9869
|
* @summary List announcements
|
|
9860
|
-
* @param {
|
|
9870
|
+
* @param {string} [eventId] Filter by eventId
|
|
9871
|
+
* @param {string} [groupId] Filter by groupId
|
|
9872
|
+
* @param {string} [audienceId] Filter by audienceId
|
|
9873
|
+
* @param {boolean} [community] Filter by community
|
|
9861
9874
|
* @param {number} [page] Page number
|
|
9862
9875
|
* @param {number} [pageSize] Number of items per page
|
|
9863
9876
|
* @param {string} [orderBy] Field to order by
|
|
@@ -9865,10 +9878,10 @@ const AnnouncementsApiFp = function (configuration) {
|
|
|
9865
9878
|
* @param {*} [options] Override http request option.
|
|
9866
9879
|
* @throws {RequiredError}
|
|
9867
9880
|
*/
|
|
9868
|
-
getAnnouncements(
|
|
9881
|
+
getAnnouncements(eventId, groupId, audienceId, community, page, pageSize, orderBy, search, options) {
|
|
9869
9882
|
return __awaiter(this, void 0, void 0, function* () {
|
|
9870
9883
|
var _a, _b, _c;
|
|
9871
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncements(
|
|
9884
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncements(eventId, groupId, audienceId, community, page, pageSize, orderBy, search, options);
|
|
9872
9885
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
9873
9886
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnnouncementsApi.getAnnouncements']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
9874
9887
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -9984,7 +9997,7 @@ const AnnouncementsApiFactory = function (configuration, basePath, axios) {
|
|
|
9984
9997
|
* @throws {RequiredError}
|
|
9985
9998
|
*/
|
|
9986
9999
|
getAnnouncements(requestParameters = {}, options) {
|
|
9987
|
-
return localVarFp.getAnnouncements(requestParameters.
|
|
10000
|
+
return localVarFp.getAnnouncements(requestParameters.eventId, requestParameters.groupId, requestParameters.audienceId, requestParameters.community, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
9988
10001
|
},
|
|
9989
10002
|
/**
|
|
9990
10003
|
* 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.
|
|
@@ -10080,7 +10093,7 @@ class AnnouncementsApi extends base_1.BaseAPI {
|
|
|
10080
10093
|
* @throws {RequiredError}
|
|
10081
10094
|
*/
|
|
10082
10095
|
getAnnouncements(requestParameters = {}, options) {
|
|
10083
|
-
return (0, exports.AnnouncementsApiFp)(this.configuration).getAnnouncements(requestParameters.
|
|
10096
|
+
return (0, exports.AnnouncementsApiFp)(this.configuration).getAnnouncements(requestParameters.eventId, requestParameters.groupId, requestParameters.audienceId, requestParameters.community, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
10084
10097
|
}
|
|
10085
10098
|
/**
|
|
10086
10099
|
* 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.
|
|
@@ -10425,9 +10438,13 @@ const AnnouncementsAudiencesApiAxiosParamCreator = function (configuration) {
|
|
|
10425
10438
|
};
|
|
10426
10439
|
}),
|
|
10427
10440
|
/**
|
|
10428
|
-
* 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.
|
|
10441
|
+
* 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.
|
|
10429
10442
|
* @summary List announcement audiences
|
|
10430
|
-
* @param {
|
|
10443
|
+
* @param {string} [eventId] Filter by eventId
|
|
10444
|
+
* @param {string} [groupId] Filter by groupId
|
|
10445
|
+
* @param {string} [channelId] Filter by channelId
|
|
10446
|
+
* @param {boolean} [archived] Filter by archived
|
|
10447
|
+
* @param {boolean} [featured] Filter by featured
|
|
10431
10448
|
* @param {number} [page] Page number
|
|
10432
10449
|
* @param {number} [pageSize] Number of items per page
|
|
10433
10450
|
* @param {string} [orderBy] Field to order by
|
|
@@ -10435,7 +10452,7 @@ const AnnouncementsAudiencesApiAxiosParamCreator = function (configuration) {
|
|
|
10435
10452
|
* @param {*} [options] Override http request option.
|
|
10436
10453
|
* @throws {RequiredError}
|
|
10437
10454
|
*/
|
|
10438
|
-
getAnnouncementAudiences: (
|
|
10455
|
+
getAnnouncementAudiences: (eventId_1, groupId_1, channelId_1, archived_1, featured_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [eventId_1, groupId_1, channelId_1, archived_1, featured_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (eventId, groupId, channelId, archived, featured, page, pageSize, orderBy, search, options = {}) {
|
|
10439
10456
|
const localVarPath = `/announcements/audiences`;
|
|
10440
10457
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10441
10458
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -10450,10 +10467,20 @@ const AnnouncementsAudiencesApiAxiosParamCreator = function (configuration) {
|
|
|
10450
10467
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
10451
10468
|
// authentication OrganizationId required
|
|
10452
10469
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
10453
|
-
if (
|
|
10454
|
-
|
|
10455
|
-
|
|
10456
|
-
|
|
10470
|
+
if (eventId !== undefined) {
|
|
10471
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
10472
|
+
}
|
|
10473
|
+
if (groupId !== undefined) {
|
|
10474
|
+
localVarQueryParameter['groupId'] = groupId;
|
|
10475
|
+
}
|
|
10476
|
+
if (channelId !== undefined) {
|
|
10477
|
+
localVarQueryParameter['channelId'] = channelId;
|
|
10478
|
+
}
|
|
10479
|
+
if (archived !== undefined) {
|
|
10480
|
+
localVarQueryParameter['archived'] = archived;
|
|
10481
|
+
}
|
|
10482
|
+
if (featured !== undefined) {
|
|
10483
|
+
localVarQueryParameter['featured'] = featured;
|
|
10457
10484
|
}
|
|
10458
10485
|
if (page !== undefined) {
|
|
10459
10486
|
localVarQueryParameter['page'] = page;
|
|
@@ -10753,9 +10780,13 @@ const AnnouncementsAudiencesApiFp = function (configuration) {
|
|
|
10753
10780
|
});
|
|
10754
10781
|
},
|
|
10755
10782
|
/**
|
|
10756
|
-
* 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.
|
|
10783
|
+
* 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.
|
|
10757
10784
|
* @summary List announcement audiences
|
|
10758
|
-
* @param {
|
|
10785
|
+
* @param {string} [eventId] Filter by eventId
|
|
10786
|
+
* @param {string} [groupId] Filter by groupId
|
|
10787
|
+
* @param {string} [channelId] Filter by channelId
|
|
10788
|
+
* @param {boolean} [archived] Filter by archived
|
|
10789
|
+
* @param {boolean} [featured] Filter by featured
|
|
10759
10790
|
* @param {number} [page] Page number
|
|
10760
10791
|
* @param {number} [pageSize] Number of items per page
|
|
10761
10792
|
* @param {string} [orderBy] Field to order by
|
|
@@ -10763,10 +10794,10 @@ const AnnouncementsAudiencesApiFp = function (configuration) {
|
|
|
10763
10794
|
* @param {*} [options] Override http request option.
|
|
10764
10795
|
* @throws {RequiredError}
|
|
10765
10796
|
*/
|
|
10766
|
-
getAnnouncementAudiences(
|
|
10797
|
+
getAnnouncementAudiences(eventId, groupId, channelId, archived, featured, page, pageSize, orderBy, search, options) {
|
|
10767
10798
|
return __awaiter(this, void 0, void 0, function* () {
|
|
10768
10799
|
var _a, _b, _c;
|
|
10769
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementAudiences(
|
|
10800
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getAnnouncementAudiences(eventId, groupId, channelId, archived, featured, page, pageSize, orderBy, search, options);
|
|
10770
10801
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
10771
10802
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AnnouncementsAudiencesApi.getAnnouncementAudiences']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
10772
10803
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -10916,14 +10947,14 @@ const AnnouncementsAudiencesApiFactory = function (configuration, basePath, axio
|
|
|
10916
10947
|
return localVarFp.getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
10917
10948
|
},
|
|
10918
10949
|
/**
|
|
10919
|
-
* 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.
|
|
10950
|
+
* 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.
|
|
10920
10951
|
* @summary List announcement audiences
|
|
10921
10952
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
10922
10953
|
* @param {*} [options] Override http request option.
|
|
10923
10954
|
* @throws {RequiredError}
|
|
10924
10955
|
*/
|
|
10925
10956
|
getAnnouncementAudiences(requestParameters = {}, options) {
|
|
10926
|
-
return localVarFp.getAnnouncementAudiences(requestParameters.
|
|
10957
|
+
return localVarFp.getAnnouncementAudiences(requestParameters.eventId, requestParameters.groupId, requestParameters.channelId, requestParameters.archived, requestParameters.featured, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
10927
10958
|
},
|
|
10928
10959
|
/**
|
|
10929
10960
|
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
@@ -11043,14 +11074,14 @@ class AnnouncementsAudiencesApi extends base_1.BaseAPI {
|
|
|
11043
11074
|
return (0, exports.AnnouncementsAudiencesApiFp)(this.configuration).getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
11044
11075
|
}
|
|
11045
11076
|
/**
|
|
11046
|
-
* 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.
|
|
11077
|
+
* 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.
|
|
11047
11078
|
* @summary List announcement audiences
|
|
11048
11079
|
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
11049
11080
|
* @param {*} [options] Override http request option.
|
|
11050
11081
|
* @throws {RequiredError}
|
|
11051
11082
|
*/
|
|
11052
11083
|
getAnnouncementAudiences(requestParameters = {}, options) {
|
|
11053
|
-
return (0, exports.AnnouncementsAudiencesApiFp)(this.configuration).getAnnouncementAudiences(requestParameters.
|
|
11084
|
+
return (0, exports.AnnouncementsAudiencesApiFp)(this.configuration).getAnnouncementAudiences(requestParameters.eventId, requestParameters.groupId, requestParameters.channelId, requestParameters.archived, requestParameters.featured, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
11054
11085
|
}
|
|
11055
11086
|
/**
|
|
11056
11087
|
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
@@ -86147,11 +86178,13 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
86147
86178
|
/**
|
|
86148
86179
|
* 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.
|
|
86149
86180
|
* @summary Count the caller\'s notifications
|
|
86150
|
-
* @param {
|
|
86181
|
+
* @param {boolean} [read] Filter by read
|
|
86182
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
86183
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
86151
86184
|
* @param {*} [options] Override http request option.
|
|
86152
86185
|
* @throws {RequiredError}
|
|
86153
86186
|
*/
|
|
86154
|
-
getNotificationCount: (
|
|
86187
|
+
getNotificationCount: (read_1, source_1, type_1, ...args_1) => __awaiter(this, [read_1, source_1, type_1, ...args_1], void 0, function* (read, source, type, options = {}) {
|
|
86155
86188
|
const localVarPath = `/notifications/count`;
|
|
86156
86189
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
86157
86190
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -86166,10 +86199,14 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
86166
86199
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
86167
86200
|
// authentication OrganizationId required
|
|
86168
86201
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
86169
|
-
if (
|
|
86170
|
-
|
|
86171
|
-
|
|
86172
|
-
|
|
86202
|
+
if (read !== undefined) {
|
|
86203
|
+
localVarQueryParameter['read'] = read;
|
|
86204
|
+
}
|
|
86205
|
+
if (source !== undefined) {
|
|
86206
|
+
localVarQueryParameter['source'] = source;
|
|
86207
|
+
}
|
|
86208
|
+
if (type !== undefined) {
|
|
86209
|
+
localVarQueryParameter['type'] = type;
|
|
86173
86210
|
}
|
|
86174
86211
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
86175
86212
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -86213,7 +86250,9 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
86213
86250
|
/**
|
|
86214
86251
|
* 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.
|
|
86215
86252
|
* @summary List the current member\'s notifications
|
|
86216
|
-
* @param {
|
|
86253
|
+
* @param {boolean} [read] Filter by read
|
|
86254
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
86255
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
86217
86256
|
* @param {number} [page] Page number
|
|
86218
86257
|
* @param {number} [pageSize] Number of items per page
|
|
86219
86258
|
* @param {string} [orderBy] Field to order by
|
|
@@ -86221,7 +86260,7 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
86221
86260
|
* @param {*} [options] Override http request option.
|
|
86222
86261
|
* @throws {RequiredError}
|
|
86223
86262
|
*/
|
|
86224
|
-
getNotifications: (
|
|
86263
|
+
getNotifications: (read_1, source_1, type_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [read_1, source_1, type_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (read, source, type, page, pageSize, orderBy, search, options = {}) {
|
|
86225
86264
|
const localVarPath = `/notifications`;
|
|
86226
86265
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
86227
86266
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -86236,10 +86275,14 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
86236
86275
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
86237
86276
|
// authentication OrganizationId required
|
|
86238
86277
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
86239
|
-
if (
|
|
86240
|
-
|
|
86241
|
-
|
|
86242
|
-
|
|
86278
|
+
if (read !== undefined) {
|
|
86279
|
+
localVarQueryParameter['read'] = read;
|
|
86280
|
+
}
|
|
86281
|
+
if (source !== undefined) {
|
|
86282
|
+
localVarQueryParameter['source'] = source;
|
|
86283
|
+
}
|
|
86284
|
+
if (type !== undefined) {
|
|
86285
|
+
localVarQueryParameter['type'] = type;
|
|
86243
86286
|
}
|
|
86244
86287
|
if (page !== undefined) {
|
|
86245
86288
|
localVarQueryParameter['page'] = page;
|
|
@@ -86309,14 +86352,16 @@ const NotificationsApiFp = function (configuration) {
|
|
|
86309
86352
|
/**
|
|
86310
86353
|
* 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.
|
|
86311
86354
|
* @summary Count the caller\'s notifications
|
|
86312
|
-
* @param {
|
|
86355
|
+
* @param {boolean} [read] Filter by read
|
|
86356
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
86357
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
86313
86358
|
* @param {*} [options] Override http request option.
|
|
86314
86359
|
* @throws {RequiredError}
|
|
86315
86360
|
*/
|
|
86316
|
-
getNotificationCount(
|
|
86361
|
+
getNotificationCount(read, source, type, options) {
|
|
86317
86362
|
return __awaiter(this, void 0, void 0, function* () {
|
|
86318
86363
|
var _a, _b, _c;
|
|
86319
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotificationCount(
|
|
86364
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotificationCount(read, source, type, options);
|
|
86320
86365
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
86321
86366
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['NotificationsApi.getNotificationCount']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
86322
86367
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -86340,7 +86385,9 @@ const NotificationsApiFp = function (configuration) {
|
|
|
86340
86385
|
/**
|
|
86341
86386
|
* 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.
|
|
86342
86387
|
* @summary List the current member\'s notifications
|
|
86343
|
-
* @param {
|
|
86388
|
+
* @param {boolean} [read] Filter by read
|
|
86389
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
86390
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
86344
86391
|
* @param {number} [page] Page number
|
|
86345
86392
|
* @param {number} [pageSize] Number of items per page
|
|
86346
86393
|
* @param {string} [orderBy] Field to order by
|
|
@@ -86348,10 +86395,10 @@ const NotificationsApiFp = function (configuration) {
|
|
|
86348
86395
|
* @param {*} [options] Override http request option.
|
|
86349
86396
|
* @throws {RequiredError}
|
|
86350
86397
|
*/
|
|
86351
|
-
getNotifications(
|
|
86398
|
+
getNotifications(read, source, type, page, pageSize, orderBy, search, options) {
|
|
86352
86399
|
return __awaiter(this, void 0, void 0, function* () {
|
|
86353
86400
|
var _a, _b, _c;
|
|
86354
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotifications(
|
|
86401
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotifications(read, source, type, page, pageSize, orderBy, search, options);
|
|
86355
86402
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
86356
86403
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['NotificationsApi.getNotifications']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
86357
86404
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -86390,7 +86437,7 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
|
|
|
86390
86437
|
* @throws {RequiredError}
|
|
86391
86438
|
*/
|
|
86392
86439
|
getNotificationCount(requestParameters = {}, options) {
|
|
86393
|
-
return localVarFp.getNotificationCount(requestParameters.
|
|
86440
|
+
return localVarFp.getNotificationCount(requestParameters.read, requestParameters.source, requestParameters.type, options).then((request) => request(axios, basePath));
|
|
86394
86441
|
},
|
|
86395
86442
|
/**
|
|
86396
86443
|
* 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.
|
|
@@ -86409,7 +86456,7 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
|
|
|
86409
86456
|
* @throws {RequiredError}
|
|
86410
86457
|
*/
|
|
86411
86458
|
getNotifications(requestParameters = {}, options) {
|
|
86412
|
-
return localVarFp.getNotifications(requestParameters.
|
|
86459
|
+
return localVarFp.getNotifications(requestParameters.read, requestParameters.source, requestParameters.type, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
86413
86460
|
},
|
|
86414
86461
|
/**
|
|
86415
86462
|
* Marks the given list of notification IDs as read for the current organization member and returns the count of notifications updated.
|
|
@@ -86436,7 +86483,7 @@ class NotificationsApi extends base_1.BaseAPI {
|
|
|
86436
86483
|
* @throws {RequiredError}
|
|
86437
86484
|
*/
|
|
86438
86485
|
getNotificationCount(requestParameters = {}, options) {
|
|
86439
|
-
return (0, exports.NotificationsApiFp)(this.configuration).getNotificationCount(requestParameters.
|
|
86486
|
+
return (0, exports.NotificationsApiFp)(this.configuration).getNotificationCount(requestParameters.read, requestParameters.source, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
|
|
86440
86487
|
}
|
|
86441
86488
|
/**
|
|
86442
86489
|
* 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.
|
|
@@ -86455,7 +86502,7 @@ class NotificationsApi extends base_1.BaseAPI {
|
|
|
86455
86502
|
* @throws {RequiredError}
|
|
86456
86503
|
*/
|
|
86457
86504
|
getNotifications(requestParameters = {}, options) {
|
|
86458
|
-
return (0, exports.NotificationsApiFp)(this.configuration).getNotifications(requestParameters.
|
|
86505
|
+
return (0, exports.NotificationsApiFp)(this.configuration).getNotifications(requestParameters.read, requestParameters.source, requestParameters.type, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
86459
86506
|
}
|
|
86460
86507
|
/**
|
|
86461
86508
|
* Marks the given list of notification IDs as read for the current organization member and returns the count of notifications updated.
|
|
@@ -86629,11 +86676,16 @@ const OrganizationApiAxiosParamCreator = function (configuration) {
|
|
|
86629
86676
|
/**
|
|
86630
86677
|
* 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.
|
|
86631
86678
|
* @summary Search across the organization
|
|
86632
|
-
* @param {
|
|
86679
|
+
* @param {boolean} [accounts] Filter by accounts
|
|
86680
|
+
* @param {boolean} [events] Filter by events
|
|
86681
|
+
* @param {boolean} [groups] Filter by groups
|
|
86682
|
+
* @param {boolean} [channels] Filter by channels
|
|
86683
|
+
* @param {boolean} [contents] Filter by contents
|
|
86684
|
+
* @param {boolean} [threads] Filter by threads
|
|
86633
86685
|
* @param {*} [options] Override http request option.
|
|
86634
86686
|
* @throws {RequiredError}
|
|
86635
86687
|
*/
|
|
86636
|
-
searchOrganization: (
|
|
86688
|
+
searchOrganization: (accounts_1, events_1, groups_1, channels_1, contents_1, threads_1, ...args_1) => __awaiter(this, [accounts_1, events_1, groups_1, channels_1, contents_1, threads_1, ...args_1], void 0, function* (accounts, events, groups, channels, contents, threads, options = {}) {
|
|
86637
86689
|
const localVarPath = `/organization/search`;
|
|
86638
86690
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
86639
86691
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -86648,10 +86700,23 @@ const OrganizationApiAxiosParamCreator = function (configuration) {
|
|
|
86648
86700
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
86649
86701
|
// authentication OrganizationId required
|
|
86650
86702
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
86651
|
-
if (
|
|
86652
|
-
|
|
86653
|
-
|
|
86654
|
-
|
|
86703
|
+
if (accounts !== undefined) {
|
|
86704
|
+
localVarQueryParameter['accounts'] = accounts;
|
|
86705
|
+
}
|
|
86706
|
+
if (events !== undefined) {
|
|
86707
|
+
localVarQueryParameter['events'] = events;
|
|
86708
|
+
}
|
|
86709
|
+
if (groups !== undefined) {
|
|
86710
|
+
localVarQueryParameter['groups'] = groups;
|
|
86711
|
+
}
|
|
86712
|
+
if (channels !== undefined) {
|
|
86713
|
+
localVarQueryParameter['channels'] = channels;
|
|
86714
|
+
}
|
|
86715
|
+
if (contents !== undefined) {
|
|
86716
|
+
localVarQueryParameter['contents'] = contents;
|
|
86717
|
+
}
|
|
86718
|
+
if (threads !== undefined) {
|
|
86719
|
+
localVarQueryParameter['threads'] = threads;
|
|
86655
86720
|
}
|
|
86656
86721
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
86657
86722
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -86886,14 +86951,19 @@ const OrganizationApiFp = function (configuration) {
|
|
|
86886
86951
|
/**
|
|
86887
86952
|
* 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.
|
|
86888
86953
|
* @summary Search across the organization
|
|
86889
|
-
* @param {
|
|
86954
|
+
* @param {boolean} [accounts] Filter by accounts
|
|
86955
|
+
* @param {boolean} [events] Filter by events
|
|
86956
|
+
* @param {boolean} [groups] Filter by groups
|
|
86957
|
+
* @param {boolean} [channels] Filter by channels
|
|
86958
|
+
* @param {boolean} [contents] Filter by contents
|
|
86959
|
+
* @param {boolean} [threads] Filter by threads
|
|
86890
86960
|
* @param {*} [options] Override http request option.
|
|
86891
86961
|
* @throws {RequiredError}
|
|
86892
86962
|
*/
|
|
86893
|
-
searchOrganization(
|
|
86963
|
+
searchOrganization(accounts, events, groups, channels, contents, threads, options) {
|
|
86894
86964
|
return __awaiter(this, void 0, void 0, function* () {
|
|
86895
86965
|
var _a, _b, _c;
|
|
86896
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.searchOrganization(
|
|
86966
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.searchOrganization(accounts, events, groups, channels, contents, threads, options);
|
|
86897
86967
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
86898
86968
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrganizationApi.searchOrganization']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
86899
86969
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -87020,7 +87090,7 @@ const OrganizationApiFactory = function (configuration, basePath, axios) {
|
|
|
87020
87090
|
* @throws {RequiredError}
|
|
87021
87091
|
*/
|
|
87022
87092
|
searchOrganization(requestParameters = {}, options) {
|
|
87023
|
-
return localVarFp.searchOrganization(requestParameters.
|
|
87093
|
+
return localVarFp.searchOrganization(requestParameters.accounts, requestParameters.events, requestParameters.groups, requestParameters.channels, requestParameters.contents, requestParameters.threads, options).then((request) => request(axios, basePath));
|
|
87024
87094
|
},
|
|
87025
87095
|
/**
|
|
87026
87096
|
* 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.
|
|
@@ -87116,7 +87186,7 @@ class OrganizationApi extends base_1.BaseAPI {
|
|
|
87116
87186
|
* @throws {RequiredError}
|
|
87117
87187
|
*/
|
|
87118
87188
|
searchOrganization(requestParameters = {}, options) {
|
|
87119
|
-
return (0, exports.OrganizationApiFp)(this.configuration).searchOrganization(requestParameters.
|
|
87189
|
+
return (0, exports.OrganizationApiFp)(this.configuration).searchOrganization(requestParameters.accounts, requestParameters.events, requestParameters.groups, requestParameters.channels, requestParameters.contents, requestParameters.threads, options).then((request) => request(this.axios, this.basePath));
|
|
87120
87190
|
}
|
|
87121
87191
|
/**
|
|
87122
87192
|
* 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.
|
|
@@ -95634,7 +95704,17 @@ const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
95634
95704
|
/**
|
|
95635
95705
|
* 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.
|
|
95636
95706
|
* @summary List an organization\'s custom reports
|
|
95637
|
-
* @param {
|
|
95707
|
+
* @param {string} [eventId] Filter by eventId
|
|
95708
|
+
* @param {string} [placeId] Filter by placeId
|
|
95709
|
+
* @param {string} [groupId] Filter by groupId
|
|
95710
|
+
* @param {string} [channelId] Filter by channelId
|
|
95711
|
+
* @param {string} [accountId] Filter by accountId
|
|
95712
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
95713
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
95714
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
95715
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
95716
|
+
* @param {string} [entityId] Filter by entityId
|
|
95717
|
+
* @param {string} [since] Filter by since
|
|
95638
95718
|
* @param {number} [page] Page number
|
|
95639
95719
|
* @param {number} [pageSize] Number of items per page
|
|
95640
95720
|
* @param {string} [orderBy] Field to order by
|
|
@@ -95642,7 +95722,7 @@ const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
95642
95722
|
* @param {*} [options] Override http request option.
|
|
95643
95723
|
* @throws {RequiredError}
|
|
95644
95724
|
*/
|
|
95645
|
-
getCustomReports: (
|
|
95725
|
+
getCustomReports: (eventId_1, placeId_1, groupId_1, channelId_1, accountId_1, surveyId_1, sessionId_1, seriesId_1, spaceId_1, entityId_1, since_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [eventId_1, placeId_1, groupId_1, channelId_1, accountId_1, surveyId_1, sessionId_1, seriesId_1, spaceId_1, entityId_1, since_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (eventId, placeId, groupId, channelId, accountId, surveyId, sessionId, seriesId, spaceId, entityId, since, page, pageSize, orderBy, search, options = {}) {
|
|
95646
95726
|
const localVarPath = `/reports/custom`;
|
|
95647
95727
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
95648
95728
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -95657,10 +95737,38 @@ const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
95657
95737
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
95658
95738
|
// authentication OrganizationId required
|
|
95659
95739
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
95660
|
-
if (
|
|
95661
|
-
|
|
95662
|
-
|
|
95663
|
-
|
|
95740
|
+
if (eventId !== undefined) {
|
|
95741
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
95742
|
+
}
|
|
95743
|
+
if (placeId !== undefined) {
|
|
95744
|
+
localVarQueryParameter['placeId'] = placeId;
|
|
95745
|
+
}
|
|
95746
|
+
if (groupId !== undefined) {
|
|
95747
|
+
localVarQueryParameter['groupId'] = groupId;
|
|
95748
|
+
}
|
|
95749
|
+
if (channelId !== undefined) {
|
|
95750
|
+
localVarQueryParameter['channelId'] = channelId;
|
|
95751
|
+
}
|
|
95752
|
+
if (accountId !== undefined) {
|
|
95753
|
+
localVarQueryParameter['accountId'] = accountId;
|
|
95754
|
+
}
|
|
95755
|
+
if (surveyId !== undefined) {
|
|
95756
|
+
localVarQueryParameter['surveyId'] = surveyId;
|
|
95757
|
+
}
|
|
95758
|
+
if (sessionId !== undefined) {
|
|
95759
|
+
localVarQueryParameter['sessionId'] = sessionId;
|
|
95760
|
+
}
|
|
95761
|
+
if (seriesId !== undefined) {
|
|
95762
|
+
localVarQueryParameter['seriesId'] = seriesId;
|
|
95763
|
+
}
|
|
95764
|
+
if (spaceId !== undefined) {
|
|
95765
|
+
localVarQueryParameter['spaceId'] = spaceId;
|
|
95766
|
+
}
|
|
95767
|
+
if (entityId !== undefined) {
|
|
95768
|
+
localVarQueryParameter['entityId'] = entityId;
|
|
95769
|
+
}
|
|
95770
|
+
if (since !== undefined) {
|
|
95771
|
+
localVarQueryParameter['since'] = since;
|
|
95664
95772
|
}
|
|
95665
95773
|
if (page !== undefined) {
|
|
95666
95774
|
localVarQueryParameter['page'] = page;
|
|
@@ -95687,11 +95795,21 @@ const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
95687
95795
|
* 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.
|
|
95688
95796
|
* @summary Run a standard report and fetch all its rows
|
|
95689
95797
|
* @param {string} standard The standard identifier
|
|
95690
|
-
* @param {
|
|
95798
|
+
* @param {string} [eventId] Filter by eventId
|
|
95799
|
+
* @param {string} [placeId] Filter by placeId
|
|
95800
|
+
* @param {string} [groupId] Filter by groupId
|
|
95801
|
+
* @param {string} [channelId] Filter by channelId
|
|
95802
|
+
* @param {string} [accountId] Filter by accountId
|
|
95803
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
95804
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
95805
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
95806
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
95807
|
+
* @param {string} [entityId] Filter by entityId
|
|
95808
|
+
* @param {string} [since] Filter by since
|
|
95691
95809
|
* @param {*} [options] Override http request option.
|
|
95692
95810
|
* @throws {RequiredError}
|
|
95693
95811
|
*/
|
|
95694
|
-
getReport: (standard_1,
|
|
95812
|
+
getReport: (standard_1, eventId_1, placeId_1, groupId_1, channelId_1, accountId_1, surveyId_1, sessionId_1, seriesId_1, spaceId_1, entityId_1, since_1, ...args_1) => __awaiter(this, [standard_1, eventId_1, placeId_1, groupId_1, channelId_1, accountId_1, surveyId_1, sessionId_1, seriesId_1, spaceId_1, entityId_1, since_1, ...args_1], void 0, function* (standard, eventId, placeId, groupId, channelId, accountId, surveyId, sessionId, seriesId, spaceId, entityId, since, options = {}) {
|
|
95695
95813
|
// verify required parameter 'standard' is not null or undefined
|
|
95696
95814
|
(0, common_1.assertParamExists)('getReport', 'standard', standard);
|
|
95697
95815
|
const localVarPath = `/reports/{standard}`
|
|
@@ -95709,10 +95827,38 @@ const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
95709
95827
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
95710
95828
|
// authentication OrganizationId required
|
|
95711
95829
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
95712
|
-
if (
|
|
95713
|
-
|
|
95714
|
-
|
|
95715
|
-
|
|
95830
|
+
if (eventId !== undefined) {
|
|
95831
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
95832
|
+
}
|
|
95833
|
+
if (placeId !== undefined) {
|
|
95834
|
+
localVarQueryParameter['placeId'] = placeId;
|
|
95835
|
+
}
|
|
95836
|
+
if (groupId !== undefined) {
|
|
95837
|
+
localVarQueryParameter['groupId'] = groupId;
|
|
95838
|
+
}
|
|
95839
|
+
if (channelId !== undefined) {
|
|
95840
|
+
localVarQueryParameter['channelId'] = channelId;
|
|
95841
|
+
}
|
|
95842
|
+
if (accountId !== undefined) {
|
|
95843
|
+
localVarQueryParameter['accountId'] = accountId;
|
|
95844
|
+
}
|
|
95845
|
+
if (surveyId !== undefined) {
|
|
95846
|
+
localVarQueryParameter['surveyId'] = surveyId;
|
|
95847
|
+
}
|
|
95848
|
+
if (sessionId !== undefined) {
|
|
95849
|
+
localVarQueryParameter['sessionId'] = sessionId;
|
|
95850
|
+
}
|
|
95851
|
+
if (seriesId !== undefined) {
|
|
95852
|
+
localVarQueryParameter['seriesId'] = seriesId;
|
|
95853
|
+
}
|
|
95854
|
+
if (spaceId !== undefined) {
|
|
95855
|
+
localVarQueryParameter['spaceId'] = spaceId;
|
|
95856
|
+
}
|
|
95857
|
+
if (entityId !== undefined) {
|
|
95858
|
+
localVarQueryParameter['entityId'] = entityId;
|
|
95859
|
+
}
|
|
95860
|
+
if (since !== undefined) {
|
|
95861
|
+
localVarQueryParameter['since'] = since;
|
|
95716
95862
|
}
|
|
95717
95863
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
95718
95864
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -95947,7 +96093,17 @@ const ReportsApiFp = function (configuration) {
|
|
|
95947
96093
|
/**
|
|
95948
96094
|
* 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.
|
|
95949
96095
|
* @summary List an organization\'s custom reports
|
|
95950
|
-
* @param {
|
|
96096
|
+
* @param {string} [eventId] Filter by eventId
|
|
96097
|
+
* @param {string} [placeId] Filter by placeId
|
|
96098
|
+
* @param {string} [groupId] Filter by groupId
|
|
96099
|
+
* @param {string} [channelId] Filter by channelId
|
|
96100
|
+
* @param {string} [accountId] Filter by accountId
|
|
96101
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
96102
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
96103
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
96104
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
96105
|
+
* @param {string} [entityId] Filter by entityId
|
|
96106
|
+
* @param {string} [since] Filter by since
|
|
95951
96107
|
* @param {number} [page] Page number
|
|
95952
96108
|
* @param {number} [pageSize] Number of items per page
|
|
95953
96109
|
* @param {string} [orderBy] Field to order by
|
|
@@ -95955,10 +96111,10 @@ const ReportsApiFp = function (configuration) {
|
|
|
95955
96111
|
* @param {*} [options] Override http request option.
|
|
95956
96112
|
* @throws {RequiredError}
|
|
95957
96113
|
*/
|
|
95958
|
-
getCustomReports(
|
|
96114
|
+
getCustomReports(eventId, placeId, groupId, channelId, accountId, surveyId, sessionId, seriesId, spaceId, entityId, since, page, pageSize, orderBy, search, options) {
|
|
95959
96115
|
return __awaiter(this, void 0, void 0, function* () {
|
|
95960
96116
|
var _a, _b, _c;
|
|
95961
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCustomReports(
|
|
96117
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCustomReports(eventId, placeId, groupId, channelId, accountId, surveyId, sessionId, seriesId, spaceId, entityId, since, page, pageSize, orderBy, search, options);
|
|
95962
96118
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
95963
96119
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReportsApi.getCustomReports']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
95964
96120
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -95968,14 +96124,24 @@ const ReportsApiFp = function (configuration) {
|
|
|
95968
96124
|
* 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.
|
|
95969
96125
|
* @summary Run a standard report and fetch all its rows
|
|
95970
96126
|
* @param {string} standard The standard identifier
|
|
95971
|
-
* @param {
|
|
96127
|
+
* @param {string} [eventId] Filter by eventId
|
|
96128
|
+
* @param {string} [placeId] Filter by placeId
|
|
96129
|
+
* @param {string} [groupId] Filter by groupId
|
|
96130
|
+
* @param {string} [channelId] Filter by channelId
|
|
96131
|
+
* @param {string} [accountId] Filter by accountId
|
|
96132
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
96133
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
96134
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
96135
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
96136
|
+
* @param {string} [entityId] Filter by entityId
|
|
96137
|
+
* @param {string} [since] Filter by since
|
|
95972
96138
|
* @param {*} [options] Override http request option.
|
|
95973
96139
|
* @throws {RequiredError}
|
|
95974
96140
|
*/
|
|
95975
|
-
getReport(standard,
|
|
96141
|
+
getReport(standard, eventId, placeId, groupId, channelId, accountId, surveyId, sessionId, seriesId, spaceId, entityId, since, options) {
|
|
95976
96142
|
return __awaiter(this, void 0, void 0, function* () {
|
|
95977
96143
|
var _a, _b, _c;
|
|
95978
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReport(standard,
|
|
96144
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReport(standard, eventId, placeId, groupId, channelId, accountId, surveyId, sessionId, seriesId, spaceId, entityId, since, options);
|
|
95979
96145
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
95980
96146
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReportsApi.getReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
95981
96147
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -96108,7 +96274,7 @@ const ReportsApiFactory = function (configuration, basePath, axios) {
|
|
|
96108
96274
|
* @throws {RequiredError}
|
|
96109
96275
|
*/
|
|
96110
96276
|
getCustomReports(requestParameters = {}, options) {
|
|
96111
|
-
return localVarFp.getCustomReports(requestParameters.
|
|
96277
|
+
return localVarFp.getCustomReports(requestParameters.eventId, requestParameters.placeId, requestParameters.groupId, requestParameters.channelId, requestParameters.accountId, requestParameters.surveyId, requestParameters.sessionId, requestParameters.seriesId, requestParameters.spaceId, requestParameters.entityId, requestParameters.since, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
96112
96278
|
},
|
|
96113
96279
|
/**
|
|
96114
96280
|
* 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.
|
|
@@ -96118,7 +96284,7 @@ const ReportsApiFactory = function (configuration, basePath, axios) {
|
|
|
96118
96284
|
* @throws {RequiredError}
|
|
96119
96285
|
*/
|
|
96120
96286
|
getReport(requestParameters, options) {
|
|
96121
|
-
return localVarFp.getReport(requestParameters.standard, requestParameters.
|
|
96287
|
+
return localVarFp.getReport(requestParameters.standard, requestParameters.eventId, requestParameters.placeId, requestParameters.groupId, requestParameters.channelId, requestParameters.accountId, requestParameters.surveyId, requestParameters.sessionId, requestParameters.seriesId, requestParameters.spaceId, requestParameters.entityId, requestParameters.since, options).then((request) => request(axios, basePath));
|
|
96122
96288
|
},
|
|
96123
96289
|
/**
|
|
96124
96290
|
* 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.
|
|
@@ -96225,7 +96391,7 @@ class ReportsApi extends base_1.BaseAPI {
|
|
|
96225
96391
|
* @throws {RequiredError}
|
|
96226
96392
|
*/
|
|
96227
96393
|
getCustomReports(requestParameters = {}, options) {
|
|
96228
|
-
return (0, exports.ReportsApiFp)(this.configuration).getCustomReports(requestParameters.
|
|
96394
|
+
return (0, exports.ReportsApiFp)(this.configuration).getCustomReports(requestParameters.eventId, requestParameters.placeId, requestParameters.groupId, requestParameters.channelId, requestParameters.accountId, requestParameters.surveyId, requestParameters.sessionId, requestParameters.seriesId, requestParameters.spaceId, requestParameters.entityId, requestParameters.since, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
96229
96395
|
}
|
|
96230
96396
|
/**
|
|
96231
96397
|
* 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.
|
|
@@ -96235,7 +96401,7 @@ class ReportsApi extends base_1.BaseAPI {
|
|
|
96235
96401
|
* @throws {RequiredError}
|
|
96236
96402
|
*/
|
|
96237
96403
|
getReport(requestParameters, options) {
|
|
96238
|
-
return (0, exports.ReportsApiFp)(this.configuration).getReport(requestParameters.standard, requestParameters.
|
|
96404
|
+
return (0, exports.ReportsApiFp)(this.configuration).getReport(requestParameters.standard, requestParameters.eventId, requestParameters.placeId, requestParameters.groupId, requestParameters.channelId, requestParameters.accountId, requestParameters.surveyId, requestParameters.sessionId, requestParameters.seriesId, requestParameters.spaceId, requestParameters.entityId, requestParameters.since, options).then((request) => request(this.axios, this.basePath));
|
|
96239
96405
|
}
|
|
96240
96406
|
/**
|
|
96241
96407
|
* 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.
|