@connectedxm/admin-sdk 13.1.0 → 13.2.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 +4 -0
- package/README.md +2 -2
- package/api.ts +214 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +115 -1
- package/dist/api.js +183 -29
- 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 +115 -1
- package/dist/esm/api.js +155 -1
- 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/BaseReportExport.md +22 -0
- package/docs/DownloadReport200Response.md +24 -0
- package/docs/GetReportExport200Response.md +24 -0
- package/docs/ReportExport.md +32 -0
- package/docs/ReportsApi.md +108 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -266,6 +266,7 @@ docs/BaseRegistrationQuestionResponseChange.md
|
|
|
266
266
|
docs/BaseRegistrationSection.md
|
|
267
267
|
docs/BaseRegistrationSectionCount.md
|
|
268
268
|
docs/BaseRegistrationSectionQuestion.md
|
|
269
|
+
docs/BaseReportExport.md
|
|
269
270
|
docs/BaseRoom.md
|
|
270
271
|
docs/BaseRound.md
|
|
271
272
|
docs/BaseRoundEvent.md
|
|
@@ -532,6 +533,7 @@ docs/DeleteManyImagesInput.md
|
|
|
532
533
|
docs/DeleteManyVideosInput.md
|
|
533
534
|
docs/DenyEventPassRequest.md
|
|
534
535
|
docs/DomainDetails.md
|
|
536
|
+
docs/DownloadReport200Response.md
|
|
535
537
|
docs/EmailCodeAuth.md
|
|
536
538
|
docs/EmailReceipt.md
|
|
537
539
|
docs/EmailReceiptStatus.md
|
|
@@ -1081,6 +1083,7 @@ docs/GetPreferences200Response.md
|
|
|
1081
1083
|
docs/GetPresets200Response.md
|
|
1082
1084
|
docs/GetPushDevice200Response.md
|
|
1083
1085
|
docs/GetReport200Response.md
|
|
1086
|
+
docs/GetReportExport200Response.md
|
|
1084
1087
|
docs/GetReports200Response.md
|
|
1085
1088
|
docs/GetRoomTypeRooms200Response.md
|
|
1086
1089
|
docs/GetSearchListConnectedQuestions200Response.md
|
|
@@ -1431,6 +1434,7 @@ docs/ReorderSurveyQuestionChoices200Response.md
|
|
|
1431
1434
|
docs/ReorderSurveyQuestionMatrixRows200Response.md
|
|
1432
1435
|
docs/ReorderSurveyQuestionMatrixRowsRequest.md
|
|
1433
1436
|
docs/ReorderSurveySectionQuestions200Response.md
|
|
1437
|
+
docs/ReportExport.md
|
|
1434
1438
|
docs/ReportFilters.md
|
|
1435
1439
|
docs/ReportType.md
|
|
1436
1440
|
docs/ReportsApi.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@13.
|
|
1
|
+
## @connectedxm/admin-sdk@13.2.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@13.
|
|
39
|
+
npm install @connectedxm/admin-sdk@13.2.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
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: 13.
|
|
7
|
+
* The version of the OpenAPI document: 13.2.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2797,6 +2797,12 @@ export interface BaseRegistrationSectionQuestion {
|
|
|
2797
2797
|
'question': BaseRegistrationQuestion;
|
|
2798
2798
|
'sortOrder': number;
|
|
2799
2799
|
}
|
|
2800
|
+
export interface BaseReportExport {
|
|
2801
|
+
'id': string;
|
|
2802
|
+
'status': ExportStatus;
|
|
2803
|
+
}
|
|
2804
|
+
|
|
2805
|
+
|
|
2800
2806
|
export interface BaseRoom {
|
|
2801
2807
|
'id': string;
|
|
2802
2808
|
'roomName': string;
|
|
@@ -5372,6 +5378,16 @@ export interface DenyEventPassRequest {
|
|
|
5372
5378
|
export interface DomainDetails {
|
|
5373
5379
|
'name': string;
|
|
5374
5380
|
}
|
|
5381
|
+
export interface DownloadReport200Response {
|
|
5382
|
+
'status': DownloadReport200ResponseStatusEnum;
|
|
5383
|
+
'message': string;
|
|
5384
|
+
'data': BaseReportExport;
|
|
5385
|
+
}
|
|
5386
|
+
|
|
5387
|
+
export enum DownloadReport200ResponseStatusEnum {
|
|
5388
|
+
Ok = 'ok'
|
|
5389
|
+
}
|
|
5390
|
+
|
|
5375
5391
|
|
|
5376
5392
|
export enum EmailCodeAuth {
|
|
5377
5393
|
Disabled = 'disabled',
|
|
@@ -10514,6 +10530,16 @@ export enum GetReport200ResponseStatusEnum {
|
|
|
10514
10530
|
Ok = 'ok'
|
|
10515
10531
|
}
|
|
10516
10532
|
|
|
10533
|
+
export interface GetReportExport200Response {
|
|
10534
|
+
'status': GetReportExport200ResponseStatusEnum;
|
|
10535
|
+
'message': string;
|
|
10536
|
+
'data': ReportExport;
|
|
10537
|
+
}
|
|
10538
|
+
|
|
10539
|
+
export enum GetReportExport200ResponseStatusEnum {
|
|
10540
|
+
Ok = 'ok'
|
|
10541
|
+
}
|
|
10542
|
+
|
|
10517
10543
|
export interface GetReports200Response {
|
|
10518
10544
|
'status': GetReports200ResponseStatusEnum;
|
|
10519
10545
|
'message': string;
|
|
@@ -13917,6 +13943,17 @@ export enum ReorderSurveySectionQuestions200ResponseStatusEnum {
|
|
|
13917
13943
|
Ok = 'ok'
|
|
13918
13944
|
}
|
|
13919
13945
|
|
|
13946
|
+
export interface ReportExport {
|
|
13947
|
+
'id': string;
|
|
13948
|
+
'status': ExportStatus;
|
|
13949
|
+
'standard': string;
|
|
13950
|
+
'message': string | null;
|
|
13951
|
+
'downloadUrl': string | null;
|
|
13952
|
+
'expiration': string | null;
|
|
13953
|
+
'createdAt': string;
|
|
13954
|
+
}
|
|
13955
|
+
|
|
13956
|
+
|
|
13920
13957
|
export interface ReportFilters {
|
|
13921
13958
|
'eventId'?: string;
|
|
13922
13959
|
'placeId'?: string;
|
|
@@ -136416,6 +136453,51 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
136416
136453
|
options: localVarRequestOptions,
|
|
136417
136454
|
};
|
|
136418
136455
|
},
|
|
136456
|
+
/**
|
|
136457
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
136458
|
+
* @summary Build a standard report as a downloadable CSV
|
|
136459
|
+
* @param {string} standard The standard identifier
|
|
136460
|
+
* @param {ReportFilters} reportFilters
|
|
136461
|
+
* @param {*} [options] Override http request option.
|
|
136462
|
+
* @throws {RequiredError}
|
|
136463
|
+
*/
|
|
136464
|
+
downloadReport: async (standard: string, reportFilters: ReportFilters, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
136465
|
+
// verify required parameter 'standard' is not null or undefined
|
|
136466
|
+
assertParamExists('downloadReport', 'standard', standard)
|
|
136467
|
+
// verify required parameter 'reportFilters' is not null or undefined
|
|
136468
|
+
assertParamExists('downloadReport', 'reportFilters', reportFilters)
|
|
136469
|
+
const localVarPath = `/reports/{standard}/download`
|
|
136470
|
+
.replace('{standard}', encodeURIComponent(String(standard)));
|
|
136471
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
136472
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
136473
|
+
let baseOptions;
|
|
136474
|
+
if (configuration) {
|
|
136475
|
+
baseOptions = configuration.baseOptions;
|
|
136476
|
+
}
|
|
136477
|
+
|
|
136478
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
136479
|
+
const localVarHeaderParameter = {} as any;
|
|
136480
|
+
const localVarQueryParameter = {} as any;
|
|
136481
|
+
|
|
136482
|
+
// authentication ApiKeyAuth required
|
|
136483
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
136484
|
+
|
|
136485
|
+
// authentication OrganizationId required
|
|
136486
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
136487
|
+
|
|
136488
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
136489
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
136490
|
+
|
|
136491
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
136492
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
136493
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
136494
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reportFilters, localVarRequestOptions, configuration)
|
|
136495
|
+
|
|
136496
|
+
return {
|
|
136497
|
+
url: toPathString(localVarUrlObj),
|
|
136498
|
+
options: localVarRequestOptions,
|
|
136499
|
+
};
|
|
136500
|
+
},
|
|
136419
136501
|
/**
|
|
136420
136502
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
136421
136503
|
* @summary Export a custom report
|
|
@@ -136747,6 +136829,46 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
136747
136829
|
options: localVarRequestOptions,
|
|
136748
136830
|
};
|
|
136749
136831
|
},
|
|
136832
|
+
/**
|
|
136833
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
136834
|
+
* @summary Get the status of a report download
|
|
136835
|
+
* @param {string} exportId The export identifier
|
|
136836
|
+
* @param {*} [options] Override http request option.
|
|
136837
|
+
* @throws {RequiredError}
|
|
136838
|
+
*/
|
|
136839
|
+
getReportExport: async (exportId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
136840
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
136841
|
+
assertParamExists('getReportExport', 'exportId', exportId)
|
|
136842
|
+
const localVarPath = `/reports/exports/{exportId}`
|
|
136843
|
+
.replace('{exportId}', encodeURIComponent(String(exportId)));
|
|
136844
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
136845
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
136846
|
+
let baseOptions;
|
|
136847
|
+
if (configuration) {
|
|
136848
|
+
baseOptions = configuration.baseOptions;
|
|
136849
|
+
}
|
|
136850
|
+
|
|
136851
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
136852
|
+
const localVarHeaderParameter = {} as any;
|
|
136853
|
+
const localVarQueryParameter = {} as any;
|
|
136854
|
+
|
|
136855
|
+
// authentication ApiKeyAuth required
|
|
136856
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
136857
|
+
|
|
136858
|
+
// authentication OrganizationId required
|
|
136859
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
136860
|
+
|
|
136861
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
136862
|
+
|
|
136863
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
136864
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
136865
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
136866
|
+
|
|
136867
|
+
return {
|
|
136868
|
+
url: toPathString(localVarUrlObj),
|
|
136869
|
+
options: localVarRequestOptions,
|
|
136870
|
+
};
|
|
136871
|
+
},
|
|
136750
136872
|
/**
|
|
136751
136873
|
* 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.
|
|
136752
136874
|
* @summary List available standard reports
|
|
@@ -136929,6 +137051,20 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
136929
137051
|
const localVarOperationServerBasePath = operationServerMap['ReportsApi.deleteCustomReportSchedule']?.[localVarOperationServerIndex]?.url;
|
|
136930
137052
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
136931
137053
|
},
|
|
137054
|
+
/**
|
|
137055
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
137056
|
+
* @summary Build a standard report as a downloadable CSV
|
|
137057
|
+
* @param {string} standard The standard identifier
|
|
137058
|
+
* @param {ReportFilters} reportFilters
|
|
137059
|
+
* @param {*} [options] Override http request option.
|
|
137060
|
+
* @throws {RequiredError}
|
|
137061
|
+
*/
|
|
137062
|
+
async downloadReport(standard: string, reportFilters: ReportFilters, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadReport200Response>> {
|
|
137063
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadReport(standard, reportFilters, options);
|
|
137064
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
137065
|
+
const localVarOperationServerBasePath = operationServerMap['ReportsApi.downloadReport']?.[localVarOperationServerIndex]?.url;
|
|
137066
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
137067
|
+
},
|
|
136932
137068
|
/**
|
|
136933
137069
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
136934
137070
|
* @summary Export a custom report
|
|
@@ -137020,6 +137156,19 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
137020
137156
|
const localVarOperationServerBasePath = operationServerMap['ReportsApi.getReport']?.[localVarOperationServerIndex]?.url;
|
|
137021
137157
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
137022
137158
|
},
|
|
137159
|
+
/**
|
|
137160
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
137161
|
+
* @summary Get the status of a report download
|
|
137162
|
+
* @param {string} exportId The export identifier
|
|
137163
|
+
* @param {*} [options] Override http request option.
|
|
137164
|
+
* @throws {RequiredError}
|
|
137165
|
+
*/
|
|
137166
|
+
async getReportExport(exportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReportExport200Response>> {
|
|
137167
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getReportExport(exportId, options);
|
|
137168
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
137169
|
+
const localVarOperationServerBasePath = operationServerMap['ReportsApi.getReportExport']?.[localVarOperationServerIndex]?.url;
|
|
137170
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
137171
|
+
},
|
|
137023
137172
|
/**
|
|
137024
137173
|
* 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.
|
|
137025
137174
|
* @summary List available standard reports
|
|
@@ -137100,6 +137249,16 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
137100
137249
|
deleteCustomReportSchedule(requestParameters: ReportsApiDeleteCustomReportScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomReportSchedule200Response> {
|
|
137101
137250
|
return localVarFp.deleteCustomReportSchedule(requestParameters.reportId, options).then((request) => request(axios, basePath));
|
|
137102
137251
|
},
|
|
137252
|
+
/**
|
|
137253
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
137254
|
+
* @summary Build a standard report as a downloadable CSV
|
|
137255
|
+
* @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
|
|
137256
|
+
* @param {*} [options] Override http request option.
|
|
137257
|
+
* @throws {RequiredError}
|
|
137258
|
+
*/
|
|
137259
|
+
downloadReport(requestParameters: ReportsApiDownloadReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<DownloadReport200Response> {
|
|
137260
|
+
return localVarFp.downloadReport(requestParameters.standard, requestParameters.reportFilters, options).then((request) => request(axios, basePath));
|
|
137261
|
+
},
|
|
137103
137262
|
/**
|
|
137104
137263
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
137105
137264
|
* @summary Export a custom report
|
|
@@ -137150,6 +137309,16 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
137150
137309
|
getReport(requestParameters: ReportsApiGetReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetReport200Response> {
|
|
137151
137310
|
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));
|
|
137152
137311
|
},
|
|
137312
|
+
/**
|
|
137313
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
137314
|
+
* @summary Get the status of a report download
|
|
137315
|
+
* @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
|
|
137316
|
+
* @param {*} [options] Override http request option.
|
|
137317
|
+
* @throws {RequiredError}
|
|
137318
|
+
*/
|
|
137319
|
+
getReportExport(requestParameters: ReportsApiGetReportExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetReportExport200Response> {
|
|
137320
|
+
return localVarFp.getReportExport(requestParameters.exportId, options).then((request) => request(axios, basePath));
|
|
137321
|
+
},
|
|
137153
137322
|
/**
|
|
137154
137323
|
* 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.
|
|
137155
137324
|
* @summary List available standard reports
|
|
@@ -137215,6 +137384,18 @@ export interface ReportsApiDeleteCustomReportScheduleRequest {
|
|
|
137215
137384
|
readonly reportId: string
|
|
137216
137385
|
}
|
|
137217
137386
|
|
|
137387
|
+
/**
|
|
137388
|
+
* Request parameters for downloadReport operation in ReportsApi.
|
|
137389
|
+
*/
|
|
137390
|
+
export interface ReportsApiDownloadReportRequest {
|
|
137391
|
+
/**
|
|
137392
|
+
* The standard identifier
|
|
137393
|
+
*/
|
|
137394
|
+
readonly standard: string
|
|
137395
|
+
|
|
137396
|
+
readonly reportFilters: ReportFilters
|
|
137397
|
+
}
|
|
137398
|
+
|
|
137218
137399
|
/**
|
|
137219
137400
|
* Request parameters for exportCustomReport operation in ReportsApi.
|
|
137220
137401
|
*/
|
|
@@ -137392,6 +137573,16 @@ export interface ReportsApiGetReportRequest {
|
|
|
137392
137573
|
readonly since?: string
|
|
137393
137574
|
}
|
|
137394
137575
|
|
|
137576
|
+
/**
|
|
137577
|
+
* Request parameters for getReportExport operation in ReportsApi.
|
|
137578
|
+
*/
|
|
137579
|
+
export interface ReportsApiGetReportExportRequest {
|
|
137580
|
+
/**
|
|
137581
|
+
* The export identifier
|
|
137582
|
+
*/
|
|
137583
|
+
readonly exportId: string
|
|
137584
|
+
}
|
|
137585
|
+
|
|
137395
137586
|
/**
|
|
137396
137587
|
* Request parameters for getReports operation in ReportsApi.
|
|
137397
137588
|
*/
|
|
@@ -137463,6 +137654,17 @@ export class ReportsApi extends BaseAPI {
|
|
|
137463
137654
|
return ReportsApiFp(this.configuration).deleteCustomReportSchedule(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
|
|
137464
137655
|
}
|
|
137465
137656
|
|
|
137657
|
+
/**
|
|
137658
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
137659
|
+
* @summary Build a standard report as a downloadable CSV
|
|
137660
|
+
* @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
|
|
137661
|
+
* @param {*} [options] Override http request option.
|
|
137662
|
+
* @throws {RequiredError}
|
|
137663
|
+
*/
|
|
137664
|
+
public downloadReport(requestParameters: ReportsApiDownloadReportRequest, options?: RawAxiosRequestConfig) {
|
|
137665
|
+
return ReportsApiFp(this.configuration).downloadReport(requestParameters.standard, requestParameters.reportFilters, options).then((request) => request(this.axios, this.basePath));
|
|
137666
|
+
}
|
|
137667
|
+
|
|
137466
137668
|
/**
|
|
137467
137669
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
137468
137670
|
* @summary Export a custom report
|
|
@@ -137518,6 +137720,17 @@ export class ReportsApi extends BaseAPI {
|
|
|
137518
137720
|
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));
|
|
137519
137721
|
}
|
|
137520
137722
|
|
|
137723
|
+
/**
|
|
137724
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
137725
|
+
* @summary Get the status of a report download
|
|
137726
|
+
* @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
|
|
137727
|
+
* @param {*} [options] Override http request option.
|
|
137728
|
+
* @throws {RequiredError}
|
|
137729
|
+
*/
|
|
137730
|
+
public getReportExport(requestParameters: ReportsApiGetReportExportRequest, options?: RawAxiosRequestConfig) {
|
|
137731
|
+
return ReportsApiFp(this.configuration).getReportExport(requestParameters.exportId, options).then((request) => request(this.axios, this.basePath));
|
|
137732
|
+
}
|
|
137733
|
+
|
|
137521
137734
|
/**
|
|
137522
137735
|
* 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.
|
|
137523
137736
|
* @summary List available standard reports
|
package/base.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: 13.
|
|
7
|
+
* The version of the OpenAPI document: 13.2.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.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: 13.
|
|
7
|
+
* The version of the OpenAPI document: 13.2.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 13.
|
|
6
|
+
* The version of the OpenAPI document: 13.2.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 13.
|
|
5
|
+
* The version of the OpenAPI document: 13.2.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2580,6 +2580,10 @@ export interface BaseRegistrationSectionQuestion {
|
|
|
2580
2580
|
'question': BaseRegistrationQuestion;
|
|
2581
2581
|
'sortOrder': number;
|
|
2582
2582
|
}
|
|
2583
|
+
export interface BaseReportExport {
|
|
2584
|
+
'id': string;
|
|
2585
|
+
'status': ExportStatus;
|
|
2586
|
+
}
|
|
2583
2587
|
export interface BaseRoom {
|
|
2584
2588
|
'id': string;
|
|
2585
2589
|
'roomName': string;
|
|
@@ -4872,6 +4876,14 @@ export interface DenyEventPassRequest {
|
|
|
4872
4876
|
export interface DomainDetails {
|
|
4873
4877
|
'name': string;
|
|
4874
4878
|
}
|
|
4879
|
+
export interface DownloadReport200Response {
|
|
4880
|
+
'status': DownloadReport200ResponseStatusEnum;
|
|
4881
|
+
'message': string;
|
|
4882
|
+
'data': BaseReportExport;
|
|
4883
|
+
}
|
|
4884
|
+
export declare enum DownloadReport200ResponseStatusEnum {
|
|
4885
|
+
Ok = "ok"
|
|
4886
|
+
}
|
|
4875
4887
|
export declare enum EmailCodeAuth {
|
|
4876
4888
|
Disabled = "disabled",
|
|
4877
4889
|
Optional = "optional",
|
|
@@ -9335,6 +9347,14 @@ export interface GetReport200Response {
|
|
|
9335
9347
|
export declare enum GetReport200ResponseStatusEnum {
|
|
9336
9348
|
Ok = "ok"
|
|
9337
9349
|
}
|
|
9350
|
+
export interface GetReportExport200Response {
|
|
9351
|
+
'status': GetReportExport200ResponseStatusEnum;
|
|
9352
|
+
'message': string;
|
|
9353
|
+
'data': ReportExport;
|
|
9354
|
+
}
|
|
9355
|
+
export declare enum GetReportExport200ResponseStatusEnum {
|
|
9356
|
+
Ok = "ok"
|
|
9357
|
+
}
|
|
9338
9358
|
export interface GetReports200Response {
|
|
9339
9359
|
'status': GetReports200ResponseStatusEnum;
|
|
9340
9360
|
'message': string;
|
|
@@ -12354,6 +12374,15 @@ export interface ReorderSurveySectionQuestions200Response {
|
|
|
12354
12374
|
export declare enum ReorderSurveySectionQuestions200ResponseStatusEnum {
|
|
12355
12375
|
Ok = "ok"
|
|
12356
12376
|
}
|
|
12377
|
+
export interface ReportExport {
|
|
12378
|
+
'id': string;
|
|
12379
|
+
'status': ExportStatus;
|
|
12380
|
+
'standard': string;
|
|
12381
|
+
'message': string | null;
|
|
12382
|
+
'downloadUrl': string | null;
|
|
12383
|
+
'expiration': string | null;
|
|
12384
|
+
'createdAt': string;
|
|
12385
|
+
}
|
|
12357
12386
|
export interface ReportFilters {
|
|
12358
12387
|
'eventId'?: string;
|
|
12359
12388
|
'placeId'?: string;
|
|
@@ -75182,6 +75211,15 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
75182
75211
|
* @throws {RequiredError}
|
|
75183
75212
|
*/
|
|
75184
75213
|
deleteCustomReportSchedule: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75214
|
+
/**
|
|
75215
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75216
|
+
* @summary Build a standard report as a downloadable CSV
|
|
75217
|
+
* @param {string} standard The standard identifier
|
|
75218
|
+
* @param {ReportFilters} reportFilters
|
|
75219
|
+
* @param {*} [options] Override http request option.
|
|
75220
|
+
* @throws {RequiredError}
|
|
75221
|
+
*/
|
|
75222
|
+
downloadReport: (standard: string, reportFilters: ReportFilters, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75185
75223
|
/**
|
|
75186
75224
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
75187
75225
|
* @summary Export a custom report
|
|
@@ -75248,6 +75286,14 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
75248
75286
|
* @throws {RequiredError}
|
|
75249
75287
|
*/
|
|
75250
75288
|
getReport: (standard: string, eventId?: string, placeId?: string, groupId?: string, channelId?: string, accountId?: string, surveyId?: string, sessionId?: string, seriesId?: string, spaceId?: string, entityId?: string, since?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75289
|
+
/**
|
|
75290
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75291
|
+
* @summary Get the status of a report download
|
|
75292
|
+
* @param {string} exportId The export identifier
|
|
75293
|
+
* @param {*} [options] Override http request option.
|
|
75294
|
+
* @throws {RequiredError}
|
|
75295
|
+
*/
|
|
75296
|
+
getReportExport: (exportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75251
75297
|
/**
|
|
75252
75298
|
* 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.
|
|
75253
75299
|
* @summary List available standard reports
|
|
@@ -75304,6 +75350,15 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
75304
75350
|
* @throws {RequiredError}
|
|
75305
75351
|
*/
|
|
75306
75352
|
deleteCustomReportSchedule(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomReportSchedule200Response>>;
|
|
75353
|
+
/**
|
|
75354
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75355
|
+
* @summary Build a standard report as a downloadable CSV
|
|
75356
|
+
* @param {string} standard The standard identifier
|
|
75357
|
+
* @param {ReportFilters} reportFilters
|
|
75358
|
+
* @param {*} [options] Override http request option.
|
|
75359
|
+
* @throws {RequiredError}
|
|
75360
|
+
*/
|
|
75361
|
+
downloadReport(standard: string, reportFilters: ReportFilters, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadReport200Response>>;
|
|
75307
75362
|
/**
|
|
75308
75363
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
75309
75364
|
* @summary Export a custom report
|
|
@@ -75370,6 +75425,14 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
75370
75425
|
* @throws {RequiredError}
|
|
75371
75426
|
*/
|
|
75372
75427
|
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>>;
|
|
75428
|
+
/**
|
|
75429
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75430
|
+
* @summary Get the status of a report download
|
|
75431
|
+
* @param {string} exportId The export identifier
|
|
75432
|
+
* @param {*} [options] Override http request option.
|
|
75433
|
+
* @throws {RequiredError}
|
|
75434
|
+
*/
|
|
75435
|
+
getReportExport(exportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReportExport200Response>>;
|
|
75373
75436
|
/**
|
|
75374
75437
|
* 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.
|
|
75375
75438
|
* @summary List available standard reports
|
|
@@ -75425,6 +75488,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
|
|
|
75425
75488
|
* @throws {RequiredError}
|
|
75426
75489
|
*/
|
|
75427
75490
|
deleteCustomReportSchedule(requestParameters: ReportsApiDeleteCustomReportScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomReportSchedule200Response>;
|
|
75491
|
+
/**
|
|
75492
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75493
|
+
* @summary Build a standard report as a downloadable CSV
|
|
75494
|
+
* @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
|
|
75495
|
+
* @param {*} [options] Override http request option.
|
|
75496
|
+
* @throws {RequiredError}
|
|
75497
|
+
*/
|
|
75498
|
+
downloadReport(requestParameters: ReportsApiDownloadReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<DownloadReport200Response>;
|
|
75428
75499
|
/**
|
|
75429
75500
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
75430
75501
|
* @summary Export a custom report
|
|
@@ -75465,6 +75536,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
|
|
|
75465
75536
|
* @throws {RequiredError}
|
|
75466
75537
|
*/
|
|
75467
75538
|
getReport(requestParameters: ReportsApiGetReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetReport200Response>;
|
|
75539
|
+
/**
|
|
75540
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75541
|
+
* @summary Get the status of a report download
|
|
75542
|
+
* @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
|
|
75543
|
+
* @param {*} [options] Override http request option.
|
|
75544
|
+
* @throws {RequiredError}
|
|
75545
|
+
*/
|
|
75546
|
+
getReportExport(requestParameters: ReportsApiGetReportExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetReportExport200Response>;
|
|
75468
75547
|
/**
|
|
75469
75548
|
* 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.
|
|
75470
75549
|
* @summary List available standard reports
|
|
@@ -75518,6 +75597,16 @@ export interface ReportsApiDeleteCustomReportScheduleRequest {
|
|
|
75518
75597
|
*/
|
|
75519
75598
|
readonly reportId: string;
|
|
75520
75599
|
}
|
|
75600
|
+
/**
|
|
75601
|
+
* Request parameters for downloadReport operation in ReportsApi.
|
|
75602
|
+
*/
|
|
75603
|
+
export interface ReportsApiDownloadReportRequest {
|
|
75604
|
+
/**
|
|
75605
|
+
* The standard identifier
|
|
75606
|
+
*/
|
|
75607
|
+
readonly standard: string;
|
|
75608
|
+
readonly reportFilters: ReportFilters;
|
|
75609
|
+
}
|
|
75521
75610
|
/**
|
|
75522
75611
|
* Request parameters for exportCustomReport operation in ReportsApi.
|
|
75523
75612
|
*/
|
|
@@ -75664,6 +75753,15 @@ export interface ReportsApiGetReportRequest {
|
|
|
75664
75753
|
*/
|
|
75665
75754
|
readonly since?: string;
|
|
75666
75755
|
}
|
|
75756
|
+
/**
|
|
75757
|
+
* Request parameters for getReportExport operation in ReportsApi.
|
|
75758
|
+
*/
|
|
75759
|
+
export interface ReportsApiGetReportExportRequest {
|
|
75760
|
+
/**
|
|
75761
|
+
* The export identifier
|
|
75762
|
+
*/
|
|
75763
|
+
readonly exportId: string;
|
|
75764
|
+
}
|
|
75667
75765
|
/**
|
|
75668
75766
|
* Request parameters for getReports operation in ReportsApi.
|
|
75669
75767
|
*/
|
|
@@ -75721,6 +75819,14 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
75721
75819
|
* @throws {RequiredError}
|
|
75722
75820
|
*/
|
|
75723
75821
|
deleteCustomReportSchedule(requestParameters: ReportsApiDeleteCustomReportScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomReportSchedule200Response, any, {}, any>>;
|
|
75822
|
+
/**
|
|
75823
|
+
* Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75824
|
+
* @summary Build a standard report as a downloadable CSV
|
|
75825
|
+
* @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
|
|
75826
|
+
* @param {*} [options] Override http request option.
|
|
75827
|
+
* @throws {RequiredError}
|
|
75828
|
+
*/
|
|
75829
|
+
downloadReport(requestParameters: ReportsApiDownloadReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadReport200Response, any, {}, any>>;
|
|
75724
75830
|
/**
|
|
75725
75831
|
* Kicks off an asynchronous export of a custom report\'s data, optionally emailing the resulting file to a specified address in addition to the requesting user, and requires read permission on the reports domain plus any domains associated with the report\'s standard type.
|
|
75726
75832
|
* @summary Export a custom report
|
|
@@ -75761,6 +75867,14 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
75761
75867
|
* @throws {RequiredError}
|
|
75762
75868
|
*/
|
|
75763
75869
|
getReport(requestParameters: ReportsApiGetReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReport200Response, any, {}, any>>;
|
|
75870
|
+
/**
|
|
75871
|
+
* Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
|
|
75872
|
+
* @summary Get the status of a report download
|
|
75873
|
+
* @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
|
|
75874
|
+
* @param {*} [options] Override http request option.
|
|
75875
|
+
* @throws {RequiredError}
|
|
75876
|
+
*/
|
|
75877
|
+
getReportExport(requestParameters: ReportsApiGetReportExportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReportExport200Response, any, {}, any>>;
|
|
75764
75878
|
/**
|
|
75765
75879
|
* 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.
|
|
75766
75880
|
* @summary List available standard reports
|