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

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.
Files changed (63) hide show
  1. package/.openapi-generator/FILES +0 -1
  2. package/README.md +1 -1
  3. package/api.ts +670 -92
  4. package/base.ts +2 -2
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/index.cjs +296 -31
  8. package/dist/index.cjs.map +1 -1
  9. package/dist/index.d.cts +465 -71
  10. package/dist/index.d.ts +465 -71
  11. package/dist/index.js +294 -31
  12. package/dist/index.js.map +1 -1
  13. package/docs/assets/css/main.css +2679 -0
  14. package/docs/assets/images/icons.png +0 -0
  15. package/docs/assets/images/icons@2x.png +0 -0
  16. package/docs/assets/images/widgets.png +0 -0
  17. package/docs/assets/images/widgets@2x.png +0 -0
  18. package/docs/assets/js/main.js +1 -0
  19. package/docs/assets/js/search.json +1 -0
  20. package/docs/classes/_api_.basetemplatesapi.html +351 -0
  21. package/docs/classes/_api_.documentsapi.html +314 -0
  22. package/docs/classes/_api_.filtercyclesapi.html +483 -0
  23. package/docs/classes/_api_.imagesapi.html +354 -0
  24. package/docs/classes/_api_.jobsapi.html +311 -0
  25. package/docs/classes/_api_.reportsapi.html +400 -0
  26. package/docs/classes/_api_.reporttasksapi.html +503 -0
  27. package/docs/classes/_api_.templatesapi.html +676 -0
  28. package/docs/classes/_base_.baseapi.html +283 -0
  29. package/docs/classes/_base_.requirederror.html +291 -0
  30. package/docs/classes/_configuration_.configuration.html +345 -0
  31. package/docs/classes/_index_.connectreport.html +317 -0
  32. package/docs/enums/_api_.filtercycleemailenum.html +196 -0
  33. package/docs/enums/_api_.filtercyclefrequencyenum.html +238 -0
  34. package/docs/enums/_api_.reporttaskemailenum.html +196 -0
  35. package/docs/enums/_api_.reporttaskfrequencyenum.html +238 -0
  36. package/docs/enums/_api_.templateplatformenum.html +182 -0
  37. package/docs/globals.html +132 -0
  38. package/docs/index.html +145 -0
  39. package/docs/interfaces/_api_.filtercycle.html +791 -0
  40. package/docs/interfaces/_api_.filtercycleallof.html +273 -0
  41. package/docs/interfaces/_api_.filtercyclealloffieldinfo.html +228 -0
  42. package/docs/interfaces/_api_.filtercyclealloffieldvalues.html +228 -0
  43. package/docs/interfaces/_api_.inlineresponse200.html +186 -0
  44. package/docs/interfaces/_api_.inlineresponse2001.html +207 -0
  45. package/docs/interfaces/_api_.job.html +270 -0
  46. package/docs/interfaces/_api_.modelerror.html +207 -0
  47. package/docs/interfaces/_api_.report.html +348 -0
  48. package/docs/interfaces/_api_.reporttask.html +683 -0
  49. package/docs/interfaces/_api_.reporttaskcustomselection.html +234 -0
  50. package/docs/interfaces/_api_.reporttaskfieldvalues.html +207 -0
  51. package/docs/interfaces/_api_.reporttaskfiltersets.html +207 -0
  52. package/docs/interfaces/_api_.reporttaskgroupstosharewith.html +186 -0
  53. package/docs/interfaces/_api_.reporttasktags.html +207 -0
  54. package/docs/interfaces/_api_.reporttaskuserstosharewith.html +186 -0
  55. package/docs/interfaces/_api_.reporttaskvariables.html +207 -0
  56. package/docs/interfaces/_api_.template.html +291 -0
  57. package/docs/interfaces/_base_.requestargs.html +205 -0
  58. package/docs/interfaces/_configuration_.configurationparameters.html +253 -0
  59. package/docs/modules/_api_.html +4377 -0
  60. package/docs/modules/_base_.html +238 -0
  61. package/docs/modules/_configuration_.html +144 -0
  62. package/docs/modules/_index_.html +135 -0
  63. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -70,7 +70,7 @@ import globalAxios2 from "axios";
70
70
 
71
71
  // base.ts
72
72
  import globalAxios from "axios";
73
- var BASE_PATH = "https://connectreport.s3.us-east-2.amazonaws.com/api/v1".replace(/\/+$/, "");
73
+ var BASE_PATH = "http://localhost/api/v1".replace(/\/+$/, "");
74
74
  var BaseAPI = class {
75
75
  constructor(configuration, basePath = BASE_PATH, axios2 = globalAxios) {
76
76
  this.basePath = basePath;
@@ -157,6 +157,11 @@ var FilterCycleEmailEnum = /* @__PURE__ */ ((FilterCycleEmailEnum2) => {
157
157
  FilterCycleEmailEnum2["Csv"] = "csv";
158
158
  return FilterCycleEmailEnum2;
159
159
  })(FilterCycleEmailEnum || {});
160
+ var ReportTypeEnum = /* @__PURE__ */ ((ReportTypeEnum2) => {
161
+ ReportTypeEnum2["PixelPerfect"] = "pixel-perfect";
162
+ ReportTypeEnum2["Excel"] = "excel";
163
+ return ReportTypeEnum2;
164
+ })(ReportTypeEnum || {});
160
165
  var ReportTaskFrequencyEnum = /* @__PURE__ */ ((ReportTaskFrequencyEnum2) => {
161
166
  ReportTaskFrequencyEnum2["Monthly"] = "Monthly";
162
167
  ReportTaskFrequencyEnum2["OnceNow"] = "Once - now";
@@ -208,6 +213,11 @@ var ReportTaskResponseEmailEnum = /* @__PURE__ */ ((ReportTaskResponseEmailEnum2
208
213
  ReportTaskResponseEmailEnum2["Csv"] = "csv";
209
214
  return ReportTaskResponseEmailEnum2;
210
215
  })(ReportTaskResponseEmailEnum || {});
216
+ var TemplateTypeEnum = /* @__PURE__ */ ((TemplateTypeEnum2) => {
217
+ TemplateTypeEnum2["PixelPerfect"] = "pixel-perfect";
218
+ TemplateTypeEnum2["Excel"] = "excel";
219
+ return TemplateTypeEnum2;
220
+ })(TemplateTypeEnum || {});
211
221
  var BaseTemplatesApiAxiosParamCreator = function(configuration) {
212
222
  return {
213
223
  /**
@@ -239,6 +249,35 @@ var BaseTemplatesApiAxiosParamCreator = function(configuration) {
239
249
  options: localVarRequestOptions
240
250
  };
241
251
  },
252
+ /**
253
+ *
254
+ * @summary Get base template thumbnail
255
+ * @param {string} id
256
+ * @param {*} [options] Override http request option.
257
+ * @throws {RequiredError}
258
+ */
259
+ getBaseTemplateThumbnail: async (id, options = {}) => {
260
+ assertParamExists("getBaseTemplateThumbnail", "id", id);
261
+ const localVarPath = `/base-templates/{id}/thumbnail`.replace(`{${"id"}}`, encodeURIComponent(String(id)));
262
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
263
+ let baseOptions;
264
+ if (configuration) {
265
+ baseOptions = configuration.baseOptions;
266
+ }
267
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
268
+ const localVarHeaderParameter = {};
269
+ const localVarQueryParameter = {};
270
+ await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration);
271
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
272
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
273
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
274
+ let formHeaders = {};
275
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers };
276
+ return {
277
+ url: toPathString(localVarUrlObj),
278
+ options: localVarRequestOptions
279
+ };
280
+ },
242
281
  /**
243
282
  *
244
283
  * @summary List base templates
@@ -290,6 +329,17 @@ var BaseTemplatesApiFp = function(configuration) {
290
329
  const localVarAxiosArgs = await localVarAxiosParamCreator.duplicateBaseTemplate(id, options);
291
330
  return createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration);
292
331
  },
332
+ /**
333
+ *
334
+ * @summary Get base template thumbnail
335
+ * @param {string} id
336
+ * @param {*} [options] Override http request option.
337
+ * @throws {RequiredError}
338
+ */
339
+ async getBaseTemplateThumbnail(id, options) {
340
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBaseTemplateThumbnail(id, options);
341
+ return createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration);
342
+ },
293
343
  /**
294
344
  *
295
345
  * @summary List base templates
@@ -317,6 +367,16 @@ var BaseTemplatesApiFactory = function(configuration, basePath, axios2) {
317
367
  duplicateBaseTemplate(id, options) {
318
368
  return localVarFp.duplicateBaseTemplate(id, options).then((request) => request(axios2, basePath));
319
369
  },
370
+ /**
371
+ *
372
+ * @summary Get base template thumbnail
373
+ * @param {string} id
374
+ * @param {*} [options] Override http request option.
375
+ * @throws {RequiredError}
376
+ */
377
+ getBaseTemplateThumbnail(id, options) {
378
+ return localVarFp.getBaseTemplateThumbnail(id, options).then((request) => request(axios2, basePath));
379
+ },
320
380
  /**
321
381
  *
322
382
  * @summary List base templates
@@ -342,6 +402,17 @@ var BaseTemplatesApi = class extends BaseAPI {
342
402
  duplicateBaseTemplate(id, options) {
343
403
  return BaseTemplatesApiFp(this.configuration).duplicateBaseTemplate(id, options).then((request) => request(this.axios, this.basePath));
344
404
  }
405
+ /**
406
+ *
407
+ * @summary Get base template thumbnail
408
+ * @param {string} id
409
+ * @param {*} [options] Override http request option.
410
+ * @throws {RequiredError}
411
+ * @memberof BaseTemplatesApi
412
+ */
413
+ getBaseTemplateThumbnail(id, options) {
414
+ return BaseTemplatesApiFp(this.configuration).getBaseTemplateThumbnail(id, options).then((request) => request(this.axios, this.basePath));
415
+ }
345
416
  /**
346
417
  *
347
418
  * @summary List base templates
@@ -360,16 +431,49 @@ var DocumentsApiAxiosParamCreator = function(configuration) {
360
431
  /**
361
432
  *
362
433
  * @summary Retrieve a generated document
363
- * @param {string} fileName
434
+ * @param {string} id
364
435
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
365
436
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
366
437
  * @param {*} [options] Override http request option.
367
438
  * @throws {RequiredError}
368
439
  */
369
- getDocument: async (fileName, fileType, attachmentName, options = {}) => {
370
- assertParamExists("getDocument", "fileName", fileName);
440
+ getDocument: async (id, fileType, attachmentName, options = {}) => {
441
+ assertParamExists("getDocument", "id", id);
371
442
  assertParamExists("getDocument", "fileType", fileType);
372
- const localVarPath = `/documents/{fileType}/{fileName}`.replace(`{${"fileName"}}`, encodeURIComponent(String(fileName))).replace(`{${"fileType"}}`, encodeURIComponent(String(fileType)));
443
+ const localVarPath = `/documents/{fileType}/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(id))).replace(`{${"fileType"}}`, encodeURIComponent(String(fileType)));
444
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
445
+ let baseOptions;
446
+ if (configuration) {
447
+ baseOptions = configuration.baseOptions;
448
+ }
449
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
450
+ const localVarHeaderParameter = {};
451
+ const localVarQueryParameter = {};
452
+ await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration);
453
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
454
+ if (attachmentName !== void 0) {
455
+ localVarQueryParameter["attachmentName"] = attachmentName;
456
+ }
457
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
458
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
459
+ let formHeaders = {};
460
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers };
461
+ return {
462
+ url: toPathString(localVarUrlObj),
463
+ options: localVarRequestOptions
464
+ };
465
+ },
466
+ /**
467
+ *
468
+ * @summary Retrieve a generated document
469
+ * @param {string} id
470
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
471
+ * @param {*} [options] Override http request option.
472
+ * @throws {RequiredError}
473
+ */
474
+ getDocumentById: async (id, attachmentName, options = {}) => {
475
+ assertParamExists("getDocumentById", "id", id);
476
+ const localVarPath = `/documents/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(id)));
373
477
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
374
478
  let baseOptions;
375
479
  if (configuration) {
@@ -400,14 +504,26 @@ var DocumentsApiFp = function(configuration) {
400
504
  /**
401
505
  *
402
506
  * @summary Retrieve a generated document
403
- * @param {string} fileName
507
+ * @param {string} id
404
508
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
405
509
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
406
510
  * @param {*} [options] Override http request option.
407
511
  * @throws {RequiredError}
408
512
  */
409
- async getDocument(fileName, fileType, attachmentName, options) {
410
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(fileName, fileType, attachmentName, options);
513
+ async getDocument(id, fileType, attachmentName, options) {
514
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(id, fileType, attachmentName, options);
515
+ return createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration);
516
+ },
517
+ /**
518
+ *
519
+ * @summary Retrieve a generated document
520
+ * @param {string} id
521
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
522
+ * @param {*} [options] Override http request option.
523
+ * @throws {RequiredError}
524
+ */
525
+ async getDocumentById(id, attachmentName, options) {
526
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentById(id, attachmentName, options);
411
527
  return createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration);
412
528
  }
413
529
  };
@@ -418,14 +534,25 @@ var DocumentsApiFactory = function(configuration, basePath, axios2) {
418
534
  /**
419
535
  *
420
536
  * @summary Retrieve a generated document
421
- * @param {string} fileName
537
+ * @param {string} id
422
538
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
423
539
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
424
540
  * @param {*} [options] Override http request option.
425
541
  * @throws {RequiredError}
426
542
  */
427
- getDocument(fileName, fileType, attachmentName, options) {
428
- return localVarFp.getDocument(fileName, fileType, attachmentName, options).then((request) => request(axios2, basePath));
543
+ getDocument(id, fileType, attachmentName, options) {
544
+ return localVarFp.getDocument(id, fileType, attachmentName, options).then((request) => request(axios2, basePath));
545
+ },
546
+ /**
547
+ *
548
+ * @summary Retrieve a generated document
549
+ * @param {string} id
550
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
551
+ * @param {*} [options] Override http request option.
552
+ * @throws {RequiredError}
553
+ */
554
+ getDocumentById(id, attachmentName, options) {
555
+ return localVarFp.getDocumentById(id, attachmentName, options).then((request) => request(axios2, basePath));
429
556
  }
430
557
  };
431
558
  };
@@ -433,15 +560,27 @@ var DocumentsApi = class extends BaseAPI {
433
560
  /**
434
561
  *
435
562
  * @summary Retrieve a generated document
436
- * @param {string} fileName
563
+ * @param {string} id
437
564
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
438
565
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
439
566
  * @param {*} [options] Override http request option.
440
567
  * @throws {RequiredError}
441
568
  * @memberof DocumentsApi
442
569
  */
443
- getDocument(fileName, fileType, attachmentName, options) {
444
- return DocumentsApiFp(this.configuration).getDocument(fileName, fileType, attachmentName, options).then((request) => request(this.axios, this.basePath));
570
+ getDocument(id, fileType, attachmentName, options) {
571
+ return DocumentsApiFp(this.configuration).getDocument(id, fileType, attachmentName, options).then((request) => request(this.axios, this.basePath));
572
+ }
573
+ /**
574
+ *
575
+ * @summary Retrieve a generated document
576
+ * @param {string} id
577
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
578
+ * @param {*} [options] Override http request option.
579
+ * @throws {RequiredError}
580
+ * @memberof DocumentsApi
581
+ */
582
+ getDocumentById(id, attachmentName, options) {
583
+ return DocumentsApiFp(this.configuration).getDocumentById(id, attachmentName, options).then((request) => request(this.axios, this.basePath));
445
584
  }
446
585
  };
447
586
  var FilterCyclesApiAxiosParamCreator = function(configuration) {
@@ -904,13 +1043,13 @@ var ImagesApiAxiosParamCreator = function(configuration) {
904
1043
  /**
905
1044
  *
906
1045
  * @summary Retrieves a user uploaded image for use in a template
907
- * @param {string} title
1046
+ * @param {string} id
908
1047
  * @param {*} [options] Override http request option.
909
1048
  * @throws {RequiredError}
910
1049
  */
911
- getImage: async (title, options = {}) => {
912
- assertParamExists("getImage", "title", title);
913
- const localVarPath = `/images/{title}`.replace(`{${"title"}}`, encodeURIComponent(String(title)));
1050
+ getImage: async (id, options = {}) => {
1051
+ assertParamExists("getImage", "id", id);
1052
+ const localVarPath = `/images/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(id)));
914
1053
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
915
1054
  let baseOptions;
916
1055
  if (configuration) {
@@ -975,12 +1114,12 @@ var ImagesApiFp = function(configuration) {
975
1114
  /**
976
1115
  *
977
1116
  * @summary Retrieves a user uploaded image for use in a template
978
- * @param {string} title
1117
+ * @param {string} id
979
1118
  * @param {*} [options] Override http request option.
980
1119
  * @throws {RequiredError}
981
1120
  */
982
- async getImage(title, options) {
983
- const localVarAxiosArgs = await localVarAxiosParamCreator.getImage(title, options);
1121
+ async getImage(id, options) {
1122
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getImage(id, options);
984
1123
  return createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration);
985
1124
  },
986
1125
  /**
@@ -1002,12 +1141,12 @@ var ImagesApiFactory = function(configuration, basePath, axios2) {
1002
1141
  /**
1003
1142
  *
1004
1143
  * @summary Retrieves a user uploaded image for use in a template
1005
- * @param {string} title
1144
+ * @param {string} id
1006
1145
  * @param {*} [options] Override http request option.
1007
1146
  * @throws {RequiredError}
1008
1147
  */
1009
- getImage(title, options) {
1010
- return localVarFp.getImage(title, options).then((request) => request(axios2, basePath));
1148
+ getImage(id, options) {
1149
+ return localVarFp.getImage(id, options).then((request) => request(axios2, basePath));
1011
1150
  },
1012
1151
  /**
1013
1152
  * Uploads an image to the server for use in templates
@@ -1025,13 +1164,13 @@ var ImagesApi = class extends BaseAPI {
1025
1164
  /**
1026
1165
  *
1027
1166
  * @summary Retrieves a user uploaded image for use in a template
1028
- * @param {string} title
1167
+ * @param {string} id
1029
1168
  * @param {*} [options] Override http request option.
1030
1169
  * @throws {RequiredError}
1031
1170
  * @memberof ImagesApi
1032
1171
  */
1033
- getImage(title, options) {
1034
- return ImagesApiFp(this.configuration).getImage(title, options).then((request) => request(this.axios, this.basePath));
1172
+ getImage(id, options) {
1173
+ return ImagesApiFp(this.configuration).getImage(id, options).then((request) => request(this.axios, this.basePath));
1035
1174
  }
1036
1175
  /**
1037
1176
  * Uploads an image to the server for use in templates
@@ -1224,7 +1363,7 @@ var ReportTasksApiAxiosParamCreator = function(configuration) {
1224
1363
  * @param {{ [key: string]: string; }} [meta] When you list report tasks you can filter the list given one or metadata key/value pairs. Only items that contain all of the given metadata properties are returned.
1225
1364
  * @param {string} [templateId]
1226
1365
  * @param {number} [perPage]
1227
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1366
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1228
1367
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1229
1368
  * @param {object} [filter] Filters for report tasks. JSON encoded object in the form of `{ field: string, query: string}`, or for date range fields (including \"startOn\" and \"endOn\"), `{ field: string, query: { start: Date, end: Date }}`. ### Examples: Filter on \"startOn\": ``` { \"field\": \"startOn\", \"query\": { \"start\": \"2020-01-01T00:00:00.000Z\", \"end\": \"2020-01-02T00:00:00.000Z\" } } ``` Filter on \"enabled\" ``` { \"field\": \"enabled\", \"query\": \"True\" } ``` Filter on \"frequency\": ``` { \"field\": \"frequency\", \"query\": \"Monthly\" } ```
1230
1369
  * @param {*} [options] Override http request option.
@@ -1380,7 +1519,7 @@ var ReportTasksApiFp = function(configuration) {
1380
1519
  * @param {{ [key: string]: string; }} [meta] When you list report tasks you can filter the list given one or metadata key/value pairs. Only items that contain all of the given metadata properties are returned.
1381
1520
  * @param {string} [templateId]
1382
1521
  * @param {number} [perPage]
1383
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1522
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1384
1523
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1385
1524
  * @param {object} [filter] Filters for report tasks. JSON encoded object in the form of `{ field: string, query: string}`, or for date range fields (including \"startOn\" and \"endOn\"), `{ field: string, query: { start: Date, end: Date }}`. ### Examples: Filter on \"startOn\": ``` { \"field\": \"startOn\", \"query\": { \"start\": \"2020-01-01T00:00:00.000Z\", \"end\": \"2020-01-02T00:00:00.000Z\" } } ``` Filter on \"enabled\" ``` { \"field\": \"enabled\", \"query\": \"True\" } ``` Filter on \"frequency\": ``` { \"field\": \"frequency\", \"query\": \"Monthly\" } ```
1386
1525
  * @param {*} [options] Override http request option.
@@ -1456,7 +1595,7 @@ var ReportTasksApiFactory = function(configuration, basePath, axios2) {
1456
1595
  * @param {{ [key: string]: string; }} [meta] When you list report tasks you can filter the list given one or metadata key/value pairs. Only items that contain all of the given metadata properties are returned.
1457
1596
  * @param {string} [templateId]
1458
1597
  * @param {number} [perPage]
1459
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1598
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1460
1599
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1461
1600
  * @param {object} [filter] Filters for report tasks. JSON encoded object in the form of `{ field: string, query: string}`, or for date range fields (including \"startOn\" and \"endOn\"), `{ field: string, query: { start: Date, end: Date }}`. ### Examples: Filter on \"startOn\": ``` { \"field\": \"startOn\", \"query\": { \"start\": \"2020-01-01T00:00:00.000Z\", \"end\": \"2020-01-02T00:00:00.000Z\" } } ``` Filter on \"enabled\" ``` { \"field\": \"enabled\", \"query\": \"True\" } ``` Filter on \"frequency\": ``` { \"field\": \"frequency\", \"query\": \"Monthly\" } ```
1462
1601
  * @param {*} [options] Override http request option.
@@ -1530,7 +1669,7 @@ var ReportTasksApi = class extends BaseAPI {
1530
1669
  * @param {{ [key: string]: string; }} [meta] When you list report tasks you can filter the list given one or metadata key/value pairs. Only items that contain all of the given metadata properties are returned.
1531
1670
  * @param {string} [templateId]
1532
1671
  * @param {number} [perPage]
1533
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1672
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1534
1673
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1535
1674
  * @param {object} [filter] Filters for report tasks. JSON encoded object in the form of `{ field: string, query: string}`, or for date range fields (including \"startOn\" and \"endOn\"), `{ field: string, query: { start: Date, end: Date }}`. ### Examples: Filter on \"startOn\": ``` { \"field\": \"startOn\", \"query\": { \"start\": \"2020-01-01T00:00:00.000Z\", \"end\": \"2020-01-02T00:00:00.000Z\" } } ``` Filter on \"enabled\" ``` { \"field\": \"enabled\", \"query\": \"True\" } ``` Filter on \"frequency\": ``` { \"field\": \"frequency\", \"query\": \"Monthly\" } ```
1536
1675
  * @param {*} [options] Override http request option.
@@ -1624,6 +1763,35 @@ var ReportsApiAxiosParamCreator = function(configuration) {
1624
1763
  options: localVarRequestOptions
1625
1764
  };
1626
1765
  },
1766
+ /**
1767
+ *
1768
+ * @summary Get report thumbnail
1769
+ * @param {string} id
1770
+ * @param {*} [options] Override http request option.
1771
+ * @throws {RequiredError}
1772
+ */
1773
+ getReportThumbnail: async (id, options = {}) => {
1774
+ assertParamExists("getReportThumbnail", "id", id);
1775
+ const localVarPath = `/reports/{id}/thumbnail`.replace(`{${"id"}}`, encodeURIComponent(String(id)));
1776
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1777
+ let baseOptions;
1778
+ if (configuration) {
1779
+ baseOptions = configuration.baseOptions;
1780
+ }
1781
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
1782
+ const localVarHeaderParameter = {};
1783
+ const localVarQueryParameter = {};
1784
+ await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration);
1785
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
1786
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
1787
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1788
+ let formHeaders = {};
1789
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers };
1790
+ return {
1791
+ url: toPathString(localVarUrlObj),
1792
+ options: localVarRequestOptions
1793
+ };
1794
+ },
1627
1795
  /**
1628
1796
  *
1629
1797
  * @summary List reports
@@ -1736,6 +1904,17 @@ var ReportsApiFp = function(configuration) {
1736
1904
  const localVarAxiosArgs = await localVarAxiosParamCreator.getReport(id, options);
1737
1905
  return createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration);
1738
1906
  },
1907
+ /**
1908
+ *
1909
+ * @summary Get report thumbnail
1910
+ * @param {string} id
1911
+ * @param {*} [options] Override http request option.
1912
+ * @throws {RequiredError}
1913
+ */
1914
+ async getReportThumbnail(id, options) {
1915
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getReportThumbnail(id, options);
1916
+ return createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration);
1917
+ },
1739
1918
  /**
1740
1919
  *
1741
1920
  * @summary List reports
@@ -1789,6 +1968,16 @@ var ReportsApiFactory = function(configuration, basePath, axios2) {
1789
1968
  getReport(id, options) {
1790
1969
  return localVarFp.getReport(id, options).then((request) => request(axios2, basePath));
1791
1970
  },
1971
+ /**
1972
+ *
1973
+ * @summary Get report thumbnail
1974
+ * @param {string} id
1975
+ * @param {*} [options] Override http request option.
1976
+ * @throws {RequiredError}
1977
+ */
1978
+ getReportThumbnail(id, options) {
1979
+ return localVarFp.getReportThumbnail(id, options).then((request) => request(axios2, basePath));
1980
+ },
1792
1981
  /**
1793
1982
  *
1794
1983
  * @summary List reports
@@ -1840,6 +2029,17 @@ var ReportsApi = class extends BaseAPI {
1840
2029
  getReport(id, options) {
1841
2030
  return ReportsApiFp(this.configuration).getReport(id, options).then((request) => request(this.axios, this.basePath));
1842
2031
  }
2032
+ /**
2033
+ *
2034
+ * @summary Get report thumbnail
2035
+ * @param {string} id
2036
+ * @param {*} [options] Override http request option.
2037
+ * @throws {RequiredError}
2038
+ * @memberof ReportsApi
2039
+ */
2040
+ getReportThumbnail(id, options) {
2041
+ return ReportsApiFp(this.configuration).getReportThumbnail(id, options).then((request) => request(this.axios, this.basePath));
2042
+ }
1843
2043
  /**
1844
2044
  *
1845
2045
  * @summary List reports
@@ -2018,6 +2218,35 @@ var TemplatesApiAxiosParamCreator = function(configuration) {
2018
2218
  options: localVarRequestOptions
2019
2219
  };
2020
2220
  },
2221
+ /**
2222
+ *
2223
+ * @summary Get template thumbnail
2224
+ * @param {string} id
2225
+ * @param {*} [options] Override http request option.
2226
+ * @throws {RequiredError}
2227
+ */
2228
+ getTemplateThumbnail: async (id, options = {}) => {
2229
+ assertParamExists("getTemplateThumbnail", "id", id);
2230
+ const localVarPath = `/templates/{id}/thumbnail`.replace(`{${"id"}}`, encodeURIComponent(String(id)));
2231
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2232
+ let baseOptions;
2233
+ if (configuration) {
2234
+ baseOptions = configuration.baseOptions;
2235
+ }
2236
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
2237
+ const localVarHeaderParameter = {};
2238
+ const localVarQueryParameter = {};
2239
+ await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration);
2240
+ await setBearerAuthToObject(localVarHeaderParameter, configuration);
2241
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
2242
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2243
+ let formHeaders = {};
2244
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers };
2245
+ return {
2246
+ url: toPathString(localVarUrlObj),
2247
+ options: localVarRequestOptions
2248
+ };
2249
+ },
2021
2250
  /**
2022
2251
  *
2023
2252
  * @summary List report templates
@@ -2213,6 +2442,17 @@ var TemplatesApiFp = function(configuration) {
2213
2442
  const localVarAxiosArgs = await localVarAxiosParamCreator.getTemplate(id, options);
2214
2443
  return createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration);
2215
2444
  },
2445
+ /**
2446
+ *
2447
+ * @summary Get template thumbnail
2448
+ * @param {string} id
2449
+ * @param {*} [options] Override http request option.
2450
+ * @throws {RequiredError}
2451
+ */
2452
+ async getTemplateThumbnail(id, options) {
2453
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTemplateThumbnail(id, options);
2454
+ return createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration);
2455
+ },
2216
2456
  /**
2217
2457
  *
2218
2458
  * @summary List report templates
@@ -2314,6 +2554,16 @@ var TemplatesApiFactory = function(configuration, basePath, axios2) {
2314
2554
  getTemplate(id, options) {
2315
2555
  return localVarFp.getTemplate(id, options).then((request) => request(axios2, basePath));
2316
2556
  },
2557
+ /**
2558
+ *
2559
+ * @summary Get template thumbnail
2560
+ * @param {string} id
2561
+ * @param {*} [options] Override http request option.
2562
+ * @throws {RequiredError}
2563
+ */
2564
+ getTemplateThumbnail(id, options) {
2565
+ return localVarFp.getTemplateThumbnail(id, options).then((request) => request(axios2, basePath));
2566
+ },
2317
2567
  /**
2318
2568
  *
2319
2569
  * @summary List report templates
@@ -2414,6 +2664,17 @@ var TemplatesApi = class extends BaseAPI {
2414
2664
  getTemplate(id, options) {
2415
2665
  return TemplatesApiFp(this.configuration).getTemplate(id, options).then((request) => request(this.axios, this.basePath));
2416
2666
  }
2667
+ /**
2668
+ *
2669
+ * @summary Get template thumbnail
2670
+ * @param {string} id
2671
+ * @param {*} [options] Override http request option.
2672
+ * @throws {RequiredError}
2673
+ * @memberof TemplatesApi
2674
+ */
2675
+ getTemplateThumbnail(id, options) {
2676
+ return TemplatesApiFp(this.configuration).getTemplateThumbnail(id, options).then((request) => request(this.axios, this.basePath));
2677
+ }
2417
2678
  /**
2418
2679
  *
2419
2680
  * @summary List report templates
@@ -2835,10 +3096,12 @@ export {
2835
3096
  ReportTasksApiAxiosParamCreator,
2836
3097
  ReportTasksApiFactory,
2837
3098
  ReportTasksApiFp,
3099
+ ReportTypeEnum,
2838
3100
  ReportsApi,
2839
3101
  ReportsApiAxiosParamCreator,
2840
3102
  ReportsApiFactory,
2841
3103
  ReportsApiFp,
3104
+ TemplateTypeEnum,
2842
3105
  TemplatesApi,
2843
3106
  TemplatesApiAxiosParamCreator,
2844
3107
  TemplatesApiFactory,