@connectedxm/admin-sdk 13.1.0 → 13.3.0

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.1.0
+ * The version of the OpenAPI document: 13.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -652,6 +652,10 @@ export var DelegateRole;
     DelegateRole["Manager"] = "manager";
     DelegateRole["Member"] = "member";
 })(DelegateRole || (DelegateRole = {}));
+export var DownloadReport200ResponseStatusEnum;
+(function (DownloadReport200ResponseStatusEnum) {
+    DownloadReport200ResponseStatusEnum["Ok"] = "ok";
+})(DownloadReport200ResponseStatusEnum || (DownloadReport200ResponseStatusEnum = {}));
 export var EmailCodeAuth;
 (function (EmailCodeAuth) {
     EmailCodeAuth["Disabled"] = "disabled";
@@ -1602,6 +1606,14 @@ export var GetEvents200ResponseStatusEnum;
 (function (GetEvents200ResponseStatusEnum) {
     GetEvents200ResponseStatusEnum["Ok"] = "ok";
 })(GetEvents200ResponseStatusEnum || (GetEvents200ResponseStatusEnum = {}));
+export var GetExport200ResponseStatusEnum;
+(function (GetExport200ResponseStatusEnum) {
+    GetExport200ResponseStatusEnum["Ok"] = "ok";
+})(GetExport200ResponseStatusEnum || (GetExport200ResponseStatusEnum = {}));
+export var GetExports200ResponseStatusEnum;
+(function (GetExports200ResponseStatusEnum) {
+    GetExports200ResponseStatusEnum["Ok"] = "ok";
+})(GetExports200ResponseStatusEnum || (GetExports200ResponseStatusEnum = {}));
 export var GetFiles200ResponseStatusEnum;
 (function (GetFiles200ResponseStatusEnum) {
     GetFiles200ResponseStatusEnum["Ok"] = "ok";
@@ -1874,6 +1886,10 @@ export var GetReport200ResponseStatusEnum;
 (function (GetReport200ResponseStatusEnum) {
     GetReport200ResponseStatusEnum["Ok"] = "ok";
 })(GetReport200ResponseStatusEnum || (GetReport200ResponseStatusEnum = {}));
+export var GetReportExport200ResponseStatusEnum;
+(function (GetReportExport200ResponseStatusEnum) {
+    GetReportExport200ResponseStatusEnum["Ok"] = "ok";
+})(GetReportExport200ResponseStatusEnum || (GetReportExport200ResponseStatusEnum = {}));
 export var GetReports200ResponseStatusEnum;
 (function (GetReports200ResponseStatusEnum) {
     GetReports200ResponseStatusEnum["Ok"] = "ok";
@@ -75427,6 +75443,194 @@ export class EventsTranslationsApi extends BaseAPI {
         return EventsTranslationsApiFp(this.configuration).updateEventTranslation(requestParameters.eventId, requestParameters.locale, requestParameters.eventTranslationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * ExportsApi - axios parameter creator
+ */
+export const ExportsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+         * @summary Get a single export
+         * @param {string} exportId The export identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getExport: (exportId_1, ...args_1) => __awaiter(this, [exportId_1, ...args_1], void 0, function* (exportId, options = {}) {
+            // verify required parameter 'exportId' is not null or undefined
+            assertParamExists('getExport', 'exportId', exportId);
+            const localVarPath = `/exports/{exportId}`
+                .replace('{exportId}', encodeURIComponent(String(exportId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+         * @summary List data exports
+         * @param {ExportStatus} [status] Filter by status
+         * @param {number} [page] Page number
+         * @param {number} [pageSize] Number of items per page
+         * @param {string} [orderBy] Field to order by
+         * @param {string} [search] Search query
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getExports: (status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (status, page, pageSize, orderBy, search, options = {}) {
+            const localVarPath = `/exports`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            if (status !== undefined) {
+                localVarQueryParameter['status'] = status;
+            }
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+            if (orderBy !== undefined) {
+                localVarQueryParameter['orderBy'] = orderBy;
+            }
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * ExportsApi - functional programming interface
+ */
+export const ExportsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = ExportsApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+         * @summary Get a single export
+         * @param {string} exportId The export identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getExport(exportId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getExport(exportId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExportsApi.getExport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+         * @summary List data exports
+         * @param {ExportStatus} [status] Filter by status
+         * @param {number} [page] Page number
+         * @param {number} [pageSize] Number of items per page
+         * @param {string} [orderBy] Field to order by
+         * @param {string} [search] Search query
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getExports(status, page, pageSize, orderBy, search, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getExports(status, page, pageSize, orderBy, search, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExportsApi.getExports']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * ExportsApi - factory interface
+ */
+export const ExportsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = ExportsApiFp(configuration);
+    return {
+        /**
+         * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+         * @summary Get a single export
+         * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getExport(requestParameters, options) {
+            return localVarFp.getExport(requestParameters.exportId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+         * @summary List data exports
+         * @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getExports(requestParameters = {}, options) {
+            return localVarFp.getExports(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * ExportsApi - object-oriented interface
+ */
+export class ExportsApi extends BaseAPI {
+    /**
+     * Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+     * @summary Get a single export
+     * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExport(requestParameters, options) {
+        return ExportsApiFp(this.configuration).getExport(requestParameters.exportId, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+     * @summary List data exports
+     * @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExports(requestParameters = {}, options) {
+        return ExportsApiFp(this.configuration).getExports(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * FilesApi - axios parameter creator
  */
@@ -94923,6 +95127,45 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * 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.
+         * @summary Build a standard report as a downloadable CSV
+         * @param {string} standard The standard identifier
+         * @param {ReportFilters} reportFilters
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadReport: (standard_1, reportFilters_1, ...args_1) => __awaiter(this, [standard_1, reportFilters_1, ...args_1], void 0, function* (standard, reportFilters, options = {}) {
+            // verify required parameter 'standard' is not null or undefined
+            assertParamExists('downloadReport', 'standard', standard);
+            // verify required parameter 'reportFilters' is not null or undefined
+            assertParamExists('downloadReport', 'reportFilters', reportFilters);
+            const localVarPath = `/reports/{standard}/download`
+                .replace('{standard}', encodeURIComponent(String(standard)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(reportFilters, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * 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.
          * @summary Export a custom report
@@ -95198,6 +95441,40 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * 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.
+         * @summary Get the status of a report download
+         * @param {string} exportId The export identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getReportExport: (exportId_1, ...args_1) => __awaiter(this, [exportId_1, ...args_1], void 0, function* (exportId, options = {}) {
+            // verify required parameter 'exportId' is not null or undefined
+            assertParamExists('getReportExport', 'exportId', exportId);
+            const localVarPath = `/reports/exports/{exportId}`
+                .replace('{exportId}', encodeURIComponent(String(exportId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * 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.
          * @summary List available standard reports
@@ -95369,6 +95646,23 @@ export const ReportsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * 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.
+         * @summary Build a standard report as a downloadable CSV
+         * @param {string} standard The standard identifier
+         * @param {ReportFilters} reportFilters
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadReport(standard, reportFilters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadReport(standard, reportFilters, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReportsApi.downloadReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * 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.
          * @summary Export a custom report
@@ -95475,6 +95769,22 @@ export const ReportsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * 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.
+         * @summary Get the status of a report download
+         * @param {string} exportId The export identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getReportExport(exportId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getReportExport(exportId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReportsApi.getReportExport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * 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.
          * @summary List available standard reports
@@ -95563,6 +95873,16 @@ export const ReportsApiFactory = function (configuration, basePath, axios) {
         deleteCustomReportSchedule(requestParameters, options) {
             return localVarFp.deleteCustomReportSchedule(requestParameters.reportId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary Build a standard report as a downloadable CSV
+         * @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadReport(requestParameters, options) {
+            return localVarFp.downloadReport(requestParameters.standard, requestParameters.reportFilters, options).then((request) => request(axios, basePath));
+        },
         /**
          * 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.
          * @summary Export a custom report
@@ -95613,6 +95933,16 @@ export const ReportsApiFactory = function (configuration, basePath, axios) {
         getReport(requestParameters, options) {
             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));
         },
+        /**
+         * 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.
+         * @summary Get the status of a report download
+         * @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getReportExport(requestParameters, options) {
+            return localVarFp.getReportExport(requestParameters.exportId, options).then((request) => request(axios, basePath));
+        },
         /**
          * 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.
          * @summary List available standard reports
@@ -95679,6 +96009,16 @@ export class ReportsApi extends BaseAPI {
     deleteCustomReportSchedule(requestParameters, options) {
         return ReportsApiFp(this.configuration).deleteCustomReportSchedule(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * 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.
+     * @summary Build a standard report as a downloadable CSV
+     * @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadReport(requestParameters, options) {
+        return ReportsApiFp(this.configuration).downloadReport(requestParameters.standard, requestParameters.reportFilters, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * 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.
      * @summary Export a custom report
@@ -95729,6 +96069,16 @@ export class ReportsApi extends BaseAPI {
     getReport(requestParameters, options) {
         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));
     }
+    /**
+     * 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.
+     * @summary Get the status of a report download
+     * @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReportExport(requestParameters, options) {
+        return ReportsApiFp(this.configuration).getReportExport(requestParameters.exportId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * 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.
      * @summary List available standard reports

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.1.0
+ * The version of the OpenAPI document: 13.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.1.0
+ * The version of the OpenAPI document: 13.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.1.0
+ * The version of the OpenAPI document: 13.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.1.0
+ * The version of the OpenAPI document: 13.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.1.0
+ * The version of the OpenAPI document: 13.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.1.0
+ * The version of the OpenAPI document: 13.3.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/BaseExport.md

@@ -0,0 +1,38 @@
+# BaseExport
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**status** | [**ExportStatus**](ExportStatus.md) |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**userId** | **string** |  | [default to undefined]
+**expiration** | **string** |  | [default to undefined]
+**downloadUrl** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseExport } from '@connectedxm/admin-sdk';
+
+const instance: BaseExport = {
+    id,
+    type,
+    status,
+    message,
+    eventId,
+    userId,
+    expiration,
+    downloadUrl,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/BaseReportExport.md

@@ -0,0 +1,22 @@
+# BaseReportExport
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**status** | [**ExportStatus**](ExportStatus.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseReportExport } from '@connectedxm/admin-sdk';
+
+const instance: BaseReportExport = {
+    id,
+    status,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DownloadReport200Response.md

@@ -0,0 +1,24 @@
+# DownloadReport200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**BaseReportExport**](BaseReportExport.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { DownloadReport200Response } from '@connectedxm/admin-sdk';
+
+const instance: DownloadReport200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Export.md

@@ -0,0 +1,40 @@
+# Export
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**status** | [**ExportStatus**](ExportStatus.md) |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**userId** | **string** |  | [default to undefined]
+**expiration** | **string** |  | [default to undefined]
+**downloadUrl** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**user** | [**BaseUser**](BaseUser.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Export } from '@connectedxm/admin-sdk';
+
+const instance: Export = {
+    id,
+    type,
+    status,
+    message,
+    eventId,
+    userId,
+    expiration,
+    downloadUrl,
+    createdAt,
+    updatedAt,
+    user,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)