@connectedxm/admin-sdk 12.2.0 → 12.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -0
- package/README.md +2 -2
- package/api.ts +488 -95
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +272 -46
- package/dist/api.js +244 -78
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +272 -46
- package/dist/esm/api.js +244 -78
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/AnnouncementsApi.md +13 -5
- package/docs/AnnouncementsAudiencesApi.md +16 -5
- package/docs/BaseStandardReport.md +1 -1
- package/docs/CustomReportCreateInputs.md +6 -0
- package/docs/NotificationsApi.md +20 -10
- package/docs/OrganizationApi.md +19 -5
- package/docs/ReportFilters.md +6 -0
- package/docs/ReportsApi.md +68 -10
- package/docs/StandardReport.md +2 -2
- package/docs/StandardReportAllOfNextCursor.md +18 -0
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 12.
|
|
7
|
+
* The version of the OpenAPI document: 12.3.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2921,7 +2921,7 @@ export interface BaseStandardReport {
|
|
|
2921
2921
|
'category': string;
|
|
2922
2922
|
'name': string;
|
|
2923
2923
|
'description': string;
|
|
2924
|
-
'dateType'
|
|
2924
|
+
'dateType'?: EventReportDateType;
|
|
2925
2925
|
'favorite': boolean;
|
|
2926
2926
|
'rowLink'?: string;
|
|
2927
2927
|
}
|
|
@@ -5241,6 +5241,9 @@ export interface CustomReportCreateInputs {
|
|
|
5241
5241
|
'surveyId'?: string;
|
|
5242
5242
|
'sessionId'?: string;
|
|
5243
5243
|
'seriesId'?: string;
|
|
5244
|
+
'spaceId'?: string;
|
|
5245
|
+
'entityId'?: string;
|
|
5246
|
+
'since'?: string;
|
|
5244
5247
|
'name': string;
|
|
5245
5248
|
'description'?: string | null;
|
|
5246
5249
|
'gridState'?: string | null;
|
|
@@ -13896,6 +13899,9 @@ export interface ReportFilters {
|
|
|
13896
13899
|
'surveyId'?: string;
|
|
13897
13900
|
'sessionId'?: string;
|
|
13898
13901
|
'seriesId'?: string;
|
|
13902
|
+
'spaceId'?: string;
|
|
13903
|
+
'entityId'?: string;
|
|
13904
|
+
'since'?: string;
|
|
13899
13905
|
}
|
|
13900
13906
|
|
|
13901
13907
|
export enum ReportType {
|
|
@@ -14566,15 +14572,20 @@ export interface StandardReport {
|
|
|
14566
14572
|
'category': string;
|
|
14567
14573
|
'name': string;
|
|
14568
14574
|
'description': string;
|
|
14569
|
-
'dateType'
|
|
14575
|
+
'dateType'?: EventReportDateType;
|
|
14570
14576
|
'favorite': boolean;
|
|
14571
14577
|
'rowLink'?: string;
|
|
14572
14578
|
'rowData': Array<object>;
|
|
14573
14579
|
'colDefs': Array<object>;
|
|
14574
|
-
'nextCursor':
|
|
14580
|
+
'nextCursor': StandardReportAllOfNextCursor | null;
|
|
14575
14581
|
}
|
|
14576
14582
|
|
|
14577
14583
|
|
|
14584
|
+
/**
|
|
14585
|
+
* @type StandardReportAllOfNextCursor
|
|
14586
|
+
*/
|
|
14587
|
+
export type StandardReportAllOfNextCursor = number | string;
|
|
14588
|
+
|
|
14578
14589
|
export interface StartEventRoundMatchmakingRequest {
|
|
14579
14590
|
'targetMatchSize': number;
|
|
14580
14591
|
}
|
|
@@ -24544,7 +24555,10 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
24544
24555
|
/**
|
|
24545
24556
|
* 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.
|
|
24546
24557
|
* @summary List announcements
|
|
24547
|
-
* @param {
|
|
24558
|
+
* @param {string} [eventId] Filter by eventId
|
|
24559
|
+
* @param {string} [groupId] Filter by groupId
|
|
24560
|
+
* @param {string} [audienceId] Filter by audienceId
|
|
24561
|
+
* @param {boolean} [community] Filter by community
|
|
24548
24562
|
* @param {number} [page] Page number
|
|
24549
24563
|
* @param {number} [pageSize] Number of items per page
|
|
24550
24564
|
* @param {string} [orderBy] Field to order by
|
|
@@ -24552,7 +24566,7 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
24552
24566
|
* @param {*} [options] Override http request option.
|
|
24553
24567
|
* @throws {RequiredError}
|
|
24554
24568
|
*/
|
|
24555
|
-
getAnnouncements: async (
|
|
24569
|
+
getAnnouncements: async (eventId?: string, groupId?: string, audienceId?: string, community?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
24556
24570
|
const localVarPath = `/announcements`;
|
|
24557
24571
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24558
24572
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -24571,10 +24585,20 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
24571
24585
|
// authentication OrganizationId required
|
|
24572
24586
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
24573
24587
|
|
|
24574
|
-
if (
|
|
24575
|
-
|
|
24576
|
-
|
|
24577
|
-
|
|
24588
|
+
if (eventId !== undefined) {
|
|
24589
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
24590
|
+
}
|
|
24591
|
+
|
|
24592
|
+
if (groupId !== undefined) {
|
|
24593
|
+
localVarQueryParameter['groupId'] = groupId;
|
|
24594
|
+
}
|
|
24595
|
+
|
|
24596
|
+
if (audienceId !== undefined) {
|
|
24597
|
+
localVarQueryParameter['audienceId'] = audienceId;
|
|
24598
|
+
}
|
|
24599
|
+
|
|
24600
|
+
if (community !== undefined) {
|
|
24601
|
+
localVarQueryParameter['community'] = community;
|
|
24578
24602
|
}
|
|
24579
24603
|
|
|
24580
24604
|
if (page !== undefined) {
|
|
@@ -24790,7 +24814,10 @@ export const AnnouncementsApiFp = function(configuration?: Configuration) {
|
|
|
24790
24814
|
/**
|
|
24791
24815
|
* 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.
|
|
24792
24816
|
* @summary List announcements
|
|
24793
|
-
* @param {
|
|
24817
|
+
* @param {string} [eventId] Filter by eventId
|
|
24818
|
+
* @param {string} [groupId] Filter by groupId
|
|
24819
|
+
* @param {string} [audienceId] Filter by audienceId
|
|
24820
|
+
* @param {boolean} [community] Filter by community
|
|
24794
24821
|
* @param {number} [page] Page number
|
|
24795
24822
|
* @param {number} [pageSize] Number of items per page
|
|
24796
24823
|
* @param {string} [orderBy] Field to order by
|
|
@@ -24798,8 +24825,8 @@ export const AnnouncementsApiFp = function(configuration?: Configuration) {
|
|
|
24798
24825
|
* @param {*} [options] Override http request option.
|
|
24799
24826
|
* @throws {RequiredError}
|
|
24800
24827
|
*/
|
|
24801
|
-
async getAnnouncements(
|
|
24802
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncements(
|
|
24828
|
+
async 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>> {
|
|
24829
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncements(eventId, groupId, audienceId, community, page, pageSize, orderBy, search, options);
|
|
24803
24830
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
24804
24831
|
const localVarOperationServerBasePath = operationServerMap['AnnouncementsApi.getAnnouncements']?.[localVarOperationServerIndex]?.url;
|
|
24805
24832
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -24908,7 +24935,7 @@ export const AnnouncementsApiFactory = function (configuration?: Configuration,
|
|
|
24908
24935
|
* @throws {RequiredError}
|
|
24909
24936
|
*/
|
|
24910
24937
|
getAnnouncements(requestParameters: AnnouncementsApiGetAnnouncementsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncements200Response> {
|
|
24911
|
-
return localVarFp.getAnnouncements(requestParameters.
|
|
24938
|
+
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));
|
|
24912
24939
|
},
|
|
24913
24940
|
/**
|
|
24914
24941
|
* 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.
|
|
@@ -25030,9 +25057,24 @@ export interface AnnouncementsApiGetAnnouncementRecipientsRequest {
|
|
|
25030
25057
|
*/
|
|
25031
25058
|
export interface AnnouncementsApiGetAnnouncementsRequest {
|
|
25032
25059
|
/**
|
|
25033
|
-
* Filter by
|
|
25060
|
+
* Filter by eventId
|
|
25034
25061
|
*/
|
|
25035
|
-
readonly
|
|
25062
|
+
readonly eventId?: string
|
|
25063
|
+
|
|
25064
|
+
/**
|
|
25065
|
+
* Filter by groupId
|
|
25066
|
+
*/
|
|
25067
|
+
readonly groupId?: string
|
|
25068
|
+
|
|
25069
|
+
/**
|
|
25070
|
+
* Filter by audienceId
|
|
25071
|
+
*/
|
|
25072
|
+
readonly audienceId?: string
|
|
25073
|
+
|
|
25074
|
+
/**
|
|
25075
|
+
* Filter by community
|
|
25076
|
+
*/
|
|
25077
|
+
readonly community?: boolean
|
|
25036
25078
|
|
|
25037
25079
|
/**
|
|
25038
25080
|
* Page number
|
|
@@ -25156,7 +25198,7 @@ export class AnnouncementsApi extends BaseAPI {
|
|
|
25156
25198
|
* @throws {RequiredError}
|
|
25157
25199
|
*/
|
|
25158
25200
|
public getAnnouncements(requestParameters: AnnouncementsApiGetAnnouncementsRequest = {}, options?: RawAxiosRequestConfig) {
|
|
25159
|
-
return AnnouncementsApiFp(this.configuration).getAnnouncements(requestParameters.
|
|
25201
|
+
return 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));
|
|
25160
25202
|
}
|
|
25161
25203
|
|
|
25162
25204
|
/**
|
|
@@ -25559,7 +25601,11 @@ export const AnnouncementsAudiencesApiAxiosParamCreator = function (configuratio
|
|
|
25559
25601
|
/**
|
|
25560
25602
|
* 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.
|
|
25561
25603
|
* @summary List announcement audiences
|
|
25562
|
-
* @param {
|
|
25604
|
+
* @param {string} [eventId] Filter by eventId
|
|
25605
|
+
* @param {string} [groupId] Filter by groupId
|
|
25606
|
+
* @param {string} [channelId] Filter by channelId
|
|
25607
|
+
* @param {boolean} [archived] Filter by archived
|
|
25608
|
+
* @param {boolean} [featured] Filter by featured
|
|
25563
25609
|
* @param {number} [page] Page number
|
|
25564
25610
|
* @param {number} [pageSize] Number of items per page
|
|
25565
25611
|
* @param {string} [orderBy] Field to order by
|
|
@@ -25567,7 +25613,7 @@ export const AnnouncementsAudiencesApiAxiosParamCreator = function (configuratio
|
|
|
25567
25613
|
* @param {*} [options] Override http request option.
|
|
25568
25614
|
* @throws {RequiredError}
|
|
25569
25615
|
*/
|
|
25570
|
-
getAnnouncementAudiences: async (
|
|
25616
|
+
getAnnouncementAudiences: async (eventId?: string, groupId?: string, channelId?: string, archived?: boolean, featured?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
25571
25617
|
const localVarPath = `/announcements/audiences`;
|
|
25572
25618
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25573
25619
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -25586,10 +25632,24 @@ export const AnnouncementsAudiencesApiAxiosParamCreator = function (configuratio
|
|
|
25586
25632
|
// authentication OrganizationId required
|
|
25587
25633
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
25588
25634
|
|
|
25589
|
-
if (
|
|
25590
|
-
|
|
25591
|
-
|
|
25592
|
-
|
|
25635
|
+
if (eventId !== undefined) {
|
|
25636
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
25637
|
+
}
|
|
25638
|
+
|
|
25639
|
+
if (groupId !== undefined) {
|
|
25640
|
+
localVarQueryParameter['groupId'] = groupId;
|
|
25641
|
+
}
|
|
25642
|
+
|
|
25643
|
+
if (channelId !== undefined) {
|
|
25644
|
+
localVarQueryParameter['channelId'] = channelId;
|
|
25645
|
+
}
|
|
25646
|
+
|
|
25647
|
+
if (archived !== undefined) {
|
|
25648
|
+
localVarQueryParameter['archived'] = archived;
|
|
25649
|
+
}
|
|
25650
|
+
|
|
25651
|
+
if (featured !== undefined) {
|
|
25652
|
+
localVarQueryParameter['featured'] = featured;
|
|
25593
25653
|
}
|
|
25594
25654
|
|
|
25595
25655
|
if (page !== undefined) {
|
|
@@ -25892,7 +25952,11 @@ export const AnnouncementsAudiencesApiFp = function(configuration?: Configuratio
|
|
|
25892
25952
|
/**
|
|
25893
25953
|
* 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.
|
|
25894
25954
|
* @summary List announcement audiences
|
|
25895
|
-
* @param {
|
|
25955
|
+
* @param {string} [eventId] Filter by eventId
|
|
25956
|
+
* @param {string} [groupId] Filter by groupId
|
|
25957
|
+
* @param {string} [channelId] Filter by channelId
|
|
25958
|
+
* @param {boolean} [archived] Filter by archived
|
|
25959
|
+
* @param {boolean} [featured] Filter by featured
|
|
25896
25960
|
* @param {number} [page] Page number
|
|
25897
25961
|
* @param {number} [pageSize] Number of items per page
|
|
25898
25962
|
* @param {string} [orderBy] Field to order by
|
|
@@ -25900,8 +25964,8 @@ export const AnnouncementsAudiencesApiFp = function(configuration?: Configuratio
|
|
|
25900
25964
|
* @param {*} [options] Override http request option.
|
|
25901
25965
|
* @throws {RequiredError}
|
|
25902
25966
|
*/
|
|
25903
|
-
async getAnnouncementAudiences(
|
|
25904
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementAudiences(
|
|
25967
|
+
async 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>> {
|
|
25968
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementAudiences(eventId, groupId, channelId, archived, featured, page, pageSize, orderBy, search, options);
|
|
25905
25969
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
25906
25970
|
const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.getAnnouncementAudiences']?.[localVarOperationServerIndex]?.url;
|
|
25907
25971
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -26048,7 +26112,7 @@ export const AnnouncementsAudiencesApiFactory = function (configuration?: Config
|
|
|
26048
26112
|
* @throws {RequiredError}
|
|
26049
26113
|
*/
|
|
26050
26114
|
getAnnouncementAudiences(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudiences200Response> {
|
|
26051
|
-
return localVarFp.getAnnouncementAudiences(requestParameters.
|
|
26115
|
+
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));
|
|
26052
26116
|
},
|
|
26053
26117
|
/**
|
|
26054
26118
|
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
@@ -26209,9 +26273,29 @@ export interface AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest
|
|
|
26209
26273
|
*/
|
|
26210
26274
|
export interface AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest {
|
|
26211
26275
|
/**
|
|
26212
|
-
* Filter by
|
|
26276
|
+
* Filter by eventId
|
|
26277
|
+
*/
|
|
26278
|
+
readonly eventId?: string
|
|
26279
|
+
|
|
26280
|
+
/**
|
|
26281
|
+
* Filter by groupId
|
|
26282
|
+
*/
|
|
26283
|
+
readonly groupId?: string
|
|
26284
|
+
|
|
26285
|
+
/**
|
|
26286
|
+
* Filter by channelId
|
|
26213
26287
|
*/
|
|
26214
|
-
readonly
|
|
26288
|
+
readonly channelId?: string
|
|
26289
|
+
|
|
26290
|
+
/**
|
|
26291
|
+
* Filter by archived
|
|
26292
|
+
*/
|
|
26293
|
+
readonly archived?: boolean
|
|
26294
|
+
|
|
26295
|
+
/**
|
|
26296
|
+
* Filter by featured
|
|
26297
|
+
*/
|
|
26298
|
+
readonly featured?: boolean
|
|
26215
26299
|
|
|
26216
26300
|
/**
|
|
26217
26301
|
* Page number
|
|
@@ -26385,7 +26469,7 @@ export class AnnouncementsAudiencesApi extends BaseAPI {
|
|
|
26385
26469
|
* @throws {RequiredError}
|
|
26386
26470
|
*/
|
|
26387
26471
|
public getAnnouncementAudiences(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest = {}, options?: RawAxiosRequestConfig) {
|
|
26388
|
-
return AnnouncementsAudiencesApiFp(this.configuration).getAnnouncementAudiences(requestParameters.
|
|
26472
|
+
return 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));
|
|
26389
26473
|
}
|
|
26390
26474
|
|
|
26391
26475
|
/**
|
|
@@ -124724,11 +124808,13 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
124724
124808
|
/**
|
|
124725
124809
|
* 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.
|
|
124726
124810
|
* @summary Count the caller\'s notifications
|
|
124727
|
-
* @param {
|
|
124811
|
+
* @param {boolean} [read] Filter by read
|
|
124812
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
124813
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
124728
124814
|
* @param {*} [options] Override http request option.
|
|
124729
124815
|
* @throws {RequiredError}
|
|
124730
124816
|
*/
|
|
124731
|
-
getNotificationCount: async (
|
|
124817
|
+
getNotificationCount: async (read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
124732
124818
|
const localVarPath = `/notifications/count`;
|
|
124733
124819
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
124734
124820
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -124747,10 +124833,16 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
124747
124833
|
// authentication OrganizationId required
|
|
124748
124834
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
124749
124835
|
|
|
124750
|
-
if (
|
|
124751
|
-
|
|
124752
|
-
|
|
124753
|
-
|
|
124836
|
+
if (read !== undefined) {
|
|
124837
|
+
localVarQueryParameter['read'] = read;
|
|
124838
|
+
}
|
|
124839
|
+
|
|
124840
|
+
if (source !== undefined) {
|
|
124841
|
+
localVarQueryParameter['source'] = source;
|
|
124842
|
+
}
|
|
124843
|
+
|
|
124844
|
+
if (type !== undefined) {
|
|
124845
|
+
localVarQueryParameter['type'] = type;
|
|
124754
124846
|
}
|
|
124755
124847
|
|
|
124756
124848
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
@@ -124803,7 +124895,9 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
124803
124895
|
/**
|
|
124804
124896
|
* 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.
|
|
124805
124897
|
* @summary List the current member\'s notifications
|
|
124806
|
-
* @param {
|
|
124898
|
+
* @param {boolean} [read] Filter by read
|
|
124899
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
124900
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
124807
124901
|
* @param {number} [page] Page number
|
|
124808
124902
|
* @param {number} [pageSize] Number of items per page
|
|
124809
124903
|
* @param {string} [orderBy] Field to order by
|
|
@@ -124811,7 +124905,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
124811
124905
|
* @param {*} [options] Override http request option.
|
|
124812
124906
|
* @throws {RequiredError}
|
|
124813
124907
|
*/
|
|
124814
|
-
getNotifications: async (
|
|
124908
|
+
getNotifications: async (read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
124815
124909
|
const localVarPath = `/notifications`;
|
|
124816
124910
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
124817
124911
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -124830,10 +124924,16 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
124830
124924
|
// authentication OrganizationId required
|
|
124831
124925
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
124832
124926
|
|
|
124833
|
-
if (
|
|
124834
|
-
|
|
124835
|
-
|
|
124836
|
-
|
|
124927
|
+
if (read !== undefined) {
|
|
124928
|
+
localVarQueryParameter['read'] = read;
|
|
124929
|
+
}
|
|
124930
|
+
|
|
124931
|
+
if (source !== undefined) {
|
|
124932
|
+
localVarQueryParameter['source'] = source;
|
|
124933
|
+
}
|
|
124934
|
+
|
|
124935
|
+
if (type !== undefined) {
|
|
124936
|
+
localVarQueryParameter['type'] = type;
|
|
124837
124937
|
}
|
|
124838
124938
|
|
|
124839
124939
|
if (page !== undefined) {
|
|
@@ -124916,12 +125016,14 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
|
|
|
124916
125016
|
/**
|
|
124917
125017
|
* 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.
|
|
124918
125018
|
* @summary Count the caller\'s notifications
|
|
124919
|
-
* @param {
|
|
125019
|
+
* @param {boolean} [read] Filter by read
|
|
125020
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
125021
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
124920
125022
|
* @param {*} [options] Override http request option.
|
|
124921
125023
|
* @throws {RequiredError}
|
|
124922
125024
|
*/
|
|
124923
|
-
async getNotificationCount(
|
|
124924
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationCount(
|
|
125025
|
+
async getNotificationCount(read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncAccounts200Response>> {
|
|
125026
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationCount(read, source, type, options);
|
|
124925
125027
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
124926
125028
|
const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getNotificationCount']?.[localVarOperationServerIndex]?.url;
|
|
124927
125029
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -124941,7 +125043,9 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
|
|
|
124941
125043
|
/**
|
|
124942
125044
|
* 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.
|
|
124943
125045
|
* @summary List the current member\'s notifications
|
|
124944
|
-
* @param {
|
|
125046
|
+
* @param {boolean} [read] Filter by read
|
|
125047
|
+
* @param {AdminNotificationSource} [source] Filter by source
|
|
125048
|
+
* @param {AdminNotificationType} [type] Filter by type
|
|
124945
125049
|
* @param {number} [page] Page number
|
|
124946
125050
|
* @param {number} [pageSize] Number of items per page
|
|
124947
125051
|
* @param {string} [orderBy] Field to order by
|
|
@@ -124949,8 +125053,8 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
|
|
|
124949
125053
|
* @param {*} [options] Override http request option.
|
|
124950
125054
|
* @throws {RequiredError}
|
|
124951
125055
|
*/
|
|
124952
|
-
async getNotifications(
|
|
124953
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getNotifications(
|
|
125056
|
+
async getNotifications(read?: boolean, source?: AdminNotificationSource, type?: AdminNotificationType, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotifications200Response>> {
|
|
125057
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getNotifications(read, source, type, page, pageSize, orderBy, search, options);
|
|
124954
125058
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
124955
125059
|
const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getNotifications']?.[localVarOperationServerIndex]?.url;
|
|
124956
125060
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -124985,7 +125089,7 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
|
|
|
124985
125089
|
* @throws {RequiredError}
|
|
124986
125090
|
*/
|
|
124987
125091
|
getNotificationCount(requestParameters: NotificationsApiGetNotificationCountRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<SyncAccounts200Response> {
|
|
124988
|
-
return localVarFp.getNotificationCount(requestParameters.
|
|
125092
|
+
return localVarFp.getNotificationCount(requestParameters.read, requestParameters.source, requestParameters.type, options).then((request) => request(axios, basePath));
|
|
124989
125093
|
},
|
|
124990
125094
|
/**
|
|
124991
125095
|
* 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.
|
|
@@ -125004,7 +125108,7 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
|
|
|
125004
125108
|
* @throws {RequiredError}
|
|
125005
125109
|
*/
|
|
125006
125110
|
getNotifications(requestParameters: NotificationsApiGetNotificationsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetNotifications200Response> {
|
|
125007
|
-
return localVarFp.getNotifications(requestParameters.
|
|
125111
|
+
return localVarFp.getNotifications(requestParameters.read, requestParameters.source, requestParameters.type, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
125008
125112
|
},
|
|
125009
125113
|
/**
|
|
125010
125114
|
* Marks the given list of notification IDs as read for the current organization member and returns the count of notifications updated.
|
|
@@ -125024,9 +125128,19 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
|
|
|
125024
125128
|
*/
|
|
125025
125129
|
export interface NotificationsApiGetNotificationCountRequest {
|
|
125026
125130
|
/**
|
|
125027
|
-
* Filter by
|
|
125131
|
+
* Filter by read
|
|
125132
|
+
*/
|
|
125133
|
+
readonly read?: boolean
|
|
125134
|
+
|
|
125135
|
+
/**
|
|
125136
|
+
* Filter by source
|
|
125137
|
+
*/
|
|
125138
|
+
readonly source?: AdminNotificationSource
|
|
125139
|
+
|
|
125140
|
+
/**
|
|
125141
|
+
* Filter by type
|
|
125028
125142
|
*/
|
|
125029
|
-
readonly
|
|
125143
|
+
readonly type?: AdminNotificationType
|
|
125030
125144
|
}
|
|
125031
125145
|
|
|
125032
125146
|
/**
|
|
@@ -125034,9 +125148,19 @@ export interface NotificationsApiGetNotificationCountRequest {
|
|
|
125034
125148
|
*/
|
|
125035
125149
|
export interface NotificationsApiGetNotificationsRequest {
|
|
125036
125150
|
/**
|
|
125037
|
-
* Filter by
|
|
125151
|
+
* Filter by read
|
|
125038
125152
|
*/
|
|
125039
|
-
readonly
|
|
125153
|
+
readonly read?: boolean
|
|
125154
|
+
|
|
125155
|
+
/**
|
|
125156
|
+
* Filter by source
|
|
125157
|
+
*/
|
|
125158
|
+
readonly source?: AdminNotificationSource
|
|
125159
|
+
|
|
125160
|
+
/**
|
|
125161
|
+
* Filter by type
|
|
125162
|
+
*/
|
|
125163
|
+
readonly type?: AdminNotificationType
|
|
125040
125164
|
|
|
125041
125165
|
/**
|
|
125042
125166
|
* Page number
|
|
@@ -125078,7 +125202,7 @@ export class NotificationsApi extends BaseAPI {
|
|
|
125078
125202
|
* @throws {RequiredError}
|
|
125079
125203
|
*/
|
|
125080
125204
|
public getNotificationCount(requestParameters: NotificationsApiGetNotificationCountRequest = {}, options?: RawAxiosRequestConfig) {
|
|
125081
|
-
return NotificationsApiFp(this.configuration).getNotificationCount(requestParameters.
|
|
125205
|
+
return NotificationsApiFp(this.configuration).getNotificationCount(requestParameters.read, requestParameters.source, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
|
|
125082
125206
|
}
|
|
125083
125207
|
|
|
125084
125208
|
/**
|
|
@@ -125099,7 +125223,7 @@ export class NotificationsApi extends BaseAPI {
|
|
|
125099
125223
|
* @throws {RequiredError}
|
|
125100
125224
|
*/
|
|
125101
125225
|
public getNotifications(requestParameters: NotificationsApiGetNotificationsRequest = {}, options?: RawAxiosRequestConfig) {
|
|
125102
|
-
return NotificationsApiFp(this.configuration).getNotifications(requestParameters.
|
|
125226
|
+
return 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));
|
|
125103
125227
|
}
|
|
125104
125228
|
|
|
125105
125229
|
/**
|
|
@@ -125306,11 +125430,16 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config
|
|
|
125306
125430
|
/**
|
|
125307
125431
|
* 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.
|
|
125308
125432
|
* @summary Search across the organization
|
|
125309
|
-
* @param {
|
|
125433
|
+
* @param {boolean} [accounts] Filter by accounts
|
|
125434
|
+
* @param {boolean} [events] Filter by events
|
|
125435
|
+
* @param {boolean} [groups] Filter by groups
|
|
125436
|
+
* @param {boolean} [channels] Filter by channels
|
|
125437
|
+
* @param {boolean} [contents] Filter by contents
|
|
125438
|
+
* @param {boolean} [threads] Filter by threads
|
|
125310
125439
|
* @param {*} [options] Override http request option.
|
|
125311
125440
|
* @throws {RequiredError}
|
|
125312
125441
|
*/
|
|
125313
|
-
searchOrganization: async (
|
|
125442
|
+
searchOrganization: async (accounts?: boolean, events?: boolean, groups?: boolean, channels?: boolean, contents?: boolean, threads?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
125314
125443
|
const localVarPath = `/organization/search`;
|
|
125315
125444
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
125316
125445
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -125329,10 +125458,28 @@ export const OrganizationApiAxiosParamCreator = function (configuration?: Config
|
|
|
125329
125458
|
// authentication OrganizationId required
|
|
125330
125459
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
125331
125460
|
|
|
125332
|
-
if (
|
|
125333
|
-
|
|
125334
|
-
|
|
125335
|
-
|
|
125461
|
+
if (accounts !== undefined) {
|
|
125462
|
+
localVarQueryParameter['accounts'] = accounts;
|
|
125463
|
+
}
|
|
125464
|
+
|
|
125465
|
+
if (events !== undefined) {
|
|
125466
|
+
localVarQueryParameter['events'] = events;
|
|
125467
|
+
}
|
|
125468
|
+
|
|
125469
|
+
if (groups !== undefined) {
|
|
125470
|
+
localVarQueryParameter['groups'] = groups;
|
|
125471
|
+
}
|
|
125472
|
+
|
|
125473
|
+
if (channels !== undefined) {
|
|
125474
|
+
localVarQueryParameter['channels'] = channels;
|
|
125475
|
+
}
|
|
125476
|
+
|
|
125477
|
+
if (contents !== undefined) {
|
|
125478
|
+
localVarQueryParameter['contents'] = contents;
|
|
125479
|
+
}
|
|
125480
|
+
|
|
125481
|
+
if (threads !== undefined) {
|
|
125482
|
+
localVarQueryParameter['threads'] = threads;
|
|
125336
125483
|
}
|
|
125337
125484
|
|
|
125338
125485
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
@@ -125582,12 +125729,17 @@ export const OrganizationApiFp = function(configuration?: Configuration) {
|
|
|
125582
125729
|
/**
|
|
125583
125730
|
* 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.
|
|
125584
125731
|
* @summary Search across the organization
|
|
125585
|
-
* @param {
|
|
125732
|
+
* @param {boolean} [accounts] Filter by accounts
|
|
125733
|
+
* @param {boolean} [events] Filter by events
|
|
125734
|
+
* @param {boolean} [groups] Filter by groups
|
|
125735
|
+
* @param {boolean} [channels] Filter by channels
|
|
125736
|
+
* @param {boolean} [contents] Filter by contents
|
|
125737
|
+
* @param {boolean} [threads] Filter by threads
|
|
125586
125738
|
* @param {*} [options] Override http request option.
|
|
125587
125739
|
* @throws {RequiredError}
|
|
125588
125740
|
*/
|
|
125589
|
-
async searchOrganization(
|
|
125590
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.searchOrganization(
|
|
125741
|
+
async searchOrganization(accounts?: boolean, events?: boolean, groups?: boolean, channels?: boolean, contents?: boolean, threads?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchOrganization200Response>> {
|
|
125742
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.searchOrganization(accounts, events, groups, channels, contents, threads, options);
|
|
125591
125743
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
125592
125744
|
const localVarOperationServerBasePath = operationServerMap['OrganizationApi.searchOrganization']?.[localVarOperationServerIndex]?.url;
|
|
125593
125745
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -125701,7 +125853,7 @@ export const OrganizationApiFactory = function (configuration?: Configuration, b
|
|
|
125701
125853
|
* @throws {RequiredError}
|
|
125702
125854
|
*/
|
|
125703
125855
|
searchOrganization(requestParameters: OrganizationApiSearchOrganizationRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<SearchOrganization200Response> {
|
|
125704
|
-
return localVarFp.searchOrganization(requestParameters.
|
|
125856
|
+
return localVarFp.searchOrganization(requestParameters.accounts, requestParameters.events, requestParameters.groups, requestParameters.channels, requestParameters.contents, requestParameters.threads, options).then((request) => request(axios, basePath));
|
|
125705
125857
|
},
|
|
125706
125858
|
/**
|
|
125707
125859
|
* 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.
|
|
@@ -125806,9 +125958,34 @@ export interface OrganizationApiGetOrganizationSystemLogsRequest {
|
|
|
125806
125958
|
*/
|
|
125807
125959
|
export interface OrganizationApiSearchOrganizationRequest {
|
|
125808
125960
|
/**
|
|
125809
|
-
* Filter by
|
|
125961
|
+
* Filter by accounts
|
|
125962
|
+
*/
|
|
125963
|
+
readonly accounts?: boolean
|
|
125964
|
+
|
|
125965
|
+
/**
|
|
125966
|
+
* Filter by events
|
|
125967
|
+
*/
|
|
125968
|
+
readonly events?: boolean
|
|
125969
|
+
|
|
125970
|
+
/**
|
|
125971
|
+
* Filter by groups
|
|
125972
|
+
*/
|
|
125973
|
+
readonly groups?: boolean
|
|
125974
|
+
|
|
125975
|
+
/**
|
|
125976
|
+
* Filter by channels
|
|
125977
|
+
*/
|
|
125978
|
+
readonly channels?: boolean
|
|
125979
|
+
|
|
125980
|
+
/**
|
|
125981
|
+
* Filter by contents
|
|
125982
|
+
*/
|
|
125983
|
+
readonly contents?: boolean
|
|
125984
|
+
|
|
125985
|
+
/**
|
|
125986
|
+
* Filter by threads
|
|
125810
125987
|
*/
|
|
125811
|
-
readonly
|
|
125988
|
+
readonly threads?: boolean
|
|
125812
125989
|
}
|
|
125813
125990
|
|
|
125814
125991
|
/**
|
|
@@ -125899,7 +126076,7 @@ export class OrganizationApi extends BaseAPI {
|
|
|
125899
126076
|
* @throws {RequiredError}
|
|
125900
126077
|
*/
|
|
125901
126078
|
public searchOrganization(requestParameters: OrganizationApiSearchOrganizationRequest = {}, options?: RawAxiosRequestConfig) {
|
|
125902
|
-
return OrganizationApiFp(this.configuration).searchOrganization(requestParameters.
|
|
126079
|
+
return OrganizationApiFp(this.configuration).searchOrganization(requestParameters.accounts, requestParameters.events, requestParameters.groups, requestParameters.channels, requestParameters.contents, requestParameters.threads, options).then((request) => request(this.axios, this.basePath));
|
|
125903
126080
|
}
|
|
125904
126081
|
|
|
125905
126082
|
/**
|
|
@@ -136340,7 +136517,17 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
136340
136517
|
/**
|
|
136341
136518
|
* 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.
|
|
136342
136519
|
* @summary List an organization\'s custom reports
|
|
136343
|
-
* @param {
|
|
136520
|
+
* @param {string} [eventId] Filter by eventId
|
|
136521
|
+
* @param {string} [placeId] Filter by placeId
|
|
136522
|
+
* @param {string} [groupId] Filter by groupId
|
|
136523
|
+
* @param {string} [channelId] Filter by channelId
|
|
136524
|
+
* @param {string} [accountId] Filter by accountId
|
|
136525
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
136526
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
136527
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
136528
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
136529
|
+
* @param {string} [entityId] Filter by entityId
|
|
136530
|
+
* @param {string} [since] Filter by since
|
|
136344
136531
|
* @param {number} [page] Page number
|
|
136345
136532
|
* @param {number} [pageSize] Number of items per page
|
|
136346
136533
|
* @param {string} [orderBy] Field to order by
|
|
@@ -136348,7 +136535,7 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
136348
136535
|
* @param {*} [options] Override http request option.
|
|
136349
136536
|
* @throws {RequiredError}
|
|
136350
136537
|
*/
|
|
136351
|
-
getCustomReports: async (
|
|
136538
|
+
getCustomReports: async (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> => {
|
|
136352
136539
|
const localVarPath = `/reports/custom`;
|
|
136353
136540
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
136354
136541
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -136367,10 +136554,48 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
136367
136554
|
// authentication OrganizationId required
|
|
136368
136555
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
136369
136556
|
|
|
136370
|
-
if (
|
|
136371
|
-
|
|
136372
|
-
|
|
136373
|
-
|
|
136557
|
+
if (eventId !== undefined) {
|
|
136558
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
136559
|
+
}
|
|
136560
|
+
|
|
136561
|
+
if (placeId !== undefined) {
|
|
136562
|
+
localVarQueryParameter['placeId'] = placeId;
|
|
136563
|
+
}
|
|
136564
|
+
|
|
136565
|
+
if (groupId !== undefined) {
|
|
136566
|
+
localVarQueryParameter['groupId'] = groupId;
|
|
136567
|
+
}
|
|
136568
|
+
|
|
136569
|
+
if (channelId !== undefined) {
|
|
136570
|
+
localVarQueryParameter['channelId'] = channelId;
|
|
136571
|
+
}
|
|
136572
|
+
|
|
136573
|
+
if (accountId !== undefined) {
|
|
136574
|
+
localVarQueryParameter['accountId'] = accountId;
|
|
136575
|
+
}
|
|
136576
|
+
|
|
136577
|
+
if (surveyId !== undefined) {
|
|
136578
|
+
localVarQueryParameter['surveyId'] = surveyId;
|
|
136579
|
+
}
|
|
136580
|
+
|
|
136581
|
+
if (sessionId !== undefined) {
|
|
136582
|
+
localVarQueryParameter['sessionId'] = sessionId;
|
|
136583
|
+
}
|
|
136584
|
+
|
|
136585
|
+
if (seriesId !== undefined) {
|
|
136586
|
+
localVarQueryParameter['seriesId'] = seriesId;
|
|
136587
|
+
}
|
|
136588
|
+
|
|
136589
|
+
if (spaceId !== undefined) {
|
|
136590
|
+
localVarQueryParameter['spaceId'] = spaceId;
|
|
136591
|
+
}
|
|
136592
|
+
|
|
136593
|
+
if (entityId !== undefined) {
|
|
136594
|
+
localVarQueryParameter['entityId'] = entityId;
|
|
136595
|
+
}
|
|
136596
|
+
|
|
136597
|
+
if (since !== undefined) {
|
|
136598
|
+
localVarQueryParameter['since'] = since;
|
|
136374
136599
|
}
|
|
136375
136600
|
|
|
136376
136601
|
if (page !== undefined) {
|
|
@@ -136404,11 +136629,21 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
136404
136629
|
* 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.
|
|
136405
136630
|
* @summary Run a standard report and fetch all its rows
|
|
136406
136631
|
* @param {string} standard The standard identifier
|
|
136407
|
-
* @param {
|
|
136632
|
+
* @param {string} [eventId] Filter by eventId
|
|
136633
|
+
* @param {string} [placeId] Filter by placeId
|
|
136634
|
+
* @param {string} [groupId] Filter by groupId
|
|
136635
|
+
* @param {string} [channelId] Filter by channelId
|
|
136636
|
+
* @param {string} [accountId] Filter by accountId
|
|
136637
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
136638
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
136639
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
136640
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
136641
|
+
* @param {string} [entityId] Filter by entityId
|
|
136642
|
+
* @param {string} [since] Filter by since
|
|
136408
136643
|
* @param {*} [options] Override http request option.
|
|
136409
136644
|
* @throws {RequiredError}
|
|
136410
136645
|
*/
|
|
136411
|
-
getReport: async (standard: string,
|
|
136646
|
+
getReport: async (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> => {
|
|
136412
136647
|
// verify required parameter 'standard' is not null or undefined
|
|
136413
136648
|
assertParamExists('getReport', 'standard', standard)
|
|
136414
136649
|
const localVarPath = `/reports/{standard}`
|
|
@@ -136430,10 +136665,48 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
136430
136665
|
// authentication OrganizationId required
|
|
136431
136666
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
136432
136667
|
|
|
136433
|
-
if (
|
|
136434
|
-
|
|
136435
|
-
|
|
136436
|
-
|
|
136668
|
+
if (eventId !== undefined) {
|
|
136669
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
136670
|
+
}
|
|
136671
|
+
|
|
136672
|
+
if (placeId !== undefined) {
|
|
136673
|
+
localVarQueryParameter['placeId'] = placeId;
|
|
136674
|
+
}
|
|
136675
|
+
|
|
136676
|
+
if (groupId !== undefined) {
|
|
136677
|
+
localVarQueryParameter['groupId'] = groupId;
|
|
136678
|
+
}
|
|
136679
|
+
|
|
136680
|
+
if (channelId !== undefined) {
|
|
136681
|
+
localVarQueryParameter['channelId'] = channelId;
|
|
136682
|
+
}
|
|
136683
|
+
|
|
136684
|
+
if (accountId !== undefined) {
|
|
136685
|
+
localVarQueryParameter['accountId'] = accountId;
|
|
136686
|
+
}
|
|
136687
|
+
|
|
136688
|
+
if (surveyId !== undefined) {
|
|
136689
|
+
localVarQueryParameter['surveyId'] = surveyId;
|
|
136690
|
+
}
|
|
136691
|
+
|
|
136692
|
+
if (sessionId !== undefined) {
|
|
136693
|
+
localVarQueryParameter['sessionId'] = sessionId;
|
|
136694
|
+
}
|
|
136695
|
+
|
|
136696
|
+
if (seriesId !== undefined) {
|
|
136697
|
+
localVarQueryParameter['seriesId'] = seriesId;
|
|
136698
|
+
}
|
|
136699
|
+
|
|
136700
|
+
if (spaceId !== undefined) {
|
|
136701
|
+
localVarQueryParameter['spaceId'] = spaceId;
|
|
136702
|
+
}
|
|
136703
|
+
|
|
136704
|
+
if (entityId !== undefined) {
|
|
136705
|
+
localVarQueryParameter['entityId'] = entityId;
|
|
136706
|
+
}
|
|
136707
|
+
|
|
136708
|
+
if (since !== undefined) {
|
|
136709
|
+
localVarQueryParameter['since'] = since;
|
|
136437
136710
|
}
|
|
136438
136711
|
|
|
136439
136712
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
@@ -136672,7 +136945,17 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
136672
136945
|
/**
|
|
136673
136946
|
* 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.
|
|
136674
136947
|
* @summary List an organization\'s custom reports
|
|
136675
|
-
* @param {
|
|
136948
|
+
* @param {string} [eventId] Filter by eventId
|
|
136949
|
+
* @param {string} [placeId] Filter by placeId
|
|
136950
|
+
* @param {string} [groupId] Filter by groupId
|
|
136951
|
+
* @param {string} [channelId] Filter by channelId
|
|
136952
|
+
* @param {string} [accountId] Filter by accountId
|
|
136953
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
136954
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
136955
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
136956
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
136957
|
+
* @param {string} [entityId] Filter by entityId
|
|
136958
|
+
* @param {string} [since] Filter by since
|
|
136676
136959
|
* @param {number} [page] Page number
|
|
136677
136960
|
* @param {number} [pageSize] Number of items per page
|
|
136678
136961
|
* @param {string} [orderBy] Field to order by
|
|
@@ -136680,8 +136963,8 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
136680
136963
|
* @param {*} [options] Override http request option.
|
|
136681
136964
|
* @throws {RequiredError}
|
|
136682
136965
|
*/
|
|
136683
|
-
async getCustomReports(
|
|
136684
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomReports(
|
|
136966
|
+
async 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>> {
|
|
136967
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomReports(eventId, placeId, groupId, channelId, accountId, surveyId, sessionId, seriesId, spaceId, entityId, since, page, pageSize, orderBy, search, options);
|
|
136685
136968
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
136686
136969
|
const localVarOperationServerBasePath = operationServerMap['ReportsApi.getCustomReports']?.[localVarOperationServerIndex]?.url;
|
|
136687
136970
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -136690,12 +136973,22 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
136690
136973
|
* 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.
|
|
136691
136974
|
* @summary Run a standard report and fetch all its rows
|
|
136692
136975
|
* @param {string} standard The standard identifier
|
|
136693
|
-
* @param {
|
|
136976
|
+
* @param {string} [eventId] Filter by eventId
|
|
136977
|
+
* @param {string} [placeId] Filter by placeId
|
|
136978
|
+
* @param {string} [groupId] Filter by groupId
|
|
136979
|
+
* @param {string} [channelId] Filter by channelId
|
|
136980
|
+
* @param {string} [accountId] Filter by accountId
|
|
136981
|
+
* @param {string} [surveyId] Filter by surveyId
|
|
136982
|
+
* @param {string} [sessionId] Filter by sessionId
|
|
136983
|
+
* @param {string} [seriesId] Filter by seriesId
|
|
136984
|
+
* @param {string} [spaceId] Filter by spaceId
|
|
136985
|
+
* @param {string} [entityId] Filter by entityId
|
|
136986
|
+
* @param {string} [since] Filter by since
|
|
136694
136987
|
* @param {*} [options] Override http request option.
|
|
136695
136988
|
* @throws {RequiredError}
|
|
136696
136989
|
*/
|
|
136697
|
-
async getReport(standard: string,
|
|
136698
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getReport(standard,
|
|
136990
|
+
async 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>> {
|
|
136991
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getReport(standard, eventId, placeId, groupId, channelId, accountId, surveyId, sessionId, seriesId, spaceId, entityId, since, options);
|
|
136699
136992
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
136700
136993
|
const localVarOperationServerBasePath = operationServerMap['ReportsApi.getReport']?.[localVarOperationServerIndex]?.url;
|
|
136701
136994
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -136818,7 +137111,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
136818
137111
|
* @throws {RequiredError}
|
|
136819
137112
|
*/
|
|
136820
137113
|
getCustomReports(requestParameters: ReportsApiGetCustomReportsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomReports200Response> {
|
|
136821
|
-
return localVarFp.getCustomReports(requestParameters.
|
|
137114
|
+
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));
|
|
136822
137115
|
},
|
|
136823
137116
|
/**
|
|
136824
137117
|
* 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.
|
|
@@ -136828,7 +137121,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
136828
137121
|
* @throws {RequiredError}
|
|
136829
137122
|
*/
|
|
136830
137123
|
getReport(requestParameters: ReportsApiGetReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetReport200Response> {
|
|
136831
|
-
return localVarFp.getReport(requestParameters.standard, requestParameters.
|
|
137124
|
+
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));
|
|
136832
137125
|
},
|
|
136833
137126
|
/**
|
|
136834
137127
|
* 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.
|
|
@@ -136932,9 +137225,59 @@ export interface ReportsApiGetCustomReportScheduleRequest {
|
|
|
136932
137225
|
*/
|
|
136933
137226
|
export interface ReportsApiGetCustomReportsRequest {
|
|
136934
137227
|
/**
|
|
136935
|
-
* Filter by
|
|
137228
|
+
* Filter by eventId
|
|
137229
|
+
*/
|
|
137230
|
+
readonly eventId?: string
|
|
137231
|
+
|
|
137232
|
+
/**
|
|
137233
|
+
* Filter by placeId
|
|
137234
|
+
*/
|
|
137235
|
+
readonly placeId?: string
|
|
137236
|
+
|
|
137237
|
+
/**
|
|
137238
|
+
* Filter by groupId
|
|
137239
|
+
*/
|
|
137240
|
+
readonly groupId?: string
|
|
137241
|
+
|
|
137242
|
+
/**
|
|
137243
|
+
* Filter by channelId
|
|
137244
|
+
*/
|
|
137245
|
+
readonly channelId?: string
|
|
137246
|
+
|
|
137247
|
+
/**
|
|
137248
|
+
* Filter by accountId
|
|
137249
|
+
*/
|
|
137250
|
+
readonly accountId?: string
|
|
137251
|
+
|
|
137252
|
+
/**
|
|
137253
|
+
* Filter by surveyId
|
|
136936
137254
|
*/
|
|
136937
|
-
readonly
|
|
137255
|
+
readonly surveyId?: string
|
|
137256
|
+
|
|
137257
|
+
/**
|
|
137258
|
+
* Filter by sessionId
|
|
137259
|
+
*/
|
|
137260
|
+
readonly sessionId?: string
|
|
137261
|
+
|
|
137262
|
+
/**
|
|
137263
|
+
* Filter by seriesId
|
|
137264
|
+
*/
|
|
137265
|
+
readonly seriesId?: string
|
|
137266
|
+
|
|
137267
|
+
/**
|
|
137268
|
+
* Filter by spaceId
|
|
137269
|
+
*/
|
|
137270
|
+
readonly spaceId?: string
|
|
137271
|
+
|
|
137272
|
+
/**
|
|
137273
|
+
* Filter by entityId
|
|
137274
|
+
*/
|
|
137275
|
+
readonly entityId?: string
|
|
137276
|
+
|
|
137277
|
+
/**
|
|
137278
|
+
* Filter by since
|
|
137279
|
+
*/
|
|
137280
|
+
readonly since?: string
|
|
136938
137281
|
|
|
136939
137282
|
/**
|
|
136940
137283
|
* Page number
|
|
@@ -136967,9 +137310,59 @@ export interface ReportsApiGetReportRequest {
|
|
|
136967
137310
|
readonly standard: string
|
|
136968
137311
|
|
|
136969
137312
|
/**
|
|
136970
|
-
* Filter by
|
|
137313
|
+
* Filter by eventId
|
|
137314
|
+
*/
|
|
137315
|
+
readonly eventId?: string
|
|
137316
|
+
|
|
137317
|
+
/**
|
|
137318
|
+
* Filter by placeId
|
|
137319
|
+
*/
|
|
137320
|
+
readonly placeId?: string
|
|
137321
|
+
|
|
137322
|
+
/**
|
|
137323
|
+
* Filter by groupId
|
|
137324
|
+
*/
|
|
137325
|
+
readonly groupId?: string
|
|
137326
|
+
|
|
137327
|
+
/**
|
|
137328
|
+
* Filter by channelId
|
|
137329
|
+
*/
|
|
137330
|
+
readonly channelId?: string
|
|
137331
|
+
|
|
137332
|
+
/**
|
|
137333
|
+
* Filter by accountId
|
|
137334
|
+
*/
|
|
137335
|
+
readonly accountId?: string
|
|
137336
|
+
|
|
137337
|
+
/**
|
|
137338
|
+
* Filter by surveyId
|
|
137339
|
+
*/
|
|
137340
|
+
readonly surveyId?: string
|
|
137341
|
+
|
|
137342
|
+
/**
|
|
137343
|
+
* Filter by sessionId
|
|
137344
|
+
*/
|
|
137345
|
+
readonly sessionId?: string
|
|
137346
|
+
|
|
137347
|
+
/**
|
|
137348
|
+
* Filter by seriesId
|
|
137349
|
+
*/
|
|
137350
|
+
readonly seriesId?: string
|
|
137351
|
+
|
|
137352
|
+
/**
|
|
137353
|
+
* Filter by spaceId
|
|
137354
|
+
*/
|
|
137355
|
+
readonly spaceId?: string
|
|
137356
|
+
|
|
137357
|
+
/**
|
|
137358
|
+
* Filter by entityId
|
|
137359
|
+
*/
|
|
137360
|
+
readonly entityId?: string
|
|
137361
|
+
|
|
137362
|
+
/**
|
|
137363
|
+
* Filter by since
|
|
136971
137364
|
*/
|
|
136972
|
-
readonly
|
|
137365
|
+
readonly since?: string
|
|
136973
137366
|
}
|
|
136974
137367
|
|
|
136975
137368
|
/**
|
|
@@ -137084,7 +137477,7 @@ export class ReportsApi extends BaseAPI {
|
|
|
137084
137477
|
* @throws {RequiredError}
|
|
137085
137478
|
*/
|
|
137086
137479
|
public getCustomReports(requestParameters: ReportsApiGetCustomReportsRequest = {}, options?: RawAxiosRequestConfig) {
|
|
137087
|
-
return ReportsApiFp(this.configuration).getCustomReports(requestParameters.
|
|
137480
|
+
return 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));
|
|
137088
137481
|
}
|
|
137089
137482
|
|
|
137090
137483
|
/**
|
|
@@ -137095,7 +137488,7 @@ export class ReportsApi extends BaseAPI {
|
|
|
137095
137488
|
* @throws {RequiredError}
|
|
137096
137489
|
*/
|
|
137097
137490
|
public getReport(requestParameters: ReportsApiGetReportRequest, options?: RawAxiosRequestConfig) {
|
|
137098
|
-
return ReportsApiFp(this.configuration).getReport(requestParameters.standard, requestParameters.
|
|
137491
|
+
return 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));
|
|
137099
137492
|
}
|
|
137100
137493
|
|
|
137101
137494
|
/**
|