@connectedxm/admin-sdk 6.23.7 → 6.24.3
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 +1 -0
- package/README.md +2 -0
- package/api.ts +99 -0
- package/dist/api.d.ts +51 -0
- package/dist/api.js +76 -0
- package/dist/esm/api.d.ts +51 -0
- package/dist/esm/api.js +76 -0
- package/docs/BaseEvent.md +2 -0
- package/docs/CustomReportExportInputs.md +20 -0
- package/docs/Event.md +2 -0
- package/docs/EventCreateInputs.md +2 -0
- package/docs/EventUpdateInputs.md +2 -0
- package/docs/ReportsApi.md +56 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -448,6 +448,7 @@ docs/CustomModuleTranslationUpdateInputs.md
|
|
|
448
448
|
docs/CustomModuleUpdateInputs.md
|
|
449
449
|
docs/CustomReport.md
|
|
450
450
|
docs/CustomReportCreateInputs.md
|
|
451
|
+
docs/CustomReportExportInputs.md
|
|
451
452
|
docs/CustomReportUpdateInputs.md
|
|
452
453
|
docs/Dashboard.md
|
|
453
454
|
docs/DashboardCreateInputs.md
|
package/README.md
CHANGED
|
@@ -1001,6 +1001,7 @@ Class | Method | HTTP request | Description
|
|
|
1001
1001
|
*PushDevicesApi* | [**getPushDevices**](docs/PushDevicesApi.md#getpushdevices) | **GET** /push-devices | Get Push Devices
|
|
1002
1002
|
*ReportsApi* | [**createCustomReport**](docs/ReportsApi.md#createcustomreport) | **POST** /reports/{standard} | Create Custom Report
|
|
1003
1003
|
*ReportsApi* | [**deleteCustomReport**](docs/ReportsApi.md#deletecustomreport) | **DELETE** /reports/custom/{reportId} | Delete Custom Report
|
|
1004
|
+
*ReportsApi* | [**exportCustomReport**](docs/ReportsApi.md#exportcustomreport) | **POST** /reports/custom/{reportId}/export | Export Custom Report
|
|
1004
1005
|
*ReportsApi* | [**getCustomReport**](docs/ReportsApi.md#getcustomreport) | **GET** /reports/custom/{reportId} | Get Custom Report
|
|
1005
1006
|
*ReportsApi* | [**getCustomReports**](docs/ReportsApi.md#getcustomreports) | **GET** /reports/custom | Get Custom Reports
|
|
1006
1007
|
*ReportsApi* | [**getReport**](docs/ReportsApi.md#getreport) | **GET** /reports/{standard} | Get Report
|
|
@@ -1653,6 +1654,7 @@ Class | Method | HTTP request | Description
|
|
|
1653
1654
|
- [CustomModuleUpdateInputs](docs/CustomModuleUpdateInputs.md)
|
|
1654
1655
|
- [CustomReport](docs/CustomReport.md)
|
|
1655
1656
|
- [CustomReportCreateInputs](docs/CustomReportCreateInputs.md)
|
|
1657
|
+
- [CustomReportExportInputs](docs/CustomReportExportInputs.md)
|
|
1656
1658
|
- [CustomReportUpdateInputs](docs/CustomReportUpdateInputs.md)
|
|
1657
1659
|
- [Dashboard](docs/Dashboard.md)
|
|
1658
1660
|
- [DashboardCreateInputs](docs/DashboardCreateInputs.md)
|
package/api.ts
CHANGED
|
@@ -1214,6 +1214,7 @@ export interface BaseEvent {
|
|
|
1214
1214
|
'series': BaseSeries | null;
|
|
1215
1215
|
'paymentIntegrationId': string | null;
|
|
1216
1216
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
1217
|
+
'archived': boolean;
|
|
1217
1218
|
}
|
|
1218
1219
|
|
|
1219
1220
|
|
|
@@ -4521,6 +4522,9 @@ export interface CustomReportCreateInputs {
|
|
|
4521
4522
|
'gridState'?: string | null;
|
|
4522
4523
|
'shared'?: boolean;
|
|
4523
4524
|
}
|
|
4525
|
+
export interface CustomReportExportInputs {
|
|
4526
|
+
'email': string;
|
|
4527
|
+
}
|
|
4524
4528
|
export interface CustomReportUpdateInputs {
|
|
4525
4529
|
'name'?: string | null;
|
|
4526
4530
|
'description'?: string | null;
|
|
@@ -4681,6 +4685,7 @@ export interface Event {
|
|
|
4681
4685
|
'series': BaseSeries | null;
|
|
4682
4686
|
'paymentIntegrationId': string | null;
|
|
4683
4687
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
4688
|
+
'archived': boolean;
|
|
4684
4689
|
'roundName': string | null;
|
|
4685
4690
|
'matchName': string | null;
|
|
4686
4691
|
'passSupply': number | null;
|
|
@@ -5027,6 +5032,7 @@ export interface EventCreateInputs {
|
|
|
5027
5032
|
'eventEnd': string;
|
|
5028
5033
|
'featured'?: boolean;
|
|
5029
5034
|
'visible'?: boolean;
|
|
5035
|
+
'archived'?: boolean;
|
|
5030
5036
|
'slug'?: string | null;
|
|
5031
5037
|
'internalRefId'?: string | null;
|
|
5032
5038
|
'longDescription'?: string | null;
|
|
@@ -6453,6 +6459,7 @@ export enum EventType {
|
|
|
6453
6459
|
export interface EventUpdateInputs {
|
|
6454
6460
|
'featured'?: boolean;
|
|
6455
6461
|
'visible'?: boolean;
|
|
6462
|
+
'archived'?: boolean;
|
|
6456
6463
|
'name'?: string | null;
|
|
6457
6464
|
'eventType'?: EventType | null;
|
|
6458
6465
|
'slug'?: string | null;
|
|
@@ -122712,6 +122719,51 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
122712
122719
|
options: localVarRequestOptions,
|
|
122713
122720
|
};
|
|
122714
122721
|
},
|
|
122722
|
+
/**
|
|
122723
|
+
* Export Custom Report endpoint
|
|
122724
|
+
* @summary Export Custom Report
|
|
122725
|
+
* @param {string} reportId The report identifier
|
|
122726
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
122727
|
+
* @param {*} [options] Override http request option.
|
|
122728
|
+
* @throws {RequiredError}
|
|
122729
|
+
*/
|
|
122730
|
+
exportCustomReport: async (reportId: string, customReportExportInputs: CustomReportExportInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
122731
|
+
// verify required parameter 'reportId' is not null or undefined
|
|
122732
|
+
assertParamExists('exportCustomReport', 'reportId', reportId)
|
|
122733
|
+
// verify required parameter 'customReportExportInputs' is not null or undefined
|
|
122734
|
+
assertParamExists('exportCustomReport', 'customReportExportInputs', customReportExportInputs)
|
|
122735
|
+
const localVarPath = `/reports/custom/{reportId}/export`
|
|
122736
|
+
.replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
|
|
122737
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
122738
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
122739
|
+
let baseOptions;
|
|
122740
|
+
if (configuration) {
|
|
122741
|
+
baseOptions = configuration.baseOptions;
|
|
122742
|
+
}
|
|
122743
|
+
|
|
122744
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
122745
|
+
const localVarHeaderParameter = {} as any;
|
|
122746
|
+
const localVarQueryParameter = {} as any;
|
|
122747
|
+
|
|
122748
|
+
// authentication ApiKeyAuth required
|
|
122749
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
122750
|
+
|
|
122751
|
+
// authentication OrganizationId required
|
|
122752
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
122753
|
+
|
|
122754
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
122755
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
122756
|
+
|
|
122757
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
122758
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
122759
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
122760
|
+
localVarRequestOptions.data = serializeDataIfNeeded(customReportExportInputs, localVarRequestOptions, configuration)
|
|
122761
|
+
|
|
122762
|
+
return {
|
|
122763
|
+
url: toPathString(localVarUrlObj),
|
|
122764
|
+
options: localVarRequestOptions,
|
|
122765
|
+
};
|
|
122766
|
+
},
|
|
122715
122767
|
/**
|
|
122716
122768
|
* Get Custom Report endpoint
|
|
122717
122769
|
* @summary Get Custom Report
|
|
@@ -122990,6 +123042,20 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
122990
123042
|
const localVarOperationServerBasePath = operationServerMap['ReportsApi.deleteCustomReport']?.[localVarOperationServerIndex]?.url;
|
|
122991
123043
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
122992
123044
|
},
|
|
123045
|
+
/**
|
|
123046
|
+
* Export Custom Report endpoint
|
|
123047
|
+
* @summary Export Custom Report
|
|
123048
|
+
* @param {string} reportId The report identifier
|
|
123049
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
123050
|
+
* @param {*} [options] Override http request option.
|
|
123051
|
+
* @throws {RequiredError}
|
|
123052
|
+
*/
|
|
123053
|
+
async exportCustomReport(reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
123054
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomReport(reportId, customReportExportInputs, options);
|
|
123055
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
123056
|
+
const localVarOperationServerBasePath = operationServerMap['ReportsApi.exportCustomReport']?.[localVarOperationServerIndex]?.url;
|
|
123057
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
123058
|
+
},
|
|
122993
123059
|
/**
|
|
122994
123060
|
* Get Custom Report endpoint
|
|
122995
123061
|
* @summary Get Custom Report
|
|
@@ -123090,6 +123156,16 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
123090
123156
|
deleteCustomReport(requestParameters: ReportsApiDeleteCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
123091
123157
|
return localVarFp.deleteCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
|
|
123092
123158
|
},
|
|
123159
|
+
/**
|
|
123160
|
+
* Export Custom Report endpoint
|
|
123161
|
+
* @summary Export Custom Report
|
|
123162
|
+
* @param {ReportsApiExportCustomReportRequest} requestParameters Request parameters.
|
|
123163
|
+
* @param {*} [options] Override http request option.
|
|
123164
|
+
* @throws {RequiredError}
|
|
123165
|
+
*/
|
|
123166
|
+
exportCustomReport(requestParameters: ReportsApiExportCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
123167
|
+
return localVarFp.exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(axios, basePath));
|
|
123168
|
+
},
|
|
123093
123169
|
/**
|
|
123094
123170
|
* Get Custom Report endpoint
|
|
123095
123171
|
* @summary Get Custom Report
|
|
@@ -123165,6 +123241,18 @@ export interface ReportsApiDeleteCustomReportRequest {
|
|
|
123165
123241
|
readonly reportId: string
|
|
123166
123242
|
}
|
|
123167
123243
|
|
|
123244
|
+
/**
|
|
123245
|
+
* Request parameters for exportCustomReport operation in ReportsApi.
|
|
123246
|
+
*/
|
|
123247
|
+
export interface ReportsApiExportCustomReportRequest {
|
|
123248
|
+
/**
|
|
123249
|
+
* The report identifier
|
|
123250
|
+
*/
|
|
123251
|
+
readonly reportId: string
|
|
123252
|
+
|
|
123253
|
+
readonly customReportExportInputs: CustomReportExportInputs
|
|
123254
|
+
}
|
|
123255
|
+
|
|
123168
123256
|
/**
|
|
123169
123257
|
* Request parameters for getCustomReport operation in ReportsApi.
|
|
123170
123258
|
*/
|
|
@@ -123271,6 +123359,17 @@ export class ReportsApi extends BaseAPI {
|
|
|
123271
123359
|
return ReportsApiFp(this.configuration).deleteCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
|
|
123272
123360
|
}
|
|
123273
123361
|
|
|
123362
|
+
/**
|
|
123363
|
+
* Export Custom Report endpoint
|
|
123364
|
+
* @summary Export Custom Report
|
|
123365
|
+
* @param {ReportsApiExportCustomReportRequest} requestParameters Request parameters.
|
|
123366
|
+
* @param {*} [options] Override http request option.
|
|
123367
|
+
* @throws {RequiredError}
|
|
123368
|
+
*/
|
|
123369
|
+
public exportCustomReport(requestParameters: ReportsApiExportCustomReportRequest, options?: RawAxiosRequestConfig) {
|
|
123370
|
+
return ReportsApiFp(this.configuration).exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(this.axios, this.basePath));
|
|
123371
|
+
}
|
|
123372
|
+
|
|
123274
123373
|
/**
|
|
123275
123374
|
* Get Custom Report endpoint
|
|
123276
123375
|
* @summary Get Custom Report
|
package/dist/api.d.ts
CHANGED
|
@@ -1113,6 +1113,7 @@ export interface BaseEvent {
|
|
|
1113
1113
|
'series': BaseSeries | null;
|
|
1114
1114
|
'paymentIntegrationId': string | null;
|
|
1115
1115
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
1116
|
+
'archived': boolean;
|
|
1116
1117
|
}
|
|
1117
1118
|
export interface BaseEventActivation {
|
|
1118
1119
|
'id': string;
|
|
@@ -4090,6 +4091,9 @@ export interface CustomReportCreateInputs {
|
|
|
4090
4091
|
'gridState'?: string | null;
|
|
4091
4092
|
'shared'?: boolean;
|
|
4092
4093
|
}
|
|
4094
|
+
export interface CustomReportExportInputs {
|
|
4095
|
+
'email': string;
|
|
4096
|
+
}
|
|
4093
4097
|
export interface CustomReportUpdateInputs {
|
|
4094
4098
|
'name'?: string | null;
|
|
4095
4099
|
'description'?: string | null;
|
|
@@ -4234,6 +4238,7 @@ export interface Event {
|
|
|
4234
4238
|
'series': BaseSeries | null;
|
|
4235
4239
|
'paymentIntegrationId': string | null;
|
|
4236
4240
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
4241
|
+
'archived': boolean;
|
|
4237
4242
|
'roundName': string | null;
|
|
4238
4243
|
'matchName': string | null;
|
|
4239
4244
|
'passSupply': number | null;
|
|
@@ -4554,6 +4559,7 @@ export interface EventCreateInputs {
|
|
|
4554
4559
|
'eventEnd': string;
|
|
4555
4560
|
'featured'?: boolean;
|
|
4556
4561
|
'visible'?: boolean;
|
|
4562
|
+
'archived'?: boolean;
|
|
4557
4563
|
'slug'?: string | null;
|
|
4558
4564
|
'internalRefId'?: string | null;
|
|
4559
4565
|
'longDescription'?: string | null;
|
|
@@ -5914,6 +5920,7 @@ export declare enum EventType {
|
|
|
5914
5920
|
export interface EventUpdateInputs {
|
|
5915
5921
|
'featured'?: boolean;
|
|
5916
5922
|
'visible'?: boolean;
|
|
5923
|
+
'archived'?: boolean;
|
|
5917
5924
|
'name'?: string | null;
|
|
5918
5925
|
'eventType'?: EventType | null;
|
|
5919
5926
|
'slug'?: string | null;
|
|
@@ -67538,6 +67545,15 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
67538
67545
|
* @throws {RequiredError}
|
|
67539
67546
|
*/
|
|
67540
67547
|
deleteCustomReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67548
|
+
/**
|
|
67549
|
+
* Export Custom Report endpoint
|
|
67550
|
+
* @summary Export Custom Report
|
|
67551
|
+
* @param {string} reportId The report identifier
|
|
67552
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
67553
|
+
* @param {*} [options] Override http request option.
|
|
67554
|
+
* @throws {RequiredError}
|
|
67555
|
+
*/
|
|
67556
|
+
exportCustomReport: (reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67541
67557
|
/**
|
|
67542
67558
|
* Get Custom Report endpoint
|
|
67543
67559
|
* @summary Get Custom Report
|
|
@@ -67606,6 +67622,15 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
67606
67622
|
* @throws {RequiredError}
|
|
67607
67623
|
*/
|
|
67608
67624
|
deleteCustomReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67625
|
+
/**
|
|
67626
|
+
* Export Custom Report endpoint
|
|
67627
|
+
* @summary Export Custom Report
|
|
67628
|
+
* @param {string} reportId The report identifier
|
|
67629
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
67630
|
+
* @param {*} [options] Override http request option.
|
|
67631
|
+
* @throws {RequiredError}
|
|
67632
|
+
*/
|
|
67633
|
+
exportCustomReport(reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67609
67634
|
/**
|
|
67610
67635
|
* Get Custom Report endpoint
|
|
67611
67636
|
* @summary Get Custom Report
|
|
@@ -67673,6 +67698,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
|
|
|
67673
67698
|
* @throws {RequiredError}
|
|
67674
67699
|
*/
|
|
67675
67700
|
deleteCustomReport(requestParameters: ReportsApiDeleteCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
67701
|
+
/**
|
|
67702
|
+
* Export Custom Report endpoint
|
|
67703
|
+
* @summary Export Custom Report
|
|
67704
|
+
* @param {ReportsApiExportCustomReportRequest} requestParameters Request parameters.
|
|
67705
|
+
* @param {*} [options] Override http request option.
|
|
67706
|
+
* @throws {RequiredError}
|
|
67707
|
+
*/
|
|
67708
|
+
exportCustomReport(requestParameters: ReportsApiExportCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
67676
67709
|
/**
|
|
67677
67710
|
* Get Custom Report endpoint
|
|
67678
67711
|
* @summary Get Custom Report
|
|
@@ -67733,6 +67766,16 @@ export interface ReportsApiDeleteCustomReportRequest {
|
|
|
67733
67766
|
*/
|
|
67734
67767
|
readonly reportId: string;
|
|
67735
67768
|
}
|
|
67769
|
+
/**
|
|
67770
|
+
* Request parameters for exportCustomReport operation in ReportsApi.
|
|
67771
|
+
*/
|
|
67772
|
+
export interface ReportsApiExportCustomReportRequest {
|
|
67773
|
+
/**
|
|
67774
|
+
* The report identifier
|
|
67775
|
+
*/
|
|
67776
|
+
readonly reportId: string;
|
|
67777
|
+
readonly customReportExportInputs: CustomReportExportInputs;
|
|
67778
|
+
}
|
|
67736
67779
|
/**
|
|
67737
67780
|
* Request parameters for getCustomReport operation in ReportsApi.
|
|
67738
67781
|
*/
|
|
@@ -67822,6 +67865,14 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
67822
67865
|
* @throws {RequiredError}
|
|
67823
67866
|
*/
|
|
67824
67867
|
deleteCustomReport(requestParameters: ReportsApiDeleteCustomReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}>>;
|
|
67868
|
+
/**
|
|
67869
|
+
* Export Custom Report endpoint
|
|
67870
|
+
* @summary Export Custom Report
|
|
67871
|
+
* @param {ReportsApiExportCustomReportRequest} requestParameters Request parameters.
|
|
67872
|
+
* @param {*} [options] Override http request option.
|
|
67873
|
+
* @throws {RequiredError}
|
|
67874
|
+
*/
|
|
67875
|
+
exportCustomReport(requestParameters: ReportsApiExportCustomReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}>>;
|
|
67825
67876
|
/**
|
|
67826
67877
|
* Get Custom Report endpoint
|
|
67827
67878
|
* @summary Get Custom Report
|
package/dist/api.js
CHANGED
|
@@ -85794,6 +85794,45 @@ const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
85794
85794
|
options: localVarRequestOptions,
|
|
85795
85795
|
};
|
|
85796
85796
|
}),
|
|
85797
|
+
/**
|
|
85798
|
+
* Export Custom Report endpoint
|
|
85799
|
+
* @summary Export Custom Report
|
|
85800
|
+
* @param {string} reportId The report identifier
|
|
85801
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
85802
|
+
* @param {*} [options] Override http request option.
|
|
85803
|
+
* @throws {RequiredError}
|
|
85804
|
+
*/
|
|
85805
|
+
exportCustomReport: (reportId_1, customReportExportInputs_1, ...args_1) => __awaiter(this, [reportId_1, customReportExportInputs_1, ...args_1], void 0, function* (reportId, customReportExportInputs, options = {}) {
|
|
85806
|
+
// verify required parameter 'reportId' is not null or undefined
|
|
85807
|
+
(0, common_1.assertParamExists)('exportCustomReport', 'reportId', reportId);
|
|
85808
|
+
// verify required parameter 'customReportExportInputs' is not null or undefined
|
|
85809
|
+
(0, common_1.assertParamExists)('exportCustomReport', 'customReportExportInputs', customReportExportInputs);
|
|
85810
|
+
const localVarPath = `/reports/custom/{reportId}/export`
|
|
85811
|
+
.replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
|
|
85812
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
85813
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
85814
|
+
let baseOptions;
|
|
85815
|
+
if (configuration) {
|
|
85816
|
+
baseOptions = configuration.baseOptions;
|
|
85817
|
+
}
|
|
85818
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
85819
|
+
const localVarHeaderParameter = {};
|
|
85820
|
+
const localVarQueryParameter = {};
|
|
85821
|
+
// authentication ApiKeyAuth required
|
|
85822
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
85823
|
+
// authentication OrganizationId required
|
|
85824
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
85825
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
85826
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
85827
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
85828
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
85829
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
85830
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(customReportExportInputs, localVarRequestOptions, configuration);
|
|
85831
|
+
return {
|
|
85832
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
85833
|
+
options: localVarRequestOptions,
|
|
85834
|
+
};
|
|
85835
|
+
}),
|
|
85797
85836
|
/**
|
|
85798
85837
|
* Get Custom Report endpoint
|
|
85799
85838
|
* @summary Get Custom Report
|
|
@@ -86040,6 +86079,23 @@ const ReportsApiFp = function (configuration) {
|
|
|
86040
86079
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
86041
86080
|
});
|
|
86042
86081
|
},
|
|
86082
|
+
/**
|
|
86083
|
+
* Export Custom Report endpoint
|
|
86084
|
+
* @summary Export Custom Report
|
|
86085
|
+
* @param {string} reportId The report identifier
|
|
86086
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
86087
|
+
* @param {*} [options] Override http request option.
|
|
86088
|
+
* @throws {RequiredError}
|
|
86089
|
+
*/
|
|
86090
|
+
exportCustomReport(reportId, customReportExportInputs, options) {
|
|
86091
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
86092
|
+
var _a, _b, _c;
|
|
86093
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomReport(reportId, customReportExportInputs, options);
|
|
86094
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
86095
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReportsApi.exportCustomReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
86096
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
86097
|
+
});
|
|
86098
|
+
},
|
|
86043
86099
|
/**
|
|
86044
86100
|
* Get Custom Report endpoint
|
|
86045
86101
|
* @summary Get Custom Report
|
|
@@ -86155,6 +86211,16 @@ const ReportsApiFactory = function (configuration, basePath, axios) {
|
|
|
86155
86211
|
deleteCustomReport(requestParameters, options) {
|
|
86156
86212
|
return localVarFp.deleteCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
|
|
86157
86213
|
},
|
|
86214
|
+
/**
|
|
86215
|
+
* Export Custom Report endpoint
|
|
86216
|
+
* @summary Export Custom Report
|
|
86217
|
+
* @param {ReportsApiExportCustomReportRequest} requestParameters Request parameters.
|
|
86218
|
+
* @param {*} [options] Override http request option.
|
|
86219
|
+
* @throws {RequiredError}
|
|
86220
|
+
*/
|
|
86221
|
+
exportCustomReport(requestParameters, options) {
|
|
86222
|
+
return localVarFp.exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(axios, basePath));
|
|
86223
|
+
},
|
|
86158
86224
|
/**
|
|
86159
86225
|
* Get Custom Report endpoint
|
|
86160
86226
|
* @summary Get Custom Report
|
|
@@ -86232,6 +86298,16 @@ class ReportsApi extends base_1.BaseAPI {
|
|
|
86232
86298
|
deleteCustomReport(requestParameters, options) {
|
|
86233
86299
|
return (0, exports.ReportsApiFp)(this.configuration).deleteCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
|
|
86234
86300
|
}
|
|
86301
|
+
/**
|
|
86302
|
+
* Export Custom Report endpoint
|
|
86303
|
+
* @summary Export Custom Report
|
|
86304
|
+
* @param {ReportsApiExportCustomReportRequest} requestParameters Request parameters.
|
|
86305
|
+
* @param {*} [options] Override http request option.
|
|
86306
|
+
* @throws {RequiredError}
|
|
86307
|
+
*/
|
|
86308
|
+
exportCustomReport(requestParameters, options) {
|
|
86309
|
+
return (0, exports.ReportsApiFp)(this.configuration).exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(this.axios, this.basePath));
|
|
86310
|
+
}
|
|
86235
86311
|
/**
|
|
86236
86312
|
* Get Custom Report endpoint
|
|
86237
86313
|
* @summary Get Custom Report
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1113,6 +1113,7 @@ export interface BaseEvent {
|
|
|
1113
1113
|
'series': BaseSeries | null;
|
|
1114
1114
|
'paymentIntegrationId': string | null;
|
|
1115
1115
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
1116
|
+
'archived': boolean;
|
|
1116
1117
|
}
|
|
1117
1118
|
export interface BaseEventActivation {
|
|
1118
1119
|
'id': string;
|
|
@@ -4090,6 +4091,9 @@ export interface CustomReportCreateInputs {
|
|
|
4090
4091
|
'gridState'?: string | null;
|
|
4091
4092
|
'shared'?: boolean;
|
|
4092
4093
|
}
|
|
4094
|
+
export interface CustomReportExportInputs {
|
|
4095
|
+
'email': string;
|
|
4096
|
+
}
|
|
4093
4097
|
export interface CustomReportUpdateInputs {
|
|
4094
4098
|
'name'?: string | null;
|
|
4095
4099
|
'description'?: string | null;
|
|
@@ -4234,6 +4238,7 @@ export interface Event {
|
|
|
4234
4238
|
'series': BaseSeries | null;
|
|
4235
4239
|
'paymentIntegrationId': string | null;
|
|
4236
4240
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
4241
|
+
'archived': boolean;
|
|
4237
4242
|
'roundName': string | null;
|
|
4238
4243
|
'matchName': string | null;
|
|
4239
4244
|
'passSupply': number | null;
|
|
@@ -4554,6 +4559,7 @@ export interface EventCreateInputs {
|
|
|
4554
4559
|
'eventEnd': string;
|
|
4555
4560
|
'featured'?: boolean;
|
|
4556
4561
|
'visible'?: boolean;
|
|
4562
|
+
'archived'?: boolean;
|
|
4557
4563
|
'slug'?: string | null;
|
|
4558
4564
|
'internalRefId'?: string | null;
|
|
4559
4565
|
'longDescription'?: string | null;
|
|
@@ -5914,6 +5920,7 @@ export declare enum EventType {
|
|
|
5914
5920
|
export interface EventUpdateInputs {
|
|
5915
5921
|
'featured'?: boolean;
|
|
5916
5922
|
'visible'?: boolean;
|
|
5923
|
+
'archived'?: boolean;
|
|
5917
5924
|
'name'?: string | null;
|
|
5918
5925
|
'eventType'?: EventType | null;
|
|
5919
5926
|
'slug'?: string | null;
|
|
@@ -67538,6 +67545,15 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
67538
67545
|
* @throws {RequiredError}
|
|
67539
67546
|
*/
|
|
67540
67547
|
deleteCustomReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67548
|
+
/**
|
|
67549
|
+
* Export Custom Report endpoint
|
|
67550
|
+
* @summary Export Custom Report
|
|
67551
|
+
* @param {string} reportId The report identifier
|
|
67552
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
67553
|
+
* @param {*} [options] Override http request option.
|
|
67554
|
+
* @throws {RequiredError}
|
|
67555
|
+
*/
|
|
67556
|
+
exportCustomReport: (reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67541
67557
|
/**
|
|
67542
67558
|
* Get Custom Report endpoint
|
|
67543
67559
|
* @summary Get Custom Report
|
|
@@ -67606,6 +67622,15 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
67606
67622
|
* @throws {RequiredError}
|
|
67607
67623
|
*/
|
|
67608
67624
|
deleteCustomReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67625
|
+
/**
|
|
67626
|
+
* Export Custom Report endpoint
|
|
67627
|
+
* @summary Export Custom Report
|
|
67628
|
+
* @param {string} reportId The report identifier
|
|
67629
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
67630
|
+
* @param {*} [options] Override http request option.
|
|
67631
|
+
* @throws {RequiredError}
|
|
67632
|
+
*/
|
|
67633
|
+
exportCustomReport(reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67609
67634
|
/**
|
|
67610
67635
|
* Get Custom Report endpoint
|
|
67611
67636
|
* @summary Get Custom Report
|
|
@@ -67673,6 +67698,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
|
|
|
67673
67698
|
* @throws {RequiredError}
|
|
67674
67699
|
*/
|
|
67675
67700
|
deleteCustomReport(requestParameters: ReportsApiDeleteCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
67701
|
+
/**
|
|
67702
|
+
* Export Custom Report endpoint
|
|
67703
|
+
* @summary Export Custom Report
|
|
67704
|
+
* @param {ReportsApiExportCustomReportRequest} requestParameters Request parameters.
|
|
67705
|
+
* @param {*} [options] Override http request option.
|
|
67706
|
+
* @throws {RequiredError}
|
|
67707
|
+
*/
|
|
67708
|
+
exportCustomReport(requestParameters: ReportsApiExportCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
67676
67709
|
/**
|
|
67677
67710
|
* Get Custom Report endpoint
|
|
67678
67711
|
* @summary Get Custom Report
|
|
@@ -67733,6 +67766,16 @@ export interface ReportsApiDeleteCustomReportRequest {
|
|
|
67733
67766
|
*/
|
|
67734
67767
|
readonly reportId: string;
|
|
67735
67768
|
}
|
|
67769
|
+
/**
|
|
67770
|
+
* Request parameters for exportCustomReport operation in ReportsApi.
|
|
67771
|
+
*/
|
|
67772
|
+
export interface ReportsApiExportCustomReportRequest {
|
|
67773
|
+
/**
|
|
67774
|
+
* The report identifier
|
|
67775
|
+
*/
|
|
67776
|
+
readonly reportId: string;
|
|
67777
|
+
readonly customReportExportInputs: CustomReportExportInputs;
|
|
67778
|
+
}
|
|
67736
67779
|
/**
|
|
67737
67780
|
* Request parameters for getCustomReport operation in ReportsApi.
|
|
67738
67781
|
*/
|
|
@@ -67822,6 +67865,14 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
67822
67865
|
* @throws {RequiredError}
|
|
67823
67866
|
*/
|
|
67824
67867
|
deleteCustomReport(requestParameters: ReportsApiDeleteCustomReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}>>;
|
|
67868
|
+
/**
|
|
67869
|
+
* Export Custom Report endpoint
|
|
67870
|
+
* @summary Export Custom Report
|
|
67871
|
+
* @param {ReportsApiExportCustomReportRequest} requestParameters Request parameters.
|
|
67872
|
+
* @param {*} [options] Override http request option.
|
|
67873
|
+
* @throws {RequiredError}
|
|
67874
|
+
*/
|
|
67875
|
+
exportCustomReport(requestParameters: ReportsApiExportCustomReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}>>;
|
|
67825
67876
|
/**
|
|
67826
67877
|
* Get Custom Report endpoint
|
|
67827
67878
|
* @summary Get Custom Report
|
package/dist/esm/api.js
CHANGED
|
@@ -85169,6 +85169,45 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
85169
85169
|
options: localVarRequestOptions,
|
|
85170
85170
|
};
|
|
85171
85171
|
}),
|
|
85172
|
+
/**
|
|
85173
|
+
* Export Custom Report endpoint
|
|
85174
|
+
* @summary Export Custom Report
|
|
85175
|
+
* @param {string} reportId The report identifier
|
|
85176
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
85177
|
+
* @param {*} [options] Override http request option.
|
|
85178
|
+
* @throws {RequiredError}
|
|
85179
|
+
*/
|
|
85180
|
+
exportCustomReport: (reportId_1, customReportExportInputs_1, ...args_1) => __awaiter(this, [reportId_1, customReportExportInputs_1, ...args_1], void 0, function* (reportId, customReportExportInputs, options = {}) {
|
|
85181
|
+
// verify required parameter 'reportId' is not null or undefined
|
|
85182
|
+
assertParamExists('exportCustomReport', 'reportId', reportId);
|
|
85183
|
+
// verify required parameter 'customReportExportInputs' is not null or undefined
|
|
85184
|
+
assertParamExists('exportCustomReport', 'customReportExportInputs', customReportExportInputs);
|
|
85185
|
+
const localVarPath = `/reports/custom/{reportId}/export`
|
|
85186
|
+
.replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
|
|
85187
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
85188
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
85189
|
+
let baseOptions;
|
|
85190
|
+
if (configuration) {
|
|
85191
|
+
baseOptions = configuration.baseOptions;
|
|
85192
|
+
}
|
|
85193
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
85194
|
+
const localVarHeaderParameter = {};
|
|
85195
|
+
const localVarQueryParameter = {};
|
|
85196
|
+
// authentication ApiKeyAuth required
|
|
85197
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
85198
|
+
// authentication OrganizationId required
|
|
85199
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
85200
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
85201
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
85202
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
85203
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
85204
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
85205
|
+
localVarRequestOptions.data = serializeDataIfNeeded(customReportExportInputs, localVarRequestOptions, configuration);
|
|
85206
|
+
return {
|
|
85207
|
+
url: toPathString(localVarUrlObj),
|
|
85208
|
+
options: localVarRequestOptions,
|
|
85209
|
+
};
|
|
85210
|
+
}),
|
|
85172
85211
|
/**
|
|
85173
85212
|
* Get Custom Report endpoint
|
|
85174
85213
|
* @summary Get Custom Report
|
|
@@ -85414,6 +85453,23 @@ export const ReportsApiFp = function (configuration) {
|
|
|
85414
85453
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85415
85454
|
});
|
|
85416
85455
|
},
|
|
85456
|
+
/**
|
|
85457
|
+
* Export Custom Report endpoint
|
|
85458
|
+
* @summary Export Custom Report
|
|
85459
|
+
* @param {string} reportId The report identifier
|
|
85460
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
85461
|
+
* @param {*} [options] Override http request option.
|
|
85462
|
+
* @throws {RequiredError}
|
|
85463
|
+
*/
|
|
85464
|
+
exportCustomReport(reportId, customReportExportInputs, options) {
|
|
85465
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
85466
|
+
var _a, _b, _c;
|
|
85467
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomReport(reportId, customReportExportInputs, options);
|
|
85468
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85469
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReportsApi.exportCustomReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85470
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85471
|
+
});
|
|
85472
|
+
},
|
|
85417
85473
|
/**
|
|
85418
85474
|
* Get Custom Report endpoint
|
|
85419
85475
|
* @summary Get Custom Report
|
|
@@ -85528,6 +85584,16 @@ export const ReportsApiFactory = function (configuration, basePath, axios) {
|
|
|
85528
85584
|
deleteCustomReport(requestParameters, options) {
|
|
85529
85585
|
return localVarFp.deleteCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
|
|
85530
85586
|
},
|
|
85587
|
+
/**
|
|
85588
|
+
* Export Custom Report endpoint
|
|
85589
|
+
* @summary Export Custom Report
|
|
85590
|
+
* @param {ReportsApiExportCustomReportRequest} requestParameters Request parameters.
|
|
85591
|
+
* @param {*} [options] Override http request option.
|
|
85592
|
+
* @throws {RequiredError}
|
|
85593
|
+
*/
|
|
85594
|
+
exportCustomReport(requestParameters, options) {
|
|
85595
|
+
return localVarFp.exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(axios, basePath));
|
|
85596
|
+
},
|
|
85531
85597
|
/**
|
|
85532
85598
|
* Get Custom Report endpoint
|
|
85533
85599
|
* @summary Get Custom Report
|
|
@@ -85604,6 +85670,16 @@ export class ReportsApi extends BaseAPI {
|
|
|
85604
85670
|
deleteCustomReport(requestParameters, options) {
|
|
85605
85671
|
return ReportsApiFp(this.configuration).deleteCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
|
|
85606
85672
|
}
|
|
85673
|
+
/**
|
|
85674
|
+
* Export Custom Report endpoint
|
|
85675
|
+
* @summary Export Custom Report
|
|
85676
|
+
* @param {ReportsApiExportCustomReportRequest} requestParameters Request parameters.
|
|
85677
|
+
* @param {*} [options] Override http request option.
|
|
85678
|
+
* @throws {RequiredError}
|
|
85679
|
+
*/
|
|
85680
|
+
exportCustomReport(requestParameters, options) {
|
|
85681
|
+
return ReportsApiFp(this.configuration).exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(this.axios, this.basePath));
|
|
85682
|
+
}
|
|
85607
85683
|
/**
|
|
85608
85684
|
* Get Custom Report endpoint
|
|
85609
85685
|
* @summary Get Custom Report
|
package/docs/BaseEvent.md
CHANGED
|
@@ -39,6 +39,7 @@ Name | Type | Description | Notes
|
|
|
39
39
|
**series** | [**BaseSeries**](BaseSeries.md) | | [default to undefined]
|
|
40
40
|
**paymentIntegrationId** | **string** | | [default to undefined]
|
|
41
41
|
**paymentIntegration** | [**BasePaymentIntegration**](BasePaymentIntegration.md) | | [default to undefined]
|
|
42
|
+
**archived** | **boolean** | | [default to undefined]
|
|
42
43
|
|
|
43
44
|
## Example
|
|
44
45
|
|
|
@@ -80,6 +81,7 @@ const instance: BaseEvent = {
|
|
|
80
81
|
series,
|
|
81
82
|
paymentIntegrationId,
|
|
82
83
|
paymentIntegration,
|
|
84
|
+
archived,
|
|
83
85
|
};
|
|
84
86
|
```
|
|
85
87
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# CustomReportExportInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { CustomReportExportInputs } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: CustomReportExportInputs = {
|
|
16
|
+
email,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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/Event.md
CHANGED
|
@@ -39,6 +39,7 @@ Name | Type | Description | Notes
|
|
|
39
39
|
**series** | [**BaseSeries**](BaseSeries.md) | | [default to undefined]
|
|
40
40
|
**paymentIntegrationId** | **string** | | [default to undefined]
|
|
41
41
|
**paymentIntegration** | [**BasePaymentIntegration**](BasePaymentIntegration.md) | | [default to undefined]
|
|
42
|
+
**archived** | **boolean** | | [default to undefined]
|
|
42
43
|
**roundName** | **string** | | [default to undefined]
|
|
43
44
|
**matchName** | **string** | | [default to undefined]
|
|
44
45
|
**passSupply** | **number** | | [default to undefined]
|
|
@@ -122,6 +123,7 @@ const instance: Event = {
|
|
|
122
123
|
series,
|
|
123
124
|
paymentIntegrationId,
|
|
124
125
|
paymentIntegration,
|
|
126
|
+
archived,
|
|
125
127
|
roundName,
|
|
126
128
|
matchName,
|
|
127
129
|
passSupply,
|
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**eventEnd** | **string** | | [default to undefined]
|
|
14
14
|
**featured** | **boolean** | | [optional] [default to undefined]
|
|
15
15
|
**visible** | **boolean** | | [optional] [default to undefined]
|
|
16
|
+
**archived** | **boolean** | | [optional] [default to undefined]
|
|
16
17
|
**slug** | **string** | | [optional] [default to undefined]
|
|
17
18
|
**internalRefId** | **string** | | [optional] [default to undefined]
|
|
18
19
|
**longDescription** | **string** | | [optional] [default to undefined]
|
|
@@ -80,6 +81,7 @@ const instance: EventCreateInputs = {
|
|
|
80
81
|
eventEnd,
|
|
81
82
|
featured,
|
|
82
83
|
visible,
|
|
84
|
+
archived,
|
|
83
85
|
slug,
|
|
84
86
|
internalRefId,
|
|
85
87
|
longDescription,
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**featured** | **boolean** | | [optional] [default to undefined]
|
|
9
9
|
**visible** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
**archived** | **boolean** | | [optional] [default to undefined]
|
|
10
11
|
**name** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**eventType** | [**EventType**](EventType.md) | | [optional] [default to undefined]
|
|
12
13
|
**slug** | **string** | | [optional] [default to undefined]
|
|
@@ -74,6 +75,7 @@ import { EventUpdateInputs } from '@connectedxm/admin-sdk';
|
|
|
74
75
|
const instance: EventUpdateInputs = {
|
|
75
76
|
featured,
|
|
76
77
|
visible,
|
|
78
|
+
archived,
|
|
77
79
|
name,
|
|
78
80
|
eventType,
|
|
79
81
|
slug,
|
package/docs/ReportsApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**createCustomReport**](#createcustomreport) | **POST** /reports/{standard} | Create Custom Report|
|
|
8
8
|
|[**deleteCustomReport**](#deletecustomreport) | **DELETE** /reports/custom/{reportId} | Delete Custom Report|
|
|
9
|
+
|[**exportCustomReport**](#exportcustomreport) | **POST** /reports/custom/{reportId}/export | Export Custom Report|
|
|
9
10
|
|[**getCustomReport**](#getcustomreport) | **GET** /reports/custom/{reportId} | Get Custom Report|
|
|
10
11
|
|[**getCustomReports**](#getcustomreports) | **GET** /reports/custom | Get Custom Reports|
|
|
11
12
|
|[**getReport**](#getreport) | **GET** /reports/{standard} | Get Report|
|
|
@@ -111,6 +112,61 @@ const { status, data } = await apiInstance.deleteCustomReport(
|
|
|
111
112
|
- **Accept**: application/json
|
|
112
113
|
|
|
113
114
|
|
|
115
|
+
### HTTP response details
|
|
116
|
+
| Status code | Description | Response headers |
|
|
117
|
+
|-------------|-------------|------------------|
|
|
118
|
+
|**200** | Successful response | - |
|
|
119
|
+
|
|
120
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
121
|
+
|
|
122
|
+
# **exportCustomReport**
|
|
123
|
+
> CreateAccountInvitations200Response exportCustomReport(customReportExportInputs)
|
|
124
|
+
|
|
125
|
+
Export Custom Report endpoint
|
|
126
|
+
|
|
127
|
+
### Example
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
import {
|
|
131
|
+
ReportsApi,
|
|
132
|
+
Configuration,
|
|
133
|
+
CustomReportExportInputs
|
|
134
|
+
} from '@connectedxm/admin-sdk';
|
|
135
|
+
|
|
136
|
+
const configuration = new Configuration();
|
|
137
|
+
const apiInstance = new ReportsApi(configuration);
|
|
138
|
+
|
|
139
|
+
let reportId: string; //The report identifier (default to undefined)
|
|
140
|
+
let customReportExportInputs: CustomReportExportInputs; //
|
|
141
|
+
|
|
142
|
+
const { status, data } = await apiInstance.exportCustomReport(
|
|
143
|
+
reportId,
|
|
144
|
+
customReportExportInputs
|
|
145
|
+
);
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Parameters
|
|
149
|
+
|
|
150
|
+
|Name | Type | Description | Notes|
|
|
151
|
+
|------------- | ------------- | ------------- | -------------|
|
|
152
|
+
| **customReportExportInputs** | **CustomReportExportInputs**| | |
|
|
153
|
+
| **reportId** | [**string**] | The report identifier | defaults to undefined|
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
### Return type
|
|
157
|
+
|
|
158
|
+
**CreateAccountInvitations200Response**
|
|
159
|
+
|
|
160
|
+
### Authorization
|
|
161
|
+
|
|
162
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
163
|
+
|
|
164
|
+
### HTTP request headers
|
|
165
|
+
|
|
166
|
+
- **Content-Type**: application/json
|
|
167
|
+
- **Accept**: application/json
|
|
168
|
+
|
|
169
|
+
|
|
114
170
|
### HTTP response details
|
|
115
171
|
| Status code | Description | Response headers |
|
|
116
172
|
|-------------|-------------|------------------|
|