@epilot/sdk 2.19.2 → 2.19.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 (109) hide show
  1. package/dist/apis/pricing.d.cts +67 -3
  2. package/dist/apis/pricing.d.ts +67 -3
  3. package/dist/index.d.cts +1 -1
  4. package/dist/index.d.ts +1 -1
  5. package/dist/{pricing.d-Det6zqGv.d.cts → pricing.d-CSVO1WCD.d.cts} +1 -1
  6. package/dist/{pricing.d-Det6zqGv.d.ts → pricing.d-CSVO1WCD.d.ts} +1 -1
  7. package/package.json +1 -1
  8. package/definitions/access-token-runtime.json +0 -1
  9. package/definitions/access-token.json +0 -835
  10. package/definitions/address-runtime.json +0 -1
  11. package/definitions/address-suggestions-runtime.json +0 -1
  12. package/definitions/address-suggestions.json +0 -582
  13. package/definitions/address.json +0 -578
  14. package/definitions/ai-agents-runtime.json +0 -1
  15. package/definitions/ai-agents.json +0 -2863
  16. package/definitions/app-runtime.json +0 -1
  17. package/definitions/app.json +0 -5743
  18. package/definitions/audit-logs-runtime.json +0 -1
  19. package/definitions/audit-logs.json +0 -305
  20. package/definitions/automation-runtime.json +0 -1
  21. package/definitions/automation.json +0 -5557
  22. package/definitions/billing-runtime.json +0 -1
  23. package/definitions/billing.json +0 -2386
  24. package/definitions/blueprint-manifest-runtime.json +0 -1
  25. package/definitions/blueprint-manifest.json +0 -7718
  26. package/definitions/calendar-runtime.json +0 -1
  27. package/definitions/calendar.json +0 -2904
  28. package/definitions/configuration-hub-runtime.json +0 -1
  29. package/definitions/configuration-hub.json +0 -2250
  30. package/definitions/consent-runtime.json +0 -1
  31. package/definitions/consent.json +0 -344
  32. package/definitions/customer-portal-runtime.json +0 -1
  33. package/definitions/customer-portal.json +0 -19919
  34. package/definitions/dashboard-runtime.json +0 -1
  35. package/definitions/dashboard.json +0 -1355
  36. package/definitions/data-governance-runtime.json +0 -1
  37. package/definitions/data-governance.json +0 -1126
  38. package/definitions/deduplication-runtime.json +0 -1
  39. package/definitions/deduplication.json +0 -782
  40. package/definitions/design-runtime.json +0 -1
  41. package/definitions/design.json +0 -1827
  42. package/definitions/document-runtime.json +0 -1
  43. package/definitions/document.json +0 -758
  44. package/definitions/email-settings-runtime.json +0 -1
  45. package/definitions/email-settings.json +0 -3736
  46. package/definitions/email-template-runtime.json +0 -1
  47. package/definitions/email-template.json +0 -1441
  48. package/definitions/entity-mapping-runtime.json +0 -1
  49. package/definitions/entity-mapping.json +0 -1642
  50. package/definitions/entity-runtime.json +0 -1
  51. package/definitions/entity.json +0 -11517
  52. package/definitions/environments-runtime.json +0 -1
  53. package/definitions/environments.json +0 -539
  54. package/definitions/event-catalog-runtime.json +0 -1
  55. package/definitions/event-catalog.json +0 -1524
  56. package/definitions/file-runtime.json +0 -1
  57. package/definitions/file.json +0 -3905
  58. package/definitions/iban-runtime.json +0 -1
  59. package/definitions/iban.json +0 -132
  60. package/definitions/integration-toolkit-runtime.json +0 -1
  61. package/definitions/integration-toolkit.json +0 -12769
  62. package/definitions/journey-runtime.json +0 -1
  63. package/definitions/journey.json +0 -2640
  64. package/definitions/kanban-runtime.json +0 -1
  65. package/definitions/kanban.json +0 -1506
  66. package/definitions/message-runtime.json +0 -1
  67. package/definitions/message.json +0 -3667
  68. package/definitions/metering-runtime.json +0 -1
  69. package/definitions/metering.json +0 -3132
  70. package/definitions/notes-runtime.json +0 -1
  71. package/definitions/notes.json +0 -1698
  72. package/definitions/notification-runtime.json +0 -1
  73. package/definitions/notification.json +0 -1439
  74. package/definitions/organization-runtime.json +0 -1
  75. package/definitions/organization.json +0 -1192
  76. package/definitions/partner-directory-runtime.json +0 -1
  77. package/definitions/partner-directory.json +0 -2284
  78. package/definitions/permissions-runtime.json +0 -1
  79. package/definitions/permissions.json +0 -1598
  80. package/definitions/pricing-runtime.json +0 -1
  81. package/definitions/pricing-tier-runtime.json +0 -1
  82. package/definitions/pricing-tier.json +0 -105
  83. package/definitions/pricing.json +0 -11569
  84. package/definitions/purpose-runtime.json +0 -1
  85. package/definitions/purpose.json +0 -524
  86. package/definitions/query-runtime.json +0 -1
  87. package/definitions/query.json +0 -3178
  88. package/definitions/sandbox-runtime.json +0 -1
  89. package/definitions/sandbox.json +0 -453
  90. package/definitions/sharing-runtime.json +0 -1
  91. package/definitions/sharing.json +0 -956
  92. package/definitions/snapshot-runtime.json +0 -1
  93. package/definitions/snapshot.json +0 -1103
  94. package/definitions/submission-runtime.json +0 -1
  95. package/definitions/submission.json +0 -313
  96. package/definitions/targeting-runtime.json +0 -1
  97. package/definitions/targeting.json +0 -2212
  98. package/definitions/template-variables-runtime.json +0 -1
  99. package/definitions/template-variables.json +0 -1416
  100. package/definitions/user-runtime.json +0 -1
  101. package/definitions/user.json +0 -3051
  102. package/definitions/validation-rules-runtime.json +0 -1
  103. package/definitions/validation-rules.json +0 -2365
  104. package/definitions/webhooks-runtime.json +0 -1
  105. package/definitions/webhooks.json +0 -1875
  106. package/definitions/workflow-definition-runtime.json +0 -1
  107. package/definitions/workflow-definition.json +0 -3592
  108. package/definitions/workflow-runtime.json +0 -1
  109. package/definitions/workflow.json +0 -4669
@@ -1,1439 +0,0 @@
1
- {
2
- "openapi": "3.0.3",
3
- "info": {
4
- "title": "Notification API",
5
- "version": "1.7.0",
6
- "description": "Notification API for epilot 360"
7
- },
8
- "security": [
9
- {
10
- "EpilotAuth": []
11
- },
12
- {
13
- "EpilotOrg": []
14
- }
15
- ],
16
- "tags": [
17
- {
18
- "name": "Notification",
19
- "description": "Notification"
20
- },
21
- {
22
- "name": "Template",
23
- "description": "Notification Template"
24
- }
25
- ],
26
- "paths": {
27
- "/v2/notification/notifications": {
28
- "get": {
29
- "operationId": "getNotificationsV2",
30
- "summary": "getNotificationsV2",
31
- "description": "Get notifications items. These items may eventually contain entities within their payload, which can be hydrated by the client if desired by calling the Entity API directly.",
32
- "tags": [
33
- "Notification"
34
- ],
35
- "parameters": [
36
- {
37
- "in": "query",
38
- "name": "cursor",
39
- "schema": {
40
- "type": "string"
41
- },
42
- "required": false,
43
- "description": "Base64 encoded cursor to be used for pagination"
44
- },
45
- {
46
- "in": "query",
47
- "name": "after_id",
48
- "schema": {
49
- "type": "integer"
50
- }
51
- },
52
- {
53
- "in": "query",
54
- "name": "limit",
55
- "schema": {
56
- "type": "integer"
57
- },
58
- "description": "The numbers of items to return"
59
- }
60
- ],
61
- "responses": {
62
- "200": {
63
- "description": "Success",
64
- "content": {
65
- "application/json": {
66
- "schema": {
67
- "type": "object",
68
- "properties": {
69
- "cursor": {
70
- "type": "string",
71
- "example": "eyJjcmVhd",
72
- "description": "Base64 encoded cursor to be used for pagination"
73
- },
74
- "total": {
75
- "type": "integer",
76
- "example": 1
77
- },
78
- "total_unread": {
79
- "type": "integer",
80
- "example": 1
81
- },
82
- "results": {
83
- "type": "array",
84
- "items": {
85
- "$ref": "#/components/schemas/NotificationItem"
86
- }
87
- }
88
- }
89
- }
90
- }
91
- }
92
- }
93
- }
94
- }
95
- },
96
- "/v1/notification/notifications": {
97
- "post": {
98
- "operationId": "createNotification",
99
- "summary": "createNotification",
100
- "description": "Create a message that can be displayed in the notification panel.",
101
- "tags": [
102
- "Notification"
103
- ],
104
- "requestBody": {
105
- "content": {
106
- "application/json": {
107
- "schema": {
108
- "$ref": "#/components/schemas/Notification"
109
- }
110
- }
111
- }
112
- },
113
- "responses": {
114
- "202": {
115
- "description": "Success"
116
- }
117
- }
118
- },
119
- "get": {
120
- "operationId": "getNotifications",
121
- "summary": "getNotifications",
122
- "description": "Get notifications",
123
- "tags": [
124
- "Notification"
125
- ],
126
- "parameters": [
127
- {
128
- "in": "query",
129
- "name": "after_id",
130
- "schema": {
131
- "type": "integer"
132
- }
133
- },
134
- {
135
- "in": "query",
136
- "name": "limit",
137
- "schema": {
138
- "type": "integer"
139
- },
140
- "description": "The numbers of items to return"
141
- },
142
- {
143
- "in": "query",
144
- "name": "no_hydrate",
145
- "schema": {
146
- "type": "boolean"
147
- },
148
- "description": "When true, the payload will not be hydrated with the entity data. This is useful when the client does not need the entity data and wants to save on API calls (performance gain). When false, the payload will be hydrated with the entity data. This is useful when the client needs the entity data to display the notification (e.g. to show the name of the contact in the notification message), but can have a significative performance impact.\n\nThis endpoint will eventually be deprecated in favor of GET /v2/notification/notifications which no longer hydrates the payload by default.\n"
149
- }
150
- ],
151
- "responses": {
152
- "200": {
153
- "description": "Success",
154
- "content": {
155
- "application/json": {
156
- "schema": {
157
- "type": "object",
158
- "properties": {
159
- "total": {
160
- "type": "integer",
161
- "example": 1
162
- },
163
- "total_unread": {
164
- "type": "integer",
165
- "example": 1
166
- },
167
- "results": {
168
- "type": "array",
169
- "items": {
170
- "$ref": "#/components/schemas/NotificationItem"
171
- }
172
- }
173
- }
174
- }
175
- }
176
- }
177
- }
178
- }
179
- }
180
- },
181
- "/v1/notification/notifications/{id}": {
182
- "get": {
183
- "operationId": "getNotification",
184
- "summary": "getNotification",
185
- "description": "Get the details of a single notification.",
186
- "tags": [
187
- "Notification"
188
- ],
189
- "parameters": [
190
- {
191
- "in": "path",
192
- "name": "id",
193
- "description": "Notification Id",
194
- "required": true,
195
- "schema": {
196
- "type": "number"
197
- }
198
- }
199
- ],
200
- "responses": {
201
- "200": {
202
- "description": "Success",
203
- "content": {
204
- "application/json": {
205
- "schema": {
206
- "$ref": "#/components/schemas/NotificationItem"
207
- }
208
- }
209
- }
210
- }
211
- }
212
- }
213
- },
214
- "/v1/notification/notifications/mark": {
215
- "put": {
216
- "operationId": "markAllAsRead",
217
- "summary": "markAllAsRead",
218
- "description": "Mark all as read",
219
- "tags": [
220
- "Notification"
221
- ],
222
- "responses": {
223
- "204": {
224
- "description": "ok"
225
- }
226
- }
227
- }
228
- },
229
- "/v1/notification/notifications/{id}/mark": {
230
- "put": {
231
- "operationId": "markAsRead",
232
- "summary": "markAsRead",
233
- "description": "Mark as read",
234
- "parameters": [
235
- {
236
- "in": "path",
237
- "name": "id",
238
- "schema": {
239
- "type": "integer"
240
- },
241
- "required": true,
242
- "description": "Numeric ID of the notification to mark as read"
243
- }
244
- ],
245
- "tags": [
246
- "Notification"
247
- ],
248
- "responses": {
249
- "204": {
250
- "description": "Success"
251
- }
252
- }
253
- }
254
- },
255
- "/v1/notification/unreads": {
256
- "get": {
257
- "operationId": "getTotalUnread",
258
- "summary": "getTotalUnread",
259
- "description": "Get total unread",
260
- "tags": [
261
- "Notification"
262
- ],
263
- "responses": {
264
- "200": {
265
- "description": "Success",
266
- "content": {
267
- "text/plain": {
268
- "schema": {
269
- "type": "number",
270
- "example": 999
271
- }
272
- }
273
- }
274
- }
275
- }
276
- }
277
- },
278
- "/v1/notification/templates": {
279
- "get": {
280
- "operationId": "listNotificationTemplates",
281
- "summary": "listNotificationTemplates",
282
- "description": "List notification templates with optional filtering and pagination",
283
- "tags": [
284
- "Template"
285
- ],
286
- "parameters": [
287
- {
288
- "name": "q",
289
- "in": "query",
290
- "required": false,
291
- "description": "Lucene query string for filtering",
292
- "schema": {
293
- "type": "string"
294
- }
295
- },
296
- {
297
- "name": "from",
298
- "in": "query",
299
- "required": false,
300
- "description": "Pagination offset (0-based)",
301
- "schema": {
302
- "type": "integer",
303
- "minimum": 0,
304
- "default": 0
305
- }
306
- },
307
- {
308
- "name": "size",
309
- "in": "query",
310
- "required": false,
311
- "description": "Results per page",
312
- "schema": {
313
- "type": "integer",
314
- "minimum": 1,
315
- "maximum": 1000,
316
- "default": 25
317
- }
318
- },
319
- {
320
- "name": "sort",
321
- "in": "query",
322
- "required": false,
323
- "description": "Sort fields (prefix with - for descending)",
324
- "schema": {
325
- "type": "string"
326
- }
327
- },
328
- {
329
- "name": "fields",
330
- "in": "query",
331
- "required": false,
332
- "description": "Comma-separated fields to include",
333
- "schema": {
334
- "type": "string"
335
- }
336
- },
337
- {
338
- "name": "hydrate",
339
- "in": "query",
340
- "required": false,
341
- "description": "Resolve nested relations",
342
- "schema": {
343
- "type": "boolean",
344
- "default": false
345
- }
346
- }
347
- ],
348
- "responses": {
349
- "200": {
350
- "description": "Success",
351
- "content": {
352
- "application/json": {
353
- "schema": {
354
- "$ref": "#/components/schemas/NotificationTemplateListResponse"
355
- }
356
- }
357
- }
358
- },
359
- "401": {
360
- "description": "Unauthorized",
361
- "content": {
362
- "application/json": {
363
- "schema": {
364
- "$ref": "#/components/schemas/Error"
365
- }
366
- }
367
- }
368
- },
369
- "500": {
370
- "description": "Internal Server Error",
371
- "content": {
372
- "application/json": {
373
- "schema": {
374
- "$ref": "#/components/schemas/Error"
375
- }
376
- }
377
- }
378
- }
379
- }
380
- },
381
- "post": {
382
- "operationId": "createNotificationTemplate",
383
- "summary": "createNotificationTemplate",
384
- "description": "Create a new notification template",
385
- "tags": [
386
- "Template"
387
- ],
388
- "requestBody": {
389
- "required": true,
390
- "content": {
391
- "application/json": {
392
- "schema": {
393
- "$ref": "#/components/schemas/CreateNotificationTemplateInput"
394
- }
395
- }
396
- }
397
- },
398
- "responses": {
399
- "201": {
400
- "description": "Created",
401
- "content": {
402
- "application/json": {
403
- "schema": {
404
- "$ref": "#/components/schemas/NotificationTemplate"
405
- }
406
- }
407
- }
408
- },
409
- "400": {
410
- "description": "Bad Request",
411
- "content": {
412
- "application/json": {
413
- "schema": {
414
- "$ref": "#/components/schemas/Error"
415
- }
416
- }
417
- }
418
- },
419
- "401": {
420
- "description": "Unauthorized",
421
- "content": {
422
- "application/json": {
423
- "schema": {
424
- "$ref": "#/components/schemas/Error"
425
- }
426
- }
427
- }
428
- },
429
- "500": {
430
- "description": "Internal Server Error",
431
- "content": {
432
- "application/json": {
433
- "schema": {
434
- "$ref": "#/components/schemas/Error"
435
- }
436
- }
437
- }
438
- }
439
- }
440
- }
441
- },
442
- "/v1/notification/templates/{id}": {
443
- "get": {
444
- "operationId": "getNotificationTemplate",
445
- "summary": "getNotificationTemplate",
446
- "description": "Get a single notification template by ID",
447
- "tags": [
448
- "Template"
449
- ],
450
- "parameters": [
451
- {
452
- "$ref": "#/components/parameters/TemplateIdPathParam"
453
- }
454
- ],
455
- "responses": {
456
- "200": {
457
- "description": "Success",
458
- "content": {
459
- "application/json": {
460
- "schema": {
461
- "$ref": "#/components/schemas/NotificationTemplate"
462
- }
463
- }
464
- }
465
- },
466
- "401": {
467
- "description": "Unauthorized",
468
- "content": {
469
- "application/json": {
470
- "schema": {
471
- "$ref": "#/components/schemas/Error"
472
- }
473
- }
474
- }
475
- },
476
- "404": {
477
- "description": "Not Found",
478
- "content": {
479
- "application/json": {
480
- "schema": {
481
- "$ref": "#/components/schemas/Error"
482
- }
483
- }
484
- }
485
- },
486
- "500": {
487
- "description": "Internal Server Error",
488
- "content": {
489
- "application/json": {
490
- "schema": {
491
- "$ref": "#/components/schemas/Error"
492
- }
493
- }
494
- }
495
- }
496
- }
497
- },
498
- "put": {
499
- "operationId": "updateNotificationTemplate",
500
- "summary": "updateNotificationTemplate",
501
- "description": "Update a notification template (full replacement)",
502
- "tags": [
503
- "Template"
504
- ],
505
- "parameters": [
506
- {
507
- "$ref": "#/components/parameters/TemplateIdPathParam"
508
- }
509
- ],
510
- "requestBody": {
511
- "required": true,
512
- "content": {
513
- "application/json": {
514
- "schema": {
515
- "$ref": "#/components/schemas/UpdateNotificationTemplateInput"
516
- }
517
- }
518
- }
519
- },
520
- "responses": {
521
- "200": {
522
- "description": "Success",
523
- "content": {
524
- "application/json": {
525
- "schema": {
526
- "$ref": "#/components/schemas/NotificationTemplate"
527
- }
528
- }
529
- }
530
- },
531
- "400": {
532
- "description": "Bad Request",
533
- "content": {
534
- "application/json": {
535
- "schema": {
536
- "$ref": "#/components/schemas/Error"
537
- }
538
- }
539
- }
540
- },
541
- "401": {
542
- "description": "Unauthorized",
543
- "content": {
544
- "application/json": {
545
- "schema": {
546
- "$ref": "#/components/schemas/Error"
547
- }
548
- }
549
- }
550
- },
551
- "404": {
552
- "description": "Not Found",
553
- "content": {
554
- "application/json": {
555
- "schema": {
556
- "$ref": "#/components/schemas/Error"
557
- }
558
- }
559
- }
560
- },
561
- "500": {
562
- "description": "Internal Server Error",
563
- "content": {
564
- "application/json": {
565
- "schema": {
566
- "$ref": "#/components/schemas/Error"
567
- }
568
- }
569
- }
570
- }
571
- }
572
- },
573
- "patch": {
574
- "operationId": "patchNotificationTemplate",
575
- "summary": "patchNotificationTemplate",
576
- "description": "Partially update a notification template",
577
- "tags": [
578
- "Template"
579
- ],
580
- "parameters": [
581
- {
582
- "$ref": "#/components/parameters/TemplateIdPathParam"
583
- }
584
- ],
585
- "requestBody": {
586
- "required": true,
587
- "content": {
588
- "application/json": {
589
- "schema": {
590
- "$ref": "#/components/schemas/UpdateNotificationTemplateInput"
591
- }
592
- }
593
- }
594
- },
595
- "responses": {
596
- "200": {
597
- "description": "Success",
598
- "content": {
599
- "application/json": {
600
- "schema": {
601
- "$ref": "#/components/schemas/NotificationTemplate"
602
- }
603
- }
604
- }
605
- },
606
- "400": {
607
- "description": "Bad Request",
608
- "content": {
609
- "application/json": {
610
- "schema": {
611
- "$ref": "#/components/schemas/Error"
612
- }
613
- }
614
- }
615
- },
616
- "401": {
617
- "description": "Unauthorized",
618
- "content": {
619
- "application/json": {
620
- "schema": {
621
- "$ref": "#/components/schemas/Error"
622
- }
623
- }
624
- }
625
- },
626
- "404": {
627
- "description": "Not Found",
628
- "content": {
629
- "application/json": {
630
- "schema": {
631
- "$ref": "#/components/schemas/Error"
632
- }
633
- }
634
- }
635
- },
636
- "500": {
637
- "description": "Internal Server Error",
638
- "content": {
639
- "application/json": {
640
- "schema": {
641
- "$ref": "#/components/schemas/Error"
642
- }
643
- }
644
- }
645
- }
646
- }
647
- },
648
- "delete": {
649
- "operationId": "deleteNotificationTemplate",
650
- "summary": "deleteNotificationTemplate",
651
- "description": "Delete a notification template permanently",
652
- "tags": [
653
- "Template"
654
- ],
655
- "parameters": [
656
- {
657
- "$ref": "#/components/parameters/TemplateIdPathParam"
658
- }
659
- ],
660
- "responses": {
661
- "200": {
662
- "description": "Success",
663
- "content": {
664
- "application/json": {
665
- "schema": {
666
- "$ref": "#/components/schemas/NotificationTemplate"
667
- }
668
- }
669
- }
670
- },
671
- "401": {
672
- "description": "Unauthorized",
673
- "content": {
674
- "application/json": {
675
- "schema": {
676
- "$ref": "#/components/schemas/Error"
677
- }
678
- }
679
- }
680
- },
681
- "404": {
682
- "description": "Not Found",
683
- "content": {
684
- "application/json": {
685
- "schema": {
686
- "$ref": "#/components/schemas/Error"
687
- }
688
- }
689
- }
690
- },
691
- "500": {
692
- "description": "Internal Server Error",
693
- "content": {
694
- "application/json": {
695
- "schema": {
696
- "$ref": "#/components/schemas/Error"
697
- }
698
- }
699
- }
700
- }
701
- }
702
- }
703
- },
704
- "/v1/notification/templates/send-preview": {
705
- "post": {
706
- "operationId": "sendPreview",
707
- "summary": "sendPreview",
708
- "description": "Send a preview notification (both email and in-app) to the requesting user.\nUsed to test notification templates before saving.\n",
709
- "tags": [
710
- "Template"
711
- ],
712
- "requestBody": {
713
- "required": true,
714
- "content": {
715
- "application/json": {
716
- "schema": {
717
- "$ref": "#/components/schemas/SendPreviewInput"
718
- }
719
- }
720
- }
721
- },
722
- "responses": {
723
- "200": {
724
- "description": "Preview notification sent successfully",
725
- "content": {
726
- "application/json": {
727
- "schema": {
728
- "$ref": "#/components/schemas/SendPreviewResponse"
729
- }
730
- }
731
- }
732
- },
733
- "400": {
734
- "description": "Bad Request",
735
- "content": {
736
- "application/json": {
737
- "schema": {
738
- "$ref": "#/components/schemas/Error"
739
- }
740
- }
741
- }
742
- },
743
- "401": {
744
- "description": "Unauthorized",
745
- "content": {
746
- "application/json": {
747
- "schema": {
748
- "$ref": "#/components/schemas/Error"
749
- }
750
- }
751
- }
752
- },
753
- "500": {
754
- "description": "Internal Server Error",
755
- "content": {
756
- "application/json": {
757
- "schema": {
758
- "$ref": "#/components/schemas/Error"
759
- }
760
- }
761
- }
762
- }
763
- }
764
- }
765
- }
766
- },
767
- "components": {
768
- "securitySchemes": {
769
- "EpilotAuth": {
770
- "type": "http",
771
- "scheme": "bearer",
772
- "description": "Authorization header with epilot OAuth2 bearer token",
773
- "bearerFormat": "JWT"
774
- },
775
- "EpilotOrg": {
776
- "description": "Overrides the target organization to allow shared tenant access",
777
- "name": "x-epilot-org-id",
778
- "in": "header",
779
- "type": "apiKey"
780
- }
781
- },
782
- "parameters": {
783
- "TemplateIdPathParam": {
784
- "name": "id",
785
- "in": "path",
786
- "required": true,
787
- "description": "Template ID (UUID)",
788
- "schema": {
789
- "type": "string",
790
- "format": "uuid"
791
- }
792
- }
793
- },
794
- "schemas": {
795
- "Error": {
796
- "type": "object",
797
- "properties": {
798
- "message": {
799
- "type": "string",
800
- "description": "Error message"
801
- },
802
- "code": {
803
- "type": "string",
804
- "description": "Error code"
805
- }
806
- },
807
- "required": [
808
- "message"
809
- ]
810
- },
811
- "EntityOperation": {
812
- "type": "object",
813
- "properties": {
814
- "entity": {
815
- "$ref": "#/components/schemas/EntityId"
816
- },
817
- "operation": {
818
- "type": "string",
819
- "example": "updateEntity"
820
- },
821
- "params": {
822
- "type": "object",
823
- "properties": {
824
- "id": {
825
- "$ref": "#/components/schemas/EntityId"
826
- },
827
- "slug": {
828
- "$ref": "#/components/schemas/EntitySlug"
829
- }
830
- },
831
- "example": {
832
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
833
- "slug": "contact"
834
- }
835
- },
836
- "payload": {
837
- "allOf": [
838
- {
839
- "$ref": "#/components/schemas/Entity"
840
- },
841
- {
842
- "example": {
843
- "_schema": "contact",
844
- "_org": "123",
845
- "status": "Inactive"
846
- }
847
- }
848
- ]
849
- }
850
- },
851
- "required": [
852
- "entity",
853
- "name"
854
- ]
855
- },
856
- "NotificationItem": {
857
- "allOf": [
858
- {
859
- "type": "object",
860
- "properties": {
861
- "id": {
862
- "$ref": "#/components/schemas/Id"
863
- },
864
- "notification_id": {
865
- "$ref": "#/components/schemas/NotificationId"
866
- },
867
- "timestamp": {
868
- "type": "string",
869
- "format": "date-time"
870
- },
871
- "read_state": {
872
- "type": "boolean",
873
- "example": false
874
- }
875
- }
876
- },
877
- {
878
- "$ref": "#/components/schemas/NotificationBase"
879
- },
880
- {
881
- "type": "object",
882
- "properties": {
883
- "caller": {
884
- "$ref": "#/components/schemas/NotificationCallerContext"
885
- }
886
- }
887
- },
888
- {
889
- "type": "object",
890
- "properties": {
891
- "operations": {
892
- "type": "array",
893
- "items": {
894
- "$ref": "#/components/schemas/EntityOperation"
895
- }
896
- }
897
- }
898
- }
899
- ]
900
- },
901
- "Notification": {
902
- "allOf": [
903
- {
904
- "$ref": "#/components/schemas/NotificationBase"
905
- },
906
- {
907
- "type": "object",
908
- "properties": {
909
- "read_state": {
910
- "type": "boolean",
911
- "example": false
912
- },
913
- "visibility_user_ids": {
914
- "description": "The person who is the corresponding event recipient.",
915
- "type": "array",
916
- "items": {
917
- "type": "string"
918
- },
919
- "example": [
920
- "1",
921
- "2",
922
- "3",
923
- "4",
924
- "5"
925
- ]
926
- }
927
- }
928
- }
929
- ]
930
- },
931
- "NotificationBase": {
932
- "type": "object",
933
- "properties": {
934
- "notification_id": {
935
- "type": "number"
936
- },
937
- "timestamp": {
938
- "type": "string",
939
- "format": "date-time"
940
- },
941
- "type": {
942
- "description": "Type of notification",
943
- "type": "string",
944
- "example": "workflow"
945
- },
946
- "redirect_url": {
947
- "description": "Redirect url",
948
- "type": "string",
949
- "example": "https://epilot.cloud"
950
- },
951
- "organization_id": {
952
- "description": "Organization Id",
953
- "type": "string",
954
- "example": "206801"
955
- },
956
- "title": {
957
- "type": "object",
958
- "properties": {
959
- "en": {
960
- "type": "string",
961
- "description": "Title for notification. Supports handlebars syntax.",
962
- "example": "My custom notification"
963
- },
964
- "de": {
965
- "type": "string",
966
- "description": "Title for notification. Supports handlebars syntax.",
967
- "example": "Meine benutzerdefinierte Aktivität"
968
- }
969
- }
970
- },
971
- "message": {
972
- "type": "object",
973
- "properties": {
974
- "en": {
975
- "type": "string",
976
- "description": "Message for notification. Supports handlebars syntax.",
977
- "example": "{{caller}} did something with {{contact.entity.id}} {{branch.name}}."
978
- },
979
- "de": {
980
- "type": "string",
981
- "description": "Message for notification. Supports handlebars syntax.",
982
- "example": "{{caller}} habe etwas damit gemacht {{contact.entity.id}} {{branch.name}}."
983
- }
984
- }
985
- },
986
- "payload": {
987
- "type": "object",
988
- "properties": {},
989
- "additionalProperties": true,
990
- "example": {
991
- "entity": {
992
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
993
- "schema": "contact"
994
- }
995
- }
996
- },
997
- "caller": {
998
- "$ref": "#/components/schemas/NotificationCallerContext"
999
- },
1000
- "operations": {
1001
- "type": "array",
1002
- "items": {
1003
- "$ref": "#/components/schemas/EntityOperation"
1004
- }
1005
- },
1006
- "force_notify_users": {
1007
- "type": "object",
1008
- "properties": {},
1009
- "additionalProperties": true,
1010
- "example": {
1011
- "12345": {
1012
- "email": false,
1013
- "in_app": false
1014
- }
1015
- }
1016
- },
1017
- "allowed_channels": {
1018
- "description": "Optional delivery-channel ceiling. When present, delivery is restricted to the intersection of this set and each recipient's own notification preferences — it can only NARROW delivery, never force a channel on. Absent means no restriction (recipient preferences and per-type defaults apply as before). An empty array suppresses all channels.",
1019
- "type": "array",
1020
- "items": {
1021
- "type": "string",
1022
- "enum": [
1023
- "email",
1024
- "in_app"
1025
- ]
1026
- },
1027
- "example": [
1028
- "in_app"
1029
- ]
1030
- }
1031
- },
1032
- "required": [
1033
- "type",
1034
- "title",
1035
- "message"
1036
- ]
1037
- },
1038
- "EntityId": {
1039
- "type": "string",
1040
- "format": "uuid"
1041
- },
1042
- "Entity": {
1043
- "type": "object",
1044
- "properties": {},
1045
- "additionalProperties": true
1046
- },
1047
- "Id": {
1048
- "type": "number",
1049
- "example": 123456789
1050
- },
1051
- "NotificationId": {
1052
- "type": "number",
1053
- "example": 123456789
1054
- },
1055
- "NotificationCallerContext": {
1056
- "type": "object",
1057
- "additionalProperties": true,
1058
- "properties": {
1059
- "EpilotAuth": {
1060
- "type": "object",
1061
- "properties": {
1062
- "token": {
1063
- "type": "object",
1064
- "properties": {
1065
- "sub": {
1066
- "type": "string",
1067
- "example": "476e9b48-42f4-4234-a2b0-4668b34626ce"
1068
- },
1069
- "email": {
1070
- "type": "string",
1071
- "example": "example@epilot.cloud"
1072
- },
1073
- "cognito:username": {
1074
- "type": "string",
1075
- "example": "example@epilot.cloud"
1076
- },
1077
- "custom:ivy_user_id": {
1078
- "type": "string",
1079
- "example": "10006129"
1080
- }
1081
- },
1082
- "example": {
1083
- "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",
1084
- "cognito:groups": [
1085
- "Administrator"
1086
- ],
1087
- "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",
1088
- "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",
1089
- "custom:ivy_org_id": "739224",
1090
- "cognito:username": "n.ahmad@epilot.cloud",
1091
- "custom:ivy_user_id": "10006129",
1092
- "cognito:roles": [
1093
- "arn:aws:iam::912468240823:role/base-administrator-role"
1094
- ],
1095
- "aud": "6e0jbdnger7nmoktaaflarue1l",
1096
- "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",
1097
- "token_use": "id",
1098
- "auth_time": 1614333023,
1099
- "exp": 1614336623,
1100
- "iat": 1614333023,
1101
- "email": "n.ahmad@epilot.cloud"
1102
- }
1103
- }
1104
- }
1105
- }
1106
- }
1107
- },
1108
- "EntitySlug": {
1109
- "description": "URL-friendly identifier for the entity schema",
1110
- "type": "string",
1111
- "example": "contact"
1112
- },
1113
- "EntityOwner": {
1114
- "type": "object",
1115
- "required": [
1116
- "org_id",
1117
- "user_id"
1118
- ],
1119
- "properties": {
1120
- "org_id": {
1121
- "type": "string",
1122
- "description": "Organization ID"
1123
- },
1124
- "user_id": {
1125
- "type": "string",
1126
- "description": "User ID"
1127
- }
1128
- }
1129
- },
1130
- "EntityAcl": {
1131
- "type": "object",
1132
- "description": "Access control list",
1133
- "properties": {
1134
- "view": {
1135
- "type": "array",
1136
- "items": {
1137
- "type": "string"
1138
- }
1139
- },
1140
- "edit": {
1141
- "type": "array",
1142
- "items": {
1143
- "type": "string"
1144
- }
1145
- },
1146
- "delete": {
1147
- "type": "array",
1148
- "items": {
1149
- "type": "string"
1150
- }
1151
- }
1152
- }
1153
- },
1154
- "NotificationTemplate": {
1155
- "type": "object",
1156
- "required": [
1157
- "_id",
1158
- "_org",
1159
- "_schema",
1160
- "_title",
1161
- "_created_at",
1162
- "_updated_at"
1163
- ],
1164
- "properties": {
1165
- "_id": {
1166
- "type": "string",
1167
- "format": "uuid",
1168
- "description": "Unique identifier"
1169
- },
1170
- "_schema": {
1171
- "type": "string",
1172
- "description": "Entity schema type"
1173
- },
1174
- "_title": {
1175
- "type": "string",
1176
- "nullable": true,
1177
- "description": "Display title"
1178
- },
1179
- "_org": {
1180
- "type": "string",
1181
- "description": "Organization ID"
1182
- },
1183
- "_tags": {
1184
- "type": "array",
1185
- "items": {
1186
- "type": "string"
1187
- },
1188
- "nullable": true,
1189
- "description": "Tags for categorization"
1190
- },
1191
- "_created_at": {
1192
- "type": "string",
1193
- "format": "date-time",
1194
- "nullable": true,
1195
- "description": "ISO timestamp of creation"
1196
- },
1197
- "_updated_at": {
1198
- "type": "string",
1199
- "format": "date-time",
1200
- "nullable": true,
1201
- "description": "ISO timestamp of last update"
1202
- },
1203
- "_manifest": {
1204
- "type": "array",
1205
- "description": "Manifest ID used to create/update the entity",
1206
- "items": {
1207
- "type": "string",
1208
- "format": "uuid",
1209
- "example": "123e4567-e89b-12d3-a456-426614174000"
1210
- }
1211
- },
1212
- "_owners": {
1213
- "type": "array",
1214
- "items": {
1215
- "$ref": "#/components/schemas/EntityOwner"
1216
- },
1217
- "description": "Entity owners",
1218
- "readOnly": true
1219
- },
1220
- "_acl": {
1221
- "allOf": [
1222
- {
1223
- "$ref": "#/components/schemas/EntityAcl"
1224
- }
1225
- ],
1226
- "description": "Access control list",
1227
- "readOnly": true
1228
- },
1229
- "name": {
1230
- "type": "string",
1231
- "description": "Internal template name"
1232
- },
1233
- "type": {
1234
- "type": "string",
1235
- "description": "Notification type key"
1236
- },
1237
- "notification_title": {
1238
- "type": "string",
1239
- "description": "Notification title (Lexical editor JSON, supports variables)"
1240
- },
1241
- "message": {
1242
- "type": "string",
1243
- "description": "Notification body (Lexical editor JSON, supports variables)"
1244
- },
1245
- "action_label": {
1246
- "type": "string",
1247
- "description": "CTA button text (supports variables)"
1248
- },
1249
- "action_url": {
1250
- "type": "string",
1251
- "description": "CTA button URL (supports variables)"
1252
- },
1253
- "style": {
1254
- "type": "string",
1255
- "description": "JSON string with style config"
1256
- },
1257
- "system_template": {
1258
- "type": "boolean",
1259
- "description": "Whether this is a system template",
1260
- "readOnly": true
1261
- },
1262
- "created_by": {
1263
- "type": "string",
1264
- "description": "User ID who created the template",
1265
- "readOnly": true
1266
- },
1267
- "updated_by": {
1268
- "type": "string",
1269
- "description": "User ID who last updated the template",
1270
- "readOnly": true
1271
- }
1272
- }
1273
- },
1274
- "CreateNotificationTemplateInput": {
1275
- "type": "object",
1276
- "required": [
1277
- "name",
1278
- "type"
1279
- ],
1280
- "properties": {
1281
- "name": {
1282
- "type": "string",
1283
- "description": "Internal template name (required)"
1284
- },
1285
- "type": {
1286
- "type": "string",
1287
- "description": "Notification type key (required)"
1288
- },
1289
- "notification_title": {
1290
- "type": "string",
1291
- "description": "Notification title (Lexical editor JSON, supports variables)"
1292
- },
1293
- "message": {
1294
- "type": "string",
1295
- "description": "Notification body (Lexical editor JSON, supports variables)"
1296
- },
1297
- "action_label": {
1298
- "type": "string",
1299
- "description": "CTA button text (supports variables)"
1300
- },
1301
- "action_url": {
1302
- "type": "string",
1303
- "description": "CTA button URL (supports variables)"
1304
- },
1305
- "style": {
1306
- "type": "string",
1307
- "description": "JSON string with style config"
1308
- },
1309
- "_title": {
1310
- "type": "string",
1311
- "description": "Display title"
1312
- },
1313
- "_tags": {
1314
- "type": "array",
1315
- "items": {
1316
- "type": "string"
1317
- },
1318
- "description": "Tags for categorization"
1319
- },
1320
- "_manifest": {
1321
- "type": "array",
1322
- "description": "Manifest ID used to create/update the entity",
1323
- "items": {
1324
- "type": "string",
1325
- "format": "uuid",
1326
- "example": "123e4567-e89b-12d3-a456-426614174000"
1327
- }
1328
- }
1329
- }
1330
- },
1331
- "UpdateNotificationTemplateInput": {
1332
- "type": "object",
1333
- "properties": {
1334
- "name": {
1335
- "type": "string",
1336
- "description": "Internal template name"
1337
- },
1338
- "notification_title": {
1339
- "type": "string",
1340
- "description": "Notification title (Lexical editor JSON, supports variables)"
1341
- },
1342
- "message": {
1343
- "type": "string",
1344
- "description": "Notification body (Lexical editor JSON, supports variables)"
1345
- },
1346
- "action_label": {
1347
- "type": "string",
1348
- "description": "CTA button text (supports variables)"
1349
- },
1350
- "action_url": {
1351
- "type": "string",
1352
- "description": "CTA button URL (supports variables)"
1353
- },
1354
- "style": {
1355
- "type": "string",
1356
- "description": "JSON string with style config"
1357
- },
1358
- "_title": {
1359
- "type": "string",
1360
- "description": "Display title"
1361
- },
1362
- "_tags": {
1363
- "type": "array",
1364
- "items": {
1365
- "type": "string"
1366
- },
1367
- "description": "Tags for categorization"
1368
- },
1369
- "_manifest": {
1370
- "type": "array",
1371
- "description": "Manifest ID used to create/update the entity",
1372
- "items": {
1373
- "type": "string",
1374
- "format": "uuid",
1375
- "example": "123e4567-e89b-12d3-a456-426614174000"
1376
- }
1377
- }
1378
- }
1379
- },
1380
- "NotificationTemplateListResponse": {
1381
- "type": "object",
1382
- "properties": {
1383
- "results": {
1384
- "type": "array",
1385
- "items": {
1386
- "$ref": "#/components/schemas/NotificationTemplate"
1387
- }
1388
- },
1389
- "hits": {
1390
- "type": "integer",
1391
- "description": "Total number of matching results"
1392
- }
1393
- }
1394
- },
1395
- "SendPreviewInput": {
1396
- "type": "object",
1397
- "required": [
1398
- "template"
1399
- ],
1400
- "properties": {
1401
- "template": {
1402
- "$ref": "#/components/schemas/UpdateNotificationTemplateInput"
1403
- },
1404
- "context_ids": {
1405
- "type": "object",
1406
- "description": "Optional context IDs for variable replacement",
1407
- "additionalProperties": {
1408
- "type": "string"
1409
- }
1410
- }
1411
- }
1412
- },
1413
- "SendPreviewResponse": {
1414
- "type": "array",
1415
- "description": "Array of results for each notification channel (email, in-app)",
1416
- "items": {
1417
- "type": "object",
1418
- "required": [
1419
- "success"
1420
- ],
1421
- "properties": {
1422
- "success": {
1423
- "type": "boolean",
1424
- "description": "Whether this notification was sent successfully"
1425
- },
1426
- "data": {
1427
- "description": "Result data"
1428
- }
1429
- }
1430
- }
1431
- }
1432
- }
1433
- },
1434
- "servers": [
1435
- {
1436
- "url": "https://notification.sls.epilot.io"
1437
- }
1438
- ]
1439
- }