@connectreport/connectreport-js 2.81.0-beta.5 → 2.81.0-beta.7

package/api.ts

@@ -34,17 +34,29 @@ export interface CycleConfig {
      */
     configType: CycleConfigConfigTypeEnum;
     /**
-     * Data connector name (case-insensitive)
+     * Data source type - \'connector\' for external data connector, \'parameterSheet\' for worksheet in the template
      * @type {string}
      * @memberof CycleConfig
      */
-    connector: string;
+    cycleSource?: CycleConfigCycleSourceEnum;
     /**
-     * Data source document ID
+     * Name of the worksheet to read parameter rows from (required when cycleSource is \'parameterSheet\')
      * @type {string}
      * @memberof CycleConfig
      */
-    docId: string;
+    parameterSheetName?: string;
+    /**
+     * Data connector name (case-insensitive, required when cycleSource is \'connector\')
+     * @type {string}
+     * @memberof CycleConfig
+     */
+    connector?: string;
+    /**
+     * Data source document ID (required when cycleSource is \'connector\')
+     * @type {string}
+     * @memberof CycleConfig
+     */
+    docId?: string;
     /**
      * Columns to query - defines what data to fetch (each row creates a child task)
      * @type {Array<FieldInfo>}
@@ -133,6 +145,14 @@ export enum CycleConfigConfigTypeEnum {
     Filters = 'filters',
     Recipients = 'recipients'
 }
+/**
+    * @export
+    * @enum {string}
+    */
+export enum CycleConfigCycleSourceEnum {
+    Connector = 'connector',
+    ParameterSheet = 'parameterSheet'
+}
 
 /**
  * Field metadata from data source
@@ -321,6 +341,12 @@ export interface FilterCycle {
      * @memberof FilterCycle
      */
     onedriveParentFolderId?: string;
+    /**
+     * Controls how generated output is published. `generateNew` (default) inserts a new generated report on every run. `refresh` maintains a single living file - the template artifact opens the latest generated report, and an OneDrive-backed template has its own item content overwritten in place (folder-publish is disabled).
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    publicationMode?: FilterCyclePublicationModeEnum;
     /**
      * 
      * @type {CycleConfig}
@@ -394,6 +420,14 @@ export enum FilterCycleEmailEnum {
     Xlsx = 'xlsx',
     Csv = 'csv'
 }
+/**
+    * @export
+    * @enum {string}
+    */
+export enum FilterCyclePublicationModeEnum {
+    GenerateNew = 'generateNew',
+    Refresh = 'refresh'
+}
 
 /**
  * 
@@ -928,6 +962,12 @@ export interface ReportTask {
      * @memberof ReportTask
      */
     onedriveParentFolderId?: string;
+    /**
+     * Controls how generated output is published. `generateNew` (default) inserts a new generated report on every run. `refresh` maintains a single living file - the template artifact opens the latest generated report, and an OneDrive-backed template has its own item content overwritten in place (folder-publish is disabled).
+     * @type {string}
+     * @memberof ReportTask
+     */
+    publicationMode?: ReportTaskPublicationModeEnum;
     /**
      * 
      * @type {CycleConfig}
@@ -959,6 +999,14 @@ export enum ReportTaskEmailEnum {
     Xlsx = 'xlsx',
     Csv = 'csv'
 }
+/**
+    * @export
+    * @enum {string}
+    */
+export enum ReportTaskPublicationModeEnum {
+    GenerateNew = 'generateNew',
+    Refresh = 'refresh'
+}
 
 /**
  * 
@@ -1242,6 +1290,12 @@ export interface ReportTaskRequest {
      * @memberof ReportTaskRequest
      */
     onedriveParentFolderId?: string;
+    /**
+     * Controls how generated output is published. `generateNew` (default) inserts a new generated report on every run. `refresh` maintains a single living file - the template artifact opens the latest generated report, and an OneDrive-backed template has its own item content overwritten in place (folder-publish is disabled).
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    publicationMode?: ReportTaskRequestPublicationModeEnum;
     /**
      * 
      * @type {CycleConfig}
@@ -1291,6 +1345,14 @@ export enum ReportTaskRequestEmailEnum {
     Xlsx = 'xlsx',
     Csv = 'csv'
 }
+/**
+    * @export
+    * @enum {string}
+    */
+export enum ReportTaskRequestPublicationModeEnum {
+    GenerateNew = 'generateNew',
+    Refresh = 'refresh'
+}
 
 /**
  * 
@@ -1486,6 +1548,12 @@ export interface ReportTaskResponse {
      * @memberof ReportTaskResponse
      */
     onedriveParentFolderId?: string;
+    /**
+     * Controls how generated output is published. `generateNew` (default) inserts a new generated report on every run. `refresh` maintains a single living file - the template artifact opens the latest generated report, and an OneDrive-backed template has its own item content overwritten in place (folder-publish is disabled).
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    publicationMode?: ReportTaskResponsePublicationModeEnum;
     /**
      * 
      * @type {CycleConfig}
@@ -1589,6 +1657,14 @@ export enum ReportTaskResponseEmailEnum {
     Xlsx = 'xlsx',
     Csv = 'csv'
 }
+/**
+    * @export
+    * @enum {string}
+    */
+export enum ReportTaskResponsePublicationModeEnum {
+    GenerateNew = 'generateNew',
+    Refresh = 'refresh'
+}
 
 /**
  * 

package/dist/index.cjs

@@ -79,12 +79,14 @@ __export(index_exports, {
   BaseTemplatesApiFp: () => BaseTemplatesApiFp,
   ConnectReport: () => ConnectReport,
   CycleConfigConfigTypeEnum: () => CycleConfigConfigTypeEnum,
+  CycleConfigCycleSourceEnum: () => CycleConfigCycleSourceEnum,
   DocumentsApi: () => DocumentsApi,
   DocumentsApiAxiosParamCreator: () => DocumentsApiAxiosParamCreator,
   DocumentsApiFactory: () => DocumentsApiFactory,
   DocumentsApiFp: () => DocumentsApiFp,
   FilterCycleEmailEnum: () => FilterCycleEmailEnum,
   FilterCycleFrequencyEnum: () => FilterCycleFrequencyEnum,
+  FilterCyclePublicationModeEnum: () => FilterCyclePublicationModeEnum,
   FilterCyclesApi: () => FilterCyclesApi,
   FilterCyclesApiAxiosParamCreator: () => FilterCyclesApiAxiosParamCreator,
   FilterCyclesApiFactory: () => FilterCyclesApiFactory,
@@ -99,10 +101,13 @@ __export(index_exports, {
   JobsApiFp: () => JobsApiFp,
   ReportTaskEmailEnum: () => ReportTaskEmailEnum,
   ReportTaskFrequencyEnum: () => ReportTaskFrequencyEnum,
+  ReportTaskPublicationModeEnum: () => ReportTaskPublicationModeEnum,
   ReportTaskRequestEmailEnum: () => ReportTaskRequestEmailEnum,
   ReportTaskRequestFrequencyEnum: () => ReportTaskRequestFrequencyEnum,
+  ReportTaskRequestPublicationModeEnum: () => ReportTaskRequestPublicationModeEnum,
   ReportTaskResponseEmailEnum: () => ReportTaskResponseEmailEnum,
   ReportTaskResponseFrequencyEnum: () => ReportTaskResponseFrequencyEnum,
+  ReportTaskResponsePublicationModeEnum: () => ReportTaskResponsePublicationModeEnum,
   ReportTasksApi: () => ReportTasksApi,
   ReportTasksApiAxiosParamCreator: () => ReportTasksApiAxiosParamCreator,
   ReportTasksApiFactory: () => ReportTasksApiFactory,
@@ -204,6 +209,11 @@ var CycleConfigConfigTypeEnum = /* @__PURE__ */ ((CycleConfigConfigTypeEnum2) =>
   CycleConfigConfigTypeEnum2["Recipients"] = "recipients";
   return CycleConfigConfigTypeEnum2;
 })(CycleConfigConfigTypeEnum || {});
+var CycleConfigCycleSourceEnum = /* @__PURE__ */ ((CycleConfigCycleSourceEnum2) => {
+  CycleConfigCycleSourceEnum2["Connector"] = "connector";
+  CycleConfigCycleSourceEnum2["ParameterSheet"] = "parameterSheet";
+  return CycleConfigCycleSourceEnum2;
+})(CycleConfigCycleSourceEnum || {});
 var FilterCycleFrequencyEnum = /* @__PURE__ */ ((FilterCycleFrequencyEnum2) => {
   FilterCycleFrequencyEnum2["Monthly"] = "Monthly";
   FilterCycleFrequencyEnum2["OnceNow"] = "Once - now";
@@ -221,6 +231,11 @@ var FilterCycleEmailEnum = /* @__PURE__ */ ((FilterCycleEmailEnum2) => {
   FilterCycleEmailEnum2["Csv"] = "csv";
   return FilterCycleEmailEnum2;
 })(FilterCycleEmailEnum || {});
+var FilterCyclePublicationModeEnum = /* @__PURE__ */ ((FilterCyclePublicationModeEnum2) => {
+  FilterCyclePublicationModeEnum2["GenerateNew"] = "generateNew";
+  FilterCyclePublicationModeEnum2["Refresh"] = "refresh";
+  return FilterCyclePublicationModeEnum2;
+})(FilterCyclePublicationModeEnum || {});
 var ReportTypeEnum = /* @__PURE__ */ ((ReportTypeEnum2) => {
   ReportTypeEnum2["PixelPerfect"] = "pixel-perfect";
   ReportTypeEnum2["Excel"] = "excel";
@@ -243,6 +258,11 @@ var ReportTaskEmailEnum = /* @__PURE__ */ ((ReportTaskEmailEnum2) => {
   ReportTaskEmailEnum2["Csv"] = "csv";
   return ReportTaskEmailEnum2;
 })(ReportTaskEmailEnum || {});
+var ReportTaskPublicationModeEnum = /* @__PURE__ */ ((ReportTaskPublicationModeEnum2) => {
+  ReportTaskPublicationModeEnum2["GenerateNew"] = "generateNew";
+  ReportTaskPublicationModeEnum2["Refresh"] = "refresh";
+  return ReportTaskPublicationModeEnum2;
+})(ReportTaskPublicationModeEnum || {});
 var ReportTaskRequestFrequencyEnum = /* @__PURE__ */ ((ReportTaskRequestFrequencyEnum2) => {
   ReportTaskRequestFrequencyEnum2["Monthly"] = "Monthly";
   ReportTaskRequestFrequencyEnum2["OnceNow"] = "Once - now";
@@ -260,6 +280,11 @@ var ReportTaskRequestEmailEnum = /* @__PURE__ */ ((ReportTaskRequestEmailEnum2)
   ReportTaskRequestEmailEnum2["Csv"] = "csv";
   return ReportTaskRequestEmailEnum2;
 })(ReportTaskRequestEmailEnum || {});
+var ReportTaskRequestPublicationModeEnum = /* @__PURE__ */ ((ReportTaskRequestPublicationModeEnum2) => {
+  ReportTaskRequestPublicationModeEnum2["GenerateNew"] = "generateNew";
+  ReportTaskRequestPublicationModeEnum2["Refresh"] = "refresh";
+  return ReportTaskRequestPublicationModeEnum2;
+})(ReportTaskRequestPublicationModeEnum || {});
 var ReportTaskResponseFrequencyEnum = /* @__PURE__ */ ((ReportTaskResponseFrequencyEnum2) => {
   ReportTaskResponseFrequencyEnum2["Monthly"] = "Monthly";
   ReportTaskResponseFrequencyEnum2["OnceNow"] = "Once - now";
@@ -277,6 +302,11 @@ var ReportTaskResponseEmailEnum = /* @__PURE__ */ ((ReportTaskResponseEmailEnum2
   ReportTaskResponseEmailEnum2["Csv"] = "csv";
   return ReportTaskResponseEmailEnum2;
 })(ReportTaskResponseEmailEnum || {});
+var ReportTaskResponsePublicationModeEnum = /* @__PURE__ */ ((ReportTaskResponsePublicationModeEnum2) => {
+  ReportTaskResponsePublicationModeEnum2["GenerateNew"] = "generateNew";
+  ReportTaskResponsePublicationModeEnum2["Refresh"] = "refresh";
+  return ReportTaskResponsePublicationModeEnum2;
+})(ReportTaskResponsePublicationModeEnum || {});
 var TemplateTypeEnum = /* @__PURE__ */ ((TemplateTypeEnum2) => {
   TemplateTypeEnum2["PixelPerfect"] = "pixel-perfect";
   TemplateTypeEnum2["Excel"] = "excel";
@@ -3134,12 +3164,14 @@ globalThis.ConnectReport = ConnectReport;
   BaseTemplatesApiFp,
   ConnectReport,
   CycleConfigConfigTypeEnum,
+  CycleConfigCycleSourceEnum,
   DocumentsApi,
   DocumentsApiAxiosParamCreator,
   DocumentsApiFactory,
   DocumentsApiFp,
   FilterCycleEmailEnum,
   FilterCycleFrequencyEnum,
+  FilterCyclePublicationModeEnum,
   FilterCyclesApi,
   FilterCyclesApiAxiosParamCreator,
   FilterCyclesApiFactory,
@@ -3154,10 +3186,13 @@ globalThis.ConnectReport = ConnectReport;
   JobsApiFp,
   ReportTaskEmailEnum,
   ReportTaskFrequencyEnum,
+  ReportTaskPublicationModeEnum,
   ReportTaskRequestEmailEnum,
   ReportTaskRequestFrequencyEnum,
+  ReportTaskRequestPublicationModeEnum,
   ReportTaskResponseEmailEnum,
   ReportTaskResponseFrequencyEnum,
+  ReportTaskResponsePublicationModeEnum,
   ReportTasksApi,
   ReportTasksApiAxiosParamCreator,
   ReportTasksApiFactory,