@connectedxm/admin-sdk 6.24.2 → 6.24.4
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 +1 -0
- package/api.ts +24 -5
- package/dist/api.d.ts +16 -2
- package/dist/api.js +11 -5
- package/dist/esm/api.d.ts +16 -2
- package/dist/esm/api.js +11 -5
- package/docs/BaseSeries.md +4 -0
- package/docs/CustomReportExportInputs.md +20 -0
- package/docs/ReportsApi.md +8 -4
- package/docs/Series.md +4 -0
- package/docs/SeriesCreateInputs.md +4 -0
- package/docs/SeriesUpdateInputs.md +4 -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
|
@@ -1654,6 +1654,7 @@ Class | Method | HTTP request | Description
|
|
|
1654
1654
|
- [CustomModuleUpdateInputs](docs/CustomModuleUpdateInputs.md)
|
|
1655
1655
|
- [CustomReport](docs/CustomReport.md)
|
|
1656
1656
|
- [CustomReportCreateInputs](docs/CustomReportCreateInputs.md)
|
|
1657
|
+
- [CustomReportExportInputs](docs/CustomReportExportInputs.md)
|
|
1657
1658
|
- [CustomReportUpdateInputs](docs/CustomReportUpdateInputs.md)
|
|
1658
1659
|
- [Dashboard](docs/Dashboard.md)
|
|
1659
1660
|
- [DashboardCreateInputs](docs/DashboardCreateInputs.md)
|
package/api.ts
CHANGED
|
@@ -2207,6 +2207,8 @@ export interface BaseSeries {
|
|
|
2207
2207
|
'name': string;
|
|
2208
2208
|
'description': string | null;
|
|
2209
2209
|
'longDescription': string | null;
|
|
2210
|
+
'registration': boolean;
|
|
2211
|
+
'featured': boolean;
|
|
2210
2212
|
'startDate': string | null;
|
|
2211
2213
|
'endDate': string | null;
|
|
2212
2214
|
'imageId': string | null;
|
|
@@ -4522,6 +4524,9 @@ export interface CustomReportCreateInputs {
|
|
|
4522
4524
|
'gridState'?: string | null;
|
|
4523
4525
|
'shared'?: boolean;
|
|
4524
4526
|
}
|
|
4527
|
+
export interface CustomReportExportInputs {
|
|
4528
|
+
'email': string;
|
|
4529
|
+
}
|
|
4525
4530
|
export interface CustomReportUpdateInputs {
|
|
4526
4531
|
'name'?: string | null;
|
|
4527
4532
|
'description'?: string | null;
|
|
@@ -12349,6 +12354,8 @@ export interface Series {
|
|
|
12349
12354
|
'name': string;
|
|
12350
12355
|
'description': string | null;
|
|
12351
12356
|
'longDescription': string | null;
|
|
12357
|
+
'registration': boolean;
|
|
12358
|
+
'featured': boolean;
|
|
12352
12359
|
'startDate': string | null;
|
|
12353
12360
|
'endDate': string | null;
|
|
12354
12361
|
'imageId': string | null;
|
|
@@ -12378,6 +12385,8 @@ export interface SeriesCreateInputs {
|
|
|
12378
12385
|
'startDate'?: string | null;
|
|
12379
12386
|
'endDate'?: string | null;
|
|
12380
12387
|
'registration'?: boolean;
|
|
12388
|
+
'featured'?: boolean;
|
|
12389
|
+
'sortOrder'?: AdvertisementCreateInputsWeight | null;
|
|
12381
12390
|
'price'?: number;
|
|
12382
12391
|
'taxCode'?: string | null;
|
|
12383
12392
|
'taxIncluded'?: boolean;
|
|
@@ -12603,6 +12612,8 @@ export interface SeriesUpdateInputs {
|
|
|
12603
12612
|
'startDate'?: string | null;
|
|
12604
12613
|
'endDate'?: string | null;
|
|
12605
12614
|
'registration'?: boolean;
|
|
12615
|
+
'featured'?: boolean;
|
|
12616
|
+
'sortOrder'?: AdvertisementCreateInputsWeight | null;
|
|
12606
12617
|
'price'?: number;
|
|
12607
12618
|
'taxCode'?: string | null;
|
|
12608
12619
|
'taxIncluded'?: boolean;
|
|
@@ -122720,12 +122731,15 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
122720
122731
|
* Export Custom Report endpoint
|
|
122721
122732
|
* @summary Export Custom Report
|
|
122722
122733
|
* @param {string} reportId The report identifier
|
|
122734
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
122723
122735
|
* @param {*} [options] Override http request option.
|
|
122724
122736
|
* @throws {RequiredError}
|
|
122725
122737
|
*/
|
|
122726
|
-
exportCustomReport: async (reportId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
122738
|
+
exportCustomReport: async (reportId: string, customReportExportInputs: CustomReportExportInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
122727
122739
|
// verify required parameter 'reportId' is not null or undefined
|
|
122728
122740
|
assertParamExists('exportCustomReport', 'reportId', reportId)
|
|
122741
|
+
// verify required parameter 'customReportExportInputs' is not null or undefined
|
|
122742
|
+
assertParamExists('exportCustomReport', 'customReportExportInputs', customReportExportInputs)
|
|
122729
122743
|
const localVarPath = `/reports/custom/{reportId}/export`
|
|
122730
122744
|
.replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
|
|
122731
122745
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -122745,11 +122759,13 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
122745
122759
|
// authentication OrganizationId required
|
|
122746
122760
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
122747
122761
|
|
|
122762
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
122748
122763
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
122749
122764
|
|
|
122750
122765
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
122751
122766
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
122752
122767
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
122768
|
+
localVarRequestOptions.data = serializeDataIfNeeded(customReportExportInputs, localVarRequestOptions, configuration)
|
|
122753
122769
|
|
|
122754
122770
|
return {
|
|
122755
122771
|
url: toPathString(localVarUrlObj),
|
|
@@ -123038,11 +123054,12 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
123038
123054
|
* Export Custom Report endpoint
|
|
123039
123055
|
* @summary Export Custom Report
|
|
123040
123056
|
* @param {string} reportId The report identifier
|
|
123057
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
123041
123058
|
* @param {*} [options] Override http request option.
|
|
123042
123059
|
* @throws {RequiredError}
|
|
123043
123060
|
*/
|
|
123044
|
-
async exportCustomReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
123045
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomReport(reportId, options);
|
|
123061
|
+
async exportCustomReport(reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
123062
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomReport(reportId, customReportExportInputs, options);
|
|
123046
123063
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
123047
123064
|
const localVarOperationServerBasePath = operationServerMap['ReportsApi.exportCustomReport']?.[localVarOperationServerIndex]?.url;
|
|
123048
123065
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -123155,7 +123172,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
123155
123172
|
* @throws {RequiredError}
|
|
123156
123173
|
*/
|
|
123157
123174
|
exportCustomReport(requestParameters: ReportsApiExportCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
123158
|
-
return localVarFp.exportCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
|
|
123175
|
+
return localVarFp.exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(axios, basePath));
|
|
123159
123176
|
},
|
|
123160
123177
|
/**
|
|
123161
123178
|
* Get Custom Report endpoint
|
|
@@ -123240,6 +123257,8 @@ export interface ReportsApiExportCustomReportRequest {
|
|
|
123240
123257
|
* The report identifier
|
|
123241
123258
|
*/
|
|
123242
123259
|
readonly reportId: string
|
|
123260
|
+
|
|
123261
|
+
readonly customReportExportInputs: CustomReportExportInputs
|
|
123243
123262
|
}
|
|
123244
123263
|
|
|
123245
123264
|
/**
|
|
@@ -123356,7 +123375,7 @@ export class ReportsApi extends BaseAPI {
|
|
|
123356
123375
|
* @throws {RequiredError}
|
|
123357
123376
|
*/
|
|
123358
123377
|
public exportCustomReport(requestParameters: ReportsApiExportCustomReportRequest, options?: RawAxiosRequestConfig) {
|
|
123359
|
-
return ReportsApiFp(this.configuration).exportCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
|
|
123378
|
+
return ReportsApiFp(this.configuration).exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(this.axios, this.basePath));
|
|
123360
123379
|
}
|
|
123361
123380
|
|
|
123362
123381
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -2046,6 +2046,8 @@ export interface BaseSeries {
|
|
|
2046
2046
|
'name': string;
|
|
2047
2047
|
'description': string | null;
|
|
2048
2048
|
'longDescription': string | null;
|
|
2049
|
+
'registration': boolean;
|
|
2050
|
+
'featured': boolean;
|
|
2049
2051
|
'startDate': string | null;
|
|
2050
2052
|
'endDate': string | null;
|
|
2051
2053
|
'imageId': string | null;
|
|
@@ -4091,6 +4093,9 @@ export interface CustomReportCreateInputs {
|
|
|
4091
4093
|
'gridState'?: string | null;
|
|
4092
4094
|
'shared'?: boolean;
|
|
4093
4095
|
}
|
|
4096
|
+
export interface CustomReportExportInputs {
|
|
4097
|
+
'email': string;
|
|
4098
|
+
}
|
|
4094
4099
|
export interface CustomReportUpdateInputs {
|
|
4095
4100
|
'name'?: string | null;
|
|
4096
4101
|
'description'?: string | null;
|
|
@@ -10946,6 +10951,8 @@ export interface Series {
|
|
|
10946
10951
|
'name': string;
|
|
10947
10952
|
'description': string | null;
|
|
10948
10953
|
'longDescription': string | null;
|
|
10954
|
+
'registration': boolean;
|
|
10955
|
+
'featured': boolean;
|
|
10949
10956
|
'startDate': string | null;
|
|
10950
10957
|
'endDate': string | null;
|
|
10951
10958
|
'imageId': string | null;
|
|
@@ -10973,6 +10980,8 @@ export interface SeriesCreateInputs {
|
|
|
10973
10980
|
'startDate'?: string | null;
|
|
10974
10981
|
'endDate'?: string | null;
|
|
10975
10982
|
'registration'?: boolean;
|
|
10983
|
+
'featured'?: boolean;
|
|
10984
|
+
'sortOrder'?: AdvertisementCreateInputsWeight | null;
|
|
10976
10985
|
'price'?: number;
|
|
10977
10986
|
'taxCode'?: string | null;
|
|
10978
10987
|
'taxIncluded'?: boolean;
|
|
@@ -11182,6 +11191,8 @@ export interface SeriesUpdateInputs {
|
|
|
11182
11191
|
'startDate'?: string | null;
|
|
11183
11192
|
'endDate'?: string | null;
|
|
11184
11193
|
'registration'?: boolean;
|
|
11194
|
+
'featured'?: boolean;
|
|
11195
|
+
'sortOrder'?: AdvertisementCreateInputsWeight | null;
|
|
11185
11196
|
'price'?: number;
|
|
11186
11197
|
'taxCode'?: string | null;
|
|
11187
11198
|
'taxIncluded'?: boolean;
|
|
@@ -67546,10 +67557,11 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
67546
67557
|
* Export Custom Report endpoint
|
|
67547
67558
|
* @summary Export Custom Report
|
|
67548
67559
|
* @param {string} reportId The report identifier
|
|
67560
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
67549
67561
|
* @param {*} [options] Override http request option.
|
|
67550
67562
|
* @throws {RequiredError}
|
|
67551
67563
|
*/
|
|
67552
|
-
exportCustomReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67564
|
+
exportCustomReport: (reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67553
67565
|
/**
|
|
67554
67566
|
* Get Custom Report endpoint
|
|
67555
67567
|
* @summary Get Custom Report
|
|
@@ -67622,10 +67634,11 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
67622
67634
|
* Export Custom Report endpoint
|
|
67623
67635
|
* @summary Export Custom Report
|
|
67624
67636
|
* @param {string} reportId The report identifier
|
|
67637
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
67625
67638
|
* @param {*} [options] Override http request option.
|
|
67626
67639
|
* @throws {RequiredError}
|
|
67627
67640
|
*/
|
|
67628
|
-
exportCustomReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67641
|
+
exportCustomReport(reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67629
67642
|
/**
|
|
67630
67643
|
* Get Custom Report endpoint
|
|
67631
67644
|
* @summary Get Custom Report
|
|
@@ -67769,6 +67782,7 @@ export interface ReportsApiExportCustomReportRequest {
|
|
|
67769
67782
|
* The report identifier
|
|
67770
67783
|
*/
|
|
67771
67784
|
readonly reportId: string;
|
|
67785
|
+
readonly customReportExportInputs: CustomReportExportInputs;
|
|
67772
67786
|
}
|
|
67773
67787
|
/**
|
|
67774
67788
|
* Request parameters for getCustomReport operation in ReportsApi.
|
package/dist/api.js
CHANGED
|
@@ -85798,12 +85798,15 @@ const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
85798
85798
|
* Export Custom Report endpoint
|
|
85799
85799
|
* @summary Export Custom Report
|
|
85800
85800
|
* @param {string} reportId The report identifier
|
|
85801
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
85801
85802
|
* @param {*} [options] Override http request option.
|
|
85802
85803
|
* @throws {RequiredError}
|
|
85803
85804
|
*/
|
|
85804
|
-
exportCustomReport: (reportId_1, ...args_1) => __awaiter(this, [reportId_1, ...args_1], void 0, function* (reportId, options = {}) {
|
|
85805
|
+
exportCustomReport: (reportId_1, customReportExportInputs_1, ...args_1) => __awaiter(this, [reportId_1, customReportExportInputs_1, ...args_1], void 0, function* (reportId, customReportExportInputs, options = {}) {
|
|
85805
85806
|
// verify required parameter 'reportId' is not null or undefined
|
|
85806
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);
|
|
85807
85810
|
const localVarPath = `/reports/custom/{reportId}/export`
|
|
85808
85811
|
.replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
|
|
85809
85812
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -85819,10 +85822,12 @@ const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
85819
85822
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
85820
85823
|
// authentication OrganizationId required
|
|
85821
85824
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
85825
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
85822
85826
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
85823
85827
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
85824
85828
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
85825
85829
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
85830
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(customReportExportInputs, localVarRequestOptions, configuration);
|
|
85826
85831
|
return {
|
|
85827
85832
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
85828
85833
|
options: localVarRequestOptions,
|
|
@@ -86078,13 +86083,14 @@ const ReportsApiFp = function (configuration) {
|
|
|
86078
86083
|
* Export Custom Report endpoint
|
|
86079
86084
|
* @summary Export Custom Report
|
|
86080
86085
|
* @param {string} reportId The report identifier
|
|
86086
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
86081
86087
|
* @param {*} [options] Override http request option.
|
|
86082
86088
|
* @throws {RequiredError}
|
|
86083
86089
|
*/
|
|
86084
|
-
exportCustomReport(reportId, options) {
|
|
86090
|
+
exportCustomReport(reportId, customReportExportInputs, options) {
|
|
86085
86091
|
return __awaiter(this, void 0, void 0, function* () {
|
|
86086
86092
|
var _a, _b, _c;
|
|
86087
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomReport(reportId, options);
|
|
86093
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomReport(reportId, customReportExportInputs, options);
|
|
86088
86094
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
86089
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;
|
|
86090
86096
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -86213,7 +86219,7 @@ const ReportsApiFactory = function (configuration, basePath, axios) {
|
|
|
86213
86219
|
* @throws {RequiredError}
|
|
86214
86220
|
*/
|
|
86215
86221
|
exportCustomReport(requestParameters, options) {
|
|
86216
|
-
return localVarFp.exportCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
|
|
86222
|
+
return localVarFp.exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(axios, basePath));
|
|
86217
86223
|
},
|
|
86218
86224
|
/**
|
|
86219
86225
|
* Get Custom Report endpoint
|
|
@@ -86300,7 +86306,7 @@ class ReportsApi extends base_1.BaseAPI {
|
|
|
86300
86306
|
* @throws {RequiredError}
|
|
86301
86307
|
*/
|
|
86302
86308
|
exportCustomReport(requestParameters, options) {
|
|
86303
|
-
return (0, exports.ReportsApiFp)(this.configuration).exportCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
|
|
86309
|
+
return (0, exports.ReportsApiFp)(this.configuration).exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(this.axios, this.basePath));
|
|
86304
86310
|
}
|
|
86305
86311
|
/**
|
|
86306
86312
|
* Get Custom Report endpoint
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2046,6 +2046,8 @@ export interface BaseSeries {
|
|
|
2046
2046
|
'name': string;
|
|
2047
2047
|
'description': string | null;
|
|
2048
2048
|
'longDescription': string | null;
|
|
2049
|
+
'registration': boolean;
|
|
2050
|
+
'featured': boolean;
|
|
2049
2051
|
'startDate': string | null;
|
|
2050
2052
|
'endDate': string | null;
|
|
2051
2053
|
'imageId': string | null;
|
|
@@ -4091,6 +4093,9 @@ export interface CustomReportCreateInputs {
|
|
|
4091
4093
|
'gridState'?: string | null;
|
|
4092
4094
|
'shared'?: boolean;
|
|
4093
4095
|
}
|
|
4096
|
+
export interface CustomReportExportInputs {
|
|
4097
|
+
'email': string;
|
|
4098
|
+
}
|
|
4094
4099
|
export interface CustomReportUpdateInputs {
|
|
4095
4100
|
'name'?: string | null;
|
|
4096
4101
|
'description'?: string | null;
|
|
@@ -10946,6 +10951,8 @@ export interface Series {
|
|
|
10946
10951
|
'name': string;
|
|
10947
10952
|
'description': string | null;
|
|
10948
10953
|
'longDescription': string | null;
|
|
10954
|
+
'registration': boolean;
|
|
10955
|
+
'featured': boolean;
|
|
10949
10956
|
'startDate': string | null;
|
|
10950
10957
|
'endDate': string | null;
|
|
10951
10958
|
'imageId': string | null;
|
|
@@ -10973,6 +10980,8 @@ export interface SeriesCreateInputs {
|
|
|
10973
10980
|
'startDate'?: string | null;
|
|
10974
10981
|
'endDate'?: string | null;
|
|
10975
10982
|
'registration'?: boolean;
|
|
10983
|
+
'featured'?: boolean;
|
|
10984
|
+
'sortOrder'?: AdvertisementCreateInputsWeight | null;
|
|
10976
10985
|
'price'?: number;
|
|
10977
10986
|
'taxCode'?: string | null;
|
|
10978
10987
|
'taxIncluded'?: boolean;
|
|
@@ -11182,6 +11191,8 @@ export interface SeriesUpdateInputs {
|
|
|
11182
11191
|
'startDate'?: string | null;
|
|
11183
11192
|
'endDate'?: string | null;
|
|
11184
11193
|
'registration'?: boolean;
|
|
11194
|
+
'featured'?: boolean;
|
|
11195
|
+
'sortOrder'?: AdvertisementCreateInputsWeight | null;
|
|
11185
11196
|
'price'?: number;
|
|
11186
11197
|
'taxCode'?: string | null;
|
|
11187
11198
|
'taxIncluded'?: boolean;
|
|
@@ -67546,10 +67557,11 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
67546
67557
|
* Export Custom Report endpoint
|
|
67547
67558
|
* @summary Export Custom Report
|
|
67548
67559
|
* @param {string} reportId The report identifier
|
|
67560
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
67549
67561
|
* @param {*} [options] Override http request option.
|
|
67550
67562
|
* @throws {RequiredError}
|
|
67551
67563
|
*/
|
|
67552
|
-
exportCustomReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67564
|
+
exportCustomReport: (reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67553
67565
|
/**
|
|
67554
67566
|
* Get Custom Report endpoint
|
|
67555
67567
|
* @summary Get Custom Report
|
|
@@ -67622,10 +67634,11 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
67622
67634
|
* Export Custom Report endpoint
|
|
67623
67635
|
* @summary Export Custom Report
|
|
67624
67636
|
* @param {string} reportId The report identifier
|
|
67637
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
67625
67638
|
* @param {*} [options] Override http request option.
|
|
67626
67639
|
* @throws {RequiredError}
|
|
67627
67640
|
*/
|
|
67628
|
-
exportCustomReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67641
|
+
exportCustomReport(reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67629
67642
|
/**
|
|
67630
67643
|
* Get Custom Report endpoint
|
|
67631
67644
|
* @summary Get Custom Report
|
|
@@ -67769,6 +67782,7 @@ export interface ReportsApiExportCustomReportRequest {
|
|
|
67769
67782
|
* The report identifier
|
|
67770
67783
|
*/
|
|
67771
67784
|
readonly reportId: string;
|
|
67785
|
+
readonly customReportExportInputs: CustomReportExportInputs;
|
|
67772
67786
|
}
|
|
67773
67787
|
/**
|
|
67774
67788
|
* Request parameters for getCustomReport operation in ReportsApi.
|
package/dist/esm/api.js
CHANGED
|
@@ -85173,12 +85173,15 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
85173
85173
|
* Export Custom Report endpoint
|
|
85174
85174
|
* @summary Export Custom Report
|
|
85175
85175
|
* @param {string} reportId The report identifier
|
|
85176
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
85176
85177
|
* @param {*} [options] Override http request option.
|
|
85177
85178
|
* @throws {RequiredError}
|
|
85178
85179
|
*/
|
|
85179
|
-
exportCustomReport: (reportId_1, ...args_1) => __awaiter(this, [reportId_1, ...args_1], void 0, function* (reportId, options = {}) {
|
|
85180
|
+
exportCustomReport: (reportId_1, customReportExportInputs_1, ...args_1) => __awaiter(this, [reportId_1, customReportExportInputs_1, ...args_1], void 0, function* (reportId, customReportExportInputs, options = {}) {
|
|
85180
85181
|
// verify required parameter 'reportId' is not null or undefined
|
|
85181
85182
|
assertParamExists('exportCustomReport', 'reportId', reportId);
|
|
85183
|
+
// verify required parameter 'customReportExportInputs' is not null or undefined
|
|
85184
|
+
assertParamExists('exportCustomReport', 'customReportExportInputs', customReportExportInputs);
|
|
85182
85185
|
const localVarPath = `/reports/custom/{reportId}/export`
|
|
85183
85186
|
.replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
|
|
85184
85187
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -85194,10 +85197,12 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
|
|
|
85194
85197
|
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
85195
85198
|
// authentication OrganizationId required
|
|
85196
85199
|
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
85200
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
85197
85201
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
85198
85202
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
85199
85203
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
85200
85204
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
85205
|
+
localVarRequestOptions.data = serializeDataIfNeeded(customReportExportInputs, localVarRequestOptions, configuration);
|
|
85201
85206
|
return {
|
|
85202
85207
|
url: toPathString(localVarUrlObj),
|
|
85203
85208
|
options: localVarRequestOptions,
|
|
@@ -85452,13 +85457,14 @@ export const ReportsApiFp = function (configuration) {
|
|
|
85452
85457
|
* Export Custom Report endpoint
|
|
85453
85458
|
* @summary Export Custom Report
|
|
85454
85459
|
* @param {string} reportId The report identifier
|
|
85460
|
+
* @param {CustomReportExportInputs} customReportExportInputs
|
|
85455
85461
|
* @param {*} [options] Override http request option.
|
|
85456
85462
|
* @throws {RequiredError}
|
|
85457
85463
|
*/
|
|
85458
|
-
exportCustomReport(reportId, options) {
|
|
85464
|
+
exportCustomReport(reportId, customReportExportInputs, options) {
|
|
85459
85465
|
return __awaiter(this, void 0, void 0, function* () {
|
|
85460
85466
|
var _a, _b, _c;
|
|
85461
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomReport(reportId, options);
|
|
85467
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomReport(reportId, customReportExportInputs, options);
|
|
85462
85468
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85463
85469
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReportsApi.exportCustomReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85464
85470
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -85586,7 +85592,7 @@ export const ReportsApiFactory = function (configuration, basePath, axios) {
|
|
|
85586
85592
|
* @throws {RequiredError}
|
|
85587
85593
|
*/
|
|
85588
85594
|
exportCustomReport(requestParameters, options) {
|
|
85589
|
-
return localVarFp.exportCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
|
|
85595
|
+
return localVarFp.exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(axios, basePath));
|
|
85590
85596
|
},
|
|
85591
85597
|
/**
|
|
85592
85598
|
* Get Custom Report endpoint
|
|
@@ -85672,7 +85678,7 @@ export class ReportsApi extends BaseAPI {
|
|
|
85672
85678
|
* @throws {RequiredError}
|
|
85673
85679
|
*/
|
|
85674
85680
|
exportCustomReport(requestParameters, options) {
|
|
85675
|
-
return ReportsApiFp(this.configuration).exportCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
|
|
85681
|
+
return ReportsApiFp(this.configuration).exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(this.axios, this.basePath));
|
|
85676
85682
|
}
|
|
85677
85683
|
/**
|
|
85678
85684
|
* Get Custom Report endpoint
|
package/docs/BaseSeries.md
CHANGED
|
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**name** | **string** | | [default to undefined]
|
|
11
11
|
**description** | **string** | | [default to undefined]
|
|
12
12
|
**longDescription** | **string** | | [default to undefined]
|
|
13
|
+
**registration** | **boolean** | | [default to undefined]
|
|
14
|
+
**featured** | **boolean** | | [default to undefined]
|
|
13
15
|
**startDate** | **string** | | [default to undefined]
|
|
14
16
|
**endDate** | **string** | | [default to undefined]
|
|
15
17
|
**imageId** | **string** | | [default to undefined]
|
|
@@ -26,6 +28,8 @@ const instance: BaseSeries = {
|
|
|
26
28
|
name,
|
|
27
29
|
description,
|
|
28
30
|
longDescription,
|
|
31
|
+
registration,
|
|
32
|
+
featured,
|
|
29
33
|
startDate,
|
|
30
34
|
endDate,
|
|
31
35
|
imageId,
|
|
@@ -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/ReportsApi.md
CHANGED
|
@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.deleteCustomReport(
|
|
|
120
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
121
|
|
|
122
122
|
# **exportCustomReport**
|
|
123
|
-
> CreateAccountInvitations200Response exportCustomReport()
|
|
123
|
+
> CreateAccountInvitations200Response exportCustomReport(customReportExportInputs)
|
|
124
124
|
|
|
125
125
|
Export Custom Report endpoint
|
|
126
126
|
|
|
@@ -129,16 +129,19 @@ Export Custom Report endpoint
|
|
|
129
129
|
```typescript
|
|
130
130
|
import {
|
|
131
131
|
ReportsApi,
|
|
132
|
-
Configuration
|
|
132
|
+
Configuration,
|
|
133
|
+
CustomReportExportInputs
|
|
133
134
|
} from '@connectedxm/admin-sdk';
|
|
134
135
|
|
|
135
136
|
const configuration = new Configuration();
|
|
136
137
|
const apiInstance = new ReportsApi(configuration);
|
|
137
138
|
|
|
138
139
|
let reportId: string; //The report identifier (default to undefined)
|
|
140
|
+
let customReportExportInputs: CustomReportExportInputs; //
|
|
139
141
|
|
|
140
142
|
const { status, data } = await apiInstance.exportCustomReport(
|
|
141
|
-
reportId
|
|
143
|
+
reportId,
|
|
144
|
+
customReportExportInputs
|
|
142
145
|
);
|
|
143
146
|
```
|
|
144
147
|
|
|
@@ -146,6 +149,7 @@ const { status, data } = await apiInstance.exportCustomReport(
|
|
|
146
149
|
|
|
147
150
|
|Name | Type | Description | Notes|
|
|
148
151
|
|------------- | ------------- | ------------- | -------------|
|
|
152
|
+
| **customReportExportInputs** | **CustomReportExportInputs**| | |
|
|
149
153
|
| **reportId** | [**string**] | The report identifier | defaults to undefined|
|
|
150
154
|
|
|
151
155
|
|
|
@@ -159,7 +163,7 @@ const { status, data } = await apiInstance.exportCustomReport(
|
|
|
159
163
|
|
|
160
164
|
### HTTP request headers
|
|
161
165
|
|
|
162
|
-
- **Content-Type**:
|
|
166
|
+
- **Content-Type**: application/json
|
|
163
167
|
- **Accept**: application/json
|
|
164
168
|
|
|
165
169
|
|
package/docs/Series.md
CHANGED
|
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**name** | **string** | | [default to undefined]
|
|
11
11
|
**description** | **string** | | [default to undefined]
|
|
12
12
|
**longDescription** | **string** | | [default to undefined]
|
|
13
|
+
**registration** | **boolean** | | [default to undefined]
|
|
14
|
+
**featured** | **boolean** | | [default to undefined]
|
|
13
15
|
**startDate** | **string** | | [default to undefined]
|
|
14
16
|
**endDate** | **string** | | [default to undefined]
|
|
15
17
|
**imageId** | **string** | | [default to undefined]
|
|
@@ -38,6 +40,8 @@ const instance: Series = {
|
|
|
38
40
|
name,
|
|
39
41
|
description,
|
|
40
42
|
longDescription,
|
|
43
|
+
registration,
|
|
44
|
+
featured,
|
|
41
45
|
startDate,
|
|
42
46
|
endDate,
|
|
43
47
|
imageId,
|
|
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**startDate** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**endDate** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**registration** | **boolean** | | [optional] [default to undefined]
|
|
17
|
+
**featured** | **boolean** | | [optional] [default to undefined]
|
|
18
|
+
**sortOrder** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
17
19
|
**price** | **number** | | [optional] [default to undefined]
|
|
18
20
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
19
21
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
@@ -37,6 +39,8 @@ const instance: SeriesCreateInputs = {
|
|
|
37
39
|
startDate,
|
|
38
40
|
endDate,
|
|
39
41
|
registration,
|
|
42
|
+
featured,
|
|
43
|
+
sortOrder,
|
|
40
44
|
price,
|
|
41
45
|
taxCode,
|
|
42
46
|
taxIncluded,
|
|
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**startDate** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**endDate** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**registration** | **boolean** | | [optional] [default to undefined]
|
|
17
|
+
**featured** | **boolean** | | [optional] [default to undefined]
|
|
18
|
+
**sortOrder** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
17
19
|
**price** | **number** | | [optional] [default to undefined]
|
|
18
20
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
19
21
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
@@ -37,6 +39,8 @@ const instance: SeriesUpdateInputs = {
|
|
|
37
39
|
startDate,
|
|
38
40
|
endDate,
|
|
39
41
|
registration,
|
|
42
|
+
featured,
|
|
43
|
+
sortOrder,
|
|
40
44
|
price,
|
|
41
45
|
taxCode,
|
|
42
46
|
taxIncluded,
|