Merge pull request #116 from TaskarCenterAtUW/feature-generate-api-client

system:auto generated API client

Author: github-actions[bot]

README.md

@@ -1,4 +1,4 @@
-## tdei-client@1.1.91
+## tdei-client@1.1.92
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install tdei-client@1.1.91 --save
+npm install tdei-client@1.1.92 --save
 ```
 
 _unPublished (not recommended):_

apis/oswapi.ts

@@ -617,6 +617,103 @@ export const OSWApiAxiosParamCreator = function (configuration?: Configuration)
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Streams all feedback for the specified project group in CSV format. Requires poc or osw_data_generator role.
+         * @summary Downloads dataset viewer feedbacks as a CSV.
+         * @param {string} [tdei_dataset_id] ID of the dataset.
+         * @param {Date} [from_date] <strong>from_date:</strong> Date in ISO 8601 format, filters feedback created after this date.
+         * @param {Date} [to_date] <strong>to_date:</strong> Date in ISO 8601 format, filters feedback created before this date.
+         * @param {string} [status] <strong>status:</strong> Filters feedbacks by their status.
+         * @param {string} [sort_by] <strong>sort_by:</strong> String, defaults to 'created_at'. Sorts feedbacks by the specified field.
+         * @param {string} [due_date] <strong>due_date:</strong> Legacy alias for <code>sort_by</code>. Use 'created_at' or 'due_date'.
+         * @param {string} [sort_order] <strong>sort_order:</strong> String, defaults to 'desc'. Sorts feedbacks in ascending or descending order.
+         * @param {number} [page_no] <strong>page_no:</strong> Integer, specifies the page number to retrieve. If omitted with page_size, the response is unpaginated.
+         * @param {number} [page_size] <strong>Page size:</strong> Integer, between 1 to 50. If omitted with page_no, the response is unpaginated.
+         * @param {string} [format] <strong>format:</strong> Output format. Only 'csv' is supported.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        oswDatasetViewerFeedbacksDownload: async (tdei_dataset_id?: string, from_date?: Date, to_date?: Date, status?: string, sort_by?: string, due_date?: string, sort_order?: string, page_no?: number, page_size?: number, format?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/osw/dataset-viewer/feedbacks/download/{tdei_project_group_id}`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, 'https://example.com');
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication AuthorizationToken required
+            // http bearer authentication required
+            if (configuration && configuration.accessToken) {
+                const accessToken = typeof configuration.accessToken === 'function'
+                    ? await configuration.accessToken()
+                    : await configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
+            }
+
+            if (tdei_dataset_id !== undefined) {
+                localVarQueryParameter['tdei_dataset_id'] = tdei_dataset_id;
+            }
+
+            if (from_date !== undefined) {
+                localVarQueryParameter['from_date'] = (from_date as any instanceof Date) ?
+                    (from_date as any).toISOString() :
+                    from_date;
+            }
+
+            if (to_date !== undefined) {
+                localVarQueryParameter['to_date'] = (to_date as any instanceof Date) ?
+                    (to_date as any).toISOString() :
+                    to_date;
+            }
+
+            if (status !== undefined) {
+                localVarQueryParameter['status'] = status;
+            }
+
+            if (sort_by !== undefined) {
+                localVarQueryParameter['sort_by'] = sort_by;
+            }
+
+            if (due_date !== undefined) {
+                localVarQueryParameter['due_date'] = due_date;
+            }
+
+            if (sort_order !== undefined) {
+                localVarQueryParameter['sort_order'] = sort_order;
+            }
+
+            if (page_no !== undefined) {
+                localVarQueryParameter['page_no'] = page_no;
+            }
+
+            if (page_size !== undefined) {
+                localVarQueryParameter['page_size'] = page_size;
+            }
+
+            if (format !== undefined) {
+                localVarQueryParameter['format'] = format;
+            }
+
+            const query = new URLSearchParams(localVarUrlObj.search);
+            for (const key in localVarQueryParameter) {
+                query.set(key, localVarQueryParameter[key]);
+            }
+            for (const key in options.params) {
+                query.set(key, options.params[key]);
+            }
+            localVarUrlObj.search = (new URLSearchParams(query)).toString();
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieves the feedbacks summary. Response includes a summary of feedbacks such as total count, total overdue, and other relevant statistics.
          * @summary Retrieves the feedbacks summary.
@@ -1407,6 +1504,29 @@ export const OSWApiFp = function(configuration?: Configuration) {
                 return axios.request(axiosRequestArgs);
             };
         },
+        /**
+         * Streams all feedback for the specified project group in CSV format. Requires poc or osw_data_generator role.
+         * @summary Downloads dataset viewer feedbacks as a CSV.
+         * @param {string} [tdei_dataset_id] ID of the dataset.
+         * @param {Date} [from_date] &lt;strong&gt;from_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedback created after this date.
+         * @param {Date} [to_date] &lt;strong&gt;to_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedback created before this date.
+         * @param {string} [status] &lt;strong&gt;status:&lt;/strong&gt; Filters feedbacks by their status.
+         * @param {string} [sort_by] &lt;strong&gt;sort_by:&lt;/strong&gt; String, defaults to &#x27;created_at&#x27;. Sorts feedbacks by the specified field.
+         * @param {string} [due_date] &lt;strong&gt;due_date:&lt;/strong&gt; Legacy alias for &lt;code&gt;sort_by&lt;/code&gt;. Use &#x27;created_at&#x27; or &#x27;due_date&#x27;.
+         * @param {string} [sort_order] &lt;strong&gt;sort_order:&lt;/strong&gt; String, defaults to &#x27;desc&#x27;. Sorts feedbacks in ascending or descending order.
+         * @param {number} [page_no] &lt;strong&gt;page_no:&lt;/strong&gt; Integer, specifies the page number to retrieve. If omitted with page_size, the response is unpaginated.
+         * @param {number} [page_size] &lt;strong&gt;Page size:&lt;/strong&gt; Integer, between 1 to 50. If omitted with page_no, the response is unpaginated.
+         * @param {string} [format] &lt;strong&gt;format:&lt;/strong&gt; Output format. Only &#x27;csv&#x27; is supported.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async oswDatasetViewerFeedbacksDownload(tdei_dataset_id?: string, from_date?: Date, to_date?: Date, status?: string, sort_by?: string, due_date?: string, sort_order?: string, page_no?: number, page_size?: number, format?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Blob>>> {
+            const localVarAxiosArgs = await OSWApiAxiosParamCreator(configuration).oswDatasetViewerFeedbacksDownload(tdei_dataset_id, from_date, to_date, status, sort_by, due_date, sort_order, page_no, page_size, format, options);
+            return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+                const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
+                return axios.request(axiosRequestArgs);
+            };
+        },
         /**
          * Retrieves the feedbacks summary. Response includes a summary of feedbacks such as total count, total overdue, and other relevant statistics.
          * @summary Retrieves the feedbacks summary.
@@ -1671,6 +1791,25 @@ export const OSWApiFactory = function (configuration?: Configuration, basePath?:
         async oswDatasetViewerFeedbacks(tdei_project_group_id?: string, tdei_dataset_id?: string, from_date?: Date, to_date?: Date, status?: string, sort_by?: string, sort_order?: string, page_no?: number, page_size?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Feedback>>> {
             return OSWApiFp(configuration).oswDatasetViewerFeedbacks(tdei_project_group_id, tdei_dataset_id, from_date, to_date, status, sort_by, sort_order, page_no, page_size, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Streams all feedback for the specified project group in CSV format. Requires poc or osw_data_generator role.
+         * @summary Downloads dataset viewer feedbacks as a CSV.
+         * @param {string} [tdei_dataset_id] ID of the dataset.
+         * @param {Date} [from_date] &lt;strong&gt;from_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedback created after this date.
+         * @param {Date} [to_date] &lt;strong&gt;to_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedback created before this date.
+         * @param {string} [status] &lt;strong&gt;status:&lt;/strong&gt; Filters feedbacks by their status.
+         * @param {string} [sort_by] &lt;strong&gt;sort_by:&lt;/strong&gt; String, defaults to &#x27;created_at&#x27;. Sorts feedbacks by the specified field.
+         * @param {string} [due_date] &lt;strong&gt;due_date:&lt;/strong&gt; Legacy alias for &lt;code&gt;sort_by&lt;/code&gt;. Use &#x27;created_at&#x27; or &#x27;due_date&#x27;.
+         * @param {string} [sort_order] &lt;strong&gt;sort_order:&lt;/strong&gt; String, defaults to &#x27;desc&#x27;. Sorts feedbacks in ascending or descending order.
+         * @param {number} [page_no] &lt;strong&gt;page_no:&lt;/strong&gt; Integer, specifies the page number to retrieve. If omitted with page_size, the response is unpaginated.
+         * @param {number} [page_size] &lt;strong&gt;Page size:&lt;/strong&gt; Integer, between 1 to 50. If omitted with page_no, the response is unpaginated.
+         * @param {string} [format] &lt;strong&gt;format:&lt;/strong&gt; Output format. Only &#x27;csv&#x27; is supported.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async oswDatasetViewerFeedbacksDownload(tdei_dataset_id?: string, from_date?: Date, to_date?: Date, status?: string, sort_by?: string, due_date?: string, sort_order?: string, page_no?: number, page_size?: number, format?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Blob>> {
+            return OSWApiFp(configuration).oswDatasetViewerFeedbacksDownload(tdei_dataset_id, from_date, to_date, status, sort_by, due_date, sort_order, page_no, page_size, format, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieves the feedbacks summary. Response includes a summary of feedbacks such as total count, total overdue, and other relevant statistics.
          * @summary Retrieves the feedbacks summary.
@@ -1905,6 +2044,26 @@ export class OSWApi extends BaseAPI {
     public async oswDatasetViewerFeedbacks(tdei_project_group_id?: string, tdei_dataset_id?: string, from_date?: Date, to_date?: Date, status?: string, sort_by?: string, sort_order?: string, page_no?: number, page_size?: number, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<Feedback>>> {
         return OSWApiFp(this.configuration).oswDatasetViewerFeedbacks(tdei_project_group_id, tdei_dataset_id, from_date, to_date, status, sort_by, sort_order, page_no, page_size, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Streams all feedback for the specified project group in CSV format. Requires poc or osw_data_generator role.
+     * @summary Downloads dataset viewer feedbacks as a CSV.
+     * @param {string} [tdei_dataset_id] ID of the dataset.
+     * @param {Date} [from_date] &lt;strong&gt;from_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedback created after this date.
+     * @param {Date} [to_date] &lt;strong&gt;to_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedback created before this date.
+     * @param {string} [status] &lt;strong&gt;status:&lt;/strong&gt; Filters feedbacks by their status.
+     * @param {string} [sort_by] &lt;strong&gt;sort_by:&lt;/strong&gt; String, defaults to &#x27;created_at&#x27;. Sorts feedbacks by the specified field.
+     * @param {string} [due_date] &lt;strong&gt;due_date:&lt;/strong&gt; Legacy alias for &lt;code&gt;sort_by&lt;/code&gt;. Use &#x27;created_at&#x27; or &#x27;due_date&#x27;.
+     * @param {string} [sort_order] &lt;strong&gt;sort_order:&lt;/strong&gt; String, defaults to &#x27;desc&#x27;. Sorts feedbacks in ascending or descending order.
+     * @param {number} [page_no] &lt;strong&gt;page_no:&lt;/strong&gt; Integer, specifies the page number to retrieve. If omitted with page_size, the response is unpaginated.
+     * @param {number} [page_size] &lt;strong&gt;Page size:&lt;/strong&gt; Integer, between 1 to 50. If omitted with page_no, the response is unpaginated.
+     * @param {string} [format] &lt;strong&gt;format:&lt;/strong&gt; Output format. Only &#x27;csv&#x27; is supported.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OSWApi
+     */
+    public async oswDatasetViewerFeedbacksDownload(tdei_dataset_id?: string, from_date?: Date, to_date?: Date, status?: string, sort_by?: string, due_date?: string, sort_order?: string, page_no?: number, page_size?: number, format?: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<Blob>> {
+        return OSWApiFp(this.configuration).oswDatasetViewerFeedbacksDownload(tdei_dataset_id, from_date, to_date, status, sort_by, due_date, sort_order, page_no, page_size, format, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Retrieves the feedbacks summary. Response includes a summary of feedbacks such as total count, total overdue, and other relevant statistics.
      * @summary Retrieves the feedbacks summary.