@teemill/projects 1.37.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 +117 -2
- package/api.ts +178 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +130 -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 +130 -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/ApiError.md +22 -0
- package/docs/Auth.md +24 -0
- package/docs/AuthResponse.md +20 -0
- package/docs/Bookmark.md +36 -0
- package/docs/BookmarkData.md +22 -0
- package/docs/BookmarkRoute.md +20 -0
- package/docs/BookmarkRouteRoute.md +24 -0
- package/docs/BookmarkTab.md +24 -0
- package/docs/BookmarkTabs.md +20 -0
- package/docs/BookmarkUrl.md +20 -0
- package/docs/Bookmarks.md +20 -0
- package/docs/CreateBookmarkRequest.md +30 -0
- package/docs/CreateInviteRequest.md +22 -0
- package/docs/CreateProjectRequest.md +26 -0
- package/docs/CreateTaskRequest.md +22 -0
- package/docs/ExportTasks202Response.md +20 -0
- package/docs/Icon.md +24 -0
- package/docs/InstallTemplateRequest.md +20 -0
- package/docs/Integration.md +26 -0
- package/docs/IntegrationsResponse.md +20 -0
- package/docs/LegacyProjectLogo.md +22 -0
- package/docs/ListTasksResponse.md +20 -0
- package/docs/NullableIcon.md +24 -0
- package/docs/OkrLevel.md +13 -0
- package/docs/Project.md +36 -0
- package/docs/ProjectCurrency.md +22 -0
- package/docs/ProjectInvite.md +30 -0
- package/docs/ProjectInvites.md +22 -0
- package/docs/ProjectLogo.md +22 -0
- package/docs/ProjectManager.md +24 -0
- package/docs/ProjectPlatform.md +22 -0
- package/docs/ProjectUser.md +34 -0
- package/docs/ProjectUserAvatar.md +20 -0
- package/docs/ProjectUsers.md +22 -0
- package/docs/ProjectsApi.md +2079 -0
- package/docs/ProjectsResponse.md +20 -0
- package/docs/Task.md +46 -0
- package/docs/TaskStatus.md +14 -0
- package/docs/TaskSummary.md +40 -0
- package/docs/Template.md +28 -0
- package/docs/TemplateCode.md +16 -0
- package/docs/TemplatesResponse.md +20 -0
- package/docs/UpdateBookmarkRequest.md +34 -0
- package/docs/UpdateBookmarkTabsRequest.md +20 -0
- package/docs/UpdateBookmarkTabsRequestTabsInner.md +24 -0
- package/docs/UpdateIntegrationRequest.md +20 -0
- package/docs/UpdateProjectRequest.md +22 -0
- package/docs/UpdateTaskRequest.md +36 -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):_
|
|
@@ -44,3 +44,118 @@ _unPublished (not recommended):_
|
|
|
44
44
|
```
|
|
45
45
|
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
46
46
|
```
|
|
47
|
+
|
|
48
|
+
### Documentation for API Endpoints
|
|
49
|
+
|
|
50
|
+
All URIs are relative to *https://localhost:8080*
|
|
51
|
+
|
|
52
|
+
Class | Method | HTTP request | Description
|
|
53
|
+
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*ProjectsApi* | [**createAuth**](docs/ProjectsApi.md#createauth) | **POST** /v1/projects/{project}/auth | Create auth token
|
|
55
|
+
*ProjectsApi* | [**createBookmark**](docs/ProjectsApi.md#createbookmark) | **POST** /v1/projects/{project}/bookmarks | Create bookmark
|
|
56
|
+
*ProjectsApi* | [**createInvite**](docs/ProjectsApi.md#createinvite) | **POST** /v1/projects/{project}/invites | Creates an invite
|
|
57
|
+
*ProjectsApi* | [**createProject**](docs/ProjectsApi.md#createproject) | **POST** /v1/projects | Create project
|
|
58
|
+
*ProjectsApi* | [**createTask**](docs/ProjectsApi.md#createtask) | **POST** /v1/projects/{project}/tasks | Create Task
|
|
59
|
+
*ProjectsApi* | [**deleteAuth**](docs/ProjectsApi.md#deleteauth) | **DELETE** /v1/projects/{project}/auth/{auth} | Delete auth token
|
|
60
|
+
*ProjectsApi* | [**deleteBookmark**](docs/ProjectsApi.md#deletebookmark) | **DELETE** /v1/projects/{project}/bookmarks/{id} | Delete bookmark
|
|
61
|
+
*ProjectsApi* | [**deleteInvite**](docs/ProjectsApi.md#deleteinvite) | **DELETE** /v1/projects/{project}/invites/{invite} | Deletes an invite
|
|
62
|
+
*ProjectsApi* | [**deleteProject**](docs/ProjectsApi.md#deleteproject) | **DELETE** /v1/projects/{project} | Delete project
|
|
63
|
+
*ProjectsApi* | [**deleteTask**](docs/ProjectsApi.md#deletetask) | **DELETE** /v1/projects/{project}/tasks/{id} | Delete Task
|
|
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
|
|
66
|
+
*ProjectsApi* | [**exportTasks**](docs/ProjectsApi.md#exporttasks) | **GET** /v1/projects/{project}/tasks/export | Export all tasks
|
|
67
|
+
*ProjectsApi* | [**getAuth**](docs/ProjectsApi.md#getauth) | **GET** /v1/projects/{project}/auth | List auth tokens
|
|
68
|
+
*ProjectsApi* | [**getIntegration**](docs/ProjectsApi.md#getintegration) | **GET** /v1/projects/{project}/integrations/{integration} | Get integration
|
|
69
|
+
*ProjectsApi* | [**getIntegrations**](docs/ProjectsApi.md#getintegrations) | **GET** /v1/projects/{project}/integrations | List integrations
|
|
70
|
+
*ProjectsApi* | [**getInvites**](docs/ProjectsApi.md#getinvites) | **GET** /v1/projects/{project}/invites | List Invites
|
|
71
|
+
*ProjectsApi* | [**getProject**](docs/ProjectsApi.md#getproject) | **GET** /v1/projects/{project} | Get project
|
|
72
|
+
*ProjectsApi* | [**getProjects**](docs/ProjectsApi.md#getprojects) | **GET** /v1/projects | List projects
|
|
73
|
+
*ProjectsApi* | [**getTask**](docs/ProjectsApi.md#gettask) | **GET** /v1/projects/{project}/tasks/{id} | Get Task
|
|
74
|
+
*ProjectsApi* | [**getTemplates**](docs/ProjectsApi.md#gettemplates) | **GET** /v1/projects/templates | List templates
|
|
75
|
+
*ProjectsApi* | [**getUser**](docs/ProjectsApi.md#getuser) | **GET** /v1/projects/{project}/users/{user} | Get a user
|
|
76
|
+
*ProjectsApi* | [**getUsers**](docs/ProjectsApi.md#getusers) | **GET** /v1/projects/{project}/users | List project users
|
|
77
|
+
*ProjectsApi* | [**installIntegration**](docs/ProjectsApi.md#installintegration) | **POST** /v1/projects/{project}/integrations/{integration} | Install integration
|
|
78
|
+
*ProjectsApi* | [**installTemplate**](docs/ProjectsApi.md#installtemplate) | **POST** /v1/projects/{project}/templates/{template} | Install integration template
|
|
79
|
+
*ProjectsApi* | [**listBookmarks**](docs/ProjectsApi.md#listbookmarks) | **GET** /v1/projects/{project}/bookmarks | List bookmarks
|
|
80
|
+
*ProjectsApi* | [**listBookmarktabs**](docs/ProjectsApi.md#listbookmarktabs) | **GET** /v1/projects/{project}/bookmarktabs | List bookmark tabs
|
|
81
|
+
*ProjectsApi* | [**listTasks**](docs/ProjectsApi.md#listtasks) | **GET** /v1/projects/{project}/tasks | List Tasks
|
|
82
|
+
*ProjectsApi* | [**setupIntegration**](docs/ProjectsApi.md#setupintegration) | **POST** /v1/projects/{project}/integrations/{integration}/setup | Setup integration
|
|
83
|
+
*ProjectsApi* | [**uninstallIntegration**](docs/ProjectsApi.md#uninstallintegration) | **DELETE** /v1/projects/{project}/integrations/{integration} | Uninstall integration
|
|
84
|
+
*ProjectsApi* | [**updateBookmark**](docs/ProjectsApi.md#updatebookmark) | **PATCH** /v1/projects/{project}/bookmarks/{id} | Update bookmark
|
|
85
|
+
*ProjectsApi* | [**updateBookmarkTabs**](docs/ProjectsApi.md#updatebookmarktabs) | **PUT** /v1/projects/{project}/bookmarktabs | Update bookmark tabs
|
|
86
|
+
*ProjectsApi* | [**updateIntegration**](docs/ProjectsApi.md#updateintegration) | **PATCH** /v1/projects/{project}/integrations/{integration} | Update integration
|
|
87
|
+
*ProjectsApi* | [**updateProject**](docs/ProjectsApi.md#updateproject) | **PATCH** /v1/projects/{project} | Update project
|
|
88
|
+
*ProjectsApi* | [**updateTask**](docs/ProjectsApi.md#updatetask) | **PATCH** /v1/projects/{project}/tasks/{id} | Update Task
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### Documentation For Models
|
|
92
|
+
|
|
93
|
+
- [ApiError](docs/ApiError.md)
|
|
94
|
+
- [Auth](docs/Auth.md)
|
|
95
|
+
- [AuthResponse](docs/AuthResponse.md)
|
|
96
|
+
- [Bookmark](docs/Bookmark.md)
|
|
97
|
+
- [BookmarkData](docs/BookmarkData.md)
|
|
98
|
+
- [BookmarkRoute](docs/BookmarkRoute.md)
|
|
99
|
+
- [BookmarkRouteRoute](docs/BookmarkRouteRoute.md)
|
|
100
|
+
- [BookmarkTab](docs/BookmarkTab.md)
|
|
101
|
+
- [BookmarkTabs](docs/BookmarkTabs.md)
|
|
102
|
+
- [BookmarkUrl](docs/BookmarkUrl.md)
|
|
103
|
+
- [Bookmarks](docs/Bookmarks.md)
|
|
104
|
+
- [CreateBookmarkRequest](docs/CreateBookmarkRequest.md)
|
|
105
|
+
- [CreateInviteRequest](docs/CreateInviteRequest.md)
|
|
106
|
+
- [CreateProjectRequest](docs/CreateProjectRequest.md)
|
|
107
|
+
- [CreateTaskRequest](docs/CreateTaskRequest.md)
|
|
108
|
+
- [ExportTasks202Response](docs/ExportTasks202Response.md)
|
|
109
|
+
- [Icon](docs/Icon.md)
|
|
110
|
+
- [InstallTemplateRequest](docs/InstallTemplateRequest.md)
|
|
111
|
+
- [Integration](docs/Integration.md)
|
|
112
|
+
- [IntegrationsResponse](docs/IntegrationsResponse.md)
|
|
113
|
+
- [LegacyProjectLogo](docs/LegacyProjectLogo.md)
|
|
114
|
+
- [ListTasksResponse](docs/ListTasksResponse.md)
|
|
115
|
+
- [NullableIcon](docs/NullableIcon.md)
|
|
116
|
+
- [OkrLevel](docs/OkrLevel.md)
|
|
117
|
+
- [Project](docs/Project.md)
|
|
118
|
+
- [ProjectCurrency](docs/ProjectCurrency.md)
|
|
119
|
+
- [ProjectInvite](docs/ProjectInvite.md)
|
|
120
|
+
- [ProjectInvites](docs/ProjectInvites.md)
|
|
121
|
+
- [ProjectLogo](docs/ProjectLogo.md)
|
|
122
|
+
- [ProjectManager](docs/ProjectManager.md)
|
|
123
|
+
- [ProjectPlatform](docs/ProjectPlatform.md)
|
|
124
|
+
- [ProjectUser](docs/ProjectUser.md)
|
|
125
|
+
- [ProjectUserAvatar](docs/ProjectUserAvatar.md)
|
|
126
|
+
- [ProjectUsers](docs/ProjectUsers.md)
|
|
127
|
+
- [ProjectsResponse](docs/ProjectsResponse.md)
|
|
128
|
+
- [Task](docs/Task.md)
|
|
129
|
+
- [TaskStatus](docs/TaskStatus.md)
|
|
130
|
+
- [TaskSummary](docs/TaskSummary.md)
|
|
131
|
+
- [Template](docs/Template.md)
|
|
132
|
+
- [TemplateCode](docs/TemplateCode.md)
|
|
133
|
+
- [TemplatesResponse](docs/TemplatesResponse.md)
|
|
134
|
+
- [UpdateBookmarkRequest](docs/UpdateBookmarkRequest.md)
|
|
135
|
+
- [UpdateBookmarkTabsRequest](docs/UpdateBookmarkTabsRequest.md)
|
|
136
|
+
- [UpdateBookmarkTabsRequestTabsInner](docs/UpdateBookmarkTabsRequestTabsInner.md)
|
|
137
|
+
- [UpdateIntegrationRequest](docs/UpdateIntegrationRequest.md)
|
|
138
|
+
- [UpdateProjectRequest](docs/UpdateProjectRequest.md)
|
|
139
|
+
- [UpdateTaskRequest](docs/UpdateTaskRequest.md)
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<a id="documentation-for-authorization"></a>
|
|
143
|
+
## Documentation For Authorization
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
Authentication schemes defined for the API:
|
|
147
|
+
<a id="api-key"></a>
|
|
148
|
+
### api-key
|
|
149
|
+
|
|
150
|
+
- **Type**: API key
|
|
151
|
+
- **API key parameter name**: Authorization
|
|
152
|
+
- **Location**: HTTP header
|
|
153
|
+
|
|
154
|
+
<a id="session-oauth"></a>
|
|
155
|
+
### session-oauth
|
|
156
|
+
|
|
157
|
+
- **Type**: OAuth
|
|
158
|
+
- **Flow**: password
|
|
159
|
+
- **Authorization URL**:
|
|
160
|
+
- **Scopes**: N/A
|
|
161
|
+
|
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).
|
|
@@ -128,6 +128,18 @@ export interface Bookmark {
|
|
|
128
128
|
* @memberof Bookmark
|
|
129
129
|
*/
|
|
130
130
|
'tabId': string | null;
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @type {number}
|
|
134
|
+
* @memberof Bookmark
|
|
135
|
+
*/
|
|
136
|
+
'sortOrder': number;
|
|
137
|
+
/**
|
|
138
|
+
*
|
|
139
|
+
* @type {number}
|
|
140
|
+
* @memberof Bookmark
|
|
141
|
+
*/
|
|
142
|
+
'tabSortOrder': number;
|
|
131
143
|
}
|
|
132
144
|
/**
|
|
133
145
|
* @type BookmarkData
|
|
@@ -505,6 +517,21 @@ export interface NullableIcon {
|
|
|
505
517
|
*/
|
|
506
518
|
'icon': Array<any>;
|
|
507
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
|
+
|
|
508
535
|
/**
|
|
509
536
|
*
|
|
510
537
|
* @export
|
|
@@ -880,6 +907,18 @@ export interface Task {
|
|
|
880
907
|
* @memberof Task
|
|
881
908
|
*/
|
|
882
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;
|
|
883
922
|
/**
|
|
884
923
|
* The unique id of the user who created the task
|
|
885
924
|
* @type {string}
|
|
@@ -892,6 +931,12 @@ export interface Task {
|
|
|
892
931
|
* @memberof Task
|
|
893
932
|
*/
|
|
894
933
|
'createdAt': string;
|
|
934
|
+
/**
|
|
935
|
+
*
|
|
936
|
+
* @type {string}
|
|
937
|
+
* @memberof Task
|
|
938
|
+
*/
|
|
939
|
+
'updatedAt': string;
|
|
895
940
|
}
|
|
896
941
|
|
|
897
942
|
|
|
@@ -959,12 +1004,30 @@ export interface TaskSummary {
|
|
|
959
1004
|
* @memberof TaskSummary
|
|
960
1005
|
*/
|
|
961
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;
|
|
962
1019
|
/**
|
|
963
1020
|
*
|
|
964
1021
|
* @type {string}
|
|
965
1022
|
* @memberof TaskSummary
|
|
966
1023
|
*/
|
|
967
1024
|
'createdAt': string;
|
|
1025
|
+
/**
|
|
1026
|
+
*
|
|
1027
|
+
* @type {string}
|
|
1028
|
+
* @memberof TaskSummary
|
|
1029
|
+
*/
|
|
1030
|
+
'updatedAt': string;
|
|
968
1031
|
}
|
|
969
1032
|
|
|
970
1033
|
|
|
@@ -1079,6 +1142,18 @@ export interface UpdateBookmarkRequest {
|
|
|
1079
1142
|
* @memberof UpdateBookmarkRequest
|
|
1080
1143
|
*/
|
|
1081
1144
|
'tabId'?: string | null;
|
|
1145
|
+
/**
|
|
1146
|
+
* The sort order of the bookmark in all tab
|
|
1147
|
+
* @type {number}
|
|
1148
|
+
* @memberof UpdateBookmarkRequest
|
|
1149
|
+
*/
|
|
1150
|
+
'sortOrder'?: number | null;
|
|
1151
|
+
/**
|
|
1152
|
+
* The sort order of the bookmark in the custom or favourite tab
|
|
1153
|
+
* @type {number}
|
|
1154
|
+
* @memberof UpdateBookmarkRequest
|
|
1155
|
+
*/
|
|
1156
|
+
'tabSortOrder'?: number | null;
|
|
1082
1157
|
}
|
|
1083
1158
|
/**
|
|
1084
1159
|
*
|
|
@@ -1198,6 +1273,18 @@ export interface UpdateTaskRequest {
|
|
|
1198
1273
|
* @memberof UpdateTaskRequest
|
|
1199
1274
|
*/
|
|
1200
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;
|
|
1201
1288
|
}
|
|
1202
1289
|
|
|
1203
1290
|
|
|
@@ -1688,6 +1775,47 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1688
1775
|
|
|
1689
1776
|
|
|
1690
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
|
+
|
|
1691
1819
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1692
1820
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1693
1821
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2918,6 +3046,19 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
2918
3046
|
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.deleteUser']?.[localVarOperationServerIndex]?.url;
|
|
2919
3047
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2920
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
|
+
},
|
|
2921
3062
|
/**
|
|
2922
3063
|
* Export all the tasks in the workflow
|
|
2923
3064
|
* @summary Export all tasks
|
|
@@ -3361,6 +3502,16 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
3361
3502
|
deleteUser(requestParameters: ProjectsApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
3362
3503
|
return localVarFp.deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(axios, basePath));
|
|
3363
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
|
+
},
|
|
3364
3515
|
/**
|
|
3365
3516
|
* Export all the tasks in the workflow
|
|
3366
3517
|
* @summary Export all tasks
|
|
@@ -3804,6 +3955,20 @@ export interface ProjectsApiDeleteUserRequest {
|
|
|
3804
3955
|
readonly user: string
|
|
3805
3956
|
}
|
|
3806
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
|
+
|
|
3807
3972
|
/**
|
|
3808
3973
|
* Request parameters for exportTasks operation in ProjectsApi.
|
|
3809
3974
|
* @export
|
|
@@ -4433,6 +4598,18 @@ export class ProjectsApi extends BaseAPI {
|
|
|
4433
4598
|
return ProjectsApiFp(this.configuration).deleteUser(requestParameters.project, requestParameters.user, options).then((request) => request(this.axios, this.basePath));
|
|
4434
4599
|
}
|
|
4435
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
|
+
|
|
4436
4613
|
/**
|
|
4437
4614
|
* Export all the tasks in the workflow
|
|
4438
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).
|
|
@@ -118,6 +118,18 @@ export interface Bookmark {
|
|
|
118
118
|
* @memberof Bookmark
|
|
119
119
|
*/
|
|
120
120
|
'tabId': string | null;
|
|
121
|
+
/**
|
|
122
|
+
*
|
|
123
|
+
* @type {number}
|
|
124
|
+
* @memberof Bookmark
|
|
125
|
+
*/
|
|
126
|
+
'sortOrder': number;
|
|
127
|
+
/**
|
|
128
|
+
*
|
|
129
|
+
* @type {number}
|
|
130
|
+
* @memberof Bookmark
|
|
131
|
+
*/
|
|
132
|
+
'tabSortOrder': number;
|
|
121
133
|
}
|
|
122
134
|
/**
|
|
123
135
|
* @type BookmarkData
|
|
@@ -494,6 +506,17 @@ export interface NullableIcon {
|
|
|
494
506
|
*/
|
|
495
507
|
'icon': Array<any>;
|
|
496
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];
|
|
497
520
|
/**
|
|
498
521
|
*
|
|
499
522
|
* @export
|
|
@@ -868,6 +891,18 @@ export interface Task {
|
|
|
868
891
|
* @memberof Task
|
|
869
892
|
*/
|
|
870
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;
|
|
871
906
|
/**
|
|
872
907
|
* The unique id of the user who created the task
|
|
873
908
|
* @type {string}
|
|
@@ -880,6 +915,12 @@ export interface Task {
|
|
|
880
915
|
* @memberof Task
|
|
881
916
|
*/
|
|
882
917
|
'createdAt': string;
|
|
918
|
+
/**
|
|
919
|
+
*
|
|
920
|
+
* @type {string}
|
|
921
|
+
* @memberof Task
|
|
922
|
+
*/
|
|
923
|
+
'updatedAt': string;
|
|
883
924
|
}
|
|
884
925
|
/**
|
|
885
926
|
*
|
|
@@ -941,12 +982,30 @@ export interface TaskSummary {
|
|
|
941
982
|
* @memberof TaskSummary
|
|
942
983
|
*/
|
|
943
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;
|
|
944
997
|
/**
|
|
945
998
|
*
|
|
946
999
|
* @type {string}
|
|
947
1000
|
* @memberof TaskSummary
|
|
948
1001
|
*/
|
|
949
1002
|
'createdAt': string;
|
|
1003
|
+
/**
|
|
1004
|
+
*
|
|
1005
|
+
* @type {string}
|
|
1006
|
+
* @memberof TaskSummary
|
|
1007
|
+
*/
|
|
1008
|
+
'updatedAt': string;
|
|
950
1009
|
}
|
|
951
1010
|
/**
|
|
952
1011
|
*
|
|
@@ -1053,6 +1112,18 @@ export interface UpdateBookmarkRequest {
|
|
|
1053
1112
|
* @memberof UpdateBookmarkRequest
|
|
1054
1113
|
*/
|
|
1055
1114
|
'tabId'?: string | null;
|
|
1115
|
+
/**
|
|
1116
|
+
* The sort order of the bookmark in all tab
|
|
1117
|
+
* @type {number}
|
|
1118
|
+
* @memberof UpdateBookmarkRequest
|
|
1119
|
+
*/
|
|
1120
|
+
'sortOrder'?: number | null;
|
|
1121
|
+
/**
|
|
1122
|
+
* The sort order of the bookmark in the custom or favourite tab
|
|
1123
|
+
* @type {number}
|
|
1124
|
+
* @memberof UpdateBookmarkRequest
|
|
1125
|
+
*/
|
|
1126
|
+
'tabSortOrder'?: number | null;
|
|
1056
1127
|
}
|
|
1057
1128
|
/**
|
|
1058
1129
|
*
|
|
@@ -1172,6 +1243,18 @@ export interface UpdateTaskRequest {
|
|
|
1172
1243
|
* @memberof UpdateTaskRequest
|
|
1173
1244
|
*/
|
|
1174
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;
|
|
1175
1258
|
}
|
|
1176
1259
|
/**
|
|
1177
1260
|
* ProjectsApi - axios parameter creator
|
|
@@ -1274,6 +1357,14 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1274
1357
|
* @throws {RequiredError}
|
|
1275
1358
|
*/
|
|
1276
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>;
|
|
1277
1368
|
/**
|
|
1278
1369
|
* Export all the tasks in the workflow
|
|
1279
1370
|
* @summary Export all tasks
|
|
@@ -1584,6 +1675,14 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
1584
1675
|
* @throws {RequiredError}
|
|
1585
1676
|
*/
|
|
1586
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>>;
|
|
1587
1686
|
/**
|
|
1588
1687
|
* Export all the tasks in the workflow
|
|
1589
1688
|
* @summary Export all tasks
|
|
@@ -1886,6 +1985,14 @@ export declare const ProjectsApiFactory: (configuration?: Configuration, basePat
|
|
|
1886
1985
|
* @throws {RequiredError}
|
|
1887
1986
|
*/
|
|
1888
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>;
|
|
1889
1996
|
/**
|
|
1890
1997
|
* Export all the tasks in the workflow
|
|
1891
1998
|
* @summary Export all tasks
|
|
@@ -2262,6 +2369,19 @@ export interface ProjectsApiDeleteUserRequest {
|
|
|
2262
2369
|
*/
|
|
2263
2370
|
readonly user: string;
|
|
2264
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
|
+
}
|
|
2265
2385
|
/**
|
|
2266
2386
|
* Request parameters for exportTasks operation in ProjectsApi.
|
|
2267
2387
|
* @export
|
|
@@ -2811,6 +2931,15 @@ export declare class ProjectsApi extends BaseAPI {
|
|
|
2811
2931
|
* @memberof ProjectsApi
|
|
2812
2932
|
*/
|
|
2813
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>>;
|
|
2814
2943
|
/**
|
|
2815
2944
|
* Export all the tasks in the workflow
|
|
2816
2945
|
* @summary Export all tasks
|