@connectedxm/admin-sdk 13.1.0 → 13.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/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.1.0
7
+ * The version of the OpenAPI document: 13.3.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2154,6 +2154,20 @@ export interface BaseEventTrack {
2154
2154
  'description': string | null;
2155
2155
  'color': string;
2156
2156
  }
2157
+ export interface BaseExport {
2158
+ 'id': string;
2159
+ 'type': string;
2160
+ 'status': ExportStatus;
2161
+ 'message': string | null;
2162
+ 'eventId': string | null;
2163
+ 'userId': string | null;
2164
+ 'expiration': string | null;
2165
+ 'downloadUrl': string | null;
2166
+ 'createdAt': string;
2167
+ 'updatedAt': string;
2168
+ }
2169
+
2170
+
2157
2171
  export interface BaseFaq {
2158
2172
  'id': string;
2159
2173
  'slug': string;
@@ -2797,6 +2811,12 @@ export interface BaseRegistrationSectionQuestion {
2797
2811
  'question': BaseRegistrationQuestion;
2798
2812
  'sortOrder': number;
2799
2813
  }
2814
+ export interface BaseReportExport {
2815
+ 'id': string;
2816
+ 'status': ExportStatus;
2817
+ }
2818
+
2819
+
2800
2820
  export interface BaseRoom {
2801
2821
  'id': string;
2802
2822
  'roomName': string;
@@ -5372,6 +5392,16 @@ export interface DenyEventPassRequest {
5372
5392
  export interface DomainDetails {
5373
5393
  'name': string;
5374
5394
  }
5395
+ export interface DownloadReport200Response {
5396
+ 'status': DownloadReport200ResponseStatusEnum;
5397
+ 'message': string;
5398
+ 'data': BaseReportExport;
5399
+ }
5400
+
5401
+ export enum DownloadReport200ResponseStatusEnum {
5402
+ Ok = 'ok'
5403
+ }
5404
+
5375
5405
 
5376
5406
  export enum EmailCodeAuth {
5377
5407
  Disabled = 'disabled',
@@ -7486,6 +7516,21 @@ export enum ExchangeType {
7486
7516
  }
7487
7517
 
7488
7518
 
7519
+ export interface Export {
7520
+ 'id': string;
7521
+ 'type': string;
7522
+ 'status': ExportStatus;
7523
+ 'message': string | null;
7524
+ 'eventId': string | null;
7525
+ 'userId': string | null;
7526
+ 'expiration': string | null;
7527
+ 'downloadUrl': string | null;
7528
+ 'createdAt': string;
7529
+ 'updatedAt': string;
7530
+ 'user': BaseUser | null;
7531
+ }
7532
+
7533
+
7489
7534
 
7490
7535
  export enum ExportStatus {
7491
7536
  Pending = 'pending',
@@ -9798,6 +9843,27 @@ export enum GetEvents200ResponseStatusEnum {
9798
9843
  Ok = 'ok'
9799
9844
  }
9800
9845
 
9846
+ export interface GetExport200Response {
9847
+ 'status': GetExport200ResponseStatusEnum;
9848
+ 'message': string;
9849
+ 'data': Export;
9850
+ }
9851
+
9852
+ export enum GetExport200ResponseStatusEnum {
9853
+ Ok = 'ok'
9854
+ }
9855
+
9856
+ export interface GetExports200Response {
9857
+ 'status': GetExports200ResponseStatusEnum;
9858
+ 'message': string;
9859
+ 'data': Array<Export>;
9860
+ 'count'?: number;
9861
+ }
9862
+
9863
+ export enum GetExports200ResponseStatusEnum {
9864
+ Ok = 'ok'
9865
+ }
9866
+
9801
9867
  export interface GetFiles200Response {
9802
9868
  'status': GetFiles200ResponseStatusEnum;
9803
9869
  'message': string;
@@ -10514,6 +10580,16 @@ export enum GetReport200ResponseStatusEnum {
10514
10580
  Ok = 'ok'
10515
10581
  }
10516
10582
 
10583
+ export interface GetReportExport200Response {
10584
+ 'status': GetReportExport200ResponseStatusEnum;
10585
+ 'message': string;
10586
+ 'data': ReportExport;
10587
+ }
10588
+
10589
+ export enum GetReportExport200ResponseStatusEnum {
10590
+ Ok = 'ok'
10591
+ }
10592
+
10517
10593
  export interface GetReports200Response {
10518
10594
  'status': GetReports200ResponseStatusEnum;
10519
10595
  'message': string;
@@ -13917,6 +13993,17 @@ export enum ReorderSurveySectionQuestions200ResponseStatusEnum {
13917
13993
  Ok = 'ok'
13918
13994
  }
13919
13995
 
13996
+ export interface ReportExport {
13997
+ 'id': string;
13998
+ 'status': ExportStatus;
13999
+ 'standard': string;
14000
+ 'message': string | null;
14001
+ 'downloadUrl': string | null;
14002
+ 'expiration': string | null;
14003
+ 'createdAt': string;
14004
+ }
14005
+
14006
+
13920
14007
  export interface ReportFilters {
13921
14008
  'eventId'?: string;
13922
14009
  'placeId'?: string;
@@ -111761,6 +111848,252 @@ export class EventsTranslationsApi extends BaseAPI {
111761
111848
 
111762
111849
 
111763
111850
 
111851
+ /**
111852
+ * ExportsApi - axios parameter creator
111853
+ */
111854
+ export const ExportsApiAxiosParamCreator = function (configuration?: Configuration) {
111855
+ return {
111856
+ /**
111857
+ * 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.
111858
+ * @summary Get a single export
111859
+ * @param {string} exportId The export identifier
111860
+ * @param {*} [options] Override http request option.
111861
+ * @throws {RequiredError}
111862
+ */
111863
+ getExport: async (exportId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
111864
+ // verify required parameter 'exportId' is not null or undefined
111865
+ assertParamExists('getExport', 'exportId', exportId)
111866
+ const localVarPath = `/exports/{exportId}`
111867
+ .replace('{exportId}', encodeURIComponent(String(exportId)));
111868
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
111869
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
111870
+ let baseOptions;
111871
+ if (configuration) {
111872
+ baseOptions = configuration.baseOptions;
111873
+ }
111874
+
111875
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
111876
+ const localVarHeaderParameter = {} as any;
111877
+ const localVarQueryParameter = {} as any;
111878
+
111879
+ // authentication ApiKeyAuth required
111880
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
111881
+
111882
+ // authentication OrganizationId required
111883
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
111884
+
111885
+ localVarHeaderParameter['Accept'] = 'application/json';
111886
+
111887
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
111888
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
111889
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
111890
+
111891
+ return {
111892
+ url: toPathString(localVarUrlObj),
111893
+ options: localVarRequestOptions,
111894
+ };
111895
+ },
111896
+ /**
111897
+ * 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.
111898
+ * @summary List data exports
111899
+ * @param {ExportStatus} [status] Filter by status
111900
+ * @param {number} [page] Page number
111901
+ * @param {number} [pageSize] Number of items per page
111902
+ * @param {string} [orderBy] Field to order by
111903
+ * @param {string} [search] Search query
111904
+ * @param {*} [options] Override http request option.
111905
+ * @throws {RequiredError}
111906
+ */
111907
+ getExports: async (status?: ExportStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
111908
+ const localVarPath = `/exports`;
111909
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
111910
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
111911
+ let baseOptions;
111912
+ if (configuration) {
111913
+ baseOptions = configuration.baseOptions;
111914
+ }
111915
+
111916
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
111917
+ const localVarHeaderParameter = {} as any;
111918
+ const localVarQueryParameter = {} as any;
111919
+
111920
+ // authentication ApiKeyAuth required
111921
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
111922
+
111923
+ // authentication OrganizationId required
111924
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
111925
+
111926
+ if (status !== undefined) {
111927
+ localVarQueryParameter['status'] = status;
111928
+ }
111929
+
111930
+ if (page !== undefined) {
111931
+ localVarQueryParameter['page'] = page;
111932
+ }
111933
+
111934
+ if (pageSize !== undefined) {
111935
+ localVarQueryParameter['pageSize'] = pageSize;
111936
+ }
111937
+
111938
+ if (orderBy !== undefined) {
111939
+ localVarQueryParameter['orderBy'] = orderBy;
111940
+ }
111941
+
111942
+ if (search !== undefined) {
111943
+ localVarQueryParameter['search'] = search;
111944
+ }
111945
+
111946
+ localVarHeaderParameter['Accept'] = 'application/json';
111947
+
111948
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
111949
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
111950
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
111951
+
111952
+ return {
111953
+ url: toPathString(localVarUrlObj),
111954
+ options: localVarRequestOptions,
111955
+ };
111956
+ },
111957
+ }
111958
+ };
111959
+
111960
+ /**
111961
+ * ExportsApi - functional programming interface
111962
+ */
111963
+ export const ExportsApiFp = function(configuration?: Configuration) {
111964
+ const localVarAxiosParamCreator = ExportsApiAxiosParamCreator(configuration)
111965
+ return {
111966
+ /**
111967
+ * 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.
111968
+ * @summary Get a single export
111969
+ * @param {string} exportId The export identifier
111970
+ * @param {*} [options] Override http request option.
111971
+ * @throws {RequiredError}
111972
+ */
111973
+ async getExport(exportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExport200Response>> {
111974
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getExport(exportId, options);
111975
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
111976
+ const localVarOperationServerBasePath = operationServerMap['ExportsApi.getExport']?.[localVarOperationServerIndex]?.url;
111977
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
111978
+ },
111979
+ /**
111980
+ * 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.
111981
+ * @summary List data exports
111982
+ * @param {ExportStatus} [status] Filter by status
111983
+ * @param {number} [page] Page number
111984
+ * @param {number} [pageSize] Number of items per page
111985
+ * @param {string} [orderBy] Field to order by
111986
+ * @param {string} [search] Search query
111987
+ * @param {*} [options] Override http request option.
111988
+ * @throws {RequiredError}
111989
+ */
111990
+ async getExports(status?: ExportStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExports200Response>> {
111991
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getExports(status, page, pageSize, orderBy, search, options);
111992
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
111993
+ const localVarOperationServerBasePath = operationServerMap['ExportsApi.getExports']?.[localVarOperationServerIndex]?.url;
111994
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
111995
+ },
111996
+ }
111997
+ };
111998
+
111999
+ /**
112000
+ * ExportsApi - factory interface
112001
+ */
112002
+ export const ExportsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
112003
+ const localVarFp = ExportsApiFp(configuration)
112004
+ return {
112005
+ /**
112006
+ * 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.
112007
+ * @summary Get a single export
112008
+ * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
112009
+ * @param {*} [options] Override http request option.
112010
+ * @throws {RequiredError}
112011
+ */
112012
+ getExport(requestParameters: ExportsApiGetExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetExport200Response> {
112013
+ return localVarFp.getExport(requestParameters.exportId, options).then((request) => request(axios, basePath));
112014
+ },
112015
+ /**
112016
+ * 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.
112017
+ * @summary List data exports
112018
+ * @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
112019
+ * @param {*} [options] Override http request option.
112020
+ * @throws {RequiredError}
112021
+ */
112022
+ getExports(requestParameters: ExportsApiGetExportsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetExports200Response> {
112023
+ return localVarFp.getExports(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
112024
+ },
112025
+ };
112026
+ };
112027
+
112028
+ /**
112029
+ * Request parameters for getExport operation in ExportsApi.
112030
+ */
112031
+ export interface ExportsApiGetExportRequest {
112032
+ /**
112033
+ * The export identifier
112034
+ */
112035
+ readonly exportId: string
112036
+ }
112037
+
112038
+ /**
112039
+ * Request parameters for getExports operation in ExportsApi.
112040
+ */
112041
+ export interface ExportsApiGetExportsRequest {
112042
+ /**
112043
+ * Filter by status
112044
+ */
112045
+ readonly status?: ExportStatus
112046
+
112047
+ /**
112048
+ * Page number
112049
+ */
112050
+ readonly page?: number
112051
+
112052
+ /**
112053
+ * Number of items per page
112054
+ */
112055
+ readonly pageSize?: number
112056
+
112057
+ /**
112058
+ * Field to order by
112059
+ */
112060
+ readonly orderBy?: string
112061
+
112062
+ /**
112063
+ * Search query
112064
+ */
112065
+ readonly search?: string
112066
+ }
112067
+
112068
+ /**
112069
+ * ExportsApi - object-oriented interface
112070
+ */
112071
+ export class ExportsApi extends BaseAPI {
112072
+ /**
112073
+ * 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.
112074
+ * @summary Get a single export
112075
+ * @param {ExportsApiGetExportRequest} requestParameters Request parameters.
112076
+ * @param {*} [options] Override http request option.
112077
+ * @throws {RequiredError}
112078
+ */
112079
+ public getExport(requestParameters: ExportsApiGetExportRequest, options?: RawAxiosRequestConfig) {
112080
+ return ExportsApiFp(this.configuration).getExport(requestParameters.exportId, options).then((request) => request(this.axios, this.basePath));
112081
+ }
112082
+
112083
+ /**
112084
+ * 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.
112085
+ * @summary List data exports
112086
+ * @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
112087
+ * @param {*} [options] Override http request option.
112088
+ * @throws {RequiredError}
112089
+ */
112090
+ public getExports(requestParameters: ExportsApiGetExportsRequest = {}, options?: RawAxiosRequestConfig) {
112091
+ return ExportsApiFp(this.configuration).getExports(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
112092
+ }
112093
+ }
112094
+
112095
+
112096
+
111764
112097
  /**
111765
112098
  * FilesApi - axios parameter creator
111766
112099
  */
@@ -136416,6 +136749,51 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
136416
136749
  options: localVarRequestOptions,
136417
136750
  };
136418
136751
  },
136752
+ /**
136753
+ * 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.
136754
+ * @summary Build a standard report as a downloadable CSV
136755
+ * @param {string} standard The standard identifier
136756
+ * @param {ReportFilters} reportFilters
136757
+ * @param {*} [options] Override http request option.
136758
+ * @throws {RequiredError}
136759
+ */
136760
+ downloadReport: async (standard: string, reportFilters: ReportFilters, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
136761
+ // verify required parameter 'standard' is not null or undefined
136762
+ assertParamExists('downloadReport', 'standard', standard)
136763
+ // verify required parameter 'reportFilters' is not null or undefined
136764
+ assertParamExists('downloadReport', 'reportFilters', reportFilters)
136765
+ const localVarPath = `/reports/{standard}/download`
136766
+ .replace('{standard}', encodeURIComponent(String(standard)));
136767
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
136768
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
136769
+ let baseOptions;
136770
+ if (configuration) {
136771
+ baseOptions = configuration.baseOptions;
136772
+ }
136773
+
136774
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
136775
+ const localVarHeaderParameter = {} as any;
136776
+ const localVarQueryParameter = {} as any;
136777
+
136778
+ // authentication ApiKeyAuth required
136779
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
136780
+
136781
+ // authentication OrganizationId required
136782
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
136783
+
136784
+ localVarHeaderParameter['Content-Type'] = 'application/json';
136785
+ localVarHeaderParameter['Accept'] = 'application/json';
136786
+
136787
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
136788
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
136789
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
136790
+ localVarRequestOptions.data = serializeDataIfNeeded(reportFilters, localVarRequestOptions, configuration)
136791
+
136792
+ return {
136793
+ url: toPathString(localVarUrlObj),
136794
+ options: localVarRequestOptions,
136795
+ };
136796
+ },
136419
136797
  /**
136420
136798
  * 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
136799
  * @summary Export a custom report
@@ -136747,6 +137125,46 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
136747
137125
  options: localVarRequestOptions,
136748
137126
  };
136749
137127
  },
137128
+ /**
137129
+ * 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.
137130
+ * @summary Get the status of a report download
137131
+ * @param {string} exportId The export identifier
137132
+ * @param {*} [options] Override http request option.
137133
+ * @throws {RequiredError}
137134
+ */
137135
+ getReportExport: async (exportId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
137136
+ // verify required parameter 'exportId' is not null or undefined
137137
+ assertParamExists('getReportExport', 'exportId', exportId)
137138
+ const localVarPath = `/reports/exports/{exportId}`
137139
+ .replace('{exportId}', encodeURIComponent(String(exportId)));
137140
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
137141
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
137142
+ let baseOptions;
137143
+ if (configuration) {
137144
+ baseOptions = configuration.baseOptions;
137145
+ }
137146
+
137147
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
137148
+ const localVarHeaderParameter = {} as any;
137149
+ const localVarQueryParameter = {} as any;
137150
+
137151
+ // authentication ApiKeyAuth required
137152
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
137153
+
137154
+ // authentication OrganizationId required
137155
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
137156
+
137157
+ localVarHeaderParameter['Accept'] = 'application/json';
137158
+
137159
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
137160
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
137161
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
137162
+
137163
+ return {
137164
+ url: toPathString(localVarUrlObj),
137165
+ options: localVarRequestOptions,
137166
+ };
137167
+ },
136750
137168
  /**
136751
137169
  * 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
137170
  * @summary List available standard reports
@@ -136929,6 +137347,20 @@ export const ReportsApiFp = function(configuration?: Configuration) {
136929
137347
  const localVarOperationServerBasePath = operationServerMap['ReportsApi.deleteCustomReportSchedule']?.[localVarOperationServerIndex]?.url;
136930
137348
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
136931
137349
  },
137350
+ /**
137351
+ * 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.
137352
+ * @summary Build a standard report as a downloadable CSV
137353
+ * @param {string} standard The standard identifier
137354
+ * @param {ReportFilters} reportFilters
137355
+ * @param {*} [options] Override http request option.
137356
+ * @throws {RequiredError}
137357
+ */
137358
+ async downloadReport(standard: string, reportFilters: ReportFilters, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadReport200Response>> {
137359
+ const localVarAxiosArgs = await localVarAxiosParamCreator.downloadReport(standard, reportFilters, options);
137360
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
137361
+ const localVarOperationServerBasePath = operationServerMap['ReportsApi.downloadReport']?.[localVarOperationServerIndex]?.url;
137362
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
137363
+ },
136932
137364
  /**
136933
137365
  * 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
137366
  * @summary Export a custom report
@@ -137020,6 +137452,19 @@ export const ReportsApiFp = function(configuration?: Configuration) {
137020
137452
  const localVarOperationServerBasePath = operationServerMap['ReportsApi.getReport']?.[localVarOperationServerIndex]?.url;
137021
137453
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
137022
137454
  },
137455
+ /**
137456
+ * 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.
137457
+ * @summary Get the status of a report download
137458
+ * @param {string} exportId The export identifier
137459
+ * @param {*} [options] Override http request option.
137460
+ * @throws {RequiredError}
137461
+ */
137462
+ async getReportExport(exportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReportExport200Response>> {
137463
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getReportExport(exportId, options);
137464
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
137465
+ const localVarOperationServerBasePath = operationServerMap['ReportsApi.getReportExport']?.[localVarOperationServerIndex]?.url;
137466
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
137467
+ },
137023
137468
  /**
137024
137469
  * 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
137470
  * @summary List available standard reports
@@ -137100,6 +137545,16 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
137100
137545
  deleteCustomReportSchedule(requestParameters: ReportsApiDeleteCustomReportScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomReportSchedule200Response> {
137101
137546
  return localVarFp.deleteCustomReportSchedule(requestParameters.reportId, options).then((request) => request(axios, basePath));
137102
137547
  },
137548
+ /**
137549
+ * 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.
137550
+ * @summary Build a standard report as a downloadable CSV
137551
+ * @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
137552
+ * @param {*} [options] Override http request option.
137553
+ * @throws {RequiredError}
137554
+ */
137555
+ downloadReport(requestParameters: ReportsApiDownloadReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<DownloadReport200Response> {
137556
+ return localVarFp.downloadReport(requestParameters.standard, requestParameters.reportFilters, options).then((request) => request(axios, basePath));
137557
+ },
137103
137558
  /**
137104
137559
  * 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
137560
  * @summary Export a custom report
@@ -137150,6 +137605,16 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
137150
137605
  getReport(requestParameters: ReportsApiGetReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetReport200Response> {
137151
137606
  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
137607
  },
137608
+ /**
137609
+ * 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.
137610
+ * @summary Get the status of a report download
137611
+ * @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
137612
+ * @param {*} [options] Override http request option.
137613
+ * @throws {RequiredError}
137614
+ */
137615
+ getReportExport(requestParameters: ReportsApiGetReportExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetReportExport200Response> {
137616
+ return localVarFp.getReportExport(requestParameters.exportId, options).then((request) => request(axios, basePath));
137617
+ },
137153
137618
  /**
137154
137619
  * 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
137620
  * @summary List available standard reports
@@ -137215,6 +137680,18 @@ export interface ReportsApiDeleteCustomReportScheduleRequest {
137215
137680
  readonly reportId: string
137216
137681
  }
137217
137682
 
137683
+ /**
137684
+ * Request parameters for downloadReport operation in ReportsApi.
137685
+ */
137686
+ export interface ReportsApiDownloadReportRequest {
137687
+ /**
137688
+ * The standard identifier
137689
+ */
137690
+ readonly standard: string
137691
+
137692
+ readonly reportFilters: ReportFilters
137693
+ }
137694
+
137218
137695
  /**
137219
137696
  * Request parameters for exportCustomReport operation in ReportsApi.
137220
137697
  */
@@ -137392,6 +137869,16 @@ export interface ReportsApiGetReportRequest {
137392
137869
  readonly since?: string
137393
137870
  }
137394
137871
 
137872
+ /**
137873
+ * Request parameters for getReportExport operation in ReportsApi.
137874
+ */
137875
+ export interface ReportsApiGetReportExportRequest {
137876
+ /**
137877
+ * The export identifier
137878
+ */
137879
+ readonly exportId: string
137880
+ }
137881
+
137395
137882
  /**
137396
137883
  * Request parameters for getReports operation in ReportsApi.
137397
137884
  */
@@ -137463,6 +137950,17 @@ export class ReportsApi extends BaseAPI {
137463
137950
  return ReportsApiFp(this.configuration).deleteCustomReportSchedule(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
137464
137951
  }
137465
137952
 
137953
+ /**
137954
+ * 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.
137955
+ * @summary Build a standard report as a downloadable CSV
137956
+ * @param {ReportsApiDownloadReportRequest} requestParameters Request parameters.
137957
+ * @param {*} [options] Override http request option.
137958
+ * @throws {RequiredError}
137959
+ */
137960
+ public downloadReport(requestParameters: ReportsApiDownloadReportRequest, options?: RawAxiosRequestConfig) {
137961
+ return ReportsApiFp(this.configuration).downloadReport(requestParameters.standard, requestParameters.reportFilters, options).then((request) => request(this.axios, this.basePath));
137962
+ }
137963
+
137466
137964
  /**
137467
137965
  * 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
137966
  * @summary Export a custom report
@@ -137518,6 +138016,17 @@ export class ReportsApi extends BaseAPI {
137518
138016
  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
138017
  }
137520
138018
 
138019
+ /**
138020
+ * 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.
138021
+ * @summary Get the status of a report download
138022
+ * @param {ReportsApiGetReportExportRequest} requestParameters Request parameters.
138023
+ * @param {*} [options] Override http request option.
138024
+ * @throws {RequiredError}
138025
+ */
138026
+ public getReportExport(requestParameters: ReportsApiGetReportExportRequest, options?: RawAxiosRequestConfig) {
138027
+ return ReportsApiFp(this.configuration).getReportExport(requestParameters.exportId, options).then((request) => request(this.axios, this.basePath));
138028
+ }
138029
+
137521
138030
  /**
137522
138031
  * 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
138032
  * @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.1.0
7
+ * The version of the OpenAPI document: 13.3.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.1.0
7
+ * The version of the OpenAPI document: 13.3.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.1.0
6
+ * The version of the OpenAPI document: 13.3.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).