@connectedxm/admin-sdk 6.24.2 → 6.24.3

package/.openapi-generator/FILES

@@ -448,6 +448,7 @@ docs/CustomModuleTranslationUpdateInputs.md
 docs/CustomModuleUpdateInputs.md
 docs/CustomReport.md
 docs/CustomReportCreateInputs.md
+docs/CustomReportExportInputs.md
 docs/CustomReportUpdateInputs.md
 docs/Dashboard.md
 docs/DashboardCreateInputs.md

package/README.md

@@ -1654,6 +1654,7 @@ Class | Method | HTTP request | Description
  - [CustomModuleUpdateInputs](docs/CustomModuleUpdateInputs.md)
  - [CustomReport](docs/CustomReport.md)
  - [CustomReportCreateInputs](docs/CustomReportCreateInputs.md)
+ - [CustomReportExportInputs](docs/CustomReportExportInputs.md)
  - [CustomReportUpdateInputs](docs/CustomReportUpdateInputs.md)
  - [Dashboard](docs/Dashboard.md)
  - [DashboardCreateInputs](docs/DashboardCreateInputs.md)

package/api.ts

@@ -4522,6 +4522,9 @@ export interface CustomReportCreateInputs {
     'gridState'?: string | null;
     'shared'?: boolean;
 }
+export interface CustomReportExportInputs {
+    'email': string;
+}
 export interface CustomReportUpdateInputs {
     'name'?: string | null;
     'description'?: string | null;
@@ -122720,12 +122723,15 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
          * Export Custom Report endpoint
          * @summary Export Custom Report
          * @param {string} reportId The report identifier
+         * @param {CustomReportExportInputs} customReportExportInputs 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        exportCustomReport: async (reportId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        exportCustomReport: async (reportId: string, customReportExportInputs: CustomReportExportInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'reportId' is not null or undefined
             assertParamExists('exportCustomReport', 'reportId', reportId)
+            // verify required parameter 'customReportExportInputs' is not null or undefined
+            assertParamExists('exportCustomReport', 'customReportExportInputs', customReportExportInputs)
             const localVarPath = `/reports/custom/{reportId}/export`
                 .replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -122745,11 +122751,13 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
             // authentication OrganizationId required
             await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
 
+            localVarHeaderParameter['Content-Type'] = 'application/json';
             localVarHeaderParameter['Accept'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(customReportExportInputs, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -123038,11 +123046,12 @@ export const ReportsApiFp = function(configuration?: Configuration) {
          * Export Custom Report endpoint
          * @summary Export Custom Report
          * @param {string} reportId The report identifier
+         * @param {CustomReportExportInputs} customReportExportInputs 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async exportCustomReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomReport(reportId, options);
+        async exportCustomReport(reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomReport(reportId, customReportExportInputs, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ReportsApi.exportCustomReport']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -123155,7 +123164,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
          * @throws {RequiredError}
          */
         exportCustomReport(requestParameters: ReportsApiExportCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
-            return localVarFp.exportCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
+            return localVarFp.exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(axios, basePath));
         },
         /**
          * Get Custom Report endpoint
@@ -123240,6 +123249,8 @@ export interface ReportsApiExportCustomReportRequest {
      * The report identifier
      */
     readonly reportId: string
+
+    readonly customReportExportInputs: CustomReportExportInputs
 }
 
 /**
@@ -123356,7 +123367,7 @@ export class ReportsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     public exportCustomReport(requestParameters: ReportsApiExportCustomReportRequest, options?: RawAxiosRequestConfig) {
-        return ReportsApiFp(this.configuration).exportCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
+        return ReportsApiFp(this.configuration).exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/dist/api.d.ts

@@ -4091,6 +4091,9 @@ export interface CustomReportCreateInputs {
     'gridState'?: string | null;
     'shared'?: boolean;
 }
+export interface CustomReportExportInputs {
+    'email': string;
+}
 export interface CustomReportUpdateInputs {
     'name'?: string | null;
     'description'?: string | null;
@@ -67546,10 +67549,11 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
      * Export Custom Report endpoint
      * @summary Export Custom Report
      * @param {string} reportId The report identifier
+     * @param {CustomReportExportInputs} customReportExportInputs
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    exportCustomReport: (reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Custom Report endpoint
      * @summary Get Custom Report
@@ -67622,10 +67626,11 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
      * Export Custom Report endpoint
      * @summary Export Custom Report
      * @param {string} reportId The report identifier
+     * @param {CustomReportExportInputs} customReportExportInputs
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
+    exportCustomReport(reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
     /**
      * Get Custom Report endpoint
      * @summary Get Custom Report
@@ -67769,6 +67774,7 @@ export interface ReportsApiExportCustomReportRequest {
      * The report identifier
      */
     readonly reportId: string;
+    readonly customReportExportInputs: CustomReportExportInputs;
 }
 /**
  * Request parameters for getCustomReport operation in ReportsApi.

package/dist/api.js

@@ -85798,12 +85798,15 @@ const ReportsApiAxiosParamCreator = function (configuration) {
          * Export Custom Report endpoint
          * @summary Export Custom Report
          * @param {string} reportId The report identifier
+         * @param {CustomReportExportInputs} customReportExportInputs
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        exportCustomReport: (reportId_1, ...args_1) => __awaiter(this, [reportId_1, ...args_1], void 0, function* (reportId, options = {}) {
+        exportCustomReport: (reportId_1, customReportExportInputs_1, ...args_1) => __awaiter(this, [reportId_1, customReportExportInputs_1, ...args_1], void 0, function* (reportId, customReportExportInputs, options = {}) {
             // verify required parameter 'reportId' is not null or undefined
             (0, common_1.assertParamExists)('exportCustomReport', 'reportId', reportId);
+            // verify required parameter 'customReportExportInputs' is not null or undefined
+            (0, common_1.assertParamExists)('exportCustomReport', 'customReportExportInputs', customReportExportInputs);
             const localVarPath = `/reports/custom/{reportId}/export`
                 .replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -85819,10 +85822,12 @@ const ReportsApiAxiosParamCreator = function (configuration) {
             yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
             // authentication OrganizationId required
             yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
             localVarHeaderParameter['Accept'] = 'application/json';
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(customReportExportInputs, localVarRequestOptions, configuration);
             return {
                 url: (0, common_1.toPathString)(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -86078,13 +86083,14 @@ const ReportsApiFp = function (configuration) {
          * Export Custom Report endpoint
          * @summary Export Custom Report
          * @param {string} reportId The report identifier
+         * @param {CustomReportExportInputs} customReportExportInputs
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        exportCustomReport(reportId, options) {
+        exportCustomReport(reportId, customReportExportInputs, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomReport(reportId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomReport(reportId, customReportExportInputs, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 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;
                 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) {
          * @throws {RequiredError}
          */
         exportCustomReport(requestParameters, options) {
-            return localVarFp.exportCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
+            return localVarFp.exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(axios, basePath));
         },
         /**
          * Get Custom Report endpoint
@@ -86300,7 +86306,7 @@ class ReportsApi extends base_1.BaseAPI {
      * @throws {RequiredError}
      */
     exportCustomReport(requestParameters, options) {
-        return (0, exports.ReportsApiFp)(this.configuration).exportCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.ReportsApiFp)(this.configuration).exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Get Custom Report endpoint

package/dist/esm/api.d.ts

@@ -4091,6 +4091,9 @@ export interface CustomReportCreateInputs {
     'gridState'?: string | null;
     'shared'?: boolean;
 }
+export interface CustomReportExportInputs {
+    'email': string;
+}
 export interface CustomReportUpdateInputs {
     'name'?: string | null;
     'description'?: string | null;
@@ -67546,10 +67549,11 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
      * Export Custom Report endpoint
      * @summary Export Custom Report
      * @param {string} reportId The report identifier
+     * @param {CustomReportExportInputs} customReportExportInputs
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    exportCustomReport: (reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Custom Report endpoint
      * @summary Get Custom Report
@@ -67622,10 +67626,11 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
      * Export Custom Report endpoint
      * @summary Export Custom Report
      * @param {string} reportId The report identifier
+     * @param {CustomReportExportInputs} customReportExportInputs
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportCustomReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
+    exportCustomReport(reportId: string, customReportExportInputs: CustomReportExportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
     /**
      * Get Custom Report endpoint
      * @summary Get Custom Report
@@ -67769,6 +67774,7 @@ export interface ReportsApiExportCustomReportRequest {
      * The report identifier
      */
     readonly reportId: string;
+    readonly customReportExportInputs: CustomReportExportInputs;
 }
 /**
  * Request parameters for getCustomReport operation in ReportsApi.

package/dist/esm/api.js

@@ -85173,12 +85173,15 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
          * Export Custom Report endpoint
          * @summary Export Custom Report
          * @param {string} reportId The report identifier
+         * @param {CustomReportExportInputs} customReportExportInputs
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        exportCustomReport: (reportId_1, ...args_1) => __awaiter(this, [reportId_1, ...args_1], void 0, function* (reportId, options = {}) {
+        exportCustomReport: (reportId_1, customReportExportInputs_1, ...args_1) => __awaiter(this, [reportId_1, customReportExportInputs_1, ...args_1], void 0, function* (reportId, customReportExportInputs, options = {}) {
             // verify required parameter 'reportId' is not null or undefined
             assertParamExists('exportCustomReport', 'reportId', reportId);
+            // verify required parameter 'customReportExportInputs' is not null or undefined
+            assertParamExists('exportCustomReport', 'customReportExportInputs', customReportExportInputs);
             const localVarPath = `/reports/custom/{reportId}/export`
                 .replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -85194,10 +85197,12 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
             yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
             // authentication OrganizationId required
             yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
             localVarHeaderParameter['Accept'] = 'application/json';
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(customReportExportInputs, localVarRequestOptions, configuration);
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -85452,13 +85457,14 @@ export const ReportsApiFp = function (configuration) {
          * Export Custom Report endpoint
          * @summary Export Custom Report
          * @param {string} reportId The report identifier
+         * @param {CustomReportExportInputs} customReportExportInputs
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        exportCustomReport(reportId, options) {
+        exportCustomReport(reportId, customReportExportInputs, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomReport(reportId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomReport(reportId, customReportExportInputs, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReportsApi.exportCustomReport']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -85586,7 +85592,7 @@ export const ReportsApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         exportCustomReport(requestParameters, options) {
-            return localVarFp.exportCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
+            return localVarFp.exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(axios, basePath));
         },
         /**
          * Get Custom Report endpoint
@@ -85672,7 +85678,7 @@ export class ReportsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     exportCustomReport(requestParameters, options) {
-        return ReportsApiFp(this.configuration).exportCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
+        return ReportsApiFp(this.configuration).exportCustomReport(requestParameters.reportId, requestParameters.customReportExportInputs, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Get Custom Report endpoint

package/docs/CustomReportExportInputs.md

@@ -0,0 +1,20 @@
+# CustomReportExportInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CustomReportExportInputs } from '@connectedxm/admin-sdk';
+
+const instance: CustomReportExportInputs = {
+    email,
+};
+```
+
+[[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

@@ -120,7 +120,7 @@ const { status, data } = await apiInstance.deleteCustomReport(
 [[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)
 
 # **exportCustomReport**
-> CreateAccountInvitations200Response exportCustomReport()
+> CreateAccountInvitations200Response exportCustomReport(customReportExportInputs)
 
 Export Custom Report endpoint
 
@@ -129,16 +129,19 @@ Export Custom Report endpoint
 ```typescript
 import {
     ReportsApi,
-    Configuration
+    Configuration,
+    CustomReportExportInputs
 } from '@connectedxm/admin-sdk';
 
 const configuration = new Configuration();
 const apiInstance = new ReportsApi(configuration);
 
 let reportId: string; //The report identifier (default to undefined)
+let customReportExportInputs: CustomReportExportInputs; //
 
 const { status, data } = await apiInstance.exportCustomReport(
-    reportId
+    reportId,
+    customReportExportInputs
 );
 ```
 
@@ -146,6 +149,7 @@ const { status, data } = await apiInstance.exportCustomReport(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **customReportExportInputs** | **CustomReportExportInputs**|  | |
 | **reportId** | [**string**] | The report identifier | defaults to undefined|
 
 
@@ -159,7 +163,7 @@ const { status, data } = await apiInstance.exportCustomReport(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "6.24.2",
+  "version": "6.24.3",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {