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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -5,7 +5,7 @@ import { AxiosInstance, AxiosPromise } from 'axios';
5
5
  * ConnectReport Core API
6
6
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
7
7
  *
8
- * The version of the OpenAPI document: 2.80.0
8
+ * The version of the OpenAPI document: 2.80.5
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -91,7 +91,7 @@ declare class Configuration {
91
91
  * ConnectReport Core API
92
92
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
93
93
  *
94
- * The version of the OpenAPI document: 2.80.0
94
+ * The version of the OpenAPI document: 2.80.5
95
95
  *
96
96
  *
97
97
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -120,6 +120,148 @@ declare class BaseAPI {
120
120
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
121
121
  }
122
122
 
123
+ /**
124
+ * Configuration for data-driven report cycles where each row in a data source creates a child report task
125
+ * @export
126
+ * @interface CycleConfig
127
+ */
128
+ interface CycleConfig {
129
+ /**
130
+ * Type of cycle configuration - \'filters\' for Dynamic Filters, \'recipients\' for Dynamic Recipients
131
+ * @type {string}
132
+ * @memberof CycleConfig
133
+ */
134
+ configType: CycleConfigConfigTypeEnum;
135
+ /**
136
+ * Data connector name (case-insensitive)
137
+ * @type {string}
138
+ * @memberof CycleConfig
139
+ */
140
+ connector: string;
141
+ /**
142
+ * Data source document ID
143
+ * @type {string}
144
+ * @memberof CycleConfig
145
+ */
146
+ docId: string;
147
+ /**
148
+ * Columns to query - defines what data to fetch (each row creates a child task)
149
+ * @type {Array<FieldInfo>}
150
+ * @memberof CycleConfig
151
+ */
152
+ tableColumns: Array<FieldInfo>;
153
+ /**
154
+ *
155
+ * @type {RowExclusion}
156
+ * @memberof CycleConfig
157
+ */
158
+ excludedValues?: RowExclusion;
159
+ /**
160
+ * Map source fields to report filter fields
161
+ * @type {Array<FilterMapping>}
162
+ * @memberof CycleConfig
163
+ */
164
+ filterMappings?: Array<FilterMapping>;
165
+ /**
166
+ *
167
+ * @type {FieldInfo}
168
+ * @memberof CycleConfig
169
+ */
170
+ recipientsFieldInfo?: FieldInfo;
171
+ /**
172
+ *
173
+ * @type {FieldInfo}
174
+ * @memberof CycleConfig
175
+ */
176
+ emailSubjectFieldInfo?: FieldInfo;
177
+ /**
178
+ *
179
+ * @type {FieldInfo}
180
+ * @memberof CycleConfig
181
+ */
182
+ emailBodyFieldInfo?: FieldInfo;
183
+ /**
184
+ *
185
+ * @type {FieldInfo}
186
+ * @memberof CycleConfig
187
+ */
188
+ titleFieldInfo?: FieldInfo;
189
+ /**
190
+ *
191
+ * @type {FieldInfo}
192
+ * @memberof CycleConfig
193
+ */
194
+ oneDriveParentFolderIdFieldInfo?: FieldInfo;
195
+ /**
196
+ *
197
+ * @type {FieldInfo}
198
+ * @memberof CycleConfig
199
+ */
200
+ tagsFieldInfo?: FieldInfo;
201
+ /**
202
+ *
203
+ * @type {FieldInfo}
204
+ * @memberof CycleConfig
205
+ */
206
+ groupsToShareWithFieldInfo?: FieldInfo;
207
+ /**
208
+ *
209
+ * @type {FieldInfo}
210
+ * @memberof CycleConfig
211
+ */
212
+ emailFieldInfo?: FieldInfo;
213
+ /**
214
+ * Automatically tag child reports with first column value
215
+ * @type {boolean}
216
+ * @memberof CycleConfig
217
+ */
218
+ autotag?: boolean;
219
+ }
220
+ /**
221
+ * @export
222
+ * @enum {string}
223
+ */
224
+ declare enum CycleConfigConfigTypeEnum {
225
+ Filters = "filters",
226
+ Recipients = "recipients"
227
+ }
228
+ /**
229
+ * Field metadata from data source
230
+ * @export
231
+ * @interface FieldInfo
232
+ */
233
+ interface FieldInfo {
234
+ /**
235
+ * Display name of the field
236
+ * @type {string}
237
+ * @memberof FieldInfo
238
+ */
239
+ fieldName?: string;
240
+ /**
241
+ * Definition/expression of the field
242
+ * @type {string}
243
+ * @memberof FieldInfo
244
+ */
245
+ fieldDef: string;
246
+ /**
247
+ * Unique identifier of the field
248
+ * @type {string}
249
+ * @memberof FieldInfo
250
+ */
251
+ id?: string;
252
+ /**
253
+ * Table identifier
254
+ * @type {string}
255
+ * @memberof FieldInfo
256
+ */
257
+ table?: string;
258
+ /**
259
+ * Display name of the table
260
+ * @type {string}
261
+ * @memberof FieldInfo
262
+ */
263
+ tableName?: string;
264
+ }
123
265
  /**
124
266
  *
125
267
  * @export
@@ -266,6 +408,18 @@ interface FilterCycle {
266
408
  * @memberof FilterCycle
267
409
  */
268
410
  emailBody?: string;
411
+ /**
412
+ * The ID of the OneDrive folder to publish the report to
413
+ * @type {string}
414
+ * @memberof FilterCycle
415
+ */
416
+ onedriveParentFolderId?: string;
417
+ /**
418
+ *
419
+ * @type {CycleConfig}
420
+ * @memberof FilterCycle
421
+ */
422
+ cycle?: CycleConfig;
269
423
  /**
270
424
  *
271
425
  * @type {FilterCycleAllOfFieldInfo}
@@ -279,7 +433,7 @@ interface FilterCycle {
279
433
  */
280
434
  fieldValues?: Array<FilterCycleAllOfFieldValues>;
281
435
  /**
282
- *
436
+ * This field is deprecated in favor of docId.
283
437
  * @type {string}
284
438
  * @memberof FilterCycle
285
439
  */
@@ -296,6 +450,18 @@ interface FilterCycle {
296
450
  * @memberof FilterCycle
297
451
  */
298
452
  autotag?: boolean;
453
+ /**
454
+ *
455
+ * @type {string}
456
+ * @memberof FilterCycle
457
+ */
458
+ docId?: string;
459
+ /**
460
+ *
461
+ * @type {string}
462
+ * @memberof FilterCycle
463
+ */
464
+ connectorName?: string;
299
465
  }
300
466
  /**
301
467
  * @export
@@ -339,7 +505,7 @@ interface FilterCycleAllOf {
339
505
  */
340
506
  fieldValues?: Array<FilterCycleAllOfFieldValues>;
341
507
  /**
342
- *
508
+ * This field is deprecated in favor of docId.
343
509
  * @type {string}
344
510
  * @memberof FilterCycleAllOf
345
511
  */
@@ -356,6 +522,18 @@ interface FilterCycleAllOf {
356
522
  * @memberof FilterCycleAllOf
357
523
  */
358
524
  autotag?: boolean;
525
+ /**
526
+ *
527
+ * @type {string}
528
+ * @memberof FilterCycleAllOf
529
+ */
530
+ docId?: string;
531
+ /**
532
+ *
533
+ * @type {string}
534
+ * @memberof FilterCycleAllOf
535
+ */
536
+ connectorName?: string;
359
537
  }
360
538
  /**
361
539
  *
@@ -407,6 +585,25 @@ interface FilterCycleAllOfFieldValues {
407
585
  */
408
586
  number?: number;
409
587
  }
588
+ /**
589
+ * Maps a source table field to a report filter field
590
+ * @export
591
+ * @interface FilterMapping
592
+ */
593
+ interface FilterMapping {
594
+ /**
595
+ *
596
+ * @type {FieldInfo}
597
+ * @memberof FilterMapping
598
+ */
599
+ from: FieldInfo;
600
+ /**
601
+ *
602
+ * @type {FieldInfo}
603
+ * @memberof FilterMapping
604
+ */
605
+ to: FieldInfo;
606
+ }
410
607
  /**
411
608
  *
412
609
  * @export
@@ -434,10 +631,16 @@ interface InlineResponse200 {
434
631
  interface InlineResponse2001 {
435
632
  /**
436
633
  *
437
- * @type {string}
634
+ * @type {Array<ReportTaskResponse>}
438
635
  * @memberof InlineResponse2001
439
636
  */
440
- path?: string;
637
+ reportTasks?: Array<ReportTaskResponse>;
638
+ /**
639
+ *
640
+ * @type {number}
641
+ * @memberof InlineResponse2001
642
+ */
643
+ totalPages?: number;
441
644
  }
442
645
  /**
443
646
  *
@@ -447,16 +650,22 @@ interface InlineResponse2001 {
447
650
  interface InlineResponse2002 {
448
651
  /**
449
652
  *
450
- * @type {Array<ReportTaskResponse>}
653
+ * @type {Array<Report>}
451
654
  * @memberof InlineResponse2002
452
655
  */
453
- reportTasks?: Array<ReportTaskResponse>;
656
+ reports?: Array<Report>;
454
657
  /**
455
658
  *
456
659
  * @type {number}
457
660
  * @memberof InlineResponse2002
458
661
  */
459
662
  totalPages?: number;
663
+ /**
664
+ *
665
+ * @type {number}
666
+ * @memberof InlineResponse2002
667
+ */
668
+ totalItems?: number;
460
669
  }
461
670
  /**
462
671
  *
@@ -466,22 +675,16 @@ interface InlineResponse2002 {
466
675
  interface InlineResponse2003 {
467
676
  /**
468
677
  *
469
- * @type {Array<Report>}
678
+ * @type {Array<Template>}
470
679
  * @memberof InlineResponse2003
471
680
  */
472
- reports?: Array<Report>;
681
+ templates?: Array<Template>;
473
682
  /**
474
683
  *
475
684
  * @type {number}
476
685
  * @memberof InlineResponse2003
477
686
  */
478
687
  totalPages?: number;
479
- /**
480
- *
481
- * @type {number}
482
- * @memberof InlineResponse2003
483
- */
484
- totalItems?: number;
485
688
  }
486
689
  /**
487
690
  *
@@ -491,16 +694,10 @@ interface InlineResponse2003 {
491
694
  interface InlineResponse2004 {
492
695
  /**
493
696
  *
494
- * @type {Array<Template>}
495
- * @memberof InlineResponse2004
496
- */
497
- templates?: Array<Template>;
498
- /**
499
- *
500
- * @type {number}
697
+ * @type {string}
501
698
  * @memberof InlineResponse2004
502
699
  */
503
- totalPages?: number;
700
+ path?: string;
504
701
  }
505
702
  /**
506
703
  *
@@ -655,6 +852,20 @@ interface Report {
655
852
  * @memberof Report
656
853
  */
657
854
  sizeBytes?: number;
855
+ /**
856
+ * The type of report
857
+ * @type {string}
858
+ * @memberof Report
859
+ */
860
+ type?: ReportTypeEnum;
861
+ }
862
+ /**
863
+ * @export
864
+ * @enum {string}
865
+ */
866
+ declare enum ReportTypeEnum {
867
+ PixelPerfect = "pixel-perfect",
868
+ Excel = "excel"
658
869
  }
659
870
  /**
660
871
  *
@@ -802,6 +1013,18 @@ interface ReportTask {
802
1013
  * @memberof ReportTask
803
1014
  */
804
1015
  emailBody?: string;
1016
+ /**
1017
+ * The ID of the OneDrive folder to publish the report to
1018
+ * @type {string}
1019
+ * @memberof ReportTask
1020
+ */
1021
+ onedriveParentFolderId?: string;
1022
+ /**
1023
+ *
1024
+ * @type {CycleConfig}
1025
+ * @memberof ReportTask
1026
+ */
1027
+ cycle?: CycleConfig;
805
1028
  }
806
1029
  /**
807
1030
  * @export
@@ -1073,6 +1296,18 @@ interface ReportTaskRequest {
1073
1296
  * @memberof ReportTaskRequest
1074
1297
  */
1075
1298
  emailBody?: string;
1299
+ /**
1300
+ * The ID of the OneDrive folder to publish the report to
1301
+ * @type {string}
1302
+ * @memberof ReportTaskRequest
1303
+ */
1304
+ onedriveParentFolderId?: string;
1305
+ /**
1306
+ *
1307
+ * @type {CycleConfig}
1308
+ * @memberof ReportTaskRequest
1309
+ */
1310
+ cycle?: CycleConfig;
1076
1311
  /**
1077
1312
  * Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
1078
1313
  * @type {Array<string>}
@@ -1305,6 +1540,18 @@ interface ReportTaskResponse {
1305
1540
  * @memberof ReportTaskResponse
1306
1541
  */
1307
1542
  emailBody?: string;
1543
+ /**
1544
+ * The ID of the OneDrive folder to publish the report to
1545
+ * @type {string}
1546
+ * @memberof ReportTaskResponse
1547
+ */
1548
+ onedriveParentFolderId?: string;
1549
+ /**
1550
+ *
1551
+ * @type {CycleConfig}
1552
+ * @memberof ReportTaskResponse
1553
+ */
1554
+ cycle?: CycleConfig;
1308
1555
  /**
1309
1556
  * Users to share the published report with. This field will be updated entirely if provided
1310
1557
  * @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
@@ -1556,6 +1803,44 @@ interface ReportTaskVariables {
1556
1803
  */
1557
1804
  value?: string;
1558
1805
  }
1806
+ /**
1807
+ * Filter out rows where field matches specified values
1808
+ * @export
1809
+ * @interface RowExclusion
1810
+ */
1811
+ interface RowExclusion {
1812
+ /**
1813
+ *
1814
+ * @type {FieldInfo}
1815
+ * @memberof RowExclusion
1816
+ */
1817
+ exclusionFieldInfo: FieldInfo;
1818
+ /**
1819
+ *
1820
+ * @type {Array<RowExclusionFieldValues>}
1821
+ * @memberof RowExclusion
1822
+ */
1823
+ fieldValues: Array<RowExclusionFieldValues>;
1824
+ }
1825
+ /**
1826
+ *
1827
+ * @export
1828
+ * @interface RowExclusionFieldValues
1829
+ */
1830
+ interface RowExclusionFieldValues {
1831
+ /**
1832
+ *
1833
+ * @type {string}
1834
+ * @memberof RowExclusionFieldValues
1835
+ */
1836
+ text: string;
1837
+ /**
1838
+ *
1839
+ * @type {number}
1840
+ * @memberof RowExclusionFieldValues
1841
+ */
1842
+ number?: number;
1843
+ }
1559
1844
  /**
1560
1845
  *
1561
1846
  * @export
@@ -1597,7 +1882,7 @@ interface Template {
1597
1882
  * @type {string}
1598
1883
  * @memberof Template
1599
1884
  */
1600
- type: TemplateTypeEnum;
1885
+ type?: TemplateTypeEnum;
1601
1886
  }
1602
1887
  /**
1603
1888
  * @export
@@ -1687,6 +1972,14 @@ declare const BaseTemplatesApiAxiosParamCreator: (configuration?: Configuration)
1687
1972
  * @throws {RequiredError}
1688
1973
  */
1689
1974
  duplicateBaseTemplate: (id: string, options?: any) => Promise<RequestArgs>;
1975
+ /**
1976
+ *
1977
+ * @summary Get base template thumbnail
1978
+ * @param {string} id
1979
+ * @param {*} [options] Override http request option.
1980
+ * @throws {RequiredError}
1981
+ */
1982
+ getBaseTemplateThumbnail: (id: string, options?: any) => Promise<RequestArgs>;
1690
1983
  /**
1691
1984
  *
1692
1985
  * @summary List base templates
@@ -1710,6 +2003,14 @@ declare const BaseTemplatesApiFp: (configuration?: Configuration) => {
1710
2003
  * @throws {RequiredError}
1711
2004
  */
1712
2005
  duplicateBaseTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
2006
+ /**
2007
+ *
2008
+ * @summary Get base template thumbnail
2009
+ * @param {string} id
2010
+ * @param {*} [options] Override http request option.
2011
+ * @throws {RequiredError}
2012
+ */
2013
+ getBaseTemplateThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1713
2014
  /**
1714
2015
  *
1715
2016
  * @summary List base templates
@@ -1733,6 +2034,14 @@ declare const BaseTemplatesApiFactory: (configuration?: Configuration, basePath?
1733
2034
  * @throws {RequiredError}
1734
2035
  */
1735
2036
  duplicateBaseTemplate(id: string, options?: any): AxiosPromise<Template>;
2037
+ /**
2038
+ *
2039
+ * @summary Get base template thumbnail
2040
+ * @param {string} id
2041
+ * @param {*} [options] Override http request option.
2042
+ * @throws {RequiredError}
2043
+ */
2044
+ getBaseTemplateThumbnail(id: string, options?: any): AxiosPromise<any>;
1736
2045
  /**
1737
2046
  *
1738
2047
  * @summary List base templates
@@ -1759,6 +2068,15 @@ declare class BaseTemplatesApi extends BaseAPI {
1759
2068
  * @memberof BaseTemplatesApi
1760
2069
  */
1761
2070
  duplicateBaseTemplate(id: string, options?: any): Promise<axios.AxiosResponse<Template, any>>;
2071
+ /**
2072
+ *
2073
+ * @summary Get base template thumbnail
2074
+ * @param {string} id
2075
+ * @param {*} [options] Override http request option.
2076
+ * @throws {RequiredError}
2077
+ * @memberof BaseTemplatesApi
2078
+ */
2079
+ getBaseTemplateThumbnail(id: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
1762
2080
  /**
1763
2081
  *
1764
2082
  * @summary List base templates
@@ -1778,13 +2096,22 @@ declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) =>
1778
2096
  /**
1779
2097
  *
1780
2098
  * @summary Retrieve a generated document
1781
- * @param {string} fileName
2099
+ * @param {string} id
1782
2100
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1783
2101
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1784
2102
  * @param {*} [options] Override http request option.
1785
2103
  * @throws {RequiredError}
1786
2104
  */
1787
- getDocument: (fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any) => Promise<RequestArgs>;
2105
+ getDocument: (id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any) => Promise<RequestArgs>;
2106
+ /**
2107
+ *
2108
+ * @summary Retrieve a generated document
2109
+ * @param {string} id
2110
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
2111
+ * @param {*} [options] Override http request option.
2112
+ * @throws {RequiredError}
2113
+ */
2114
+ getDocumentById: (id: string, attachmentName?: string, options?: any) => Promise<RequestArgs>;
1788
2115
  };
1789
2116
  /**
1790
2117
  * DocumentsApi - functional programming interface
@@ -1794,13 +2121,22 @@ declare const DocumentsApiFp: (configuration?: Configuration) => {
1794
2121
  /**
1795
2122
  *
1796
2123
  * @summary Retrieve a generated document
1797
- * @param {string} fileName
2124
+ * @param {string} id
1798
2125
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1799
2126
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1800
2127
  * @param {*} [options] Override http request option.
1801
2128
  * @throws {RequiredError}
1802
2129
  */
1803
- getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2130
+ getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2131
+ /**
2132
+ *
2133
+ * @summary Retrieve a generated document
2134
+ * @param {string} id
2135
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
2136
+ * @param {*} [options] Override http request option.
2137
+ * @throws {RequiredError}
2138
+ */
2139
+ getDocumentById(id: string, attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1804
2140
  };
1805
2141
  /**
1806
2142
  * DocumentsApi - factory interface
@@ -1810,13 +2146,22 @@ declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: st
1810
2146
  /**
1811
2147
  *
1812
2148
  * @summary Retrieve a generated document
1813
- * @param {string} fileName
2149
+ * @param {string} id
1814
2150
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1815
2151
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1816
2152
  * @param {*} [options] Override http request option.
1817
2153
  * @throws {RequiredError}
1818
2154
  */
1819
- getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): AxiosPromise<any>;
2155
+ getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): AxiosPromise<any>;
2156
+ /**
2157
+ *
2158
+ * @summary Retrieve a generated document
2159
+ * @param {string} id
2160
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
2161
+ * @param {*} [options] Override http request option.
2162
+ * @throws {RequiredError}
2163
+ */
2164
+ getDocumentById(id: string, attachmentName?: string, options?: any): AxiosPromise<any>;
1820
2165
  };
1821
2166
  /**
1822
2167
  * DocumentsApi - object-oriented interface
@@ -1828,14 +2173,24 @@ declare class DocumentsApi extends BaseAPI {
1828
2173
  /**
1829
2174
  *
1830
2175
  * @summary Retrieve a generated document
1831
- * @param {string} fileName
2176
+ * @param {string} id
1832
2177
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1833
2178
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1834
2179
  * @param {*} [options] Override http request option.
1835
2180
  * @throws {RequiredError}
1836
2181
  * @memberof DocumentsApi
1837
2182
  */
1838
- getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
2183
+ getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
2184
+ /**
2185
+ *
2186
+ * @summary Retrieve a generated document
2187
+ * @param {string} id
2188
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
2189
+ * @param {*} [options] Override http request option.
2190
+ * @throws {RequiredError}
2191
+ * @memberof DocumentsApi
2192
+ */
2193
+ getDocumentById(id: string, attachmentName?: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
1839
2194
  }
1840
2195
  /**
1841
2196
  * FilterCyclesApi - axios parameter creator
@@ -2106,11 +2461,11 @@ declare const ImagesApiAxiosParamCreator: (configuration?: Configuration) => {
2106
2461
  /**
2107
2462
  *
2108
2463
  * @summary Retrieves a user uploaded image for use in a template
2109
- * @param {string} title
2464
+ * @param {string} id
2110
2465
  * @param {*} [options] Override http request option.
2111
2466
  * @throws {RequiredError}
2112
2467
  */
2113
- getImage: (title: string, options?: any) => Promise<RequestArgs>;
2468
+ getImage: (id: string, options?: any) => Promise<RequestArgs>;
2114
2469
  /**
2115
2470
  * Uploads an image to the server for use in templates
2116
2471
  * @summary Upload an image for use in a template
@@ -2128,11 +2483,11 @@ declare const ImagesApiFp: (configuration?: Configuration) => {
2128
2483
  /**
2129
2484
  *
2130
2485
  * @summary Retrieves a user uploaded image for use in a template
2131
- * @param {string} title
2486
+ * @param {string} id
2132
2487
  * @param {*} [options] Override http request option.
2133
2488
  * @throws {RequiredError}
2134
2489
  */
2135
- getImage(title: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2490
+ getImage(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2136
2491
  /**
2137
2492
  * Uploads an image to the server for use in templates
2138
2493
  * @summary Upload an image for use in a template
@@ -2140,7 +2495,7 @@ declare const ImagesApiFp: (configuration?: Configuration) => {
2140
2495
  * @param {*} [options] Override http request option.
2141
2496
  * @throws {RequiredError}
2142
2497
  */
2143
- uploadImage(image?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>>;
2498
+ uploadImage(image?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>>;
2144
2499
  };
2145
2500
  /**
2146
2501
  * ImagesApi - factory interface
@@ -2150,11 +2505,11 @@ declare const ImagesApiFactory: (configuration?: Configuration, basePath?: strin
2150
2505
  /**
2151
2506
  *
2152
2507
  * @summary Retrieves a user uploaded image for use in a template
2153
- * @param {string} title
2508
+ * @param {string} id
2154
2509
  * @param {*} [options] Override http request option.
2155
2510
  * @throws {RequiredError}
2156
2511
  */
2157
- getImage(title: string, options?: any): AxiosPromise<any>;
2512
+ getImage(id: string, options?: any): AxiosPromise<any>;
2158
2513
  /**
2159
2514
  * Uploads an image to the server for use in templates
2160
2515
  * @summary Upload an image for use in a template
@@ -2162,7 +2517,7 @@ declare const ImagesApiFactory: (configuration?: Configuration, basePath?: strin
2162
2517
  * @param {*} [options] Override http request option.
2163
2518
  * @throws {RequiredError}
2164
2519
  */
2165
- uploadImage(image?: any, options?: any): AxiosPromise<InlineResponse2001>;
2520
+ uploadImage(image?: any, options?: any): AxiosPromise<InlineResponse2004>;
2166
2521
  };
2167
2522
  /**
2168
2523
  * ImagesApi - object-oriented interface
@@ -2174,12 +2529,12 @@ declare class ImagesApi extends BaseAPI {
2174
2529
  /**
2175
2530
  *
2176
2531
  * @summary Retrieves a user uploaded image for use in a template
2177
- * @param {string} title
2532
+ * @param {string} id
2178
2533
  * @param {*} [options] Override http request option.
2179
2534
  * @throws {RequiredError}
2180
2535
  * @memberof ImagesApi
2181
2536
  */
2182
- getImage(title: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
2537
+ getImage(id: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
2183
2538
  /**
2184
2539
  * Uploads an image to the server for use in templates
2185
2540
  * @summary Upload an image for use in a template
@@ -2188,7 +2543,7 @@ declare class ImagesApi extends BaseAPI {
2188
2543
  * @throws {RequiredError}
2189
2544
  * @memberof ImagesApi
2190
2545
  */
2191
- uploadImage(image?: any, options?: any): Promise<axios.AxiosResponse<InlineResponse2001, any>>;
2546
+ uploadImage(image?: any, options?: any): Promise<axios.AxiosResponse<InlineResponse2004, any>>;
2192
2547
  }
2193
2548
  /**
2194
2549
  * JobsApi - axios parameter creator
@@ -2358,7 +2713,7 @@ declare const ReportTasksApiFp: (configuration?: Configuration) => {
2358
2713
  */
2359
2714
  getReportTasks(pageNum?: number, meta?: {
2360
2715
  [key: string]: string;
2361
- }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>;
2716
+ }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>>;
2362
2717
  /**
2363
2718
  * Duplicates the task and runs it as \"Once - Now\"
2364
2719
  * @summary Run task now
@@ -2422,7 +2777,7 @@ declare const ReportTasksApiFactory: (configuration?: Configuration, basePath?:
2422
2777
  */
2423
2778
  getReportTasks(pageNum?: number, meta?: {
2424
2779
  [key: string]: string;
2425
- }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): AxiosPromise<InlineResponse2002>;
2780
+ }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): AxiosPromise<InlineResponse2001>;
2426
2781
  /**
2427
2782
  * Duplicates the task and runs it as \"Once - Now\"
2428
2783
  * @summary Run task now
@@ -2492,7 +2847,7 @@ declare class ReportTasksApi extends BaseAPI {
2492
2847
  */
2493
2848
  getReportTasks(pageNum?: number, meta?: {
2494
2849
  [key: string]: string;
2495
- }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<axios.AxiosResponse<InlineResponse2002, any>>;
2850
+ }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<axios.AxiosResponse<InlineResponse2001, any>>;
2496
2851
  /**
2497
2852
  * Duplicates the task and runs it as \"Once - Now\"
2498
2853
  * @summary Run task now
@@ -2534,6 +2889,14 @@ declare const ReportsApiAxiosParamCreator: (configuration?: Configuration) => {
2534
2889
  * @throws {RequiredError}
2535
2890
  */
2536
2891
  getReport: (id: string, options?: any) => Promise<RequestArgs>;
2892
+ /**
2893
+ *
2894
+ * @summary Get report thumbnail
2895
+ * @param {string} id
2896
+ * @param {*} [options] Override http request option.
2897
+ * @throws {RequiredError}
2898
+ */
2899
+ getReportThumbnail: (id: string, options?: any) => Promise<RequestArgs>;
2537
2900
  /**
2538
2901
  *
2539
2902
  * @summary List reports
@@ -2578,6 +2941,14 @@ declare const ReportsApiFp: (configuration?: Configuration) => {
2578
2941
  * @throws {RequiredError}
2579
2942
  */
2580
2943
  getReport(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Report>>;
2944
+ /**
2945
+ *
2946
+ * @summary Get report thumbnail
2947
+ * @param {string} id
2948
+ * @param {*} [options] Override http request option.
2949
+ * @throws {RequiredError}
2950
+ */
2951
+ getReportThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2581
2952
  /**
2582
2953
  *
2583
2954
  * @summary List reports
@@ -2590,7 +2961,7 @@ declare const ReportsApiFp: (configuration?: Configuration) => {
2590
2961
  * @param {*} [options] Override http request option.
2591
2962
  * @throws {RequiredError}
2592
2963
  */
2593
- getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>>;
2964
+ getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>;
2594
2965
  /**
2595
2966
  *
2596
2967
  * @summary Render a published report
@@ -2622,6 +2993,14 @@ declare const ReportsApiFactory: (configuration?: Configuration, basePath?: stri
2622
2993
  * @throws {RequiredError}
2623
2994
  */
2624
2995
  getReport(id: string, options?: any): AxiosPromise<Report>;
2996
+ /**
2997
+ *
2998
+ * @summary Get report thumbnail
2999
+ * @param {string} id
3000
+ * @param {*} [options] Override http request option.
3001
+ * @throws {RequiredError}
3002
+ */
3003
+ getReportThumbnail(id: string, options?: any): AxiosPromise<any>;
2625
3004
  /**
2626
3005
  *
2627
3006
  * @summary List reports
@@ -2634,7 +3013,7 @@ declare const ReportsApiFactory: (configuration?: Configuration, basePath?: stri
2634
3013
  * @param {*} [options] Override http request option.
2635
3014
  * @throws {RequiredError}
2636
3015
  */
2637
- getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<InlineResponse2003>;
3016
+ getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<InlineResponse2002>;
2638
3017
  /**
2639
3018
  *
2640
3019
  * @summary Render a published report
@@ -2670,6 +3049,15 @@ declare class ReportsApi extends BaseAPI {
2670
3049
  * @memberof ReportsApi
2671
3050
  */
2672
3051
  getReport(id: string, options?: any): Promise<axios.AxiosResponse<Report, any>>;
3052
+ /**
3053
+ *
3054
+ * @summary Get report thumbnail
3055
+ * @param {string} id
3056
+ * @param {*} [options] Override http request option.
3057
+ * @throws {RequiredError}
3058
+ * @memberof ReportsApi
3059
+ */
3060
+ getReportThumbnail(id: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
2673
3061
  /**
2674
3062
  *
2675
3063
  * @summary List reports
@@ -2683,7 +3071,7 @@ declare class ReportsApi extends BaseAPI {
2683
3071
  * @throws {RequiredError}
2684
3072
  * @memberof ReportsApi
2685
3073
  */
2686
- getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<axios.AxiosResponse<InlineResponse2003, any>>;
3074
+ getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<axios.AxiosResponse<InlineResponse2002, any>>;
2687
3075
  /**
2688
3076
  *
2689
3077
  * @summary Render a published report
@@ -2740,6 +3128,14 @@ declare const TemplatesApiAxiosParamCreator: (configuration?: Configuration) =>
2740
3128
  * @throws {RequiredError}
2741
3129
  */
2742
3130
  getTemplate: (id: string, options?: any) => Promise<RequestArgs>;
3131
+ /**
3132
+ *
3133
+ * @summary Get template thumbnail
3134
+ * @param {string} id
3135
+ * @param {*} [options] Override http request option.
3136
+ * @throws {RequiredError}
3137
+ */
3138
+ getTemplateThumbnail: (id: string, options?: any) => Promise<RequestArgs>;
2743
3139
  /**
2744
3140
  *
2745
3141
  * @summary List report templates
@@ -2820,6 +3216,14 @@ declare const TemplatesApiFp: (configuration?: Configuration) => {
2820
3216
  * @throws {RequiredError}
2821
3217
  */
2822
3218
  getTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
3219
+ /**
3220
+ *
3221
+ * @summary Get template thumbnail
3222
+ * @param {string} id
3223
+ * @param {*} [options] Override http request option.
3224
+ * @throws {RequiredError}
3225
+ */
3226
+ getTemplateThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2823
3227
  /**
2824
3228
  *
2825
3229
  * @summary List report templates
@@ -2827,7 +3231,7 @@ declare const TemplatesApiFp: (configuration?: Configuration) => {
2827
3231
  * @param {*} [options] Override http request option.
2828
3232
  * @throws {RequiredError}
2829
3233
  */
2830
- getTemplates(pageNum?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>>;
3234
+ getTemplates(pageNum?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>>;
2831
3235
  /**
2832
3236
  * Imports an exported .CRPT file
2833
3237
  * @summary Import a template
@@ -2900,6 +3304,14 @@ declare const TemplatesApiFactory: (configuration?: Configuration, basePath?: st
2900
3304
  * @throws {RequiredError}
2901
3305
  */
2902
3306
  getTemplate(id: string, options?: any): AxiosPromise<Template>;
3307
+ /**
3308
+ *
3309
+ * @summary Get template thumbnail
3310
+ * @param {string} id
3311
+ * @param {*} [options] Override http request option.
3312
+ * @throws {RequiredError}
3313
+ */
3314
+ getTemplateThumbnail(id: string, options?: any): AxiosPromise<any>;
2903
3315
  /**
2904
3316
  *
2905
3317
  * @summary List report templates
@@ -2907,7 +3319,7 @@ declare const TemplatesApiFactory: (configuration?: Configuration, basePath?: st
2907
3319
  * @param {*} [options] Override http request option.
2908
3320
  * @throws {RequiredError}
2909
3321
  */
2910
- getTemplates(pageNum?: number, options?: any): AxiosPromise<InlineResponse2004>;
3322
+ getTemplates(pageNum?: number, options?: any): AxiosPromise<InlineResponse2003>;
2911
3323
  /**
2912
3324
  * Imports an exported .CRPT file
2913
3325
  * @summary Import a template
@@ -2987,6 +3399,15 @@ declare class TemplatesApi extends BaseAPI {
2987
3399
  * @memberof TemplatesApi
2988
3400
  */
2989
3401
  getTemplate(id: string, options?: any): Promise<axios.AxiosResponse<Template, any>>;
3402
+ /**
3403
+ *
3404
+ * @summary Get template thumbnail
3405
+ * @param {string} id
3406
+ * @param {*} [options] Override http request option.
3407
+ * @throws {RequiredError}
3408
+ * @memberof TemplatesApi
3409
+ */
3410
+ getTemplateThumbnail(id: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
2990
3411
  /**
2991
3412
  *
2992
3413
  * @summary List report templates
@@ -2995,7 +3416,7 @@ declare class TemplatesApi extends BaseAPI {
2995
3416
  * @throws {RequiredError}
2996
3417
  * @memberof TemplatesApi
2997
3418
  */
2998
- getTemplates(pageNum?: number, options?: any): Promise<axios.AxiosResponse<InlineResponse2004, any>>;
3419
+ getTemplates(pageNum?: number, options?: any): Promise<axios.AxiosResponse<InlineResponse2003, any>>;
2999
3420
  /**
3000
3421
  * Imports an exported .CRPT file
3001
3422
  * @summary Import a template
@@ -3104,4 +3525,4 @@ declare class ConnectReport {
3104
3525
  constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
3105
3526
  }
3106
3527
 
3107
- 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, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp };
3528
+ 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 };