@connectedxm/admin-sdk 13.2.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/.openapi-generator/FILES +5 -0
- package/AdminApi.ts +3 -0
- package/README.md +2 -2
- package/api.ts +297 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +169 -1
- package/dist/api.js +224 -24
- 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/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +169 -1
- package/dist/esm/api.js +197 -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/BaseExport.md +38 -0
- package/docs/Export.md +40 -0
- package/docs/ExportsApi.md +123 -0
- package/docs/GetExport200Response.md +24 -0
- package/docs/GetExports200Response.md +26 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -203,6 +203,7 @@ docs/BaseEventSpeaker.md
|
|
|
203
203
|
docs/BaseEventSponsorship.md
|
|
204
204
|
docs/BaseEventSponsorshipLevel.md
|
|
205
205
|
docs/BaseEventTrack.md
|
|
206
|
+
docs/BaseExport.md
|
|
206
207
|
docs/BaseFaq.md
|
|
207
208
|
docs/BaseFaqSection.md
|
|
208
209
|
docs/BaseFile.md
|
|
@@ -795,7 +796,9 @@ docs/EventsTracksTranslationsApi.md
|
|
|
795
796
|
docs/EventsTransfersApi.md
|
|
796
797
|
docs/EventsTranslationsApi.md
|
|
797
798
|
docs/ExchangeType.md
|
|
799
|
+
docs/Export.md
|
|
798
800
|
docs/ExportStatus.md
|
|
801
|
+
docs/ExportsApi.md
|
|
799
802
|
docs/Faq.md
|
|
800
803
|
docs/FaqSection.md
|
|
801
804
|
docs/FaqSectionTranslation.md
|
|
@@ -1015,6 +1018,8 @@ docs/GetEventTrackTranslations200Response.md
|
|
|
1015
1018
|
docs/GetEventTranslation200Response.md
|
|
1016
1019
|
docs/GetEventTranslations200Response.md
|
|
1017
1020
|
docs/GetEvents200Response.md
|
|
1021
|
+
docs/GetExport200Response.md
|
|
1022
|
+
docs/GetExports200Response.md
|
|
1018
1023
|
docs/GetFiles200Response.md
|
|
1019
1024
|
docs/GetGroupInvitation200Response.md
|
|
1020
1025
|
docs/GetGroupInvitations200Response.md
|
package/AdminApi.ts
CHANGED
|
@@ -130,6 +130,7 @@ import {
|
|
|
130
130
|
EventsTracksTranslationsApi,
|
|
131
131
|
EventsTransfersApi,
|
|
132
132
|
EventsTranslationsApi,
|
|
133
|
+
ExportsApi,
|
|
133
134
|
FilesApi,
|
|
134
135
|
GroupsApi,
|
|
135
136
|
GroupsEventsApi,
|
|
@@ -348,6 +349,7 @@ export class AdminApi {
|
|
|
348
349
|
public readonly eventsTracksTranslations: EventsTracksTranslationsApi;
|
|
349
350
|
public readonly eventsTransfers: EventsTransfersApi;
|
|
350
351
|
public readonly eventsTranslations: EventsTranslationsApi;
|
|
352
|
+
public readonly exports: ExportsApi;
|
|
351
353
|
public readonly files: FilesApi;
|
|
352
354
|
public readonly groups: GroupsApi;
|
|
353
355
|
public readonly groupsEvents: GroupsEventsApi;
|
|
@@ -564,6 +566,7 @@ export class AdminApi {
|
|
|
564
566
|
this.eventsTracksTranslations = new EventsTracksTranslationsApi(this.config);
|
|
565
567
|
this.eventsTransfers = new EventsTransfersApi(this.config);
|
|
566
568
|
this.eventsTranslations = new EventsTranslationsApi(this.config);
|
|
569
|
+
this.exports = new ExportsApi(this.config);
|
|
567
570
|
this.files = new FilesApi(this.config);
|
|
568
571
|
this.groups = new GroupsApi(this.config);
|
|
569
572
|
this.groupsEvents = new GroupsEventsApi(this.config);
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@13.
|
|
1
|
+
## @connectedxm/admin-sdk@13.3.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@13.
|
|
39
|
+
npm install @connectedxm/admin-sdk@13.3.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 13.
|
|
7
|
+
* The version of the OpenAPI document: 13.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;
|
|
@@ -7502,6 +7516,21 @@ export enum ExchangeType {
|
|
|
7502
7516
|
}
|
|
7503
7517
|
|
|
7504
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
|
+
|
|
7505
7534
|
|
|
7506
7535
|
export enum ExportStatus {
|
|
7507
7536
|
Pending = 'pending',
|
|
@@ -9814,6 +9843,27 @@ export enum GetEvents200ResponseStatusEnum {
|
|
|
9814
9843
|
Ok = 'ok'
|
|
9815
9844
|
}
|
|
9816
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
|
+
|
|
9817
9867
|
export interface GetFiles200Response {
|
|
9818
9868
|
'status': GetFiles200ResponseStatusEnum;
|
|
9819
9869
|
'message': string;
|
|
@@ -111798,6 +111848,252 @@ export class EventsTranslationsApi extends BaseAPI {
|
|
|
111798
111848
|
|
|
111799
111849
|
|
|
111800
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
|
+
|
|
111801
112097
|
/**
|
|
111802
112098
|
* FilesApi - axios parameter creator
|
|
111803
112099
|
*/
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 13.
|
|
7
|
+
* The version of the OpenAPI document: 13.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.
|
|
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.
|
|
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).
|
package/dist/AdminApi.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* const accounts = await adminApi.accounts.getAccounts();
|
|
10
10
|
* const eventsPasses = await adminApi.eventsPasses.getEventPasses();
|
|
11
11
|
*/
|
|
12
|
-
import { AccountsApi, AccountsAddressesApi, AccountsFollowersApi, AccountsFollowingApi, AccountsGroupsApi, AccountsInterestsApi, AccountsInvitationsApi, AccountsLeadsApi, AccountsMergesApi, AccountsTiersApi, ActivitiesApi, ActivitiesScheduleApi, AdvertisementsApi, AnnouncementsApi, AnnouncementsAudiencesApi, AnnouncementsScheduleApi, AnnouncementsTemplatesApi, AnnouncementsTemplatesTranslationsApi, AnnouncementsTranslationsApi, ApiLogsApi, AuthSessionsApi, BenefitsApi, BenefitsTranslationsApi, BookingsApi, BookingsAvailabilitiesApi, BookingsBlackoutsApi, BookingsPlacesApi, BookingsPlacesTranslationsApi, BookingsQuestionsApi, BookingsQuestionsChoicesApi, BookingsQuestionsChoicesTranslationsApi, BookingsQuestionsTranslationsApi, BookingsResponsesApi, BookingsSpacesApi, BookingsSpacesTranslationsApi, ChannelsApi, ChannelsTranslationsApi, DashboardsApi, DashboardsWidgetsApi, EmailReceiptsApi, EventsApi, EventsAccessApi, EventsActivationsApi, EventsActivationsSessionsApi, EventsActivationsTranslationsApi, EventsAddonsApi, EventsAddonsTranslationsApi, EventsAttributesApi, EventsBenefitsApi, EventsBlocksApi, EventsBypassApi, EventsCohostsApi, EventsCouponsApi, EventsEmailsApi, EventsEmailsTranslationsApi, EventsFaqsApi, EventsFaqsTranslationsApi, EventsFollowupsApi, EventsFollowupsTranslationsApi, EventsGroupcouponreminderApi, EventsMatchesApi, EventsMediaApi, EventsMediaTranslationsApi, EventsOnSiteApi, EventsPackagesApi, EventsPackagesPassesApi, EventsPackagesTranslationsApi, EventsPagesApi, EventsPagesTranslationsApi, EventsPasschangesApi, EventsPassesApi, EventsPassesAccessesApi, EventsPassesAddonsApi, EventsPassesAttributesApi, EventsPassesFollowupsApi, EventsPassesResponsesApi, EventsPasstypesApi, EventsPasstypesExchangetargetsApi, EventsPasstypesPriceschedulesApi, EventsPasstypesRefundschedulesApi, EventsPasstypesTranslationsApi, EventsQuestionsApi, EventsQuestionsTranslationsApi, EventsRegistrationsApi, EventsRegistrationsPackagesApi, EventsRegistrationsReservationsApi, EventsRoomsApi, EventsRoomtypesApi, EventsRoomtypesTranslationsApi, EventsSectionsApi, EventsSectionsTranslationsApi, EventsSessionsApi, EventsSessionsAccessesApi, EventsSessionsLocationsApi, EventsSessionsLocationsTranslationsApi, EventsSessionsMatchesApi, EventsSessionsPricesApi, EventsSessionsQuestionsApi, EventsSessionsQuestionsTranslationsApi, EventsSessionsSectionsApi, EventsSessionsSectionsTranslationsApi, EventsSessionsTimesApi, EventsSessionsTimesTranslationsApi, EventsSessionsTranslationsApi, EventsSpeakersApi, EventsSpeakersTranslationsApi, EventsSponsorsApi, EventsSponsorshiplevelsApi, EventsSponsorshiplevelsTranslationsApi, EventsSponsorshipsApi, EventsSponsorshipsTranslationsApi, EventsTemplatesApi, EventsTracksApi, EventsTracksTranslationsApi, EventsTransfersApi, EventsTranslationsApi, FilesApi, GroupsApi, GroupsEventsApi, GroupsInterestsApi, GroupsInvitationsApi, GroupsMembersApi, GroupsModeratorsApi, GroupsRequestsApi, GroupsSponsorsApi, GroupsTranslationsApi, ImportsApi, InterestsApi, InvoicesApi, InvoicesLineitemsApi, LoginsApi, LoginsAccountsApi, MeetingsApi, MeetingsLinksApi, MeetingsLivestreamsApi, MeetingsParticipantsApi, MeetingsPresetsApi, MeetingsRecordingsApi, MeetingsSessionsApi, NotificationsApi, OrganizationApi, OrganizationAttributesApi, OrganizationDomainsApi, OrganizationEntitiesApi, OrganizationIntegrationsApi, OrganizationLanguageoverridesApi, OrganizationModulesApi, OrganizationModulesCustomApi, OrganizationModulesCustomTranslationsApi, OrganizationModulesSettingsApi, OrganizationModulesSettingsTranslationsApi, OrganizationModulesTiersApi, OrganizationPaymentsApi, OrganizationSideeffectsApi, OrganizationTaxApi, OrganizationTeammembersApi, OrganizationUsersApi, OrganizationWebhooksApi, PaymentsApi, PreferencesApi, PushDevicesApi, ReportsApi, ReportsUsersApi, SearchlistsApi, SearchlistsValuesApi, SelfApi, SelfApikeysApi, SelfImagesApi, SeriesApi, SeriesQuestionsApi, SeriesQuestionsChoicesApi, SeriesQuestionsTranslationsApi, SeriesRegistrationsApi, SeriesTranslationsApi, SponsorsApi, SponsorsAccountsApi, SponsorsTranslationsApi, StorageFilesApi, StorageImagesApi, StorageVideosApi, StorageVideosCaptionsApi, StreamsApi, StreamsOutputsApi, StreamsSessionsApi, SupportApi, SupportMessagesApi, SupportNotesApi, SurveysApi, SurveysQuestionsApi, SurveysQuestionsTranslationsApi, SurveysSectionsApi, SurveysSectionsTranslationsApi, SurveysSessionsApi, SurveysSubmissionsApi, SurveysTranslationsApi, ThreadsApi, ThreadsAccountsApi, ThreadsMessagesApi, ThreadsMessagesFilesApi, ThreadsMessagesImagesApi, ThreadsMessagesReactionsApi, ThreadsMessagesVideosApi, ThreadsStorageApi, TiersApi } from "./api";
|
|
12
|
+
import { AccountsApi, AccountsAddressesApi, AccountsFollowersApi, AccountsFollowingApi, AccountsGroupsApi, AccountsInterestsApi, AccountsInvitationsApi, AccountsLeadsApi, AccountsMergesApi, AccountsTiersApi, ActivitiesApi, ActivitiesScheduleApi, AdvertisementsApi, AnnouncementsApi, AnnouncementsAudiencesApi, AnnouncementsScheduleApi, AnnouncementsTemplatesApi, AnnouncementsTemplatesTranslationsApi, AnnouncementsTranslationsApi, ApiLogsApi, AuthSessionsApi, BenefitsApi, BenefitsTranslationsApi, BookingsApi, BookingsAvailabilitiesApi, BookingsBlackoutsApi, BookingsPlacesApi, BookingsPlacesTranslationsApi, BookingsQuestionsApi, BookingsQuestionsChoicesApi, BookingsQuestionsChoicesTranslationsApi, BookingsQuestionsTranslationsApi, BookingsResponsesApi, BookingsSpacesApi, BookingsSpacesTranslationsApi, ChannelsApi, ChannelsTranslationsApi, DashboardsApi, DashboardsWidgetsApi, EmailReceiptsApi, EventsApi, EventsAccessApi, EventsActivationsApi, EventsActivationsSessionsApi, EventsActivationsTranslationsApi, EventsAddonsApi, EventsAddonsTranslationsApi, EventsAttributesApi, EventsBenefitsApi, EventsBlocksApi, EventsBypassApi, EventsCohostsApi, EventsCouponsApi, EventsEmailsApi, EventsEmailsTranslationsApi, EventsFaqsApi, EventsFaqsTranslationsApi, EventsFollowupsApi, EventsFollowupsTranslationsApi, EventsGroupcouponreminderApi, EventsMatchesApi, EventsMediaApi, EventsMediaTranslationsApi, EventsOnSiteApi, EventsPackagesApi, EventsPackagesPassesApi, EventsPackagesTranslationsApi, EventsPagesApi, EventsPagesTranslationsApi, EventsPasschangesApi, EventsPassesApi, EventsPassesAccessesApi, EventsPassesAddonsApi, EventsPassesAttributesApi, EventsPassesFollowupsApi, EventsPassesResponsesApi, EventsPasstypesApi, EventsPasstypesExchangetargetsApi, EventsPasstypesPriceschedulesApi, EventsPasstypesRefundschedulesApi, EventsPasstypesTranslationsApi, EventsQuestionsApi, EventsQuestionsTranslationsApi, EventsRegistrationsApi, EventsRegistrationsPackagesApi, EventsRegistrationsReservationsApi, EventsRoomsApi, EventsRoomtypesApi, EventsRoomtypesTranslationsApi, EventsSectionsApi, EventsSectionsTranslationsApi, EventsSessionsApi, EventsSessionsAccessesApi, EventsSessionsLocationsApi, EventsSessionsLocationsTranslationsApi, EventsSessionsMatchesApi, EventsSessionsPricesApi, EventsSessionsQuestionsApi, EventsSessionsQuestionsTranslationsApi, EventsSessionsSectionsApi, EventsSessionsSectionsTranslationsApi, EventsSessionsTimesApi, EventsSessionsTimesTranslationsApi, EventsSessionsTranslationsApi, EventsSpeakersApi, EventsSpeakersTranslationsApi, EventsSponsorsApi, EventsSponsorshiplevelsApi, EventsSponsorshiplevelsTranslationsApi, EventsSponsorshipsApi, EventsSponsorshipsTranslationsApi, EventsTemplatesApi, EventsTracksApi, EventsTracksTranslationsApi, EventsTransfersApi, EventsTranslationsApi, ExportsApi, FilesApi, GroupsApi, GroupsEventsApi, GroupsInterestsApi, GroupsInvitationsApi, GroupsMembersApi, GroupsModeratorsApi, GroupsRequestsApi, GroupsSponsorsApi, GroupsTranslationsApi, ImportsApi, InterestsApi, InvoicesApi, InvoicesLineitemsApi, LoginsApi, LoginsAccountsApi, MeetingsApi, MeetingsLinksApi, MeetingsLivestreamsApi, MeetingsParticipantsApi, MeetingsPresetsApi, MeetingsRecordingsApi, MeetingsSessionsApi, NotificationsApi, OrganizationApi, OrganizationAttributesApi, OrganizationDomainsApi, OrganizationEntitiesApi, OrganizationIntegrationsApi, OrganizationLanguageoverridesApi, OrganizationModulesApi, OrganizationModulesCustomApi, OrganizationModulesCustomTranslationsApi, OrganizationModulesSettingsApi, OrganizationModulesSettingsTranslationsApi, OrganizationModulesTiersApi, OrganizationPaymentsApi, OrganizationSideeffectsApi, OrganizationTaxApi, OrganizationTeammembersApi, OrganizationUsersApi, OrganizationWebhooksApi, PaymentsApi, PreferencesApi, PushDevicesApi, ReportsApi, ReportsUsersApi, SearchlistsApi, SearchlistsValuesApi, SelfApi, SelfApikeysApi, SelfImagesApi, SeriesApi, SeriesQuestionsApi, SeriesQuestionsChoicesApi, SeriesQuestionsTranslationsApi, SeriesRegistrationsApi, SeriesTranslationsApi, SponsorsApi, SponsorsAccountsApi, SponsorsTranslationsApi, StorageFilesApi, StorageImagesApi, StorageVideosApi, StorageVideosCaptionsApi, StreamsApi, StreamsOutputsApi, StreamsSessionsApi, SupportApi, SupportMessagesApi, SupportNotesApi, SurveysApi, SurveysQuestionsApi, SurveysQuestionsTranslationsApi, SurveysSectionsApi, SurveysSectionsTranslationsApi, SurveysSessionsApi, SurveysSubmissionsApi, SurveysTranslationsApi, ThreadsApi, ThreadsAccountsApi, ThreadsMessagesApi, ThreadsMessagesFilesApi, ThreadsMessagesImagesApi, ThreadsMessagesReactionsApi, ThreadsMessagesVideosApi, ThreadsStorageApi, TiersApi } from "./api";
|
|
13
13
|
export interface AdminApiConfig {
|
|
14
14
|
/** Your API key for authentication */
|
|
15
15
|
apiKey: string;
|
|
@@ -136,6 +136,7 @@ export declare class AdminApi {
|
|
|
136
136
|
readonly eventsTracksTranslations: EventsTracksTranslationsApi;
|
|
137
137
|
readonly eventsTransfers: EventsTransfersApi;
|
|
138
138
|
readonly eventsTranslations: EventsTranslationsApi;
|
|
139
|
+
readonly exports: ExportsApi;
|
|
139
140
|
readonly files: FilesApi;
|
|
140
141
|
readonly groups: GroupsApi;
|
|
141
142
|
readonly groupsEvents: GroupsEventsApi;
|
package/dist/AdminApi.js
CHANGED
|
@@ -144,6 +144,7 @@ class AdminApi {
|
|
|
144
144
|
this.eventsTracksTranslations = new api_1.EventsTracksTranslationsApi(this.config);
|
|
145
145
|
this.eventsTransfers = new api_1.EventsTransfersApi(this.config);
|
|
146
146
|
this.eventsTranslations = new api_1.EventsTranslationsApi(this.config);
|
|
147
|
+
this.exports = new api_1.ExportsApi(this.config);
|
|
147
148
|
this.files = new api_1.FilesApi(this.config);
|
|
148
149
|
this.groups = new api_1.GroupsApi(this.config);
|
|
149
150
|
this.groupsEvents = new api_1.GroupsEventsApi(this.config);
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 13.
|
|
5
|
+
* The version of the OpenAPI document: 13.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1984,6 +1984,18 @@ export interface BaseEventTrack {
|
|
|
1984
1984
|
'description': string | null;
|
|
1985
1985
|
'color': string;
|
|
1986
1986
|
}
|
|
1987
|
+
export interface BaseExport {
|
|
1988
|
+
'id': string;
|
|
1989
|
+
'type': string;
|
|
1990
|
+
'status': ExportStatus;
|
|
1991
|
+
'message': string | null;
|
|
1992
|
+
'eventId': string | null;
|
|
1993
|
+
'userId': string | null;
|
|
1994
|
+
'expiration': string | null;
|
|
1995
|
+
'downloadUrl': string | null;
|
|
1996
|
+
'createdAt': string;
|
|
1997
|
+
'updatedAt': string;
|
|
1998
|
+
}
|
|
1987
1999
|
export interface BaseFaq {
|
|
1988
2000
|
'id': string;
|
|
1989
2001
|
'slug': string;
|
|
@@ -6881,6 +6893,19 @@ export declare enum ExchangeType {
|
|
|
6881
6893
|
Downgrade = "downgrade",
|
|
6882
6894
|
Swap = "swap"
|
|
6883
6895
|
}
|
|
6896
|
+
export interface Export {
|
|
6897
|
+
'id': string;
|
|
6898
|
+
'type': string;
|
|
6899
|
+
'status': ExportStatus;
|
|
6900
|
+
'message': string | null;
|
|
6901
|
+
'eventId': string | null;
|
|
6902
|
+
'userId': string | null;
|
|
6903
|
+
'expiration': string | null;
|
|
6904
|
+
'downloadUrl': string | null;
|
|
6905
|
+
'createdAt': string;
|
|
6906
|
+
'updatedAt': string;
|
|
6907
|
+
'user': BaseUser | null;
|
|
6908
|
+
}
|
|
6884
6909
|
export declare enum ExportStatus {
|
|
6885
6910
|
Pending = "pending",
|
|
6886
6911
|
Resolved = "resolved",
|
|
@@ -8765,6 +8790,23 @@ export interface GetEvents200Response {
|
|
|
8765
8790
|
export declare enum GetEvents200ResponseStatusEnum {
|
|
8766
8791
|
Ok = "ok"
|
|
8767
8792
|
}
|
|
8793
|
+
export interface GetExport200Response {
|
|
8794
|
+
'status': GetExport200ResponseStatusEnum;
|
|
8795
|
+
'message': string;
|
|
8796
|
+
'data': Export;
|
|
8797
|
+
}
|
|
8798
|
+
export declare enum GetExport200ResponseStatusEnum {
|
|
8799
|
+
Ok = "ok"
|
|
8800
|
+
}
|
|
8801
|
+
export interface GetExports200Response {
|
|
8802
|
+
'status': GetExports200ResponseStatusEnum;
|
|
8803
|
+
'message': string;
|
|
8804
|
+
'data': Array<Export>;
|
|
8805
|
+
'count'?: number;
|
|
8806
|
+
}
|
|
8807
|
+
export declare enum GetExports200ResponseStatusEnum {
|
|
8808
|
+
Ok = "ok"
|
|
8809
|
+
}
|
|
8768
8810
|
export interface GetFiles200Response {
|
|
8769
8811
|
'status': GetFiles200ResponseStatusEnum;
|
|
8770
8812
|
'message': string;
|
|
@@ -62966,6 +63008,132 @@ export declare class EventsTranslationsApi extends BaseAPI {
|
|
|
62966
63008
|
*/
|
|
62967
63009
|
updateEventTranslation(requestParameters: EventsTranslationsApiUpdateEventTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncAccounts200Response, any, {}, any>>;
|
|
62968
63010
|
}
|
|
63011
|
+
/**
|
|
63012
|
+
* ExportsApi - axios parameter creator
|
|
63013
|
+
*/
|
|
63014
|
+
export declare const ExportsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
63015
|
+
/**
|
|
63016
|
+
* 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.
|
|
63017
|
+
* @summary Get a single export
|
|
63018
|
+
* @param {string} exportId The export identifier
|
|
63019
|
+
* @param {*} [options] Override http request option.
|
|
63020
|
+
* @throws {RequiredError}
|
|
63021
|
+
*/
|
|
63022
|
+
getExport: (exportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63023
|
+
/**
|
|
63024
|
+
* 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.
|
|
63025
|
+
* @summary List data exports
|
|
63026
|
+
* @param {ExportStatus} [status] Filter by status
|
|
63027
|
+
* @param {number} [page] Page number
|
|
63028
|
+
* @param {number} [pageSize] Number of items per page
|
|
63029
|
+
* @param {string} [orderBy] Field to order by
|
|
63030
|
+
* @param {string} [search] Search query
|
|
63031
|
+
* @param {*} [options] Override http request option.
|
|
63032
|
+
* @throws {RequiredError}
|
|
63033
|
+
*/
|
|
63034
|
+
getExports: (status?: ExportStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
63035
|
+
};
|
|
63036
|
+
/**
|
|
63037
|
+
* ExportsApi - functional programming interface
|
|
63038
|
+
*/
|
|
63039
|
+
export declare const ExportsApiFp: (configuration?: Configuration) => {
|
|
63040
|
+
/**
|
|
63041
|
+
* 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.
|
|
63042
|
+
* @summary Get a single export
|
|
63043
|
+
* @param {string} exportId The export identifier
|
|
63044
|
+
* @param {*} [options] Override http request option.
|
|
63045
|
+
* @throws {RequiredError}
|
|
63046
|
+
*/
|
|
63047
|
+
getExport(exportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExport200Response>>;
|
|
63048
|
+
/**
|
|
63049
|
+
* 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.
|
|
63050
|
+
* @summary List data exports
|
|
63051
|
+
* @param {ExportStatus} [status] Filter by status
|
|
63052
|
+
* @param {number} [page] Page number
|
|
63053
|
+
* @param {number} [pageSize] Number of items per page
|
|
63054
|
+
* @param {string} [orderBy] Field to order by
|
|
63055
|
+
* @param {string} [search] Search query
|
|
63056
|
+
* @param {*} [options] Override http request option.
|
|
63057
|
+
* @throws {RequiredError}
|
|
63058
|
+
*/
|
|
63059
|
+
getExports(status?: ExportStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExports200Response>>;
|
|
63060
|
+
};
|
|
63061
|
+
/**
|
|
63062
|
+
* ExportsApi - factory interface
|
|
63063
|
+
*/
|
|
63064
|
+
export declare const ExportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
63065
|
+
/**
|
|
63066
|
+
* 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.
|
|
63067
|
+
* @summary Get a single export
|
|
63068
|
+
* @param {ExportsApiGetExportRequest} requestParameters Request parameters.
|
|
63069
|
+
* @param {*} [options] Override http request option.
|
|
63070
|
+
* @throws {RequiredError}
|
|
63071
|
+
*/
|
|
63072
|
+
getExport(requestParameters: ExportsApiGetExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetExport200Response>;
|
|
63073
|
+
/**
|
|
63074
|
+
* 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.
|
|
63075
|
+
* @summary List data exports
|
|
63076
|
+
* @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
|
|
63077
|
+
* @param {*} [options] Override http request option.
|
|
63078
|
+
* @throws {RequiredError}
|
|
63079
|
+
*/
|
|
63080
|
+
getExports(requestParameters?: ExportsApiGetExportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetExports200Response>;
|
|
63081
|
+
};
|
|
63082
|
+
/**
|
|
63083
|
+
* Request parameters for getExport operation in ExportsApi.
|
|
63084
|
+
*/
|
|
63085
|
+
export interface ExportsApiGetExportRequest {
|
|
63086
|
+
/**
|
|
63087
|
+
* The export identifier
|
|
63088
|
+
*/
|
|
63089
|
+
readonly exportId: string;
|
|
63090
|
+
}
|
|
63091
|
+
/**
|
|
63092
|
+
* Request parameters for getExports operation in ExportsApi.
|
|
63093
|
+
*/
|
|
63094
|
+
export interface ExportsApiGetExportsRequest {
|
|
63095
|
+
/**
|
|
63096
|
+
* Filter by status
|
|
63097
|
+
*/
|
|
63098
|
+
readonly status?: ExportStatus;
|
|
63099
|
+
/**
|
|
63100
|
+
* Page number
|
|
63101
|
+
*/
|
|
63102
|
+
readonly page?: number;
|
|
63103
|
+
/**
|
|
63104
|
+
* Number of items per page
|
|
63105
|
+
*/
|
|
63106
|
+
readonly pageSize?: number;
|
|
63107
|
+
/**
|
|
63108
|
+
* Field to order by
|
|
63109
|
+
*/
|
|
63110
|
+
readonly orderBy?: string;
|
|
63111
|
+
/**
|
|
63112
|
+
* Search query
|
|
63113
|
+
*/
|
|
63114
|
+
readonly search?: string;
|
|
63115
|
+
}
|
|
63116
|
+
/**
|
|
63117
|
+
* ExportsApi - object-oriented interface
|
|
63118
|
+
*/
|
|
63119
|
+
export declare class ExportsApi extends BaseAPI {
|
|
63120
|
+
/**
|
|
63121
|
+
* 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.
|
|
63122
|
+
* @summary Get a single export
|
|
63123
|
+
* @param {ExportsApiGetExportRequest} requestParameters Request parameters.
|
|
63124
|
+
* @param {*} [options] Override http request option.
|
|
63125
|
+
* @throws {RequiredError}
|
|
63126
|
+
*/
|
|
63127
|
+
getExport(requestParameters: ExportsApiGetExportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExport200Response, any, {}, any>>;
|
|
63128
|
+
/**
|
|
63129
|
+
* 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.
|
|
63130
|
+
* @summary List data exports
|
|
63131
|
+
* @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
|
|
63132
|
+
* @param {*} [options] Override http request option.
|
|
63133
|
+
* @throws {RequiredError}
|
|
63134
|
+
*/
|
|
63135
|
+
getExports(requestParameters?: ExportsApiGetExportsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExports200Response, any, {}, any>>;
|
|
63136
|
+
}
|
|
62969
63137
|
/**
|
|
62970
63138
|
* FilesApi - axios parameter creator
|
|
62971
63139
|
*/
|