@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/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).
|
|
@@ -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
|
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/ApiError.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ApiError } from '@teemill/projects';
|
|
15
|
+
|
|
16
|
+
const instance: ApiError = {
|
|
17
|
+
code,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|