@taktoria/sdk 0.2.0 → 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.
Files changed (27) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/okr/client/Client.js +6 -3
  3. package/dist/cjs/api/resources/okr/client/requests/GetScorecardRequest.d.ts +5 -0
  4. package/dist/cjs/api/resources/okr/client/requests/GetTeamOkrsRequest.d.ts +5 -0
  5. package/dist/cjs/api/resources/okr/client/requests/ListTeamScoresRequest.d.ts +6 -0
  6. package/dist/cjs/api/resources/okr/types/ScorecardKeyResultRow.d.ts +3 -0
  7. package/dist/cjs/api/resources/okr/types/ScorecardRow.d.ts +3 -0
  8. package/dist/cjs/serialization/resources/okr/types/ScorecardKeyResultRow.d.ts +2 -0
  9. package/dist/cjs/serialization/resources/okr/types/ScorecardKeyResultRow.js +2 -0
  10. package/dist/cjs/serialization/resources/okr/types/ScorecardRow.d.ts +2 -0
  11. package/dist/cjs/serialization/resources/okr/types/ScorecardRow.js +2 -0
  12. package/dist/cjs/version.d.ts +1 -1
  13. package/dist/cjs/version.js +1 -1
  14. package/dist/esm/BaseClient.mjs +2 -2
  15. package/dist/esm/api/resources/okr/client/Client.mjs +6 -3
  16. package/dist/esm/api/resources/okr/client/requests/GetScorecardRequest.d.mts +5 -0
  17. package/dist/esm/api/resources/okr/client/requests/GetTeamOkrsRequest.d.mts +5 -0
  18. package/dist/esm/api/resources/okr/client/requests/ListTeamScoresRequest.d.mts +6 -0
  19. package/dist/esm/api/resources/okr/types/ScorecardKeyResultRow.d.mts +3 -0
  20. package/dist/esm/api/resources/okr/types/ScorecardRow.d.mts +3 -0
  21. package/dist/esm/serialization/resources/okr/types/ScorecardKeyResultRow.d.mts +2 -0
  22. package/dist/esm/serialization/resources/okr/types/ScorecardKeyResultRow.mjs +2 -0
  23. package/dist/esm/serialization/resources/okr/types/ScorecardRow.d.mts +2 -0
  24. package/dist/esm/serialization/resources/okr/types/ScorecardRow.mjs +2 -0
  25. package/dist/esm/version.d.mts +1 -1
  26. package/dist/esm/version.mjs +1 -1
  27. package/package.json +1 -1
@@ -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.2.0",
47
- "User-Agent": "@taktoria/sdk/0.2.0",
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);
@@ -1223,7 +1223,7 @@ class OkrClient {
1223
1223
  __getScorecard() {
1224
1224
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
1225
1225
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
1226
- const { year, teamId, priority, frame, mid } = request;
1226
+ const { year, teamId, priority, tag, frame, mid } = request;
1227
1227
  const _queryParams = {
1228
1228
  year,
1229
1229
  teamId,
@@ -1233,6 +1233,7 @@ class OkrClient {
1233
1233
  omitUndefined: true,
1234
1234
  })
1235
1235
  : undefined,
1236
+ tag,
1236
1237
  frame,
1237
1238
  mid,
1238
1239
  };
@@ -2380,7 +2381,7 @@ class OkrClient {
2380
2381
  __listTeamScores() {
2381
2382
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
2382
2383
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2383
- const { year, quarter, period, q, sort, onlyScored, limit, cursor } = request;
2384
+ const { year, quarter, period, q, sort, onlyScored, tag, limit, cursor } = request;
2384
2385
  const _queryParams = {
2385
2386
  year,
2386
2387
  quarter,
@@ -2393,6 +2394,7 @@ class OkrClient {
2393
2394
  q,
2394
2395
  sort,
2395
2396
  onlyScored,
2397
+ tag,
2396
2398
  limit,
2397
2399
  cursor,
2398
2400
  };
@@ -2489,7 +2491,7 @@ class OkrClient {
2489
2491
  __getTeamOkrs(teamSlug_1) {
2490
2492
  return __awaiter(this, arguments, void 0, function* (teamSlug, request = {}, requestOptions) {
2491
2493
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2492
- const { year, quarter, period } = request;
2494
+ const { year, quarter, period, tag } = request;
2493
2495
  const _queryParams = {
2494
2496
  year,
2495
2497
  quarter,
@@ -2499,6 +2501,7 @@ class OkrClient {
2499
2501
  omitUndefined: true,
2500
2502
  })
2501
2503
  : undefined,
2504
+ tag,
2502
2505
  };
2503
2506
  const _authRequest = yield this._options.authProvider.getAuthRequest();
2504
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);
@@ -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
  }
@@ -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;
@@ -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. */
@@ -8,6 +8,8 @@ export declare namespace ScorecardKeyResultRow {
8
8
  interface Raw {
9
9
  keyResultId: string;
10
10
  title: string;
11
+ description?: string | null;
12
+ tags: string[];
11
13
  priority?: OkrPriority.Raw | null;
12
14
  weight: number;
13
15
  cells: Record<string, ScorecardCell.Raw>;
@@ -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),
@@ -9,6 +9,8 @@ export declare namespace ScorecardRow {
9
9
  interface Raw {
10
10
  objectiveId: string;
11
11
  title: string;
12
+ description?: string | null;
13
+ tags: string[];
12
14
  weight: number;
13
15
  timeframe: ScorecardTimeframe.Raw;
14
16
  cells: Record<string, ScorecardCell.Raw>;
@@ -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),
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.2.0";
1
+ export declare const SDK_VERSION = "0.2.1";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.2.0";
4
+ exports.SDK_VERSION = "0.2.1";
@@ -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.2.0",
10
- "User-Agent": "@taktoria/sdk/0.2.0",
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);
@@ -1187,7 +1187,7 @@ export class OkrClient {
1187
1187
  __getScorecard() {
1188
1188
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
1189
1189
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
1190
- const { year, teamId, priority, frame, mid } = request;
1190
+ const { year, teamId, priority, tag, frame, mid } = request;
1191
1191
  const _queryParams = {
1192
1192
  year,
1193
1193
  teamId,
@@ -1197,6 +1197,7 @@ export class OkrClient {
1197
1197
  omitUndefined: true,
1198
1198
  })
1199
1199
  : undefined,
1200
+ tag,
1200
1201
  frame,
1201
1202
  mid,
1202
1203
  };
@@ -2344,7 +2345,7 @@ export class OkrClient {
2344
2345
  __listTeamScores() {
2345
2346
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
2346
2347
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2347
- const { year, quarter, period, q, sort, onlyScored, limit, cursor } = request;
2348
+ const { year, quarter, period, q, sort, onlyScored, tag, limit, cursor } = request;
2348
2349
  const _queryParams = {
2349
2350
  year,
2350
2351
  quarter,
@@ -2357,6 +2358,7 @@ export class OkrClient {
2357
2358
  q,
2358
2359
  sort,
2359
2360
  onlyScored,
2361
+ tag,
2360
2362
  limit,
2361
2363
  cursor,
2362
2364
  };
@@ -2453,7 +2455,7 @@ export class OkrClient {
2453
2455
  __getTeamOkrs(teamSlug_1) {
2454
2456
  return __awaiter(this, arguments, void 0, function* (teamSlug, request = {}, requestOptions) {
2455
2457
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2456
- const { year, quarter, period } = request;
2458
+ const { year, quarter, period, tag } = request;
2457
2459
  const _queryParams = {
2458
2460
  year,
2459
2461
  quarter,
@@ -2463,6 +2465,7 @@ export class OkrClient {
2463
2465
  omitUndefined: true,
2464
2466
  })
2465
2467
  : undefined,
2468
+ tag,
2466
2469
  };
2467
2470
  const _authRequest = yield this._options.authProvider.getAuthRequest();
2468
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);
@@ -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
  }
@@ -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;
@@ -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. */
@@ -8,6 +8,8 @@ export declare namespace ScorecardKeyResultRow {
8
8
  interface Raw {
9
9
  keyResultId: string;
10
10
  title: string;
11
+ description?: string | null;
12
+ tags: string[];
11
13
  priority?: OkrPriority.Raw | null;
12
14
  weight: number;
13
15
  cells: Record<string, ScorecardCell.Raw>;
@@ -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),
@@ -9,6 +9,8 @@ export declare namespace ScorecardRow {
9
9
  interface Raw {
10
10
  objectiveId: string;
11
11
  title: string;
12
+ description?: string | null;
13
+ tags: string[];
12
14
  weight: number;
13
15
  timeframe: ScorecardTimeframe.Raw;
14
16
  cells: Record<string, ScorecardCell.Raw>;
@@ -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),
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.2.0";
1
+ export declare const SDK_VERSION = "0.2.1";
@@ -1 +1 @@
1
- export const SDK_VERSION = "0.2.0";
1
+ export const SDK_VERSION = "0.2.1";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taktoria/sdk",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "private": false,
5
5
  "type": "commonjs",
6
6
  "main": "./dist/cjs/index.js",