@taktoria/sdk 0.1.6 → 0.2.1
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/okr/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/okr/client/Client.js +14 -6
- package/dist/cjs/api/resources/okr/client/requests/BrowseObjectivesRequest.d.ts +6 -1
- package/dist/cjs/api/resources/okr/client/requests/GetScorecardRequest.d.ts +5 -0
- package/dist/cjs/api/resources/okr/client/requests/GetTeamOkrsRequest.d.ts +5 -0
- package/dist/cjs/api/resources/okr/client/requests/ListMyObjectivesRequest.d.ts +6 -1
- package/dist/cjs/api/resources/okr/client/requests/ListObjectivesRequest.d.ts +6 -1
- package/dist/cjs/api/resources/okr/client/requests/ListTeamScoresRequest.d.ts +6 -0
- package/dist/cjs/api/resources/okr/types/CreateKeyResultRequest.d.ts +6 -1
- package/dist/cjs/api/resources/okr/types/CreateObjectiveRequest.d.ts +9 -2
- package/dist/cjs/api/resources/okr/types/KeyResult.d.ts +7 -0
- package/dist/cjs/api/resources/okr/types/Objective.d.ts +5 -0
- package/dist/cjs/api/resources/okr/types/ScorecardKeyResultRow.d.ts +3 -0
- package/dist/cjs/api/resources/okr/types/ScorecardRow.d.ts +3 -0
- package/dist/cjs/api/resources/okr/types/UpdateKeyResultRequest.d.ts +6 -1
- package/dist/cjs/api/resources/okr/types/UpdateObjectiveRequest.d.ts +5 -1
- package/dist/cjs/serialization/resources/okr/types/CreateKeyResultRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/okr/types/CreateKeyResultRequest.js +2 -0
- package/dist/cjs/serialization/resources/okr/types/CreateObjectiveRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/okr/types/CreateObjectiveRequest.js +1 -0
- package/dist/cjs/serialization/resources/okr/types/KeyResult.d.ts +2 -0
- package/dist/cjs/serialization/resources/okr/types/KeyResult.js +2 -0
- package/dist/cjs/serialization/resources/okr/types/Objective.d.ts +1 -0
- package/dist/cjs/serialization/resources/okr/types/Objective.js +1 -0
- package/dist/cjs/serialization/resources/okr/types/ScorecardKeyResultRow.d.ts +2 -0
- package/dist/cjs/serialization/resources/okr/types/ScorecardKeyResultRow.js +2 -0
- package/dist/cjs/serialization/resources/okr/types/ScorecardRow.d.ts +2 -0
- package/dist/cjs/serialization/resources/okr/types/ScorecardRow.js +2 -0
- package/dist/cjs/serialization/resources/okr/types/UpdateKeyResultRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/okr/types/UpdateKeyResultRequest.js +2 -0
- package/dist/cjs/serialization/resources/okr/types/UpdateObjectiveRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/okr/types/UpdateObjectiveRequest.js +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/okr/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/okr/client/Client.mjs +14 -6
- package/dist/esm/api/resources/okr/client/requests/BrowseObjectivesRequest.d.mts +6 -1
- package/dist/esm/api/resources/okr/client/requests/GetScorecardRequest.d.mts +5 -0
- package/dist/esm/api/resources/okr/client/requests/GetTeamOkrsRequest.d.mts +5 -0
- package/dist/esm/api/resources/okr/client/requests/ListMyObjectivesRequest.d.mts +6 -1
- package/dist/esm/api/resources/okr/client/requests/ListObjectivesRequest.d.mts +6 -1
- package/dist/esm/api/resources/okr/client/requests/ListTeamScoresRequest.d.mts +6 -0
- package/dist/esm/api/resources/okr/types/CreateKeyResultRequest.d.mts +6 -1
- package/dist/esm/api/resources/okr/types/CreateObjectiveRequest.d.mts +9 -2
- package/dist/esm/api/resources/okr/types/KeyResult.d.mts +7 -0
- package/dist/esm/api/resources/okr/types/Objective.d.mts +5 -0
- package/dist/esm/api/resources/okr/types/ScorecardKeyResultRow.d.mts +3 -0
- package/dist/esm/api/resources/okr/types/ScorecardRow.d.mts +3 -0
- package/dist/esm/api/resources/okr/types/UpdateKeyResultRequest.d.mts +6 -1
- package/dist/esm/api/resources/okr/types/UpdateObjectiveRequest.d.mts +5 -1
- package/dist/esm/serialization/resources/okr/types/CreateKeyResultRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/okr/types/CreateKeyResultRequest.mjs +2 -0
- package/dist/esm/serialization/resources/okr/types/CreateObjectiveRequest.d.mts +1 -0
- package/dist/esm/serialization/resources/okr/types/CreateObjectiveRequest.mjs +1 -0
- package/dist/esm/serialization/resources/okr/types/KeyResult.d.mts +2 -0
- package/dist/esm/serialization/resources/okr/types/KeyResult.mjs +2 -0
- package/dist/esm/serialization/resources/okr/types/Objective.d.mts +1 -0
- package/dist/esm/serialization/resources/okr/types/Objective.mjs +1 -0
- package/dist/esm/serialization/resources/okr/types/ScorecardKeyResultRow.d.mts +2 -0
- package/dist/esm/serialization/resources/okr/types/ScorecardKeyResultRow.mjs +2 -0
- package/dist/esm/serialization/resources/okr/types/ScorecardRow.d.mts +2 -0
- package/dist/esm/serialization/resources/okr/types/ScorecardRow.mjs +2 -0
- package/dist/esm/serialization/resources/okr/types/UpdateKeyResultRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/okr/types/UpdateKeyResultRequest.mjs +2 -0
- package/dist/esm/serialization/resources/okr/types/UpdateObjectiveRequest.d.mts +1 -0
- package/dist/esm/serialization/resources/okr/types/UpdateObjectiveRequest.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +2 -0
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "@taktoria/sdk",
|
|
46
|
-
"X-Fern-SDK-Version": "0.1
|
|
47
|
-
"User-Agent": "@taktoria/sdk/0.1
|
|
46
|
+
"X-Fern-SDK-Version": "0.2.1",
|
|
47
|
+
"User-Agent": "@taktoria/sdk/0.2.1",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -55,10 +55,12 @@ export declare class OkrClient {
|
|
|
55
55
|
* @example
|
|
56
56
|
* await client.okr.createObjective({
|
|
57
57
|
* title: "Make onboarding effortless",
|
|
58
|
+
* tags: ["onboarding"],
|
|
58
59
|
* year: 2026,
|
|
59
60
|
* quarter: 3,
|
|
60
61
|
* keyResults: [{
|
|
61
62
|
* title: "Median time to first launch under 10 minutes",
|
|
63
|
+
* tags: ["activation"],
|
|
62
64
|
* priority: "P1"
|
|
63
65
|
* }, {
|
|
64
66
|
* title: "90% of new workspaces invite a second person",
|
|
@@ -83,7 +83,7 @@ class OkrClient {
|
|
|
83
83
|
__listObjectives() {
|
|
84
84
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
85
85
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
86
|
-
const { year, quarter, teamId, ownerUserId, visibility, q, draft, archived, limit, cursor } = request;
|
|
86
|
+
const { year, quarter, teamId, ownerUserId, visibility, tag, q, draft, archived, limit, cursor } = request;
|
|
87
87
|
const _queryParams = {
|
|
88
88
|
year,
|
|
89
89
|
quarter,
|
|
@@ -95,6 +95,7 @@ class OkrClient {
|
|
|
95
95
|
omitUndefined: true,
|
|
96
96
|
})
|
|
97
97
|
: undefined,
|
|
98
|
+
tag,
|
|
98
99
|
q,
|
|
99
100
|
draft,
|
|
100
101
|
archived,
|
|
@@ -190,10 +191,12 @@ class OkrClient {
|
|
|
190
191
|
* @example
|
|
191
192
|
* await client.okr.createObjective({
|
|
192
193
|
* title: "Make onboarding effortless",
|
|
194
|
+
* tags: ["onboarding"],
|
|
193
195
|
* year: 2026,
|
|
194
196
|
* quarter: 3,
|
|
195
197
|
* keyResults: [{
|
|
196
198
|
* title: "Median time to first launch under 10 minutes",
|
|
199
|
+
* tags: ["activation"],
|
|
197
200
|
* priority: "P1"
|
|
198
201
|
* }, {
|
|
199
202
|
* title: "90% of new workspaces invite a second person",
|
|
@@ -1220,7 +1223,7 @@ class OkrClient {
|
|
|
1220
1223
|
__getScorecard() {
|
|
1221
1224
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
1222
1225
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
1223
|
-
const { year, teamId, priority, frame, mid } = request;
|
|
1226
|
+
const { year, teamId, priority, tag, frame, mid } = request;
|
|
1224
1227
|
const _queryParams = {
|
|
1225
1228
|
year,
|
|
1226
1229
|
teamId,
|
|
@@ -1230,6 +1233,7 @@ class OkrClient {
|
|
|
1230
1233
|
omitUndefined: true,
|
|
1231
1234
|
})
|
|
1232
1235
|
: undefined,
|
|
1236
|
+
tag,
|
|
1233
1237
|
frame,
|
|
1234
1238
|
mid,
|
|
1235
1239
|
};
|
|
@@ -2135,7 +2139,7 @@ class OkrClient {
|
|
|
2135
2139
|
__listMyObjectives() {
|
|
2136
2140
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
2137
2141
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2138
|
-
const { year, quarter, period, teamId, priority, includeTeams, q, sort, limit, cursor } = request;
|
|
2142
|
+
const { year, quarter, period, teamId, priority, includeTeams, tag, q, sort, limit, cursor } = request;
|
|
2139
2143
|
const _queryParams = {
|
|
2140
2144
|
year,
|
|
2141
2145
|
quarter,
|
|
@@ -2153,6 +2157,7 @@ class OkrClient {
|
|
|
2153
2157
|
})
|
|
2154
2158
|
: undefined,
|
|
2155
2159
|
includeTeams,
|
|
2160
|
+
tag,
|
|
2156
2161
|
q,
|
|
2157
2162
|
sort,
|
|
2158
2163
|
limit,
|
|
@@ -2259,7 +2264,7 @@ class OkrClient {
|
|
|
2259
2264
|
__browseObjectives() {
|
|
2260
2265
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
2261
2266
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2262
|
-
const { year, quarter, period, allPeriods, teamId, priority, q, sort, limit, cursor } = request;
|
|
2267
|
+
const { year, quarter, period, allPeriods, teamId, priority, tag, q, sort, limit, cursor } = request;
|
|
2263
2268
|
const _queryParams = {
|
|
2264
2269
|
year,
|
|
2265
2270
|
quarter,
|
|
@@ -2277,6 +2282,7 @@ class OkrClient {
|
|
|
2277
2282
|
omitUndefined: true,
|
|
2278
2283
|
})
|
|
2279
2284
|
: undefined,
|
|
2285
|
+
tag,
|
|
2280
2286
|
q,
|
|
2281
2287
|
sort,
|
|
2282
2288
|
limit,
|
|
@@ -2375,7 +2381,7 @@ class OkrClient {
|
|
|
2375
2381
|
__listTeamScores() {
|
|
2376
2382
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
2377
2383
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2378
|
-
const { year, quarter, period, q, sort, onlyScored, limit, cursor } = request;
|
|
2384
|
+
const { year, quarter, period, q, sort, onlyScored, tag, limit, cursor } = request;
|
|
2379
2385
|
const _queryParams = {
|
|
2380
2386
|
year,
|
|
2381
2387
|
quarter,
|
|
@@ -2388,6 +2394,7 @@ class OkrClient {
|
|
|
2388
2394
|
q,
|
|
2389
2395
|
sort,
|
|
2390
2396
|
onlyScored,
|
|
2397
|
+
tag,
|
|
2391
2398
|
limit,
|
|
2392
2399
|
cursor,
|
|
2393
2400
|
};
|
|
@@ -2484,7 +2491,7 @@ class OkrClient {
|
|
|
2484
2491
|
__getTeamOkrs(teamSlug_1) {
|
|
2485
2492
|
return __awaiter(this, arguments, void 0, function* (teamSlug, request = {}, requestOptions) {
|
|
2486
2493
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2487
|
-
const { year, quarter, period } = request;
|
|
2494
|
+
const { year, quarter, period, tag } = request;
|
|
2488
2495
|
const _queryParams = {
|
|
2489
2496
|
year,
|
|
2490
2497
|
quarter,
|
|
@@ -2494,6 +2501,7 @@ class OkrClient {
|
|
|
2494
2501
|
omitUndefined: true,
|
|
2495
2502
|
})
|
|
2496
2503
|
: undefined,
|
|
2504
|
+
tag,
|
|
2497
2505
|
};
|
|
2498
2506
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
2499
2507
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -15,7 +15,12 @@ export interface BrowseObjectivesRequest {
|
|
|
15
15
|
teamId?: string | string[];
|
|
16
16
|
/** Only objectives holding a key result of this priority. */
|
|
17
17
|
priority?: Taktoria.OkrPriority;
|
|
18
|
-
/**
|
|
18
|
+
/**
|
|
19
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
20
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
21
|
+
*/
|
|
22
|
+
tag?: string;
|
|
23
|
+
/** Words in titles, descriptions, tags, key results, owners and teams. See Searching. */
|
|
19
24
|
q?: string;
|
|
20
25
|
/** `order` (the workspace's own, the default), `high` or `low` by score, unscored last. */
|
|
21
26
|
sort?: string;
|
|
@@ -17,6 +17,11 @@ export interface GetScorecardRequest {
|
|
|
17
17
|
* their cells rolled up from those key results alone.
|
|
18
18
|
*/
|
|
19
19
|
priority?: Taktoria.OkrPriority;
|
|
20
|
+
/**
|
|
21
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
22
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
23
|
+
*/
|
|
24
|
+
tag?: string;
|
|
20
25
|
/** `annual`, or a quarter `1` to `4`. Every period when left out. */
|
|
21
26
|
frame?: string | string[];
|
|
22
27
|
/** `false` leaves out the mid-quarter columns. */
|
|
@@ -8,4 +8,9 @@ export interface GetTeamOkrsRequest {
|
|
|
8
8
|
year?: number;
|
|
9
9
|
quarter?: number;
|
|
10
10
|
period?: Taktoria.OkrPeriod;
|
|
11
|
+
/**
|
|
12
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
13
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
14
|
+
*/
|
|
15
|
+
tag?: string;
|
|
11
16
|
}
|
|
@@ -18,7 +18,12 @@ export interface ListMyObjectivesRequest {
|
|
|
18
18
|
priority?: Taktoria.OkrPriority;
|
|
19
19
|
/** `false` for what is theirs in person only, not their teams'. */
|
|
20
20
|
includeTeams?: boolean;
|
|
21
|
-
/**
|
|
21
|
+
/**
|
|
22
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
23
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
24
|
+
*/
|
|
25
|
+
tag?: string;
|
|
26
|
+
/** Words in titles, descriptions, tags, key results, owners and teams. See Searching. */
|
|
22
27
|
q?: string;
|
|
23
28
|
/** `order` (the workspace's own, the default), `high` or `low` by score, unscored last. */
|
|
24
29
|
sort?: string;
|
|
@@ -16,7 +16,12 @@ export interface ListObjectivesRequest {
|
|
|
16
16
|
teamId?: string;
|
|
17
17
|
ownerUserId?: string;
|
|
18
18
|
visibility?: Taktoria.OkrVisibility;
|
|
19
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
21
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
22
|
+
*/
|
|
23
|
+
tag?: string;
|
|
24
|
+
/** Search objectives by their title, description, tags, key results' titles, descriptions and tags, owner's name and team's name, among those the caller may see (a private objective only by those allowed to see it). Every word must appear in one of those fields; case and accents are ignored; at most 100 characters and 8 words. See Searching under Errors and pagination. */
|
|
20
25
|
q?: string;
|
|
21
26
|
/** `true` lists only drafts and `false` only what is published; left out, both. */
|
|
22
27
|
draft?: boolean;
|
|
@@ -16,6 +16,12 @@ export interface ListTeamScoresRequest {
|
|
|
16
16
|
sort?: string;
|
|
17
17
|
/** `true` keeps only the teams with a score. */
|
|
18
18
|
onlyScored?: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* Only teams holding an objective that carries this tag, or a key
|
|
21
|
+
* result that does, each scored on those alone. One word, matched
|
|
22
|
+
* whole.
|
|
23
|
+
*/
|
|
24
|
+
tag?: string;
|
|
19
25
|
/** At most 100; 50 when left out. */
|
|
20
26
|
limit?: number;
|
|
21
27
|
cursor?: string;
|
|
@@ -3,10 +3,15 @@ import type * as Taktoria from "../../../index.js";
|
|
|
3
3
|
* Owners must be members and teams of the workspace; an id from anywhere
|
|
4
4
|
* else is refused with a 422, and `details.unknown` names it: nobody is
|
|
5
5
|
* dropped. The title is trimmed and never blank (at most 500
|
|
6
|
-
* characters).
|
|
6
|
+
* characters). A description (at most 5000) and tags (at most 10, one
|
|
7
|
+
* word each, stored lowercase) are optional, as on an objective.
|
|
7
8
|
*/
|
|
8
9
|
export interface CreateKeyResultRequest {
|
|
9
10
|
title: string;
|
|
11
|
+
/** Optional; trimmed, blank meaning none, at most 5000 characters. */
|
|
12
|
+
description?: string;
|
|
13
|
+
/** Optional, at most 10: one word each, stored lowercase without a leading `#`. */
|
|
14
|
+
tags?: string[];
|
|
10
15
|
/**
|
|
11
16
|
* A first score, 0.0 to 1.0. It is recorded as a check-in by the
|
|
12
17
|
* caller (a key's maker, for a key), as setting one later is.
|
|
@@ -3,8 +3,12 @@ import type * as Taktoria from "../../../index.js";
|
|
|
3
3
|
* The same rules as the dashboard's forms and the MCP server's tools:
|
|
4
4
|
*
|
|
5
5
|
* - `title` is trimmed, and a 422 if nothing is left (at most 500
|
|
6
|
-
* characters); `description` is trimmed, blank meaning
|
|
7
|
-
* 5000).
|
|
6
|
+
* characters); `description` is optional, trimmed, blank meaning
|
|
7
|
+
* none (at most 5000).
|
|
8
|
+
* - `tags` are optional: at most 10, each one word of letters, digits,
|
|
9
|
+
* `-` or `_`, at most 32 characters. They are stored lowercase, without
|
|
10
|
+
* a leading `#`, each once; anything else is a 422 naming the tag in
|
|
11
|
+
* `details.tag`.
|
|
8
12
|
* - `year` is a fiscal year from 2000 to 2100, and `weight` from 0.01 to
|
|
9
13
|
* 100: there is no weight of 0, which the rollup never treated as
|
|
10
14
|
* "not counted".
|
|
@@ -26,7 +30,10 @@ import type * as Taktoria from "../../../index.js";
|
|
|
26
30
|
export interface CreateObjectiveRequest {
|
|
27
31
|
/** Trimmed; never blank, at most 500 characters. */
|
|
28
32
|
title: string;
|
|
33
|
+
/** Optional; trimmed, blank meaning none, at most 5000 characters. */
|
|
29
34
|
description?: string;
|
|
35
|
+
/** Optional, at most 10: one word each, stored lowercase without a leading `#`. */
|
|
36
|
+
tags?: string[];
|
|
30
37
|
period?: Taktoria.OkrPeriod;
|
|
31
38
|
/** The fiscal year, 2000 to 2100. */
|
|
32
39
|
year: number;
|
|
@@ -8,6 +8,13 @@ export interface KeyResult {
|
|
|
8
8
|
id: string;
|
|
9
9
|
objectiveId: string;
|
|
10
10
|
title: string;
|
|
11
|
+
/** What it means and how it is measured, if anybody said. Absent when none. */
|
|
12
|
+
description?: string;
|
|
13
|
+
/**
|
|
14
|
+
* Its tags, A to Z: free text, one lowercase word each (letters,
|
|
15
|
+
* digits, `-` and `_`), at most 10. Filter by one with `tag`.
|
|
16
|
+
*/
|
|
17
|
+
tags: string[];
|
|
11
18
|
/**
|
|
12
19
|
* Google-style grade from 0.0 to 1.0, or absent until it has been
|
|
13
20
|
* scored. 0.7 and up is delivered for an ambitious goal, 0.4 to 0.7
|
|
@@ -7,6 +7,11 @@ export interface Objective {
|
|
|
7
7
|
organizationId: string;
|
|
8
8
|
title: string;
|
|
9
9
|
description?: string;
|
|
10
|
+
/**
|
|
11
|
+
* Its tags, A to Z: free text, one lowercase word each (letters,
|
|
12
|
+
* digits, `-` and `_`), at most 10. Filter by one with `tag`.
|
|
13
|
+
*/
|
|
14
|
+
tags: string[];
|
|
10
15
|
period: Taktoria.OkrPeriod;
|
|
11
16
|
/** The fiscal year, 2000 to 2100, named by the year its Q1 falls in. */
|
|
12
17
|
year: number;
|
|
@@ -2,6 +2,9 @@ import type * as Taktoria from "../../../index.js";
|
|
|
2
2
|
export interface ScorecardKeyResultRow {
|
|
3
3
|
keyResultId: string;
|
|
4
4
|
title: string;
|
|
5
|
+
description?: string;
|
|
6
|
+
/** Its tags, A to Z. */
|
|
7
|
+
tags: string[];
|
|
5
8
|
priority?: Taktoria.OkrPriority;
|
|
6
9
|
weight: number;
|
|
7
10
|
cells: Record<string, Taktoria.ScorecardCell>;
|
|
@@ -5,6 +5,9 @@ import type * as Taktoria from "../../../index.js";
|
|
|
5
5
|
export interface ScorecardRow {
|
|
6
6
|
objectiveId: string;
|
|
7
7
|
title: string;
|
|
8
|
+
description?: string;
|
|
9
|
+
/** Its tags, A to Z. */
|
|
10
|
+
tags: string[];
|
|
8
11
|
weight: number;
|
|
9
12
|
timeframe: Taktoria.ScorecardTimeframe;
|
|
10
13
|
/** Rolled up from its key results, by weight. */
|
|
@@ -5,10 +5,15 @@ import type * as Taktoria from "../../../index.js";
|
|
|
5
5
|
* Anybody new on it must be a member or team of this workspace (a 422
|
|
6
6
|
* naming them in `details.unknown`); an owner already on it who has
|
|
7
7
|
* since left may stay. The title is trimmed and never blank; the weight
|
|
8
|
-
* is 0.01 to 100.
|
|
8
|
+
* is 0.01 to 100. `tags` sent replace the ones it had, so `[]` removes
|
|
9
|
+
* them all.
|
|
9
10
|
*/
|
|
10
11
|
export interface UpdateKeyResultRequest {
|
|
11
12
|
title?: string;
|
|
13
|
+
/** Blank or `null` removes it. */
|
|
14
|
+
description?: string;
|
|
15
|
+
/** Replaces its tags; `[]` removes them all. */
|
|
16
|
+
tags?: string[];
|
|
12
17
|
/**
|
|
13
18
|
* A new score, 0.0 to 1.0, is recorded as a check-in with no note,
|
|
14
19
|
* by the caller (a key's maker, for a key), and the activity feed
|
|
@@ -7,11 +7,15 @@ import type * as Taktoria from "../../../index.js";
|
|
|
7
7
|
* as on create; the owner it already has may stay, even if they have
|
|
8
8
|
* since left. The fields sent meet the same rules as on create: a title
|
|
9
9
|
* trimmed and never blank, a year from 2000 to 2100, a weight from 0.01
|
|
10
|
-
* to 100.
|
|
10
|
+
* to 100, tags one word each. `tags` sent replace the ones it had, so
|
|
11
|
+
* `[]` removes them all; left out, they stay.
|
|
11
12
|
*/
|
|
12
13
|
export interface UpdateObjectiveRequest {
|
|
13
14
|
title?: string;
|
|
15
|
+
/** Blank or `null` removes it. */
|
|
14
16
|
description?: string;
|
|
17
|
+
/** Replaces its tags; `[]` removes them all. */
|
|
18
|
+
tags?: string[];
|
|
15
19
|
period?: Taktoria.OkrPeriod;
|
|
16
20
|
year?: number;
|
|
17
21
|
quarter?: number;
|
|
@@ -6,6 +6,8 @@ export declare const CreateKeyResultRequest: core.serialization.ObjectSchema<ser
|
|
|
6
6
|
export declare namespace CreateKeyResultRequest {
|
|
7
7
|
interface Raw {
|
|
8
8
|
title: string;
|
|
9
|
+
description?: string | null;
|
|
10
|
+
tags?: string[] | null;
|
|
9
11
|
score?: number | null;
|
|
10
12
|
weight?: number | null;
|
|
11
13
|
priority?: OkrPriority.Raw | null;
|
|
@@ -39,6 +39,8 @@ const core = __importStar(require("../../../../core/index.js"));
|
|
|
39
39
|
const OkrPriority_js_1 = require("./OkrPriority.js");
|
|
40
40
|
exports.CreateKeyResultRequest = core.serialization.object({
|
|
41
41
|
title: core.serialization.string(),
|
|
42
|
+
description: core.serialization.string().optional(),
|
|
43
|
+
tags: core.serialization.list(core.serialization.string()).optional(),
|
|
42
44
|
score: core.serialization.number().optional(),
|
|
43
45
|
weight: core.serialization.number().optional(),
|
|
44
46
|
priority: OkrPriority_js_1.OkrPriority.optional(),
|
|
@@ -42,6 +42,7 @@ const OkrVisibility_js_1 = require("./OkrVisibility.js");
|
|
|
42
42
|
exports.CreateObjectiveRequest = core.serialization.object({
|
|
43
43
|
title: core.serialization.string(),
|
|
44
44
|
description: core.serialization.string().optional(),
|
|
45
|
+
tags: core.serialization.list(core.serialization.string()).optional(),
|
|
45
46
|
period: OkrPeriod_js_1.OkrPeriod.optional(),
|
|
46
47
|
year: core.serialization.number(),
|
|
47
48
|
quarter: core.serialization.number().optional(),
|
|
@@ -42,6 +42,8 @@ exports.KeyResult = core.serialization.object({
|
|
|
42
42
|
id: core.serialization.string(),
|
|
43
43
|
objectiveId: core.serialization.string(),
|
|
44
44
|
title: core.serialization.string(),
|
|
45
|
+
description: core.serialization.string().optional(),
|
|
46
|
+
tags: core.serialization.list(core.serialization.string()),
|
|
45
47
|
score: core.serialization.number().optional(),
|
|
46
48
|
weight: core.serialization.number(),
|
|
47
49
|
priority: OkrPriority_js_1.OkrPriority,
|
|
@@ -46,6 +46,7 @@ exports.Objective = core.serialization.object({
|
|
|
46
46
|
organizationId: core.serialization.string(),
|
|
47
47
|
title: core.serialization.string(),
|
|
48
48
|
description: core.serialization.string().optional(),
|
|
49
|
+
tags: core.serialization.list(core.serialization.string()),
|
|
49
50
|
period: OkrPeriod_js_1.OkrPeriod,
|
|
50
51
|
year: core.serialization.number(),
|
|
51
52
|
quarter: core.serialization.number().optional(),
|
|
@@ -41,6 +41,8 @@ const ScorecardCell_js_1 = require("./ScorecardCell.js");
|
|
|
41
41
|
exports.ScorecardKeyResultRow = core.serialization.object({
|
|
42
42
|
keyResultId: core.serialization.string(),
|
|
43
43
|
title: core.serialization.string(),
|
|
44
|
+
description: core.serialization.string().optional(),
|
|
45
|
+
tags: core.serialization.list(core.serialization.string()),
|
|
44
46
|
priority: OkrPriority_js_1.OkrPriority.optional(),
|
|
45
47
|
weight: core.serialization.number(),
|
|
46
48
|
cells: core.serialization.record(core.serialization.string(), ScorecardCell_js_1.ScorecardCell),
|
|
@@ -42,6 +42,8 @@ const ScorecardTimeframe_js_1 = require("./ScorecardTimeframe.js");
|
|
|
42
42
|
exports.ScorecardRow = core.serialization.object({
|
|
43
43
|
objectiveId: core.serialization.string(),
|
|
44
44
|
title: core.serialization.string(),
|
|
45
|
+
description: core.serialization.string().optional(),
|
|
46
|
+
tags: core.serialization.list(core.serialization.string()),
|
|
45
47
|
weight: core.serialization.number(),
|
|
46
48
|
timeframe: ScorecardTimeframe_js_1.ScorecardTimeframe,
|
|
47
49
|
cells: core.serialization.record(core.serialization.string(), ScorecardCell_js_1.ScorecardCell),
|
|
@@ -6,6 +6,8 @@ export declare const UpdateKeyResultRequest: core.serialization.ObjectSchema<ser
|
|
|
6
6
|
export declare namespace UpdateKeyResultRequest {
|
|
7
7
|
interface Raw {
|
|
8
8
|
title?: string | null;
|
|
9
|
+
description?: string | null;
|
|
10
|
+
tags?: string[] | null;
|
|
9
11
|
score?: number | null;
|
|
10
12
|
weight?: number | null;
|
|
11
13
|
priority?: OkrPriority.Raw | null;
|
|
@@ -39,6 +39,8 @@ const core = __importStar(require("../../../../core/index.js"));
|
|
|
39
39
|
const OkrPriority_js_1 = require("./OkrPriority.js");
|
|
40
40
|
exports.UpdateKeyResultRequest = core.serialization.object({
|
|
41
41
|
title: core.serialization.string().optional(),
|
|
42
|
+
description: core.serialization.string().optional(),
|
|
43
|
+
tags: core.serialization.list(core.serialization.string()).optional(),
|
|
42
44
|
score: core.serialization.number().optional(),
|
|
43
45
|
weight: core.serialization.number().optional(),
|
|
44
46
|
priority: OkrPriority_js_1.OkrPriority.optional(),
|
|
@@ -41,6 +41,7 @@ const OkrVisibility_js_1 = require("./OkrVisibility.js");
|
|
|
41
41
|
exports.UpdateObjectiveRequest = core.serialization.object({
|
|
42
42
|
title: core.serialization.string().optional(),
|
|
43
43
|
description: core.serialization.string().optional(),
|
|
44
|
+
tags: core.serialization.list(core.serialization.string()).optional(),
|
|
44
45
|
period: OkrPeriod_js_1.OkrPeriod.optional(),
|
|
45
46
|
year: core.serialization.number().optional(),
|
|
46
47
|
quarter: core.serialization.number().optional(),
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.1
|
|
1
|
+
export declare const SDK_VERSION = "0.2.1";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@taktoria/sdk",
|
|
9
|
-
"X-Fern-SDK-Version": "0.1
|
|
10
|
-
"User-Agent": "@taktoria/sdk/0.1
|
|
9
|
+
"X-Fern-SDK-Version": "0.2.1",
|
|
10
|
+
"User-Agent": "@taktoria/sdk/0.2.1",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -55,10 +55,12 @@ export declare class OkrClient {
|
|
|
55
55
|
* @example
|
|
56
56
|
* await client.okr.createObjective({
|
|
57
57
|
* title: "Make onboarding effortless",
|
|
58
|
+
* tags: ["onboarding"],
|
|
58
59
|
* year: 2026,
|
|
59
60
|
* quarter: 3,
|
|
60
61
|
* keyResults: [{
|
|
61
62
|
* title: "Median time to first launch under 10 minutes",
|
|
63
|
+
* tags: ["activation"],
|
|
62
64
|
* priority: "P1"
|
|
63
65
|
* }, {
|
|
64
66
|
* title: "90% of new workspaces invite a second person",
|
|
@@ -47,7 +47,7 @@ export class OkrClient {
|
|
|
47
47
|
__listObjectives() {
|
|
48
48
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
49
49
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
50
|
-
const { year, quarter, teamId, ownerUserId, visibility, q, draft, archived, limit, cursor } = request;
|
|
50
|
+
const { year, quarter, teamId, ownerUserId, visibility, tag, q, draft, archived, limit, cursor } = request;
|
|
51
51
|
const _queryParams = {
|
|
52
52
|
year,
|
|
53
53
|
quarter,
|
|
@@ -59,6 +59,7 @@ export class OkrClient {
|
|
|
59
59
|
omitUndefined: true,
|
|
60
60
|
})
|
|
61
61
|
: undefined,
|
|
62
|
+
tag,
|
|
62
63
|
q,
|
|
63
64
|
draft,
|
|
64
65
|
archived,
|
|
@@ -154,10 +155,12 @@ export class OkrClient {
|
|
|
154
155
|
* @example
|
|
155
156
|
* await client.okr.createObjective({
|
|
156
157
|
* title: "Make onboarding effortless",
|
|
158
|
+
* tags: ["onboarding"],
|
|
157
159
|
* year: 2026,
|
|
158
160
|
* quarter: 3,
|
|
159
161
|
* keyResults: [{
|
|
160
162
|
* title: "Median time to first launch under 10 minutes",
|
|
163
|
+
* tags: ["activation"],
|
|
161
164
|
* priority: "P1"
|
|
162
165
|
* }, {
|
|
163
166
|
* title: "90% of new workspaces invite a second person",
|
|
@@ -1184,7 +1187,7 @@ export class OkrClient {
|
|
|
1184
1187
|
__getScorecard() {
|
|
1185
1188
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
1186
1189
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
1187
|
-
const { year, teamId, priority, frame, mid } = request;
|
|
1190
|
+
const { year, teamId, priority, tag, frame, mid } = request;
|
|
1188
1191
|
const _queryParams = {
|
|
1189
1192
|
year,
|
|
1190
1193
|
teamId,
|
|
@@ -1194,6 +1197,7 @@ export class OkrClient {
|
|
|
1194
1197
|
omitUndefined: true,
|
|
1195
1198
|
})
|
|
1196
1199
|
: undefined,
|
|
1200
|
+
tag,
|
|
1197
1201
|
frame,
|
|
1198
1202
|
mid,
|
|
1199
1203
|
};
|
|
@@ -2099,7 +2103,7 @@ export class OkrClient {
|
|
|
2099
2103
|
__listMyObjectives() {
|
|
2100
2104
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
2101
2105
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2102
|
-
const { year, quarter, period, teamId, priority, includeTeams, q, sort, limit, cursor } = request;
|
|
2106
|
+
const { year, quarter, period, teamId, priority, includeTeams, tag, q, sort, limit, cursor } = request;
|
|
2103
2107
|
const _queryParams = {
|
|
2104
2108
|
year,
|
|
2105
2109
|
quarter,
|
|
@@ -2117,6 +2121,7 @@ export class OkrClient {
|
|
|
2117
2121
|
})
|
|
2118
2122
|
: undefined,
|
|
2119
2123
|
includeTeams,
|
|
2124
|
+
tag,
|
|
2120
2125
|
q,
|
|
2121
2126
|
sort,
|
|
2122
2127
|
limit,
|
|
@@ -2223,7 +2228,7 @@ export class OkrClient {
|
|
|
2223
2228
|
__browseObjectives() {
|
|
2224
2229
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
2225
2230
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2226
|
-
const { year, quarter, period, allPeriods, teamId, priority, q, sort, limit, cursor } = request;
|
|
2231
|
+
const { year, quarter, period, allPeriods, teamId, priority, tag, q, sort, limit, cursor } = request;
|
|
2227
2232
|
const _queryParams = {
|
|
2228
2233
|
year,
|
|
2229
2234
|
quarter,
|
|
@@ -2241,6 +2246,7 @@ export class OkrClient {
|
|
|
2241
2246
|
omitUndefined: true,
|
|
2242
2247
|
})
|
|
2243
2248
|
: undefined,
|
|
2249
|
+
tag,
|
|
2244
2250
|
q,
|
|
2245
2251
|
sort,
|
|
2246
2252
|
limit,
|
|
@@ -2339,7 +2345,7 @@ export class OkrClient {
|
|
|
2339
2345
|
__listTeamScores() {
|
|
2340
2346
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
2341
2347
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2342
|
-
const { year, quarter, period, q, sort, onlyScored, limit, cursor } = request;
|
|
2348
|
+
const { year, quarter, period, q, sort, onlyScored, tag, limit, cursor } = request;
|
|
2343
2349
|
const _queryParams = {
|
|
2344
2350
|
year,
|
|
2345
2351
|
quarter,
|
|
@@ -2352,6 +2358,7 @@ export class OkrClient {
|
|
|
2352
2358
|
q,
|
|
2353
2359
|
sort,
|
|
2354
2360
|
onlyScored,
|
|
2361
|
+
tag,
|
|
2355
2362
|
limit,
|
|
2356
2363
|
cursor,
|
|
2357
2364
|
};
|
|
@@ -2448,7 +2455,7 @@ export class OkrClient {
|
|
|
2448
2455
|
__getTeamOkrs(teamSlug_1) {
|
|
2449
2456
|
return __awaiter(this, arguments, void 0, function* (teamSlug, request = {}, requestOptions) {
|
|
2450
2457
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
2451
|
-
const { year, quarter, period } = request;
|
|
2458
|
+
const { year, quarter, period, tag } = request;
|
|
2452
2459
|
const _queryParams = {
|
|
2453
2460
|
year,
|
|
2454
2461
|
quarter,
|
|
@@ -2458,6 +2465,7 @@ export class OkrClient {
|
|
|
2458
2465
|
omitUndefined: true,
|
|
2459
2466
|
})
|
|
2460
2467
|
: undefined,
|
|
2468
|
+
tag,
|
|
2461
2469
|
};
|
|
2462
2470
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
2463
2471
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
@@ -15,7 +15,12 @@ export interface BrowseObjectivesRequest {
|
|
|
15
15
|
teamId?: string | string[];
|
|
16
16
|
/** Only objectives holding a key result of this priority. */
|
|
17
17
|
priority?: Taktoria.OkrPriority;
|
|
18
|
-
/**
|
|
18
|
+
/**
|
|
19
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
20
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
21
|
+
*/
|
|
22
|
+
tag?: string;
|
|
23
|
+
/** Words in titles, descriptions, tags, key results, owners and teams. See Searching. */
|
|
19
24
|
q?: string;
|
|
20
25
|
/** `order` (the workspace's own, the default), `high` or `low` by score, unscored last. */
|
|
21
26
|
sort?: string;
|
|
@@ -17,6 +17,11 @@ export interface GetScorecardRequest {
|
|
|
17
17
|
* their cells rolled up from those key results alone.
|
|
18
18
|
*/
|
|
19
19
|
priority?: Taktoria.OkrPriority;
|
|
20
|
+
/**
|
|
21
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
22
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
23
|
+
*/
|
|
24
|
+
tag?: string;
|
|
20
25
|
/** `annual`, or a quarter `1` to `4`. Every period when left out. */
|
|
21
26
|
frame?: string | string[];
|
|
22
27
|
/** `false` leaves out the mid-quarter columns. */
|
|
@@ -8,4 +8,9 @@ export interface GetTeamOkrsRequest {
|
|
|
8
8
|
year?: number;
|
|
9
9
|
quarter?: number;
|
|
10
10
|
period?: Taktoria.OkrPeriod;
|
|
11
|
+
/**
|
|
12
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
13
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
14
|
+
*/
|
|
15
|
+
tag?: string;
|
|
11
16
|
}
|
|
@@ -18,7 +18,12 @@ export interface ListMyObjectivesRequest {
|
|
|
18
18
|
priority?: Taktoria.OkrPriority;
|
|
19
19
|
/** `false` for what is theirs in person only, not their teams'. */
|
|
20
20
|
includeTeams?: boolean;
|
|
21
|
-
/**
|
|
21
|
+
/**
|
|
22
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
23
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
24
|
+
*/
|
|
25
|
+
tag?: string;
|
|
26
|
+
/** Words in titles, descriptions, tags, key results, owners and teams. See Searching. */
|
|
22
27
|
q?: string;
|
|
23
28
|
/** `order` (the workspace's own, the default), `high` or `low` by score, unscored last. */
|
|
24
29
|
sort?: string;
|
|
@@ -16,7 +16,12 @@ export interface ListObjectivesRequest {
|
|
|
16
16
|
teamId?: string;
|
|
17
17
|
ownerUserId?: string;
|
|
18
18
|
visibility?: Taktoria.OkrVisibility;
|
|
19
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* Only objectives carrying this tag, or holding a key result that
|
|
21
|
+
* does. One word, matched whole; case and a leading `#` are ignored.
|
|
22
|
+
*/
|
|
23
|
+
tag?: string;
|
|
24
|
+
/** Search objectives by their title, description, tags, key results' titles, descriptions and tags, owner's name and team's name, among those the caller may see (a private objective only by those allowed to see it). Every word must appear in one of those fields; case and accents are ignored; at most 100 characters and 8 words. See Searching under Errors and pagination. */
|
|
20
25
|
q?: string;
|
|
21
26
|
/** `true` lists only drafts and `false` only what is published; left out, both. */
|
|
22
27
|
draft?: boolean;
|
|
@@ -16,6 +16,12 @@ export interface ListTeamScoresRequest {
|
|
|
16
16
|
sort?: string;
|
|
17
17
|
/** `true` keeps only the teams with a score. */
|
|
18
18
|
onlyScored?: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* Only teams holding an objective that carries this tag, or a key
|
|
21
|
+
* result that does, each scored on those alone. One word, matched
|
|
22
|
+
* whole.
|
|
23
|
+
*/
|
|
24
|
+
tag?: string;
|
|
19
25
|
/** At most 100; 50 when left out. */
|
|
20
26
|
limit?: number;
|
|
21
27
|
cursor?: string;
|
|
@@ -3,10 +3,15 @@ import type * as Taktoria from "../../../index.mjs";
|
|
|
3
3
|
* Owners must be members and teams of the workspace; an id from anywhere
|
|
4
4
|
* else is refused with a 422, and `details.unknown` names it: nobody is
|
|
5
5
|
* dropped. The title is trimmed and never blank (at most 500
|
|
6
|
-
* characters).
|
|
6
|
+
* characters). A description (at most 5000) and tags (at most 10, one
|
|
7
|
+
* word each, stored lowercase) are optional, as on an objective.
|
|
7
8
|
*/
|
|
8
9
|
export interface CreateKeyResultRequest {
|
|
9
10
|
title: string;
|
|
11
|
+
/** Optional; trimmed, blank meaning none, at most 5000 characters. */
|
|
12
|
+
description?: string;
|
|
13
|
+
/** Optional, at most 10: one word each, stored lowercase without a leading `#`. */
|
|
14
|
+
tags?: string[];
|
|
10
15
|
/**
|
|
11
16
|
* A first score, 0.0 to 1.0. It is recorded as a check-in by the
|
|
12
17
|
* caller (a key's maker, for a key), as setting one later is.
|
|
@@ -3,8 +3,12 @@ import type * as Taktoria from "../../../index.mjs";
|
|
|
3
3
|
* The same rules as the dashboard's forms and the MCP server's tools:
|
|
4
4
|
*
|
|
5
5
|
* - `title` is trimmed, and a 422 if nothing is left (at most 500
|
|
6
|
-
* characters); `description` is trimmed, blank meaning
|
|
7
|
-
* 5000).
|
|
6
|
+
* characters); `description` is optional, trimmed, blank meaning
|
|
7
|
+
* none (at most 5000).
|
|
8
|
+
* - `tags` are optional: at most 10, each one word of letters, digits,
|
|
9
|
+
* `-` or `_`, at most 32 characters. They are stored lowercase, without
|
|
10
|
+
* a leading `#`, each once; anything else is a 422 naming the tag in
|
|
11
|
+
* `details.tag`.
|
|
8
12
|
* - `year` is a fiscal year from 2000 to 2100, and `weight` from 0.01 to
|
|
9
13
|
* 100: there is no weight of 0, which the rollup never treated as
|
|
10
14
|
* "not counted".
|
|
@@ -26,7 +30,10 @@ import type * as Taktoria from "../../../index.mjs";
|
|
|
26
30
|
export interface CreateObjectiveRequest {
|
|
27
31
|
/** Trimmed; never blank, at most 500 characters. */
|
|
28
32
|
title: string;
|
|
33
|
+
/** Optional; trimmed, blank meaning none, at most 5000 characters. */
|
|
29
34
|
description?: string;
|
|
35
|
+
/** Optional, at most 10: one word each, stored lowercase without a leading `#`. */
|
|
36
|
+
tags?: string[];
|
|
30
37
|
period?: Taktoria.OkrPeriod;
|
|
31
38
|
/** The fiscal year, 2000 to 2100. */
|
|
32
39
|
year: number;
|
|
@@ -8,6 +8,13 @@ export interface KeyResult {
|
|
|
8
8
|
id: string;
|
|
9
9
|
objectiveId: string;
|
|
10
10
|
title: string;
|
|
11
|
+
/** What it means and how it is measured, if anybody said. Absent when none. */
|
|
12
|
+
description?: string;
|
|
13
|
+
/**
|
|
14
|
+
* Its tags, A to Z: free text, one lowercase word each (letters,
|
|
15
|
+
* digits, `-` and `_`), at most 10. Filter by one with `tag`.
|
|
16
|
+
*/
|
|
17
|
+
tags: string[];
|
|
11
18
|
/**
|
|
12
19
|
* Google-style grade from 0.0 to 1.0, or absent until it has been
|
|
13
20
|
* scored. 0.7 and up is delivered for an ambitious goal, 0.4 to 0.7
|
|
@@ -7,6 +7,11 @@ export interface Objective {
|
|
|
7
7
|
organizationId: string;
|
|
8
8
|
title: string;
|
|
9
9
|
description?: string;
|
|
10
|
+
/**
|
|
11
|
+
* Its tags, A to Z: free text, one lowercase word each (letters,
|
|
12
|
+
* digits, `-` and `_`), at most 10. Filter by one with `tag`.
|
|
13
|
+
*/
|
|
14
|
+
tags: string[];
|
|
10
15
|
period: Taktoria.OkrPeriod;
|
|
11
16
|
/** The fiscal year, 2000 to 2100, named by the year its Q1 falls in. */
|
|
12
17
|
year: number;
|
|
@@ -2,6 +2,9 @@ import type * as Taktoria from "../../../index.mjs";
|
|
|
2
2
|
export interface ScorecardKeyResultRow {
|
|
3
3
|
keyResultId: string;
|
|
4
4
|
title: string;
|
|
5
|
+
description?: string;
|
|
6
|
+
/** Its tags, A to Z. */
|
|
7
|
+
tags: string[];
|
|
5
8
|
priority?: Taktoria.OkrPriority;
|
|
6
9
|
weight: number;
|
|
7
10
|
cells: Record<string, Taktoria.ScorecardCell>;
|
|
@@ -5,6 +5,9 @@ import type * as Taktoria from "../../../index.mjs";
|
|
|
5
5
|
export interface ScorecardRow {
|
|
6
6
|
objectiveId: string;
|
|
7
7
|
title: string;
|
|
8
|
+
description?: string;
|
|
9
|
+
/** Its tags, A to Z. */
|
|
10
|
+
tags: string[];
|
|
8
11
|
weight: number;
|
|
9
12
|
timeframe: Taktoria.ScorecardTimeframe;
|
|
10
13
|
/** Rolled up from its key results, by weight. */
|
|
@@ -5,10 +5,15 @@ import type * as Taktoria from "../../../index.mjs";
|
|
|
5
5
|
* Anybody new on it must be a member or team of this workspace (a 422
|
|
6
6
|
* naming them in `details.unknown`); an owner already on it who has
|
|
7
7
|
* since left may stay. The title is trimmed and never blank; the weight
|
|
8
|
-
* is 0.01 to 100.
|
|
8
|
+
* is 0.01 to 100. `tags` sent replace the ones it had, so `[]` removes
|
|
9
|
+
* them all.
|
|
9
10
|
*/
|
|
10
11
|
export interface UpdateKeyResultRequest {
|
|
11
12
|
title?: string;
|
|
13
|
+
/** Blank or `null` removes it. */
|
|
14
|
+
description?: string;
|
|
15
|
+
/** Replaces its tags; `[]` removes them all. */
|
|
16
|
+
tags?: string[];
|
|
12
17
|
/**
|
|
13
18
|
* A new score, 0.0 to 1.0, is recorded as a check-in with no note,
|
|
14
19
|
* by the caller (a key's maker, for a key), and the activity feed
|
|
@@ -7,11 +7,15 @@ import type * as Taktoria from "../../../index.mjs";
|
|
|
7
7
|
* as on create; the owner it already has may stay, even if they have
|
|
8
8
|
* since left. The fields sent meet the same rules as on create: a title
|
|
9
9
|
* trimmed and never blank, a year from 2000 to 2100, a weight from 0.01
|
|
10
|
-
* to 100.
|
|
10
|
+
* to 100, tags one word each. `tags` sent replace the ones it had, so
|
|
11
|
+
* `[]` removes them all; left out, they stay.
|
|
11
12
|
*/
|
|
12
13
|
export interface UpdateObjectiveRequest {
|
|
13
14
|
title?: string;
|
|
15
|
+
/** Blank or `null` removes it. */
|
|
14
16
|
description?: string;
|
|
17
|
+
/** Replaces its tags; `[]` removes them all. */
|
|
18
|
+
tags?: string[];
|
|
15
19
|
period?: Taktoria.OkrPeriod;
|
|
16
20
|
year?: number;
|
|
17
21
|
quarter?: number;
|
|
@@ -6,6 +6,8 @@ export declare const CreateKeyResultRequest: core.serialization.ObjectSchema<ser
|
|
|
6
6
|
export declare namespace CreateKeyResultRequest {
|
|
7
7
|
interface Raw {
|
|
8
8
|
title: string;
|
|
9
|
+
description?: string | null;
|
|
10
|
+
tags?: string[] | null;
|
|
9
11
|
score?: number | null;
|
|
10
12
|
weight?: number | null;
|
|
11
13
|
priority?: OkrPriority.Raw | null;
|
|
@@ -3,6 +3,8 @@ import * as core from "../../../../core/index.mjs";
|
|
|
3
3
|
import { OkrPriority } from "./OkrPriority.mjs";
|
|
4
4
|
export const CreateKeyResultRequest = core.serialization.object({
|
|
5
5
|
title: core.serialization.string(),
|
|
6
|
+
description: core.serialization.string().optional(),
|
|
7
|
+
tags: core.serialization.list(core.serialization.string()).optional(),
|
|
6
8
|
score: core.serialization.number().optional(),
|
|
7
9
|
weight: core.serialization.number().optional(),
|
|
8
10
|
priority: OkrPriority.optional(),
|
|
@@ -6,6 +6,7 @@ import { OkrVisibility } from "./OkrVisibility.mjs";
|
|
|
6
6
|
export const CreateObjectiveRequest = core.serialization.object({
|
|
7
7
|
title: core.serialization.string(),
|
|
8
8
|
description: core.serialization.string().optional(),
|
|
9
|
+
tags: core.serialization.list(core.serialization.string()).optional(),
|
|
9
10
|
period: OkrPeriod.optional(),
|
|
10
11
|
year: core.serialization.number(),
|
|
11
12
|
quarter: core.serialization.number().optional(),
|
|
@@ -6,6 +6,8 @@ export const KeyResult = core.serialization.object({
|
|
|
6
6
|
id: core.serialization.string(),
|
|
7
7
|
objectiveId: core.serialization.string(),
|
|
8
8
|
title: core.serialization.string(),
|
|
9
|
+
description: core.serialization.string().optional(),
|
|
10
|
+
tags: core.serialization.list(core.serialization.string()),
|
|
9
11
|
score: core.serialization.number().optional(),
|
|
10
12
|
weight: core.serialization.number(),
|
|
11
13
|
priority: OkrPriority,
|
|
@@ -10,6 +10,7 @@ export const Objective = core.serialization.object({
|
|
|
10
10
|
organizationId: core.serialization.string(),
|
|
11
11
|
title: core.serialization.string(),
|
|
12
12
|
description: core.serialization.string().optional(),
|
|
13
|
+
tags: core.serialization.list(core.serialization.string()),
|
|
13
14
|
period: OkrPeriod,
|
|
14
15
|
year: core.serialization.number(),
|
|
15
16
|
quarter: core.serialization.number().optional(),
|
|
@@ -5,6 +5,8 @@ import { ScorecardCell } from "./ScorecardCell.mjs";
|
|
|
5
5
|
export const ScorecardKeyResultRow = core.serialization.object({
|
|
6
6
|
keyResultId: core.serialization.string(),
|
|
7
7
|
title: core.serialization.string(),
|
|
8
|
+
description: core.serialization.string().optional(),
|
|
9
|
+
tags: core.serialization.list(core.serialization.string()),
|
|
8
10
|
priority: OkrPriority.optional(),
|
|
9
11
|
weight: core.serialization.number(),
|
|
10
12
|
cells: core.serialization.record(core.serialization.string(), ScorecardCell),
|
|
@@ -6,6 +6,8 @@ import { ScorecardTimeframe } from "./ScorecardTimeframe.mjs";
|
|
|
6
6
|
export const ScorecardRow = core.serialization.object({
|
|
7
7
|
objectiveId: core.serialization.string(),
|
|
8
8
|
title: core.serialization.string(),
|
|
9
|
+
description: core.serialization.string().optional(),
|
|
10
|
+
tags: core.serialization.list(core.serialization.string()),
|
|
9
11
|
weight: core.serialization.number(),
|
|
10
12
|
timeframe: ScorecardTimeframe,
|
|
11
13
|
cells: core.serialization.record(core.serialization.string(), ScorecardCell),
|
|
@@ -6,6 +6,8 @@ export declare const UpdateKeyResultRequest: core.serialization.ObjectSchema<ser
|
|
|
6
6
|
export declare namespace UpdateKeyResultRequest {
|
|
7
7
|
interface Raw {
|
|
8
8
|
title?: string | null;
|
|
9
|
+
description?: string | null;
|
|
10
|
+
tags?: string[] | null;
|
|
9
11
|
score?: number | null;
|
|
10
12
|
weight?: number | null;
|
|
11
13
|
priority?: OkrPriority.Raw | null;
|
|
@@ -3,6 +3,8 @@ import * as core from "../../../../core/index.mjs";
|
|
|
3
3
|
import { OkrPriority } from "./OkrPriority.mjs";
|
|
4
4
|
export const UpdateKeyResultRequest = core.serialization.object({
|
|
5
5
|
title: core.serialization.string().optional(),
|
|
6
|
+
description: core.serialization.string().optional(),
|
|
7
|
+
tags: core.serialization.list(core.serialization.string()).optional(),
|
|
6
8
|
score: core.serialization.number().optional(),
|
|
7
9
|
weight: core.serialization.number().optional(),
|
|
8
10
|
priority: OkrPriority.optional(),
|
|
@@ -5,6 +5,7 @@ import { OkrVisibility } from "./OkrVisibility.mjs";
|
|
|
5
5
|
export const UpdateObjectiveRequest = core.serialization.object({
|
|
6
6
|
title: core.serialization.string().optional(),
|
|
7
7
|
description: core.serialization.string().optional(),
|
|
8
|
+
tags: core.serialization.list(core.serialization.string()).optional(),
|
|
8
9
|
period: OkrPeriod.optional(),
|
|
9
10
|
year: core.serialization.number().optional(),
|
|
10
11
|
quarter: core.serialization.number().optional(),
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.1
|
|
1
|
+
export declare const SDK_VERSION = "0.2.1";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "0.1
|
|
1
|
+
export const SDK_VERSION = "0.2.1";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -7633,10 +7633,12 @@ under the name of whoever made the key.
|
|
|
7633
7633
|
```typescript
|
|
7634
7634
|
await client.okr.createObjective({
|
|
7635
7635
|
title: "Make onboarding effortless",
|
|
7636
|
+
tags: ["onboarding"],
|
|
7636
7637
|
year: 2026,
|
|
7637
7638
|
quarter: 3,
|
|
7638
7639
|
keyResults: [{
|
|
7639
7640
|
title: "Median time to first launch under 10 minutes",
|
|
7641
|
+
tags: ["activation"],
|
|
7640
7642
|
priority: "P1"
|
|
7641
7643
|
}, {
|
|
7642
7644
|
title: "90% of new workspaces invite a second person",
|