@teemill/projects 1.38.0 → 1.39.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 +154 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +106 -1
- package/dist/api.js +83 -2
- 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 +106 -1
- package/dist/esm/api.js +82 -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/OkrLevel.md +13 -0
- package/docs/ProjectsApi.md +56 -0
- package/docs/Task.md +6 -0
- package/docs/TaskSummary.md +6 -0
- package/docs/UpdateTaskRequest.md +4 -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.39.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.39.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -62,6 +62,7 @@ Class | Method | HTTP request | Description
|
|
|
62
62
|
*ProjectsApi* | [**deleteProject**](docs/ProjectsApi.md#deleteproject) | **DELETE** /v1/projects/{project} | Delete project
|
|
63
63
|
*ProjectsApi* | [**deleteTask**](docs/ProjectsApi.md#deletetask) | **DELETE** /v1/projects/{project}/tasks/{id} | Delete Task
|
|
64
64
|
*ProjectsApi* | [**deleteUser**](docs/ProjectsApi.md#deleteuser) | **DELETE** /v1/projects/{project}/users/{user} | Delete a user by ID
|
|
65
|
+
*ProjectsApi* | [**exportOkrs**](docs/ProjectsApi.md#exportokrs) | **GET** /v1/projects/{project}/okrs/export | Export all OKRs
|
|
65
66
|
*ProjectsApi* | [**exportTasks**](docs/ProjectsApi.md#exporttasks) | **GET** /v1/projects/{project}/tasks/export | Export all tasks
|
|
66
67
|
*ProjectsApi* | [**getAuth**](docs/ProjectsApi.md#getauth) | **GET** /v1/projects/{project}/auth | List auth tokens
|
|
67
68
|
*ProjectsApi* | [**getIntegration**](docs/ProjectsApi.md#getintegration) | **GET** /v1/projects/{project}/integrations/{integration} | Get integration
|
|
@@ -112,6 +113,7 @@ Class | Method | HTTP request | Description
|
|
|
112
113
|
- [LegacyProjectLogo](docs/LegacyProjectLogo.md)
|
|
113
114
|
- [ListTasksResponse](docs/ListTasksResponse.md)
|
|
114
115
|
- [NullableIcon](docs/NullableIcon.md)
|
|
116
|
+
- [OkrLevel](docs/OkrLevel.md)
|
|
115
117
|
- [Project](docs/Project.md)
|
|
116
118
|
- [ProjectCurrency](docs/ProjectCurrency.md)
|
|
117
119
|
- [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.39.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -517,6 +517,21 @@ export interface NullableIcon {
|
|
|
517
517
|
*/
|
|
518
518
|
'icon': Array<any>;
|
|
519
519
|
}
|
|
520
|
+
/**
|
|
521
|
+
* Indicates whether the task is an OKR associated with the user
|
|
522
|
+
* @export
|
|
523
|
+
* @enum {string}
|
|
524
|
+
*/
|
|
525
|
+
|
|
526
|
+
export const OkrLevel = {
|
|
527
|
+
Objective: 'objective',
|
|
528
|
+
KeyResult: 'key_result',
|
|
529
|
+
Task: 'task'
|
|
530
|
+
} as const;
|
|
531
|
+
|
|
532
|
+
export type OkrLevel = typeof OkrLevel[keyof typeof OkrLevel];
|
|
533
|
+
|
|
534
|
+
|
|
520
535
|
/**
|
|
521
536
|
*
|
|
522
537
|
* @export
|
|
@@ -892,6 +907,18 @@ export interface Task {
|
|
|
892
907
|
* @memberof Task
|
|
893
908
|
*/
|
|
894
909
|
'workProgress': number;
|
|
910
|
+
/**
|
|
911
|
+
*
|
|
912
|
+
* @type {OkrLevel}
|
|
913
|
+
* @memberof Task
|
|
914
|
+
*/
|
|
915
|
+
'okrLevel': OkrLevel | null;
|
|
916
|
+
/**
|
|
917
|
+
*
|
|
918
|
+
* @type {string}
|
|
919
|
+
* @memberof Task
|
|
920
|
+
*/
|
|
921
|
+
'parentTask': string | null;
|
|
895
922
|
/**
|
|
896
923
|
* The unique id of the user who created the task
|
|
897
924
|
* @type {string}
|
|
@@ -904,6 +931,12 @@ export interface Task {
|
|
|
904
931
|
* @memberof Task
|
|
905
932
|
*/
|
|
906
933
|
'createdAt': string;
|
|
934
|
+
/**
|
|
935
|
+
*
|
|
936
|
+
* @type {string}
|
|
937
|
+
* @memberof Task
|
|
938
|
+
*/
|
|
939
|
+
'updatedAt': string;
|
|
907
940
|
}
|
|
908
941
|
|
|
909
942
|
|
|
@@ -971,12 +1004,30 @@ export interface TaskSummary {
|
|
|
971
1004
|
* @memberof TaskSummary
|
|
972
1005
|
*/
|
|
973
1006
|
'workProgress': number;
|
|
1007
|
+
/**
|
|
1008
|
+
*
|
|
1009
|
+
* @type {OkrLevel}
|
|
1010
|
+
* @memberof TaskSummary
|
|
1011
|
+
*/
|
|
1012
|
+
'okrLevel': OkrLevel | null;
|
|
1013
|
+
/**
|
|
1014
|
+
*
|
|
1015
|
+
* @type {string}
|
|
1016
|
+
* @memberof TaskSummary
|
|
1017
|
+
*/
|
|
1018
|
+
'parentTask': string | null;
|
|
974
1019
|
/**
|
|
975
1020
|
*
|
|
976
1021
|
* @type {string}
|
|
977
1022
|
* @memberof TaskSummary
|
|
978
1023
|
*/
|
|
979
1024
|
'createdAt': string;
|
|
1025
|
+
/**
|
|
1026
|
+
*
|
|
1027
|
+
* @type {string}
|
|
1028
|
+
* @memberof TaskSummary
|
|
1029
|
+
*/
|
|
1030
|
+
'updatedAt': string;
|
|
980
1031
|
}
|
|
981
1032
|
|
|
982
1033
|
|
|
@@ -1222,6 +1273,18 @@ export interface UpdateTaskRequest {
|
|
|
1222
1273
|
* @memberof UpdateTaskRequest
|
|
1223
1274
|
*/
|
|
1224
1275
|
'workProgress'?: number;
|
|
1276
|
+
/**
|
|
1277
|
+
*
|
|
1278
|
+
* @type {OkrLevel}
|
|
1279
|
+
* @memberof UpdateTaskRequest
|
|
1280
|
+
*/
|
|
1281
|
+
'okrLevel'?: OkrLevel | null;
|
|
1282
|
+
/**
|
|
1283
|
+
*
|
|
1284
|
+
* @type {string}
|
|
1285
|
+
* @memberof UpdateTaskRequest
|
|
1286
|
+
*/
|
|
1287
|
+
'parentTask'?: string | null;
|
|
1225
1288
|
}
|
|
1226
1289
|
|
|
1227
1290
|
|
|
@@ -1712,6 +1775,47 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1712
1775
|
|
|
1713
1776
|
|
|
1714
1777
|
|
|
1778
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1779
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1780
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1781
|
+
|
|
1782
|
+
return {
|
|
1783
|
+
url: toPathString(localVarUrlObj),
|
|
1784
|
+
options: localVarRequestOptions,
|
|
1785
|
+
};
|
|
1786
|
+
},
|
|
1787
|
+
/**
|
|
1788
|
+
* Export all the OKRs in the planner
|
|
1789
|
+
* @summary Export all OKRs
|
|
1790
|
+
* @param {string} project Projects unique identifier
|
|
1791
|
+
* @param {*} [options] Override http request option.
|
|
1792
|
+
* @throws {RequiredError}
|
|
1793
|
+
*/
|
|
1794
|
+
exportOkrs: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1795
|
+
// verify required parameter 'project' is not null or undefined
|
|
1796
|
+
assertParamExists('exportOkrs', 'project', project)
|
|
1797
|
+
const localVarPath = `/v1/projects/{project}/okrs/export`
|
|
1798
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
1799
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1800
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1801
|
+
let baseOptions;
|
|
1802
|
+
if (configuration) {
|
|
1803
|
+
baseOptions = configuration.baseOptions;
|
|
1804
|
+
}
|
|
1805
|
+
|
|
1806
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1807
|
+
const localVarHeaderParameter = {} as any;
|
|
1808
|
+
const localVarQueryParameter = {} as any;
|
|
1809
|
+
|
|
1810
|
+
// authentication session-oauth required
|
|
1811
|
+
// oauth required
|
|
1812
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1813
|
+
|
|
1814
|
+
// authentication api-key required
|
|
1815
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
|
|
1715
1819
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1716
1820
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1717
1821
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2942,6 +3046,19 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
2942
3046
|
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.deleteUser']?.[localVarOperationServerIndex]?.url;
|
|
2943
3047
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2944
3048
|
},
|
|
3049
|
+
/**
|
|
3050
|
+
* Export all the OKRs in the planner
|
|
3051
|
+
* @summary Export all OKRs
|
|
3052
|
+
* @param {string} project Projects unique identifier
|
|
3053
|
+
* @param {*} [options] Override http request option.
|
|
3054
|
+
* @throws {RequiredError}
|
|
3055
|
+
*/
|
|
3056
|
+
async exportOkrs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3057
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportOkrs(project, options);
|
|
3058
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3059
|
+
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.exportOkrs']?.[localVarOperationServerIndex]?.url;
|
|
3060
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3061
|
+
},
|
|
2945
3062
|
/**
|
|
2946
3063
|
* Export all the tasks in the workflow
|
|
2947
3064
|
* @summary Export all tasks
|
|
@@ -3385,6 +3502,16 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
3385
3502
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
3386
3503
|
return localVarFp.deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(axios, basePath));
|
|
3387
3504
|
},
|
|
3505
|
+
/**
|
|
3506
|
+
* Export all the OKRs in the planner
|
|
3507
|
+
* @summary Export all OKRs
|
|
3508
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
3509
|
+
* @param {*} [options] Override http request option.
|
|
3510
|
+
* @throws {RequiredError}
|
|
3511
|
+
*/
|
|
3512
|
+
exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3513
|
+
return localVarFp.exportOkrs(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
3514
|
+
},
|
|
3388
3515
|
/**
|
|
3389
3516
|
* Export all the tasks in the workflow
|
|
3390
3517
|
* @summary Export all tasks
|
|
@@ -3828,6 +3955,20 @@ export interface ProjectsApiDeleteUserRequest {
|
|
|
3828
3955
|
readonly user: string
|
|
3829
3956
|
}
|
|
3830
3957
|
|
|
3958
|
+
/**
|
|
3959
|
+
* Request parameters for exportOkrs operation in ProjectsApi.
|
|
3960
|
+
* @export
|
|
3961
|
+
* @interface ProjectsApiExportOkrsRequest
|
|
3962
|
+
*/
|
|
3963
|
+
export interface ProjectsApiExportOkrsRequest {
|
|
3964
|
+
/**
|
|
3965
|
+
* Projects unique identifier
|
|
3966
|
+
* @type {string}
|
|
3967
|
+
* @memberof ProjectsApiExportOkrs
|
|
3968
|
+
*/
|
|
3969
|
+
readonly project: string
|
|
3970
|
+
}
|
|
3971
|
+
|
|
3831
3972
|
/**
|
|
3832
3973
|
* Request parameters for exportTasks operation in ProjectsApi.
|
|
3833
3974
|
* @export
|
|
@@ -4457,6 +4598,18 @@ export class ProjectsApi extends BaseAPI {
|
|
|
4457
4598
|
return ProjectsApiFp(this.configuration).deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(this.axios, this.basePath));
|
|
4458
4599
|
}
|
|
4459
4600
|
|
|
4601
|
+
/**
|
|
4602
|
+
* Export all the OKRs in the planner
|
|
4603
|
+
* @summary Export all OKRs
|
|
4604
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
4605
|
+
* @param {*} [options] Override http request option.
|
|
4606
|
+
* @throws {RequiredError}
|
|
4607
|
+
* @memberof ProjectsApi
|
|
4608
|
+
*/
|
|
4609
|
+
public exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig) {
|
|
4610
|
+
return ProjectsApiFp(this.configuration).exportOkrs(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
4611
|
+
}
|
|
4612
|
+
|
|
4460
4613
|
/**
|
|
4461
4614
|
* Export all the tasks in the workflow
|
|
4462
4615
|
* @summary Export all tasks
|
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.39.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -506,6 +506,17 @@ export interface NullableIcon {
|
|
|
506
506
|
*/
|
|
507
507
|
'icon': Array<any>;
|
|
508
508
|
}
|
|
509
|
+
/**
|
|
510
|
+
* Indicates whether the task is an OKR associated with the user
|
|
511
|
+
* @export
|
|
512
|
+
* @enum {string}
|
|
513
|
+
*/
|
|
514
|
+
export declare const OkrLevel: {
|
|
515
|
+
readonly Objective: "objective";
|
|
516
|
+
readonly KeyResult: "key_result";
|
|
517
|
+
readonly Task: "task";
|
|
518
|
+
};
|
|
519
|
+
export type OkrLevel = typeof OkrLevel[keyof typeof OkrLevel];
|
|
509
520
|
/**
|
|
510
521
|
*
|
|
511
522
|
* @export
|
|
@@ -880,6 +891,18 @@ export interface Task {
|
|
|
880
891
|
* @memberof Task
|
|
881
892
|
*/
|
|
882
893
|
'workProgress': number;
|
|
894
|
+
/**
|
|
895
|
+
*
|
|
896
|
+
* @type {OkrLevel}
|
|
897
|
+
* @memberof Task
|
|
898
|
+
*/
|
|
899
|
+
'okrLevel': OkrLevel | null;
|
|
900
|
+
/**
|
|
901
|
+
*
|
|
902
|
+
* @type {string}
|
|
903
|
+
* @memberof Task
|
|
904
|
+
*/
|
|
905
|
+
'parentTask': string | null;
|
|
883
906
|
/**
|
|
884
907
|
* The unique id of the user who created the task
|
|
885
908
|
* @type {string}
|
|
@@ -892,6 +915,12 @@ export interface Task {
|
|
|
892
915
|
* @memberof Task
|
|
893
916
|
*/
|
|
894
917
|
'createdAt': string;
|
|
918
|
+
/**
|
|
919
|
+
*
|
|
920
|
+
* @type {string}
|
|
921
|
+
* @memberof Task
|
|
922
|
+
*/
|
|
923
|
+
'updatedAt': string;
|
|
895
924
|
}
|
|
896
925
|
/**
|
|
897
926
|
*
|
|
@@ -953,12 +982,30 @@ export interface TaskSummary {
|
|
|
953
982
|
* @memberof TaskSummary
|
|
954
983
|
*/
|
|
955
984
|
'workProgress': number;
|
|
985
|
+
/**
|
|
986
|
+
*
|
|
987
|
+
* @type {OkrLevel}
|
|
988
|
+
* @memberof TaskSummary
|
|
989
|
+
*/
|
|
990
|
+
'okrLevel': OkrLevel | null;
|
|
991
|
+
/**
|
|
992
|
+
*
|
|
993
|
+
* @type {string}
|
|
994
|
+
* @memberof TaskSummary
|
|
995
|
+
*/
|
|
996
|
+
'parentTask': string | null;
|
|
956
997
|
/**
|
|
957
998
|
*
|
|
958
999
|
* @type {string}
|
|
959
1000
|
* @memberof TaskSummary
|
|
960
1001
|
*/
|
|
961
1002
|
'createdAt': string;
|
|
1003
|
+
/**
|
|
1004
|
+
*
|
|
1005
|
+
* @type {string}
|
|
1006
|
+
* @memberof TaskSummary
|
|
1007
|
+
*/
|
|
1008
|
+
'updatedAt': string;
|
|
962
1009
|
}
|
|
963
1010
|
/**
|
|
964
1011
|
*
|
|
@@ -1196,6 +1243,18 @@ export interface UpdateTaskRequest {
|
|
|
1196
1243
|
* @memberof UpdateTaskRequest
|
|
1197
1244
|
*/
|
|
1198
1245
|
'workProgress'?: number;
|
|
1246
|
+
/**
|
|
1247
|
+
*
|
|
1248
|
+
* @type {OkrLevel}
|
|
1249
|
+
* @memberof UpdateTaskRequest
|
|
1250
|
+
*/
|
|
1251
|
+
'okrLevel'?: OkrLevel | null;
|
|
1252
|
+
/**
|
|
1253
|
+
*
|
|
1254
|
+
* @type {string}
|
|
1255
|
+
* @memberof UpdateTaskRequest
|
|
1256
|
+
*/
|
|
1257
|
+
'parentTask'?: string | null;
|
|
1199
1258
|
}
|
|
1200
1259
|
/**
|
|
1201
1260
|
* ProjectsApi - axios parameter creator
|
|
@@ -1298,6 +1357,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1298
1357
|
* @throws {RequiredError}
|
|
1299
1358
|
*/
|
|
1300
1359
|
deleteUser: (project: string, user: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1360
|
+
/**
|
|
1361
|
+
* Export all the OKRs in the planner
|
|
1362
|
+
* @summary Export all OKRs
|
|
1363
|
+
* @param {string} project Projects unique identifier
|
|
1364
|
+
* @param {*} [options] Override http request option.
|
|
1365
|
+
* @throws {RequiredError}
|
|
1366
|
+
*/
|
|
1367
|
+
exportOkrs: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1301
1368
|
/**
|
|
1302
1369
|
* Export all the tasks in the workflow
|
|
1303
1370
|
* @summary Export all tasks
|
|
@@ -1608,6 +1675,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
1608
1675
|
* @throws {RequiredError}
|
|
1609
1676
|
*/
|
|
1610
1677
|
deleteUser(project: string, user: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1678
|
+
/**
|
|
1679
|
+
* Export all the OKRs in the planner
|
|
1680
|
+
* @summary Export all OKRs
|
|
1681
|
+
* @param {string} project Projects unique identifier
|
|
1682
|
+
* @param {*} [options] Override http request option.
|
|
1683
|
+
* @throws {RequiredError}
|
|
1684
|
+
*/
|
|
1685
|
+
exportOkrs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1611
1686
|
/**
|
|
1612
1687
|
* Export all the tasks in the workflow
|
|
1613
1688
|
* @summary Export all tasks
|
|
@@ -1910,6 +1985,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
1910
1985
|
* @throws {RequiredError}
|
|
1911
1986
|
*/
|
|
1912
1987
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1988
|
+
/**
|
|
1989
|
+
* Export all the OKRs in the planner
|
|
1990
|
+
* @summary Export all OKRs
|
|
1991
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
1992
|
+
* @param {*} [options] Override http request option.
|
|
1993
|
+
* @throws {RequiredError}
|
|
1994
|
+
*/
|
|
1995
|
+
exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1913
1996
|
/**
|
|
1914
1997
|
* Export all the tasks in the workflow
|
|
1915
1998
|
* @summary Export all tasks
|
|
@@ -2286,6 +2369,19 @@ export interface ProjectsApiDeleteUserRequest {
|
|
|
2286
2369
|
*/
|
|
2287
2370
|
readonly user: string;
|
|
2288
2371
|
}
|
|
2372
|
+
/**
|
|
2373
|
+
* Request parameters for exportOkrs operation in ProjectsApi.
|
|
2374
|
+
* @export
|
|
2375
|
+
* @interface ProjectsApiExportOkrsRequest
|
|
2376
|
+
*/
|
|
2377
|
+
export interface ProjectsApiExportOkrsRequest {
|
|
2378
|
+
/**
|
|
2379
|
+
* Projects unique identifier
|
|
2380
|
+
* @type {string}
|
|
2381
|
+
* @memberof ProjectsApiExportOkrs
|
|
2382
|
+
*/
|
|
2383
|
+
readonly project: string;
|
|
2384
|
+
}
|
|
2289
2385
|
/**
|
|
2290
2386
|
* Request parameters for exportTasks operation in ProjectsApi.
|
|
2291
2387
|
* @export
|
|
@@ -2835,6 +2931,15 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
2835
2931
|
* @memberof ProjectsApi
|
|
2836
2932
|
*/
|
|
2837
2933
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2934
|
+
/**
|
|
2935
|
+
* Export all the OKRs in the planner
|
|
2936
|
+
* @summary Export all OKRs
|
|
2937
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
2938
|
+
* @param {*} [options] Override http request option.
|
|
2939
|
+
* @throws {RequiredError}
|
|
2940
|
+
* @memberof ProjectsApi
|
|
2941
|
+
*/
|
|
2942
|
+
exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
2838
2943
|
/**
|
|
2839
2944
|
* Export all the tasks in the workflow
|
|
2840
2945
|
* @summary Export all tasks
|
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.39.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,13 +22,23 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.ProjectsApi = exports.ProjectsApiFactory = exports.ProjectsApiFp = exports.ProjectsApiAxiosParamCreator = exports.TemplateCode = exports.TaskStatus = exports.ProjectUserTypeEnum = void 0;
|
|
25
|
+
exports.ProjectsApi = exports.ProjectsApiFactory = exports.ProjectsApiFp = exports.ProjectsApiAxiosParamCreator = exports.TemplateCode = exports.TaskStatus = exports.ProjectUserTypeEnum = exports.OkrLevel = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
29
29
|
const common_1 = require("./common");
|
|
30
30
|
// @ts-ignore
|
|
31
31
|
const base_1 = require("./base");
|
|
32
|
+
/**
|
|
33
|
+
* Indicates whether the task is an OKR associated with the user
|
|
34
|
+
* @export
|
|
35
|
+
* @enum {string}
|
|
36
|
+
*/
|
|
37
|
+
exports.OkrLevel = {
|
|
38
|
+
Objective: 'objective',
|
|
39
|
+
KeyResult: 'key_result',
|
|
40
|
+
Task: 'task'
|
|
41
|
+
};
|
|
32
42
|
exports.ProjectUserTypeEnum = {
|
|
33
43
|
User: 'user',
|
|
34
44
|
Service: 'service',
|
|
@@ -471,6 +481,40 @@ const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
471
481
|
options: localVarRequestOptions,
|
|
472
482
|
};
|
|
473
483
|
}),
|
|
484
|
+
/**
|
|
485
|
+
* Export all the OKRs in the planner
|
|
486
|
+
* @summary Export all OKRs
|
|
487
|
+
* @param {string} project Projects unique identifier
|
|
488
|
+
* @param {*} [options] Override http request option.
|
|
489
|
+
* @throws {RequiredError}
|
|
490
|
+
*/
|
|
491
|
+
exportOkrs: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
492
|
+
// verify required parameter 'project' is not null or undefined
|
|
493
|
+
(0, common_1.assertParamExists)('exportOkrs', 'project', project);
|
|
494
|
+
const localVarPath = `/v1/projects/{project}/okrs/export`
|
|
495
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
496
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
497
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
498
|
+
let baseOptions;
|
|
499
|
+
if (configuration) {
|
|
500
|
+
baseOptions = configuration.baseOptions;
|
|
501
|
+
}
|
|
502
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
503
|
+
const localVarHeaderParameter = {};
|
|
504
|
+
const localVarQueryParameter = {};
|
|
505
|
+
// authentication session-oauth required
|
|
506
|
+
// oauth required
|
|
507
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
508
|
+
// authentication api-key required
|
|
509
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
510
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
511
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
512
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
513
|
+
return {
|
|
514
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
515
|
+
options: localVarRequestOptions,
|
|
516
|
+
};
|
|
517
|
+
}),
|
|
474
518
|
/**
|
|
475
519
|
* Export all the tasks in the workflow
|
|
476
520
|
* @summary Export all tasks
|
|
@@ -1548,6 +1592,22 @@ const ProjectsApiFp = function (configuration) {
|
|
|
1548
1592
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1549
1593
|
});
|
|
1550
1594
|
},
|
|
1595
|
+
/**
|
|
1596
|
+
* Export all the OKRs in the planner
|
|
1597
|
+
* @summary Export all OKRs
|
|
1598
|
+
* @param {string} project Projects unique identifier
|
|
1599
|
+
* @param {*} [options] Override http request option.
|
|
1600
|
+
* @throws {RequiredError}
|
|
1601
|
+
*/
|
|
1602
|
+
exportOkrs(project, options) {
|
|
1603
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1604
|
+
var _a, _b, _c;
|
|
1605
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOkrs(project, options);
|
|
1606
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1607
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProjectsApi.exportOkrs']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1608
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1609
|
+
});
|
|
1610
|
+
},
|
|
1551
1611
|
/**
|
|
1552
1612
|
* Export all the tasks in the workflow
|
|
1553
1613
|
* @summary Export all tasks
|
|
@@ -2060,6 +2120,16 @@ const ProjectsApiFactory = function (configuration, basePath, axios) {
|
|
|
2060
2120
|
deleteUser(requestParameters, options) {
|
|
2061
2121
|
return localVarFp.deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(axios, basePath));
|
|
2062
2122
|
},
|
|
2123
|
+
/**
|
|
2124
|
+
* Export all the OKRs in the planner
|
|
2125
|
+
* @summary Export all OKRs
|
|
2126
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
2127
|
+
* @param {*} [options] Override http request option.
|
|
2128
|
+
* @throws {RequiredError}
|
|
2129
|
+
*/
|
|
2130
|
+
exportOkrs(requestParameters, options) {
|
|
2131
|
+
return localVarFp.exportOkrs(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
2132
|
+
},
|
|
2063
2133
|
/**
|
|
2064
2134
|
* Export all the tasks in the workflow
|
|
2065
2135
|
* @summary Export all tasks
|
|
@@ -2421,6 +2491,17 @@ class ProjectsApi extends base_1.BaseAPI {
|
|
|
2421
2491
|
deleteUser(requestParameters, options) {
|
|
2422
2492
|
return (0, exports.ProjectsApiFp)(this.configuration).deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(this.axios, this.basePath));
|
|
2423
2493
|
}
|
|
2494
|
+
/**
|
|
2495
|
+
* Export all the OKRs in the planner
|
|
2496
|
+
* @summary Export all OKRs
|
|
2497
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
2498
|
+
* @param {*} [options] Override http request option.
|
|
2499
|
+
* @throws {RequiredError}
|
|
2500
|
+
* @memberof ProjectsApi
|
|
2501
|
+
*/
|
|
2502
|
+
exportOkrs(requestParameters, options) {
|
|
2503
|
+
return (0, exports.ProjectsApiFp)(this.configuration).exportOkrs(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
2504
|
+
}
|
|
2424
2505
|
/**
|
|
2425
2506
|
* Export all the tasks in the workflow
|
|
2426
2507
|
* @summary Export all tasks
|
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.39.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -506,6 +506,17 @@ export interface NullableIcon {
|
|
|
506
506
|
*/
|
|
507
507
|
'icon': Array<any>;
|
|
508
508
|
}
|
|
509
|
+
/**
|
|
510
|
+
* Indicates whether the task is an OKR associated with the user
|
|
511
|
+
* @export
|
|
512
|
+
* @enum {string}
|
|
513
|
+
*/
|
|
514
|
+
export declare const OkrLevel: {
|
|
515
|
+
readonly Objective: "objective";
|
|
516
|
+
readonly KeyResult: "key_result";
|
|
517
|
+
readonly Task: "task";
|
|
518
|
+
};
|
|
519
|
+
export type OkrLevel = typeof OkrLevel[keyof typeof OkrLevel];
|
|
509
520
|
/**
|
|
510
521
|
*
|
|
511
522
|
* @export
|
|
@@ -880,6 +891,18 @@ export interface Task {
|
|
|
880
891
|
* @memberof Task
|
|
881
892
|
*/
|
|
882
893
|
'workProgress': number;
|
|
894
|
+
/**
|
|
895
|
+
*
|
|
896
|
+
* @type {OkrLevel}
|
|
897
|
+
* @memberof Task
|
|
898
|
+
*/
|
|
899
|
+
'okrLevel': OkrLevel | null;
|
|
900
|
+
/**
|
|
901
|
+
*
|
|
902
|
+
* @type {string}
|
|
903
|
+
* @memberof Task
|
|
904
|
+
*/
|
|
905
|
+
'parentTask': string | null;
|
|
883
906
|
/**
|
|
884
907
|
* The unique id of the user who created the task
|
|
885
908
|
* @type {string}
|
|
@@ -892,6 +915,12 @@ export interface Task {
|
|
|
892
915
|
* @memberof Task
|
|
893
916
|
*/
|
|
894
917
|
'createdAt': string;
|
|
918
|
+
/**
|
|
919
|
+
*
|
|
920
|
+
* @type {string}
|
|
921
|
+
* @memberof Task
|
|
922
|
+
*/
|
|
923
|
+
'updatedAt': string;
|
|
895
924
|
}
|
|
896
925
|
/**
|
|
897
926
|
*
|
|
@@ -953,12 +982,30 @@ export interface TaskSummary {
|
|
|
953
982
|
* @memberof TaskSummary
|
|
954
983
|
*/
|
|
955
984
|
'workProgress': number;
|
|
985
|
+
/**
|
|
986
|
+
*
|
|
987
|
+
* @type {OkrLevel}
|
|
988
|
+
* @memberof TaskSummary
|
|
989
|
+
*/
|
|
990
|
+
'okrLevel': OkrLevel | null;
|
|
991
|
+
/**
|
|
992
|
+
*
|
|
993
|
+
* @type {string}
|
|
994
|
+
* @memberof TaskSummary
|
|
995
|
+
*/
|
|
996
|
+
'parentTask': string | null;
|
|
956
997
|
/**
|
|
957
998
|
*
|
|
958
999
|
* @type {string}
|
|
959
1000
|
* @memberof TaskSummary
|
|
960
1001
|
*/
|
|
961
1002
|
'createdAt': string;
|
|
1003
|
+
/**
|
|
1004
|
+
*
|
|
1005
|
+
* @type {string}
|
|
1006
|
+
* @memberof TaskSummary
|
|
1007
|
+
*/
|
|
1008
|
+
'updatedAt': string;
|
|
962
1009
|
}
|
|
963
1010
|
/**
|
|
964
1011
|
*
|
|
@@ -1196,6 +1243,18 @@ export interface UpdateTaskRequest {
|
|
|
1196
1243
|
* @memberof UpdateTaskRequest
|
|
1197
1244
|
*/
|
|
1198
1245
|
'workProgress'?: number;
|
|
1246
|
+
/**
|
|
1247
|
+
*
|
|
1248
|
+
* @type {OkrLevel}
|
|
1249
|
+
* @memberof UpdateTaskRequest
|
|
1250
|
+
*/
|
|
1251
|
+
'okrLevel'?: OkrLevel | null;
|
|
1252
|
+
/**
|
|
1253
|
+
*
|
|
1254
|
+
* @type {string}
|
|
1255
|
+
* @memberof UpdateTaskRequest
|
|
1256
|
+
*/
|
|
1257
|
+
'parentTask'?: string | null;
|
|
1199
1258
|
}
|
|
1200
1259
|
/**
|
|
1201
1260
|
* ProjectsApi - axios parameter creator
|
|
@@ -1298,6 +1357,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1298
1357
|
* @throws {RequiredError}
|
|
1299
1358
|
*/
|
|
1300
1359
|
deleteUser: (project: string, user: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1360
|
+
/**
|
|
1361
|
+
* Export all the OKRs in the planner
|
|
1362
|
+
* @summary Export all OKRs
|
|
1363
|
+
* @param {string} project Projects unique identifier
|
|
1364
|
+
* @param {*} [options] Override http request option.
|
|
1365
|
+
* @throws {RequiredError}
|
|
1366
|
+
*/
|
|
1367
|
+
exportOkrs: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1301
1368
|
/**
|
|
1302
1369
|
* Export all the tasks in the workflow
|
|
1303
1370
|
* @summary Export all tasks
|
|
@@ -1608,6 +1675,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
1608
1675
|
* @throws {RequiredError}
|
|
1609
1676
|
*/
|
|
1610
1677
|
deleteUser(project: string, user: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1678
|
+
/**
|
|
1679
|
+
* Export all the OKRs in the planner
|
|
1680
|
+
* @summary Export all OKRs
|
|
1681
|
+
* @param {string} project Projects unique identifier
|
|
1682
|
+
* @param {*} [options] Override http request option.
|
|
1683
|
+
* @throws {RequiredError}
|
|
1684
|
+
*/
|
|
1685
|
+
exportOkrs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1611
1686
|
/**
|
|
1612
1687
|
* Export all the tasks in the workflow
|
|
1613
1688
|
* @summary Export all tasks
|
|
@@ -1910,6 +1985,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
1910
1985
|
* @throws {RequiredError}
|
|
1911
1986
|
*/
|
|
1912
1987
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1988
|
+
/**
|
|
1989
|
+
* Export all the OKRs in the planner
|
|
1990
|
+
* @summary Export all OKRs
|
|
1991
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
1992
|
+
* @param {*} [options] Override http request option.
|
|
1993
|
+
* @throws {RequiredError}
|
|
1994
|
+
*/
|
|
1995
|
+
exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1913
1996
|
/**
|
|
1914
1997
|
* Export all the tasks in the workflow
|
|
1915
1998
|
* @summary Export all tasks
|
|
@@ -2286,6 +2369,19 @@ export interface ProjectsApiDeleteUserRequest {
|
|
|
2286
2369
|
*/
|
|
2287
2370
|
readonly user: string;
|
|
2288
2371
|
}
|
|
2372
|
+
/**
|
|
2373
|
+
* Request parameters for exportOkrs operation in ProjectsApi.
|
|
2374
|
+
* @export
|
|
2375
|
+
* @interface ProjectsApiExportOkrsRequest
|
|
2376
|
+
*/
|
|
2377
|
+
export interface ProjectsApiExportOkrsRequest {
|
|
2378
|
+
/**
|
|
2379
|
+
* Projects unique identifier
|
|
2380
|
+
* @type {string}
|
|
2381
|
+
* @memberof ProjectsApiExportOkrs
|
|
2382
|
+
*/
|
|
2383
|
+
readonly project: string;
|
|
2384
|
+
}
|
|
2289
2385
|
/**
|
|
2290
2386
|
* Request parameters for exportTasks operation in ProjectsApi.
|
|
2291
2387
|
* @export
|
|
@@ -2835,6 +2931,15 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
2835
2931
|
* @memberof ProjectsApi
|
|
2836
2932
|
*/
|
|
2837
2933
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2934
|
+
/**
|
|
2935
|
+
* Export all the OKRs in the planner
|
|
2936
|
+
* @summary Export all OKRs
|
|
2937
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
2938
|
+
* @param {*} [options] Override http request option.
|
|
2939
|
+
* @throws {RequiredError}
|
|
2940
|
+
* @memberof ProjectsApi
|
|
2941
|
+
*/
|
|
2942
|
+
exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
2838
2943
|
/**
|
|
2839
2944
|
* Export all the tasks in the workflow
|
|
2840
2945
|
* @summary Export all tasks
|
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.39.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -26,6 +26,16 @@ import globalAxios from 'axios';
|
|
|
26
26
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import { BASE_PATH, BaseAPI, operationServerMap } from './base';
|
|
29
|
+
/**
|
|
30
|
+
* Indicates whether the task is an OKR associated with the user
|
|
31
|
+
* @export
|
|
32
|
+
* @enum {string}
|
|
33
|
+
*/
|
|
34
|
+
export const OkrLevel = {
|
|
35
|
+
Objective: 'objective',
|
|
36
|
+
KeyResult: 'key_result',
|
|
37
|
+
Task: 'task'
|
|
38
|
+
};
|
|
29
39
|
export const ProjectUserTypeEnum = {
|
|
30
40
|
User: 'user',
|
|
31
41
|
Service: 'service',
|
|
@@ -468,6 +478,40 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
468
478
|
options: localVarRequestOptions,
|
|
469
479
|
};
|
|
470
480
|
}),
|
|
481
|
+
/**
|
|
482
|
+
* Export all the OKRs in the planner
|
|
483
|
+
* @summary Export all OKRs
|
|
484
|
+
* @param {string} project Projects unique identifier
|
|
485
|
+
* @param {*} [options] Override http request option.
|
|
486
|
+
* @throws {RequiredError}
|
|
487
|
+
*/
|
|
488
|
+
exportOkrs: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
489
|
+
// verify required parameter 'project' is not null or undefined
|
|
490
|
+
assertParamExists('exportOkrs', 'project', project);
|
|
491
|
+
const localVarPath = `/v1/projects/{project}/okrs/export`
|
|
492
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
493
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
494
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
495
|
+
let baseOptions;
|
|
496
|
+
if (configuration) {
|
|
497
|
+
baseOptions = configuration.baseOptions;
|
|
498
|
+
}
|
|
499
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
500
|
+
const localVarHeaderParameter = {};
|
|
501
|
+
const localVarQueryParameter = {};
|
|
502
|
+
// authentication session-oauth required
|
|
503
|
+
// oauth required
|
|
504
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
505
|
+
// authentication api-key required
|
|
506
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
507
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
508
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
509
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
510
|
+
return {
|
|
511
|
+
url: toPathString(localVarUrlObj),
|
|
512
|
+
options: localVarRequestOptions,
|
|
513
|
+
};
|
|
514
|
+
}),
|
|
471
515
|
/**
|
|
472
516
|
* Export all the tasks in the workflow
|
|
473
517
|
* @summary Export all tasks
|
|
@@ -1544,6 +1588,22 @@ export const ProjectsApiFp = function (configuration) {
|
|
|
1544
1588
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1545
1589
|
});
|
|
1546
1590
|
},
|
|
1591
|
+
/**
|
|
1592
|
+
* Export all the OKRs in the planner
|
|
1593
|
+
* @summary Export all OKRs
|
|
1594
|
+
* @param {string} project Projects unique identifier
|
|
1595
|
+
* @param {*} [options] Override http request option.
|
|
1596
|
+
* @throws {RequiredError}
|
|
1597
|
+
*/
|
|
1598
|
+
exportOkrs(project, options) {
|
|
1599
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1600
|
+
var _a, _b, _c;
|
|
1601
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportOkrs(project, options);
|
|
1602
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1603
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProjectsApi.exportOkrs']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1604
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1605
|
+
});
|
|
1606
|
+
},
|
|
1547
1607
|
/**
|
|
1548
1608
|
* Export all the tasks in the workflow
|
|
1549
1609
|
* @summary Export all tasks
|
|
@@ -2055,6 +2115,16 @@ export const ProjectsApiFactory = function (configuration, basePath, axios) {
|
|
|
2055
2115
|
deleteUser(requestParameters, options) {
|
|
2056
2116
|
return localVarFp.deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(axios, basePath));
|
|
2057
2117
|
},
|
|
2118
|
+
/**
|
|
2119
|
+
* Export all the OKRs in the planner
|
|
2120
|
+
* @summary Export all OKRs
|
|
2121
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
2122
|
+
* @param {*} [options] Override http request option.
|
|
2123
|
+
* @throws {RequiredError}
|
|
2124
|
+
*/
|
|
2125
|
+
exportOkrs(requestParameters, options) {
|
|
2126
|
+
return localVarFp.exportOkrs(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
2127
|
+
},
|
|
2058
2128
|
/**
|
|
2059
2129
|
* Export all the tasks in the workflow
|
|
2060
2130
|
* @summary Export all tasks
|
|
@@ -2415,6 +2485,17 @@ export class ProjectsApi extends BaseAPI {
|
|
|
2415
2485
|
deleteUser(requestParameters, options) {
|
|
2416
2486
|
return ProjectsApiFp(this.configuration).deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(this.axios, this.basePath));
|
|
2417
2487
|
}
|
|
2488
|
+
/**
|
|
2489
|
+
* Export all the OKRs in the planner
|
|
2490
|
+
* @summary Export all OKRs
|
|
2491
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
2492
|
+
* @param {*} [options] Override http request option.
|
|
2493
|
+
* @throws {RequiredError}
|
|
2494
|
+
* @memberof ProjectsApi
|
|
2495
|
+
*/
|
|
2496
|
+
exportOkrs(requestParameters, options) {
|
|
2497
|
+
return ProjectsApiFp(this.configuration).exportOkrs(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
2498
|
+
}
|
|
2418
2499
|
/**
|
|
2419
2500
|
* Export all the tasks in the workflow
|
|
2420
2501
|
* @summary Export all tasks
|
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
package/docs/OkrLevel.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# OkrLevel
|
|
2
|
+
|
|
3
|
+
Indicates whether the task is an OKR associated with the user
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Objective` (value: `'objective'`)
|
|
8
|
+
|
|
9
|
+
* `KeyResult` (value: `'key_result'`)
|
|
10
|
+
|
|
11
|
+
* `Task` (value: `'task'`)
|
|
12
|
+
|
|
13
|
+
[[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
|
@@ -15,6 +15,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
15
15
|
|[**deleteProject**](#deleteproject) | **DELETE** /v1/projects/{project} | Delete project|
|
|
16
16
|
|[**deleteTask**](#deletetask) | **DELETE** /v1/projects/{project}/tasks/{id} | Delete Task|
|
|
17
17
|
|[**deleteUser**](#deleteuser) | **DELETE** /v1/projects/{project}/users/{user} | Delete a user by ID|
|
|
18
|
+
|[**exportOkrs**](#exportokrs) | **GET** /v1/projects/{project}/okrs/export | Export all OKRs|
|
|
18
19
|
|[**exportTasks**](#exporttasks) | **GET** /v1/projects/{project}/tasks/export | Export all tasks|
|
|
19
20
|
|[**getAuth**](#getauth) | **GET** /v1/projects/{project}/auth | List auth tokens|
|
|
20
21
|
|[**getIntegration**](#getintegration) | **GET** /v1/projects/{project}/integrations/{integration} | Get integration|
|
|
@@ -673,6 +674,61 @@ void (empty response body)
|
|
|
673
674
|
|
|
674
675
|
[[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)
|
|
675
676
|
|
|
677
|
+
# **exportOkrs**
|
|
678
|
+
> File exportOkrs()
|
|
679
|
+
|
|
680
|
+
Export all the OKRs in the planner
|
|
681
|
+
|
|
682
|
+
### Example
|
|
683
|
+
|
|
684
|
+
```typescript
|
|
685
|
+
import {
|
|
686
|
+
ProjectsApi,
|
|
687
|
+
Configuration
|
|
688
|
+
} from '@teemill/projects';
|
|
689
|
+
|
|
690
|
+
const configuration = new Configuration();
|
|
691
|
+
const apiInstance = new ProjectsApi(configuration);
|
|
692
|
+
|
|
693
|
+
let project: string; //Projects unique identifier (default to undefined)
|
|
694
|
+
|
|
695
|
+
const { status, data } = await apiInstance.exportOkrs(
|
|
696
|
+
project
|
|
697
|
+
);
|
|
698
|
+
```
|
|
699
|
+
|
|
700
|
+
### Parameters
|
|
701
|
+
|
|
702
|
+
|Name | Type | Description | Notes|
|
|
703
|
+
|------------- | ------------- | ------------- | -------------|
|
|
704
|
+
| **project** | [**string**] | Projects unique identifier | defaults to undefined|
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
### Return type
|
|
708
|
+
|
|
709
|
+
**File**
|
|
710
|
+
|
|
711
|
+
### Authorization
|
|
712
|
+
|
|
713
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
714
|
+
|
|
715
|
+
### HTTP request headers
|
|
716
|
+
|
|
717
|
+
- **Content-Type**: Not defined
|
|
718
|
+
- **Accept**: text/csv; charset=utf-8, application/json
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
### HTTP response details
|
|
722
|
+
| Status code | Description | Response headers |
|
|
723
|
+
|-------------|-------------|------------------|
|
|
724
|
+
|**200** | Returns the CSV export | - |
|
|
725
|
+
|**202** | Export started. When complete, the export will be available for download from a notification within PodOS Dashboard. | - |
|
|
726
|
+
|**401** | Not authorised to access this resource | - |
|
|
727
|
+
|**403** | Refuse to authorize | - |
|
|
728
|
+
|**500** | Unknown server error | - |
|
|
729
|
+
|
|
730
|
+
[[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)
|
|
731
|
+
|
|
676
732
|
# **exportTasks**
|
|
677
733
|
> File exportTasks()
|
|
678
734
|
|
package/docs/Task.md
CHANGED
|
@@ -14,8 +14,11 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**notificationRecipients** | **Array<string>** | The unique ids of the users who will receive notifications for the task | [default to undefined]
|
|
15
15
|
**estimatedHours** | **number** | The estimated hours to complete the task | [default to undefined]
|
|
16
16
|
**workProgress** | **number** | The completion percentage of the task | [default to undefined]
|
|
17
|
+
**okrLevel** | [**OkrLevel**](OkrLevel.md) | | [default to undefined]
|
|
18
|
+
**parentTask** | **string** | | [default to undefined]
|
|
17
19
|
**createdUser** | **string** | The unique id of the user who created the task | [default to undefined]
|
|
18
20
|
**createdAt** | **string** | | [default to undefined]
|
|
21
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
19
22
|
|
|
20
23
|
## Example
|
|
21
24
|
|
|
@@ -32,8 +35,11 @@ const instance: Task = {
|
|
|
32
35
|
notificationRecipients,
|
|
33
36
|
estimatedHours,
|
|
34
37
|
workProgress,
|
|
38
|
+
okrLevel,
|
|
39
|
+
parentTask,
|
|
35
40
|
createdUser,
|
|
36
41
|
createdAt,
|
|
42
|
+
updatedAt,
|
|
37
43
|
};
|
|
38
44
|
```
|
|
39
45
|
|
package/docs/TaskSummary.md
CHANGED
|
@@ -12,7 +12,10 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**owner** | **string** | The unique id of the user who owns the task | [default to undefined]
|
|
13
13
|
**estimatedHours** | **number** | The estimated hours to complete the task | [default to undefined]
|
|
14
14
|
**workProgress** | **number** | The completion percentage of the task | [default to undefined]
|
|
15
|
+
**okrLevel** | [**OkrLevel**](OkrLevel.md) | | [default to undefined]
|
|
16
|
+
**parentTask** | **string** | | [default to undefined]
|
|
15
17
|
**createdAt** | **string** | | [default to undefined]
|
|
18
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
16
19
|
|
|
17
20
|
## Example
|
|
18
21
|
|
|
@@ -27,7 +30,10 @@ const instance: TaskSummary = {
|
|
|
27
30
|
owner,
|
|
28
31
|
estimatedHours,
|
|
29
32
|
workProgress,
|
|
33
|
+
okrLevel,
|
|
34
|
+
parentTask,
|
|
30
35
|
createdAt,
|
|
36
|
+
updatedAt,
|
|
31
37
|
};
|
|
32
38
|
```
|
|
33
39
|
|
|
@@ -12,6 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**notificationRecipients** | **Array<string>** | The unique ids of the users who will receive notifications for the task | [optional] [default to undefined]
|
|
13
13
|
**estimatedHours** | **number** | The estimated hours to complete the task | [optional] [default to undefined]
|
|
14
14
|
**workProgress** | **number** | The completion percentage of the task | [optional] [default to undefined]
|
|
15
|
+
**okrLevel** | [**OkrLevel**](OkrLevel.md) | | [optional] [default to undefined]
|
|
16
|
+
**parentTask** | **string** | | [optional] [default to undefined]
|
|
15
17
|
|
|
16
18
|
## Example
|
|
17
19
|
|
|
@@ -26,6 +28,8 @@ const instance: UpdateTaskRequest = {
|
|
|
26
28
|
notificationRecipients,
|
|
27
29
|
estimatedHours,
|
|
28
30
|
workProgress,
|
|
31
|
+
okrLevel,
|
|
32
|
+
parentTask,
|
|
29
33
|
};
|
|
30
34
|
```
|
|
31
35
|
|
package/index.ts
CHANGED