@teemill/projects 1.38.0 → 1.40.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 +172 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +124 -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 +124 -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 +8 -0
- package/docs/TaskSummary.md +8 -0
- package/docs/UpdateTaskRequest.md +6 -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.40.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.40.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.40.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,24 @@ 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;
|
|
922
|
+
/**
|
|
923
|
+
* Indicates the task deadline date
|
|
924
|
+
* @type {string}
|
|
925
|
+
* @memberof Task
|
|
926
|
+
*/
|
|
927
|
+
'endDate': string | null;
|
|
895
928
|
/**
|
|
896
929
|
* The unique id of the user who created the task
|
|
897
930
|
* @type {string}
|
|
@@ -904,6 +937,12 @@ export interface Task {
|
|
|
904
937
|
* @memberof Task
|
|
905
938
|
*/
|
|
906
939
|
'createdAt': string;
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @type {string}
|
|
943
|
+
* @memberof Task
|
|
944
|
+
*/
|
|
945
|
+
'updatedAt': string;
|
|
907
946
|
}
|
|
908
947
|
|
|
909
948
|
|
|
@@ -971,12 +1010,36 @@ export interface TaskSummary {
|
|
|
971
1010
|
* @memberof TaskSummary
|
|
972
1011
|
*/
|
|
973
1012
|
'workProgress': number;
|
|
1013
|
+
/**
|
|
1014
|
+
*
|
|
1015
|
+
* @type {OkrLevel}
|
|
1016
|
+
* @memberof TaskSummary
|
|
1017
|
+
*/
|
|
1018
|
+
'okrLevel': OkrLevel | null;
|
|
1019
|
+
/**
|
|
1020
|
+
*
|
|
1021
|
+
* @type {string}
|
|
1022
|
+
* @memberof TaskSummary
|
|
1023
|
+
*/
|
|
1024
|
+
'parentTask': string | null;
|
|
1025
|
+
/**
|
|
1026
|
+
* Indicates the task deadline date
|
|
1027
|
+
* @type {string}
|
|
1028
|
+
* @memberof TaskSummary
|
|
1029
|
+
*/
|
|
1030
|
+
'endDate': string | null;
|
|
974
1031
|
/**
|
|
975
1032
|
*
|
|
976
1033
|
* @type {string}
|
|
977
1034
|
* @memberof TaskSummary
|
|
978
1035
|
*/
|
|
979
1036
|
'createdAt': string;
|
|
1037
|
+
/**
|
|
1038
|
+
*
|
|
1039
|
+
* @type {string}
|
|
1040
|
+
* @memberof TaskSummary
|
|
1041
|
+
*/
|
|
1042
|
+
'updatedAt': string;
|
|
980
1043
|
}
|
|
981
1044
|
|
|
982
1045
|
|
|
@@ -1222,6 +1285,24 @@ export interface UpdateTaskRequest {
|
|
|
1222
1285
|
* @memberof UpdateTaskRequest
|
|
1223
1286
|
*/
|
|
1224
1287
|
'workProgress'?: number;
|
|
1288
|
+
/**
|
|
1289
|
+
*
|
|
1290
|
+
* @type {OkrLevel}
|
|
1291
|
+
* @memberof UpdateTaskRequest
|
|
1292
|
+
*/
|
|
1293
|
+
'okrLevel'?: OkrLevel | null;
|
|
1294
|
+
/**
|
|
1295
|
+
*
|
|
1296
|
+
* @type {string}
|
|
1297
|
+
* @memberof UpdateTaskRequest
|
|
1298
|
+
*/
|
|
1299
|
+
'parentTask'?: string | null;
|
|
1300
|
+
/**
|
|
1301
|
+
* Indicates the task deadline date
|
|
1302
|
+
* @type {string}
|
|
1303
|
+
* @memberof UpdateTaskRequest
|
|
1304
|
+
*/
|
|
1305
|
+
'endDate'?: string | null;
|
|
1225
1306
|
}
|
|
1226
1307
|
|
|
1227
1308
|
|
|
@@ -1712,6 +1793,47 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1712
1793
|
|
|
1713
1794
|
|
|
1714
1795
|
|
|
1796
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1797
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1798
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1799
|
+
|
|
1800
|
+
return {
|
|
1801
|
+
url: toPathString(localVarUrlObj),
|
|
1802
|
+
options: localVarRequestOptions,
|
|
1803
|
+
};
|
|
1804
|
+
},
|
|
1805
|
+
/**
|
|
1806
|
+
* Export all the OKRs in the planner
|
|
1807
|
+
* @summary Export all OKRs
|
|
1808
|
+
* @param {string} project Projects unique identifier
|
|
1809
|
+
* @param {*} [options] Override http request option.
|
|
1810
|
+
* @throws {RequiredError}
|
|
1811
|
+
*/
|
|
1812
|
+
exportOkrs: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1813
|
+
// verify required parameter 'project' is not null or undefined
|
|
1814
|
+
assertParamExists('exportOkrs', 'project', project)
|
|
1815
|
+
const localVarPath = `/v1/projects/{project}/okrs/export`
|
|
1816
|
+
.replace(`{${"project"}}`, encodeURIComponent(String(project)));
|
|
1817
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1818
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1819
|
+
let baseOptions;
|
|
1820
|
+
if (configuration) {
|
|
1821
|
+
baseOptions = configuration.baseOptions;
|
|
1822
|
+
}
|
|
1823
|
+
|
|
1824
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1825
|
+
const localVarHeaderParameter = {} as any;
|
|
1826
|
+
const localVarQueryParameter = {} as any;
|
|
1827
|
+
|
|
1828
|
+
// authentication session-oauth required
|
|
1829
|
+
// oauth required
|
|
1830
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1831
|
+
|
|
1832
|
+
// authentication api-key required
|
|
1833
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1834
|
+
|
|
1835
|
+
|
|
1836
|
+
|
|
1715
1837
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1716
1838
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1717
1839
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2942,6 +3064,19 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
2942
3064
|
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.deleteUser']?.[localVarOperationServerIndex]?.url;
|
|
2943
3065
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2944
3066
|
},
|
|
3067
|
+
/**
|
|
3068
|
+
* Export all the OKRs in the planner
|
|
3069
|
+
* @summary Export all OKRs
|
|
3070
|
+
* @param {string} project Projects unique identifier
|
|
3071
|
+
* @param {*} [options] Override http request option.
|
|
3072
|
+
* @throws {RequiredError}
|
|
3073
|
+
*/
|
|
3074
|
+
async exportOkrs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3075
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportOkrs(project, options);
|
|
3076
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3077
|
+
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.exportOkrs']?.[localVarOperationServerIndex]?.url;
|
|
3078
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3079
|
+
},
|
|
2945
3080
|
/**
|
|
2946
3081
|
* Export all the tasks in the workflow
|
|
2947
3082
|
* @summary Export all tasks
|
|
@@ -3385,6 +3520,16 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
3385
3520
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
3386
3521
|
return localVarFp.deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(axios, basePath));
|
|
3387
3522
|
},
|
|
3523
|
+
/**
|
|
3524
|
+
* Export all the OKRs in the planner
|
|
3525
|
+
* @summary Export all OKRs
|
|
3526
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
3527
|
+
* @param {*} [options] Override http request option.
|
|
3528
|
+
* @throws {RequiredError}
|
|
3529
|
+
*/
|
|
3530
|
+
exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3531
|
+
return localVarFp.exportOkrs(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
3532
|
+
},
|
|
3388
3533
|
/**
|
|
3389
3534
|
* Export all the tasks in the workflow
|
|
3390
3535
|
* @summary Export all tasks
|
|
@@ -3828,6 +3973,20 @@ export interface ProjectsApiDeleteUserRequest {
|
|
|
3828
3973
|
readonly user: string
|
|
3829
3974
|
}
|
|
3830
3975
|
|
|
3976
|
+
/**
|
|
3977
|
+
* Request parameters for exportOkrs operation in ProjectsApi.
|
|
3978
|
+
* @export
|
|
3979
|
+
* @interface ProjectsApiExportOkrsRequest
|
|
3980
|
+
*/
|
|
3981
|
+
export interface ProjectsApiExportOkrsRequest {
|
|
3982
|
+
/**
|
|
3983
|
+
* Projects unique identifier
|
|
3984
|
+
* @type {string}
|
|
3985
|
+
* @memberof ProjectsApiExportOkrs
|
|
3986
|
+
*/
|
|
3987
|
+
readonly project: string
|
|
3988
|
+
}
|
|
3989
|
+
|
|
3831
3990
|
/**
|
|
3832
3991
|
* Request parameters for exportTasks operation in ProjectsApi.
|
|
3833
3992
|
* @export
|
|
@@ -4457,6 +4616,18 @@ export class ProjectsApi extends BaseAPI {
|
|
|
4457
4616
|
return ProjectsApiFp(this.configuration).deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(this.axios, this.basePath));
|
|
4458
4617
|
}
|
|
4459
4618
|
|
|
4619
|
+
/**
|
|
4620
|
+
* Export all the OKRs in the planner
|
|
4621
|
+
* @summary Export all OKRs
|
|
4622
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
4623
|
+
* @param {*} [options] Override http request option.
|
|
4624
|
+
* @throws {RequiredError}
|
|
4625
|
+
* @memberof ProjectsApi
|
|
4626
|
+
*/
|
|
4627
|
+
public exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig) {
|
|
4628
|
+
return ProjectsApiFp(this.configuration).exportOkrs(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
4629
|
+
}
|
|
4630
|
+
|
|
4460
4631
|
/**
|
|
4461
4632
|
* Export all the tasks in the workflow
|
|
4462
4633
|
* @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.40.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,24 @@ 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;
|
|
906
|
+
/**
|
|
907
|
+
* Indicates the task deadline date
|
|
908
|
+
* @type {string}
|
|
909
|
+
* @memberof Task
|
|
910
|
+
*/
|
|
911
|
+
'endDate': string | null;
|
|
883
912
|
/**
|
|
884
913
|
* The unique id of the user who created the task
|
|
885
914
|
* @type {string}
|
|
@@ -892,6 +921,12 @@ export interface Task {
|
|
|
892
921
|
* @memberof Task
|
|
893
922
|
*/
|
|
894
923
|
'createdAt': string;
|
|
924
|
+
/**
|
|
925
|
+
*
|
|
926
|
+
* @type {string}
|
|
927
|
+
* @memberof Task
|
|
928
|
+
*/
|
|
929
|
+
'updatedAt': string;
|
|
895
930
|
}
|
|
896
931
|
/**
|
|
897
932
|
*
|
|
@@ -953,12 +988,36 @@ export interface TaskSummary {
|
|
|
953
988
|
* @memberof TaskSummary
|
|
954
989
|
*/
|
|
955
990
|
'workProgress': number;
|
|
991
|
+
/**
|
|
992
|
+
*
|
|
993
|
+
* @type {OkrLevel}
|
|
994
|
+
* @memberof TaskSummary
|
|
995
|
+
*/
|
|
996
|
+
'okrLevel': OkrLevel | null;
|
|
997
|
+
/**
|
|
998
|
+
*
|
|
999
|
+
* @type {string}
|
|
1000
|
+
* @memberof TaskSummary
|
|
1001
|
+
*/
|
|
1002
|
+
'parentTask': string | null;
|
|
1003
|
+
/**
|
|
1004
|
+
* Indicates the task deadline date
|
|
1005
|
+
* @type {string}
|
|
1006
|
+
* @memberof TaskSummary
|
|
1007
|
+
*/
|
|
1008
|
+
'endDate': string | null;
|
|
956
1009
|
/**
|
|
957
1010
|
*
|
|
958
1011
|
* @type {string}
|
|
959
1012
|
* @memberof TaskSummary
|
|
960
1013
|
*/
|
|
961
1014
|
'createdAt': string;
|
|
1015
|
+
/**
|
|
1016
|
+
*
|
|
1017
|
+
* @type {string}
|
|
1018
|
+
* @memberof TaskSummary
|
|
1019
|
+
*/
|
|
1020
|
+
'updatedAt': string;
|
|
962
1021
|
}
|
|
963
1022
|
/**
|
|
964
1023
|
*
|
|
@@ -1196,6 +1255,24 @@ export interface UpdateTaskRequest {
|
|
|
1196
1255
|
* @memberof UpdateTaskRequest
|
|
1197
1256
|
*/
|
|
1198
1257
|
'workProgress'?: number;
|
|
1258
|
+
/**
|
|
1259
|
+
*
|
|
1260
|
+
* @type {OkrLevel}
|
|
1261
|
+
* @memberof UpdateTaskRequest
|
|
1262
|
+
*/
|
|
1263
|
+
'okrLevel'?: OkrLevel | null;
|
|
1264
|
+
/**
|
|
1265
|
+
*
|
|
1266
|
+
* @type {string}
|
|
1267
|
+
* @memberof UpdateTaskRequest
|
|
1268
|
+
*/
|
|
1269
|
+
'parentTask'?: string | null;
|
|
1270
|
+
/**
|
|
1271
|
+
* Indicates the task deadline date
|
|
1272
|
+
* @type {string}
|
|
1273
|
+
* @memberof UpdateTaskRequest
|
|
1274
|
+
*/
|
|
1275
|
+
'endDate'?: string | null;
|
|
1199
1276
|
}
|
|
1200
1277
|
/**
|
|
1201
1278
|
* ProjectsApi - axios parameter creator
|
|
@@ -1298,6 +1375,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1298
1375
|
* @throws {RequiredError}
|
|
1299
1376
|
*/
|
|
1300
1377
|
deleteUser: (project: string, user: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1378
|
+
/**
|
|
1379
|
+
* Export all the OKRs in the planner
|
|
1380
|
+
* @summary Export all OKRs
|
|
1381
|
+
* @param {string} project Projects unique identifier
|
|
1382
|
+
* @param {*} [options] Override http request option.
|
|
1383
|
+
* @throws {RequiredError}
|
|
1384
|
+
*/
|
|
1385
|
+
exportOkrs: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1301
1386
|
/**
|
|
1302
1387
|
* Export all the tasks in the workflow
|
|
1303
1388
|
* @summary Export all tasks
|
|
@@ -1608,6 +1693,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
1608
1693
|
* @throws {RequiredError}
|
|
1609
1694
|
*/
|
|
1610
1695
|
deleteUser(project: string, user: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1696
|
+
/**
|
|
1697
|
+
* Export all the OKRs in the planner
|
|
1698
|
+
* @summary Export all OKRs
|
|
1699
|
+
* @param {string} project Projects unique identifier
|
|
1700
|
+
* @param {*} [options] Override http request option.
|
|
1701
|
+
* @throws {RequiredError}
|
|
1702
|
+
*/
|
|
1703
|
+
exportOkrs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1611
1704
|
/**
|
|
1612
1705
|
* Export all the tasks in the workflow
|
|
1613
1706
|
* @summary Export all tasks
|
|
@@ -1910,6 +2003,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
1910
2003
|
* @throws {RequiredError}
|
|
1911
2004
|
*/
|
|
1912
2005
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2006
|
+
/**
|
|
2007
|
+
* Export all the OKRs in the planner
|
|
2008
|
+
* @summary Export all OKRs
|
|
2009
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
2010
|
+
* @param {*} [options] Override http request option.
|
|
2011
|
+
* @throws {RequiredError}
|
|
2012
|
+
*/
|
|
2013
|
+
exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1913
2014
|
/**
|
|
1914
2015
|
* Export all the tasks in the workflow
|
|
1915
2016
|
* @summary Export all tasks
|
|
@@ -2286,6 +2387,19 @@ export interface ProjectsApiDeleteUserRequest {
|
|
|
2286
2387
|
*/
|
|
2287
2388
|
readonly user: string;
|
|
2288
2389
|
}
|
|
2390
|
+
/**
|
|
2391
|
+
* Request parameters for exportOkrs operation in ProjectsApi.
|
|
2392
|
+
* @export
|
|
2393
|
+
* @interface ProjectsApiExportOkrsRequest
|
|
2394
|
+
*/
|
|
2395
|
+
export interface ProjectsApiExportOkrsRequest {
|
|
2396
|
+
/**
|
|
2397
|
+
* Projects unique identifier
|
|
2398
|
+
* @type {string}
|
|
2399
|
+
* @memberof ProjectsApiExportOkrs
|
|
2400
|
+
*/
|
|
2401
|
+
readonly project: string;
|
|
2402
|
+
}
|
|
2289
2403
|
/**
|
|
2290
2404
|
* Request parameters for exportTasks operation in ProjectsApi.
|
|
2291
2405
|
* @export
|
|
@@ -2835,6 +2949,15 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
2835
2949
|
* @memberof ProjectsApi
|
|
2836
2950
|
*/
|
|
2837
2951
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2952
|
+
/**
|
|
2953
|
+
* Export all the OKRs in the planner
|
|
2954
|
+
* @summary Export all OKRs
|
|
2955
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
2956
|
+
* @param {*} [options] Override http request option.
|
|
2957
|
+
* @throws {RequiredError}
|
|
2958
|
+
* @memberof ProjectsApi
|
|
2959
|
+
*/
|
|
2960
|
+
exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
2838
2961
|
/**
|
|
2839
2962
|
* Export all the tasks in the workflow
|
|
2840
2963
|
* @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.40.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.40.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,24 @@ 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;
|
|
906
|
+
/**
|
|
907
|
+
* Indicates the task deadline date
|
|
908
|
+
* @type {string}
|
|
909
|
+
* @memberof Task
|
|
910
|
+
*/
|
|
911
|
+
'endDate': string | null;
|
|
883
912
|
/**
|
|
884
913
|
* The unique id of the user who created the task
|
|
885
914
|
* @type {string}
|
|
@@ -892,6 +921,12 @@ export interface Task {
|
|
|
892
921
|
* @memberof Task
|
|
893
922
|
*/
|
|
894
923
|
'createdAt': string;
|
|
924
|
+
/**
|
|
925
|
+
*
|
|
926
|
+
* @type {string}
|
|
927
|
+
* @memberof Task
|
|
928
|
+
*/
|
|
929
|
+
'updatedAt': string;
|
|
895
930
|
}
|
|
896
931
|
/**
|
|
897
932
|
*
|
|
@@ -953,12 +988,36 @@ export interface TaskSummary {
|
|
|
953
988
|
* @memberof TaskSummary
|
|
954
989
|
*/
|
|
955
990
|
'workProgress': number;
|
|
991
|
+
/**
|
|
992
|
+
*
|
|
993
|
+
* @type {OkrLevel}
|
|
994
|
+
* @memberof TaskSummary
|
|
995
|
+
*/
|
|
996
|
+
'okrLevel': OkrLevel | null;
|
|
997
|
+
/**
|
|
998
|
+
*
|
|
999
|
+
* @type {string}
|
|
1000
|
+
* @memberof TaskSummary
|
|
1001
|
+
*/
|
|
1002
|
+
'parentTask': string | null;
|
|
1003
|
+
/**
|
|
1004
|
+
* Indicates the task deadline date
|
|
1005
|
+
* @type {string}
|
|
1006
|
+
* @memberof TaskSummary
|
|
1007
|
+
*/
|
|
1008
|
+
'endDate': string | null;
|
|
956
1009
|
/**
|
|
957
1010
|
*
|
|
958
1011
|
* @type {string}
|
|
959
1012
|
* @memberof TaskSummary
|
|
960
1013
|
*/
|
|
961
1014
|
'createdAt': string;
|
|
1015
|
+
/**
|
|
1016
|
+
*
|
|
1017
|
+
* @type {string}
|
|
1018
|
+
* @memberof TaskSummary
|
|
1019
|
+
*/
|
|
1020
|
+
'updatedAt': string;
|
|
962
1021
|
}
|
|
963
1022
|
/**
|
|
964
1023
|
*
|
|
@@ -1196,6 +1255,24 @@ export interface UpdateTaskRequest {
|
|
|
1196
1255
|
* @memberof UpdateTaskRequest
|
|
1197
1256
|
*/
|
|
1198
1257
|
'workProgress'?: number;
|
|
1258
|
+
/**
|
|
1259
|
+
*
|
|
1260
|
+
* @type {OkrLevel}
|
|
1261
|
+
* @memberof UpdateTaskRequest
|
|
1262
|
+
*/
|
|
1263
|
+
'okrLevel'?: OkrLevel | null;
|
|
1264
|
+
/**
|
|
1265
|
+
*
|
|
1266
|
+
* @type {string}
|
|
1267
|
+
* @memberof UpdateTaskRequest
|
|
1268
|
+
*/
|
|
1269
|
+
'parentTask'?: string | null;
|
|
1270
|
+
/**
|
|
1271
|
+
* Indicates the task deadline date
|
|
1272
|
+
* @type {string}
|
|
1273
|
+
* @memberof UpdateTaskRequest
|
|
1274
|
+
*/
|
|
1275
|
+
'endDate'?: string | null;
|
|
1199
1276
|
}
|
|
1200
1277
|
/**
|
|
1201
1278
|
* ProjectsApi - axios parameter creator
|
|
@@ -1298,6 +1375,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1298
1375
|
* @throws {RequiredError}
|
|
1299
1376
|
*/
|
|
1300
1377
|
deleteUser: (project: string, user: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1378
|
+
/**
|
|
1379
|
+
* Export all the OKRs in the planner
|
|
1380
|
+
* @summary Export all OKRs
|
|
1381
|
+
* @param {string} project Projects unique identifier
|
|
1382
|
+
* @param {*} [options] Override http request option.
|
|
1383
|
+
* @throws {RequiredError}
|
|
1384
|
+
*/
|
|
1385
|
+
exportOkrs: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1301
1386
|
/**
|
|
1302
1387
|
* Export all the tasks in the workflow
|
|
1303
1388
|
* @summary Export all tasks
|
|
@@ -1608,6 +1693,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
1608
1693
|
* @throws {RequiredError}
|
|
1609
1694
|
*/
|
|
1610
1695
|
deleteUser(project: string, user: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1696
|
+
/**
|
|
1697
|
+
* Export all the OKRs in the planner
|
|
1698
|
+
* @summary Export all OKRs
|
|
1699
|
+
* @param {string} project Projects unique identifier
|
|
1700
|
+
* @param {*} [options] Override http request option.
|
|
1701
|
+
* @throws {RequiredError}
|
|
1702
|
+
*/
|
|
1703
|
+
exportOkrs(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1611
1704
|
/**
|
|
1612
1705
|
* Export all the tasks in the workflow
|
|
1613
1706
|
* @summary Export all tasks
|
|
@@ -1910,6 +2003,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
1910
2003
|
* @throws {RequiredError}
|
|
1911
2004
|
*/
|
|
1912
2005
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2006
|
+
/**
|
|
2007
|
+
* Export all the OKRs in the planner
|
|
2008
|
+
* @summary Export all OKRs
|
|
2009
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
2010
|
+
* @param {*} [options] Override http request option.
|
|
2011
|
+
* @throws {RequiredError}
|
|
2012
|
+
*/
|
|
2013
|
+
exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1913
2014
|
/**
|
|
1914
2015
|
* Export all the tasks in the workflow
|
|
1915
2016
|
* @summary Export all tasks
|
|
@@ -2286,6 +2387,19 @@ export interface ProjectsApiDeleteUserRequest {
|
|
|
2286
2387
|
*/
|
|
2287
2388
|
readonly user: string;
|
|
2288
2389
|
}
|
|
2390
|
+
/**
|
|
2391
|
+
* Request parameters for exportOkrs operation in ProjectsApi.
|
|
2392
|
+
* @export
|
|
2393
|
+
* @interface ProjectsApiExportOkrsRequest
|
|
2394
|
+
*/
|
|
2395
|
+
export interface ProjectsApiExportOkrsRequest {
|
|
2396
|
+
/**
|
|
2397
|
+
* Projects unique identifier
|
|
2398
|
+
* @type {string}
|
|
2399
|
+
* @memberof ProjectsApiExportOkrs
|
|
2400
|
+
*/
|
|
2401
|
+
readonly project: string;
|
|
2402
|
+
}
|
|
2289
2403
|
/**
|
|
2290
2404
|
* Request parameters for exportTasks operation in ProjectsApi.
|
|
2291
2405
|
* @export
|
|
@@ -2835,6 +2949,15 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
2835
2949
|
* @memberof ProjectsApi
|
|
2836
2950
|
*/
|
|
2837
2951
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2952
|
+
/**
|
|
2953
|
+
* Export all the OKRs in the planner
|
|
2954
|
+
* @summary Export all OKRs
|
|
2955
|
+
* @param {ProjectsApiExportOkrsRequest} requestParameters Request parameters.
|
|
2956
|
+
* @param {*} [options] Override http request option.
|
|
2957
|
+
* @throws {RequiredError}
|
|
2958
|
+
* @memberof ProjectsApi
|
|
2959
|
+
*/
|
|
2960
|
+
exportOkrs(requestParameters: ProjectsApiExportOkrsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
2838
2961
|
/**
|
|
2839
2962
|
* Export all the tasks in the workflow
|
|
2840
2963
|
* @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.40.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,12 @@ 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]
|
|
19
|
+
**endDate** | **string** | Indicates the task deadline date | [default to undefined]
|
|
17
20
|
**createdUser** | **string** | The unique id of the user who created the task | [default to undefined]
|
|
18
21
|
**createdAt** | **string** | | [default to undefined]
|
|
22
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
19
23
|
|
|
20
24
|
## Example
|
|
21
25
|
|
|
@@ -32,8 +36,12 @@ const instance: Task = {
|
|
|
32
36
|
notificationRecipients,
|
|
33
37
|
estimatedHours,
|
|
34
38
|
workProgress,
|
|
39
|
+
okrLevel,
|
|
40
|
+
parentTask,
|
|
41
|
+
endDate,
|
|
35
42
|
createdUser,
|
|
36
43
|
createdAt,
|
|
44
|
+
updatedAt,
|
|
37
45
|
};
|
|
38
46
|
```
|
|
39
47
|
|
package/docs/TaskSummary.md
CHANGED
|
@@ -12,7 +12,11 @@ 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]
|
|
17
|
+
**endDate** | **string** | Indicates the task deadline date | [default to undefined]
|
|
15
18
|
**createdAt** | **string** | | [default to undefined]
|
|
19
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
16
20
|
|
|
17
21
|
## Example
|
|
18
22
|
|
|
@@ -27,7 +31,11 @@ const instance: TaskSummary = {
|
|
|
27
31
|
owner,
|
|
28
32
|
estimatedHours,
|
|
29
33
|
workProgress,
|
|
34
|
+
okrLevel,
|
|
35
|
+
parentTask,
|
|
36
|
+
endDate,
|
|
30
37
|
createdAt,
|
|
38
|
+
updatedAt,
|
|
31
39
|
};
|
|
32
40
|
```
|
|
33
41
|
|
|
@@ -12,6 +12,9 @@ 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]
|
|
17
|
+
**endDate** | **string** | Indicates the task deadline date | [optional] [default to undefined]
|
|
15
18
|
|
|
16
19
|
## Example
|
|
17
20
|
|
|
@@ -26,6 +29,9 @@ const instance: UpdateTaskRequest = {
|
|
|
26
29
|
notificationRecipients,
|
|
27
30
|
estimatedHours,
|
|
28
31
|
workProgress,
|
|
32
|
+
okrLevel,
|
|
33
|
+
parentTask,
|
|
34
|
+
endDate,
|
|
29
35
|
};
|
|
30
36
|
```
|
|
31
37
|
|
package/index.ts
CHANGED