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

package/dist/index.d.cts

@@ -120,6 +120,148 @@ declare class BaseAPI {
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
 
+/**
+ * Configuration for data-driven report cycles where each row in a data source creates a child report task
+ * @export
+ * @interface CycleConfig
+ */
+interface CycleConfig {
+    /**
+     * Type of cycle configuration - \'filters\' for Dynamic Filters, \'recipients\' for Dynamic Recipients
+     * @type {string}
+     * @memberof CycleConfig
+     */
+    configType: CycleConfigConfigTypeEnum;
+    /**
+     * Data connector name (case-insensitive)
+     * @type {string}
+     * @memberof CycleConfig
+     */
+    connector: string;
+    /**
+     * Data source document ID
+     * @type {string}
+     * @memberof CycleConfig
+     */
+    docId: string;
+    /**
+     * Columns to query - defines what data to fetch (each row creates a child task)
+     * @type {Array<FieldInfo>}
+     * @memberof CycleConfig
+     */
+    tableColumns: Array<FieldInfo>;
+    /**
+     *
+     * @type {RowExclusion}
+     * @memberof CycleConfig
+     */
+    excludedValues?: RowExclusion;
+    /**
+     * Map source fields to report filter fields
+     * @type {Array<FilterMapping>}
+     * @memberof CycleConfig
+     */
+    filterMappings?: Array<FilterMapping>;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    recipientsFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    emailSubjectFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    emailBodyFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    titleFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    oneDriveParentFolderIdFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    tagsFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    groupsToShareWithFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    emailFieldInfo?: FieldInfo;
+    /**
+     * Automatically tag child reports with first column value
+     * @type {boolean}
+     * @memberof CycleConfig
+     */
+    autotag?: boolean;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+declare enum CycleConfigConfigTypeEnum {
+    Filters = "filters",
+    Recipients = "recipients"
+}
+/**
+ * Field metadata from data source
+ * @export
+ * @interface FieldInfo
+ */
+interface FieldInfo {
+    /**
+     * Display name of the field
+     * @type {string}
+     * @memberof FieldInfo
+     */
+    fieldName?: string;
+    /**
+     * Definition/expression of the field
+     * @type {string}
+     * @memberof FieldInfo
+     */
+    fieldDef: string;
+    /**
+     * Unique identifier of the field
+     * @type {string}
+     * @memberof FieldInfo
+     */
+    id?: string;
+    /**
+     * Table identifier
+     * @type {string}
+     * @memberof FieldInfo
+     */
+    table?: string;
+    /**
+     * Display name of the table
+     * @type {string}
+     * @memberof FieldInfo
+     */
+    tableName?: string;
+}
 /**
  *
  * @export
@@ -272,6 +414,12 @@ interface FilterCycle {
      * @memberof FilterCycle
      */
     onedriveParentFolderId?: string;
+    /**
+     *
+     * @type {CycleConfig}
+     * @memberof FilterCycle
+     */
+    cycle?: CycleConfig;
     /**
      *
      * @type {FilterCycleAllOfFieldInfo}
@@ -437,6 +585,25 @@ interface FilterCycleAllOfFieldValues {
      */
     number?: number;
 }
+/**
+ * Maps a source table field to a report filter field
+ * @export
+ * @interface FilterMapping
+ */
+interface FilterMapping {
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof FilterMapping
+     */
+    from: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof FilterMapping
+     */
+    to: FieldInfo;
+}
 /**
  *
  * @export
@@ -852,6 +1019,12 @@ interface ReportTask {
      * @memberof ReportTask
      */
     onedriveParentFolderId?: string;
+    /**
+     *
+     * @type {CycleConfig}
+     * @memberof ReportTask
+     */
+    cycle?: CycleConfig;
 }
 /**
     * @export
@@ -1129,6 +1302,12 @@ interface ReportTaskRequest {
      * @memberof ReportTaskRequest
      */
     onedriveParentFolderId?: string;
+    /**
+     *
+     * @type {CycleConfig}
+     * @memberof ReportTaskRequest
+     */
+    cycle?: CycleConfig;
     /**
      * Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
      * @type {Array<string>}
@@ -1367,6 +1546,12 @@ interface ReportTaskResponse {
      * @memberof ReportTaskResponse
      */
     onedriveParentFolderId?: string;
+    /**
+     *
+     * @type {CycleConfig}
+     * @memberof ReportTaskResponse
+     */
+    cycle?: CycleConfig;
     /**
      * Users to share the published report with. This field will be updated entirely if provided
      * @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
@@ -1618,6 +1803,44 @@ interface ReportTaskVariables {
      */
     value?: string;
 }
+/**
+ * Filter out rows where field matches specified values
+ * @export
+ * @interface RowExclusion
+ */
+interface RowExclusion {
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof RowExclusion
+     */
+    exclusionFieldInfo: FieldInfo;
+    /**
+     *
+     * @type {Array<RowExclusionFieldValues>}
+     * @memberof RowExclusion
+     */
+    fieldValues: Array<RowExclusionFieldValues>;
+}
+/**
+ *
+ * @export
+ * @interface RowExclusionFieldValues
+ */
+interface RowExclusionFieldValues {
+    /**
+     *
+     * @type {string}
+     * @memberof RowExclusionFieldValues
+     */
+    text: string;
+    /**
+     *
+     * @type {number}
+     * @memberof RowExclusionFieldValues
+     */
+    number?: number;
+}
 /**
  *
  * @export
@@ -3302,4 +3525,4 @@ declare class ConnectReport {
     constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
 }
 
-export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, 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 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 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 };

package/dist/index.d.ts

@@ -120,6 +120,148 @@ declare class BaseAPI {
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
 
+/**
+ * Configuration for data-driven report cycles where each row in a data source creates a child report task
+ * @export
+ * @interface CycleConfig
+ */
+interface CycleConfig {
+    /**
+     * Type of cycle configuration - \'filters\' for Dynamic Filters, \'recipients\' for Dynamic Recipients
+     * @type {string}
+     * @memberof CycleConfig
+     */
+    configType: CycleConfigConfigTypeEnum;
+    /**
+     * Data connector name (case-insensitive)
+     * @type {string}
+     * @memberof CycleConfig
+     */
+    connector: string;
+    /**
+     * Data source document ID
+     * @type {string}
+     * @memberof CycleConfig
+     */
+    docId: string;
+    /**
+     * Columns to query - defines what data to fetch (each row creates a child task)
+     * @type {Array<FieldInfo>}
+     * @memberof CycleConfig
+     */
+    tableColumns: Array<FieldInfo>;
+    /**
+     *
+     * @type {RowExclusion}
+     * @memberof CycleConfig
+     */
+    excludedValues?: RowExclusion;
+    /**
+     * Map source fields to report filter fields
+     * @type {Array<FilterMapping>}
+     * @memberof CycleConfig
+     */
+    filterMappings?: Array<FilterMapping>;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    recipientsFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    emailSubjectFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    emailBodyFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    titleFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    oneDriveParentFolderIdFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    tagsFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    groupsToShareWithFieldInfo?: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof CycleConfig
+     */
+    emailFieldInfo?: FieldInfo;
+    /**
+     * Automatically tag child reports with first column value
+     * @type {boolean}
+     * @memberof CycleConfig
+     */
+    autotag?: boolean;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+declare enum CycleConfigConfigTypeEnum {
+    Filters = "filters",
+    Recipients = "recipients"
+}
+/**
+ * Field metadata from data source
+ * @export
+ * @interface FieldInfo
+ */
+interface FieldInfo {
+    /**
+     * Display name of the field
+     * @type {string}
+     * @memberof FieldInfo
+     */
+    fieldName?: string;
+    /**
+     * Definition/expression of the field
+     * @type {string}
+     * @memberof FieldInfo
+     */
+    fieldDef: string;
+    /**
+     * Unique identifier of the field
+     * @type {string}
+     * @memberof FieldInfo
+     */
+    id?: string;
+    /**
+     * Table identifier
+     * @type {string}
+     * @memberof FieldInfo
+     */
+    table?: string;
+    /**
+     * Display name of the table
+     * @type {string}
+     * @memberof FieldInfo
+     */
+    tableName?: string;
+}
 /**
  *
  * @export
@@ -272,6 +414,12 @@ interface FilterCycle {
      * @memberof FilterCycle
      */
     onedriveParentFolderId?: string;
+    /**
+     *
+     * @type {CycleConfig}
+     * @memberof FilterCycle
+     */
+    cycle?: CycleConfig;
     /**
      *
      * @type {FilterCycleAllOfFieldInfo}
@@ -437,6 +585,25 @@ interface FilterCycleAllOfFieldValues {
      */
     number?: number;
 }
+/**
+ * Maps a source table field to a report filter field
+ * @export
+ * @interface FilterMapping
+ */
+interface FilterMapping {
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof FilterMapping
+     */
+    from: FieldInfo;
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof FilterMapping
+     */
+    to: FieldInfo;
+}
 /**
  *
  * @export
@@ -852,6 +1019,12 @@ interface ReportTask {
      * @memberof ReportTask
      */
     onedriveParentFolderId?: string;
+    /**
+     *
+     * @type {CycleConfig}
+     * @memberof ReportTask
+     */
+    cycle?: CycleConfig;
 }
 /**
     * @export
@@ -1129,6 +1302,12 @@ interface ReportTaskRequest {
      * @memberof ReportTaskRequest
      */
     onedriveParentFolderId?: string;
+    /**
+     *
+     * @type {CycleConfig}
+     * @memberof ReportTaskRequest
+     */
+    cycle?: CycleConfig;
     /**
      * Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
      * @type {Array<string>}
@@ -1367,6 +1546,12 @@ interface ReportTaskResponse {
      * @memberof ReportTaskResponse
      */
     onedriveParentFolderId?: string;
+    /**
+     *
+     * @type {CycleConfig}
+     * @memberof ReportTaskResponse
+     */
+    cycle?: CycleConfig;
     /**
      * Users to share the published report with. This field will be updated entirely if provided
      * @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
@@ -1618,6 +1803,44 @@ interface ReportTaskVariables {
      */
     value?: string;
 }
+/**
+ * Filter out rows where field matches specified values
+ * @export
+ * @interface RowExclusion
+ */
+interface RowExclusion {
+    /**
+     *
+     * @type {FieldInfo}
+     * @memberof RowExclusion
+     */
+    exclusionFieldInfo: FieldInfo;
+    /**
+     *
+     * @type {Array<RowExclusionFieldValues>}
+     * @memberof RowExclusion
+     */
+    fieldValues: Array<RowExclusionFieldValues>;
+}
+/**
+ *
+ * @export
+ * @interface RowExclusionFieldValues
+ */
+interface RowExclusionFieldValues {
+    /**
+     *
+     * @type {string}
+     * @memberof RowExclusionFieldValues
+     */
+    text: string;
+    /**
+     *
+     * @type {number}
+     * @memberof RowExclusionFieldValues
+     */
+    number?: number;
+}
 /**
  *
  * @export
@@ -3302,4 +3525,4 @@ declare class ConnectReport {
     constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
 }
 
-export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, 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 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 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 };

package/dist/index.js

@@ -140,6 +140,11 @@ var createRequestFunction = function(axiosArgs, globalAxios3, BASE_PATH2, config
 };
 
 // api.ts
+var CycleConfigConfigTypeEnum = /* @__PURE__ */ ((CycleConfigConfigTypeEnum2) => {
+  CycleConfigConfigTypeEnum2["Filters"] = "filters";
+  CycleConfigConfigTypeEnum2["Recipients"] = "recipients";
+  return CycleConfigConfigTypeEnum2;
+})(CycleConfigConfigTypeEnum || {});
 var FilterCycleFrequencyEnum = /* @__PURE__ */ ((FilterCycleFrequencyEnum2) => {
   FilterCycleFrequencyEnum2["Monthly"] = "Monthly";
   FilterCycleFrequencyEnum2["OnceNow"] = "Once - now";
@@ -3068,6 +3073,7 @@ export {
   BaseTemplatesApiFactory,
   BaseTemplatesApiFp,
   ConnectReport,
+  CycleConfigConfigTypeEnum,
   DocumentsApi,
   DocumentsApiAxiosParamCreator,
   DocumentsApiFactory,