@epilot/sdk 2.4.4-alpha.0 → 2.4.4

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 (222) hide show
  1. package/dist/access-token.d-CnmUTOlq.d.cts +552 -0
  2. package/dist/access-token.d-CnmUTOlq.d.ts +552 -0
  3. package/dist/address-suggestions.d-_YwTOR-9.d.cts +339 -0
  4. package/dist/address-suggestions.d-_YwTOR-9.d.ts +339 -0
  5. package/dist/address.d-CwAPOVxa.d.cts +437 -0
  6. package/dist/address.d-CwAPOVxa.d.ts +437 -0
  7. package/dist/ai-agents.d-OkXfr2bz.d.cts +1339 -0
  8. package/dist/ai-agents.d-OkXfr2bz.d.ts +1339 -0
  9. package/dist/apis/access-token.d.cts +18 -0
  10. package/dist/apis/access-token.d.ts +12 -9
  11. package/dist/apis/address-suggestions.d.cts +18 -0
  12. package/dist/apis/address-suggestions.d.ts +12 -9
  13. package/dist/apis/address.d.cts +18 -0
  14. package/dist/apis/address.d.ts +12 -9
  15. package/dist/apis/ai-agents.d.cts +18 -0
  16. package/dist/apis/ai-agents.d.ts +12 -9
  17. package/dist/apis/app.d.cts +18 -0
  18. package/dist/apis/app.d.ts +12 -9
  19. package/dist/apis/audit-logs.d.cts +18 -0
  20. package/dist/apis/audit-logs.d.ts +12 -9
  21. package/dist/apis/automation.d.cts +18 -0
  22. package/dist/apis/automation.d.ts +12 -9
  23. package/dist/apis/billing.d.cts +18 -0
  24. package/dist/apis/billing.d.ts +12 -9
  25. package/dist/apis/blueprint-manifest.d.cts +18 -0
  26. package/dist/apis/blueprint-manifest.d.ts +12 -9
  27. package/dist/apis/calendar.d.cts +18 -0
  28. package/dist/apis/calendar.d.ts +12 -9
  29. package/dist/apis/configuration-hub.d.cts +18 -0
  30. package/dist/apis/configuration-hub.d.ts +12 -9
  31. package/dist/apis/consent.d.cts +18 -0
  32. package/dist/apis/consent.d.ts +12 -9
  33. package/dist/apis/customer-portal.d.cts +18 -0
  34. package/dist/apis/customer-portal.d.ts +12 -9
  35. package/dist/apis/dashboard.d.cts +18 -0
  36. package/dist/apis/dashboard.d.ts +12 -9
  37. package/dist/apis/data-governance.d.cts +18 -0
  38. package/dist/apis/data-governance.d.ts +12 -9
  39. package/dist/apis/deduplication.d.cts +18 -0
  40. package/dist/apis/deduplication.d.ts +12 -9
  41. package/dist/apis/design.d.cts +18 -0
  42. package/dist/apis/design.d.ts +12 -9
  43. package/dist/apis/document.d.cts +18 -0
  44. package/dist/apis/document.d.ts +12 -9
  45. package/dist/apis/email-settings.d.cts +18 -0
  46. package/dist/apis/email-settings.d.ts +12 -9
  47. package/dist/apis/email-template.d.cts +18 -0
  48. package/dist/apis/email-template.d.ts +12 -9
  49. package/dist/apis/entity-mapping.d.cts +18 -0
  50. package/dist/apis/entity-mapping.d.ts +12 -9
  51. package/dist/apis/entity.d.cts +18 -0
  52. package/dist/apis/entity.d.ts +12 -9
  53. package/dist/apis/environments.d.cts +18 -0
  54. package/dist/apis/environments.d.ts +12 -9
  55. package/dist/apis/event-catalog.d.cts +18 -0
  56. package/dist/apis/event-catalog.d.ts +12 -9
  57. package/dist/apis/file.d.cts +18 -0
  58. package/dist/apis/file.d.ts +12 -9
  59. package/dist/apis/iban.d.cts +18 -0
  60. package/dist/apis/iban.d.ts +12 -9
  61. package/dist/apis/integration-toolkit.d.cts +18 -0
  62. package/dist/apis/integration-toolkit.d.ts +12 -9
  63. package/dist/apis/journey.d.cts +18 -0
  64. package/dist/apis/journey.d.ts +12 -9
  65. package/dist/apis/kanban.d.cts +18 -0
  66. package/dist/apis/kanban.d.ts +12 -9
  67. package/dist/apis/message.d.cts +18 -0
  68. package/dist/apis/message.d.ts +12 -9
  69. package/dist/apis/metering.d.cts +18 -0
  70. package/dist/apis/metering.d.ts +12 -9
  71. package/dist/apis/notes.d.cts +18 -0
  72. package/dist/apis/notes.d.ts +12 -9
  73. package/dist/apis/notification.d.cts +18 -0
  74. package/dist/apis/notification.d.ts +12 -9
  75. package/dist/apis/organization.d.cts +18 -0
  76. package/dist/apis/organization.d.ts +12 -9
  77. package/dist/apis/partner-directory.d.cts +18 -0
  78. package/dist/apis/partner-directory.d.ts +12 -9
  79. package/dist/apis/permissions.d.cts +18 -0
  80. package/dist/apis/permissions.d.ts +12 -9
  81. package/dist/apis/pricing-tier.d.cts +18 -0
  82. package/dist/apis/pricing-tier.d.ts +12 -9
  83. package/dist/apis/pricing.d.cts +18 -0
  84. package/dist/apis/pricing.d.ts +12 -9
  85. package/dist/apis/purpose.d.cts +18 -0
  86. package/dist/apis/purpose.d.ts +12 -9
  87. package/dist/apis/query.d.cts +18 -0
  88. package/dist/apis/query.d.ts +12 -9
  89. package/dist/apis/sandbox.d.cts +18 -0
  90. package/dist/apis/sandbox.d.ts +12 -9
  91. package/dist/apis/sharing.d.cts +18 -0
  92. package/dist/apis/sharing.d.ts +12 -9
  93. package/dist/apis/submission.d.cts +18 -0
  94. package/dist/apis/submission.d.ts +12 -9
  95. package/dist/apis/target.d.cts +597 -0
  96. package/dist/apis/target.d.ts +591 -9
  97. package/dist/apis/targeting.d.cts +18 -0
  98. package/dist/apis/targeting.d.ts +12 -9
  99. package/dist/apis/template-variables.d.cts +18 -0
  100. package/dist/apis/template-variables.d.ts +12 -9
  101. package/dist/apis/user.d.cts +18 -0
  102. package/dist/apis/user.d.ts +12 -9
  103. package/dist/apis/validation-rules.d.cts +18 -0
  104. package/dist/apis/validation-rules.d.ts +12 -9
  105. package/dist/apis/webhooks.d.cts +18 -0
  106. package/dist/apis/webhooks.d.ts +12 -9
  107. package/dist/apis/workflow-definition.d.cts +18 -0
  108. package/dist/apis/workflow-definition.d.ts +12 -9
  109. package/dist/apis/workflow.d.cts +18 -0
  110. package/dist/apis/workflow.d.ts +12 -9
  111. package/dist/app.d-u7Dq42kU.d.cts +3391 -0
  112. package/dist/app.d-u7Dq42kU.d.ts +3391 -0
  113. package/dist/audit-logs.d-BRToFqeX.d.cts +287 -0
  114. package/dist/audit-logs.d-BRToFqeX.d.ts +287 -0
  115. package/dist/automation.d-Du6-uiz5.d.cts +5283 -0
  116. package/dist/automation.d-Du6-uiz5.d.ts +5283 -0
  117. package/dist/billing.d-Bs8Ku9qE.d.cts +993 -0
  118. package/dist/billing.d-Bs8Ku9qE.d.ts +993 -0
  119. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +4343 -0
  120. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +4343 -0
  121. package/dist/calendar.d-BEjLDagH.d.cts +353 -0
  122. package/dist/calendar.d-BEjLDagH.d.ts +353 -0
  123. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +478 -0
  124. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +478 -0
  125. package/dist/consent.d-C2PROHhX.d.cts +265 -0
  126. package/dist/consent.d-C2PROHhX.d.ts +265 -0
  127. package/dist/customer-portal.d-DyZ2n2dW.d.cts +16728 -0
  128. package/dist/customer-portal.d-DyZ2n2dW.d.ts +16728 -0
  129. package/dist/dashboard.d-CsGcA74I.d.cts +440 -0
  130. package/dist/dashboard.d-CsGcA74I.d.ts +440 -0
  131. package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
  132. package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
  133. package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
  134. package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
  135. package/dist/design.d-BRre8iLg.d.cts +2346 -0
  136. package/dist/design.d-BRre8iLg.d.ts +2346 -0
  137. package/dist/document.d-DN37pjdx.d.cts +648 -0
  138. package/dist/document.d-DN37pjdx.d.ts +648 -0
  139. package/dist/email-settings.d-B7Q_xT25.d.cts +2417 -0
  140. package/dist/email-settings.d-B7Q_xT25.d.ts +2417 -0
  141. package/dist/email-template.d-gtQkdaXM.d.cts +1188 -0
  142. package/dist/email-template.d-gtQkdaXM.d.ts +1188 -0
  143. package/dist/entity-mapping.d-DKSW3sfy.d.cts +1092 -0
  144. package/dist/entity-mapping.d-DKSW3sfy.d.ts +1092 -0
  145. package/dist/entity.d-BHR9dEon.d.cts +18479 -0
  146. package/dist/entity.d-BHR9dEon.d.ts +18479 -0
  147. package/dist/environments.d-BvqvN-PD.d.cts +382 -0
  148. package/dist/environments.d-BvqvN-PD.d.ts +382 -0
  149. package/dist/event-catalog.d-ENw6HO-w.d.cts +1511 -0
  150. package/dist/event-catalog.d-ENw6HO-w.d.ts +1511 -0
  151. package/dist/file.d-DcTJxjp7.d.cts +2992 -0
  152. package/dist/file.d-DcTJxjp7.d.ts +2992 -0
  153. package/dist/iban.d-BwdiGbxi.d.cts +70 -0
  154. package/dist/iban.d-BwdiGbxi.d.ts +70 -0
  155. package/dist/index.d.cts +182 -0
  156. package/dist/index.d.ts +182 -12
  157. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +5796 -0
  158. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +5796 -0
  159. package/dist/journey.d-ClXO0xK8.d.cts +1931 -0
  160. package/dist/journey.d-ClXO0xK8.d.ts +1931 -0
  161. package/dist/kanban.d-BHnSRCYW.d.cts +760 -0
  162. package/dist/kanban.d-BHnSRCYW.d.ts +760 -0
  163. package/dist/message.d-B5UuSqgw.d.cts +3811 -0
  164. package/dist/message.d-B5UuSqgw.d.ts +3811 -0
  165. package/dist/metering.d-DvtPv7wk.d.cts +1841 -0
  166. package/dist/metering.d-DvtPv7wk.d.ts +1841 -0
  167. package/dist/notes.d-BC-scR42.d.cts +1046 -0
  168. package/dist/notes.d-BC-scR42.d.ts +1046 -0
  169. package/dist/notification.d-BfBL3lga.d.cts +1147 -0
  170. package/dist/notification.d-BfBL3lga.d.ts +1147 -0
  171. package/dist/organization.d-DqwnNxMg.d.cts +1271 -0
  172. package/dist/organization.d-DqwnNxMg.d.ts +1271 -0
  173. package/dist/partner-directory.d-BCIjHoGs.d.cts +2337 -0
  174. package/dist/partner-directory.d-BCIjHoGs.d.ts +2337 -0
  175. package/dist/permissions.d-l6AT8SYP.d.cts +1279 -0
  176. package/dist/permissions.d-l6AT8SYP.d.ts +1279 -0
  177. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +81 -0
  178. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +81 -0
  179. package/dist/pricing.d-BHpMU4KU.d.cts +12255 -0
  180. package/dist/pricing.d-BHpMU4KU.d.ts +12255 -0
  181. package/dist/purpose.d-CbIYfTua.d.cts +372 -0
  182. package/dist/purpose.d-CbIYfTua.d.ts +372 -0
  183. package/dist/query.d-Cmp78IhZ.d.cts +2375 -0
  184. package/dist/query.d-Cmp78IhZ.d.ts +2375 -0
  185. package/dist/sandbox.d-BdbOFzDu.d.cts +465 -0
  186. package/dist/sandbox.d-BdbOFzDu.d.ts +465 -0
  187. package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
  188. package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
  189. package/dist/submission.d-BamwfhXw.d.cts +469 -0
  190. package/dist/submission.d-BamwfhXw.d.ts +469 -0
  191. package/dist/targeting.d-BNmcVsNS.d.cts +2057 -0
  192. package/dist/targeting.d-BNmcVsNS.d.ts +2057 -0
  193. package/dist/template-variables.d-Ble9TSBa.d.cts +1320 -0
  194. package/dist/template-variables.d-Ble9TSBa.d.ts +1320 -0
  195. package/dist/types-ChU9Acbv.d.cts +37 -0
  196. package/dist/types-ChU9Acbv.d.ts +37 -0
  197. package/dist/user.d-D18fe97W.d.cts +2270 -0
  198. package/dist/user.d-D18fe97W.d.ts +2270 -0
  199. package/dist/validation-rules.d-Db5c5zTf.d.cts +807 -0
  200. package/dist/validation-rules.d-Db5c5zTf.d.ts +807 -0
  201. package/dist/webhooks.d-pLHIL_io.d.cts +1256 -0
  202. package/dist/webhooks.d-pLHIL_io.d.ts +1256 -0
  203. package/dist/workflow-definition.d-DOeb0KVV.d.cts +1922 -0
  204. package/dist/workflow-definition.d-DOeb0KVV.d.ts +1922 -0
  205. package/dist/workflow.d-CMSKt8oN.d.cts +3151 -0
  206. package/dist/workflow.d-CMSKt8oN.d.ts +3151 -0
  207. package/package.json +1 -1
  208. package/dist/apis/_registry.d.ts +0 -8
  209. package/dist/authorize.d.ts +0 -3
  210. package/dist/bin/cli.d.ts +0 -1
  211. package/dist/client-factory.d.ts +0 -9
  212. package/dist/client-map.d.ts +0 -102
  213. package/dist/compact.d.ts +0 -22
  214. package/dist/help.d.ts +0 -12
  215. package/dist/large-response.d.ts +0 -9
  216. package/dist/openapi.d.ts +0 -12
  217. package/dist/overrides.d.ts +0 -9
  218. package/dist/proxy.d.ts +0 -14
  219. package/dist/registry.d.ts +0 -19
  220. package/dist/retry.d.ts +0 -11
  221. package/dist/sdk.d.ts +0 -29
  222. package/dist/types.d.ts +0 -53
@@ -0,0 +1,760 @@
1
+ import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
+
3
+ /* Auto-copied from kanban-client */
4
+
5
+
6
+ declare namespace Components {
7
+ namespace Schemas {
8
+ /**
9
+ * Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options.
10
+ */
11
+ export interface Board {
12
+ id?: string;
13
+ /**
14
+ * example:
15
+ * Board 1
16
+ */
17
+ title: string;
18
+ /**
19
+ * example:
20
+ * Board description
21
+ */
22
+ description?: string;
23
+ created_at?: string; // date-time
24
+ updated_at?: string; // date-time
25
+ created_by?: string;
26
+ org_id?: string;
27
+ updated_by?: string;
28
+ shared_with?: string[];
29
+ shared_with_org?: boolean;
30
+ /**
31
+ * Array of user IDs who have full ownership rights for this board (view, edit, delete)
32
+ */
33
+ owners?: string[];
34
+ config: {
35
+ /**
36
+ * example:
37
+ * workflow_tasks_overview
38
+ */
39
+ dataset?: string;
40
+ swimlanes?: /* A vertical column in a Kanban board that groups workflow tasks or entities matching its filter criteria. Each swimlane has an independent filter and a display position. */ Swimlane[];
41
+ card_config?: {
42
+ fields?: string[];
43
+ };
44
+ board_filter?: /* A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR). */ BoardFilter;
45
+ sorting?: /* Defines how query results should be sorted. Specify a field name and sort direction. */ Sorting;
46
+ group_by?: /* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set. */ GroupBy;
47
+ /**
48
+ * example:
49
+ * task 1
50
+ */
51
+ search_query?: string;
52
+ };
53
+ }
54
+ /**
55
+ * A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR).
56
+ */
57
+ export interface BoardFilter {
58
+ items: (FilterItem | FilterGroup)[];
59
+ /**
60
+ * example:
61
+ * OR
62
+ */
63
+ combination: "AND" | "OR";
64
+ }
65
+ /**
66
+ * Summary representation of a Kanban board, returned in list responses. Does not include swimlane and filter configuration details.
67
+ */
68
+ export interface BoardSummary {
69
+ id?: string;
70
+ /**
71
+ * example:
72
+ * Board 1
73
+ */
74
+ title?: string;
75
+ /**
76
+ * example:
77
+ * Board description
78
+ */
79
+ description?: string;
80
+ created_at?: string; // date-time
81
+ updated_at?: string; // date-time
82
+ created_by?: string;
83
+ org_id?: string;
84
+ updated_by?: string;
85
+ shared_with?: string[];
86
+ shared_with_org?: boolean;
87
+ /**
88
+ * Array of user IDs who have full ownership rights for this board (view, edit, delete)
89
+ */
90
+ owners?: string[];
91
+ }
92
+ /**
93
+ * Dynamic date keywords that resolve to actual dates at runtime
94
+ */
95
+ export type DynamicDateValue = "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER";
96
+ /**
97
+ * Standard error response
98
+ */
99
+ export interface Error {
100
+ /**
101
+ * Human-readable error message
102
+ * example:
103
+ * Board not found
104
+ */
105
+ message?: string;
106
+ /**
107
+ * HTTP status code
108
+ * example:
109
+ * 404
110
+ */
111
+ status?: number;
112
+ }
113
+ export interface FilterGroup {
114
+ items: FilterItem[];
115
+ /**
116
+ * example:
117
+ * AND
118
+ */
119
+ combination: "AND" | "OR";
120
+ }
121
+ export interface FilterItem {
122
+ /**
123
+ * The field key to filter on
124
+ * example:
125
+ * assignee
126
+ */
127
+ key: string;
128
+ operator: /**
129
+ * The comparison operator for filtering
130
+ * example:
131
+ * EQUALS
132
+ */
133
+ FilterOperator;
134
+ value?: /* The value to compare against - can be a single value (string, number, boolean, or dynamic date) or an array of values */ ValueType;
135
+ /**
136
+ * The data type of the field
137
+ * example:
138
+ * string
139
+ */
140
+ data_type?: "string" | "number" | "boolean" | "date";
141
+ }
142
+ /**
143
+ * The comparison operator for filtering
144
+ * example:
145
+ * EQUALS
146
+ */
147
+ export type FilterOperator = "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL";
148
+ /**
149
+ * Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination.
150
+ */
151
+ export interface FlowsQueryRequest {
152
+ /**
153
+ * Optional filter conditions to narrow the result set using AND/OR logic.
154
+ */
155
+ filters?: /* A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR). */ BoardFilter;
156
+ /**
157
+ * Sort the results by a specific field and direction.
158
+ */
159
+ sorting?: /* Defines how query results should be sorted. Specify a field name and sort direction. */ Sorting;
160
+ /**
161
+ * Group tasks by a shared property within each swimlane. Grouped tasks are returned adjacently in the result set.
162
+ */
163
+ group_by?: /* Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set. */ GroupBy;
164
+ /**
165
+ * Zero-based offset for pagination. Use with `size` to paginate through results.
166
+ * example:
167
+ * 0
168
+ */
169
+ from?: number;
170
+ /**
171
+ * Number of results to return per page.
172
+ * example:
173
+ * 10
174
+ */
175
+ size?: number;
176
+ }
177
+ /**
178
+ * Paginated result set returned from a Flows query. Each item in `results` is a workflow task record with dynamic fields depending on the dataset configuration.
179
+ */
180
+ export interface FlowsQueryResult {
181
+ [name: string]: any;
182
+ /**
183
+ * Array of matching workflow task records. Fields vary based on the dataset and card configuration.
184
+ */
185
+ results?: {
186
+ [name: string]: any;
187
+ }[];
188
+ /**
189
+ * Total number of records matching the query (across all pages).
190
+ * example:
191
+ * 42
192
+ */
193
+ hits?: number;
194
+ /**
195
+ * Current page number (1-based).
196
+ * example:
197
+ * 1
198
+ */
199
+ page_number?: number;
200
+ /**
201
+ * Number of results per page (matches the `size` request parameter).
202
+ * example:
203
+ * 10
204
+ */
205
+ page_size?: number;
206
+ /**
207
+ * Total number of available pages based on `hits` and `page_size`.
208
+ * example:
209
+ * 5
210
+ */
211
+ total_pages?: number;
212
+ }
213
+ /**
214
+ * Defines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set.
215
+ */
216
+ export interface GroupBy {
217
+ /**
218
+ * Property to group tasks by within each swimlane
219
+ */
220
+ field: "context_entity" | "phase" | "task";
221
+ }
222
+ /**
223
+ * Defines how query results should be sorted. Specify a field name and sort direction.
224
+ */
225
+ export interface Sorting {
226
+ /**
227
+ * example:
228
+ * created_at
229
+ */
230
+ field: string;
231
+ direction?: "asc" | "desc";
232
+ }
233
+ /**
234
+ * A vertical column in a Kanban board that groups workflow tasks or entities matching its filter criteria. Each swimlane has an independent filter and a display position.
235
+ */
236
+ export interface Swimlane {
237
+ id?: string;
238
+ /**
239
+ * example:
240
+ * Swimlane 1
241
+ */
242
+ title?: string;
243
+ /**
244
+ * example:
245
+ * 1
246
+ */
247
+ position?: number;
248
+ filter?: /* A filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR). */ BoardFilter;
249
+ /**
250
+ * example:
251
+ * success
252
+ */
253
+ title_chip_variant?: string;
254
+ }
255
+ /**
256
+ * The value to compare against - can be a single value (string, number, boolean, or dynamic date) or an array of values
257
+ */
258
+ export type ValueType = /* The value to compare against - can be a single value (string, number, boolean, or dynamic date) or an array of values */ string | /* Dynamic date keywords that resolve to actual dates at runtime */ DynamicDateValue | number | boolean | (string | /* Dynamic date keywords that resolve to actual dates at runtime */ DynamicDateValue | number | boolean)[];
259
+ }
260
+ }
261
+ declare namespace Paths {
262
+ namespace ClearDefaultKanbanBoard {
263
+ namespace Responses {
264
+ export interface $200 {
265
+ message?: string;
266
+ default_board_id?: string | null;
267
+ }
268
+ export type $401 = /* Standard error response */ Components.Schemas.Error;
269
+ export type $403 = /* Standard error response */ Components.Schemas.Error;
270
+ export type $500 = /* Standard error response */ Components.Schemas.Error;
271
+ }
272
+ }
273
+ namespace CreateKanbanBoard {
274
+ export type RequestBody = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
275
+ namespace Responses {
276
+ export type $200 = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
277
+ export type $400 = /* Standard error response */ Components.Schemas.Error;
278
+ export type $401 = /* Standard error response */ Components.Schemas.Error;
279
+ export type $403 = /* Standard error response */ Components.Schemas.Error;
280
+ export type $500 = /* Standard error response */ Components.Schemas.Error;
281
+ }
282
+ }
283
+ namespace DeleteKanbanBoard {
284
+ namespace Parameters {
285
+ export type BoardId = string;
286
+ }
287
+ export interface PathParameters {
288
+ boardId: Parameters.BoardId;
289
+ }
290
+ namespace Responses {
291
+ export interface $200 {
292
+ }
293
+ export type $401 = /* Standard error response */ Components.Schemas.Error;
294
+ export type $403 = /* Standard error response */ Components.Schemas.Error;
295
+ export type $404 = /* Standard error response */ Components.Schemas.Error;
296
+ export type $500 = /* Standard error response */ Components.Schemas.Error;
297
+ }
298
+ }
299
+ namespace ExecuteFlowsQuery {
300
+ export type RequestBody = /* Request payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination. */ Components.Schemas.FlowsQueryRequest;
301
+ namespace Responses {
302
+ export type $200 = /* Paginated result set returned from a Flows query. Each item in `results` is a workflow task record with dynamic fields depending on the dataset configuration. */ Components.Schemas.FlowsQueryResult;
303
+ export type $400 = /* Standard error response */ Components.Schemas.Error;
304
+ export type $401 = /* Standard error response */ Components.Schemas.Error;
305
+ export type $403 = /* Standard error response */ Components.Schemas.Error;
306
+ export type $500 = /* Standard error response */ Components.Schemas.Error;
307
+ }
308
+ }
309
+ namespace FlowsAutocomplete {
310
+ namespace Parameters {
311
+ /**
312
+ * example:
313
+ * name
314
+ */
315
+ export type Attribute = string;
316
+ export type From = number;
317
+ export type Input = string;
318
+ export type Size = number;
319
+ }
320
+ export interface QueryParameters {
321
+ input?: Parameters.Input;
322
+ attribute: /**
323
+ * example:
324
+ * name
325
+ */
326
+ Parameters.Attribute;
327
+ size?: Parameters.Size;
328
+ from?: Parameters.From;
329
+ }
330
+ namespace Responses {
331
+ export interface $200 {
332
+ /**
333
+ * example:
334
+ * [
335
+ * "value"
336
+ * ]
337
+ */
338
+ results: (string | boolean | {
339
+ [name: string]: any;
340
+ })[];
341
+ /**
342
+ * Total number of matching items available
343
+ * example:
344
+ * 42
345
+ */
346
+ hits: number;
347
+ }
348
+ export type $400 = /* Standard error response */ Components.Schemas.Error;
349
+ export type $401 = /* Standard error response */ Components.Schemas.Error;
350
+ export type $403 = /* Standard error response */ Components.Schemas.Error;
351
+ export type $500 = /* Standard error response */ Components.Schemas.Error;
352
+ }
353
+ }
354
+ namespace GetKanbanBoard {
355
+ namespace Parameters {
356
+ export type BoardId = string;
357
+ }
358
+ export interface PathParameters {
359
+ boardId: Parameters.BoardId;
360
+ }
361
+ namespace Responses {
362
+ export type $200 = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
363
+ export type $401 = /* Standard error response */ Components.Schemas.Error;
364
+ export type $403 = /* Standard error response */ Components.Schemas.Error;
365
+ export type $404 = /* Standard error response */ Components.Schemas.Error;
366
+ export type $500 = /* Standard error response */ Components.Schemas.Error;
367
+ }
368
+ }
369
+ namespace GetKanbanBoards {
370
+ namespace Parameters {
371
+ export type Filter = "owned" | "shared";
372
+ }
373
+ export interface QueryParameters {
374
+ filter?: Parameters.Filter;
375
+ }
376
+ namespace Responses {
377
+ export type $200 = /* Summary representation of a Kanban board, returned in list responses. Does not include swimlane and filter configuration details. */ Components.Schemas.BoardSummary[];
378
+ export type $401 = /* Standard error response */ Components.Schemas.Error;
379
+ export type $403 = /* Standard error response */ Components.Schemas.Error;
380
+ export type $500 = /* Standard error response */ Components.Schemas.Error;
381
+ }
382
+ }
383
+ namespace PatchKanbanBoard {
384
+ namespace Parameters {
385
+ export type BoardId = string;
386
+ }
387
+ export interface PathParameters {
388
+ boardId: Parameters.BoardId;
389
+ }
390
+ export interface RequestBody {
391
+ /**
392
+ * example:
393
+ * Board 1
394
+ */
395
+ title?: string;
396
+ /**
397
+ * example:
398
+ * Board description
399
+ */
400
+ description?: string;
401
+ /**
402
+ * Array of user IDs to share the board with
403
+ */
404
+ shared_with?: string[];
405
+ /**
406
+ * Whether the board is shared with the entire organization
407
+ */
408
+ shared_with_org?: boolean;
409
+ /**
410
+ * Array of user IDs who have full ownership rights for this board (view, edit, delete)
411
+ */
412
+ owners?: string[];
413
+ }
414
+ namespace Responses {
415
+ export type $200 = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
416
+ export type $400 = /* Standard error response */ Components.Schemas.Error;
417
+ export type $401 = /* Standard error response */ Components.Schemas.Error;
418
+ export type $403 = /* Standard error response */ Components.Schemas.Error;
419
+ export type $404 = /* Standard error response */ Components.Schemas.Error;
420
+ export type $500 = /* Standard error response */ Components.Schemas.Error;
421
+ }
422
+ }
423
+ namespace SetDefaultKanbanBoard {
424
+ namespace Parameters {
425
+ export type BoardId = string;
426
+ }
427
+ export interface QueryParameters {
428
+ boardId: Parameters.BoardId;
429
+ }
430
+ namespace Responses {
431
+ export interface $200 {
432
+ message?: string;
433
+ default_board_id?: string;
434
+ }
435
+ export type $400 = /* Standard error response */ Components.Schemas.Error;
436
+ export type $401 = /* Standard error response */ Components.Schemas.Error;
437
+ export type $403 = /* Standard error response */ Components.Schemas.Error;
438
+ export type $404 = /* Standard error response */ Components.Schemas.Error;
439
+ export type $500 = /* Standard error response */ Components.Schemas.Error;
440
+ }
441
+ }
442
+ namespace UpdateKanbanBoard {
443
+ namespace Parameters {
444
+ export type BoardId = string;
445
+ }
446
+ export interface PathParameters {
447
+ boardId: Parameters.BoardId;
448
+ }
449
+ export type RequestBody = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
450
+ namespace Responses {
451
+ export type $200 = /* Full representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options. */ Components.Schemas.Board;
452
+ export type $400 = /* Standard error response */ Components.Schemas.Error;
453
+ export type $401 = /* Standard error response */ Components.Schemas.Error;
454
+ export type $403 = /* Standard error response */ Components.Schemas.Error;
455
+ export type $404 = /* Standard error response */ Components.Schemas.Error;
456
+ export type $500 = /* Standard error response */ Components.Schemas.Error;
457
+ }
458
+ }
459
+ }
460
+
461
+
462
+ interface OperationMethods {
463
+ /**
464
+ * createKanbanBoard - createKanbanBoard
465
+ *
466
+ * Creates a new Kanban board with the provided configuration.
467
+ *
468
+ * A board must have a title and a config containing at least one dataset. Swimlanes and filters can be configured to display specific subsets of workflow tasks or entities.
469
+ *
470
+ */
471
+ 'createKanbanBoard'(
472
+ parameters?: Parameters<UnknownParamsObject> | null,
473
+ data?: Paths.CreateKanbanBoard.RequestBody,
474
+ config?: AxiosRequestConfig
475
+ ): OperationResponse<Paths.CreateKanbanBoard.Responses.$200>
476
+ /**
477
+ * getKanbanBoards - getKanbanBoards
478
+ *
479
+ * Returns a list of all Kanban boards accessible to the authenticated user.
480
+ *
481
+ * Use the `filter` query parameter to narrow results to boards the user owns (`owned`) or boards shared with them (`shared`). When omitted, all accessible boards are returned.
482
+ *
483
+ */
484
+ 'getKanbanBoards'(
485
+ parameters?: Parameters<Paths.GetKanbanBoards.QueryParameters> | null,
486
+ data?: any,
487
+ config?: AxiosRequestConfig
488
+ ): OperationResponse<Paths.GetKanbanBoards.Responses.$200>
489
+ /**
490
+ * getKanbanBoard - getKanbanBoard
491
+ *
492
+ * Retrieves a Kanban board by ID, including its full configuration (swimlanes, filters, sorting, card fields).
493
+ *
494
+ * Use `"default"` as the `boardId` to retrieve the organization's currently configured default board.
495
+ *
496
+ */
497
+ 'getKanbanBoard'(
498
+ parameters?: Parameters<Paths.GetKanbanBoard.PathParameters> | null,
499
+ data?: any,
500
+ config?: AxiosRequestConfig
501
+ ): OperationResponse<Paths.GetKanbanBoard.Responses.$200>
502
+ /**
503
+ * updateKanbanBoard - updateKanbanBoard
504
+ *
505
+ * Fully replaces the configuration of an existing Kanban board by ID.
506
+ *
507
+ * All board fields (title, config, swimlanes, filters) must be provided. Use PATCH for partial updates.
508
+ *
509
+ */
510
+ 'updateKanbanBoard'(
511
+ parameters?: Parameters<Paths.UpdateKanbanBoard.PathParameters> | null,
512
+ data?: Paths.UpdateKanbanBoard.RequestBody,
513
+ config?: AxiosRequestConfig
514
+ ): OperationResponse<Paths.UpdateKanbanBoard.Responses.$200>
515
+ /**
516
+ * patchKanbanBoard - patchKanbanBoard
517
+ *
518
+ * Partially updates fields of an existing Kanban board by ID.
519
+ *
520
+ * Only the fields provided in the request body will be updated. Useful for updating sharing settings, ownership, or title without replacing the full board configuration.
521
+ *
522
+ */
523
+ 'patchKanbanBoard'(
524
+ parameters?: Parameters<Paths.PatchKanbanBoard.PathParameters> | null,
525
+ data?: Paths.PatchKanbanBoard.RequestBody,
526
+ config?: AxiosRequestConfig
527
+ ): OperationResponse<Paths.PatchKanbanBoard.Responses.$200>
528
+ /**
529
+ * deleteKanbanBoard - deleteKanbanBoard
530
+ *
531
+ * Permanently deletes a Kanban board by ID. This action is irreversible.
532
+ */
533
+ 'deleteKanbanBoard'(
534
+ parameters?: Parameters<Paths.DeleteKanbanBoard.PathParameters> | null,
535
+ data?: any,
536
+ config?: AxiosRequestConfig
537
+ ): OperationResponse<Paths.DeleteKanbanBoard.Responses.$200>
538
+ /**
539
+ * setDefaultKanbanBoard - setDefaultKanbanBoard
540
+ *
541
+ * Sets a Kanban board as the default board for the organization.
542
+ *
543
+ * The default board is shown to users who access the Kanban view without specifying a specific board ID.
544
+ * Pass `boardId` as a query parameter to identify the board to set as default.
545
+ *
546
+ */
547
+ 'setDefaultKanbanBoard'(
548
+ parameters?: Parameters<Paths.SetDefaultKanbanBoard.QueryParameters> | null,
549
+ data?: any,
550
+ config?: AxiosRequestConfig
551
+ ): OperationResponse<Paths.SetDefaultKanbanBoard.Responses.$200>
552
+ /**
553
+ * clearDefaultKanbanBoard - clearDefaultKanbanBoard
554
+ *
555
+ * Removes the default board configuration for the organization.
556
+ *
557
+ * After calling this endpoint, `getKanbanBoard` with `boardId=default` will return a 404 until a new default is set.
558
+ *
559
+ */
560
+ 'clearDefaultKanbanBoard'(
561
+ parameters?: Parameters<UnknownParamsObject> | null,
562
+ data?: any,
563
+ config?: AxiosRequestConfig
564
+ ): OperationResponse<Paths.ClearDefaultKanbanBoard.Responses.$200>
565
+ /**
566
+ * flowsAutocomplete - flowsAutocomplete
567
+ *
568
+ * Returns autocomplete suggestions for a given attribute in the Flows dataset.
569
+ *
570
+ * Use this endpoint to power filter dropdowns and search inputs in the Kanban board configuration UI.
571
+ * The `attribute` parameter specifies which field to autocomplete (e.g. `name`, `assignee`, `status`).
572
+ * The optional `input` parameter filters results to those matching the typed prefix.
573
+ *
574
+ */
575
+ 'flowsAutocomplete'(
576
+ parameters?: Parameters<Paths.FlowsAutocomplete.QueryParameters> | null,
577
+ data?: any,
578
+ config?: AxiosRequestConfig
579
+ ): OperationResponse<Paths.FlowsAutocomplete.Responses.$200>
580
+ /**
581
+ * executeFlowsQuery - executeFlowsQuery
582
+ *
583
+ * Executes a query against the Flows dataset and returns paginated results for use in Kanban card rendering.
584
+ *
585
+ * Supports filtering with complex AND/OR logic, sorting, and offset-based pagination.
586
+ * Results are used to populate Kanban swimlane cards with real-time workflow task data.
587
+ *
588
+ */
589
+ 'executeFlowsQuery'(
590
+ parameters?: Parameters<UnknownParamsObject> | null,
591
+ data?: Paths.ExecuteFlowsQuery.RequestBody,
592
+ config?: AxiosRequestConfig
593
+ ): OperationResponse<Paths.ExecuteFlowsQuery.Responses.$200>
594
+ }
595
+
596
+ interface PathsDictionary {
597
+ ['/v1/kanban/board']: {
598
+ /**
599
+ * createKanbanBoard - createKanbanBoard
600
+ *
601
+ * Creates a new Kanban board with the provided configuration.
602
+ *
603
+ * A board must have a title and a config containing at least one dataset. Swimlanes and filters can be configured to display specific subsets of workflow tasks or entities.
604
+ *
605
+ */
606
+ 'post'(
607
+ parameters?: Parameters<UnknownParamsObject> | null,
608
+ data?: Paths.CreateKanbanBoard.RequestBody,
609
+ config?: AxiosRequestConfig
610
+ ): OperationResponse<Paths.CreateKanbanBoard.Responses.$200>
611
+ }
612
+ ['/v1/kanban/boards']: {
613
+ /**
614
+ * getKanbanBoards - getKanbanBoards
615
+ *
616
+ * Returns a list of all Kanban boards accessible to the authenticated user.
617
+ *
618
+ * Use the `filter` query parameter to narrow results to boards the user owns (`owned`) or boards shared with them (`shared`). When omitted, all accessible boards are returned.
619
+ *
620
+ */
621
+ 'get'(
622
+ parameters?: Parameters<Paths.GetKanbanBoards.QueryParameters> | null,
623
+ data?: any,
624
+ config?: AxiosRequestConfig
625
+ ): OperationResponse<Paths.GetKanbanBoards.Responses.$200>
626
+ }
627
+ ['/v1/kanban/board/{boardId}']: {
628
+ /**
629
+ * getKanbanBoard - getKanbanBoard
630
+ *
631
+ * Retrieves a Kanban board by ID, including its full configuration (swimlanes, filters, sorting, card fields).
632
+ *
633
+ * Use `"default"` as the `boardId` to retrieve the organization's currently configured default board.
634
+ *
635
+ */
636
+ 'get'(
637
+ parameters?: Parameters<Paths.GetKanbanBoard.PathParameters> | null,
638
+ data?: any,
639
+ config?: AxiosRequestConfig
640
+ ): OperationResponse<Paths.GetKanbanBoard.Responses.$200>
641
+ /**
642
+ * updateKanbanBoard - updateKanbanBoard
643
+ *
644
+ * Fully replaces the configuration of an existing Kanban board by ID.
645
+ *
646
+ * All board fields (title, config, swimlanes, filters) must be provided. Use PATCH for partial updates.
647
+ *
648
+ */
649
+ 'put'(
650
+ parameters?: Parameters<Paths.UpdateKanbanBoard.PathParameters> | null,
651
+ data?: Paths.UpdateKanbanBoard.RequestBody,
652
+ config?: AxiosRequestConfig
653
+ ): OperationResponse<Paths.UpdateKanbanBoard.Responses.$200>
654
+ /**
655
+ * patchKanbanBoard - patchKanbanBoard
656
+ *
657
+ * Partially updates fields of an existing Kanban board by ID.
658
+ *
659
+ * Only the fields provided in the request body will be updated. Useful for updating sharing settings, ownership, or title without replacing the full board configuration.
660
+ *
661
+ */
662
+ 'patch'(
663
+ parameters?: Parameters<Paths.PatchKanbanBoard.PathParameters> | null,
664
+ data?: Paths.PatchKanbanBoard.RequestBody,
665
+ config?: AxiosRequestConfig
666
+ ): OperationResponse<Paths.PatchKanbanBoard.Responses.$200>
667
+ /**
668
+ * deleteKanbanBoard - deleteKanbanBoard
669
+ *
670
+ * Permanently deletes a Kanban board by ID. This action is irreversible.
671
+ */
672
+ 'delete'(
673
+ parameters?: Parameters<Paths.DeleteKanbanBoard.PathParameters> | null,
674
+ data?: any,
675
+ config?: AxiosRequestConfig
676
+ ): OperationResponse<Paths.DeleteKanbanBoard.Responses.$200>
677
+ }
678
+ ['/v1/kanban/org/default-board']: {
679
+ /**
680
+ * setDefaultKanbanBoard - setDefaultKanbanBoard
681
+ *
682
+ * Sets a Kanban board as the default board for the organization.
683
+ *
684
+ * The default board is shown to users who access the Kanban view without specifying a specific board ID.
685
+ * Pass `boardId` as a query parameter to identify the board to set as default.
686
+ *
687
+ */
688
+ 'put'(
689
+ parameters?: Parameters<Paths.SetDefaultKanbanBoard.QueryParameters> | null,
690
+ data?: any,
691
+ config?: AxiosRequestConfig
692
+ ): OperationResponse<Paths.SetDefaultKanbanBoard.Responses.$200>
693
+ /**
694
+ * clearDefaultKanbanBoard - clearDefaultKanbanBoard
695
+ *
696
+ * Removes the default board configuration for the organization.
697
+ *
698
+ * After calling this endpoint, `getKanbanBoard` with `boardId=default` will return a 404 until a new default is set.
699
+ *
700
+ */
701
+ 'delete'(
702
+ parameters?: Parameters<UnknownParamsObject> | null,
703
+ data?: any,
704
+ config?: AxiosRequestConfig
705
+ ): OperationResponse<Paths.ClearDefaultKanbanBoard.Responses.$200>
706
+ }
707
+ ['/v1/kanban/query/flows:autocomplete']: {
708
+ /**
709
+ * flowsAutocomplete - flowsAutocomplete
710
+ *
711
+ * Returns autocomplete suggestions for a given attribute in the Flows dataset.
712
+ *
713
+ * Use this endpoint to power filter dropdowns and search inputs in the Kanban board configuration UI.
714
+ * The `attribute` parameter specifies which field to autocomplete (e.g. `name`, `assignee`, `status`).
715
+ * The optional `input` parameter filters results to those matching the typed prefix.
716
+ *
717
+ */
718
+ 'get'(
719
+ parameters?: Parameters<Paths.FlowsAutocomplete.QueryParameters> | null,
720
+ data?: any,
721
+ config?: AxiosRequestConfig
722
+ ): OperationResponse<Paths.FlowsAutocomplete.Responses.$200>
723
+ }
724
+ ['/v1/kanban/query/flows:execute']: {
725
+ /**
726
+ * executeFlowsQuery - executeFlowsQuery
727
+ *
728
+ * Executes a query against the Flows dataset and returns paginated results for use in Kanban card rendering.
729
+ *
730
+ * Supports filtering with complex AND/OR logic, sorting, and offset-based pagination.
731
+ * Results are used to populate Kanban swimlane cards with real-time workflow task data.
732
+ *
733
+ */
734
+ 'post'(
735
+ parameters?: Parameters<UnknownParamsObject> | null,
736
+ data?: Paths.ExecuteFlowsQuery.RequestBody,
737
+ config?: AxiosRequestConfig
738
+ ): OperationResponse<Paths.ExecuteFlowsQuery.Responses.$200>
739
+ }
740
+ }
741
+
742
+ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
743
+
744
+
745
+ type Board = Components.Schemas.Board;
746
+ type BoardFilter = Components.Schemas.BoardFilter;
747
+ type BoardSummary = Components.Schemas.BoardSummary;
748
+ type DynamicDateValue = Components.Schemas.DynamicDateValue;
749
+ type Error = Components.Schemas.Error;
750
+ type FilterGroup = Components.Schemas.FilterGroup;
751
+ type FilterItem = Components.Schemas.FilterItem;
752
+ type FilterOperator = Components.Schemas.FilterOperator;
753
+ type FlowsQueryRequest = Components.Schemas.FlowsQueryRequest;
754
+ type FlowsQueryResult = Components.Schemas.FlowsQueryResult;
755
+ type GroupBy = Components.Schemas.GroupBy;
756
+ type Sorting = Components.Schemas.Sorting;
757
+ type Swimlane = Components.Schemas.Swimlane;
758
+ type ValueType = Components.Schemas.ValueType;
759
+
760
+ export { type Board as B, type Client as C, type DynamicDateValue as D, type Error as E, type FilterGroup as F, type GroupBy as G, type OperationMethods as O, Paths as P, type Sorting as S, type ValueType as V, Components as a, type PathsDictionary as b, type BoardFilter as c, type BoardSummary as d, type FilterItem as e, type FilterOperator as f, type FlowsQueryRequest as g, type FlowsQueryResult as h, type Swimlane as i };