@keboola/api-client 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (265) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +456 -0
  3. package/dist/ai/index.cjs +203 -0
  4. package/dist/ai/index.cjs.map +1 -0
  5. package/dist/ai/index.d.cts +35 -0
  6. package/dist/ai/index.d.ts +35 -0
  7. package/dist/ai/index.js +197 -0
  8. package/dist/ai/index.js.map +1 -0
  9. package/dist/ai/types.cjs +4 -0
  10. package/dist/ai/types.cjs.map +1 -0
  11. package/dist/ai/types.d.cts +2 -0
  12. package/dist/ai/types.d.ts +2 -0
  13. package/dist/ai/types.js +3 -0
  14. package/dist/ai/types.js.map +1 -0
  15. package/dist/assets/index.cjs +182 -0
  16. package/dist/assets/index.cjs.map +1 -0
  17. package/dist/assets/index.d.cts +9 -0
  18. package/dist/assets/index.d.ts +9 -0
  19. package/dist/assets/index.js +176 -0
  20. package/dist/assets/index.js.map +1 -0
  21. package/dist/assets/types.cjs +4 -0
  22. package/dist/assets/types.cjs.map +1 -0
  23. package/dist/assets/types.d.cts +8 -0
  24. package/dist/assets/types.d.ts +8 -0
  25. package/dist/assets/types.js +3 -0
  26. package/dist/assets/types.js.map +1 -0
  27. package/dist/authMiddleware-BTFSCMTE.d.ts +11 -0
  28. package/dist/authMiddleware-BteBe1Bt.d.cts +11 -0
  29. package/dist/chat/index.cjs +428 -0
  30. package/dist/chat/index.cjs.map +1 -0
  31. package/dist/chat/index.d.cts +51 -0
  32. package/dist/chat/index.d.ts +51 -0
  33. package/dist/chat/index.js +422 -0
  34. package/dist/chat/index.js.map +1 -0
  35. package/dist/chat/suggestions.cjs +158 -0
  36. package/dist/chat/suggestions.cjs.map +1 -0
  37. package/dist/chat/suggestions.d.cts +437 -0
  38. package/dist/chat/suggestions.d.ts +437 -0
  39. package/dist/chat/suggestions.js +140 -0
  40. package/dist/chat/suggestions.js.map +1 -0
  41. package/dist/chat/types.cjs +10 -0
  42. package/dist/chat/types.cjs.map +1 -0
  43. package/dist/chat/types.d.cts +3 -0
  44. package/dist/chat/types.d.ts +3 -0
  45. package/dist/chat/types.js +8 -0
  46. package/dist/chat/types.js.map +1 -0
  47. package/dist/createGenericFetchClient-CLUzu-jY.d.cts +18 -0
  48. package/dist/createGenericFetchClient-DEakI3F1.d.ts +18 -0
  49. package/dist/createOpenapiFetchClient-CpXmAIFB.d.cts +24 -0
  50. package/dist/createOpenapiFetchClient-_sm4bchL.d.ts +24 -0
  51. package/dist/dataScience/index.cjs +416 -0
  52. package/dist/dataScience/index.cjs.map +1 -0
  53. package/dist/dataScience/index.d.cts +191 -0
  54. package/dist/dataScience/index.d.ts +191 -0
  55. package/dist/dataScience/index.js +388 -0
  56. package/dist/dataScience/index.js.map +1 -0
  57. package/dist/dataScience/types.cjs +4 -0
  58. package/dist/dataScience/types.cjs.map +1 -0
  59. package/dist/dataScience/types.d.cts +2 -0
  60. package/dist/dataScience/types.d.ts +2 -0
  61. package/dist/dataScience/types.js +3 -0
  62. package/dist/dataScience/types.js.map +1 -0
  63. package/dist/editor/index.cjs +275 -0
  64. package/dist/editor/index.cjs.map +1 -0
  65. package/dist/editor/index.d.cts +172 -0
  66. package/dist/editor/index.d.ts +172 -0
  67. package/dist/editor/index.js +269 -0
  68. package/dist/editor/index.js.map +1 -0
  69. package/dist/editor/types.cjs +4 -0
  70. package/dist/editor/types.cjs.map +1 -0
  71. package/dist/editor/types.d.cts +2 -0
  72. package/dist/editor/types.d.ts +2 -0
  73. package/dist/editor/types.js +3 -0
  74. package/dist/editor/types.js.map +1 -0
  75. package/dist/encryption/index.cjs +192 -0
  76. package/dist/encryption/index.cjs.map +1 -0
  77. package/dist/encryption/index.d.cts +14 -0
  78. package/dist/encryption/index.d.ts +14 -0
  79. package/dist/encryption/index.js +186 -0
  80. package/dist/encryption/index.js.map +1 -0
  81. package/dist/encryption/types.cjs +4 -0
  82. package/dist/encryption/types.cjs.map +1 -0
  83. package/dist/encryption/types.d.cts +8 -0
  84. package/dist/encryption/types.d.ts +8 -0
  85. package/dist/encryption/types.js +3 -0
  86. package/dist/encryption/types.js.map +1 -0
  87. package/dist/import/index.cjs +198 -0
  88. package/dist/import/index.cjs.map +1 -0
  89. package/dist/import/index.d.cts +9 -0
  90. package/dist/import/index.d.ts +9 -0
  91. package/dist/import/index.js +192 -0
  92. package/dist/import/index.js.map +1 -0
  93. package/dist/index.cjs +3910 -0
  94. package/dist/index.cjs.map +1 -0
  95. package/dist/index.d.cts +3108 -0
  96. package/dist/index.d.ts +3108 -0
  97. package/dist/index.js +3858 -0
  98. package/dist/index.js.map +1 -0
  99. package/dist/keboolaUID-D1DGSbge.d.cts +19 -0
  100. package/dist/keboolaUID-D1DGSbge.d.ts +19 -0
  101. package/dist/management/index.cjs +872 -0
  102. package/dist/management/index.cjs.map +1 -0
  103. package/dist/management/index.d.cts +440 -0
  104. package/dist/management/index.d.ts +440 -0
  105. package/dist/management/index.js +865 -0
  106. package/dist/management/index.js.map +1 -0
  107. package/dist/management/types.cjs +4 -0
  108. package/dist/management/types.cjs.map +1 -0
  109. package/dist/management/types.d.cts +9 -0
  110. package/dist/management/types.d.ts +9 -0
  111. package/dist/management/types.js +3 -0
  112. package/dist/management/types.js.map +1 -0
  113. package/dist/metastore/index.cjs +339 -0
  114. package/dist/metastore/index.cjs.map +1 -0
  115. package/dist/metastore/index.d.cts +52 -0
  116. package/dist/metastore/index.d.ts +52 -0
  117. package/dist/metastore/index.js +333 -0
  118. package/dist/metastore/index.js.map +1 -0
  119. package/dist/metastore/types.cjs +4 -0
  120. package/dist/metastore/types.cjs.map +1 -0
  121. package/dist/metastore/types.d.cts +2 -0
  122. package/dist/metastore/types.d.ts +2 -0
  123. package/dist/metastore/types.js +3 -0
  124. package/dist/metastore/types.js.map +1 -0
  125. package/dist/queryService/index.cjs +250 -0
  126. package/dist/queryService/index.cjs.map +1 -0
  127. package/dist/queryService/index.d.cts +39 -0
  128. package/dist/queryService/index.d.ts +39 -0
  129. package/dist/queryService/index.js +244 -0
  130. package/dist/queryService/index.js.map +1 -0
  131. package/dist/queryService/types.cjs +4 -0
  132. package/dist/queryService/types.cjs.map +1 -0
  133. package/dist/queryService/types.d.cts +2 -0
  134. package/dist/queryService/types.d.ts +2 -0
  135. package/dist/queryService/types.js +3 -0
  136. package/dist/queryService/types.js.map +1 -0
  137. package/dist/queue/index.cjs +192 -0
  138. package/dist/queue/index.cjs.map +1 -0
  139. package/dist/queue/index.d.cts +133 -0
  140. package/dist/queue/index.d.ts +133 -0
  141. package/dist/queue/index.js +186 -0
  142. package/dist/queue/index.js.map +1 -0
  143. package/dist/queue/types.cjs +4 -0
  144. package/dist/queue/types.cjs.map +1 -0
  145. package/dist/queue/types.d.cts +2 -0
  146. package/dist/queue/types.d.ts +2 -0
  147. package/dist/queue/types.js +3 -0
  148. package/dist/queue/types.js.map +1 -0
  149. package/dist/sdk/storage/index.cjs +96 -0
  150. package/dist/sdk/storage/index.cjs.map +1 -0
  151. package/dist/sdk/storage/index.d.cts +24 -0
  152. package/dist/sdk/storage/index.d.ts +24 -0
  153. package/dist/sdk/storage/index.js +94 -0
  154. package/dist/sdk/storage/index.js.map +1 -0
  155. package/dist/sdk/tag/index.cjs +210 -0
  156. package/dist/sdk/tag/index.cjs.map +1 -0
  157. package/dist/sdk/tag/index.d.cts +25 -0
  158. package/dist/sdk/tag/index.d.ts +25 -0
  159. package/dist/sdk/tag/index.js +208 -0
  160. package/dist/sdk/tag/index.js.map +1 -0
  161. package/dist/sdk/tag/types.cjs +4 -0
  162. package/dist/sdk/tag/types.cjs.map +1 -0
  163. package/dist/sdk/tag/types.d.cts +30 -0
  164. package/dist/sdk/tag/types.d.ts +30 -0
  165. package/dist/sdk/tag/types.js +3 -0
  166. package/dist/sdk/tag/types.js.map +1 -0
  167. package/dist/status/index.cjs +178 -0
  168. package/dist/status/index.cjs.map +1 -0
  169. package/dist/status/index.d.cts +10 -0
  170. package/dist/status/index.d.ts +10 -0
  171. package/dist/status/index.js +172 -0
  172. package/dist/status/index.js.map +1 -0
  173. package/dist/status/types.cjs +4 -0
  174. package/dist/status/types.cjs.map +1 -0
  175. package/dist/status/types.d.cts +19 -0
  176. package/dist/status/types.d.ts +19 -0
  177. package/dist/status/types.js +3 -0
  178. package/dist/status/types.js.map +1 -0
  179. package/dist/storage/index.cjs +1021 -0
  180. package/dist/storage/index.cjs.map +1 -0
  181. package/dist/storage/index.d.cts +12 -0
  182. package/dist/storage/index.d.ts +12 -0
  183. package/dist/storage/index.js +1014 -0
  184. package/dist/storage/index.js.map +1 -0
  185. package/dist/storage/types.cjs +4 -0
  186. package/dist/storage/types.cjs.map +1 -0
  187. package/dist/storage/types.d.cts +10976 -0
  188. package/dist/storage/types.d.ts +10976 -0
  189. package/dist/storage/types.js +3 -0
  190. package/dist/storage/types.js.map +1 -0
  191. package/dist/storageClient-DPLh_p0V.d.cts +608 -0
  192. package/dist/storageClient-YVWer22Y.d.ts +608 -0
  193. package/dist/syncActions/index.cjs +366 -0
  194. package/dist/syncActions/index.cjs.map +1 -0
  195. package/dist/syncActions/index.d.cts +94 -0
  196. package/dist/syncActions/index.d.ts +94 -0
  197. package/dist/syncActions/index.js +341 -0
  198. package/dist/syncActions/index.js.map +1 -0
  199. package/dist/syncActions/types.cjs +4 -0
  200. package/dist/syncActions/types.cjs.map +1 -0
  201. package/dist/syncActions/types.d.cts +261 -0
  202. package/dist/syncActions/types.d.ts +261 -0
  203. package/dist/syncActions/types.js +3 -0
  204. package/dist/syncActions/types.js.map +1 -0
  205. package/dist/telemetry/index.cjs +189 -0
  206. package/dist/telemetry/index.cjs.map +1 -0
  207. package/dist/telemetry/index.d.cts +13 -0
  208. package/dist/telemetry/index.d.ts +13 -0
  209. package/dist/telemetry/index.js +183 -0
  210. package/dist/telemetry/index.js.map +1 -0
  211. package/dist/telemetry/types.cjs +4 -0
  212. package/dist/telemetry/types.cjs.map +1 -0
  213. package/dist/telemetry/types.d.cts +12 -0
  214. package/dist/telemetry/types.d.ts +12 -0
  215. package/dist/telemetry/types.js +3 -0
  216. package/dist/telemetry/types.js.map +1 -0
  217. package/dist/types-B51cQMrX.d.ts +1408 -0
  218. package/dist/types-B7k8S4ki.d.ts +1520 -0
  219. package/dist/types-BNQK_jR_.d.cts +1520 -0
  220. package/dist/types-BY0tjg2Q.d.ts +1079 -0
  221. package/dist/types-BeShtGlc.d.cts +8591 -0
  222. package/dist/types-BeShtGlc.d.ts +8591 -0
  223. package/dist/types-BjrNNn5I.d.ts +1643 -0
  224. package/dist/types-C-bd4ArM.d.cts +1079 -0
  225. package/dist/types-C7mpAfq-.d.cts +64 -0
  226. package/dist/types-C7mpAfq-.d.ts +64 -0
  227. package/dist/types-CGMJT3JL.d.ts +943 -0
  228. package/dist/types-CRSKcua9.d.cts +1314 -0
  229. package/dist/types-DJ6nbNq5.d.cts +1643 -0
  230. package/dist/types-DJkU9gvB.d.cts +943 -0
  231. package/dist/types-DYMMsuU0.d.cts +78 -0
  232. package/dist/types-DYMMsuU0.d.ts +78 -0
  233. package/dist/types-Dg1tEsVR.d.cts +17 -0
  234. package/dist/types-Dg1tEsVR.d.ts +17 -0
  235. package/dist/types-DgaMV8FF.d.cts +60 -0
  236. package/dist/types-DgaMV8FF.d.ts +60 -0
  237. package/dist/types-Dws8mFNY.d.cts +1408 -0
  238. package/dist/types-cH0_hkCW.d.ts +1314 -0
  239. package/dist/utils-BNQZiNOu.d.ts +1657 -0
  240. package/dist/utils-DE09pDTi.d.cts +1657 -0
  241. package/dist/vault/index.cjs +225 -0
  242. package/dist/vault/index.cjs.map +1 -0
  243. package/dist/vault/index.d.cts +26 -0
  244. package/dist/vault/index.d.ts +26 -0
  245. package/dist/vault/index.js +219 -0
  246. package/dist/vault/index.js.map +1 -0
  247. package/dist/vault/types.cjs +4 -0
  248. package/dist/vault/types.cjs.map +1 -0
  249. package/dist/vault/types.d.cts +390 -0
  250. package/dist/vault/types.d.ts +390 -0
  251. package/dist/vault/types.js +3 -0
  252. package/dist/vault/types.js.map +1 -0
  253. package/dist/verify/index.cjs +190 -0
  254. package/dist/verify/index.cjs.map +1 -0
  255. package/dist/verify/index.d.cts +9 -0
  256. package/dist/verify/index.d.ts +9 -0
  257. package/dist/verify/index.js +184 -0
  258. package/dist/verify/index.js.map +1 -0
  259. package/dist/verify/types.cjs +4 -0
  260. package/dist/verify/types.cjs.map +1 -0
  261. package/dist/verify/types.d.cts +29 -0
  262. package/dist/verify/types.d.ts +29 -0
  263. package/dist/verify/types.js +3 -0
  264. package/dist/verify/types.js.map +1 -0
  265. package/package.json +570 -0
@@ -0,0 +1,1314 @@
1
+ import { d as OpenapiPathType, c as OpenapiQueryType, a as OpenapiReturnType } from './types-C7mpAfq-.cjs';
2
+
3
+ /**
4
+ * This file was auto-generated by openapi-typescript.
5
+ * Do not make direct changes to the file.
6
+ */
7
+
8
+ type paths = {
9
+ '/jobs': {
10
+ parameters: {
11
+ query?: never;
12
+ header?: never;
13
+ path?: never;
14
+ cookie?: never;
15
+ };
16
+ /**
17
+ * List jobs
18
+ * @deprecated
19
+ * @description List jobs and filter them by various criteria.
20
+ *
21
+ * This endpoint is DEPRECATED. Use `/search/jobs` instead.
22
+ */
23
+ get: {
24
+ parameters: {
25
+ query?: {
26
+ /** @description Search jobs by *id*. You can set multiple values. */
27
+ id?: string[];
28
+ /** @description Search jobs by *runId*. You can set multiple values. */
29
+ runId?: string[];
30
+ /**
31
+ * @description Search jobs by *branchId*. You can set multiple values.
32
+ *
33
+ * Set **branchId[]=null** to get just jobs belonging to the **main** branch.
34
+ */
35
+ branchId?: string[];
36
+ /** @description Search jobs by *tokenId*. You can set multiple values. */
37
+ tokenId?: string[];
38
+ /** @description Search jobs by *tokenDescription*. You can set multiple values. */
39
+ tokenDescription?: string[];
40
+ /** @description Search jobs by *component id*. You can set multiple values. */
41
+ component?: string[];
42
+ /** @description Search jobs by *configuration id*. You can set multiple values. */
43
+ config?: string[];
44
+ /** @description Search jobs by *configuration row id*. Each job can have multiple configRowIds or none. You can search for multiple values and all jobs containing at least one of the specified configRowIds will be returned in that case. */
45
+ configRowIds?: string[];
46
+ /** @description Filter jobs by *mode*. You can use either *run* or *debug* values. */
47
+ mode?: ('run' | 'debug')[];
48
+ /** @description Search jobs by *status*. You can set multiple values. */
49
+ status?: components['schemas']['JobStatus'][];
50
+ /** @description Filter jobs by job *type*. */
51
+ type?:
52
+ | 'standard'
53
+ | 'container'
54
+ | 'phaseContainer'
55
+ | 'orchestrationContainer'
56
+ | 'retryContainer';
57
+ /** @description Filter jobs by component properties. Only "type" is currently supported. It lists jobs of components with the given type, having a configuration in the project. */
58
+ componentProps?: {
59
+ type?: string;
60
+ };
61
+ /** @description Jobs that were created after *createdTimeFrom*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
62
+ createdTimeFrom?: string;
63
+ /** @description Jobs that were created before *createdTimeTo*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
64
+ createdTimeTo?: string;
65
+ /** @description Jobs that started after *startTimeFrom*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
66
+ startTimeFrom?: string;
67
+ /** @description Jobs that started before *startTimeTo*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
68
+ startTimeTo?: string;
69
+ /** @description Jobs that ended after *endTimeFrom*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
70
+ endTimeFrom?: string;
71
+ /** @description Jobs that ended before *endTimeTo*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
72
+ endTimeTo?: string;
73
+ /** @description Jobs that were running for *durationSecondsFrom* seconds or more. */
74
+ durationSecondsFrom?: number;
75
+ /** @description Jobs that were running less than *durationSecondsTo* seconds. */
76
+ durationSecondsTo?: number;
77
+ /**
78
+ * @description Page offset
79
+ * @example 50
80
+ */
81
+ offset?: number;
82
+ /**
83
+ * @description Maximum limit of items per page
84
+ * @example 1000
85
+ */
86
+ limit?: number;
87
+ /**
88
+ * @description Sort the jobs by specified attribute.
89
+ * @example runId
90
+ */
91
+ sortBy?:
92
+ | 'id'
93
+ | 'runId'
94
+ | 'branchId'
95
+ | 'projectId'
96
+ | 'projectName'
97
+ | 'tokenId'
98
+ | 'tokenDescription'
99
+ | 'componentId'
100
+ | 'configId'
101
+ | 'configRowIds'
102
+ | 'tag'
103
+ | 'mode'
104
+ | 'status'
105
+ | 'startTime'
106
+ | 'createdTime'
107
+ | 'endTime'
108
+ | 'durationSeconds'
109
+ | 'result';
110
+ /**
111
+ * @description Order of the sorting. Default is *desc*, newest jobs are displayed at the top.
112
+ * @example asc
113
+ */
114
+ sortOrder?: 'asc' | 'desc';
115
+ };
116
+ header?: never;
117
+ path?: never;
118
+ cookie?: never;
119
+ };
120
+ requestBody?: never;
121
+ responses: {
122
+ /** @description Success response */
123
+ 200: {
124
+ headers: {
125
+ [name: string]: unknown;
126
+ };
127
+ content: {
128
+ 'application/json': components['schemas']['Job'][];
129
+ };
130
+ };
131
+ /** @description Error response */
132
+ default: {
133
+ headers: {
134
+ [name: string]: unknown;
135
+ };
136
+ content: {
137
+ 'application/json': components['schemas']['Error'];
138
+ };
139
+ };
140
+ };
141
+ };
142
+ put?: never;
143
+ /**
144
+ * Create a job
145
+ * @description Create a new Job
146
+ */
147
+ post: operations['createJob'];
148
+ delete?: never;
149
+ options?: never;
150
+ head?: never;
151
+ patch?: never;
152
+ trace?: never;
153
+ };
154
+ '/jobs/{jobId}': {
155
+ parameters: {
156
+ query?: never;
157
+ header?: never;
158
+ path?: never;
159
+ cookie?: never;
160
+ };
161
+ /**
162
+ * Get job detail
163
+ * @description Get details of specified job
164
+ */
165
+ get: operations['getJob'];
166
+ put?: never;
167
+ post?: never;
168
+ delete?: never;
169
+ options?: never;
170
+ head?: never;
171
+ patch?: never;
172
+ trace?: never;
173
+ };
174
+ '/jobs/{jobId}/kill': {
175
+ parameters: {
176
+ query?: never;
177
+ header?: never;
178
+ path?: never;
179
+ cookie?: never;
180
+ };
181
+ get?: never;
182
+ put?: never;
183
+ /**
184
+ * Set job for termination
185
+ * @description Sets the job desiredStatus to **terminating**. The daemon will pick such a job and depending on its current status, it will either cancell it, if the job was still in the **created** or **waiting** state, or if the job already entered **processing** state, it will be **terminated**.
186
+ */
187
+ post: operations['killJob'];
188
+ delete?: never;
189
+ options?: never;
190
+ head?: never;
191
+ patch?: never;
192
+ trace?: never;
193
+ };
194
+ '/jobs/{jobId}/open-api-lineage': {
195
+ parameters: {
196
+ query?: never;
197
+ header?: never;
198
+ path?: never;
199
+ cookie?: never;
200
+ };
201
+ /**
202
+ * Get job OpenLineage data
203
+ * @description Retreive details about executed job as events list in OpenLineage format. For orchestration, container and phase jobs, events from child jobs are also included.
204
+ */
205
+ get: operations['getJobOpenApiLineage'];
206
+ put?: never;
207
+ post?: never;
208
+ delete?: never;
209
+ options?: never;
210
+ head?: never;
211
+ patch?: never;
212
+ trace?: never;
213
+ };
214
+ '/configurations-jobs': {
215
+ parameters: {
216
+ query?: never;
217
+ header?: never;
218
+ path?: never;
219
+ cookie?: never;
220
+ };
221
+ /**
222
+ * List most recent jobs of configurations
223
+ * @deprecated
224
+ * @description List most recent jobs of configurations.
225
+ *
226
+ * This endpoint is DEPRECATED. Use `/search/grouped-jobs` instead.
227
+ */
228
+ get: operations['listConfigurationsJobs'];
229
+ put?: never;
230
+ post?: never;
231
+ delete?: never;
232
+ options?: never;
233
+ head?: never;
234
+ patch?: never;
235
+ trace?: never;
236
+ };
237
+ '/latest-configurations-jobs': {
238
+ parameters: {
239
+ query?: never;
240
+ header?: never;
241
+ path?: never;
242
+ cookie?: never;
243
+ };
244
+ /**
245
+ * List latest job per each configuration in project that ran during last month
246
+ * @deprecated
247
+ * @description List latest job per each configuration in project that ran during last month.
248
+ *
249
+ * This endpoint is DEPRECATED. Use `/search/grouped-jobs` instead.
250
+ */
251
+ get: operations['listLatestConfigurationsJobs'];
252
+ put?: never;
253
+ post?: never;
254
+ delete?: never;
255
+ options?: never;
256
+ head?: never;
257
+ patch?: never;
258
+ trace?: never;
259
+ };
260
+ '/orchestration-rerun-plan/{jobId}': {
261
+ parameters: {
262
+ query?: never;
263
+ header?: never;
264
+ path?: never;
265
+ cookie?: never;
266
+ };
267
+ /**
268
+ * Get orchestration rerun plan
269
+ * @description Returns list of orchestration tasks possible to re-run.
270
+ */
271
+ get: operations['getOrchestrationRerunPlan'];
272
+ put?: never;
273
+ post?: never;
274
+ delete?: never;
275
+ options?: never;
276
+ head?: never;
277
+ patch?: never;
278
+ trace?: never;
279
+ };
280
+ '/stats/project': {
281
+ parameters: {
282
+ query?: never;
283
+ header?: never;
284
+ path?: never;
285
+ cookie?: never;
286
+ };
287
+ /**
288
+ * Get jobs statistics
289
+ * @description Get jobs statistics
290
+ */
291
+ get: operations['getProjectStats'];
292
+ put?: never;
293
+ post?: never;
294
+ delete?: never;
295
+ options?: never;
296
+ head?: never;
297
+ patch?: never;
298
+ trace?: never;
299
+ };
300
+ '/search/jobs': {
301
+ parameters: {
302
+ query?: never;
303
+ header?: never;
304
+ path?: never;
305
+ cookie?: never;
306
+ };
307
+ /**
308
+ * Search jobs
309
+ * @description Search jobs and filter them by various criteria.
310
+ *
311
+ * Search endpoints result are eventually consistent as it does not return data directly from internal storage but
312
+ * from a search index. This means that results are not guaranteed to be 100% consistent. There is always slight
313
+ * delay before created/updated job data is propagated to the search.
314
+ */
315
+ get: {
316
+ parameters: {
317
+ query?: {
318
+ /** @description Search jobs by *id*. You can set multiple values. */
319
+ id?: string[];
320
+ /** @description Search jobs by *runId*. You can set multiple values. */
321
+ runId?: string[];
322
+ /**
323
+ * @description Search jobs by *branchId*. You can set multiple values.
324
+ *
325
+ * Set **branchId[]=null** to get just jobs belonging to the **main** branch.
326
+ */
327
+ branchId?: string[];
328
+ /** @description Search jobs by *tokenId*. You can set multiple values. */
329
+ tokenId?: string[];
330
+ /** @description Search jobs by *tokenDescription*. You can set multiple values. */
331
+ tokenDescription?: string[];
332
+ /** @description Search jobs by *component id*. You can set multiple values. */
333
+ componentId?: string[];
334
+ /**
335
+ * @deprecated
336
+ * @description Alias to `componentId` filter.
337
+ */
338
+ component?: string[];
339
+ /** @description Search jobs by *configuration id*. You can set multiple values. */
340
+ configId?: string[];
341
+ /**
342
+ * @deprecated
343
+ * @description Alias to `configId` filter.
344
+ */
345
+ config?: string[];
346
+ /** @description Search jobs by *configuration row id*. Each job can have multiple configRowIds or none. You can search for multiple values and all jobs containing at least one of the specified configRowIds will be returned in that case. */
347
+ configRowIds?: string[];
348
+ /** @description Filter jobs by *mode*. You can use either *run* or *debug* values. */
349
+ mode?: ('run' | 'debug')[];
350
+ /** @description Search jobs by *status*. You can set multiple values. */
351
+ status?: components['schemas']['JobStatus'][];
352
+ /** @description Filter jobs by job *type*. */
353
+ type?:
354
+ | 'standard'
355
+ | 'container'
356
+ | 'phaseContainer'
357
+ | 'orchestrationContainer'
358
+ | 'retryContainer';
359
+ /** @description Filter jobs by component properties. Only "type" is currently supported. It lists jobs of components with the given type, having a configuration in the project. */
360
+ componentProps?: {
361
+ type?: string;
362
+ };
363
+ /** @description Jobs that were created after *createdTimeFrom*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
364
+ createdTimeFrom?: string;
365
+ /** @description Jobs that were created before *createdTimeTo*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
366
+ createdTimeTo?: string;
367
+ /** @description Jobs that started after *startTimeFrom*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
368
+ startTimeFrom?: string;
369
+ /** @description Jobs that started before *startTimeTo*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
370
+ startTimeTo?: string;
371
+ /** @description Jobs that ended after *endTimeFrom*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
372
+ endTimeFrom?: string;
373
+ /** @description Jobs that ended before *endTimeTo*. [Supported date and time formats](https://www.php.net/manual/en/datetime.formats.php) */
374
+ endTimeTo?: string;
375
+ /** @description Jobs that were running for *durationSecondsFrom* seconds or more. */
376
+ durationSecondsFrom?: number;
377
+ /** @description Jobs that were running less than *durationSecondsTo* seconds. */
378
+ durationSecondsTo?: number;
379
+ /**
380
+ * @description Page offset
381
+ * @example 50
382
+ */
383
+ offset?: number;
384
+ /**
385
+ * @description Maximum limit of items per page
386
+ * @example 1000
387
+ */
388
+ limit?: number;
389
+ /**
390
+ * @description Sort the jobs by specified attribute.
391
+ * @example runId
392
+ */
393
+ sortBy?:
394
+ | 'id'
395
+ | 'runId'
396
+ | 'projectId'
397
+ | 'branchId'
398
+ | 'componentId'
399
+ | 'configId'
400
+ | 'tokenDescription'
401
+ | 'status'
402
+ | 'createdTime'
403
+ | 'updatedTime'
404
+ | 'startTime'
405
+ | 'endTime'
406
+ | 'durationSeconds';
407
+ /**
408
+ * @description Order of the sorting. Default is *desc*, newest jobs are displayed at the top.
409
+ * @example asc
410
+ */
411
+ sortOrder?: 'asc' | 'desc';
412
+ };
413
+ header?: never;
414
+ path?: never;
415
+ cookie?: never;
416
+ };
417
+ requestBody?: never;
418
+ responses: {
419
+ /** @description Success response */
420
+ 200: {
421
+ headers: {
422
+ [name: string]: unknown;
423
+ };
424
+ content: {
425
+ 'application/json': components['schemas']['Job'][];
426
+ };
427
+ };
428
+ /** @description Error response */
429
+ default: {
430
+ headers: {
431
+ [name: string]: unknown;
432
+ };
433
+ content: {
434
+ 'application/json': components['schemas']['Error'];
435
+ };
436
+ };
437
+ };
438
+ };
439
+ put?: never;
440
+ post?: never;
441
+ delete?: never;
442
+ options?: never;
443
+ head?: never;
444
+ patch?: never;
445
+ trace?: never;
446
+ };
447
+ '/search/grouped-jobs': {
448
+ parameters: {
449
+ query?: never;
450
+ header?: never;
451
+ path?: never;
452
+ cookie?: never;
453
+ };
454
+ /**
455
+ * Search grouped jobs
456
+ * @description Search for jobs by their attributes and aggregating them into specified groups.
457
+ *
458
+ * Search endpoints result are eventually consistent as it does not return data directly from internal storage but
459
+ * from a search index. This means that results are not guaranteed to be 100% consistent. There is always slight
460
+ * delay before created/updated job data is propagated to the search.
461
+ */
462
+ get: {
463
+ parameters: {
464
+ query: {
465
+ /** @description Specifies the fields to group jobs by. */
466
+ groupBy: ('projectId' | 'branchId' | 'componentId' | 'configId')[];
467
+ /** @description Number of jobs per group. */
468
+ jobsPerGroup?: number;
469
+ /** @description Field to sort the results by. */
470
+ sortBy?:
471
+ | 'id'
472
+ | 'runId'
473
+ | 'projectId'
474
+ | 'branchId'
475
+ | 'componentId'
476
+ | 'configId'
477
+ | 'tokenDescription'
478
+ | 'status'
479
+ | 'createdTime'
480
+ | 'updatedTime'
481
+ | 'startTime'
482
+ | 'endTime'
483
+ | 'durationSeconds';
484
+ /** @description Order of sorting (asc or desc). */
485
+ sortOrder?: 'asc' | 'desc';
486
+ /** @description Maximum number of results to return. */
487
+ limit?: number;
488
+ /** @description Filter by specific job IDs. */
489
+ id?: number[];
490
+ /** @description Filter jobs by run IDs. */
491
+ runId?: string[];
492
+ /** @description Filter jobs by branch IDs. */
493
+ branchId?: string[];
494
+ /** @description Filter jobs by configuration IDs. */
495
+ configId?: string[];
496
+ /**
497
+ * @deprecated
498
+ * @description Alias to `configId` filter.
499
+ */
500
+ config?: string[];
501
+ /** @description Filter jobs by configuration row IDs. */
502
+ configRowIds?: string[];
503
+ /** @description Filter jobs by project IDs. */
504
+ projectId?: string[];
505
+ /** @description Filter jobs by token IDs. */
506
+ tokenId?: string[];
507
+ /** @description Filter jobs by token descriptions. */
508
+ tokenDescription?: string[];
509
+ /** @description Filter jobs by component names. */
510
+ componentId?: string[];
511
+ /**
512
+ * @deprecated
513
+ * @description Alias to `componentId` filter.
514
+ */
515
+ component?: string[];
516
+ /** @description Filter jobs by status. */
517
+ status?: string[];
518
+ /** @description Filter jobs by desired status. */
519
+ desiredStatus?: string[];
520
+ /** @description Filter jobs by mode. */
521
+ mode?: string[];
522
+ /** @description Filter jobs by tags. */
523
+ tag?: string[];
524
+ /** @description Filter jobs that started from this timestamp onwards. */
525
+ startTimeFrom?: string;
526
+ /** @description Filter jobs that started up to this timestamp. */
527
+ startTimeTo?: string;
528
+ /** @description Filter jobs created from this timestamp onwards. */
529
+ createdTimeFrom?: string;
530
+ /** @description Filter jobs created up to this timestamp. */
531
+ createdTimeTo?: string;
532
+ /** @description Filter jobs that ended from this timestamp onwards. */
533
+ endTimeFrom?: string;
534
+ /** @description Filter jobs that ended up to this timestamp. */
535
+ endTimeTo?: string;
536
+ /** @description Filter jobs with a duration longer than this number of seconds. */
537
+ durationSecondsFrom?: number;
538
+ /** @description Filter jobs with a duration up to this number of seconds. */
539
+ durationSecondsTo?: number;
540
+ /** @description Filter jobs by variable values IDs. */
541
+ variableValuesId?: string[];
542
+ /** @description Filter jobs by parent run IDs. */
543
+ parentRunId?: string[];
544
+ /** @description Filter jobs by type. */
545
+ type?: string[];
546
+ /** @description Filter jobs by specific component properties as key-value pairs. */
547
+ componentProps?: {
548
+ type?: string;
549
+ };
550
+ };
551
+ header?: never;
552
+ path?: never;
553
+ cookie?: never;
554
+ };
555
+ requestBody?: never;
556
+ responses: {
557
+ /** @description Successful response */
558
+ 200: {
559
+ headers: {
560
+ [name: string]: unknown;
561
+ };
562
+ content: {
563
+ 'application/json': {
564
+ group?: {
565
+ [key: string]: string;
566
+ };
567
+ jobs?: components['schemas']['Job'][];
568
+ }[];
569
+ };
570
+ };
571
+ /** @description Error response */
572
+ default: {
573
+ headers: {
574
+ [name: string]: unknown;
575
+ };
576
+ content: {
577
+ 'application/json': components['schemas']['Error'];
578
+ };
579
+ };
580
+ };
581
+ };
582
+ put?: never;
583
+ post?: never;
584
+ delete?: never;
585
+ options?: never;
586
+ head?: never;
587
+ patch?: never;
588
+ trace?: never;
589
+ };
590
+ };
591
+ type components = {
592
+ schemas: {
593
+ Job: {
594
+ /** @example 123456789 */
595
+ id: string;
596
+ /**
597
+ * @description Run ID is same as Job ID, unless the job is a child job. A child
598
+ * job is created by providing the parent Run ID in the X-KBC-RunId
599
+ * parameter. The runId of a child job contains the parent runId and
600
+ * the child job ID separated by dot. The nesting depth is not limited.
601
+ * A parent-child job relationship means that e.g. when a parent job is terminated
602
+ * it's child jobs are terminated too. The parent-child job relationship
603
+ * does not mean that the parent will wait for it's children to finish.
604
+ * @example 123456790.123456789
605
+ */
606
+ runId: string;
607
+ /**
608
+ * @description Jobs from the main branch will have branchId = null
609
+ * @example 123456789
610
+ */
611
+ branchId?: string;
612
+ project: {
613
+ /** @example 123 */
614
+ id: string;
615
+ };
616
+ token: {
617
+ /** @example 12345 */
618
+ id?: string;
619
+ /** @example user@example.com */
620
+ description?: string;
621
+ };
622
+ status: components['schemas']['JobStatus'];
623
+ /** @enum {string|null} */
624
+ desiredStatus?: 'processing' | 'terminating' | null;
625
+ /** @example keboola.ex-db-snowflake */
626
+ component: string;
627
+ /** @enum {string} */
628
+ mode: 'run' | 'debug';
629
+ /** @example 1.2.3 */
630
+ tag?: string | null;
631
+ /** @example 123456789 */
632
+ config?: string | null;
633
+ /** @example 123456789 */
634
+ configRow?: string | null;
635
+ /**
636
+ * @example {
637
+ * "parameters": {
638
+ * "foo": "bar",
639
+ * "baz": "mek"
640
+ * }
641
+ * }
642
+ */
643
+ configData?: Record<string, never> | null;
644
+ result?: {
645
+ images?: {
646
+ digests?: string[];
647
+ id?: string;
648
+ }[];
649
+ configVersion?: number;
650
+ message?: string;
651
+ } | null;
652
+ /**
653
+ * Format: date-time
654
+ * @example 2019-06-21T09:12:33.001Z
655
+ */
656
+ createdTime: string;
657
+ /**
658
+ * Format: date-time
659
+ * @example 2019-06-21T09:12:33.001Z
660
+ */
661
+ startTime?: string | null;
662
+ /**
663
+ * Format: date-time
664
+ * @example 2019-06-21T09:12:33.001Z
665
+ */
666
+ endTime?: string | null;
667
+ /**
668
+ * Format: date-time
669
+ * @description Delayed start time - the earliest time when the job can be started
670
+ * @example 2019-06-21T09:12:33.001Z
671
+ */
672
+ delayedStartTime?: string | null;
673
+ /** @example 165 */
674
+ durationSeconds?: number | null;
675
+ /** @example false */
676
+ isFinished: boolean;
677
+ /** @example https://queue.east-us-2.azure.keboola-testing.com/jobs/123456789 */
678
+ url: string;
679
+ /** @example 1234 */
680
+ variableValuesId?: string | null;
681
+ /**
682
+ * @example {
683
+ * "items": [
684
+ * {
685
+ * "name": "testVariable",
686
+ * "value": "testValue"
687
+ * }
688
+ * ]
689
+ * }
690
+ */
691
+ variableValuesData?: {
692
+ values?: {
693
+ name?: string;
694
+ value?: string;
695
+ }[];
696
+ } | null;
697
+ /**
698
+ * @example {
699
+ * "type": "small",
700
+ * "context": "123_extractor"
701
+ * }
702
+ */
703
+ backend?: {
704
+ type?: string;
705
+ containerType?: string;
706
+ context?: string;
707
+ } | null;
708
+ metrics?: {
709
+ storage?: {
710
+ inputTablesBytesSum?: number;
711
+ outputTablesBytesSum?: number;
712
+ };
713
+ /**
714
+ * @example {
715
+ * "type": "small",
716
+ * "context": "123_extractor"
717
+ * }
718
+ */
719
+ backend?: {
720
+ type?: string;
721
+ containerType?: string;
722
+ context?: string;
723
+ };
724
+ } | null;
725
+ type?: components['schemas']['JobType'];
726
+ orchestrationTaskId?: string | null;
727
+ previousJobId?: string | null;
728
+ onlyOrchestrationTaskIds?: string[] | null;
729
+ };
730
+ /** @enum {string} */
731
+ JobStatus:
732
+ | 'created'
733
+ | 'waiting'
734
+ | 'processing'
735
+ | 'success'
736
+ | 'warning'
737
+ | 'error'
738
+ | 'terminating'
739
+ | 'terminated'
740
+ | 'cancelled';
741
+ /** @enum {string} */
742
+ JobType:
743
+ | 'standard'
744
+ | 'container'
745
+ | 'phaseContainer'
746
+ | 'orchestrationContainer'
747
+ | 'retryContainer';
748
+ ProjectStats: {
749
+ jobs?: {
750
+ /**
751
+ * @description Total duration sum of all processed jobs. (in seconds)
752
+ * @example 3600
753
+ */
754
+ durationSum?: number;
755
+ };
756
+ };
757
+ /** @description OpenLineage event list */
758
+ OpenLineageEventList: components['schemas']['OpenLineageEvent'][];
759
+ OpenLineageEvent:
760
+ | components['schemas']['OpenLineageStartEvent']
761
+ | components['schemas']['OpenLineageCompleteEvent'];
762
+ /** @description Job execution start event, including information about input mapping tables. */
763
+ OpenLineageStartEvent: {
764
+ /** @example START */
765
+ eventType: string;
766
+ /**
767
+ * Format: date-time
768
+ * @description Job execution start time
769
+ */
770
+ eventTime: string;
771
+ run: {
772
+ /** Format: uuid */
773
+ runId: string;
774
+ facets?: {
775
+ parent: {
776
+ /**
777
+ * Format: uri
778
+ * @example https://connection.north-europe.azure.keboola.com
779
+ */
780
+ _producer: string;
781
+ /** @example https://openlineage.io/spec/facets/1-0-0/ParentRunFacet.json#/$defs/ParentRunFacet */
782
+ _schemaURL: string;
783
+ run: {
784
+ /** Format: uuid */
785
+ runId: string;
786
+ };
787
+ job: {
788
+ /** @example connection.north-europe.azure.keboola.com/project/1234 */
789
+ namespace: string;
790
+ /** @example keboola.orchestrator-123 */
791
+ name: string;
792
+ };
793
+ };
794
+ };
795
+ };
796
+ job: {
797
+ /** @example connection.north-europe.azure.keboola.com/project/1234 */
798
+ namespace: string;
799
+ /** @example keboola.snowflake-transformation-123456 */
800
+ name: string;
801
+ };
802
+ /**
803
+ * Format: uri
804
+ * @description Keboola Connection stack uri
805
+ * @example https://connection.north-europe.azure.keboola.com
806
+ */
807
+ producer: string;
808
+ /** @description Input Mapping table list */
809
+ inputs: {
810
+ /** @example connection.north-europe.azure.keboola.com/project/1234 */
811
+ namespace: string;
812
+ /**
813
+ * @description Table ID in Keboola Storage
814
+ * @example in.c-kds-team-ex-shoptet-permalink-1234567.orders
815
+ */
816
+ name: string;
817
+ facets: {
818
+ schema: {
819
+ /**
820
+ * Format: uri
821
+ * @example https://connection.north-europe.azure.keboola.com
822
+ */
823
+ _producer: string;
824
+ /** @example https://openlineage.io/spec/1-0-2/OpenLineage.json#/$defs/InputDatasetFacet */
825
+ _schemaURL: string;
826
+ /**
827
+ * @example [
828
+ * {
829
+ * "name": "code"
830
+ * },
831
+ * {
832
+ * "name": "date"
833
+ * },
834
+ * {
835
+ * "name": "totalPriceWithVat"
836
+ * },
837
+ * {
838
+ * "name": "currency"
839
+ * }
840
+ * ]
841
+ */
842
+ fields: {
843
+ name: string;
844
+ }[];
845
+ };
846
+ };
847
+ }[];
848
+ };
849
+ /** @description Job execution end event, including information about output mapping tables. */
850
+ OpenLineageCompleteEvent: {
851
+ /** @example COMPLETE */
852
+ eventType: string;
853
+ /**
854
+ * Format: date-time
855
+ * @description Job execution end time
856
+ */
857
+ eventTime: string;
858
+ run: {
859
+ /** Format: uuid */
860
+ runId: string;
861
+ };
862
+ job: {
863
+ /** @example connection.north-europe.azure.keboola.com/project/1234 */
864
+ namespace: string;
865
+ /** @example keboola.snowflake-transformation-123456 */
866
+ name: string;
867
+ };
868
+ /**
869
+ * Format: uri
870
+ * @description Keboola Connection stack uri
871
+ * @example https://connection.north-europe.azure.keboola.com
872
+ */
873
+ producer: string;
874
+ /** @description Output Mapping table list */
875
+ outputs: {
876
+ /** @example connection.north-europe.azure.keboola.com/project/1234 */
877
+ namespace: string;
878
+ /**
879
+ * @description Table ID in Keboola Storage
880
+ * @example out.c-orders.dailyStats"
881
+ */
882
+ name: string;
883
+ facets: {
884
+ schema: {
885
+ /**
886
+ * Format: uri
887
+ * @example https://connection.north-europe.azure.keboola.com
888
+ */
889
+ _producer: string;
890
+ /** @example https://openlineage.io/spec/1-0-2/OpenLineage.json#/$defs/OutputDatasetFacet */
891
+ _schemaURL: string;
892
+ /**
893
+ * @example [
894
+ * {
895
+ * "name": "date"
896
+ * },
897
+ * {
898
+ * "name": "ordersCount"
899
+ * },
900
+ * {
901
+ * "name": "totalPriceEuroSum"
902
+ * }
903
+ * ]
904
+ */
905
+ fields: {
906
+ name: string;
907
+ }[];
908
+ };
909
+ };
910
+ }[];
911
+ };
912
+ Error: {
913
+ /** @example The value foobar is invalid */
914
+ error: string;
915
+ /** @example 400 */
916
+ code: number;
917
+ /** @enum {string} */
918
+ status: 'error';
919
+ /** @example job-runner-1234567890 */
920
+ exceptionId?: string;
921
+ };
922
+ };
923
+ responses: never;
924
+ parameters: never;
925
+ requestBodies: never;
926
+ headers: never;
927
+ pathItems: never;
928
+ };
929
+ type operations = {
930
+ createJob: {
931
+ parameters: {
932
+ query?: never;
933
+ header?: {
934
+ /** @description Run ID of parent job (see the description of runId property in Job schema) */
935
+ 'X-KBC-RunId'?: string;
936
+ };
937
+ path?: never;
938
+ cookie?: never;
939
+ };
940
+ /**
941
+ * @description ## Basic Job
942
+ * Use "run" **mode** to create a new job of a component specified by **component** with configuration defined either by **config** and optionally **configRow** or provide the whole configuration for the component in the **configData** attribute. Use "forceRun" **mode** to create a new job of a disabled configuration.
943
+ *
944
+ * ## Job of specific component image tag
945
+ * Specify the component image tag in the **tag** attribute.
946
+ *
947
+ * ## Debug job
948
+ * This API call has the same body attributes as the Run call, except the **mode** attribute is set to "debug" (default is "run"). It creates a job that prepares the data folder including the serialized configuration files. Then it compresses the data folder and uploads it to your project's Files in Storage. This way you will get a snapshot of what the data folder looked like before the component started. If processors are used, a snapshot of the data folder is created before each processor. After the entire component finishes, another snapshot is made.
949
+ * For example, if you run component a with processor b and c in the after section, you will receive:
950
+ * - stage_0 file with contents of the data folder before component a was run
951
+ * - stage_1 file with contents of the data folder before processor b was run
952
+ * - stage_2 file with contents of the data folder before processor c was run
953
+ * - stage_output file with contents of the data folder before output mapping was about to be performed (after c finished).
954
+ *
955
+ * If configuration rows are used, then the above is repeated for each configuration row. If the job finishes with and error, only the stages before the error are uploaded.
956
+ *
957
+ * This API call does not upload any tables or files to Storage. I.e. when the component finishes, its output is discarded and the output mapping to storage is **not performed**. This makes this API call generally very safe to call, because it cannot break the KBC project in any way. However keep in mind, that if the component has any outside side effects, these will get executed. This applies typically to writers which will write the data into the external system even with this debug API call.
958
+ *
959
+ * Note that the snapshot archive will contain all files in the data folder including any temporary files produced be the component. The snapshot will not contain the output state.json file. This is because the snapshot is made before a component is run where the out state of the previous component is not available any more. Also note that all encrypted values are removed from the configuration file and there is no way to retrieve them. It is also advisable to run this command with limited input mapping so that you don't end up with gigabyte size archives.
960
+ */
961
+ requestBody?: {
962
+ content: {
963
+ 'application/json': {
964
+ component: string;
965
+ /**
966
+ * @default run
967
+ * @enum {string}
968
+ */
969
+ mode?: 'run' | 'debug' | 'forceRun';
970
+ config?: string;
971
+ configRowIds?: string[];
972
+ configData?: Record<string, never>;
973
+ tag?: string;
974
+ branchId?: string;
975
+ variableValuesId?: string;
976
+ variableValuesData?: {
977
+ values: {
978
+ name: string;
979
+ value: string;
980
+ }[];
981
+ };
982
+ backend?: {
983
+ /** @enum {string} */
984
+ type: 'xsmall' | 'small' | 'medium' | 'large';
985
+ context?: string;
986
+ };
987
+ /** @enum {string} */
988
+ executor?: 'dind' | 'k8sContainers';
989
+ };
990
+ };
991
+ };
992
+ responses: {
993
+ /** @description Job created */
994
+ 201: {
995
+ headers: {
996
+ [name: string]: unknown;
997
+ };
998
+ content: {
999
+ 'application/json': components['schemas']['Job'];
1000
+ };
1001
+ };
1002
+ /** @description Error response */
1003
+ default: {
1004
+ headers: {
1005
+ [name: string]: unknown;
1006
+ };
1007
+ content: {
1008
+ 'application/json': components['schemas']['Error'];
1009
+ };
1010
+ };
1011
+ };
1012
+ };
1013
+ getJob: {
1014
+ parameters: {
1015
+ query?: never;
1016
+ header?: never;
1017
+ path: {
1018
+ /** @description Job ID */
1019
+ jobId: string;
1020
+ };
1021
+ cookie?: never;
1022
+ };
1023
+ requestBody?: never;
1024
+ responses: {
1025
+ /** @description Success response */
1026
+ 200: {
1027
+ headers: {
1028
+ [name: string]: unknown;
1029
+ };
1030
+ content: {
1031
+ 'application/json': components['schemas']['Job'];
1032
+ };
1033
+ };
1034
+ /** @description Error response */
1035
+ default: {
1036
+ headers: {
1037
+ [name: string]: unknown;
1038
+ };
1039
+ content: {
1040
+ 'application/json': components['schemas']['Error'];
1041
+ };
1042
+ };
1043
+ };
1044
+ };
1045
+ killJob: {
1046
+ parameters: {
1047
+ query?: never;
1048
+ header?: never;
1049
+ path: {
1050
+ /** @description Job ID */
1051
+ jobId: string;
1052
+ };
1053
+ cookie?: never;
1054
+ };
1055
+ requestBody?: never;
1056
+ responses: {
1057
+ /** @description Success response */
1058
+ 202: {
1059
+ headers: {
1060
+ [name: string]: unknown;
1061
+ };
1062
+ content: {
1063
+ 'application/json': components['schemas']['Job'];
1064
+ };
1065
+ };
1066
+ /** @description Error response */
1067
+ default: {
1068
+ headers: {
1069
+ [name: string]: unknown;
1070
+ };
1071
+ content: {
1072
+ 'application/json': components['schemas']['Error'];
1073
+ };
1074
+ };
1075
+ };
1076
+ };
1077
+ getJobOpenApiLineage: {
1078
+ parameters: {
1079
+ query?: never;
1080
+ header?: never;
1081
+ path: {
1082
+ /** @description Job ID */
1083
+ jobId: string;
1084
+ };
1085
+ cookie?: never;
1086
+ };
1087
+ requestBody?: never;
1088
+ responses: {
1089
+ /** @description Success response */
1090
+ 200: {
1091
+ headers: {
1092
+ [name: string]: unknown;
1093
+ };
1094
+ content: {
1095
+ 'application/json': components['schemas']['OpenLineageEventList'];
1096
+ };
1097
+ };
1098
+ /** @description Error response */
1099
+ default: {
1100
+ headers: {
1101
+ [name: string]: unknown;
1102
+ };
1103
+ content: {
1104
+ 'application/json': components['schemas']['Error'];
1105
+ };
1106
+ };
1107
+ };
1108
+ };
1109
+ listConfigurationsJobs: {
1110
+ parameters: {
1111
+ query?: {
1112
+ /**
1113
+ * @description Search jobs of *componentId*.
1114
+ * @example keboola.orchestrator
1115
+ */
1116
+ componentId?: string;
1117
+ /**
1118
+ * @description Configuration ID
1119
+ * @example my.config
1120
+ */
1121
+ 'configId[]'?: string[];
1122
+ /**
1123
+ * @description Filter jobs by job *type*.
1124
+ * @example standard
1125
+ */
1126
+ type?:
1127
+ | 'standard'
1128
+ | 'container'
1129
+ | 'phaseContainer'
1130
+ | 'orchestrationContainer'
1131
+ | 'retryContainer';
1132
+ /** @description Number of jobs of each configuration to list */
1133
+ jobsPerConfiguration?: number;
1134
+ /**
1135
+ * @description Attribute to sort results by
1136
+ * @example startTime
1137
+ */
1138
+ sortBy?:
1139
+ | 'id'
1140
+ | 'configId'
1141
+ | 'configRowId'
1142
+ | 'projectId'
1143
+ | 'componentId'
1144
+ | 'status'
1145
+ | 'desiredStatus'
1146
+ | 'mode'
1147
+ | 'startTime'
1148
+ | 'createdTime'
1149
+ | 'endTime';
1150
+ /**
1151
+ * @description Order of the sorting, must be used with the "sortBy" parameter
1152
+ * @example asc
1153
+ */
1154
+ sortOrder?: 'asc' | 'desc';
1155
+ /**
1156
+ * @description Paging offset
1157
+ * @example 123
1158
+ */
1159
+ offset?: number;
1160
+ /**
1161
+ * @description Results per page
1162
+ * @example 1000
1163
+ */
1164
+ limit?: number;
1165
+ /**
1166
+ * @description Search jobs by *branchId*.
1167
+ *
1168
+ * Set **branchId=null** to get just jobs belonging to the **main** branch.
1169
+ */
1170
+ branchId?: string;
1171
+ };
1172
+ header?: never;
1173
+ path?: never;
1174
+ cookie?: never;
1175
+ };
1176
+ requestBody?: never;
1177
+ responses: {
1178
+ /** @description Success response */
1179
+ 200: {
1180
+ headers: {
1181
+ [name: string]: unknown;
1182
+ };
1183
+ content: {
1184
+ 'application/json': components['schemas']['Job'][];
1185
+ };
1186
+ };
1187
+ /** @description Bad request parameters */
1188
+ 400: {
1189
+ headers: {
1190
+ [name: string]: unknown;
1191
+ };
1192
+ content: {
1193
+ 'application/json': components['schemas']['Error'];
1194
+ };
1195
+ };
1196
+ };
1197
+ };
1198
+ listLatestConfigurationsJobs: {
1199
+ parameters: {
1200
+ query?: {
1201
+ /**
1202
+ * @description Paging offset
1203
+ * @example 123
1204
+ */
1205
+ offset?: number;
1206
+ /**
1207
+ * @description Results per page
1208
+ * @example 1000
1209
+ */
1210
+ limit?: number;
1211
+ /**
1212
+ * @description Search jobs by *branchId*.
1213
+ *
1214
+ * Set **branchId=default** to get just jobs belonging to the **main** branch.
1215
+ */
1216
+ branchId?: string;
1217
+ };
1218
+ header?: never;
1219
+ path?: never;
1220
+ cookie?: never;
1221
+ };
1222
+ requestBody?: never;
1223
+ responses: {
1224
+ /** @description Success response */
1225
+ 200: {
1226
+ headers: {
1227
+ [name: string]: unknown;
1228
+ };
1229
+ content: {
1230
+ 'application/json': components['schemas']['Job'][];
1231
+ };
1232
+ };
1233
+ /** @description Bad request parameters */
1234
+ 400: {
1235
+ headers: {
1236
+ [name: string]: unknown;
1237
+ };
1238
+ content: {
1239
+ 'application/json': components['schemas']['Error'];
1240
+ };
1241
+ };
1242
+ };
1243
+ };
1244
+ getOrchestrationRerunPlan: {
1245
+ parameters: {
1246
+ query?: never;
1247
+ header?: never;
1248
+ path: {
1249
+ /** @description Job ID */
1250
+ jobId: string;
1251
+ };
1252
+ cookie?: never;
1253
+ };
1254
+ requestBody?: never;
1255
+ responses: {
1256
+ /** @description Success response */
1257
+ 200: {
1258
+ headers: {
1259
+ [name: string]: unknown;
1260
+ };
1261
+ content: {
1262
+ 'application/json': {
1263
+ jobId?: string;
1264
+ configId?: string | null;
1265
+ matchedTasks?: {
1266
+ taskId?: string;
1267
+ matched?: boolean;
1268
+ jobId?: string | null;
1269
+ componentId?: string | null;
1270
+ configId?: string | null;
1271
+ status?: components['schemas']['JobStatus'] & unknown;
1272
+ }[];
1273
+ };
1274
+ };
1275
+ };
1276
+ /** @description Invalid request parameters */
1277
+ 400: {
1278
+ headers: {
1279
+ [name: string]: unknown;
1280
+ };
1281
+ content: {
1282
+ 'application/json': components['schemas']['Error'];
1283
+ };
1284
+ };
1285
+ };
1286
+ };
1287
+ getProjectStats: {
1288
+ parameters: {
1289
+ query?: never;
1290
+ header?: never;
1291
+ path?: never;
1292
+ cookie?: never;
1293
+ };
1294
+ requestBody?: never;
1295
+ responses: {
1296
+ /** @description Success response */
1297
+ 200: {
1298
+ headers: {
1299
+ [name: string]: unknown;
1300
+ };
1301
+ content: {
1302
+ 'application/json': components['schemas']['ProjectStats'];
1303
+ };
1304
+ };
1305
+ };
1306
+ };
1307
+ };
1308
+
1309
+ type QueueJob = OpenapiReturnType<paths['/jobs/{jobId}']['get']>;
1310
+ type GetQueueJobPath = OpenapiPathType<paths['/jobs/{jobId}']['get']>;
1311
+ type SearchJobsQuery = OpenapiQueryType<paths['/search/jobs']['get']>;
1312
+ type SearchJobsResponse = OpenapiReturnType<paths['/search/jobs']['get']>;
1313
+
1314
+ export type { GetQueueJobPath as G, QueueJob as Q, SearchJobsQuery as S, SearchJobsResponse as a, components as c };