@teemill/projects 1.42.0 → 1.43.0
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/README.md +4 -2
- package/api.ts +116 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +72 -1
- package/dist/api.js +72 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +72 -1
- package/dist/esm/api.js +72 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/OkrSummary.md +24 -0
- package/docs/ProjectsApi.md +55 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/projects@1.
|
|
1
|
+
## @teemill/projects@1.43.0
|
|
2
2
|
|
|
3
3
|
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:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/projects@1.
|
|
39
|
+
npm install @teemill/projects@1.43.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -69,6 +69,7 @@ Class | Method | HTTP request | Description
|
|
|
69
69
|
*ProjectsApi* | [**getIntegration**](docs/ProjectsApi.md#getintegration) | **GET** /v1/projects/{project}/integrations/{integration} | Get integration
|
|
70
70
|
*ProjectsApi* | [**getIntegrations**](docs/ProjectsApi.md#getintegrations) | **GET** /v1/projects/{project}/integrations | List integrations
|
|
71
71
|
*ProjectsApi* | [**getInvites**](docs/ProjectsApi.md#getinvites) | **GET** /v1/projects/{project}/invites | List Invites
|
|
72
|
+
*ProjectsApi* | [**getOkrSummary**](docs/ProjectsApi.md#getokrsummary) | **GET** /v1/projects/{project}/okrs/summary | Get OKR summary
|
|
72
73
|
*ProjectsApi* | [**getProject**](docs/ProjectsApi.md#getproject) | **GET** /v1/projects/{project} | Get project
|
|
73
74
|
*ProjectsApi* | [**getProjects**](docs/ProjectsApi.md#getprojects) | **GET** /v1/projects | List projects
|
|
74
75
|
*ProjectsApi* | [**getTask**](docs/ProjectsApi.md#gettask) | **GET** /v1/projects/{project}/tasks/{id} | Get Task
|
|
@@ -117,6 +118,7 @@ Class | Method | HTTP request | Description
|
|
|
117
118
|
- [ListTasksResponse](docs/ListTasksResponse.md)
|
|
118
119
|
- [NullableIcon](docs/NullableIcon.md)
|
|
119
120
|
- [OkrLevel](docs/OkrLevel.md)
|
|
121
|
+
- [OkrSummary](docs/OkrSummary.md)
|
|
120
122
|
- [Project](docs/Project.md)
|
|
121
123
|
- [ProjectCurrency](docs/ProjectCurrency.md)
|
|
122
124
|
- [ProjectInvite](docs/ProjectInvite.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Projects API
|
|
5
5
|
* Manage PodOS Projects
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.43.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -566,6 +566,31 @@ export const OkrLevel = {
|
|
|
566
566
|
export type OkrLevel = typeof OkrLevel[keyof typeof OkrLevel];
|
|
567
567
|
|
|
568
568
|
|
|
569
|
+
/**
|
|
570
|
+
*
|
|
571
|
+
* @export
|
|
572
|
+
* @interface OkrSummary
|
|
573
|
+
*/
|
|
574
|
+
export interface OkrSummary {
|
|
575
|
+
/**
|
|
576
|
+
*
|
|
577
|
+
* @type {string}
|
|
578
|
+
* @memberof OkrSummary
|
|
579
|
+
*/
|
|
580
|
+
'id': string;
|
|
581
|
+
/**
|
|
582
|
+
*
|
|
583
|
+
* @type {string}
|
|
584
|
+
* @memberof OkrSummary
|
|
585
|
+
*/
|
|
586
|
+
'content': string;
|
|
587
|
+
/**
|
|
588
|
+
*
|
|
589
|
+
* @type {string}
|
|
590
|
+
* @memberof OkrSummary
|
|
591
|
+
*/
|
|
592
|
+
'createdAt': string;
|
|
593
|
+
}
|
|
569
594
|
/**
|
|
570
595
|
*
|
|
571
596
|
* @export
|
|
@@ -2145,6 +2170,47 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2145
2170
|
|
|
2146
2171
|
|
|
2147
2172
|
|
|
2173
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2174
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2175
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2176
|
+
|
|
2177
|
+
return {
|
|
2178
|
+
url: toPathString(localVarUrlObj),
|
|
2179
|
+
options: localVarRequestOptions,
|
|
2180
|
+
};
|
|
2181
|
+
},
|
|
2182
|
+
/**
|
|
2183
|
+
* Get the AI-generated OKR summary for the project
|
|
2184
|
+
* @summary Get OKR summary
|
|
2185
|
+
* @param {string} project Projects unique identifier
|
|
2186
|
+
* @param {*} [options] Override http request option.
|
|
2187
|
+
* @throws {RequiredError}
|
|
2188
|
+
*/
|
|
2189
|
+
getOkrSummary: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2190
|
+
// verify required parameter 'project' is not null or undefined
|
|
2191
|
+
assertParamExists('getOkrSummary', 'project', project)
|
|
2192
|
+
const localVarPath = `/v1/projects/{project}/okrs/summary`
|
|
2193
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
2194
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2195
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2196
|
+
let baseOptions;
|
|
2197
|
+
if (configuration) {
|
|
2198
|
+
baseOptions = configuration.baseOptions;
|
|
2199
|
+
}
|
|
2200
|
+
|
|
2201
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2202
|
+
const localVarHeaderParameter = {} as any;
|
|
2203
|
+
const localVarQueryParameter = {} as any;
|
|
2204
|
+
|
|
2205
|
+
// authentication session-oauth required
|
|
2206
|
+
// oauth required
|
|
2207
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2208
|
+
|
|
2209
|
+
// authentication api-key required
|
|
2210
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
|
|
2148
2214
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2149
2215
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2150
2216
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -3243,6 +3309,19 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
3243
3309
|
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.getInvites']?.[localVarOperationServerIndex]?.url;
|
|
3244
3310
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3245
3311
|
},
|
|
3312
|
+
/**
|
|
3313
|
+
* Get the AI-generated OKR summary for the project
|
|
3314
|
+
* @summary Get OKR summary
|
|
3315
|
+
* @param {string} project Projects unique identifier
|
|
3316
|
+
* @param {*} [options] Override http request option.
|
|
3317
|
+
* @throws {RequiredError}
|
|
3318
|
+
*/
|
|
3319
|
+
async getOkrSummary(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OkrSummary>> {
|
|
3320
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOkrSummary(project, options);
|
|
3321
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3322
|
+
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.getOkrSummary']?.[localVarOperationServerIndex]?.url;
|
|
3323
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3324
|
+
},
|
|
3246
3325
|
/**
|
|
3247
3326
|
* Get a project
|
|
3248
3327
|
* @summary Get project
|
|
@@ -3686,6 +3765,16 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
3686
3765
|
getInvites(requestParameters: ProjectsApiGetInvitesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectInvites> {
|
|
3687
3766
|
return localVarFp.getInvites(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
3688
3767
|
},
|
|
3768
|
+
/**
|
|
3769
|
+
* Get the AI-generated OKR summary for the project
|
|
3770
|
+
* @summary Get OKR summary
|
|
3771
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
3772
|
+
* @param {*} [options] Override http request option.
|
|
3773
|
+
* @throws {RequiredError}
|
|
3774
|
+
*/
|
|
3775
|
+
getOkrSummary(requestParameters: ProjectsApiGetOkrSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<OkrSummary> {
|
|
3776
|
+
return localVarFp.getOkrSummary(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
3777
|
+
},
|
|
3689
3778
|
/**
|
|
3690
3779
|
* Get a project
|
|
3691
3780
|
* @summary Get project
|
|
@@ -4219,6 +4308,20 @@ export interface ProjectsApiGetInvitesRequest {
|
|
|
4219
4308
|
readonly pageSize?: number
|
|
4220
4309
|
}
|
|
4221
4310
|
|
|
4311
|
+
/**
|
|
4312
|
+
* Request parameters for getOkrSummary operation in ProjectsApi.
|
|
4313
|
+
* @export
|
|
4314
|
+
* @interface ProjectsApiGetOkrSummaryRequest
|
|
4315
|
+
*/
|
|
4316
|
+
export interface ProjectsApiGetOkrSummaryRequest {
|
|
4317
|
+
/**
|
|
4318
|
+
* Projects unique identifier
|
|
4319
|
+
* @type {string}
|
|
4320
|
+
* @memberof ProjectsApiGetOkrSummary
|
|
4321
|
+
*/
|
|
4322
|
+
readonly project: string
|
|
4323
|
+
}
|
|
4324
|
+
|
|
4222
4325
|
/**
|
|
4223
4326
|
* Request parameters for getProject operation in ProjectsApi.
|
|
4224
4327
|
* @export
|
|
@@ -4827,6 +4930,18 @@ export class ProjectsApi extends BaseAPI {
|
|
|
4827
4930
|
return ProjectsApiFp(this.configuration).getInvites(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
4828
4931
|
}
|
|
4829
4932
|
|
|
4933
|
+
/**
|
|
4934
|
+
* Get the AI-generated OKR summary for the project
|
|
4935
|
+
* @summary Get OKR summary
|
|
4936
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
4937
|
+
* @param {*} [options] Override http request option.
|
|
4938
|
+
* @throws {RequiredError}
|
|
4939
|
+
* @memberof ProjectsApi
|
|
4940
|
+
*/
|
|
4941
|
+
public getOkrSummary(requestParameters: ProjectsApiGetOkrSummaryRequest, options?: RawAxiosRequestConfig) {
|
|
4942
|
+
return ProjectsApiFp(this.configuration).getOkrSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
4943
|
+
}
|
|
4944
|
+
|
|
4830
4945
|
/**
|
|
4831
4946
|
* Get a project
|
|
4832
4947
|
* @summary Get project
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Projects API
|
|
3
3
|
* Manage PodOS Projects
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.43.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -549,6 +549,31 @@ export declare const OkrLevel: {
|
|
|
549
549
|
readonly Task: "task";
|
|
550
550
|
};
|
|
551
551
|
export type OkrLevel = typeof OkrLevel[keyof typeof OkrLevel];
|
|
552
|
+
/**
|
|
553
|
+
*
|
|
554
|
+
* @export
|
|
555
|
+
* @interface OkrSummary
|
|
556
|
+
*/
|
|
557
|
+
export interface OkrSummary {
|
|
558
|
+
/**
|
|
559
|
+
*
|
|
560
|
+
* @type {string}
|
|
561
|
+
* @memberof OkrSummary
|
|
562
|
+
*/
|
|
563
|
+
'id': string;
|
|
564
|
+
/**
|
|
565
|
+
*
|
|
566
|
+
* @type {string}
|
|
567
|
+
* @memberof OkrSummary
|
|
568
|
+
*/
|
|
569
|
+
'content': string;
|
|
570
|
+
/**
|
|
571
|
+
*
|
|
572
|
+
* @type {string}
|
|
573
|
+
* @memberof OkrSummary
|
|
574
|
+
*/
|
|
575
|
+
'createdAt': string;
|
|
576
|
+
}
|
|
552
577
|
/**
|
|
553
578
|
*
|
|
554
579
|
* @export
|
|
@@ -1470,6 +1495,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1470
1495
|
* @throws {RequiredError}
|
|
1471
1496
|
*/
|
|
1472
1497
|
getInvites: (project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1498
|
+
/**
|
|
1499
|
+
* Get the AI-generated OKR summary for the project
|
|
1500
|
+
* @summary Get OKR summary
|
|
1501
|
+
* @param {string} project Projects unique identifier
|
|
1502
|
+
* @param {*} [options] Override http request option.
|
|
1503
|
+
* @throws {RequiredError}
|
|
1504
|
+
*/
|
|
1505
|
+
getOkrSummary: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1473
1506
|
/**
|
|
1474
1507
|
* Get a project
|
|
1475
1508
|
* @summary Get project
|
|
@@ -1797,6 +1830,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
1797
1830
|
* @throws {RequiredError}
|
|
1798
1831
|
*/
|
|
1799
1832
|
getInvites(project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectInvites>>;
|
|
1833
|
+
/**
|
|
1834
|
+
* Get the AI-generated OKR summary for the project
|
|
1835
|
+
* @summary Get OKR summary
|
|
1836
|
+
* @param {string} project Projects unique identifier
|
|
1837
|
+
* @param {*} [options] Override http request option.
|
|
1838
|
+
* @throws {RequiredError}
|
|
1839
|
+
*/
|
|
1840
|
+
getOkrSummary(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OkrSummary>>;
|
|
1800
1841
|
/**
|
|
1801
1842
|
* Get a project
|
|
1802
1843
|
* @summary Get project
|
|
@@ -2110,6 +2151,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
2110
2151
|
* @throws {RequiredError}
|
|
2111
2152
|
*/
|
|
2112
2153
|
getInvites(requestParameters: ProjectsApiGetInvitesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectInvites>;
|
|
2154
|
+
/**
|
|
2155
|
+
* Get the AI-generated OKR summary for the project
|
|
2156
|
+
* @summary Get OKR summary
|
|
2157
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
2158
|
+
* @param {*} [options] Override http request option.
|
|
2159
|
+
* @throws {RequiredError}
|
|
2160
|
+
*/
|
|
2161
|
+
getOkrSummary(requestParameters: ProjectsApiGetOkrSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<OkrSummary>;
|
|
2113
2162
|
/**
|
|
2114
2163
|
* Get a project
|
|
2115
2164
|
* @summary Get project
|
|
@@ -2573,6 +2622,19 @@ export interface ProjectsApiGetInvitesRequest {
|
|
|
2573
2622
|
*/
|
|
2574
2623
|
readonly pageSize?: number;
|
|
2575
2624
|
}
|
|
2625
|
+
/**
|
|
2626
|
+
* Request parameters for getOkrSummary operation in ProjectsApi.
|
|
2627
|
+
* @export
|
|
2628
|
+
* @interface ProjectsApiGetOkrSummaryRequest
|
|
2629
|
+
*/
|
|
2630
|
+
export interface ProjectsApiGetOkrSummaryRequest {
|
|
2631
|
+
/**
|
|
2632
|
+
* Projects unique identifier
|
|
2633
|
+
* @type {string}
|
|
2634
|
+
* @memberof ProjectsApiGetOkrSummary
|
|
2635
|
+
*/
|
|
2636
|
+
readonly project: string;
|
|
2637
|
+
}
|
|
2576
2638
|
/**
|
|
2577
2639
|
* Request parameters for getProject operation in ProjectsApi.
|
|
2578
2640
|
* @export
|
|
@@ -3090,6 +3152,15 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
3090
3152
|
* @memberof ProjectsApi
|
|
3091
3153
|
*/
|
|
3092
3154
|
getInvites(requestParameters: ProjectsApiGetInvitesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectInvites, any>>;
|
|
3155
|
+
/**
|
|
3156
|
+
* Get the AI-generated OKR summary for the project
|
|
3157
|
+
* @summary Get OKR summary
|
|
3158
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
3159
|
+
* @param {*} [options] Override http request option.
|
|
3160
|
+
* @throws {RequiredError}
|
|
3161
|
+
* @memberof ProjectsApi
|
|
3162
|
+
*/
|
|
3163
|
+
getOkrSummary(requestParameters: ProjectsApiGetOkrSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OkrSummary, any>>;
|
|
3093
3164
|
/**
|
|
3094
3165
|
* Get a project
|
|
3095
3166
|
* @summary Get project
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Projects API
|
|
6
6
|
* Manage PodOS Projects
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.43.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -745,6 +745,40 @@ const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
745
745
|
options: localVarRequestOptions,
|
|
746
746
|
};
|
|
747
747
|
}),
|
|
748
|
+
/**
|
|
749
|
+
* Get the AI-generated OKR summary for the project
|
|
750
|
+
* @summary Get OKR summary
|
|
751
|
+
* @param {string} project Projects unique identifier
|
|
752
|
+
* @param {*} [options] Override http request option.
|
|
753
|
+
* @throws {RequiredError}
|
|
754
|
+
*/
|
|
755
|
+
getOkrSummary: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
756
|
+
// verify required parameter 'project' is not null or undefined
|
|
757
|
+
(0, common_1.assertParamExists)('getOkrSummary', 'project', project);
|
|
758
|
+
const localVarPath = `/v1/projects/{project}/okrs/summary`
|
|
759
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
760
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
761
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
762
|
+
let baseOptions;
|
|
763
|
+
if (configuration) {
|
|
764
|
+
baseOptions = configuration.baseOptions;
|
|
765
|
+
}
|
|
766
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
767
|
+
const localVarHeaderParameter = {};
|
|
768
|
+
const localVarQueryParameter = {};
|
|
769
|
+
// authentication session-oauth required
|
|
770
|
+
// oauth required
|
|
771
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
772
|
+
// authentication api-key required
|
|
773
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
774
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
775
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
776
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
777
|
+
return {
|
|
778
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
779
|
+
options: localVarRequestOptions,
|
|
780
|
+
};
|
|
781
|
+
}),
|
|
748
782
|
/**
|
|
749
783
|
* Get a project
|
|
750
784
|
* @summary Get project
|
|
@@ -1750,6 +1784,22 @@ const ProjectsApiFp = function (configuration) {
|
|
|
1750
1784
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1751
1785
|
});
|
|
1752
1786
|
},
|
|
1787
|
+
/**
|
|
1788
|
+
* Get the AI-generated OKR summary for the project
|
|
1789
|
+
* @summary Get OKR summary
|
|
1790
|
+
* @param {string} project Projects unique identifier
|
|
1791
|
+
* @param {*} [options] Override http request option.
|
|
1792
|
+
* @throws {RequiredError}
|
|
1793
|
+
*/
|
|
1794
|
+
getOkrSummary(project, options) {
|
|
1795
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1796
|
+
var _a, _b, _c;
|
|
1797
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOkrSummary(project, options);
|
|
1798
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1799
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProjectsApi.getOkrSummary']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1800
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1801
|
+
});
|
|
1802
|
+
},
|
|
1753
1803
|
/**
|
|
1754
1804
|
* Get a project
|
|
1755
1805
|
* @summary Get project
|
|
@@ -2247,6 +2297,16 @@ const ProjectsApiFactory = function (configuration, basePath, axios) {
|
|
|
2247
2297
|
getInvites(requestParameters, options) {
|
|
2248
2298
|
return localVarFp.getInvites(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
2249
2299
|
},
|
|
2300
|
+
/**
|
|
2301
|
+
* Get the AI-generated OKR summary for the project
|
|
2302
|
+
* @summary Get OKR summary
|
|
2303
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
2304
|
+
* @param {*} [options] Override http request option.
|
|
2305
|
+
* @throws {RequiredError}
|
|
2306
|
+
*/
|
|
2307
|
+
getOkrSummary(requestParameters, options) {
|
|
2308
|
+
return localVarFp.getOkrSummary(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
2309
|
+
},
|
|
2250
2310
|
/**
|
|
2251
2311
|
* Get a project
|
|
2252
2312
|
* @summary Get project
|
|
@@ -2635,6 +2695,17 @@ class ProjectsApi extends base_1.BaseAPI {
|
|
|
2635
2695
|
getInvites(requestParameters, options) {
|
|
2636
2696
|
return (0, exports.ProjectsApiFp)(this.configuration).getInvites(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
2637
2697
|
}
|
|
2698
|
+
/**
|
|
2699
|
+
* Get the AI-generated OKR summary for the project
|
|
2700
|
+
* @summary Get OKR summary
|
|
2701
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
2702
|
+
* @param {*} [options] Override http request option.
|
|
2703
|
+
* @throws {RequiredError}
|
|
2704
|
+
* @memberof ProjectsApi
|
|
2705
|
+
*/
|
|
2706
|
+
getOkrSummary(requestParameters, options) {
|
|
2707
|
+
return (0, exports.ProjectsApiFp)(this.configuration).getOkrSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
2708
|
+
}
|
|
2638
2709
|
/**
|
|
2639
2710
|
* Get a project
|
|
2640
2711
|
* @summary Get project
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Projects API
|
|
3
3
|
* Manage PodOS Projects
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.43.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -549,6 +549,31 @@ export declare const OkrLevel: {
|
|
|
549
549
|
readonly Task: "task";
|
|
550
550
|
};
|
|
551
551
|
export type OkrLevel = typeof OkrLevel[keyof typeof OkrLevel];
|
|
552
|
+
/**
|
|
553
|
+
*
|
|
554
|
+
* @export
|
|
555
|
+
* @interface OkrSummary
|
|
556
|
+
*/
|
|
557
|
+
export interface OkrSummary {
|
|
558
|
+
/**
|
|
559
|
+
*
|
|
560
|
+
* @type {string}
|
|
561
|
+
* @memberof OkrSummary
|
|
562
|
+
*/
|
|
563
|
+
'id': string;
|
|
564
|
+
/**
|
|
565
|
+
*
|
|
566
|
+
* @type {string}
|
|
567
|
+
* @memberof OkrSummary
|
|
568
|
+
*/
|
|
569
|
+
'content': string;
|
|
570
|
+
/**
|
|
571
|
+
*
|
|
572
|
+
* @type {string}
|
|
573
|
+
* @memberof OkrSummary
|
|
574
|
+
*/
|
|
575
|
+
'createdAt': string;
|
|
576
|
+
}
|
|
552
577
|
/**
|
|
553
578
|
*
|
|
554
579
|
* @export
|
|
@@ -1470,6 +1495,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1470
1495
|
* @throws {RequiredError}
|
|
1471
1496
|
*/
|
|
1472
1497
|
getInvites: (project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1498
|
+
/**
|
|
1499
|
+
* Get the AI-generated OKR summary for the project
|
|
1500
|
+
* @summary Get OKR summary
|
|
1501
|
+
* @param {string} project Projects unique identifier
|
|
1502
|
+
* @param {*} [options] Override http request option.
|
|
1503
|
+
* @throws {RequiredError}
|
|
1504
|
+
*/
|
|
1505
|
+
getOkrSummary: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1473
1506
|
/**
|
|
1474
1507
|
* Get a project
|
|
1475
1508
|
* @summary Get project
|
|
@@ -1797,6 +1830,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
1797
1830
|
* @throws {RequiredError}
|
|
1798
1831
|
*/
|
|
1799
1832
|
getInvites(project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectInvites>>;
|
|
1833
|
+
/**
|
|
1834
|
+
* Get the AI-generated OKR summary for the project
|
|
1835
|
+
* @summary Get OKR summary
|
|
1836
|
+
* @param {string} project Projects unique identifier
|
|
1837
|
+
* @param {*} [options] Override http request option.
|
|
1838
|
+
* @throws {RequiredError}
|
|
1839
|
+
*/
|
|
1840
|
+
getOkrSummary(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OkrSummary>>;
|
|
1800
1841
|
/**
|
|
1801
1842
|
* Get a project
|
|
1802
1843
|
* @summary Get project
|
|
@@ -2110,6 +2151,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
2110
2151
|
* @throws {RequiredError}
|
|
2111
2152
|
*/
|
|
2112
2153
|
getInvites(requestParameters: ProjectsApiGetInvitesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectInvites>;
|
|
2154
|
+
/**
|
|
2155
|
+
* Get the AI-generated OKR summary for the project
|
|
2156
|
+
* @summary Get OKR summary
|
|
2157
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
2158
|
+
* @param {*} [options] Override http request option.
|
|
2159
|
+
* @throws {RequiredError}
|
|
2160
|
+
*/
|
|
2161
|
+
getOkrSummary(requestParameters: ProjectsApiGetOkrSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<OkrSummary>;
|
|
2113
2162
|
/**
|
|
2114
2163
|
* Get a project
|
|
2115
2164
|
* @summary Get project
|
|
@@ -2573,6 +2622,19 @@ export interface ProjectsApiGetInvitesRequest {
|
|
|
2573
2622
|
*/
|
|
2574
2623
|
readonly pageSize?: number;
|
|
2575
2624
|
}
|
|
2625
|
+
/**
|
|
2626
|
+
* Request parameters for getOkrSummary operation in ProjectsApi.
|
|
2627
|
+
* @export
|
|
2628
|
+
* @interface ProjectsApiGetOkrSummaryRequest
|
|
2629
|
+
*/
|
|
2630
|
+
export interface ProjectsApiGetOkrSummaryRequest {
|
|
2631
|
+
/**
|
|
2632
|
+
* Projects unique identifier
|
|
2633
|
+
* @type {string}
|
|
2634
|
+
* @memberof ProjectsApiGetOkrSummary
|
|
2635
|
+
*/
|
|
2636
|
+
readonly project: string;
|
|
2637
|
+
}
|
|
2576
2638
|
/**
|
|
2577
2639
|
* Request parameters for getProject operation in ProjectsApi.
|
|
2578
2640
|
* @export
|
|
@@ -3090,6 +3152,15 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
3090
3152
|
* @memberof ProjectsApi
|
|
3091
3153
|
*/
|
|
3092
3154
|
getInvites(requestParameters: ProjectsApiGetInvitesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectInvites, any>>;
|
|
3155
|
+
/**
|
|
3156
|
+
* Get the AI-generated OKR summary for the project
|
|
3157
|
+
* @summary Get OKR summary
|
|
3158
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
3159
|
+
* @param {*} [options] Override http request option.
|
|
3160
|
+
* @throws {RequiredError}
|
|
3161
|
+
* @memberof ProjectsApi
|
|
3162
|
+
*/
|
|
3163
|
+
getOkrSummary(requestParameters: ProjectsApiGetOkrSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OkrSummary, any>>;
|
|
3093
3164
|
/**
|
|
3094
3165
|
* Get a project
|
|
3095
3166
|
* @summary Get project
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Projects API
|
|
5
5
|
* Manage PodOS Projects
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.43.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -742,6 +742,40 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
742
742
|
options: localVarRequestOptions,
|
|
743
743
|
};
|
|
744
744
|
}),
|
|
745
|
+
/**
|
|
746
|
+
* Get the AI-generated OKR summary for the project
|
|
747
|
+
* @summary Get OKR summary
|
|
748
|
+
* @param {string} project Projects unique identifier
|
|
749
|
+
* @param {*} [options] Override http request option.
|
|
750
|
+
* @throws {RequiredError}
|
|
751
|
+
*/
|
|
752
|
+
getOkrSummary: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
753
|
+
// verify required parameter 'project' is not null or undefined
|
|
754
|
+
assertParamExists('getOkrSummary', 'project', project);
|
|
755
|
+
const localVarPath = `/v1/projects/{project}/okrs/summary`
|
|
756
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
757
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
758
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
759
|
+
let baseOptions;
|
|
760
|
+
if (configuration) {
|
|
761
|
+
baseOptions = configuration.baseOptions;
|
|
762
|
+
}
|
|
763
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
764
|
+
const localVarHeaderParameter = {};
|
|
765
|
+
const localVarQueryParameter = {};
|
|
766
|
+
// authentication session-oauth required
|
|
767
|
+
// oauth required
|
|
768
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
769
|
+
// authentication api-key required
|
|
770
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
771
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
772
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
773
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
774
|
+
return {
|
|
775
|
+
url: toPathString(localVarUrlObj),
|
|
776
|
+
options: localVarRequestOptions,
|
|
777
|
+
};
|
|
778
|
+
}),
|
|
745
779
|
/**
|
|
746
780
|
* Get a project
|
|
747
781
|
* @summary Get project
|
|
@@ -1746,6 +1780,22 @@ export const ProjectsApiFp = function (configuration) {
|
|
|
1746
1780
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1747
1781
|
});
|
|
1748
1782
|
},
|
|
1783
|
+
/**
|
|
1784
|
+
* Get the AI-generated OKR summary for the project
|
|
1785
|
+
* @summary Get OKR summary
|
|
1786
|
+
* @param {string} project Projects unique identifier
|
|
1787
|
+
* @param {*} [options] Override http request option.
|
|
1788
|
+
* @throws {RequiredError}
|
|
1789
|
+
*/
|
|
1790
|
+
getOkrSummary(project, options) {
|
|
1791
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1792
|
+
var _a, _b, _c;
|
|
1793
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOkrSummary(project, options);
|
|
1794
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1795
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProjectsApi.getOkrSummary']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1796
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1797
|
+
});
|
|
1798
|
+
},
|
|
1749
1799
|
/**
|
|
1750
1800
|
* Get a project
|
|
1751
1801
|
* @summary Get project
|
|
@@ -2242,6 +2292,16 @@ export const ProjectsApiFactory = function (configuration, basePath, axios) {
|
|
|
2242
2292
|
getInvites(requestParameters, options) {
|
|
2243
2293
|
return localVarFp.getInvites(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
2244
2294
|
},
|
|
2295
|
+
/**
|
|
2296
|
+
* Get the AI-generated OKR summary for the project
|
|
2297
|
+
* @summary Get OKR summary
|
|
2298
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
2299
|
+
* @param {*} [options] Override http request option.
|
|
2300
|
+
* @throws {RequiredError}
|
|
2301
|
+
*/
|
|
2302
|
+
getOkrSummary(requestParameters, options) {
|
|
2303
|
+
return localVarFp.getOkrSummary(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
2304
|
+
},
|
|
2245
2305
|
/**
|
|
2246
2306
|
* Get a project
|
|
2247
2307
|
* @summary Get project
|
|
@@ -2629,6 +2689,17 @@ export class ProjectsApi extends BaseAPI {
|
|
|
2629
2689
|
getInvites(requestParameters, options) {
|
|
2630
2690
|
return ProjectsApiFp(this.configuration).getInvites(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
2631
2691
|
}
|
|
2692
|
+
/**
|
|
2693
|
+
* Get the AI-generated OKR summary for the project
|
|
2694
|
+
* @summary Get OKR summary
|
|
2695
|
+
* @param {ProjectsApiGetOkrSummaryRequest} requestParameters Request parameters.
|
|
2696
|
+
* @param {*} [options] Override http request option.
|
|
2697
|
+
* @throws {RequiredError}
|
|
2698
|
+
* @memberof ProjectsApi
|
|
2699
|
+
*/
|
|
2700
|
+
getOkrSummary(requestParameters, options) {
|
|
2701
|
+
return ProjectsApiFp(this.configuration).getOkrSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
2702
|
+
}
|
|
2632
2703
|
/**
|
|
2633
2704
|
* Get a project
|
|
2634
2705
|
* @summary Get project
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# OkrSummary
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**content** | **string** | | [default to undefined]
|
|
10
|
+
**createdAt** | **string** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { OkrSummary } from '@teemill/projects';
|
|
16
|
+
|
|
17
|
+
const instance: OkrSummary = {
|
|
18
|
+
id,
|
|
19
|
+
content,
|
|
20
|
+
createdAt,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/ProjectsApi.md
CHANGED
|
@@ -22,6 +22,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
22
22
|
|[**getIntegration**](#getintegration) | **GET** /v1/projects/{project}/integrations/{integration} | Get integration|
|
|
23
23
|
|[**getIntegrations**](#getintegrations) | **GET** /v1/projects/{project}/integrations | List integrations|
|
|
24
24
|
|[**getInvites**](#getinvites) | **GET** /v1/projects/{project}/invites | List Invites|
|
|
25
|
+
|[**getOkrSummary**](#getokrsummary) | **GET** /v1/projects/{project}/okrs/summary | Get OKR summary|
|
|
25
26
|
|[**getProject**](#getproject) | **GET** /v1/projects/{project} | Get project|
|
|
26
27
|
|[**getProjects**](#getprojects) | **GET** /v1/projects | List projects|
|
|
27
28
|
|[**getTask**](#gettask) | **GET** /v1/projects/{project}/tasks/{id} | Get Task|
|
|
@@ -1081,6 +1082,60 @@ const { status, data } = await apiInstance.getInvites(
|
|
|
1081
1082
|
|
|
1082
1083
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1083
1084
|
|
|
1085
|
+
# **getOkrSummary**
|
|
1086
|
+
> OkrSummary getOkrSummary()
|
|
1087
|
+
|
|
1088
|
+
Get the AI-generated OKR summary for the project
|
|
1089
|
+
|
|
1090
|
+
### Example
|
|
1091
|
+
|
|
1092
|
+
```typescript
|
|
1093
|
+
import {
|
|
1094
|
+
ProjectsApi,
|
|
1095
|
+
Configuration
|
|
1096
|
+
} from '@teemill/projects';
|
|
1097
|
+
|
|
1098
|
+
const configuration = new Configuration();
|
|
1099
|
+
const apiInstance = new ProjectsApi(configuration);
|
|
1100
|
+
|
|
1101
|
+
let project: string; //Projects unique identifier (default to undefined)
|
|
1102
|
+
|
|
1103
|
+
const { status, data } = await apiInstance.getOkrSummary(
|
|
1104
|
+
project
|
|
1105
|
+
);
|
|
1106
|
+
```
|
|
1107
|
+
|
|
1108
|
+
### Parameters
|
|
1109
|
+
|
|
1110
|
+
|Name | Type | Description | Notes|
|
|
1111
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1112
|
+
| **project** | [**string**] | Projects unique identifier | defaults to undefined|
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
### Return type
|
|
1116
|
+
|
|
1117
|
+
**OkrSummary**
|
|
1118
|
+
|
|
1119
|
+
### Authorization
|
|
1120
|
+
|
|
1121
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
1122
|
+
|
|
1123
|
+
### HTTP request headers
|
|
1124
|
+
|
|
1125
|
+
- **Content-Type**: Not defined
|
|
1126
|
+
- **Accept**: application/json
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
### HTTP response details
|
|
1130
|
+
| Status code | Description | Response headers |
|
|
1131
|
+
|-------------|-------------|------------------|
|
|
1132
|
+
|**200** | A summary of the project\'s OKR progress. | - |
|
|
1133
|
+
|**401** | Not authorised to access this resource | - |
|
|
1134
|
+
|**403** | Refuse to authorize | - |
|
|
1135
|
+
|**500** | Unknown server error | - |
|
|
1136
|
+
|
|
1137
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1138
|
+
|
|
1084
1139
|
# **getProject**
|
|
1085
1140
|
> Project getProject()
|
|
1086
1141
|
|
package/index.ts
CHANGED