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

package/api.ts

@@ -21,6 +21,150 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
 
+/**
+ * Configuration for data-driven report cycles where each row in a data source creates a child report task
+ * @export
+ * @interface CycleConfig
+ */
+export 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}
+    */
+export enum CycleConfigConfigTypeEnum {
+    Filters = 'filters',
+    Recipients = 'recipients'
+}
+
+/**
+ * Field metadata from data source
+ * @export
+ * @interface FieldInfo
+ */
+export 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
@@ -171,6 +315,12 @@ export interface FilterCycle {
      * @memberof FilterCycle
      */
     onedriveParentFolderId?: string;
+    /**
+     * 
+     * @type {CycleConfig}
+     * @memberof FilterCycle
+     */
+    cycle?: CycleConfig;
     /**
      * 
      * @type {FilterCycleAllOfFieldInfo}
@@ -338,6 +488,25 @@ export interface FilterCycleAllOfFieldValues {
      */
     number?: number;
 }
+/**
+ * Maps a source table field to a report filter field
+ * @export
+ * @interface FilterMapping
+ */
+export interface FilterMapping {
+    /**
+     * 
+     * @type {FieldInfo}
+     * @memberof FilterMapping
+     */
+    from: FieldInfo;
+    /**
+     * 
+     * @type {FieldInfo}
+     * @memberof FilterMapping
+     */
+    to: FieldInfo;
+}
 /**
  * 
  * @export
@@ -753,6 +922,12 @@ export interface ReportTask {
      * @memberof ReportTask
      */
     onedriveParentFolderId?: string;
+    /**
+     * 
+     * @type {CycleConfig}
+     * @memberof ReportTask
+     */
+    cycle?: CycleConfig;
 }
 
 /**
@@ -1030,6 +1205,12 @@ export 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>}
@@ -1268,6 +1449,12 @@ export 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>}
@@ -1521,6 +1708,44 @@ export interface ReportTaskVariables {
      */
     value?: string;
 }
+/**
+ * Filter out rows where field matches specified values
+ * @export
+ * @interface RowExclusion
+ */
+export interface RowExclusion {
+    /**
+     * 
+     * @type {FieldInfo}
+     * @memberof RowExclusion
+     */
+    exclusionFieldInfo: FieldInfo;
+    /**
+     * 
+     * @type {Array<RowExclusionFieldValues>}
+     * @memberof RowExclusion
+     */
+    fieldValues: Array<RowExclusionFieldValues>;
+}
+/**
+ * 
+ * @export
+ * @interface RowExclusionFieldValues
+ */
+export interface RowExclusionFieldValues {
+    /**
+     * 
+     * @type {string}
+     * @memberof RowExclusionFieldValues
+     */
+    text: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RowExclusionFieldValues
+     */
+    number?: number;
+}
 /**
  * 
  * @export

package/dist/index.cjs

@@ -78,6 +78,7 @@ __export(index_exports, {
   BaseTemplatesApiFactory: () => BaseTemplatesApiFactory,
   BaseTemplatesApiFp: () => BaseTemplatesApiFp,
   ConnectReport: () => ConnectReport,
+  CycleConfigConfigTypeEnum: () => CycleConfigConfigTypeEnum,
   DocumentsApi: () => DocumentsApi,
   DocumentsApiAxiosParamCreator: () => DocumentsApiAxiosParamCreator,
   DocumentsApiFactory: () => DocumentsApiFactory,
@@ -198,6 +199,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";
@@ -3127,6 +3133,7 @@ globalThis.ConnectReport = ConnectReport;
   BaseTemplatesApiFactory,
   BaseTemplatesApiFp,
   ConnectReport,
+  CycleConfigConfigTypeEnum,
   DocumentsApi,
   DocumentsApiAxiosParamCreator,
   DocumentsApiFactory,