@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.
Files changed (246) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/Client.d.ts +3 -0
  3. package/dist/cjs/Client.js +7 -2
  4. package/dist/cjs/api/resources/artifacts/client/Client.d.ts +14 -6
  5. package/dist/cjs/api/resources/artifacts/client/Client.js +16 -7
  6. package/dist/cjs/api/resources/artifacts/client/requests/ListAllArtifactsRequest.d.ts +13 -1
  7. package/dist/cjs/api/resources/dory/client/Client.d.ts +28 -5
  8. package/dist/cjs/api/resources/dory/client/Client.js +86 -5
  9. package/dist/cjs/api/resources/dory/types/CreateEventRequest.d.ts +9 -4
  10. package/dist/cjs/api/resources/dory/types/EventCalendarInvite.d.ts +41 -0
  11. package/dist/cjs/api/resources/dory/types/EventCalendarInvite.js +3 -0
  12. package/dist/cjs/api/resources/dory/types/UpdateEventRequest.d.ts +9 -4
  13. package/dist/cjs/api/resources/dory/types/index.d.ts +1 -0
  14. package/dist/cjs/api/resources/dory/types/index.js +1 -0
  15. package/dist/cjs/api/resources/index.d.ts +3 -0
  16. package/dist/cjs/api/resources/index.js +4 -1
  17. package/dist/cjs/api/resources/insights/client/Client.js +2 -1
  18. package/dist/cjs/api/resources/insights/client/requests/ListInsightsRequest.d.ts +12 -1
  19. package/dist/cjs/api/resources/launches/client/Client.d.ts +29 -13
  20. package/dist/cjs/api/resources/launches/client/Client.js +48 -14
  21. package/dist/cjs/api/resources/launches/client/requests/ListLaunchesRequest.d.ts +25 -1
  22. package/dist/cjs/api/resources/launches/types/LaunchActivityVerb.d.ts +3 -0
  23. package/dist/cjs/api/resources/launches/types/LaunchActivityVerb.js +3 -0
  24. package/dist/cjs/api/resources/launches/types/LinkTicketingProjectRequest.d.ts +2 -2
  25. package/dist/cjs/api/resources/launches/types/SyncTicketingProjectResponse.d.ts +1 -1
  26. package/dist/cjs/api/resources/launches/types/TicketingProject.d.ts +13 -7
  27. package/dist/cjs/api/resources/okr/client/Client.d.ts +8 -0
  28. package/dist/cjs/api/resources/okr/client/Client.js +8 -0
  29. package/dist/cjs/api/resources/okr/types/KeyResult.d.ts +13 -0
  30. package/dist/cjs/api/resources/okr/types/KeyResultMetric.d.ts +12 -0
  31. package/dist/cjs/api/resources/okr/types/KeyResultMetric.js +3 -0
  32. package/dist/cjs/api/resources/okr/types/MetricSourceKind.d.ts +10 -0
  33. package/dist/cjs/api/resources/okr/types/MetricSourceKind.js +13 -0
  34. package/dist/cjs/api/resources/okr/types/index.d.ts +2 -0
  35. package/dist/cjs/api/resources/okr/types/index.js +2 -0
  36. package/dist/cjs/api/resources/organization/client/Client.d.ts +5 -2
  37. package/dist/cjs/api/resources/organization/client/Client.js +5 -2
  38. package/dist/cjs/api/resources/organization/types/Organization.d.ts +21 -0
  39. package/dist/cjs/api/resources/organization/types/UpdateOrganizationRequest.d.ts +15 -0
  40. package/dist/cjs/api/resources/platform/client/Client.d.ts +2 -2
  41. package/dist/cjs/api/resources/platform/client/Client.js +2 -2
  42. package/dist/cjs/api/resources/platform/types/NotificationChannels.d.ts +7 -2
  43. package/dist/cjs/api/resources/platform/types/UpdateNotificationChannels.d.ts +1 -0
  44. package/dist/cjs/api/resources/platform/types/UpdateNotificationPreferencesRequest.d.ts +1 -1
  45. package/dist/cjs/api/resources/platform/types/WaitingForSeat.d.ts +2 -2
  46. package/dist/cjs/api/resources/posts/client/Client.d.ts +5 -2
  47. package/dist/cjs/api/resources/posts/client/Client.js +13 -2
  48. package/dist/cjs/api/resources/posts/types/LaunchPost.d.ts +4 -3
  49. package/dist/cjs/api/resources/slackConnections/client/Client.d.ts +56 -0
  50. package/dist/cjs/api/resources/slackConnections/client/Client.js +243 -0
  51. package/dist/cjs/api/resources/slackConnections/client/index.d.ts +1 -0
  52. package/dist/cjs/api/resources/slackConnections/client/index.js +17 -0
  53. package/dist/cjs/api/resources/slackConnections/client/requests/ListSlackConnectionsRequest.d.ts +9 -0
  54. package/dist/cjs/api/resources/slackConnections/client/requests/ListSlackConnectionsRequest.js +3 -0
  55. package/dist/cjs/api/resources/slackConnections/client/requests/index.d.ts +1 -0
  56. package/dist/cjs/api/resources/slackConnections/client/requests/index.js +2 -0
  57. package/dist/cjs/api/resources/slackConnections/exports.d.ts +2 -0
  58. package/dist/cjs/api/resources/slackConnections/exports.js +21 -0
  59. package/dist/cjs/api/resources/slackConnections/index.d.ts +2 -0
  60. package/dist/cjs/api/resources/slackConnections/index.js +18 -0
  61. package/dist/cjs/api/resources/slackConnections/types/SlackConnection.d.ts +16 -0
  62. package/dist/cjs/api/resources/slackConnections/types/SlackConnection.js +3 -0
  63. package/dist/cjs/api/resources/slackConnections/types/SlackConnectionAccount.d.ts +15 -0
  64. package/dist/cjs/api/resources/slackConnections/types/SlackConnectionAccount.js +3 -0
  65. package/dist/cjs/api/resources/slackConnections/types/SlackConnectionPage.d.ts +7 -0
  66. package/dist/cjs/api/resources/slackConnections/types/SlackConnectionPage.js +3 -0
  67. package/dist/cjs/api/resources/slackConnections/types/SlackConnectionPerson.d.ts +7 -0
  68. package/dist/cjs/api/resources/slackConnections/types/SlackConnectionPerson.js +3 -0
  69. package/dist/cjs/api/resources/slackConnections/types/index.d.ts +4 -0
  70. package/dist/cjs/api/resources/slackConnections/types/index.js +20 -0
  71. package/dist/cjs/api/resources/steps/client/Client.d.ts +15 -9
  72. package/dist/cjs/api/resources/steps/client/Client.js +17 -10
  73. package/dist/cjs/api/resources/steps/client/requests/ListReviewsRequest.d.ts +12 -1
  74. package/dist/cjs/api/resources/steps/types/NudgeReason.d.ts +10 -0
  75. package/dist/cjs/api/resources/steps/types/NudgeReason.js +13 -0
  76. package/dist/cjs/api/resources/steps/types/NudgeResponse.d.ts +11 -1
  77. package/dist/cjs/api/resources/steps/types/index.d.ts +1 -0
  78. package/dist/cjs/api/resources/steps/types/index.js +1 -0
  79. package/dist/cjs/serialization/resources/dory/types/EventCalendarInvite.d.ts +20 -0
  80. package/dist/cjs/serialization/resources/dory/types/EventCalendarInvite.js +52 -0
  81. package/dist/cjs/serialization/resources/dory/types/index.d.ts +1 -0
  82. package/dist/cjs/serialization/resources/dory/types/index.js +1 -0
  83. package/dist/cjs/serialization/resources/index.d.ts +2 -0
  84. package/dist/cjs/serialization/resources/index.js +3 -1
  85. package/dist/cjs/serialization/resources/launches/types/LaunchActivityVerb.d.ts +1 -1
  86. package/dist/cjs/serialization/resources/launches/types/LaunchActivityVerb.js +1 -0
  87. package/dist/cjs/serialization/resources/okr/types/KeyResult.d.ts +3 -0
  88. package/dist/cjs/serialization/resources/okr/types/KeyResult.js +3 -0
  89. package/dist/cjs/serialization/resources/okr/types/KeyResultMetric.d.ts +12 -0
  90. package/dist/cjs/serialization/resources/okr/types/KeyResultMetric.js +44 -0
  91. package/dist/cjs/serialization/resources/okr/types/MetricSourceKind.d.ts +7 -0
  92. package/dist/cjs/serialization/resources/okr/types/MetricSourceKind.js +39 -0
  93. package/dist/cjs/serialization/resources/okr/types/index.d.ts +2 -0
  94. package/dist/cjs/serialization/resources/okr/types/index.js +2 -0
  95. package/dist/cjs/serialization/resources/organization/types/Organization.d.ts +2 -0
  96. package/dist/cjs/serialization/resources/organization/types/Organization.js +2 -0
  97. package/dist/cjs/serialization/resources/organization/types/UpdateOrganizationRequest.d.ts +2 -0
  98. package/dist/cjs/serialization/resources/organization/types/UpdateOrganizationRequest.js +2 -0
  99. package/dist/cjs/serialization/resources/platform/types/NotificationChannels.d.ts +1 -0
  100. package/dist/cjs/serialization/resources/platform/types/NotificationChannels.js +1 -0
  101. package/dist/cjs/serialization/resources/platform/types/UpdateNotificationChannels.d.ts +1 -0
  102. package/dist/cjs/serialization/resources/platform/types/UpdateNotificationChannels.js +1 -0
  103. package/dist/cjs/serialization/resources/slackConnections/index.d.ts +1 -0
  104. package/dist/cjs/serialization/resources/slackConnections/index.js +17 -0
  105. package/dist/cjs/serialization/resources/slackConnections/types/SlackConnection.d.ts +14 -0
  106. package/dist/cjs/serialization/resources/slackConnections/types/SlackConnection.js +46 -0
  107. package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionAccount.d.ts +11 -0
  108. package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionAccount.js +43 -0
  109. package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionPage.d.ts +12 -0
  110. package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionPage.js +44 -0
  111. package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionPerson.d.ts +10 -0
  112. package/dist/cjs/serialization/resources/slackConnections/types/SlackConnectionPerson.js +42 -0
  113. package/dist/cjs/serialization/resources/slackConnections/types/index.d.ts +4 -0
  114. package/dist/cjs/serialization/resources/slackConnections/types/index.js +20 -0
  115. package/dist/cjs/serialization/resources/steps/types/NudgeReason.d.ts +7 -0
  116. package/dist/cjs/serialization/resources/steps/types/NudgeReason.js +39 -0
  117. package/dist/cjs/serialization/resources/steps/types/NudgeResponse.d.ts +7 -1
  118. package/dist/cjs/serialization/resources/steps/types/NudgeResponse.js +7 -1
  119. package/dist/cjs/serialization/resources/steps/types/index.d.ts +1 -0
  120. package/dist/cjs/serialization/resources/steps/types/index.js +1 -0
  121. package/dist/cjs/version.d.ts +1 -1
  122. package/dist/cjs/version.js +1 -1
  123. package/dist/esm/BaseClient.mjs +2 -2
  124. package/dist/esm/Client.d.mts +3 -0
  125. package/dist/esm/Client.mjs +5 -0
  126. package/dist/esm/api/resources/artifacts/client/Client.d.mts +14 -6
  127. package/dist/esm/api/resources/artifacts/client/Client.mjs +16 -7
  128. package/dist/esm/api/resources/artifacts/client/requests/ListAllArtifactsRequest.d.mts +13 -1
  129. package/dist/esm/api/resources/dory/client/Client.d.mts +28 -5
  130. package/dist/esm/api/resources/dory/client/Client.mjs +86 -5
  131. package/dist/esm/api/resources/dory/types/CreateEventRequest.d.mts +9 -4
  132. package/dist/esm/api/resources/dory/types/EventCalendarInvite.d.mts +41 -0
  133. package/dist/esm/api/resources/dory/types/EventCalendarInvite.mjs +2 -0
  134. package/dist/esm/api/resources/dory/types/UpdateEventRequest.d.mts +9 -4
  135. package/dist/esm/api/resources/dory/types/index.d.mts +1 -0
  136. package/dist/esm/api/resources/dory/types/index.mjs +1 -0
  137. package/dist/esm/api/resources/index.d.mts +3 -0
  138. package/dist/esm/api/resources/index.mjs +3 -0
  139. package/dist/esm/api/resources/insights/client/Client.mjs +2 -1
  140. package/dist/esm/api/resources/insights/client/requests/ListInsightsRequest.d.mts +12 -1
  141. package/dist/esm/api/resources/launches/client/Client.d.mts +29 -13
  142. package/dist/esm/api/resources/launches/client/Client.mjs +48 -14
  143. package/dist/esm/api/resources/launches/client/requests/ListLaunchesRequest.d.mts +25 -1
  144. package/dist/esm/api/resources/launches/types/LaunchActivityVerb.d.mts +3 -0
  145. package/dist/esm/api/resources/launches/types/LaunchActivityVerb.mjs +3 -0
  146. package/dist/esm/api/resources/launches/types/LinkTicketingProjectRequest.d.mts +2 -2
  147. package/dist/esm/api/resources/launches/types/SyncTicketingProjectResponse.d.mts +1 -1
  148. package/dist/esm/api/resources/launches/types/TicketingProject.d.mts +13 -7
  149. package/dist/esm/api/resources/okr/client/Client.d.mts +8 -0
  150. package/dist/esm/api/resources/okr/client/Client.mjs +8 -0
  151. package/dist/esm/api/resources/okr/types/KeyResult.d.mts +13 -0
  152. package/dist/esm/api/resources/okr/types/KeyResultMetric.d.mts +12 -0
  153. package/dist/esm/api/resources/okr/types/KeyResultMetric.mjs +2 -0
  154. package/dist/esm/api/resources/okr/types/MetricSourceKind.d.mts +10 -0
  155. package/dist/esm/api/resources/okr/types/MetricSourceKind.mjs +10 -0
  156. package/dist/esm/api/resources/okr/types/index.d.mts +2 -0
  157. package/dist/esm/api/resources/okr/types/index.mjs +2 -0
  158. package/dist/esm/api/resources/organization/client/Client.d.mts +5 -2
  159. package/dist/esm/api/resources/organization/client/Client.mjs +5 -2
  160. package/dist/esm/api/resources/organization/types/Organization.d.mts +21 -0
  161. package/dist/esm/api/resources/organization/types/UpdateOrganizationRequest.d.mts +15 -0
  162. package/dist/esm/api/resources/platform/client/Client.d.mts +2 -2
  163. package/dist/esm/api/resources/platform/client/Client.mjs +2 -2
  164. package/dist/esm/api/resources/platform/types/NotificationChannels.d.mts +7 -2
  165. package/dist/esm/api/resources/platform/types/UpdateNotificationChannels.d.mts +1 -0
  166. package/dist/esm/api/resources/platform/types/UpdateNotificationPreferencesRequest.d.mts +1 -1
  167. package/dist/esm/api/resources/platform/types/WaitingForSeat.d.mts +2 -2
  168. package/dist/esm/api/resources/posts/client/Client.d.mts +5 -2
  169. package/dist/esm/api/resources/posts/client/Client.mjs +13 -2
  170. package/dist/esm/api/resources/posts/types/LaunchPost.d.mts +4 -3
  171. package/dist/esm/api/resources/slackConnections/client/Client.d.mts +56 -0
  172. package/dist/esm/api/resources/slackConnections/client/Client.mjs +206 -0
  173. package/dist/esm/api/resources/slackConnections/client/index.d.mts +1 -0
  174. package/dist/esm/api/resources/slackConnections/client/index.mjs +1 -0
  175. package/dist/esm/api/resources/slackConnections/client/requests/ListSlackConnectionsRequest.d.mts +9 -0
  176. package/dist/esm/api/resources/slackConnections/client/requests/ListSlackConnectionsRequest.mjs +2 -0
  177. package/dist/esm/api/resources/slackConnections/client/requests/index.d.mts +1 -0
  178. package/dist/esm/api/resources/slackConnections/client/requests/index.mjs +1 -0
  179. package/dist/esm/api/resources/slackConnections/exports.d.mts +2 -0
  180. package/dist/esm/api/resources/slackConnections/exports.mjs +3 -0
  181. package/dist/esm/api/resources/slackConnections/index.d.mts +2 -0
  182. package/dist/esm/api/resources/slackConnections/index.mjs +2 -0
  183. package/dist/esm/api/resources/slackConnections/types/SlackConnection.d.mts +16 -0
  184. package/dist/esm/api/resources/slackConnections/types/SlackConnection.mjs +2 -0
  185. package/dist/esm/api/resources/slackConnections/types/SlackConnectionAccount.d.mts +15 -0
  186. package/dist/esm/api/resources/slackConnections/types/SlackConnectionAccount.mjs +2 -0
  187. package/dist/esm/api/resources/slackConnections/types/SlackConnectionPage.d.mts +7 -0
  188. package/dist/esm/api/resources/slackConnections/types/SlackConnectionPage.mjs +2 -0
  189. package/dist/esm/api/resources/slackConnections/types/SlackConnectionPerson.d.mts +7 -0
  190. package/dist/esm/api/resources/slackConnections/types/SlackConnectionPerson.mjs +2 -0
  191. package/dist/esm/api/resources/slackConnections/types/index.d.mts +4 -0
  192. package/dist/esm/api/resources/slackConnections/types/index.mjs +4 -0
  193. package/dist/esm/api/resources/steps/client/Client.d.mts +15 -9
  194. package/dist/esm/api/resources/steps/client/Client.mjs +17 -10
  195. package/dist/esm/api/resources/steps/client/requests/ListReviewsRequest.d.mts +12 -1
  196. package/dist/esm/api/resources/steps/types/NudgeReason.d.mts +10 -0
  197. package/dist/esm/api/resources/steps/types/NudgeReason.mjs +10 -0
  198. package/dist/esm/api/resources/steps/types/NudgeResponse.d.mts +11 -1
  199. package/dist/esm/api/resources/steps/types/index.d.mts +1 -0
  200. package/dist/esm/api/resources/steps/types/index.mjs +1 -0
  201. package/dist/esm/serialization/resources/dory/types/EventCalendarInvite.d.mts +20 -0
  202. package/dist/esm/serialization/resources/dory/types/EventCalendarInvite.mjs +16 -0
  203. package/dist/esm/serialization/resources/dory/types/index.d.mts +1 -0
  204. package/dist/esm/serialization/resources/dory/types/index.mjs +1 -0
  205. package/dist/esm/serialization/resources/index.d.mts +2 -0
  206. package/dist/esm/serialization/resources/index.mjs +2 -0
  207. package/dist/esm/serialization/resources/launches/types/LaunchActivityVerb.d.mts +1 -1
  208. package/dist/esm/serialization/resources/launches/types/LaunchActivityVerb.mjs +1 -0
  209. package/dist/esm/serialization/resources/okr/types/KeyResult.d.mts +3 -0
  210. package/dist/esm/serialization/resources/okr/types/KeyResult.mjs +3 -0
  211. package/dist/esm/serialization/resources/okr/types/KeyResultMetric.d.mts +12 -0
  212. package/dist/esm/serialization/resources/okr/types/KeyResultMetric.mjs +8 -0
  213. package/dist/esm/serialization/resources/okr/types/MetricSourceKind.d.mts +7 -0
  214. package/dist/esm/serialization/resources/okr/types/MetricSourceKind.mjs +3 -0
  215. package/dist/esm/serialization/resources/okr/types/index.d.mts +2 -0
  216. package/dist/esm/serialization/resources/okr/types/index.mjs +2 -0
  217. package/dist/esm/serialization/resources/organization/types/Organization.d.mts +2 -0
  218. package/dist/esm/serialization/resources/organization/types/Organization.mjs +2 -0
  219. package/dist/esm/serialization/resources/organization/types/UpdateOrganizationRequest.d.mts +2 -0
  220. package/dist/esm/serialization/resources/organization/types/UpdateOrganizationRequest.mjs +2 -0
  221. package/dist/esm/serialization/resources/platform/types/NotificationChannels.d.mts +1 -0
  222. package/dist/esm/serialization/resources/platform/types/NotificationChannels.mjs +1 -0
  223. package/dist/esm/serialization/resources/platform/types/UpdateNotificationChannels.d.mts +1 -0
  224. package/dist/esm/serialization/resources/platform/types/UpdateNotificationChannels.mjs +1 -0
  225. package/dist/esm/serialization/resources/slackConnections/index.d.mts +1 -0
  226. package/dist/esm/serialization/resources/slackConnections/index.mjs +1 -0
  227. package/dist/esm/serialization/resources/slackConnections/types/SlackConnection.d.mts +14 -0
  228. package/dist/esm/serialization/resources/slackConnections/types/SlackConnection.mjs +10 -0
  229. package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionAccount.d.mts +11 -0
  230. package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionAccount.mjs +7 -0
  231. package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionPage.d.mts +12 -0
  232. package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionPage.mjs +8 -0
  233. package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionPerson.d.mts +10 -0
  234. package/dist/esm/serialization/resources/slackConnections/types/SlackConnectionPerson.mjs +6 -0
  235. package/dist/esm/serialization/resources/slackConnections/types/index.d.mts +4 -0
  236. package/dist/esm/serialization/resources/slackConnections/types/index.mjs +4 -0
  237. package/dist/esm/serialization/resources/steps/types/NudgeReason.d.mts +7 -0
  238. package/dist/esm/serialization/resources/steps/types/NudgeReason.mjs +3 -0
  239. package/dist/esm/serialization/resources/steps/types/NudgeResponse.d.mts +7 -1
  240. package/dist/esm/serialization/resources/steps/types/NudgeResponse.mjs +7 -1
  241. package/dist/esm/serialization/resources/steps/types/index.d.mts +1 -0
  242. package/dist/esm/serialization/resources/steps/types/index.mjs +1 -0
  243. package/dist/esm/version.d.mts +1 -1
  244. package/dist/esm/version.mjs +1 -1
  245. package/package.json +13 -1
  246. package/reference.md +285 -39
@@ -0,0 +1,56 @@
1
+ import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
2
+ import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
3
+ import * as core from "../../../../core/index.js";
4
+ import * as Taktoria from "../../../index.js";
5
+ export declare namespace SlackConnectionsClient {
6
+ type Options = BaseClientOptions;
7
+ interface RequestOptions extends BaseRequestOptions {
8
+ }
9
+ }
10
+ export declare class SlackConnectionsClient {
11
+ protected readonly _options: NormalizedClientOptionsWithAuth<SlackConnectionsClient.Options>;
12
+ constructor(options: SlackConnectionsClient.Options);
13
+ /**
14
+ * The workspace's Slack connections, newest first. A key, or a
15
+ * workspace admin's session, sees every one; anybody else's session
16
+ * sees their own, as the connect page lists them. Requires
17
+ * `slackConnections:read`.
18
+ *
19
+ * @param {Taktoria.ListSlackConnectionsRequest} request
20
+ * @param {SlackConnectionsClient.RequestOptions} requestOptions - Request-specific configuration.
21
+ *
22
+ * @throws {@link Taktoria.UnauthorizedError}
23
+ * @throws {@link Taktoria.ForbiddenError}
24
+ * @throws {@link Taktoria.TooManyRequestsError}
25
+ * @throws {@link errors.TaktoriaError}
26
+ * @throws {@link errors.TaktoriaTimeoutError}
27
+ *
28
+ * @example
29
+ * await client.slackConnections.list()
30
+ */
31
+ list(request?: Taktoria.ListSlackConnectionsRequest, requestOptions?: SlackConnectionsClient.RequestOptions): core.HttpResponsePromise<Taktoria.SlackConnectionPage>;
32
+ private __list;
33
+ /**
34
+ * Disconnect a Slack account, as the connect page's **Disconnect**
35
+ * does: where Google is required, its commands are refused from the
36
+ * next one, with a link to connect again. In the audit log as
37
+ * `slack_user_link.deleted`. Requires `slackConnections:write`. A
38
+ * person's session disconnects their own; a key or a workspace admin's
39
+ * session, anybody's. One the caller may not see is `404 not_found`.
40
+ *
41
+ * @param {string} connectionId
42
+ * @param {SlackConnectionsClient.RequestOptions} requestOptions - Request-specific configuration.
43
+ *
44
+ * @throws {@link Taktoria.UnauthorizedError}
45
+ * @throws {@link Taktoria.ForbiddenError}
46
+ * @throws {@link Taktoria.NotFoundError}
47
+ * @throws {@link Taktoria.TooManyRequestsError}
48
+ * @throws {@link errors.TaktoriaError}
49
+ * @throws {@link errors.TaktoriaTimeoutError}
50
+ *
51
+ * @example
52
+ * await client.slackConnections.disconnect("slk_4b1e")
53
+ */
54
+ disconnect(connectionId: string, requestOptions?: SlackConnectionsClient.RequestOptions): core.HttpResponsePromise<void>;
55
+ private __disconnect;
56
+ }
@@ -0,0 +1,243 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
37
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
38
+ return new (P || (P = Promise))(function (resolve, reject) {
39
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
40
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
41
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
42
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
43
+ });
44
+ };
45
+ Object.defineProperty(exports, "__esModule", { value: true });
46
+ exports.SlackConnectionsClient = void 0;
47
+ const BaseClient_js_1 = require("../../../../BaseClient.js");
48
+ const headers_js_1 = require("../../../../core/headers.js");
49
+ const core = __importStar(require("../../../../core/index.js"));
50
+ const environments = __importStar(require("../../../../environments.js"));
51
+ const handleNonStatusCodeError_js_1 = require("../../../../errors/handleNonStatusCodeError.js");
52
+ const errors = __importStar(require("../../../../errors/index.js"));
53
+ const serializers = __importStar(require("../../../../serialization/index.js"));
54
+ const Taktoria = __importStar(require("../../../index.js"));
55
+ class SlackConnectionsClient {
56
+ constructor(options) {
57
+ this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
58
+ }
59
+ /**
60
+ * The workspace's Slack connections, newest first. A key, or a
61
+ * workspace admin's session, sees every one; anybody else's session
62
+ * sees their own, as the connect page lists them. Requires
63
+ * `slackConnections:read`.
64
+ *
65
+ * @param {Taktoria.ListSlackConnectionsRequest} request
66
+ * @param {SlackConnectionsClient.RequestOptions} requestOptions - Request-specific configuration.
67
+ *
68
+ * @throws {@link Taktoria.UnauthorizedError}
69
+ * @throws {@link Taktoria.ForbiddenError}
70
+ * @throws {@link Taktoria.TooManyRequestsError}
71
+ * @throws {@link errors.TaktoriaError}
72
+ * @throws {@link errors.TaktoriaTimeoutError}
73
+ *
74
+ * @example
75
+ * await client.slackConnections.list()
76
+ */
77
+ list(request = {}, requestOptions) {
78
+ return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
79
+ }
80
+ __list() {
81
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
82
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
83
+ const { limit, cursor } = request;
84
+ const _queryParams = {
85
+ limit,
86
+ cursor,
87
+ };
88
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
89
+ 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);
90
+ const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
91
+ url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.TaktoriaEnvironment.Production, "/slack-connections"),
92
+ method: "GET",
93
+ headers: _headers,
94
+ queryString: core.url
95
+ .queryBuilder()
96
+ .addMany(_queryParams)
97
+ .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
98
+ .build(),
99
+ timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
100
+ maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
101
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
102
+ fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
103
+ logging: this._options.logging,
104
+ });
105
+ if (_response.ok) {
106
+ return {
107
+ data: serializers.SlackConnectionPage.parseOrThrow(_response.body, {
108
+ unrecognizedObjectKeys: "passthrough",
109
+ allowUnrecognizedUnionMembers: true,
110
+ allowUnrecognizedEnumValues: true,
111
+ skipValidation: true,
112
+ breadcrumbsPrefix: ["response"],
113
+ }),
114
+ rawResponse: _response.rawResponse,
115
+ };
116
+ }
117
+ if (_response.error.reason === "status-code") {
118
+ switch (_response.error.statusCode) {
119
+ case 401:
120
+ throw new Taktoria.UnauthorizedError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
121
+ unrecognizedObjectKeys: "passthrough",
122
+ allowUnrecognizedUnionMembers: true,
123
+ allowUnrecognizedEnumValues: true,
124
+ skipValidation: true,
125
+ breadcrumbsPrefix: ["response"],
126
+ }), _response.rawResponse);
127
+ case 403:
128
+ throw new Taktoria.ForbiddenError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
129
+ unrecognizedObjectKeys: "passthrough",
130
+ allowUnrecognizedUnionMembers: true,
131
+ allowUnrecognizedEnumValues: true,
132
+ skipValidation: true,
133
+ breadcrumbsPrefix: ["response"],
134
+ }), _response.rawResponse);
135
+ case 429:
136
+ throw new Taktoria.TooManyRequestsError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
137
+ unrecognizedObjectKeys: "passthrough",
138
+ allowUnrecognizedUnionMembers: true,
139
+ allowUnrecognizedEnumValues: true,
140
+ skipValidation: true,
141
+ breadcrumbsPrefix: ["response"],
142
+ }), _response.rawResponse);
143
+ default:
144
+ throw new errors.TaktoriaError({
145
+ statusCode: _response.error.statusCode,
146
+ body: _response.error.body,
147
+ rawResponse: _response.rawResponse,
148
+ });
149
+ }
150
+ }
151
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/slack-connections");
152
+ });
153
+ }
154
+ /**
155
+ * Disconnect a Slack account, as the connect page's **Disconnect**
156
+ * does: where Google is required, its commands are refused from the
157
+ * next one, with a link to connect again. In the audit log as
158
+ * `slack_user_link.deleted`. Requires `slackConnections:write`. A
159
+ * person's session disconnects their own; a key or a workspace admin's
160
+ * session, anybody's. One the caller may not see is `404 not_found`.
161
+ *
162
+ * @param {string} connectionId
163
+ * @param {SlackConnectionsClient.RequestOptions} requestOptions - Request-specific configuration.
164
+ *
165
+ * @throws {@link Taktoria.UnauthorizedError}
166
+ * @throws {@link Taktoria.ForbiddenError}
167
+ * @throws {@link Taktoria.NotFoundError}
168
+ * @throws {@link Taktoria.TooManyRequestsError}
169
+ * @throws {@link errors.TaktoriaError}
170
+ * @throws {@link errors.TaktoriaTimeoutError}
171
+ *
172
+ * @example
173
+ * await client.slackConnections.disconnect("slk_4b1e")
174
+ */
175
+ disconnect(connectionId, requestOptions) {
176
+ return core.HttpResponsePromise.fromPromise(this.__disconnect(connectionId, requestOptions));
177
+ }
178
+ __disconnect(connectionId, requestOptions) {
179
+ return __awaiter(this, void 0, void 0, function* () {
180
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
181
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
182
+ 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);
183
+ const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
184
+ url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.TaktoriaEnvironment.Production, `/slack-connections/${core.url.encodePathParam(connectionId)}`),
185
+ method: "DELETE",
186
+ headers: _headers,
187
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
188
+ timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
189
+ maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
190
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
191
+ fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
192
+ logging: this._options.logging,
193
+ });
194
+ if (_response.ok) {
195
+ return { data: undefined, rawResponse: _response.rawResponse };
196
+ }
197
+ if (_response.error.reason === "status-code") {
198
+ switch (_response.error.statusCode) {
199
+ case 401:
200
+ throw new Taktoria.UnauthorizedError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
201
+ unrecognizedObjectKeys: "passthrough",
202
+ allowUnrecognizedUnionMembers: true,
203
+ allowUnrecognizedEnumValues: true,
204
+ skipValidation: true,
205
+ breadcrumbsPrefix: ["response"],
206
+ }), _response.rawResponse);
207
+ case 403:
208
+ throw new Taktoria.ForbiddenError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
209
+ unrecognizedObjectKeys: "passthrough",
210
+ allowUnrecognizedUnionMembers: true,
211
+ allowUnrecognizedEnumValues: true,
212
+ skipValidation: true,
213
+ breadcrumbsPrefix: ["response"],
214
+ }), _response.rawResponse);
215
+ case 404:
216
+ throw new Taktoria.NotFoundError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
217
+ unrecognizedObjectKeys: "passthrough",
218
+ allowUnrecognizedUnionMembers: true,
219
+ allowUnrecognizedEnumValues: true,
220
+ skipValidation: true,
221
+ breadcrumbsPrefix: ["response"],
222
+ }), _response.rawResponse);
223
+ case 429:
224
+ throw new Taktoria.TooManyRequestsError(serializers.ErrorBody.parseOrThrow(_response.error.body, {
225
+ unrecognizedObjectKeys: "passthrough",
226
+ allowUnrecognizedUnionMembers: true,
227
+ allowUnrecognizedEnumValues: true,
228
+ skipValidation: true,
229
+ breadcrumbsPrefix: ["response"],
230
+ }), _response.rawResponse);
231
+ default:
232
+ throw new errors.TaktoriaError({
233
+ statusCode: _response.error.statusCode,
234
+ body: _response.error.body,
235
+ rawResponse: _response.rawResponse,
236
+ });
237
+ }
238
+ }
239
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/slack-connections/{connectionId}");
240
+ });
241
+ }
242
+ }
243
+ exports.SlackConnectionsClient = SlackConnectionsClient;
@@ -0,0 +1 @@
1
+ export * from "./requests/index.js";
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./requests/index.js"), exports);
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @example
3
+ * {}
4
+ */
5
+ export interface ListSlackConnectionsRequest {
6
+ /** 1 to 200; 50 by default. */
7
+ limit?: number;
8
+ cursor?: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1 @@
1
+ export type { ListSlackConnectionsRequest } from "./ListSlackConnectionsRequest.js";
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,2 @@
1
+ export { SlackConnectionsClient } from "./client/Client.js";
2
+ export * from "./client/index.js";
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16
+ };
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ exports.SlackConnectionsClient = void 0;
19
+ var Client_js_1 = require("./client/Client.js");
20
+ Object.defineProperty(exports, "SlackConnectionsClient", { enumerable: true, get: function () { return Client_js_1.SlackConnectionsClient; } });
21
+ __exportStar(require("./client/index.js"), exports);
@@ -0,0 +1,2 @@
1
+ export * from "./client/index.js";
2
+ export * from "./types/index.js";
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./client/index.js"), exports);
18
+ __exportStar(require("./types/index.js"), exports);
@@ -0,0 +1,16 @@
1
+ import type * as Taktoria from "../../../index.js";
2
+ /**
3
+ * A Slack account its owner connected by signing in with Google, on the
4
+ * page a Slack command links to. In a workspace that requires Google
5
+ * sign-in and does not take Slack's word for who typed a command
6
+ * (`slackCommandsWithoutGoogle` false on `GET /organization`), only a
7
+ * connected account's commands are acted on: as its owner, with their
8
+ * seats and rights. A connection counts only while Slack still gives the
9
+ * address of the member who made it.
10
+ */
11
+ export interface SlackConnection {
12
+ id: string;
13
+ person: Taktoria.SlackConnectionPerson;
14
+ slack: Taktoria.SlackConnectionAccount;
15
+ createdAt: Date;
16
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,15 @@
1
+ /**
2
+ * The Slack account connected.
3
+ */
4
+ export interface SlackConnectionAccount {
5
+ /** The Slack workspace's id, such as `T0123ABCD`. */
6
+ teamId: string;
7
+ /**
8
+ * The Slack workspace's name, while Taktoria is still connected to
9
+ * it. A connection to a Slack workspace since disconnected keeps its
10
+ * id, and does nothing.
11
+ */
12
+ teamName?: string;
13
+ /** The person's Slack user id, such as `U0123ABCD`. */
14
+ userId: string;
15
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ import type * as Taktoria from "../../../index.js";
2
+ export interface SlackConnectionPage {
3
+ data: Taktoria.SlackConnection[];
4
+ /** Pass as `cursor` for the next page; null on the last. */
5
+ nextCursor?: string;
6
+ hasMore: boolean;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ /**
2
+ * The member whose Slack account it is, and whom Slack commands act as.
3
+ */
4
+ export interface SlackConnectionPerson {
5
+ id: string;
6
+ name: string;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,4 @@
1
+ export * from "./SlackConnection.js";
2
+ export * from "./SlackConnectionAccount.js";
3
+ export * from "./SlackConnectionPage.js";
4
+ export * from "./SlackConnectionPerson.js";
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./SlackConnection.js"), exports);
18
+ __exportStar(require("./SlackConnectionAccount.js"), exports);
19
+ __exportStar(require("./SlackConnectionPage.js"), exports);
20
+ __exportStar(require("./SlackConnectionPerson.js"), exports);
@@ -47,10 +47,14 @@ export declare class StepsClient {
47
47
  createForLaunch(launchId: string, request: Taktoria.CreateStepRequest, requestOptions?: StepsClient.RequestOptions): core.HttpResponsePromise<Taktoria.LaunchStep>;
48
48
  private __createForLaunch;
49
49
  /**
50
- * "Add Launch Steps" copies the steps of the launch's own launch template
50
+ * "Add launch steps" copies the steps of the launch's own launch template
51
51
  * (`launchTemplateId`, the workspace's default when it has none) onto
52
52
  * the launch, back-scheduling each step from the planned launch date, and
53
- * creates the press release, dashboard and learnings artifacts. Run again,
53
+ * creates the press release, dashboard and learnings artifacts. A step
54
+ * starts with its template step's default reviewer
55
+ * (`defaultReviewer` on the step template) when that is still a member
56
+ * of the workspace, who is told as anybody given a step is: once the
57
+ * launch is published, if it is a draft. Run again,
54
58
  * say after the launch switches template, it adds only the steps the
55
59
  * launch lacks: a step it already has, or the same review (the same name
56
60
  * for the same functional team) from another template, is left out, and
@@ -165,12 +169,14 @@ export declare class StepsClient {
165
169
  setReason(stepId: string, request: Taktoria.SetDecisionReasonRequest, requestOptions?: StepsClient.RequestOptions): core.HttpResponsePromise<Taktoria.LaunchStep>;
166
170
  private __setReason;
167
171
  /**
168
- * Nudge the assigned reviewer over email and Slack. Throttled to one
169
- * nudge per step per hour however many times it is called; `queued`
170
- * is true either way, and `lastNudgedAt` on the step says when the
171
- * last one went. A draft's reviewer hears nothing until it is
172
- * published. A step with no reviewer is `409 no_reviewer`, and a key
173
- * whose maker has left the workspace is `403 forbidden`: a nudge
172
+ * Nudge the assigned reviewer over email and Slack, as the step's bell
173
+ * does in the app. One nudge per step goes out an hour however many
174
+ * times it is called, and none on a draft, whose reviewers hear
175
+ * nothing until it is published: `sent` says whether this one went
176
+ * out and, when not, `reason` says why (`throttled`, with
177
+ * `retryInMinutes`, or `draft`). `lastNudgedAt` on the step says when
178
+ * the last one went. A step with no reviewer is `409 no_reviewer`, and
179
+ * a key whose maker has left the workspace is `403 forbidden`: a nudge
174
180
  * comes from a person.
175
181
  *
176
182
  * @param {string} stepId
@@ -184,7 +190,7 @@ export declare class StepsClient {
184
190
  * @throws {@link errors.TaktoriaTimeoutError}
185
191
  *
186
192
  * @example
187
- * await client.steps.nudge("stepId")
193
+ * await client.steps.nudge("stp_1")
188
194
  */
189
195
  nudge(stepId: string, requestOptions?: StepsClient.RequestOptions): core.HttpResponsePromise<Taktoria.NudgeResponse>;
190
196
  private __nudge;
@@ -232,10 +232,14 @@ class StepsClient {
232
232
  });
233
233
  }
234
234
  /**
235
- * "Add Launch Steps" copies the steps of the launch's own launch template
235
+ * "Add launch steps" copies the steps of the launch's own launch template
236
236
  * (`launchTemplateId`, the workspace's default when it has none) onto
237
237
  * the launch, back-scheduling each step from the planned launch date, and
238
- * creates the press release, dashboard and learnings artifacts. Run again,
238
+ * creates the press release, dashboard and learnings artifacts. A step
239
+ * starts with its template step's default reviewer
240
+ * (`defaultReviewer` on the step template) when that is still a member
241
+ * of the workspace, who is told as anybody given a step is: once the
242
+ * launch is published, if it is a draft. Run again,
239
243
  * say after the launch switches template, it adds only the steps the
240
244
  * launch lacks: a step it already has, or the same review (the same name
241
245
  * for the same functional team) from another template, is left out, and
@@ -779,12 +783,14 @@ class StepsClient {
779
783
  });
780
784
  }
781
785
  /**
782
- * Nudge the assigned reviewer over email and Slack. Throttled to one
783
- * nudge per step per hour however many times it is called; `queued`
784
- * is true either way, and `lastNudgedAt` on the step says when the
785
- * last one went. A draft's reviewer hears nothing until it is
786
- * published. A step with no reviewer is `409 no_reviewer`, and a key
787
- * whose maker has left the workspace is `403 forbidden`: a nudge
786
+ * Nudge the assigned reviewer over email and Slack, as the step's bell
787
+ * does in the app. One nudge per step goes out an hour however many
788
+ * times it is called, and none on a draft, whose reviewers hear
789
+ * nothing until it is published: `sent` says whether this one went
790
+ * out and, when not, `reason` says why (`throttled`, with
791
+ * `retryInMinutes`, or `draft`). `lastNudgedAt` on the step says when
792
+ * the last one went. A step with no reviewer is `409 no_reviewer`, and
793
+ * a key whose maker has left the workspace is `403 forbidden`: a nudge
788
794
  * comes from a person.
789
795
  *
790
796
  * @param {string} stepId
@@ -798,7 +804,7 @@ class StepsClient {
798
804
  * @throws {@link errors.TaktoriaTimeoutError}
799
805
  *
800
806
  * @example
801
- * await client.steps.nudge("stepId")
807
+ * await client.steps.nudge("stp_1")
802
808
  */
803
809
  nudge(stepId, requestOptions) {
804
810
  return core.HttpResponsePromise.fromPromise(this.__nudge(stepId, requestOptions));
@@ -899,7 +905,7 @@ class StepsClient {
899
905
  __reviewQueue() {
900
906
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
901
907
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
902
- const { team, mine, status, reviewerUserId, q, year, quarter, limit, cursor } = request;
908
+ const { team, mine, status, reviewerUserId, q, period, year, quarter, limit, cursor } = request;
903
909
  const _queryParams = {
904
910
  team,
905
911
  mine,
@@ -911,6 +917,7 @@ class StepsClient {
911
917
  : undefined,
912
918
  reviewerUserId,
913
919
  q,
920
+ period,
914
921
  year,
915
922
  quarter,
916
923
  limit,
@@ -12,7 +12,18 @@ export interface ListReviewsRequest {
12
12
  reviewerUserId?: string;
13
13
  /** Search steps by their own name and their launch's name. 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. */
14
14
  q?: string;
15
- /** A fiscal year, as the workspace's fiscal year start names it. Narrows by due date; left out, every year. */
15
+ /**
16
+ * A fiscal period, as the app's period picker and its URL name them:
17
+ * a quarter (`2026-Q4`), a whole year (`2027`), `upcoming` for this
18
+ * quarter and every one after it, or `all`. Repeat it for several
19
+ * (`period=2026-Q4&period=2027-Q1`); `upcoming` or `all` among them
20
+ * wins over the rest. Narrows by due date in the workspace's fiscal
21
+ * years. With `upcoming` it keeps those with no date yet, as the
22
+ * app's lists do. Left out, with no `year`, every period. Wins over
23
+ * `year` and `quarter`; anything else is a `422 validation_error`.
24
+ */
25
+ period?: string | string[];
26
+ /** One fiscal year, as the workspace's fiscal year start names it. Narrows by due date; left out, every year. `period` takes several. */
16
27
  year?: number;
17
28
  /** A fiscal quarter, 1 to 4, of `year`. Needs `year`; left out, the whole year. */
18
29
  quarter?: number;
@@ -0,0 +1,10 @@
1
+ /** Why a nudge was not sent. */
2
+ export declare const NudgeReason: {
3
+ /**
4
+ * The reviewer was nudged on this step within the hour. */
5
+ readonly Throttled: "throttled";
6
+ /**
7
+ * The launch is a draft, so its reviewers hear nothing until it is published. */
8
+ readonly Draft: "draft";
9
+ };
10
+ export type NudgeReason = (typeof NudgeReason)[keyof typeof NudgeReason];