@connectreport/connectreport-js 2.81.0-beta.3 → 2.81.0-beta.4

package/dist/index.d.cts

@@ -5,7 +5,7 @@ import { AxiosInstance, AxiosPromise } from 'axios';
  * ConnectReport Core API
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
  *
- * The version of the OpenAPI document: 2.80.5
+ * The version of the OpenAPI document: 2.81.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -91,7 +91,7 @@ declare class Configuration {
  * ConnectReport Core API
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
  *
- * The version of the OpenAPI document: 2.80.5
+ * The version of the OpenAPI document: 2.81.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -150,6 +150,12 @@ interface CycleConfig {
      * @memberof CycleConfig
      */
     tableColumns: Array<FieldInfo>;
+    /**
+     * Maximum number of rows to fetch from the data source
+     * @type {number}
+     * @memberof CycleConfig
+     */
+    tableHeight?: number;
     /**
      *
      * @type {RowExclusion}
@@ -1067,12 +1073,24 @@ interface ReportTaskCustomSelection {
      * @memberof ReportTaskCustomSelection
      */
     fieldDef?: string;
+    /**
+     * The name of the table containing this field.
+     * @type {string}
+     * @memberof ReportTaskCustomSelection
+     */
+    tableName?: string;
     /**
      *
      * @type {Array<ReportTaskFieldValues>}
      * @memberof ReportTaskCustomSelection
      */
     fieldValues?: Array<ReportTaskFieldValues>;
+    /**
+     * Optional mappings to target specific report fields with optional scoping
+     * @type {Array<ReportTaskMappings>}
+     * @memberof ReportTaskCustomSelection
+     */
+    mappings?: Array<ReportTaskMappings>;
 }
 /**
  *
@@ -1150,6 +1168,25 @@ interface ReportTaskGroupsToShareWith {
      */
     groupId?: string;
 }
+/**
+ *
+ * @export
+ * @interface ReportTaskMappings
+ */
+interface ReportTaskMappings {
+    /**
+     *
+     * @type {ReportTaskTo}
+     * @memberof ReportTaskMappings
+     */
+    to?: ReportTaskTo;
+    /**
+     *
+     * @type {ReportTaskScope}
+     * @memberof ReportTaskMappings
+     */
+    scope?: ReportTaskScope;
+}
 /**
  *
  * @export
@@ -1765,6 +1802,38 @@ interface ReportTaskResponseAllOfUsersToShareWith {
      */
     email?: string;
 }
+/**
+ *
+ * @export
+ * @interface ReportTaskScope
+ */
+interface ReportTaskScope {
+    /**
+     *
+     * @type {Array<ReportTaskScopeObjects>}
+     * @memberof ReportTaskScope
+     */
+    objects?: Array<ReportTaskScopeObjects>;
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskScopeObjects
+ */
+interface ReportTaskScopeObjects {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskScopeObjects
+     */
+    objectKey?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ReportTaskScopeObjects
+     */
+    included?: boolean;
+}
 /**
  *
  * @export
@@ -1784,6 +1853,31 @@ interface ReportTaskTags {
      */
     name?: string;
 }
+/**
+ *
+ * @export
+ * @interface ReportTaskTo
+ */
+interface ReportTaskTo {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskTo
+     */
+    fieldName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskTo
+     */
+    fieldDef?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskTo
+     */
+    tableName?: string;
+}
 /**
  *
  * @export
@@ -1948,10 +2042,10 @@ interface Visualization {
     filterSets?: Array<ReportTaskFilterSets>;
     /**
      * Custom filters to apply. This field will be updated entirely if provided
-     * @type {Array<ReportTaskCustomSelection>}
+     * @type {Array<VisualizationSelections>}
      * @memberof Visualization
      */
-    selections?: Array<ReportTaskCustomSelection>;
+    selections?: Array<VisualizationSelections>;
     /**
      *
      * @type {Array<ReportTaskVariables>}
@@ -1959,6 +2053,31 @@ interface Visualization {
      */
     variables?: Array<ReportTaskVariables>;
 }
+/**
+ *
+ * @export
+ * @interface VisualizationSelections
+ */
+interface VisualizationSelections {
+    /**
+     * The label of the field. Used for display in certain scenarios.
+     * @type {string}
+     * @memberof VisualizationSelections
+     */
+    fieldName?: string;
+    /**
+     * The definition of the field.
+     * @type {string}
+     * @memberof VisualizationSelections
+     */
+    fieldDef?: string;
+    /**
+     *
+     * @type {Array<ReportTaskFieldValues>}
+     * @memberof VisualizationSelections
+     */
+    fieldValues?: Array<ReportTaskFieldValues>;
+}
 /**
  * BaseTemplatesApi - axios parameter creator
  * @export
@@ -3525,4 +3644,4 @@ declare class ConnectReport {
     constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
 }
 
-export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, type CycleConfig, CycleConfigConfigTypeEnum, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FieldInfo, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, type FilterMapping, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskErrors, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfGroupsSharedWith, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskTags, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportTypeEnum, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type RowExclusion, type RowExclusionFieldValues, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp };
+export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, type CycleConfig, CycleConfigConfigTypeEnum, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FieldInfo, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, type FilterMapping, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskErrors, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskMappings, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfGroupsSharedWith, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskScope, type ReportTaskScopeObjects, type ReportTaskTags, type ReportTaskTo, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportTypeEnum, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type RowExclusion, type RowExclusionFieldValues, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp, type VisualizationSelections };

package/dist/index.d.ts

@@ -5,7 +5,7 @@ import { AxiosInstance, AxiosPromise } from 'axios';
  * ConnectReport Core API
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
  *
- * The version of the OpenAPI document: 2.80.5
+ * The version of the OpenAPI document: 2.81.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -91,7 +91,7 @@ declare class Configuration {
  * ConnectReport Core API
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
  *
- * The version of the OpenAPI document: 2.80.5
+ * The version of the OpenAPI document: 2.81.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -150,6 +150,12 @@ interface CycleConfig {
      * @memberof CycleConfig
      */
     tableColumns: Array<FieldInfo>;
+    /**
+     * Maximum number of rows to fetch from the data source
+     * @type {number}
+     * @memberof CycleConfig
+     */
+    tableHeight?: number;
     /**
      *
      * @type {RowExclusion}
@@ -1067,12 +1073,24 @@ interface ReportTaskCustomSelection {
      * @memberof ReportTaskCustomSelection
      */
     fieldDef?: string;
+    /**
+     * The name of the table containing this field.
+     * @type {string}
+     * @memberof ReportTaskCustomSelection
+     */
+    tableName?: string;
     /**
      *
      * @type {Array<ReportTaskFieldValues>}
      * @memberof ReportTaskCustomSelection
      */
     fieldValues?: Array<ReportTaskFieldValues>;
+    /**
+     * Optional mappings to target specific report fields with optional scoping
+     * @type {Array<ReportTaskMappings>}
+     * @memberof ReportTaskCustomSelection
+     */
+    mappings?: Array<ReportTaskMappings>;
 }
 /**
  *
@@ -1150,6 +1168,25 @@ interface ReportTaskGroupsToShareWith {
      */
     groupId?: string;
 }
+/**
+ *
+ * @export
+ * @interface ReportTaskMappings
+ */
+interface ReportTaskMappings {
+    /**
+     *
+     * @type {ReportTaskTo}
+     * @memberof ReportTaskMappings
+     */
+    to?: ReportTaskTo;
+    /**
+     *
+     * @type {ReportTaskScope}
+     * @memberof ReportTaskMappings
+     */
+    scope?: ReportTaskScope;
+}
 /**
  *
  * @export
@@ -1765,6 +1802,38 @@ interface ReportTaskResponseAllOfUsersToShareWith {
      */
     email?: string;
 }
+/**
+ *
+ * @export
+ * @interface ReportTaskScope
+ */
+interface ReportTaskScope {
+    /**
+     *
+     * @type {Array<ReportTaskScopeObjects>}
+     * @memberof ReportTaskScope
+     */
+    objects?: Array<ReportTaskScopeObjects>;
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskScopeObjects
+ */
+interface ReportTaskScopeObjects {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskScopeObjects
+     */
+    objectKey?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ReportTaskScopeObjects
+     */
+    included?: boolean;
+}
 /**
  *
  * @export
@@ -1784,6 +1853,31 @@ interface ReportTaskTags {
      */
     name?: string;
 }
+/**
+ *
+ * @export
+ * @interface ReportTaskTo
+ */
+interface ReportTaskTo {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskTo
+     */
+    fieldName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskTo
+     */
+    fieldDef?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskTo
+     */
+    tableName?: string;
+}
 /**
  *
  * @export
@@ -1948,10 +2042,10 @@ interface Visualization {
     filterSets?: Array<ReportTaskFilterSets>;
     /**
      * Custom filters to apply. This field will be updated entirely if provided
-     * @type {Array<ReportTaskCustomSelection>}
+     * @type {Array<VisualizationSelections>}
      * @memberof Visualization
      */
-    selections?: Array<ReportTaskCustomSelection>;
+    selections?: Array<VisualizationSelections>;
     /**
      *
      * @type {Array<ReportTaskVariables>}
@@ -1959,6 +2053,31 @@ interface Visualization {
      */
     variables?: Array<ReportTaskVariables>;
 }
+/**
+ *
+ * @export
+ * @interface VisualizationSelections
+ */
+interface VisualizationSelections {
+    /**
+     * The label of the field. Used for display in certain scenarios.
+     * @type {string}
+     * @memberof VisualizationSelections
+     */
+    fieldName?: string;
+    /**
+     * The definition of the field.
+     * @type {string}
+     * @memberof VisualizationSelections
+     */
+    fieldDef?: string;
+    /**
+     *
+     * @type {Array<ReportTaskFieldValues>}
+     * @memberof VisualizationSelections
+     */
+    fieldValues?: Array<ReportTaskFieldValues>;
+}
 /**
  * BaseTemplatesApi - axios parameter creator
  * @export
@@ -3525,4 +3644,4 @@ declare class ConnectReport {
     constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
 }
 
-export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, type CycleConfig, CycleConfigConfigTypeEnum, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FieldInfo, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, type FilterMapping, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskErrors, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfGroupsSharedWith, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskTags, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportTypeEnum, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type RowExclusion, type RowExclusionFieldValues, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp };
+export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, type CycleConfig, CycleConfigConfigTypeEnum, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FieldInfo, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, type FilterMapping, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskErrors, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskMappings, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfGroupsSharedWith, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskScope, type ReportTaskScopeObjects, type ReportTaskTags, type ReportTaskTo, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportTypeEnum, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type RowExclusion, type RowExclusionFieldValues, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp, type VisualizationSelections };