@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/dist/configuration.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 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/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 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
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 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).
|
|
@@ -652,6 +652,10 @@ export var DelegateRole;
|
|
|
652
652
|
DelegateRole["Manager"] = "manager";
|
|
653
653
|
DelegateRole["Member"] = "member";
|
|
654
654
|
})(DelegateRole || (DelegateRole = {}));
|
|
655
|
+
export var DownloadReport200ResponseStatusEnum;
|
|
656
|
+
(function (DownloadReport200ResponseStatusEnum) {
|
|
657
|
+
DownloadReport200ResponseStatusEnum["Ok"] = "ok";
|
|
658
|
+
})(DownloadReport200ResponseStatusEnum || (DownloadReport200ResponseStatusEnum = {}));
|
|
655
659
|
export var EmailCodeAuth;
|
|
656
660
|
(function (EmailCodeAuth) {
|
|
657
661
|
EmailCodeAuth["Disabled"] = "disabled";
|
|
@@ -1874,6 +1878,10 @@ export var GetReport200ResponseStatusEnum;
|
|
|
1874
1878
|
(function (GetReport200ResponseStatusEnum) {
|
|
1875
1879
|
GetReport200ResponseStatusEnum["Ok"] = "ok";
|
|
1876
1880
|
})(GetReport200ResponseStatusEnum || (GetReport200ResponseStatusEnum = {}));
|
|
1881
|
+
export var GetReportExport200ResponseStatusEnum;
|
|
1882
|
+
(function (GetReportExport200ResponseStatusEnum) {
|
|
1883
|
+
GetReportExport200ResponseStatusEnum["Ok"] = "ok";
|
|
1884
|
+
})(GetReportExport200ResponseStatusEnum || (GetReportExport200ResponseStatusEnum = {}));
|
|
1877
1885
|
export var GetReports200ResponseStatusEnum;
|
|
1878
1886
|
(function (GetReports200ResponseStatusEnum) {
|
|
1879
1887
|
GetReports200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -94923,6 +94931,45 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
94923
94931
|
options: localVarRequestOptions,
|
|
94924
94932
|
};
|
|
94925
94933
|
}),
|
|
94934
|
+
/**
|
|
94935
|
+
* 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.
|
|
94936
|
+
* @summary Build a standard report as a downloadable CSV
|
|
94937
|
+
* @param {string} standard The standard identifier
|
|
94938
|
+
* @param {ReportFilters} reportFilters
|
|
94939
|
+
* @param {*} [options] Override http request option.
|
|
94940
|
+
* @throws {RequiredError}
|
|
94941
|
+
*/
|
|
94942
|
+
downloadReport: (standard_1, reportFilters_1, ...args_1) => __awaiter(this, [standard_1, reportFilters_1, ...args_1], void 0, function* (standard, reportFilters, options = {}) {
|
|
94943
|
+
// verify required parameter 'standard' is not null or undefined
|
|
94944
|
+
assertParamExists('downloadReport', 'standard', standard);
|
|
94945
|
+
// verify required parameter 'reportFilters' is not null or undefined
|
|
94946
|
+
assertParamExists('downloadReport', 'reportFilters', reportFilters);
|
|
94947
|
+
const localVarPath = `/reports/{standard}/download`
|
|
94948
|
+
.replace('{standard}', encodeURIComponent(String(standard)));
|
|
94949
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
94950
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
94951
|
+
let baseOptions;
|
|
94952
|
+
if (configuration) {
|
|
94953
|
+
baseOptions = configuration.baseOptions;
|
|
94954
|
+
}
|
|
94955
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
94956
|
+
const localVarHeaderParameter = {};
|
|
94957
|
+
const localVarQueryParameter = {};
|
|
94958
|
+
// authentication ApiKeyAuth required
|
|
94959
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
94960
|
+
// authentication OrganizationId required
|
|
94961
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
94962
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
94963
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
94964
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
94965
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
94966
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
94967
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reportFilters, localVarRequestOptions, configuration);
|
|
94968
|
+
return {
|
|
94969
|
+
url: toPathString(localVarUrlObj),
|
|
94970
|
+
options: localVarRequestOptions,
|
|
94971
|
+
};
|
|
94972
|
+
}),
|
|
94926
94973
|
/**
|
|
94927
94974
|
* 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.
|
|
94928
94975
|
* @summary Export a custom report
|
|
@@ -95198,6 +95245,40 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
95198
95245
|
options: localVarRequestOptions,
|
|
95199
95246
|
};
|
|
95200
95247
|
}),
|
|
95248
|
+
/**
|
|
95249
|
+
* 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.
|
|
95250
|
+
* @summary Get the status of a report download
|
|
95251
|
+
* @param {string} exportId The export identifier
|
|
95252
|
+
* @param {*} [options] Override http request option.
|
|
95253
|
+
* @throws {RequiredError}
|
|
95254
|
+
*/
|
|
95255
|
+
getReportExport: (exportId_1, ...args_1) => __awaiter(this, [exportId_1, ...args_1], void 0, function* (exportId, options = {}) {
|
|
95256
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
95257
|
+
assertParamExists('getReportExport', 'exportId', exportId);
|
|
95258
|
+
const localVarPath = `/reports/exports/{exportId}`
|
|
95259
|
+
.replace('{exportId}', encodeURIComponent(String(exportId)));
|
|
95260
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
95261
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
95262
|
+
let baseOptions;
|
|
95263
|
+
if (configuration) {
|
|
95264
|
+
baseOptions = configuration.baseOptions;
|
|
95265
|
+
}
|
|
95266
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
95267
|
+
const localVarHeaderParameter = {};
|
|
95268
|
+
const localVarQueryParameter = {};
|
|
95269
|
+
// authentication ApiKeyAuth required
|
|
95270
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
95271
|
+
// authentication OrganizationId required
|
|
95272
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
95273
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
95274
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
95275
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
95276
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
95277
|
+
return {
|
|
95278
|
+
url: toPathString(localVarUrlObj),
|
|
95279
|
+
options: localVarRequestOptions,
|
|
95280
|
+
};
|
|
95281
|
+
}),
|
|
95201
95282
|
/**
|
|
95202
95283
|
* 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.
|
|
95203
95284
|
* @summary List available standard reports
|
|
@@ -95369,6 +95450,23 @@ export const ReportsApiFp = function (configuration) {
|
|
|
95369
95450
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
95370
95451
|
});
|
|
95371
95452
|
},
|
|
95453
|
+
/**
|
|
95454
|
+
* 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.
|
|
95455
|
+
* @summary Build a standard report as a downloadable CSV
|
|
95456
|
+
* @param {string} standard The standard identifier
|
|
95457
|
+
* @param {ReportFilters} reportFilters
|
|
95458
|
+
* @param {*} [options] Override http request option.
|
|
95459
|
+
* @throws {RequiredError}
|
|
95460
|
+
*/
|
|
95461
|
+
downloadReport(standard, reportFilters, options) {
|
|
95462
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
95463
|
+
var _a, _b, _c;
|
|
95464
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadReport(standard, reportFilters, options);
|
|
95465
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
95466
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReportsApi.downloadReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
95467
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
95468
|
+
});
|
|
95469
|
+
},
|
|
95372
95470
|
/**
|
|
95373
95471
|
* 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.
|
|
95374
95472
|
* @summary Export a custom report
|
|
@@ -95475,6 +95573,22 @@ export const ReportsApiFp = function (configuration) {
|
|
|
95475
95573
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
95476
95574
|
});
|
|
95477
95575
|
},
|
|
95576
|
+
/**
|
|
95577
|
+
* 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.
|
|
95578
|
+
* @summary Get the status of a report download
|
|
95579
|
+
* @param {string} exportId The export identifier
|
|
95580
|
+
* @param {*} [options] Override http request option.
|
|
95581
|
+
* @throws {RequiredError}
|
|
95582
|
+
*/
|
|
95583
|
+
getReportExport(exportId, options) {
|
|
95584
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
95585
|
+
var _a, _b, _c;
|
|
95586
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReportExport(exportId, options);
|
|
95587
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
95588
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReportsApi.getReportExport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
95589
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
95590
|
+
});
|
|
95591
|
+
},
|
|
95478
95592
|
/**
|
|
95479
95593
|
* 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.
|
|
95480
95594
|
* @summary List available standard reports
|
|
@@ -95563,6 +95677,16 @@ export const ReportsApiFactory = function (configuration, basePath, axios) {
|
|
|
95563
95677
|
deleteCustomReportSchedule(requestParameters, options) {
|
|
95564
95678
|
return localVarFp.deleteCustomReportSchedule(requestParameters.reportId, options).then((request) => request(axios, basePath));
|
|
95565
95679
|
},
|
|
95680
|
+
/**
|
|
95681
|
+
* 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.
|
|
95682
|
+
* @summary Build a standard report as a downloadable CSV
|
|
95683
|
+
* @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
|
|
95684
|
+
* @param {*} [options] Override http request option.
|
|
95685
|
+
* @throws {RequiredError}
|
|
95686
|
+
*/
|
|
95687
|
+
downloadReport(requestParameters, options) {
|
|
95688
|
+
return localVarFp.downloadReport(requestParameters.standard, requestParameters.reportFilters, options).then((request) => request(axios, basePath));
|
|
95689
|
+
},
|
|
95566
95690
|
/**
|
|
95567
95691
|
* 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.
|
|
95568
95692
|
* @summary Export a custom report
|
|
@@ -95613,6 +95737,16 @@ export const ReportsApiFactory = function (configuration, basePath, axios) {
|
|
|
95613
95737
|
getReport(requestParameters, options) {
|
|
95614
95738
|
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));
|
|
95615
95739
|
},
|
|
95740
|
+
/**
|
|
95741
|
+
* 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.
|
|
95742
|
+
* @summary Get the status of a report download
|
|
95743
|
+
* @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
|
|
95744
|
+
* @param {*} [options] Override http request option.
|
|
95745
|
+
* @throws {RequiredError}
|
|
95746
|
+
*/
|
|
95747
|
+
getReportExport(requestParameters, options) {
|
|
95748
|
+
return localVarFp.getReportExport(requestParameters.exportId, options).then((request) => request(axios, basePath));
|
|
95749
|
+
},
|
|
95616
95750
|
/**
|
|
95617
95751
|
* 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.
|
|
95618
95752
|
* @summary List available standard reports
|
|
@@ -95679,6 +95813,16 @@ export class ReportsApi extends BaseAPI {
|
|
|
95679
95813
|
deleteCustomReportSchedule(requestParameters, options) {
|
|
95680
95814
|
return ReportsApiFp(this.configuration).deleteCustomReportSchedule(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
|
|
95681
95815
|
}
|
|
95816
|
+
/**
|
|
95817
|
+
* 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.
|
|
95818
|
+
* @summary Build a standard report as a downloadable CSV
|
|
95819
|
+
* @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
|
|
95820
|
+
* @param {*} [options] Override http request option.
|
|
95821
|
+
* @throws {RequiredError}
|
|
95822
|
+
*/
|
|
95823
|
+
downloadReport(requestParameters, options) {
|
|
95824
|
+
return ReportsApiFp(this.configuration).downloadReport(requestParameters.standard, requestParameters.reportFilters, options).then((request) => request(this.axios, this.basePath));
|
|
95825
|
+
}
|
|
95682
95826
|
/**
|
|
95683
95827
|
* 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.
|
|
95684
95828
|
* @summary Export a custom report
|
|
@@ -95729,6 +95873,16 @@ export class ReportsApi extends BaseAPI {
|
|
|
95729
95873
|
getReport(requestParameters, options) {
|
|
95730
95874
|
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));
|
|
95731
95875
|
}
|
|
95876
|
+
/**
|
|
95877
|
+
* 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.
|
|
95878
|
+
* @summary Get the status of a report download
|
|
95879
|
+
* @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
|
|
95880
|
+
* @param {*} [options] Override http request option.
|
|
95881
|
+
* @throws {RequiredError}
|
|
95882
|
+
*/
|
|
95883
|
+
getReportExport(requestParameters, options) {
|
|
95884
|
+
return ReportsApiFp(this.configuration).getReportExport(requestParameters.exportId, options).then((request) => request(this.axios, this.basePath));
|
|
95885
|
+
}
|
|
95732
95886
|
/**
|
|
95733
95887
|
* 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.
|
|
95734
95888
|
* @summary List available standard reports
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 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).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 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/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 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).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 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).
|
|
@@ -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).
|
|
@@ -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).
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BaseReportExport
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**status** | [**ExportStatus**](ExportStatus.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BaseReportExport } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: BaseReportExport = {
|
|
17
|
+
id,
|
|
18
|
+
status,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# DownloadReport200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**BaseReportExport**](BaseReportExport.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { DownloadReport200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: DownloadReport200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetReportExport200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**ReportExport**](ReportExport.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetReportExport200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetReportExport200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# ReportExport
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**status** | [**ExportStatus**](ExportStatus.md) | | [default to undefined]
|
|
10
|
+
**standard** | **string** | | [default to undefined]
|
|
11
|
+
**message** | **string** | | [default to undefined]
|
|
12
|
+
**downloadUrl** | **string** | | [default to undefined]
|
|
13
|
+
**expiration** | **string** | | [default to undefined]
|
|
14
|
+
**createdAt** | **string** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { ReportExport } from '@connectedxm/admin-sdk';
|
|
20
|
+
|
|
21
|
+
const instance: ReportExport = {
|
|
22
|
+
id,
|
|
23
|
+
status,
|
|
24
|
+
standard,
|
|
25
|
+
message,
|
|
26
|
+
downloadUrl,
|
|
27
|
+
expiration,
|
|
28
|
+
createdAt,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|