@taktoria/sdk 0.1.0 → 0.1.2
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/Client.d.ts +3 -0
- package/dist/cjs/Client.js +7 -2
- package/dist/cjs/api/resources/artifacts/client/Client.d.ts +14 -6
- package/dist/cjs/api/resources/artifacts/client/Client.js +16 -7
- package/dist/cjs/api/resources/artifacts/client/requests/ListAllArtifactsRequest.d.ts +13 -1
- package/dist/cjs/api/resources/dory/client/Client.d.ts +28 -5
- package/dist/cjs/api/resources/dory/client/Client.js +86 -5
- package/dist/cjs/api/resources/dory/types/CreateEventRequest.d.ts +9 -4
- package/dist/cjs/api/resources/dory/types/EventCalendarInvite.d.ts +41 -0
- package/dist/cjs/api/resources/dory/types/EventCalendarInvite.js +3 -0
- package/dist/cjs/api/resources/dory/types/UpdateEventRequest.d.ts +9 -4
- package/dist/cjs/api/resources/dory/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/dory/types/index.js +1 -0
- package/dist/cjs/api/resources/index.d.ts +3 -0
- package/dist/cjs/api/resources/index.js +4 -1
- package/dist/cjs/api/resources/insights/client/Client.js +2 -1
- package/dist/cjs/api/resources/insights/client/requests/ListInsightsRequest.d.ts +12 -1
- package/dist/cjs/api/resources/launches/client/Client.d.ts +29 -13
- package/dist/cjs/api/resources/launches/client/Client.js +48 -14
- package/dist/cjs/api/resources/launches/client/requests/ListLaunchesRequest.d.ts +25 -1
- package/dist/cjs/api/resources/launches/types/LaunchActivityVerb.d.ts +3 -0
- package/dist/cjs/api/resources/launches/types/LaunchActivityVerb.js +3 -0
- package/dist/cjs/api/resources/launches/types/LinkTicketingProjectRequest.d.ts +2 -2
- package/dist/cjs/api/resources/launches/types/SyncTicketingProjectResponse.d.ts +1 -1
- package/dist/cjs/api/resources/launches/types/TicketingProject.d.ts +13 -7
- package/dist/cjs/api/resources/okr/client/Client.d.ts +8 -0
- package/dist/cjs/api/resources/okr/client/Client.js +8 -0
- package/dist/cjs/api/resources/okr/types/KeyResult.d.ts +13 -0
- package/dist/cjs/api/resources/okr/types/KeyResultMetric.d.ts +12 -0
- package/dist/cjs/api/resources/okr/types/KeyResultMetric.js +3 -0
- package/dist/cjs/api/resources/okr/types/MetricSourceKind.d.ts +10 -0
- package/dist/cjs/api/resources/okr/types/MetricSourceKind.js +13 -0
- package/dist/cjs/api/resources/okr/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/okr/types/index.js +2 -0
- package/dist/cjs/api/resources/organization/client/Client.d.ts +5 -2
- package/dist/cjs/api/resources/organization/client/Client.js +5 -2
- package/dist/cjs/api/resources/organization/types/Organization.d.ts +21 -0
- package/dist/cjs/api/resources/organization/types/UpdateOrganizationRequest.d.ts +15 -0
- package/dist/cjs/api/resources/platform/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/platform/client/Client.js +2 -2
- package/dist/cjs/api/resources/platform/types/NotificationChannels.d.ts +7 -2
- package/dist/cjs/api/resources/platform/types/UpdateNotificationChannels.d.ts +1 -0
- package/dist/cjs/api/resources/platform/types/UpdateNotificationPreferencesRequest.d.ts +1 -1
- package/dist/cjs/api/resources/platform/types/WaitingForSeat.d.ts +2 -2
- package/dist/cjs/api/resources/posts/client/Client.d.ts +5 -2
- package/dist/cjs/api/resources/posts/client/Client.js +13 -2
- package/dist/cjs/api/resources/posts/types/LaunchPost.d.ts +4 -3
- package/dist/cjs/api/resources/slackConnections/client/Client.d.ts +56 -0
- package/dist/cjs/api/resources/slackConnections/client/Client.js +243 -0
- package/dist/cjs/api/resources/slackConnections/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/slackConnections/client/index.js +17 -0
- package/dist/cjs/api/resources/slackConnections/client/requests/ListSlackConnectionsRequest.d.ts +9 -0
- package/dist/cjs/api/resources/slackConnections/client/requests/ListSlackConnectionsRequest.js +3 -0
- package/dist/cjs/api/resources/slackConnections/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/slackConnections/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/slackConnections/exports.d.ts +2 -0
- package/dist/cjs/api/resources/slackConnections/exports.js +21 -0
- package/dist/cjs/api/resources/slackConnections/index.d.ts +2 -0
- package/dist/cjs/api/resources/slackConnections/index.js +18 -0
- package/dist/cjs/api/resources/slackConnections/types/SlackConnection.d.ts +16 -0
- package/dist/cjs/api/resources/slackConnections/types/SlackConnection.js +3 -0
- package/dist/cjs/api/resources/slackConnections/types/SlackConnectionAccount.d.ts +15 -0
- package/dist/cjs/api/resources/slackConnections/types/SlackConnectionAccount.js +3 -0
- package/dist/cjs/api/resources/slackConnections/types/SlackConnectionPage.d.ts +7 -0
- package/dist/cjs/api/resources/slackConnections/types/SlackConnectionPage.js +3 -0
- package/dist/cjs/api/resources/slackConnections/types/SlackConnectionPerson.d.ts +7 -0
- package/dist/cjs/api/resources/slackConnections/types/SlackConnectionPerson.js +3 -0
- package/dist/cjs/api/resources/slackConnections/types/index.d.ts +4 -0
- package/dist/cjs/api/resources/slackConnections/types/index.js +20 -0
- package/dist/cjs/api/resources/steps/client/Client.d.ts +15 -9
- package/dist/cjs/api/resources/steps/client/Client.js +17 -10
- package/dist/cjs/api/resources/steps/client/requests/ListReviewsRequest.d.ts +12 -1
- package/dist/cjs/api/resources/steps/types/NudgeReason.d.ts +10 -0
- package/dist/cjs/api/resources/steps/types/NudgeReason.js +13 -0
- package/dist/cjs/api/resources/steps/types/NudgeResponse.d.ts +11 -1
- package/dist/cjs/api/resources/steps/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/steps/types/index.js +1 -0
- package/dist/cjs/serialization/resources/dory/types/EventCalendarInvite.d.ts +20 -0
- package/dist/cjs/serialization/resources/dory/types/EventCalendarInvite.js +52 -0
- package/dist/cjs/serialization/resources/dory/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/dory/types/index.js +1 -0
- package/dist/cjs/serialization/resources/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/index.js +3 -1
- package/dist/cjs/serialization/resources/launches/types/LaunchActivityVerb.d.ts +1 -1
- package/dist/cjs/serialization/resources/launches/types/LaunchActivityVerb.js +1 -0
- package/dist/cjs/serialization/resources/okr/types/KeyResult.d.ts +3 -0
- package/dist/cjs/serialization/resources/okr/types/KeyResult.js +3 -0
- package/dist/cjs/serialization/resources/okr/types/KeyResultMetric.d.ts +12 -0
- package/dist/cjs/serialization/resources/okr/types/KeyResultMetric.js +44 -0
- package/dist/cjs/serialization/resources/okr/types/MetricSourceKind.d.ts +7 -0
- package/dist/cjs/serialization/resources/okr/types/MetricSourceKind.js +39 -0
- package/dist/cjs/serialization/resources/okr/types/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/okr/types/index.js +2 -0
- package/dist/cjs/serialization/resources/organization/types/Organization.d.ts +2 -0
- package/dist/cjs/serialization/resources/organization/types/Organization.js +2 -0
- package/dist/cjs/serialization/resources/organization/types/UpdateOrganizationRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/organization/types/UpdateOrganizationRequest.js +2 -0
- package/dist/cjs/serialization/resources/platform/types/NotificationChannels.d.ts +1 -0
- package/dist/cjs/serialization/resources/platform/types/NotificationChannels.js +1 -0
- package/dist/cjs/serialization/resources/platform/types/UpdateNotificationChannels.d.ts +1 -0
- package/dist/cjs/serialization/resources/platform/types/UpdateNotificationChannels.js +1 -0
- package/dist/cjs/serialization/resources/slackConnections/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/slackConnections/index.js +17 -0
- package/dist/cjs/serialization/resources/slackConnections/types/SlackConnection.d.ts +14 -0
- package/dist/cjs/serialization/resources/slackConnections/types/SlackConnection.js +46 -0
- package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionAccount.d.ts +11 -0
- package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionAccount.js +43 -0
- package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionPage.d.ts +12 -0
- package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionPage.js +44 -0
- package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionPerson.d.ts +10 -0
- package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionPerson.js +42 -0
- package/dist/cjs/serialization/resources/slackConnections/types/index.d.ts +4 -0
- package/dist/cjs/serialization/resources/slackConnections/types/index.js +20 -0
- package/dist/cjs/serialization/resources/steps/types/NudgeReason.d.ts +7 -0
- package/dist/cjs/serialization/resources/steps/types/NudgeReason.js +39 -0
- package/dist/cjs/serialization/resources/steps/types/NudgeResponse.d.ts +7 -1
- package/dist/cjs/serialization/resources/steps/types/NudgeResponse.js +7 -1
- package/dist/cjs/serialization/resources/steps/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/steps/types/index.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/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +5 -0
- package/dist/esm/api/resources/artifacts/client/Client.d.mts +14 -6
- package/dist/esm/api/resources/artifacts/client/Client.mjs +16 -7
- package/dist/esm/api/resources/artifacts/client/requests/ListAllArtifactsRequest.d.mts +13 -1
- package/dist/esm/api/resources/dory/client/Client.d.mts +28 -5
- package/dist/esm/api/resources/dory/client/Client.mjs +86 -5
- package/dist/esm/api/resources/dory/types/CreateEventRequest.d.mts +9 -4
- package/dist/esm/api/resources/dory/types/EventCalendarInvite.d.mts +41 -0
- package/dist/esm/api/resources/dory/types/EventCalendarInvite.mjs +2 -0
- package/dist/esm/api/resources/dory/types/UpdateEventRequest.d.mts +9 -4
- package/dist/esm/api/resources/dory/types/index.d.mts +1 -0
- package/dist/esm/api/resources/dory/types/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +3 -0
- package/dist/esm/api/resources/index.mjs +3 -0
- package/dist/esm/api/resources/insights/client/Client.mjs +2 -1
- package/dist/esm/api/resources/insights/client/requests/ListInsightsRequest.d.mts +12 -1
- package/dist/esm/api/resources/launches/client/Client.d.mts +29 -13
- package/dist/esm/api/resources/launches/client/Client.mjs +48 -14
- package/dist/esm/api/resources/launches/client/requests/ListLaunchesRequest.d.mts +25 -1
- package/dist/esm/api/resources/launches/types/LaunchActivityVerb.d.mts +3 -0
- package/dist/esm/api/resources/launches/types/LaunchActivityVerb.mjs +3 -0
- package/dist/esm/api/resources/launches/types/LinkTicketingProjectRequest.d.mts +2 -2
- package/dist/esm/api/resources/launches/types/SyncTicketingProjectResponse.d.mts +1 -1
- package/dist/esm/api/resources/launches/types/TicketingProject.d.mts +13 -7
- package/dist/esm/api/resources/okr/client/Client.d.mts +8 -0
- package/dist/esm/api/resources/okr/client/Client.mjs +8 -0
- package/dist/esm/api/resources/okr/types/KeyResult.d.mts +13 -0
- package/dist/esm/api/resources/okr/types/KeyResultMetric.d.mts +12 -0
- package/dist/esm/api/resources/okr/types/KeyResultMetric.mjs +2 -0
- package/dist/esm/api/resources/okr/types/MetricSourceKind.d.mts +10 -0
- package/dist/esm/api/resources/okr/types/MetricSourceKind.mjs +10 -0
- package/dist/esm/api/resources/okr/types/index.d.mts +2 -0
- package/dist/esm/api/resources/okr/types/index.mjs +2 -0
- package/dist/esm/api/resources/organization/client/Client.d.mts +5 -2
- package/dist/esm/api/resources/organization/client/Client.mjs +5 -2
- package/dist/esm/api/resources/organization/types/Organization.d.mts +21 -0
- package/dist/esm/api/resources/organization/types/UpdateOrganizationRequest.d.mts +15 -0
- package/dist/esm/api/resources/platform/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/platform/client/Client.mjs +2 -2
- package/dist/esm/api/resources/platform/types/NotificationChannels.d.mts +7 -2
- package/dist/esm/api/resources/platform/types/UpdateNotificationChannels.d.mts +1 -0
- package/dist/esm/api/resources/platform/types/UpdateNotificationPreferencesRequest.d.mts +1 -1
- package/dist/esm/api/resources/platform/types/WaitingForSeat.d.mts +2 -2
- package/dist/esm/api/resources/posts/client/Client.d.mts +5 -2
- package/dist/esm/api/resources/posts/client/Client.mjs +13 -2
- package/dist/esm/api/resources/posts/types/LaunchPost.d.mts +4 -3
- package/dist/esm/api/resources/slackConnections/client/Client.d.mts +56 -0
- package/dist/esm/api/resources/slackConnections/client/Client.mjs +206 -0
- package/dist/esm/api/resources/slackConnections/client/index.d.mts +1 -0
- package/dist/esm/api/resources/slackConnections/client/index.mjs +1 -0
- package/dist/esm/api/resources/slackConnections/client/requests/ListSlackConnectionsRequest.d.mts +9 -0
- package/dist/esm/api/resources/slackConnections/client/requests/ListSlackConnectionsRequest.mjs +2 -0
- package/dist/esm/api/resources/slackConnections/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/slackConnections/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/slackConnections/exports.d.mts +2 -0
- package/dist/esm/api/resources/slackConnections/exports.mjs +3 -0
- package/dist/esm/api/resources/slackConnections/index.d.mts +2 -0
- package/dist/esm/api/resources/slackConnections/index.mjs +2 -0
- package/dist/esm/api/resources/slackConnections/types/SlackConnection.d.mts +16 -0
- package/dist/esm/api/resources/slackConnections/types/SlackConnection.mjs +2 -0
- package/dist/esm/api/resources/slackConnections/types/SlackConnectionAccount.d.mts +15 -0
- package/dist/esm/api/resources/slackConnections/types/SlackConnectionAccount.mjs +2 -0
- package/dist/esm/api/resources/slackConnections/types/SlackConnectionPage.d.mts +7 -0
- package/dist/esm/api/resources/slackConnections/types/SlackConnectionPage.mjs +2 -0
- package/dist/esm/api/resources/slackConnections/types/SlackConnectionPerson.d.mts +7 -0
- package/dist/esm/api/resources/slackConnections/types/SlackConnectionPerson.mjs +2 -0
- package/dist/esm/api/resources/slackConnections/types/index.d.mts +4 -0
- package/dist/esm/api/resources/slackConnections/types/index.mjs +4 -0
- package/dist/esm/api/resources/steps/client/Client.d.mts +15 -9
- package/dist/esm/api/resources/steps/client/Client.mjs +17 -10
- package/dist/esm/api/resources/steps/client/requests/ListReviewsRequest.d.mts +12 -1
- package/dist/esm/api/resources/steps/types/NudgeReason.d.mts +10 -0
- package/dist/esm/api/resources/steps/types/NudgeReason.mjs +10 -0
- package/dist/esm/api/resources/steps/types/NudgeResponse.d.mts +11 -1
- package/dist/esm/api/resources/steps/types/index.d.mts +1 -0
- package/dist/esm/api/resources/steps/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/dory/types/EventCalendarInvite.d.mts +20 -0
- package/dist/esm/serialization/resources/dory/types/EventCalendarInvite.mjs +16 -0
- package/dist/esm/serialization/resources/dory/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/dory/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/index.d.mts +2 -0
- package/dist/esm/serialization/resources/index.mjs +2 -0
- package/dist/esm/serialization/resources/launches/types/LaunchActivityVerb.d.mts +1 -1
- package/dist/esm/serialization/resources/launches/types/LaunchActivityVerb.mjs +1 -0
- package/dist/esm/serialization/resources/okr/types/KeyResult.d.mts +3 -0
- package/dist/esm/serialization/resources/okr/types/KeyResult.mjs +3 -0
- package/dist/esm/serialization/resources/okr/types/KeyResultMetric.d.mts +12 -0
- package/dist/esm/serialization/resources/okr/types/KeyResultMetric.mjs +8 -0
- package/dist/esm/serialization/resources/okr/types/MetricSourceKind.d.mts +7 -0
- package/dist/esm/serialization/resources/okr/types/MetricSourceKind.mjs +3 -0
- package/dist/esm/serialization/resources/okr/types/index.d.mts +2 -0
- package/dist/esm/serialization/resources/okr/types/index.mjs +2 -0
- package/dist/esm/serialization/resources/organization/types/Organization.d.mts +2 -0
- package/dist/esm/serialization/resources/organization/types/Organization.mjs +2 -0
- package/dist/esm/serialization/resources/organization/types/UpdateOrganizationRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/organization/types/UpdateOrganizationRequest.mjs +2 -0
- package/dist/esm/serialization/resources/platform/types/NotificationChannels.d.mts +1 -0
- package/dist/esm/serialization/resources/platform/types/NotificationChannels.mjs +1 -0
- package/dist/esm/serialization/resources/platform/types/UpdateNotificationChannels.d.mts +1 -0
- package/dist/esm/serialization/resources/platform/types/UpdateNotificationChannels.mjs +1 -0
- package/dist/esm/serialization/resources/slackConnections/index.d.mts +1 -0
- package/dist/esm/serialization/resources/slackConnections/index.mjs +1 -0
- package/dist/esm/serialization/resources/slackConnections/types/SlackConnection.d.mts +14 -0
- package/dist/esm/serialization/resources/slackConnections/types/SlackConnection.mjs +10 -0
- package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionAccount.d.mts +11 -0
- package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionAccount.mjs +7 -0
- package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionPage.d.mts +12 -0
- package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionPage.mjs +8 -0
- package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionPerson.d.mts +10 -0
- package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionPerson.mjs +6 -0
- package/dist/esm/serialization/resources/slackConnections/types/index.d.mts +4 -0
- package/dist/esm/serialization/resources/slackConnections/types/index.mjs +4 -0
- package/dist/esm/serialization/resources/steps/types/NudgeReason.d.mts +7 -0
- package/dist/esm/serialization/resources/steps/types/NudgeReason.mjs +3 -0
- package/dist/esm/serialization/resources/steps/types/NudgeResponse.d.mts +7 -1
- package/dist/esm/serialization/resources/steps/types/NudgeResponse.mjs +7 -1
- package/dist/esm/serialization/resources/steps/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/steps/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +13 -1
- package/reference.md +285 -39
|
@@ -61,6 +61,9 @@ export * from "./process/types/index.mjs";
|
|
|
61
61
|
export * from "./search/client/requests/index.mjs";
|
|
62
62
|
export * as search from "./search/index.mjs";
|
|
63
63
|
export * from "./search/types/index.mjs";
|
|
64
|
+
export * from "./slackConnections/client/requests/index.mjs";
|
|
65
|
+
export * as slackConnections from "./slackConnections/index.mjs";
|
|
66
|
+
export * from "./slackConnections/types/index.mjs";
|
|
64
67
|
export * from "./steps/client/requests/index.mjs";
|
|
65
68
|
export * as steps from "./steps/index.mjs";
|
|
66
69
|
export * from "./steps/types/index.mjs";
|
|
@@ -41,7 +41,7 @@ export class InsightsClient {
|
|
|
41
41
|
__listAll() {
|
|
42
42
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
43
43
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
44
|
-
const { sentiment, year, quarter, limit, cursor } = request;
|
|
44
|
+
const { sentiment, period, year, quarter, limit, cursor } = request;
|
|
45
45
|
const _queryParams = {
|
|
46
46
|
sentiment: sentiment != null
|
|
47
47
|
? serializers.Sentiment.jsonOrThrow(sentiment, {
|
|
@@ -49,6 +49,7 @@ export class InsightsClient {
|
|
|
49
49
|
omitUndefined: true,
|
|
50
50
|
})
|
|
51
51
|
: undefined,
|
|
52
|
+
period,
|
|
52
53
|
year,
|
|
53
54
|
quarter,
|
|
54
55
|
limit,
|
|
@@ -5,7 +5,18 @@ import type * as Taktoria from "../../../../index.mjs";
|
|
|
5
5
|
*/
|
|
6
6
|
export interface ListInsightsRequest {
|
|
7
7
|
sentiment?: Taktoria.Sentiment;
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* A fiscal period, as the app's period picker and its URL name them:
|
|
10
|
+
* a quarter (`2026-Q4`), a whole year (`2027`), `upcoming` for this
|
|
11
|
+
* quarter and every one after it, or `all`. Repeat it for several
|
|
12
|
+
* (`period=2026-Q4&period=2027-Q1`); `upcoming` or `all` among them
|
|
13
|
+
* wins over the rest. Narrows by when each was recorded in the
|
|
14
|
+
* workspace's fiscal years. Left out, with no `year`, every period.
|
|
15
|
+
* Wins over `year` and `quarter`; anything else is a `422
|
|
16
|
+
* validation_error`.
|
|
17
|
+
*/
|
|
18
|
+
period?: string | string[];
|
|
19
|
+
/** One fiscal year, as the workspace's fiscal year start names it. Narrows by when each was recorded; left out, every year. `period` takes several. */
|
|
9
20
|
year?: number;
|
|
10
21
|
/** A fiscal quarter, 1 to 4, of `year`. Needs `year`; left out, the whole year. */
|
|
11
22
|
quarter?: number;
|
|
@@ -13,8 +13,11 @@ export declare class LaunchesClient {
|
|
|
13
13
|
/**
|
|
14
14
|
* List the launches in your organization, or with `mine=true` your own,
|
|
15
15
|
* the ones the app's My launches page counts as yours. Drafts included,
|
|
16
|
-
* by planned launch date. Every period unless `
|
|
17
|
-
* the app's lists open on this quarter and later
|
|
16
|
+
* by planned launch date. Every period unless `period` (or `year`)
|
|
17
|
+
* narrows it, where the app's lists open on this quarter and later:
|
|
18
|
+
* `period=upcoming` lists what they do. With `launched=true` it is the
|
|
19
|
+
* Launched page instead: launches that have launched, newest first,
|
|
20
|
+
* with the periods going by when each launched. Needs `launches:read`.
|
|
18
21
|
*
|
|
19
22
|
* @param {Taktoria.ListLaunchesRequest} request
|
|
20
23
|
* @param {LaunchesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -38,7 +41,8 @@ export declare class LaunchesClient {
|
|
|
38
41
|
* Add a launch. With a `plannedLaunchDate` it gets its launch template's
|
|
39
42
|
* steps at once, which is what fills each reviewer's queue; pass
|
|
40
43
|
* `generateSteps: false` to leave them off. Pass `draft: true` to save it
|
|
41
|
-
* without telling anybody.
|
|
44
|
+
* without telling anybody. A draft with `status: LAUNCHED` is
|
|
45
|
+
* `409 draft`: publish it, then launch it.
|
|
42
46
|
*
|
|
43
47
|
* @param {Taktoria.CreateLaunchRequest} request
|
|
44
48
|
* @param {LaunchesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -46,6 +50,7 @@ export declare class LaunchesClient {
|
|
|
46
50
|
* @throws {@link Taktoria.UnauthorizedError}
|
|
47
51
|
* @throws {@link Taktoria.SubscriptionRequiredError}
|
|
48
52
|
* @throws {@link Taktoria.ForbiddenError}
|
|
53
|
+
* @throws {@link Taktoria.ConflictError}
|
|
49
54
|
* @throws {@link Taktoria.ValidationError}
|
|
50
55
|
* @throws {@link Taktoria.TooManyRequestsError}
|
|
51
56
|
* @throws {@link errors.TaktoriaError}
|
|
@@ -77,7 +82,9 @@ export declare class LaunchesClient {
|
|
|
77
82
|
* and from what, about ten minutes after the edits stop, in one message
|
|
78
83
|
* that leaves out each owner's own edits (`launchUpdates` in their
|
|
79
84
|
* notification preferences). Its artifacts and links count too; its
|
|
80
|
-
* steps do not, and nothing is sent about a draft.
|
|
85
|
+
* steps do not, and nothing is sent about a draft. `409 launched` when
|
|
86
|
+
* `draft: true` would take a launched launch back to being a draft, and
|
|
87
|
+
* `409 draft` when the change would leave a draft `LAUNCHED`.
|
|
81
88
|
*
|
|
82
89
|
* @param {string} launchId
|
|
83
90
|
* @param {Taktoria.UpdateLaunchRequest} request
|
|
@@ -86,6 +93,7 @@ export declare class LaunchesClient {
|
|
|
86
93
|
* @throws {@link Taktoria.BadRequestError}
|
|
87
94
|
* @throws {@link Taktoria.ForbiddenError}
|
|
88
95
|
* @throws {@link Taktoria.NotFoundError}
|
|
96
|
+
* @throws {@link Taktoria.ConflictError}
|
|
89
97
|
* @throws {@link Taktoria.ValidationError}
|
|
90
98
|
* @throws {@link Taktoria.TooManyRequestsError}
|
|
91
99
|
* @throws {@link errors.TaktoriaError}
|
|
@@ -142,9 +150,15 @@ export declare class LaunchesClient {
|
|
|
142
150
|
* sites, in the GitHub organization the app is installed on, or in its
|
|
143
151
|
* Asana or ClickUp workspaces), and syncs at once: the answer's
|
|
144
152
|
* `ticketingProject` says how that went. Any other address, a whole
|
|
145
|
-
* Jira project
|
|
146
|
-
* does not sync. It reads the system,
|
|
147
|
-
* budget with a sync.
|
|
153
|
+
* Jira project, a GitHub repository, or a ClickUp folder or space
|
|
154
|
+
* included, is kept as a link and does not sync. It reads the system,
|
|
155
|
+
* so it shares the `ticketing-sync` budget with a sync. `404 not_found`
|
|
156
|
+
* when the connection cannot find or see the project, `409 conflict`
|
|
157
|
+
* for one in another workspace or site of the system than the one
|
|
158
|
+
* connected, `409 ticketing_reconnect` when the system turned the
|
|
159
|
+
* connection down (a workspace admin connects it again in Settings →
|
|
160
|
+
* Integrations), and `502 upstream_error` when it did not answer.
|
|
161
|
+
* Needs `launches:write`.
|
|
148
162
|
*
|
|
149
163
|
* @param {string} launchId
|
|
150
164
|
* @param {Taktoria.LinkTicketingProjectRequest} request
|
|
@@ -187,10 +201,12 @@ export declare class LaunchesClient {
|
|
|
187
201
|
private __unlinkTicketingProject;
|
|
188
202
|
/**
|
|
189
203
|
* Sync now, as the daily sync does, for this launch: its status,
|
|
190
|
-
* progress, and new status updates (Linear, GitHub projects
|
|
191
|
-
* comments (Jira, ClickUp)
|
|
192
|
-
*
|
|
193
|
-
*
|
|
204
|
+
* progress, and new status updates (Linear, GitHub projects) or
|
|
205
|
+
* comments (Jira, ClickUp); an Asana project brings its completion and
|
|
206
|
+
* progress, not its status updates. `404 not_found` when the launch
|
|
207
|
+
* follows nothing; `409 conflict` for a link that cannot sync (a whole
|
|
208
|
+
* Jira project, a GitHub repository, a ClickUp folder or space, or a
|
|
209
|
+
* system Taktoria does not sync);
|
|
194
210
|
* `409 ticketing_not_connected` or `409 ticketing_reconnect` when a
|
|
195
211
|
* workspace admin must connect its system in Settings → Integrations.
|
|
196
212
|
* Needs `launches:write`.
|
|
@@ -216,8 +232,8 @@ export declare class LaunchesClient {
|
|
|
216
232
|
* What has happened to a launch, newest first, as its activity feed
|
|
217
233
|
* shows it: added, changed, published, taken back to draft, launched,
|
|
218
234
|
* its steps decided and reasons given for them, comments and updates
|
|
219
|
-
* posted,
|
|
220
|
-
* entry says it in a sentence. The comments and updates
|
|
235
|
+
* posted, its ticketing project linked, unlinked and synced, and its
|
|
236
|
+
* artifacts exported to a docs tool. Each entry says it in a sentence. The comments and updates
|
|
221
237
|
* themselves are at `/launches/{launchId}/posts`. Needs `launches:read`.
|
|
222
238
|
*
|
|
223
239
|
* @param {string} launchId
|
|
@@ -24,8 +24,11 @@ export class LaunchesClient {
|
|
|
24
24
|
/**
|
|
25
25
|
* List the launches in your organization, or with `mine=true` your own,
|
|
26
26
|
* the ones the app's My launches page counts as yours. Drafts included,
|
|
27
|
-
* by planned launch date. Every period unless `
|
|
28
|
-
* the app's lists open on this quarter and later
|
|
27
|
+
* by planned launch date. Every period unless `period` (or `year`)
|
|
28
|
+
* narrows it, where the app's lists open on this quarter and later:
|
|
29
|
+
* `period=upcoming` lists what they do. With `launched=true` it is the
|
|
30
|
+
* Launched page instead: launches that have launched, newest first,
|
|
31
|
+
* with the periods going by when each launched. Needs `launches:read`.
|
|
29
32
|
*
|
|
30
33
|
* @param {Taktoria.ListLaunchesRequest} request
|
|
31
34
|
* @param {LaunchesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -49,7 +52,7 @@ export class LaunchesClient {
|
|
|
49
52
|
__list() {
|
|
50
53
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
51
54
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
52
|
-
const { status, ownerUserId, pmUserId, orgTeamId, q, search, launchTemplateId, draft, health, year, quarter, mine, includeTeams, limit, cursor, } = request;
|
|
55
|
+
const { status, ownerUserId, pmUserId, orgTeamId, q, search, launchTemplateId, draft, health, period, year, quarter, mine, includeTeams, launched, limit, cursor, } = request;
|
|
53
56
|
const _queryParams = {
|
|
54
57
|
status: status != null
|
|
55
58
|
? serializers.LaunchStatus.jsonOrThrow(status, {
|
|
@@ -65,10 +68,12 @@ export class LaunchesClient {
|
|
|
65
68
|
launchTemplateId,
|
|
66
69
|
draft,
|
|
67
70
|
health,
|
|
71
|
+
period,
|
|
68
72
|
year,
|
|
69
73
|
quarter,
|
|
70
74
|
mine,
|
|
71
75
|
includeTeams,
|
|
76
|
+
launched,
|
|
72
77
|
limit,
|
|
73
78
|
cursor,
|
|
74
79
|
};
|
|
@@ -158,7 +163,8 @@ export class LaunchesClient {
|
|
|
158
163
|
* Add a launch. With a `plannedLaunchDate` it gets its launch template's
|
|
159
164
|
* steps at once, which is what fills each reviewer's queue; pass
|
|
160
165
|
* `generateSteps: false` to leave them off. Pass `draft: true` to save it
|
|
161
|
-
* without telling anybody.
|
|
166
|
+
* without telling anybody. A draft with `status: LAUNCHED` is
|
|
167
|
+
* `409 draft`: publish it, then launch it.
|
|
162
168
|
*
|
|
163
169
|
* @param {Taktoria.CreateLaunchRequest} request
|
|
164
170
|
* @param {LaunchesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -166,6 +172,7 @@ export class LaunchesClient {
|
|
|
166
172
|
* @throws {@link Taktoria.UnauthorizedError}
|
|
167
173
|
* @throws {@link Taktoria.SubscriptionRequiredError}
|
|
168
174
|
* @throws {@link Taktoria.ForbiddenError}
|
|
175
|
+
* @throws {@link Taktoria.ConflictError}
|
|
169
176
|
* @throws {@link Taktoria.ValidationError}
|
|
170
177
|
* @throws {@link Taktoria.TooManyRequestsError}
|
|
171
178
|
* @throws {@link errors.TaktoriaError}
|
|
@@ -239,6 +246,14 @@ export class LaunchesClient {
|
|
|
239
246
|
skipValidation: true,
|
|
240
247
|
breadcrumbsPrefix: ["response"],
|
|
241
248
|
}), _response.rawResponse);
|
|
249
|
+
case 409:
|
|
250
|
+
throw new Taktoria.ConflictError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
|
|
251
|
+
unrecognizedObjectKeys: "passthrough",
|
|
252
|
+
allowUnrecognizedUnionMembers: true,
|
|
253
|
+
allowUnrecognizedEnumValues: true,
|
|
254
|
+
skipValidation: true,
|
|
255
|
+
breadcrumbsPrefix: ["response"],
|
|
256
|
+
}), _response.rawResponse);
|
|
242
257
|
case 422:
|
|
243
258
|
throw new Taktoria.ValidationError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
|
|
244
259
|
unrecognizedObjectKeys: "passthrough",
|
|
@@ -343,7 +358,9 @@ export class LaunchesClient {
|
|
|
343
358
|
* and from what, about ten minutes after the edits stop, in one message
|
|
344
359
|
* that leaves out each owner's own edits (`launchUpdates` in their
|
|
345
360
|
* notification preferences). Its artifacts and links count too; its
|
|
346
|
-
* steps do not, and nothing is sent about a draft.
|
|
361
|
+
* steps do not, and nothing is sent about a draft. `409 launched` when
|
|
362
|
+
* `draft: true` would take a launched launch back to being a draft, and
|
|
363
|
+
* `409 draft` when the change would leave a draft `LAUNCHED`.
|
|
347
364
|
*
|
|
348
365
|
* @param {string} launchId
|
|
349
366
|
* @param {Taktoria.UpdateLaunchRequest} request
|
|
@@ -352,6 +369,7 @@ export class LaunchesClient {
|
|
|
352
369
|
* @throws {@link Taktoria.BadRequestError}
|
|
353
370
|
* @throws {@link Taktoria.ForbiddenError}
|
|
354
371
|
* @throws {@link Taktoria.NotFoundError}
|
|
372
|
+
* @throws {@link Taktoria.ConflictError}
|
|
355
373
|
* @throws {@link Taktoria.ValidationError}
|
|
356
374
|
* @throws {@link Taktoria.TooManyRequestsError}
|
|
357
375
|
* @throws {@link errors.TaktoriaError}
|
|
@@ -423,6 +441,14 @@ export class LaunchesClient {
|
|
|
423
441
|
skipValidation: true,
|
|
424
442
|
breadcrumbsPrefix: ["response"],
|
|
425
443
|
}), _response.rawResponse);
|
|
444
|
+
case 409:
|
|
445
|
+
throw new Taktoria.ConflictError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
|
|
446
|
+
unrecognizedObjectKeys: "passthrough",
|
|
447
|
+
allowUnrecognizedUnionMembers: true,
|
|
448
|
+
allowUnrecognizedEnumValues: true,
|
|
449
|
+
skipValidation: true,
|
|
450
|
+
breadcrumbsPrefix: ["response"],
|
|
451
|
+
}), _response.rawResponse);
|
|
426
452
|
case 422:
|
|
427
453
|
throw new Taktoria.ValidationError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
|
|
428
454
|
unrecognizedObjectKeys: "passthrough",
|
|
@@ -633,9 +659,15 @@ export class LaunchesClient {
|
|
|
633
659
|
* sites, in the GitHub organization the app is installed on, or in its
|
|
634
660
|
* Asana or ClickUp workspaces), and syncs at once: the answer's
|
|
635
661
|
* `ticketingProject` says how that went. Any other address, a whole
|
|
636
|
-
* Jira project
|
|
637
|
-
* does not sync. It reads the system,
|
|
638
|
-
* budget with a sync.
|
|
662
|
+
* Jira project, a GitHub repository, or a ClickUp folder or space
|
|
663
|
+
* included, is kept as a link and does not sync. It reads the system,
|
|
664
|
+
* so it shares the `ticketing-sync` budget with a sync. `404 not_found`
|
|
665
|
+
* when the connection cannot find or see the project, `409 conflict`
|
|
666
|
+
* for one in another workspace or site of the system than the one
|
|
667
|
+
* connected, `409 ticketing_reconnect` when the system turned the
|
|
668
|
+
* connection down (a workspace admin connects it again in Settings →
|
|
669
|
+
* Integrations), and `502 upstream_error` when it did not answer.
|
|
670
|
+
* Needs `launches:write`.
|
|
639
671
|
*
|
|
640
672
|
* @param {string} launchId
|
|
641
673
|
* @param {Taktoria.LinkTicketingProjectRequest} request
|
|
@@ -831,10 +863,12 @@ export class LaunchesClient {
|
|
|
831
863
|
}
|
|
832
864
|
/**
|
|
833
865
|
* Sync now, as the daily sync does, for this launch: its status,
|
|
834
|
-
* progress, and new status updates (Linear, GitHub projects
|
|
835
|
-
* comments (Jira, ClickUp)
|
|
836
|
-
*
|
|
837
|
-
*
|
|
866
|
+
* progress, and new status updates (Linear, GitHub projects) or
|
|
867
|
+
* comments (Jira, ClickUp); an Asana project brings its completion and
|
|
868
|
+
* progress, not its status updates. `404 not_found` when the launch
|
|
869
|
+
* follows nothing; `409 conflict` for a link that cannot sync (a whole
|
|
870
|
+
* Jira project, a GitHub repository, a ClickUp folder or space, or a
|
|
871
|
+
* system Taktoria does not sync);
|
|
838
872
|
* `409 ticketing_not_connected` or `409 ticketing_reconnect` when a
|
|
839
873
|
* workspace admin must connect its system in Settings → Integrations.
|
|
840
874
|
* Needs `launches:write`.
|
|
@@ -942,8 +976,8 @@ export class LaunchesClient {
|
|
|
942
976
|
* What has happened to a launch, newest first, as its activity feed
|
|
943
977
|
* shows it: added, changed, published, taken back to draft, launched,
|
|
944
978
|
* its steps decided and reasons given for them, comments and updates
|
|
945
|
-
* posted,
|
|
946
|
-
* entry says it in a sentence. The comments and updates
|
|
979
|
+
* posted, its ticketing project linked, unlinked and synced, and its
|
|
980
|
+
* artifacts exported to a docs tool. Each entry says it in a sentence. The comments and updates
|
|
947
981
|
* themselves are at `/launches/{launchId}/posts`. Needs `launches:read`.
|
|
948
982
|
*
|
|
949
983
|
* @param {string} launchId
|
|
@@ -23,7 +23,20 @@ export interface ListLaunchesRequest {
|
|
|
23
23
|
draft?: boolean;
|
|
24
24
|
/** `ON_TRACK`, `AT_RISK` or `OFF_TRACK`, as the newest update says (never a launched launch), or `NONE` for launches with no health to show. */
|
|
25
25
|
health?: string;
|
|
26
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* A fiscal period, as the app's period picker and its URL name them:
|
|
28
|
+
* a quarter (`2026-Q4`), a whole year (`2027`), `upcoming` for this
|
|
29
|
+
* quarter and every one after it, or `all`. Repeat it for several
|
|
30
|
+
* (`period=2026-Q4&period=2027-Q1`); `upcoming` or `all` among them
|
|
31
|
+
* wins over the rest. Narrows by planned launch date in the
|
|
32
|
+
* workspace's fiscal years, `upcoming` keeping launches with no
|
|
33
|
+
* date yet, as the app's lists do; with `launched=true`, by when
|
|
34
|
+
* each launched. Left out, with no `year`, every period. Wins
|
|
35
|
+
* over `year` and `quarter`; anything else is a
|
|
36
|
+
* `422 validation_error`.
|
|
37
|
+
*/
|
|
38
|
+
period?: string | string[];
|
|
39
|
+
/** One fiscal year, as the workspace's fiscal year start names it. Narrows by planned launch date (actual with `launched=true`); left out, every year. `period` takes several. */
|
|
27
40
|
year?: number;
|
|
28
41
|
/** A fiscal quarter, 1 to 4, of `year`. Needs `year`; left out, the whole year. */
|
|
29
42
|
quarter?: number;
|
|
@@ -40,6 +53,17 @@ export interface ListLaunchesRequest {
|
|
|
40
53
|
mine?: boolean;
|
|
41
54
|
/** With `mine=true`, `false` leaves out launches that are yours only through a team. Left out, `true`. */
|
|
42
55
|
includeTeams?: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* `true` lists what the Launched page does: only launches that
|
|
58
|
+
* have launched (`status` `LAUNCHED`), newest first by
|
|
59
|
+
* `actualLaunchDate`, with `period`, `year` and `quarter` going
|
|
60
|
+
* by when each launched rather than when it was planned. That is
|
|
61
|
+
* how the Overview counts `launchedThisQuarter`: a launch planned
|
|
62
|
+
* for last quarter that went out in this one is this quarter's.
|
|
63
|
+
* `launched=true&period=2026-Q4` is what shipped in that quarter.
|
|
64
|
+
* Left out, by planned launch date.
|
|
65
|
+
*/
|
|
66
|
+
launched?: boolean;
|
|
43
67
|
limit?: number;
|
|
44
68
|
cursor?: string;
|
|
45
69
|
}
|
|
@@ -38,5 +38,8 @@ export declare const LaunchActivityVerb: {
|
|
|
38
38
|
* project done and flagged it ready to launch. Nobody did it, so
|
|
39
39
|
* `actor` is null. */
|
|
40
40
|
readonly Synced: "synced";
|
|
41
|
+
/**
|
|
42
|
+
* One of its artifacts was exported to a docs tool (Notion, Confluence or Google Docs). */
|
|
43
|
+
readonly Exported: "exported";
|
|
41
44
|
};
|
|
42
45
|
export type LaunchActivityVerb = (typeof LaunchActivityVerb)[keyof typeof LaunchActivityVerb];
|
|
@@ -39,4 +39,7 @@ export const LaunchActivityVerb = {
|
|
|
39
39
|
* project done and flagged it ready to launch. Nobody did it, so
|
|
40
40
|
* `actor` is null. */
|
|
41
41
|
Synced: "synced",
|
|
42
|
+
/**
|
|
43
|
+
* One of its artifacts was exported to a docs tool (Notion, Confluence or Google Docs). */
|
|
44
|
+
Exported: "exported",
|
|
42
45
|
};
|
|
@@ -8,8 +8,8 @@ export interface LinkTicketingProjectRequest {
|
|
|
8
8
|
* milestone (`https://github.com/acme/web/milestone/3`), an Asana
|
|
9
9
|
* project (`https://app.asana.com/1/<workspace>/project/<project>`),
|
|
10
10
|
* or a ClickUp list (`https://app.clickup.com/<workspace>/v/li/<list>`)
|
|
11
|
-
* or task (`https://app.clickup.com/t/<task>`). Anything else
|
|
12
|
-
* as a link.
|
|
11
|
+
* or task (`https://app.clickup.com/t/<task>`). Anything else, a
|
|
12
|
+
* ClickUp folder or space included, is kept as a link.
|
|
13
13
|
*/
|
|
14
14
|
url: string;
|
|
15
15
|
}
|
|
@@ -2,7 +2,7 @@ import type * as Taktoria from "../../../index.mjs";
|
|
|
2
2
|
export interface SyncTicketingProjectResponse {
|
|
3
3
|
/** Whether the project's status moved the launch's. */
|
|
4
4
|
statusChanged: boolean;
|
|
5
|
-
/** How many of the project's status updates (Linear, GitHub projects
|
|
5
|
+
/** How many of the project's status updates (Linear, GitHub projects) or comments (Jira, ClickUp) became the launch's. Always 0 for an Asana project, whose status updates Taktoria's connection cannot read. */
|
|
6
6
|
updatesAdded: number;
|
|
7
7
|
/** Whether this sync found the project newly done, flagging the launch ready to launch. */
|
|
8
8
|
completed: boolean;
|
|
@@ -6,11 +6,17 @@ import type * as Taktoria from "../../../index.mjs";
|
|
|
6
6
|
* milestone; an Asana project; or a ClickUp list or task. Once its system
|
|
7
7
|
* is connected to the workspace (Settings → Integrations), each day, and
|
|
8
8
|
* on a sync, its status moves the launch's; the status updates of a
|
|
9
|
-
* Linear
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
9
|
+
* Linear or GitHub project become the launch's updates, and the comments
|
|
10
|
+
* on a Jira issue or a ClickUp list or task its comments (`source` on a
|
|
11
|
+
* LaunchPost; a Jira comment restricted to some people is never brought
|
|
12
|
+
* in). An Asana project's status updates need a permission Asana's OAuth
|
|
13
|
+
* does not offer Taktoria's read-only connection, so none come in. It is
|
|
14
|
+
* followed by its tasks instead: its status kind is `PLANNED` until one
|
|
15
|
+
* is done, then `STARTED`, and `COMPLETED` once the project is marked
|
|
16
|
+
* complete, and its progress is the share of them done. A whole Jira
|
|
17
|
+
* project, a GitHub repository, and a ClickUp folder or space are kept
|
|
18
|
+
* as links. Marked done, it flags the launch ready to launch; it never
|
|
19
|
+
* launches it.
|
|
14
20
|
*/
|
|
15
21
|
export interface TicketingProject {
|
|
16
22
|
/** Null for a system Taktoria has no connector for. Such a link is kept as a link and never synced. */
|
|
@@ -37,8 +43,8 @@ export interface TicketingProject {
|
|
|
37
43
|
* to the workspace), `notFound`, `unauthorized` (a workspace admin must
|
|
38
44
|
* connect the system again), `unavailable` or `unsupported` (a system
|
|
39
45
|
* Taktoria cannot sync, or a link to something it cannot follow, such
|
|
40
|
-
* as a whole Jira project
|
|
41
|
-
* worked.
|
|
46
|
+
* as a whole Jira project, a GitHub repository, or a ClickUp folder
|
|
47
|
+
* or space). Null when it worked.
|
|
42
48
|
*/
|
|
43
49
|
syncError?: string;
|
|
44
50
|
}
|
|
@@ -238,6 +238,9 @@ export declare class OkrClient {
|
|
|
238
238
|
private __deleteKeyResult;
|
|
239
239
|
/**
|
|
240
240
|
* The history behind a key result's current grade, most recent first.
|
|
241
|
+
* On a key result a connected metric drives (`metric` on the key
|
|
242
|
+
* result), the metric's own check-ins carry `metric`, and a person's
|
|
243
|
+
* stands only until the metric next moves.
|
|
241
244
|
*
|
|
242
245
|
* @param {string} keyResultId
|
|
243
246
|
* @param {Taktoria.ListCheckInsRequest} request
|
|
@@ -271,6 +274,11 @@ export declare class OkrClient {
|
|
|
271
274
|
* With `checkpoint`, it is also the key result's grade at that
|
|
272
275
|
* scorecard checkpoint, as the dashboard's check-in form makes it.
|
|
273
276
|
*
|
|
277
|
+
* On a key result a connected metric drives (`metric` on the key
|
|
278
|
+
* result), a check-in stands only until the metric next moves: the
|
|
279
|
+
* metric's next check-in is then the latest. A **Final** grade on the
|
|
280
|
+
* scorecard is the score whatever the metric does.
|
|
281
|
+
*
|
|
274
282
|
* @param {string} keyResultId
|
|
275
283
|
* @param {Taktoria.CreateCheckInRequest} request
|
|
276
284
|
* @param {OkrClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -953,6 +953,9 @@ export class OkrClient {
|
|
|
953
953
|
}
|
|
954
954
|
/**
|
|
955
955
|
* The history behind a key result's current grade, most recent first.
|
|
956
|
+
* On a key result a connected metric drives (`metric` on the key
|
|
957
|
+
* result), the metric's own check-ins carry `metric`, and a person's
|
|
958
|
+
* stands only until the metric next moves.
|
|
956
959
|
*
|
|
957
960
|
* @param {string} keyResultId
|
|
958
961
|
* @param {Taktoria.ListCheckInsRequest} request
|
|
@@ -1053,6 +1056,11 @@ export class OkrClient {
|
|
|
1053
1056
|
* With `checkpoint`, it is also the key result's grade at that
|
|
1054
1057
|
* scorecard checkpoint, as the dashboard's check-in form makes it.
|
|
1055
1058
|
*
|
|
1059
|
+
* On a key result a connected metric drives (`metric` on the key
|
|
1060
|
+
* result), a check-in stands only until the metric next moves: the
|
|
1061
|
+
* metric's next check-in is then the latest. A **Final** grade on the
|
|
1062
|
+
* scorecard is the score whatever the metric does.
|
|
1063
|
+
*
|
|
1056
1064
|
* @param {string} keyResultId
|
|
1057
1065
|
* @param {Taktoria.CreateCheckInRequest} request
|
|
1058
1066
|
* @param {OkrClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -35,6 +35,19 @@ export interface KeyResult {
|
|
|
35
35
|
ownerUserIds: string[];
|
|
36
36
|
/** Teams of the workspace that own it; their members count as owners. */
|
|
37
37
|
ownerTeamIds: string[];
|
|
38
|
+
/**
|
|
39
|
+
* When it was last checked in on: its newest check-in's `recordedAt`,
|
|
40
|
+
* so a check-in recorded late counts at its date. Absent if it has
|
|
41
|
+
* never been checked in on. How long it has gone quiet.
|
|
42
|
+
*/
|
|
43
|
+
lastCheckInAt?: Date;
|
|
44
|
+
/**
|
|
45
|
+
* The connected metric that drives its score, absent if none. Each
|
|
46
|
+
* number the metric hears becomes a check-in, and a person's own
|
|
47
|
+
* check-in stands only until the metric next moves. Sources are set
|
|
48
|
+
* up on the key result's page in the app, not through the API.
|
|
49
|
+
*/
|
|
50
|
+
metric?: Taktoria.KeyResultMetric;
|
|
38
51
|
createdAt: Date;
|
|
39
52
|
updatedAt: Date;
|
|
40
53
|
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type * as Taktoria from "../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* The metric a key result follows, as anybody who may see the key result
|
|
4
|
+
* sees it. Never its secret, token or address.
|
|
5
|
+
*/
|
|
6
|
+
export interface KeyResultMetric {
|
|
7
|
+
/** What the number is, as the history names it, such as "Weekly active teams". */
|
|
8
|
+
name: string;
|
|
9
|
+
kind: Taktoria.MetricSourceKind;
|
|
10
|
+
/** Paused, it records nothing until somebody resumes it. */
|
|
11
|
+
paused: boolean;
|
|
12
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/** How a metric hears its number. */
|
|
2
|
+
export declare const MetricSourceKind: {
|
|
3
|
+
/**
|
|
4
|
+
* A system posts it to the metric's own address, with its secret. */
|
|
5
|
+
readonly Webhook: "WEBHOOK";
|
|
6
|
+
/**
|
|
7
|
+
* OKR Hub fetches it from an https address on a schedule. */
|
|
8
|
+
readonly Pull: "PULL";
|
|
9
|
+
};
|
|
10
|
+
export type MetricSourceKind = (typeof MetricSourceKind)[keyof typeof MetricSourceKind];
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
/** How a metric hears its number. */
|
|
3
|
+
export const MetricSourceKind = {
|
|
4
|
+
/**
|
|
5
|
+
* A system posts it to the metric's own address, with its secret. */
|
|
6
|
+
Webhook: "WEBHOOK",
|
|
7
|
+
/**
|
|
8
|
+
* OKR Hub fetches it from an https address on a schedule. */
|
|
9
|
+
Pull: "PULL",
|
|
10
|
+
};
|
|
@@ -19,6 +19,8 @@ export * from "./KeyResultDetail.mjs";
|
|
|
19
19
|
export * from "./KeyResultGrade.mjs";
|
|
20
20
|
export * from "./KeyResultGradeList.mjs";
|
|
21
21
|
export * from "./KeyResultList.mjs";
|
|
22
|
+
export * from "./KeyResultMetric.mjs";
|
|
23
|
+
export * from "./MetricSourceKind.mjs";
|
|
22
24
|
export * from "./Objective.mjs";
|
|
23
25
|
export * from "./ObjectiveDetail.mjs";
|
|
24
26
|
export * from "./ObjectivePage.mjs";
|
|
@@ -19,6 +19,8 @@ export * from "./KeyResultDetail.mjs";
|
|
|
19
19
|
export * from "./KeyResultGrade.mjs";
|
|
20
20
|
export * from "./KeyResultGradeList.mjs";
|
|
21
21
|
export * from "./KeyResultList.mjs";
|
|
22
|
+
export * from "./KeyResultMetric.mjs";
|
|
23
|
+
export * from "./MetricSourceKind.mjs";
|
|
22
24
|
export * from "./Objective.mjs";
|
|
23
25
|
export * from "./ObjectiveDetail.mjs";
|
|
24
26
|
export * from "./ObjectivePage.mjs";
|
|
@@ -28,8 +28,11 @@ export declare class OrganizationClient {
|
|
|
28
28
|
private __get;
|
|
29
29
|
/**
|
|
30
30
|
* Rename the workspace, move its slug, set its fiscal year, the years
|
|
31
|
-
* OKR Hub offers, the default time zone, LaunchCal's holiday markets
|
|
32
|
-
* whether seats grow as people join (`autoGrowSeats`)
|
|
31
|
+
* OKR Hub offers, the default time zone, LaunchCal's holiday markets,
|
|
32
|
+
* whether seats grow as people join (`autoGrowSeats`), whether
|
|
33
|
+
* LaunchCal's calendar feeds are allowed (`allowCalendarFeeds`) or
|
|
34
|
+
* whether Slack commands take Slack's word while Google is required
|
|
35
|
+
* (`slackCommandsWithoutGoogle`). Requires
|
|
33
36
|
* `organization:write`, which a signed-in session never has: this takes
|
|
34
37
|
* a key. Everything is checked before anything is written.
|
|
35
38
|
*
|
|
@@ -105,8 +105,11 @@ export class OrganizationClient {
|
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
107
|
* Rename the workspace, move its slug, set its fiscal year, the years
|
|
108
|
-
* OKR Hub offers, the default time zone, LaunchCal's holiday markets
|
|
109
|
-
* whether seats grow as people join (`autoGrowSeats`)
|
|
108
|
+
* OKR Hub offers, the default time zone, LaunchCal's holiday markets,
|
|
109
|
+
* whether seats grow as people join (`autoGrowSeats`), whether
|
|
110
|
+
* LaunchCal's calendar feeds are allowed (`allowCalendarFeeds`) or
|
|
111
|
+
* whether Slack commands take Slack's word while Google is required
|
|
112
|
+
* (`slackCommandsWithoutGoogle`). Requires
|
|
110
113
|
* `organization:write`, which a signed-in session never has: this takes
|
|
111
114
|
* a key. Everything is checked before anything is written.
|
|
112
115
|
*
|
|
@@ -44,6 +44,17 @@ export interface Organization {
|
|
|
44
44
|
* reads true.
|
|
45
45
|
*/
|
|
46
46
|
requireGoogleSignIn: boolean;
|
|
47
|
+
/**
|
|
48
|
+
* **Allow Slack commands without Google sign-in**, under **Require
|
|
49
|
+
* sign-in with Google** in Settings → Workspace. Slack cannot sign in
|
|
50
|
+
* with Google, so while Google is required, Taktoria's Slack commands
|
|
51
|
+
* act only for somebody who has connected their Slack account by
|
|
52
|
+
* signing in with Google once (see `GET /slack-connections`). On,
|
|
53
|
+
* they take the address Slack has confirmed instead, as in a
|
|
54
|
+
* workspace that does not require Google. It means nothing while
|
|
55
|
+
* `requireGoogleSignIn` is false. Off by default.
|
|
56
|
+
*/
|
|
57
|
+
slackCommandsWithoutGoogle: boolean;
|
|
47
58
|
/** Whether Google sign-in is set up on this installation, so it can be required. */
|
|
48
59
|
googleSignInAvailable: boolean;
|
|
49
60
|
/**
|
|
@@ -57,4 +68,14 @@ export interface Organization {
|
|
|
57
68
|
* `autoJoin` on. On by default.
|
|
58
69
|
*/
|
|
59
70
|
autoGrowSeats: boolean;
|
|
71
|
+
/**
|
|
72
|
+
* **Allow calendar feeds**, in Settings → Workspace: whether members
|
|
73
|
+
* may subscribe to LaunchCal from Google Calendar, Outlook or Apple
|
|
74
|
+
* Calendar. A feed is a private address read with no sign-in, around
|
|
75
|
+
* **Require Google sign-in** and single sign-on, so a workspace that
|
|
76
|
+
* holds every way in to those turns it off: every feed then answers
|
|
77
|
+
* 404 and none can be made, until it is on again. On by default.
|
|
78
|
+
* Feeds themselves have no API: each address is a person's secret.
|
|
79
|
+
*/
|
|
80
|
+
allowCalendarFeeds: boolean;
|
|
60
81
|
}
|
|
@@ -34,4 +34,19 @@ export interface UpdateOrganizationRequest {
|
|
|
34
34
|
* Settings → Domains.
|
|
35
35
|
*/
|
|
36
36
|
autoGrowSeats?: boolean;
|
|
37
|
+
/**
|
|
38
|
+
* Whether members may subscribe to LaunchCal from a calendar app.
|
|
39
|
+
* Turned off, every feed stops answering at once, and none is
|
|
40
|
+
* deleted: turned on again, they work as before. Each change is in
|
|
41
|
+
* the audit log, as it is from Settings → Workspace.
|
|
42
|
+
*/
|
|
43
|
+
allowCalendarFeeds?: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* Whether Taktoria's Slack commands take Slack's confirmed address
|
|
46
|
+
* while Google is required, rather than asking each person to connect
|
|
47
|
+
* with Google. Turned off, everybody who has not connected is asked
|
|
48
|
+
* to at their next command; connections already made keep working.
|
|
49
|
+
* Each change is in the audit log, as it is from Settings → Workspace.
|
|
50
|
+
*/
|
|
51
|
+
slackCommandsWithoutGoogle?: boolean;
|
|
37
52
|
}
|
|
@@ -29,8 +29,8 @@ export declare class PlatformClient {
|
|
|
29
29
|
getNotificationPreferences(requestOptions?: PlatformClient.RequestOptions): core.HttpResponsePromise<Taktoria.NotificationPreferences>;
|
|
30
30
|
private __getNotificationPreferences;
|
|
31
31
|
/**
|
|
32
|
-
* Turn kinds of notification on or off, by email
|
|
33
|
-
* person behind this key or session; anything not named keeps its
|
|
32
|
+
* Turn kinds of notification on or off, by email, by Slack and by
|
|
33
|
+
* Microsoft Teams, for the person behind this key or session; anything not named keeps its
|
|
34
34
|
* value. Like reading them, it needs no scope, and a signed-in session
|
|
35
35
|
* may change its own. `404` for a key whose maker has left.
|
|
36
36
|
*
|