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

package/base.ts

@@ -4,7 +4,7 @@
  * ConnectReport Core API
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
  *
- * The version of the OpenAPI document: 2.80.0
+ * The version of the OpenAPI document: 2.80.5
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * ConnectReport Core API
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
  *
- * The version of the OpenAPI document: 2.80.0
+ * The version of the OpenAPI document: 2.80.5
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * ConnectReport Core API
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
  *
- * The version of the OpenAPI document: 2.80.0
+ * The version of the OpenAPI document: 2.80.5
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.cjs

@@ -106,6 +106,7 @@ __export(index_exports, {
   ReportTasksApiAxiosParamCreator: () => ReportTasksApiAxiosParamCreator,
   ReportTasksApiFactory: () => ReportTasksApiFactory,
   ReportTasksApiFp: () => ReportTasksApiFp,
+  ReportTypeEnum: () => ReportTypeEnum,
   ReportsApi: () => ReportsApi,
   ReportsApiAxiosParamCreator: () => ReportsApiAxiosParamCreator,
   ReportsApiFactory: () => ReportsApiFactory,
@@ -214,6 +215,11 @@ var FilterCycleEmailEnum = /* @__PURE__ */ ((FilterCycleEmailEnum2) => {
   FilterCycleEmailEnum2["Csv"] = "csv";
   return FilterCycleEmailEnum2;
 })(FilterCycleEmailEnum || {});
+var ReportTypeEnum = /* @__PURE__ */ ((ReportTypeEnum2) => {
+  ReportTypeEnum2["PixelPerfect"] = "pixel-perfect";
+  ReportTypeEnum2["Excel"] = "excel";
+  return ReportTypeEnum2;
+})(ReportTypeEnum || {});
 var ReportTaskFrequencyEnum = /* @__PURE__ */ ((ReportTaskFrequencyEnum2) => {
   ReportTaskFrequencyEnum2["Monthly"] = "Monthly";
   ReportTaskFrequencyEnum2["OnceNow"] = "Once - now";
@@ -301,6 +307,35 @@ var BaseTemplatesApiAxiosParamCreator = function(configuration) {
         options: localVarRequestOptions
       };
     },
+    /**
+     * 
+     * @summary Get base template thumbnail
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBaseTemplateThumbnail: async (id, options = {}) => {
+      assertParamExists("getBaseTemplateThumbnail", "id", id);
+      const localVarPath = `/base-templates/{id}/thumbnail`.replace(`{${"id"}}`, encodeURIComponent(String(id)));
+      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+      let baseOptions;
+      if (configuration) {
+        baseOptions = configuration.baseOptions;
+      }
+      const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
+      const localVarHeaderParameter = {};
+      const localVarQueryParameter = {};
+      await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration);
+      await setBearerAuthToObject(localVarHeaderParameter, configuration);
+      setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
+      let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+      let formHeaders = {};
+      localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers };
+      return {
+        url: toPathString(localVarUrlObj),
+        options: localVarRequestOptions
+      };
+    },
     /**
      * 
      * @summary List base templates
@@ -352,6 +387,17 @@ var BaseTemplatesApiFp = function(configuration) {
       const localVarAxiosArgs = await localVarAxiosParamCreator.duplicateBaseTemplate(id, options);
       return createRequestFunction(localVarAxiosArgs, import_axios2.default, BASE_PATH, configuration);
     },
+    /**
+     * 
+     * @summary Get base template thumbnail
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    async getBaseTemplateThumbnail(id, options) {
+      const localVarAxiosArgs = await localVarAxiosParamCreator.getBaseTemplateThumbnail(id, options);
+      return createRequestFunction(localVarAxiosArgs, import_axios2.default, BASE_PATH, configuration);
+    },
     /**
      * 
      * @summary List base templates
@@ -379,6 +425,16 @@ var BaseTemplatesApiFactory = function(configuration, basePath, axios2) {
     duplicateBaseTemplate(id, options) {
       return localVarFp.duplicateBaseTemplate(id, options).then((request) => request(axios2, basePath));
     },
+    /**
+     * 
+     * @summary Get base template thumbnail
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBaseTemplateThumbnail(id, options) {
+      return localVarFp.getBaseTemplateThumbnail(id, options).then((request) => request(axios2, basePath));
+    },
     /**
      * 
      * @summary List base templates
@@ -404,6 +460,17 @@ var BaseTemplatesApi = class extends BaseAPI {
   duplicateBaseTemplate(id, options) {
     return BaseTemplatesApiFp(this.configuration).duplicateBaseTemplate(id, options).then((request) => request(this.axios, this.basePath));
   }
+  /**
+   * 
+   * @summary Get base template thumbnail
+   * @param {string} id 
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof BaseTemplatesApi
+   */
+  getBaseTemplateThumbnail(id, options) {
+    return BaseTemplatesApiFp(this.configuration).getBaseTemplateThumbnail(id, options).then((request) => request(this.axios, this.basePath));
+  }
   /**
    * 
    * @summary List base templates
@@ -422,16 +489,49 @@ var DocumentsApiAxiosParamCreator = function(configuration) {
     /**
      * 
      * @summary Retrieve a generated document
-     * @param {string} fileName 
+     * @param {string} id 
      * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType 
      * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getDocument: async (fileName, fileType, attachmentName, options = {}) => {
-      assertParamExists("getDocument", "fileName", fileName);
+    getDocument: async (id, fileType, attachmentName, options = {}) => {
+      assertParamExists("getDocument", "id", id);
       assertParamExists("getDocument", "fileType", fileType);
-      const localVarPath = `/documents/{fileType}/{fileName}`.replace(`{${"fileName"}}`, encodeURIComponent(String(fileName))).replace(`{${"fileType"}}`, encodeURIComponent(String(fileType)));
+      const localVarPath = `/documents/{fileType}/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(id))).replace(`{${"fileType"}}`, encodeURIComponent(String(fileType)));
+      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+      let baseOptions;
+      if (configuration) {
+        baseOptions = configuration.baseOptions;
+      }
+      const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
+      const localVarHeaderParameter = {};
+      const localVarQueryParameter = {};
+      await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration);
+      await setBearerAuthToObject(localVarHeaderParameter, configuration);
+      if (attachmentName !== void 0) {
+        localVarQueryParameter["attachmentName"] = attachmentName;
+      }
+      setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
+      let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+      let formHeaders = {};
+      localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers };
+      return {
+        url: toPathString(localVarUrlObj),
+        options: localVarRequestOptions
+      };
+    },
+    /**
+     * 
+     * @summary Retrieve a generated document
+     * @param {string} id 
+     * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentById: async (id, attachmentName, options = {}) => {
+      assertParamExists("getDocumentById", "id", id);
+      const localVarPath = `/documents/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(id)));
       const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
       let baseOptions;
       if (configuration) {
@@ -462,14 +562,26 @@ var DocumentsApiFp = function(configuration) {
     /**
      * 
      * @summary Retrieve a generated document
-     * @param {string} fileName 
+     * @param {string} id 
      * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType 
      * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    async getDocument(fileName, fileType, attachmentName, options) {
-      const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(fileName, fileType, attachmentName, options);
+    async getDocument(id, fileType, attachmentName, options) {
+      const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(id, fileType, attachmentName, options);
+      return createRequestFunction(localVarAxiosArgs, import_axios2.default, BASE_PATH, configuration);
+    },
+    /**
+     * 
+     * @summary Retrieve a generated document
+     * @param {string} id 
+     * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    async getDocumentById(id, attachmentName, options) {
+      const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentById(id, attachmentName, options);
       return createRequestFunction(localVarAxiosArgs, import_axios2.default, BASE_PATH, configuration);
     }
   };
@@ -480,14 +592,25 @@ var DocumentsApiFactory = function(configuration, basePath, axios2) {
     /**
      * 
      * @summary Retrieve a generated document
-     * @param {string} fileName 
+     * @param {string} id 
      * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType 
      * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getDocument(fileName, fileType, attachmentName, options) {
-      return localVarFp.getDocument(fileName, fileType, attachmentName, options).then((request) => request(axios2, basePath));
+    getDocument(id, fileType, attachmentName, options) {
+      return localVarFp.getDocument(id, fileType, attachmentName, options).then((request) => request(axios2, basePath));
+    },
+    /**
+     * 
+     * @summary Retrieve a generated document
+     * @param {string} id 
+     * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocumentById(id, attachmentName, options) {
+      return localVarFp.getDocumentById(id, attachmentName, options).then((request) => request(axios2, basePath));
     }
   };
 };
@@ -495,15 +618,27 @@ var DocumentsApi = class extends BaseAPI {
   /**
    * 
    * @summary Retrieve a generated document
-   * @param {string} fileName 
+   * @param {string} id 
    * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType 
    * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
    * @param {*} [options] Override http request option.
    * @throws {RequiredError}
    * @memberof DocumentsApi
    */
-  getDocument(fileName, fileType, attachmentName, options) {
-    return DocumentsApiFp(this.configuration).getDocument(fileName, fileType, attachmentName, options).then((request) => request(this.axios, this.basePath));
+  getDocument(id, fileType, attachmentName, options) {
+    return DocumentsApiFp(this.configuration).getDocument(id, fileType, attachmentName, options).then((request) => request(this.axios, this.basePath));
+  }
+  /**
+   * 
+   * @summary Retrieve a generated document
+   * @param {string} id 
+   * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof DocumentsApi
+   */
+  getDocumentById(id, attachmentName, options) {
+    return DocumentsApiFp(this.configuration).getDocumentById(id, attachmentName, options).then((request) => request(this.axios, this.basePath));
   }
 };
 var FilterCyclesApiAxiosParamCreator = function(configuration) {
@@ -966,13 +1101,13 @@ var ImagesApiAxiosParamCreator = function(configuration) {
     /**
      * 
      * @summary Retrieves a user uploaded image for use in a template
-     * @param {string} title 
+     * @param {string} id 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getImage: async (title, options = {}) => {
-      assertParamExists("getImage", "title", title);
-      const localVarPath = `/images/{title}`.replace(`{${"title"}}`, encodeURIComponent(String(title)));
+    getImage: async (id, options = {}) => {
+      assertParamExists("getImage", "id", id);
+      const localVarPath = `/images/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(id)));
       const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
       let baseOptions;
       if (configuration) {
@@ -1037,12 +1172,12 @@ var ImagesApiFp = function(configuration) {
     /**
      * 
      * @summary Retrieves a user uploaded image for use in a template
-     * @param {string} title 
+     * @param {string} id 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    async getImage(title, options) {
-      const localVarAxiosArgs = await localVarAxiosParamCreator.getImage(title, options);
+    async getImage(id, options) {
+      const localVarAxiosArgs = await localVarAxiosParamCreator.getImage(id, options);
       return createRequestFunction(localVarAxiosArgs, import_axios2.default, BASE_PATH, configuration);
     },
     /**
@@ -1064,12 +1199,12 @@ var ImagesApiFactory = function(configuration, basePath, axios2) {
     /**
      * 
      * @summary Retrieves a user uploaded image for use in a template
-     * @param {string} title 
+     * @param {string} id 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getImage(title, options) {
-      return localVarFp.getImage(title, options).then((request) => request(axios2, basePath));
+    getImage(id, options) {
+      return localVarFp.getImage(id, options).then((request) => request(axios2, basePath));
     },
     /**
      * Uploads an image to the server for use in templates
@@ -1087,13 +1222,13 @@ var ImagesApi = class extends BaseAPI {
   /**
    * 
    * @summary Retrieves a user uploaded image for use in a template
-   * @param {string} title 
+   * @param {string} id 
    * @param {*} [options] Override http request option.
    * @throws {RequiredError}
    * @memberof ImagesApi
    */
-  getImage(title, options) {
-    return ImagesApiFp(this.configuration).getImage(title, options).then((request) => request(this.axios, this.basePath));
+  getImage(id, options) {
+    return ImagesApiFp(this.configuration).getImage(id, options).then((request) => request(this.axios, this.basePath));
   }
   /**
    * Uploads an image to the server for use in templates
@@ -1686,6 +1821,35 @@ var ReportsApiAxiosParamCreator = function(configuration) {
         options: localVarRequestOptions
       };
     },
+    /**
+     * 
+     * @summary Get report thumbnail
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReportThumbnail: async (id, options = {}) => {
+      assertParamExists("getReportThumbnail", "id", id);
+      const localVarPath = `/reports/{id}/thumbnail`.replace(`{${"id"}}`, encodeURIComponent(String(id)));
+      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+      let baseOptions;
+      if (configuration) {
+        baseOptions = configuration.baseOptions;
+      }
+      const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
+      const localVarHeaderParameter = {};
+      const localVarQueryParameter = {};
+      await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration);
+      await setBearerAuthToObject(localVarHeaderParameter, configuration);
+      setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
+      let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+      let formHeaders = {};
+      localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers };
+      return {
+        url: toPathString(localVarUrlObj),
+        options: localVarRequestOptions
+      };
+    },
     /**
      * 
      * @summary List reports
@@ -1798,6 +1962,17 @@ var ReportsApiFp = function(configuration) {
       const localVarAxiosArgs = await localVarAxiosParamCreator.getReport(id, options);
       return createRequestFunction(localVarAxiosArgs, import_axios2.default, BASE_PATH, configuration);
     },
+    /**
+     * 
+     * @summary Get report thumbnail
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    async getReportThumbnail(id, options) {
+      const localVarAxiosArgs = await localVarAxiosParamCreator.getReportThumbnail(id, options);
+      return createRequestFunction(localVarAxiosArgs, import_axios2.default, BASE_PATH, configuration);
+    },
     /**
      * 
      * @summary List reports
@@ -1851,6 +2026,16 @@ var ReportsApiFactory = function(configuration, basePath, axios2) {
     getReport(id, options) {
       return localVarFp.getReport(id, options).then((request) => request(axios2, basePath));
     },
+    /**
+     * 
+     * @summary Get report thumbnail
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReportThumbnail(id, options) {
+      return localVarFp.getReportThumbnail(id, options).then((request) => request(axios2, basePath));
+    },
     /**
      * 
      * @summary List reports
@@ -1902,6 +2087,17 @@ var ReportsApi = class extends BaseAPI {
   getReport(id, options) {
     return ReportsApiFp(this.configuration).getReport(id, options).then((request) => request(this.axios, this.basePath));
   }
+  /**
+   * 
+   * @summary Get report thumbnail
+   * @param {string} id 
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof ReportsApi
+   */
+  getReportThumbnail(id, options) {
+    return ReportsApiFp(this.configuration).getReportThumbnail(id, options).then((request) => request(this.axios, this.basePath));
+  }
   /**
    * 
    * @summary List reports
@@ -2080,6 +2276,35 @@ var TemplatesApiAxiosParamCreator = function(configuration) {
         options: localVarRequestOptions
       };
     },
+    /**
+     * 
+     * @summary Get template thumbnail
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTemplateThumbnail: async (id, options = {}) => {
+      assertParamExists("getTemplateThumbnail", "id", id);
+      const localVarPath = `/templates/{id}/thumbnail`.replace(`{${"id"}}`, encodeURIComponent(String(id)));
+      const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+      let baseOptions;
+      if (configuration) {
+        baseOptions = configuration.baseOptions;
+      }
+      const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
+      const localVarHeaderParameter = {};
+      const localVarQueryParameter = {};
+      await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration);
+      await setBearerAuthToObject(localVarHeaderParameter, configuration);
+      setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
+      let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+      let formHeaders = {};
+      localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers };
+      return {
+        url: toPathString(localVarUrlObj),
+        options: localVarRequestOptions
+      };
+    },
     /**
      * 
      * @summary List report templates
@@ -2275,6 +2500,17 @@ var TemplatesApiFp = function(configuration) {
       const localVarAxiosArgs = await localVarAxiosParamCreator.getTemplate(id, options);
       return createRequestFunction(localVarAxiosArgs, import_axios2.default, BASE_PATH, configuration);
     },
+    /**
+     * 
+     * @summary Get template thumbnail
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    async getTemplateThumbnail(id, options) {
+      const localVarAxiosArgs = await localVarAxiosParamCreator.getTemplateThumbnail(id, options);
+      return createRequestFunction(localVarAxiosArgs, import_axios2.default, BASE_PATH, configuration);
+    },
     /**
      * 
      * @summary List report templates
@@ -2376,6 +2612,16 @@ var TemplatesApiFactory = function(configuration, basePath, axios2) {
     getTemplate(id, options) {
       return localVarFp.getTemplate(id, options).then((request) => request(axios2, basePath));
     },
+    /**
+     * 
+     * @summary Get template thumbnail
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTemplateThumbnail(id, options) {
+      return localVarFp.getTemplateThumbnail(id, options).then((request) => request(axios2, basePath));
+    },
     /**
      * 
      * @summary List report templates
@@ -2476,6 +2722,17 @@ var TemplatesApi = class extends BaseAPI {
   getTemplate(id, options) {
     return TemplatesApiFp(this.configuration).getTemplate(id, options).then((request) => request(this.axios, this.basePath));
   }
+  /**
+   * 
+   * @summary Get template thumbnail
+   * @param {string} id 
+   * @param {*} [options] Override http request option.
+   * @throws {RequiredError}
+   * @memberof TemplatesApi
+   */
+  getTemplateThumbnail(id, options) {
+    return TemplatesApiFp(this.configuration).getTemplateThumbnail(id, options).then((request) => request(this.axios, this.basePath));
+  }
   /**
    * 
    * @summary List report templates
@@ -2898,6 +3155,7 @@ globalThis.ConnectReport = ConnectReport;
   ReportTasksApiAxiosParamCreator,
   ReportTasksApiFactory,
   ReportTasksApiFp,
+  ReportTypeEnum,
   ReportsApi,
   ReportsApiAxiosParamCreator,
   ReportsApiFactory,