Skip to content

Commit 9c2f396

Browse files
Merge pull request #114 from TaskarCenterAtUW/feature-generate-api-client
system:auto generated API client
2 parents 92aab18 + 7135759 commit 9c2f396

File tree

8 files changed

+81
-43
lines changed

8 files changed

+81
-43
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## tdei-client@1.1.89
1+
## tdei-client@1.1.90
22

33
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:
44

@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
3636
_published:_
3737

3838
```
39-
npm install tdei-client@1.1.89 --save
39+
npm install tdei-client@1.1.90 --save
4040
```
4141

4242
_unPublished (not recommended):_

apis/oswapi.ts

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -532,14 +532,15 @@ export const OSWApiAxiosParamCreator = function (configuration?: Configuration)
532532
* @param {string} [tdei_dataset_id] ID of the dataset.
533533
* @param {Date} [from_date] <strong>from_date:</strong> Date in ISO 8601 format, filters feedbacks created after this date.
534534
* @param {Date} [to_date] <strong>to_date:</strong> Date in ISO 8601 format, filters feedbacks created before this date.
535+
* @param {string} [status] <strong>status:</strong> Filters feedbacks by their status.
535536
* @param {string} [sort_by] <strong>sort_by:</strong> String, defaults to 'created_at'. Sorts feedbacks by the specified field.
536537
* @param {string} [sort_order] <strong>sort_order:</strong> String, defaults to 'desc'. Sorts feedbacks in ascending or descending order.
537538
* @param {number} [page_no] <strong>page_no:</strong> Integer, defaults to 1. Specifies the page number to retrieve.
538539
* @param {number} [page_size] <strong>Page size:</strong> Integer, between 1 to 50, defaults to 10. Specifies total records per page.
539540
* @param {*} [options] Override http request option.
540541
* @throws {RequiredError}
541542
*/
542-
oswDatasetViewerFeedbacks: async (tdei_project_group_id?: string, tdei_dataset_id?: string, from_date?: Date, to_date?: Date, sort_by?: string, sort_order?: string, page_no?: number, page_size?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
543+
oswDatasetViewerFeedbacks: async (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<RequestArgs> => {
543544
const localVarPath = `/api/v1/osw/dataset-viewer/feedbacks`;
544545
// use dummy base URL string because the URL constructor only accepts absolute URLs.
545546
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
@@ -580,6 +581,10 @@ export const OSWApiAxiosParamCreator = function (configuration?: Configuration)
580581
to_date;
581582
}
582583

584+
if (status !== undefined) {
585+
localVarQueryParameter['status'] = status;
586+
}
587+
583588
if (sort_by !== undefined) {
584589
localVarQueryParameter['sort_by'] = sort_by;
585590
}
@@ -615,10 +620,11 @@ export const OSWApiAxiosParamCreator = function (configuration?: Configuration)
615620
/**
616621
* Retrieves the feedbacks summary. Response includes a summary of feedbacks such as total count, total overdue, and other relevant statistics.
617622
* @summary Retrieves the feedbacks summary.
623+
* @param {string} [tdei_project_group_id] ID of the project group.
618624
* @param {*} [options] Override http request option.
619625
* @throws {RequiredError}
620626
*/
621-
oswDatasetViewerFeedbacksMetadata: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
627+
oswDatasetViewerFeedbacksMetadata: async (tdei_project_group_id?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
622628
const localVarPath = `/api/v1/osw/dataset-viewer/feedbacks/metadata`;
623629
// use dummy base URL string because the URL constructor only accepts absolute URLs.
624630
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
@@ -639,6 +645,10 @@ export const OSWApiAxiosParamCreator = function (configuration?: Configuration)
639645
localVarHeaderParameter["Authorization"] = "Bearer " + accessToken;
640646
}
641647

648+
if (tdei_project_group_id !== undefined) {
649+
localVarQueryParameter['tdei_project_group_id'] = tdei_project_group_id;
650+
}
651+
642652
const query = new URLSearchParams(localVarUrlObj.search);
643653
for (const key in localVarQueryParameter) {
644654
query.set(key, localVarQueryParameter[key]);
@@ -1382,15 +1392,16 @@ export const OSWApiFp = function(configuration?: Configuration) {
13821392
* @param {string} [tdei_dataset_id] ID of the dataset.
13831393
* @param {Date} [from_date] &lt;strong&gt;from_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedbacks created after this date.
13841394
* @param {Date} [to_date] &lt;strong&gt;to_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedbacks created before this date.
1395+
* @param {string} [status] &lt;strong&gt;status:&lt;/strong&gt; Filters feedbacks by their status.
13851396
* @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.
13861397
* @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.
13871398
* @param {number} [page_no] &lt;strong&gt;page_no:&lt;/strong&gt; Integer, defaults to 1. Specifies the page number to retrieve.
13881399
* @param {number} [page_size] &lt;strong&gt;Page size:&lt;/strong&gt; Integer, between 1 to 50, defaults to 10. Specifies total records per page.
13891400
* @param {*} [options] Override http request option.
13901401
* @throws {RequiredError}
13911402
*/
1392-
async oswDatasetViewerFeedbacks(tdei_project_group_id?: string, tdei_dataset_id?: string, from_date?: Date, to_date?: Date, sort_by?: string, sort_order?: string, page_no?: number, page_size?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Feedback>>>> {
1393-
const localVarAxiosArgs = await OSWApiAxiosParamCreator(configuration).oswDatasetViewerFeedbacks(tdei_project_group_id, tdei_dataset_id, from_date, to_date, sort_by, sort_order, page_no, page_size, options);
1403+
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<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Feedback>>>> {
1404+
const localVarAxiosArgs = await OSWApiAxiosParamCreator(configuration).oswDatasetViewerFeedbacks(tdei_project_group_id, tdei_dataset_id, from_date, to_date, status, sort_by, sort_order, page_no, page_size, options);
13941405
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
13951406
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
13961407
return axios.request(axiosRequestArgs);
@@ -1399,11 +1410,12 @@ export const OSWApiFp = function(configuration?: Configuration) {
13991410
/**
14001411
* Retrieves the feedbacks summary. Response includes a summary of feedbacks such as total count, total overdue, and other relevant statistics.
14011412
* @summary Retrieves the feedbacks summary.
1413+
* @param {string} [tdei_project_group_id] ID of the project group.
14021414
* @param {*} [options] Override http request option.
14031415
* @throws {RequiredError}
14041416
*/
1405-
async oswDatasetViewerFeedbacksMetadata(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<FeedbackMetadata>>>> {
1406-
const localVarAxiosArgs = await OSWApiAxiosParamCreator(configuration).oswDatasetViewerFeedbacksMetadata(options);
1417+
async oswDatasetViewerFeedbacksMetadata(tdei_project_group_id?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<FeedbackMetadata>>> {
1418+
const localVarAxiosArgs = await OSWApiAxiosParamCreator(configuration).oswDatasetViewerFeedbacksMetadata(tdei_project_group_id, options);
14071419
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
14081420
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
14091421
return axios.request(axiosRequestArgs);
@@ -1648,24 +1660,26 @@ export const OSWApiFactory = function (configuration?: Configuration, basePath?:
16481660
* @param {string} [tdei_dataset_id] ID of the dataset.
16491661
* @param {Date} [from_date] &lt;strong&gt;from_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedbacks created after this date.
16501662
* @param {Date} [to_date] &lt;strong&gt;to_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedbacks created before this date.
1663+
* @param {string} [status] &lt;strong&gt;status:&lt;/strong&gt; Filters feedbacks by their status.
16511664
* @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.
16521665
* @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.
16531666
* @param {number} [page_no] &lt;strong&gt;page_no:&lt;/strong&gt; Integer, defaults to 1. Specifies the page number to retrieve.
16541667
* @param {number} [page_size] &lt;strong&gt;Page size:&lt;/strong&gt; Integer, between 1 to 50, defaults to 10. Specifies total records per page.
16551668
* @param {*} [options] Override http request option.
16561669
* @throws {RequiredError}
16571670
*/
1658-
async oswDatasetViewerFeedbacks(tdei_project_group_id?: string, tdei_dataset_id?: string, from_date?: Date, to_date?: Date, sort_by?: string, sort_order?: string, page_no?: number, page_size?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Feedback>>> {
1659-
return OSWApiFp(configuration).oswDatasetViewerFeedbacks(tdei_project_group_id, tdei_dataset_id, from_date, to_date, sort_by, sort_order, page_no, page_size, options).then((request) => request(axios, basePath));
1671+
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>>> {
1672+
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));
16601673
},
16611674
/**
16621675
* Retrieves the feedbacks summary. Response includes a summary of feedbacks such as total count, total overdue, and other relevant statistics.
16631676
* @summary Retrieves the feedbacks summary.
1677+
* @param {string} [tdei_project_group_id] ID of the project group.
16641678
* @param {*} [options] Override http request option.
16651679
* @throws {RequiredError}
16661680
*/
1667-
async oswDatasetViewerFeedbacksMetadata(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<FeedbackMetadata>>> {
1668-
return OSWApiFp(configuration).oswDatasetViewerFeedbacksMetadata(options).then((request) => request(axios, basePath));
1681+
async oswDatasetViewerFeedbacksMetadata(tdei_project_group_id?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FeedbackMetadata>> {
1682+
return OSWApiFp(configuration).oswDatasetViewerFeedbacksMetadata(tdei_project_group_id, options).then((request) => request(axios, basePath));
16691683
},
16701684
/**
16711685
* Retrieves the PM tiles SAS url for a specified dataset identified by the tdei_dataset_id.
@@ -1879,6 +1893,7 @@ export class OSWApi extends BaseAPI {
18791893
* @param {string} [tdei_dataset_id] ID of the dataset.
18801894
* @param {Date} [from_date] &lt;strong&gt;from_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedbacks created after this date.
18811895
* @param {Date} [to_date] &lt;strong&gt;to_date:&lt;/strong&gt; Date in ISO 8601 format, filters feedbacks created before this date.
1896+
* @param {string} [status] &lt;strong&gt;status:&lt;/strong&gt; Filters feedbacks by their status.
18821897
* @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.
18831898
* @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.
18841899
* @param {number} [page_no] &lt;strong&gt;page_no:&lt;/strong&gt; Integer, defaults to 1. Specifies the page number to retrieve.
@@ -1887,18 +1902,19 @@ export class OSWApi extends BaseAPI {
18871902
* @throws {RequiredError}
18881903
* @memberof OSWApi
18891904
*/
1890-
public async oswDatasetViewerFeedbacks(tdei_project_group_id?: string, tdei_dataset_id?: string, from_date?: Date, to_date?: Date, sort_by?: string, sort_order?: string, page_no?: number, page_size?: number, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<Feedback>>> {
1891-
return OSWApiFp(this.configuration).oswDatasetViewerFeedbacks(tdei_project_group_id, tdei_dataset_id, from_date, to_date, sort_by, sort_order, page_no, page_size, options).then((request) => request(this.axios, this.basePath));
1905+
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>>> {
1906+
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));
18921907
}
18931908
/**
18941909
* Retrieves the feedbacks summary. Response includes a summary of feedbacks such as total count, total overdue, and other relevant statistics.
18951910
* @summary Retrieves the feedbacks summary.
1911+
* @param {string} [tdei_project_group_id] ID of the project group.
18961912
* @param {*} [options] Override http request option.
18971913
* @throws {RequiredError}
18981914
* @memberof OSWApi
18991915
*/
1900-
public async oswDatasetViewerFeedbacksMetadata(options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<FeedbackMetadata>>> {
1901-
return OSWApiFp(this.configuration).oswDatasetViewerFeedbacksMetadata(options).then((request) => request(this.axios, this.basePath));
1916+
public async oswDatasetViewerFeedbacksMetadata(tdei_project_group_id?: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<FeedbackMetadata>> {
1917+
return OSWApiFp(this.configuration).oswDatasetViewerFeedbacksMetadata(tdei_project_group_id, options).then((request) => request(this.axios, this.basePath));
19021918
}
19031919
/**
19041920
* Retrieves the PM tiles SAS url for a specified dataset identified by the tdei_dataset_id.

0 commit comments

Comments
 (0)