@epilot/sdk 2.0.0-beta.6 → 2.0.3

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 (134) hide show
  1. package/LICENSE +21 -0
  2. package/dist/apis/automation.d.cts +2 -2
  3. package/dist/apis/automation.d.ts +2 -2
  4. package/dist/apis/customer-portal.cjs +1 -1
  5. package/dist/apis/customer-portal.d.cts +2 -2
  6. package/dist/apis/customer-portal.d.ts +2 -2
  7. package/dist/apis/customer-portal.js +1 -1
  8. package/dist/apis/erp-integration.cjs +1 -1
  9. package/dist/apis/erp-integration.d.cts +2 -2
  10. package/dist/apis/erp-integration.d.ts +2 -2
  11. package/dist/apis/erp-integration.js +1 -1
  12. package/dist/apis/journey.d.cts +2 -2
  13. package/dist/apis/journey.d.ts +2 -2
  14. package/dist/apis/kanban.d.cts +2 -2
  15. package/dist/apis/kanban.d.ts +2 -2
  16. package/dist/apis/organization.cjs +1 -1
  17. package/dist/apis/organization.d.cts +2 -2
  18. package/dist/apis/organization.d.ts +2 -2
  19. package/dist/apis/organization.js +1 -1
  20. package/dist/apis/workflow.d.cts +2 -2
  21. package/dist/apis/workflow.d.ts +2 -2
  22. package/dist/{automation.d-sRCRiHKf.d.cts → automation.d-KOiZ6ru5.d.cts} +2 -24
  23. package/dist/{automation.d-sRCRiHKf.d.ts → automation.d-KOiZ6ru5.d.ts} +2 -24
  24. package/dist/{customer-portal.d-D7cJvhBK.d.ts → customer-portal.d-Bh9NF8cY.d.cts} +598 -99
  25. package/dist/{customer-portal.d-D7cJvhBK.d.cts → customer-portal.d-Bh9NF8cY.d.ts} +598 -99
  26. package/dist/{erp-integration.d-3LmxMirP.d.cts → erp-integration.d-DOhxy4P5.d.cts} +409 -15
  27. package/dist/{erp-integration.d-3LmxMirP.d.ts → erp-integration.d-DOhxy4P5.d.ts} +409 -15
  28. package/dist/index.d.cts +7 -7
  29. package/dist/index.d.ts +7 -7
  30. package/dist/{journey.d-DkBvO_Wa.d.ts → journey.d-C4N4t1Rh.d.cts} +122 -4
  31. package/dist/{journey.d-DkBvO_Wa.d.cts → journey.d-C4N4t1Rh.d.ts} +122 -4
  32. package/dist/kanban.d-CtSt3uX2.d.cts +745 -0
  33. package/dist/kanban.d-CtSt3uX2.d.ts +745 -0
  34. package/dist/organization.d-Bd2Hmk8v.d.cts +1244 -0
  35. package/dist/organization.d-Bd2Hmk8v.d.ts +1244 -0
  36. package/dist/{workflow.d-EPa2OdVW.d.cts → workflow.d-DvhTpEtU.d.cts} +45 -3
  37. package/dist/{workflow.d-EPa2OdVW.d.ts → workflow.d-DvhTpEtU.d.ts} +45 -3
  38. package/package.json +10 -11
  39. package/definitions/access-token-runtime.json +0 -1
  40. package/definitions/access-token.json +0 -663
  41. package/definitions/address-runtime.json +0 -1
  42. package/definitions/address-suggestions-runtime.json +0 -1
  43. package/definitions/address-suggestions.json +0 -582
  44. package/definitions/address.json +0 -578
  45. package/definitions/ai-agents-runtime.json +0 -1
  46. package/definitions/ai-agents.json +0 -1711
  47. package/definitions/app-runtime.json +0 -1
  48. package/definitions/app.json +0 -4443
  49. package/definitions/audit-logs-runtime.json +0 -1
  50. package/definitions/audit-logs.json +0 -305
  51. package/definitions/automation-runtime.json +0 -1
  52. package/definitions/automation.json +0 -4850
  53. package/definitions/billing-runtime.json +0 -1
  54. package/definitions/billing.json +0 -837
  55. package/definitions/blueprint-manifest-runtime.json +0 -1
  56. package/definitions/blueprint-manifest.json +0 -3376
  57. package/definitions/consent-runtime.json +0 -1
  58. package/definitions/consent.json +0 -344
  59. package/definitions/customer-portal-runtime.json +0 -1
  60. package/definitions/customer-portal.json +0 -15000
  61. package/definitions/dashboard-runtime.json +0 -1
  62. package/definitions/dashboard.json +0 -484
  63. package/definitions/data-management-runtime.json +0 -1
  64. package/definitions/data-management.json +0 -962
  65. package/definitions/deduplication-runtime.json +0 -1
  66. package/definitions/deduplication.json +0 -183
  67. package/definitions/design-runtime.json +0 -1
  68. package/definitions/design.json +0 -1423
  69. package/definitions/document-runtime.json +0 -1
  70. package/definitions/document.json +0 -758
  71. package/definitions/email-settings-runtime.json +0 -1
  72. package/definitions/email-settings.json +0 -2627
  73. package/definitions/email-template-runtime.json +0 -1
  74. package/definitions/email-template.json +0 -1419
  75. package/definitions/entity-mapping-runtime.json +0 -1
  76. package/definitions/entity-mapping.json +0 -1642
  77. package/definitions/entity-runtime.json +0 -1
  78. package/definitions/entity.json +0 -10074
  79. package/definitions/environments-runtime.json +0 -1
  80. package/definitions/environments.json +0 -363
  81. package/definitions/erp-integration-runtime.json +0 -1
  82. package/definitions/erp-integration.json +0 -5845
  83. package/definitions/event-catalog-runtime.json +0 -1
  84. package/definitions/event-catalog.json +0 -1051
  85. package/definitions/file-runtime.json +0 -1
  86. package/definitions/file.json +0 -2842
  87. package/definitions/iban-runtime.json +0 -1
  88. package/definitions/iban.json +0 -132
  89. package/definitions/journey-runtime.json +0 -1
  90. package/definitions/journey.json +0 -2341
  91. package/definitions/kanban-runtime.json +0 -1
  92. package/definitions/kanban.json +0 -929
  93. package/definitions/message-runtime.json +0 -1
  94. package/definitions/message.json +0 -2660
  95. package/definitions/metering-runtime.json +0 -1
  96. package/definitions/metering.json +0 -2321
  97. package/definitions/notes-runtime.json +0 -1
  98. package/definitions/notes.json +0 -1531
  99. package/definitions/notification-runtime.json +0 -1
  100. package/definitions/notification.json +0 -1425
  101. package/definitions/organization-runtime.json +0 -1
  102. package/definitions/organization.json +0 -629
  103. package/definitions/partner-directory-runtime.json +0 -1
  104. package/definitions/partner-directory.json +0 -1718
  105. package/definitions/permissions-runtime.json +0 -1
  106. package/definitions/permissions.json +0 -1480
  107. package/definitions/pricing-runtime.json +0 -1
  108. package/definitions/pricing-tier-runtime.json +0 -1
  109. package/definitions/pricing-tier.json +0 -105
  110. package/definitions/pricing.json +0 -9884
  111. package/definitions/purpose-runtime.json +0 -1
  112. package/definitions/purpose.json +0 -524
  113. package/definitions/sandbox-runtime.json +0 -1
  114. package/definitions/sandbox.json +0 -453
  115. package/definitions/submission-runtime.json +0 -1
  116. package/definitions/submission.json +0 -313
  117. package/definitions/targeting-runtime.json +0 -1
  118. package/definitions/targeting.json +0 -1474
  119. package/definitions/template-variables-runtime.json +0 -1
  120. package/definitions/template-variables.json +0 -1408
  121. package/definitions/user-runtime.json +0 -1
  122. package/definitions/user.json +0 -2408
  123. package/definitions/validation-rules-runtime.json +0 -1
  124. package/definitions/validation-rules.json +0 -1491
  125. package/definitions/webhooks-runtime.json +0 -1
  126. package/definitions/webhooks.json +0 -1525
  127. package/definitions/workflow-definition-runtime.json +0 -1
  128. package/definitions/workflow-definition.json +0 -3417
  129. package/definitions/workflow-runtime.json +0 -1
  130. package/definitions/workflow.json +0 -4106
  131. package/dist/kanban.d-DUClxyBG.d.cts +0 -630
  132. package/dist/kanban.d-DUClxyBG.d.ts +0 -630
  133. package/dist/organization.d-BOLK3v9o.d.cts +0 -628
  134. package/dist/organization.d-BOLK3v9o.d.ts +0 -628
@@ -1,929 +0,0 @@
1
- {
2
- "openapi": "3.0.3",
3
- "info": {
4
- "title": "Kanban API",
5
- "version": "1.2.3"
6
- },
7
- "tags": [
8
- {
9
- "name": "Kanban",
10
- "description": "Kanban endpoints"
11
- }
12
- ],
13
- "security": [
14
- {
15
- "EpilotAuth": []
16
- },
17
- {
18
- "EpilotOrg": []
19
- }
20
- ],
21
- "paths": {
22
- "/v1/kanban/board": {
23
- "post": {
24
- "operationId": "createKanbanBoard",
25
- "summary": "Create a Kanban board",
26
- "description": "Create a Kanban board",
27
- "tags": [
28
- "Kanban"
29
- ],
30
- "requestBody": {
31
- "content": {
32
- "application/json": {
33
- "schema": {
34
- "$ref": "#/components/schemas/Board"
35
- }
36
- }
37
- }
38
- },
39
- "responses": {
40
- "200": {
41
- "description": "Successfully created board",
42
- "content": {
43
- "application/json": {
44
- "schema": {
45
- "$ref": "#/components/schemas/Board"
46
- }
47
- }
48
- }
49
- },
50
- "400": {
51
- "description": "Bad request - Invalid input data"
52
- },
53
- "401": {
54
- "description": "Unauthorized - Authentication required"
55
- },
56
- "403": {
57
- "description": "Forbidden - Insufficient permissions"
58
- },
59
- "500": {
60
- "description": "Internal server error"
61
- }
62
- }
63
- }
64
- },
65
- "/v1/kanban/boards": {
66
- "get": {
67
- "operationId": "getKanbanBoards",
68
- "summary": "Get all Kanban boards",
69
- "description": "Get all Kanban boards",
70
- "tags": [
71
- "Kanban"
72
- ],
73
- "parameters": [
74
- {
75
- "name": "filter",
76
- "in": "query",
77
- "description": "Filter boards by ownership type. If not provided, returns all accessible boards.",
78
- "schema": {
79
- "type": "string",
80
- "enum": [
81
- "owned",
82
- "shared"
83
- ]
84
- },
85
- "required": false
86
- }
87
- ],
88
- "responses": {
89
- "200": {
90
- "description": "Successfully retrieved boards",
91
- "content": {
92
- "application/json": {
93
- "schema": {
94
- "type": "array",
95
- "items": {
96
- "$ref": "#/components/schemas/BoardSummary"
97
- }
98
- }
99
- }
100
- }
101
- },
102
- "401": {
103
- "description": "Unauthorized - Authentication required"
104
- },
105
- "403": {
106
- "description": "Forbidden - Insufficient permissions"
107
- },
108
- "500": {
109
- "description": "Internal server error"
110
- }
111
- }
112
- }
113
- },
114
- "/v1/kanban/board/{boardId}": {
115
- "get": {
116
- "operationId": "getKanbanBoard",
117
- "summary": "Get a Kanban board",
118
- "description": "Get a Kanban board by ID. Use \"default\" as the boardId to get the organization's default board.\n",
119
- "tags": [
120
- "Kanban"
121
- ],
122
- "parameters": [
123
- {
124
- "name": "boardId",
125
- "in": "path",
126
- "required": true,
127
- "schema": {
128
- "type": "string"
129
- },
130
- "description": "The board ID, or \"default\" to get the organization's default board.\n",
131
- "example": "board-123"
132
- }
133
- ],
134
- "responses": {
135
- "200": {
136
- "description": "Successfully retrieved board",
137
- "content": {
138
- "application/json": {
139
- "schema": {
140
- "$ref": "#/components/schemas/Board"
141
- }
142
- }
143
- }
144
- },
145
- "401": {
146
- "description": "Unauthorized - Authentication required"
147
- },
148
- "403": {
149
- "description": "Forbidden - Insufficient permissions"
150
- },
151
- "404": {
152
- "description": "Board not found"
153
- },
154
- "500": {
155
- "description": "Internal server error"
156
- }
157
- }
158
- },
159
- "put": {
160
- "operationId": "updateKanbanBoard",
161
- "summary": "Update a Kanban board",
162
- "description": "Update a Kanban board",
163
- "tags": [
164
- "Kanban"
165
- ],
166
- "parameters": [
167
- {
168
- "name": "boardId",
169
- "in": "path",
170
- "required": true,
171
- "schema": {
172
- "type": "string"
173
- }
174
- }
175
- ],
176
- "requestBody": {
177
- "content": {
178
- "application/json": {
179
- "schema": {
180
- "$ref": "#/components/schemas/Board"
181
- }
182
- }
183
- }
184
- },
185
- "responses": {
186
- "200": {
187
- "description": "Successfully updated board",
188
- "content": {
189
- "application/json": {
190
- "schema": {
191
- "$ref": "#/components/schemas/Board"
192
- }
193
- }
194
- }
195
- },
196
- "400": {
197
- "description": "Bad request - Invalid input data"
198
- },
199
- "401": {
200
- "description": "Unauthorized - Authentication required"
201
- },
202
- "403": {
203
- "description": "Forbidden - Insufficient permissions"
204
- },
205
- "404": {
206
- "description": "Board not found"
207
- },
208
- "500": {
209
- "description": "Internal server error"
210
- }
211
- }
212
- },
213
- "patch": {
214
- "operationId": "patchKanbanBoard",
215
- "summary": "Patch a Kanban board",
216
- "description": "Patch a Kanban board",
217
- "tags": [
218
- "Kanban"
219
- ],
220
- "parameters": [
221
- {
222
- "name": "boardId",
223
- "in": "path",
224
- "required": true,
225
- "schema": {
226
- "type": "string"
227
- }
228
- }
229
- ],
230
- "requestBody": {
231
- "content": {
232
- "application/json": {
233
- "schema": {
234
- "type": "object",
235
- "properties": {
236
- "title": {
237
- "type": "string",
238
- "example": "Board 1"
239
- },
240
- "description": {
241
- "type": "string",
242
- "example": "Board description"
243
- },
244
- "shared_with": {
245
- "type": "array",
246
- "items": {
247
- "type": "string"
248
- }
249
- },
250
- "shared_with_org": {
251
- "type": "boolean"
252
- },
253
- "owners": {
254
- "type": "array",
255
- "items": {
256
- "type": "string"
257
- },
258
- "description": "Array of user IDs who have full ownership rights for this board (view, edit, delete)"
259
- }
260
- }
261
- }
262
- }
263
- }
264
- },
265
- "responses": {
266
- "200": {
267
- "description": "Successfully patched board",
268
- "content": {
269
- "application/json": {
270
- "schema": {
271
- "$ref": "#/components/schemas/Board"
272
- }
273
- }
274
- }
275
- },
276
- "400": {
277
- "description": "Bad request - Invalid input data"
278
- },
279
- "401": {
280
- "description": "Unauthorized - Authentication required"
281
- },
282
- "403": {
283
- "description": "Forbidden - Insufficient permissions"
284
- },
285
- "404": {
286
- "description": "Board not found"
287
- },
288
- "500": {
289
- "description": "Internal server error"
290
- }
291
- }
292
- },
293
- "delete": {
294
- "operationId": "deleteKanbanBoard",
295
- "summary": "Delete a Kanban board",
296
- "description": "Delete a Kanban board",
297
- "tags": [
298
- "Kanban"
299
- ],
300
- "parameters": [
301
- {
302
- "name": "boardId",
303
- "in": "path",
304
- "required": true,
305
- "schema": {
306
- "type": "string"
307
- }
308
- }
309
- ],
310
- "responses": {
311
- "200": {
312
- "description": "Successfully deleted board"
313
- },
314
- "401": {
315
- "description": "Unauthorized - Authentication required"
316
- },
317
- "403": {
318
- "description": "Forbidden - Insufficient permissions"
319
- },
320
- "404": {
321
- "description": "Board not found"
322
- },
323
- "500": {
324
- "description": "Internal server error"
325
- }
326
- }
327
- }
328
- },
329
- "/v1/kanban/org/default-board": {
330
- "put": {
331
- "operationId": "setDefaultKanbanBoard",
332
- "summary": "Set default board for organization",
333
- "description": "Set a board as the default board for the organization",
334
- "tags": [
335
- "Kanban"
336
- ],
337
- "parameters": [
338
- {
339
- "name": "boardId",
340
- "in": "query",
341
- "required": true,
342
- "schema": {
343
- "type": "string"
344
- },
345
- "description": "The ID of the board to set as default"
346
- }
347
- ],
348
- "responses": {
349
- "200": {
350
- "description": "Successfully set default board",
351
- "content": {
352
- "application/json": {
353
- "schema": {
354
- "type": "object",
355
- "properties": {
356
- "message": {
357
- "type": "string"
358
- },
359
- "default_board_id": {
360
- "type": "string"
361
- }
362
- }
363
- }
364
- }
365
- }
366
- },
367
- "400": {
368
- "description": "Bad request - Invalid input data or boardId missing"
369
- },
370
- "401": {
371
- "description": "Unauthorized - Authentication required"
372
- },
373
- "403": {
374
- "description": "Forbidden - Insufficient permissions"
375
- },
376
- "404": {
377
- "description": "Board not found"
378
- },
379
- "500": {
380
- "description": "Internal server error"
381
- }
382
- }
383
- },
384
- "delete": {
385
- "operationId": "clearDefaultKanbanBoard",
386
- "summary": "Clear default board for organization",
387
- "description": "Remove the default board setting for the organization",
388
- "tags": [
389
- "Kanban"
390
- ],
391
- "responses": {
392
- "200": {
393
- "description": "Successfully cleared default board",
394
- "content": {
395
- "application/json": {
396
- "schema": {
397
- "type": "object",
398
- "properties": {
399
- "message": {
400
- "type": "string"
401
- },
402
- "default_board_id": {
403
- "type": "string",
404
- "nullable": true
405
- }
406
- }
407
- }
408
- }
409
- }
410
- },
411
- "401": {
412
- "description": "Unauthorized - Authentication required"
413
- },
414
- "403": {
415
- "description": "Forbidden - Insufficient permissions"
416
- },
417
- "500": {
418
- "description": "Internal server error"
419
- }
420
- }
421
- }
422
- },
423
- "/v1/kanban/query/flows:autocomplete": {
424
- "get": {
425
- "operationId": "flowsAutocomplete",
426
- "summary": "flowsAutocomplete",
427
- "description": "Autocomplete flows data\n",
428
- "tags": [
429
- "Query"
430
- ],
431
- "parameters": [
432
- {
433
- "name": "input",
434
- "in": "query",
435
- "description": "Input to autocomplete",
436
- "schema": {
437
- "type": "string"
438
- }
439
- },
440
- {
441
- "name": "attribute",
442
- "in": "query",
443
- "description": "Autocomplete attribute",
444
- "schema": {
445
- "type": "string",
446
- "example": "name"
447
- },
448
- "required": true
449
- },
450
- {
451
- "name": "size",
452
- "in": "query",
453
- "description": "Maximum number of results to return",
454
- "schema": {
455
- "type": "integer",
456
- "default": 25,
457
- "minimum": 1,
458
- "maximum": 250
459
- }
460
- },
461
- {
462
- "name": "from",
463
- "in": "query",
464
- "description": "Starting offset for pagination",
465
- "schema": {
466
- "type": "integer",
467
- "default": 0,
468
- "minimum": 0
469
- }
470
- }
471
- ],
472
- "responses": {
473
- "200": {
474
- "description": "Success",
475
- "content": {
476
- "application/json": {
477
- "schema": {
478
- "type": "object",
479
- "properties": {
480
- "results": {
481
- "type": "array",
482
- "items": {
483
- "anyOf": [
484
- {
485
- "type": "string"
486
- },
487
- {
488
- "type": "boolean"
489
- },
490
- {
491
- "type": "object",
492
- "additionalProperties": true
493
- }
494
- ]
495
- },
496
- "example": [
497
- "value"
498
- ]
499
- },
500
- "hits": {
501
- "type": "number",
502
- "description": "Total number of matching items available",
503
- "example": 42
504
- }
505
- },
506
- "required": [
507
- "results",
508
- "hits"
509
- ]
510
- }
511
- }
512
- }
513
- }
514
- }
515
- }
516
- },
517
- "/v1/kanban/query/flows:execute": {
518
- "post": {
519
- "operationId": "executeFlowsQuery",
520
- "summary": "executeFlowsQuery",
521
- "description": "Query Flows Data for Kanban View.",
522
- "tags": [
523
- "Query"
524
- ],
525
- "requestBody": {
526
- "content": {
527
- "application/json": {
528
- "schema": {
529
- "$ref": "#/components/schemas/FlowsQueryRequest"
530
- }
531
- }
532
- }
533
- },
534
- "responses": {
535
- "200": {
536
- "description": "Query results",
537
- "content": {
538
- "application/json": {
539
- "schema": {
540
- "$ref": "#/components/schemas/FlowsQueryResult"
541
- }
542
- }
543
- }
544
- }
545
- }
546
- }
547
- }
548
- },
549
- "components": {
550
- "securitySchemes": {
551
- "EpilotAuth": {
552
- "type": "http",
553
- "scheme": "bearer",
554
- "description": "Authorization header with epilot OAuth2 bearer token",
555
- "bearerFormat": "JWT"
556
- },
557
- "EpilotOrg": {
558
- "description": "Overrides the target organization to allow shared tenantaccess",
559
- "name": "x-epilot-org-id",
560
- "in": "header",
561
- "type": "apiKey"
562
- }
563
- },
564
- "schemas": {
565
- "BoardSummary": {
566
- "type": "object",
567
- "properties": {
568
- "id": {
569
- "type": "string"
570
- },
571
- "title": {
572
- "type": "string",
573
- "example": "Board 1"
574
- },
575
- "description": {
576
- "type": "string",
577
- "example": "Board description"
578
- },
579
- "created_at": {
580
- "type": "string",
581
- "format": "date-time"
582
- },
583
- "updated_at": {
584
- "type": "string",
585
- "format": "date-time"
586
- },
587
- "created_by": {
588
- "type": "string"
589
- },
590
- "org_id": {
591
- "type": "string"
592
- },
593
- "updated_by": {
594
- "type": "string"
595
- },
596
- "shared_with": {
597
- "type": "array",
598
- "items": {
599
- "type": "string"
600
- }
601
- },
602
- "shared_with_org": {
603
- "type": "boolean"
604
- },
605
- "owners": {
606
- "type": "array",
607
- "items": {
608
- "type": "string"
609
- },
610
- "description": "Array of user IDs who have full ownership rights for this board (view, edit, delete)"
611
- }
612
- }
613
- },
614
- "Board": {
615
- "allOf": [
616
- {
617
- "$ref": "#/components/schemas/BoardSummary"
618
- },
619
- {
620
- "type": "object",
621
- "properties": {
622
- "config": {
623
- "type": "object",
624
- "properties": {
625
- "dataset": {
626
- "type": "string",
627
- "example": "workflow_tasks_overview"
628
- },
629
- "swimlanes": {
630
- "type": "array",
631
- "items": {
632
- "$ref": "#/components/schemas/Swimlane"
633
- }
634
- },
635
- "card_config": {
636
- "type": "object",
637
- "properties": {
638
- "fields": {
639
- "type": "array",
640
- "items": {
641
- "type": "string",
642
- "example": "assignee"
643
- }
644
- }
645
- }
646
- },
647
- "board_filter": {
648
- "$ref": "#/components/schemas/BoardFilter"
649
- },
650
- "sorting": {
651
- "$ref": "#/components/schemas/Sorting"
652
- },
653
- "search_query": {
654
- "type": "string",
655
- "example": "task 1"
656
- }
657
- }
658
- }
659
- },
660
- "required": [
661
- "title",
662
- "config"
663
- ]
664
- }
665
- ]
666
- },
667
- "Swimlane": {
668
- "type": "object",
669
- "properties": {
670
- "id": {
671
- "type": "string"
672
- },
673
- "title": {
674
- "type": "string",
675
- "example": "Swimlane 1"
676
- },
677
- "position": {
678
- "type": "number",
679
- "example": 1
680
- },
681
- "filter": {
682
- "$ref": "#/components/schemas/BoardFilter"
683
- },
684
- "title_chip_variant": {
685
- "type": "string",
686
- "example": "success"
687
- }
688
- }
689
- },
690
- "Sorting": {
691
- "type": "object",
692
- "properties": {
693
- "field": {
694
- "type": "string",
695
- "example": "created_at"
696
- },
697
- "direction": {
698
- "type": "string",
699
- "enum": [
700
- "asc",
701
- "desc"
702
- ],
703
- "default": "asc"
704
- }
705
- },
706
- "required": [
707
- "field"
708
- ]
709
- },
710
- "BoardFilter": {
711
- "type": "object",
712
- "properties": {
713
- "items": {
714
- "type": "array",
715
- "items": {
716
- "oneOf": [
717
- {
718
- "$ref": "#/components/schemas/FilterItem"
719
- },
720
- {
721
- "$ref": "#/components/schemas/FilterGroup"
722
- }
723
- ]
724
- }
725
- },
726
- "combination": {
727
- "type": "string",
728
- "enum": [
729
- "AND",
730
- "OR"
731
- ],
732
- "example": "OR"
733
- }
734
- },
735
- "required": [
736
- "items",
737
- "combination"
738
- ]
739
- },
740
- "FilterGroup": {
741
- "type": "object",
742
- "properties": {
743
- "items": {
744
- "type": "array",
745
- "items": {
746
- "$ref": "#/components/schemas/FilterItem"
747
- }
748
- },
749
- "combination": {
750
- "type": "string",
751
- "enum": [
752
- "AND",
753
- "OR"
754
- ],
755
- "example": "AND"
756
- }
757
- },
758
- "required": [
759
- "items",
760
- "combination"
761
- ]
762
- },
763
- "FilterOperator": {
764
- "type": "string",
765
- "enum": [
766
- "EQUALS",
767
- "NOT_EQUALS",
768
- "EMPTY",
769
- "NOT_EMPTY",
770
- "CONTAINS",
771
- "NOT_CONTAINS",
772
- "IS_ONE_OF",
773
- "IS_NONE_OF",
774
- "GREATER_THAN",
775
- "LESS_THAN",
776
- "GREATER_THAN_OR_EQUAL",
777
- "LESS_THAN_OR_EQUAL"
778
- ],
779
- "example": "EQUALS",
780
- "description": "The comparison operator for filtering"
781
- },
782
- "DynamicDateValue": {
783
- "type": "string",
784
- "enum": [
785
- "TODAY",
786
- "TOMORROW",
787
- "YESTERDAY",
788
- "IN_THE_FUTURE",
789
- "IN_THE_PAST",
790
- "THIS_WEEK",
791
- "NEXT_WEEK",
792
- "LAST_WEEK",
793
- "THIS_MONTH",
794
- "NEXT_MONTH",
795
- "LAST_MONTH"
796
- ],
797
- "description": "Dynamic date keywords that resolve to actual dates at runtime"
798
- },
799
- "ValueType": {
800
- "anyOf": [
801
- {
802
- "type": "string",
803
- "example": "100020"
804
- },
805
- {
806
- "$ref": "#/components/schemas/DynamicDateValue"
807
- },
808
- {
809
- "type": "number",
810
- "example": 42
811
- },
812
- {
813
- "type": "boolean",
814
- "example": true
815
- },
816
- {
817
- "type": "array",
818
- "items": {
819
- "anyOf": [
820
- {
821
- "type": "string"
822
- },
823
- {
824
- "$ref": "#/components/schemas/DynamicDateValue"
825
- },
826
- {
827
- "type": "number"
828
- },
829
- {
830
- "type": "boolean"
831
- }
832
- ]
833
- },
834
- "example": [
835
- "value1",
836
- "value2",
837
- 123,
838
- true
839
- ]
840
- }
841
- ],
842
- "description": "The value to compare against - can be a single value (string, number, boolean, or dynamic date) or an array of values"
843
- },
844
- "FlowsQueryRequest": {
845
- "type": "object",
846
- "properties": {
847
- "filters": {
848
- "$ref": "#/components/schemas/BoardFilter"
849
- },
850
- "sorting": {
851
- "$ref": "#/components/schemas/Sorting"
852
- },
853
- "from": {
854
- "type": "number",
855
- "default": 0
856
- },
857
- "size": {
858
- "type": "number",
859
- "default": 10
860
- }
861
- }
862
- },
863
- "FlowsQueryResult": {
864
- "type": "object",
865
- "properties": {
866
- "results": {
867
- "type": "array",
868
- "items": {
869
- "type": "object",
870
- "additionalProperties": true
871
- }
872
- },
873
- "hits": {
874
- "type": "number"
875
- },
876
- "page_number": {
877
- "type": "number"
878
- },
879
- "page_size": {
880
- "type": "number"
881
- },
882
- "total_pages": {
883
- "type": "number"
884
- }
885
- },
886
- "additionalProperties": true
887
- },
888
- "FilterItem": {
889
- "type": "object",
890
- "properties": {
891
- "key": {
892
- "type": "string",
893
- "example": "assignee",
894
- "description": "The field key to filter on"
895
- },
896
- "operator": {
897
- "$ref": "#/components/schemas/FilterOperator"
898
- },
899
- "value": {
900
- "$ref": "#/components/schemas/ValueType"
901
- },
902
- "data_type": {
903
- "type": "string",
904
- "enum": [
905
- "string",
906
- "number",
907
- "boolean",
908
- "date"
909
- ],
910
- "example": "string",
911
- "description": "The data type of the field"
912
- }
913
- },
914
- "required": [
915
- "key",
916
- "operator"
917
- ]
918
- }
919
- }
920
- },
921
- "servers": [
922
- {
923
- "url": "https://kanban.sls.epilot.io"
924
- },
925
- {
926
- "url": "https://kanban.sls.epilot.io"
927
- }
928
- ]
929
- }