@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,1423 +0,0 @@
1
- {
2
- "openapi": "3.0.3",
3
- "info": {
4
- "title": "Design Builder API v2",
5
- "version": "0.0.1"
6
- },
7
- "tags": [
8
- {
9
- "name": "design-builder",
10
- "description": "Available design-builder over designs provided by Design Builder v2"
11
- }
12
- ],
13
- "servers": [
14
- {
15
- "url": "https://design-builder-api.epilot.io"
16
- }
17
- ],
18
- "security": [
19
- {
20
- "custom_authorizer": []
21
- }
22
- ],
23
- "paths": {
24
- "/v1/designs": {
25
- "get": {
26
- "operationId": "getAllDesigns",
27
- "summary": "getAllDesigns",
28
- "description": "Scan all designs linked to a organization, based in orgId attribute from JWT auth token",
29
- "tags": [
30
- "design-builder"
31
- ],
32
- "responses": {
33
- "200": {
34
- "description": "Success - designs loaded with success. Empty array if org has no designs.",
35
- "content": {
36
- "application/json": {
37
- "schema": {
38
- "type": "array",
39
- "items": {
40
- "$ref": "#/components/schemas/GetAllDesignsRes"
41
- }
42
- }
43
- }
44
- }
45
- },
46
- "500": {
47
- "description": "Other errors",
48
- "content": {
49
- "application/json": {
50
- "schema": {
51
- "$ref": "#/components/schemas/ErrorResp"
52
- }
53
- }
54
- }
55
- }
56
- }
57
- },
58
- "post": {
59
- "operationId": "addDesign",
60
- "summary": "addDesign",
61
- "description": "Create a brand new design linked to a organization, based in orgId attribute from JWT auth token",
62
- "tags": [
63
- "design-builder"
64
- ],
65
- "requestBody": {
66
- "description": "Design payload",
67
- "required": true,
68
- "content": {
69
- "application/json": {
70
- "schema": {
71
- "$ref": "#/components/schemas/AddDesignReq"
72
- }
73
- }
74
- }
75
- },
76
- "responses": {
77
- "201": {
78
- "description": "Success - design created with success.",
79
- "content": {
80
- "application/json": {
81
- "schema": {
82
- "$ref": "#/components/schemas/AddDesignRes"
83
- }
84
- }
85
- }
86
- },
87
- "400": {
88
- "description": "Validation Errors",
89
- "content": {
90
- "application/json": {
91
- "schema": {
92
- "$ref": "#/components/schemas/ErrorResp"
93
- }
94
- }
95
- }
96
- },
97
- "401": {
98
- "description": "Authentication Errors",
99
- "content": {
100
- "application/json": {
101
- "schema": {
102
- "$ref": "#/components/schemas/ErrorResp"
103
- }
104
- }
105
- }
106
- },
107
- "500": {
108
- "description": "Other errors",
109
- "content": {
110
- "application/json": {
111
- "schema": {
112
- "$ref": "#/components/schemas/ErrorResp"
113
- }
114
- }
115
- }
116
- }
117
- }
118
- }
119
- },
120
- "/v1/designs/{designId}": {
121
- "get": {
122
- "operationId": "getDesign",
123
- "summary": "getDesign",
124
- "description": "Search for a especific design owned by user organization",
125
- "tags": [
126
- "design-builder"
127
- ],
128
- "parameters": [
129
- {
130
- "in": "path",
131
- "name": "designId",
132
- "schema": {
133
- "type": "string"
134
- },
135
- "required": true,
136
- "description": "Id of the design",
137
- "example": "4a062990-a6a3-11eb-9828-4f3da7d4935a"
138
- }
139
- ],
140
- "responses": {
141
- "200": {
142
- "description": "Success - design loaded with success.",
143
- "content": {
144
- "application/json": {
145
- "schema": {
146
- "$ref": "#/components/schemas/GetDesignRes"
147
- }
148
- }
149
- }
150
- },
151
- "400": {
152
- "description": "Validation Errors",
153
- "content": {
154
- "application/json": {
155
- "schema": {
156
- "$ref": "#/components/schemas/ErrorResp"
157
- }
158
- }
159
- }
160
- },
161
- "401": {
162
- "description": "Authentication Errors",
163
- "content": {
164
- "application/json": {
165
- "schema": {
166
- "$ref": "#/components/schemas/ErrorResp"
167
- }
168
- }
169
- }
170
- },
171
- "404": {
172
- "description": "No design found"
173
- },
174
- "500": {
175
- "description": "Other errors",
176
- "content": {
177
- "application/json": {
178
- "schema": {
179
- "$ref": "#/components/schemas/ErrorResp"
180
- }
181
- }
182
- }
183
- }
184
- }
185
- },
186
- "delete": {
187
- "operationId": "deleteDesign",
188
- "summary": "deleteDesign",
189
- "description": "Search and delete for a especific design owned by user organization",
190
- "tags": [
191
- "design-builder"
192
- ],
193
- "parameters": [
194
- {
195
- "in": "path",
196
- "name": "designId",
197
- "schema": {
198
- "type": "string"
199
- },
200
- "required": true,
201
- "description": "Id of the design",
202
- "example": "4a062990-a6a3-11eb-9828-4f3da7d4935a"
203
- }
204
- ],
205
- "responses": {
206
- "204": {
207
- "description": "Success - design deleted with success."
208
- },
209
- "400": {
210
- "description": "Validation Errors",
211
- "content": {
212
- "application/json": {
213
- "schema": {
214
- "$ref": "#/components/schemas/ErrorResp"
215
- }
216
- }
217
- }
218
- },
219
- "401": {
220
- "description": "Authentication Errors",
221
- "content": {
222
- "application/json": {
223
- "schema": {
224
- "$ref": "#/components/schemas/ErrorResp"
225
- }
226
- }
227
- }
228
- },
229
- "404": {
230
- "description": "No design found"
231
- },
232
- "500": {
233
- "description": "Other errors",
234
- "content": {
235
- "application/json": {
236
- "schema": {
237
- "$ref": "#/components/schemas/ErrorResp"
238
- }
239
- }
240
- }
241
- }
242
- }
243
- },
244
- "put": {
245
- "operationId": "updateDesign",
246
- "summary": "updateDesign",
247
- "description": "Update a especific design owned by user organization",
248
- "tags": [
249
- "design-builder"
250
- ],
251
- "parameters": [
252
- {
253
- "in": "path",
254
- "name": "designId",
255
- "schema": {
256
- "type": "string"
257
- },
258
- "required": true,
259
- "description": "Id of the design",
260
- "example": "4a062990-a6a3-11eb-9828-4f3da7d4935a"
261
- }
262
- ],
263
- "requestBody": {
264
- "description": "Design payload",
265
- "required": true,
266
- "content": {
267
- "application/json": {
268
- "schema": {
269
- "$ref": "#/components/schemas/UpdateDesignReq"
270
- }
271
- }
272
- }
273
- },
274
- "responses": {
275
- "204": {
276
- "description": "Success - design updated with success."
277
- },
278
- "400": {
279
- "description": "Validation Errors",
280
- "content": {
281
- "application/json": {
282
- "schema": {
283
- "$ref": "#/components/schemas/ErrorResp"
284
- }
285
- }
286
- }
287
- },
288
- "401": {
289
- "description": "Authentication Errors",
290
- "content": {
291
- "application/json": {
292
- "schema": {
293
- "$ref": "#/components/schemas/ErrorResp"
294
- }
295
- }
296
- }
297
- },
298
- "404": {
299
- "description": "No design found"
300
- },
301
- "500": {
302
- "description": "Other errors",
303
- "content": {
304
- "application/json": {
305
- "schema": {
306
- "$ref": "#/components/schemas/ErrorResp"
307
- }
308
- }
309
- }
310
- }
311
- }
312
- }
313
- },
314
- "/v1/designs/{designId}/parse": {
315
- "get": {
316
- "operationId": "getThemeFromDesign",
317
- "summary": "getThemeFromDesign",
318
- "description": "Search for a especific design owned by user organization and parse them to a new or old theme",
319
- "security": [],
320
- "tags": [
321
- "design-builder"
322
- ],
323
- "parameters": [
324
- {
325
- "in": "path",
326
- "name": "designId",
327
- "schema": {
328
- "type": "string"
329
- },
330
- "required": true,
331
- "description": "Id of the design",
332
- "example": "4a062990-a6a3-11eb-9828-4f3da7d4935a"
333
- },
334
- {
335
- "in": "query",
336
- "name": "orgId",
337
- "schema": {
338
- "type": "string"
339
- },
340
- "description": "Organization id of the user"
341
- },
342
- {
343
- "in": "query",
344
- "name": "theme",
345
- "schema": {
346
- "type": "string",
347
- "enum": [
348
- "NEW",
349
- "OLD"
350
- ]
351
- },
352
- "required": true,
353
- "description": "Type of theme to be parsed and returned",
354
- "example": "NEW"
355
- }
356
- ],
357
- "responses": {
358
- "200": {
359
- "description": "Success - design parsed with success.",
360
- "content": {
361
- "application/json": {
362
- "schema": {
363
- "type": "object"
364
- }
365
- }
366
- }
367
- },
368
- "400": {
369
- "description": "Validation Errors",
370
- "content": {
371
- "application/json": {
372
- "schema": {
373
- "$ref": "#/components/schemas/ErrorResp"
374
- }
375
- }
376
- }
377
- },
378
- "401": {
379
- "description": "Authentication Errors",
380
- "content": {
381
- "application/json": {
382
- "schema": {
383
- "$ref": "#/components/schemas/ErrorResp"
384
- }
385
- }
386
- }
387
- },
388
- "404": {
389
- "description": "No design found"
390
- },
391
- "500": {
392
- "description": "Other errors",
393
- "content": {
394
- "application/json": {
395
- "schema": {
396
- "$ref": "#/components/schemas/ErrorResp"
397
- }
398
- }
399
- }
400
- }
401
- }
402
- }
403
- },
404
- "/v1/designs/files": {
405
- "post": {
406
- "operationId": "uploadFile",
407
- "summary": "uploadFile",
408
- "description": "Upload a new file for the user organization bucket",
409
- "tags": [
410
- "design-builder"
411
- ],
412
- "requestBody": {
413
- "description": "Upload file payload",
414
- "required": true,
415
- "content": {
416
- "multipart/form-data": {
417
- "schema": {
418
- "$ref": "#/components/schemas/UploadFileReq"
419
- },
420
- "encoding": {
421
- "file_data": {
422
- "contentType": "image/*, application/x-font-ttf, application/x-font-opentype, application/font-woff, application/font-woff2"
423
- }
424
- }
425
- }
426
- }
427
- },
428
- "responses": {
429
- "201": {
430
- "description": "Success - upload with success.",
431
- "content": {
432
- "application/json": {
433
- "schema": {
434
- "$ref": "#/components/schemas/UploadFileRes"
435
- }
436
- }
437
- }
438
- },
439
- "400": {
440
- "description": "Validation Errors",
441
- "content": {
442
- "application/json": {
443
- "schema": {
444
- "$ref": "#/components/schemas/ErrorResp"
445
- }
446
- }
447
- }
448
- },
449
- "401": {
450
- "description": "Authentication Errors",
451
- "content": {
452
- "application/json": {
453
- "schema": {
454
- "$ref": "#/components/schemas/ErrorResp"
455
- }
456
- }
457
- }
458
- },
459
- "500": {
460
- "description": "Other errors",
461
- "content": {
462
- "application/json": {
463
- "schema": {
464
- "$ref": "#/components/schemas/ErrorResp"
465
- }
466
- }
467
- }
468
- }
469
- }
470
- },
471
- "get": {
472
- "operationId": "getFiles",
473
- "summary": "getFiles",
474
- "description": "List all files for the user organization bucket",
475
- "tags": [
476
- "design-builder"
477
- ],
478
- "parameters": [
479
- {
480
- "in": "query",
481
- "name": "type",
482
- "schema": {
483
- "type": "string",
484
- "enum": [
485
- "LOGO",
486
- "FONT"
487
- ]
488
- },
489
- "required": false,
490
- "description": "Type of files to be returned",
491
- "example": "LOGO"
492
- }
493
- ],
494
- "responses": {
495
- "200": {
496
- "description": "Success - files loaded with success.",
497
- "content": {
498
- "application/json": {
499
- "schema": {
500
- "$ref": "#/components/schemas/GetFilesRes"
501
- }
502
- }
503
- }
504
- },
505
- "400": {
506
- "description": "Validation Errors",
507
- "content": {
508
- "application/json": {
509
- "schema": {
510
- "$ref": "#/components/schemas/ErrorResp"
511
- }
512
- }
513
- }
514
- },
515
- "401": {
516
- "description": "Authentication Errors",
517
- "content": {
518
- "application/json": {
519
- "schema": {
520
- "$ref": "#/components/schemas/ErrorResp"
521
- }
522
- }
523
- }
524
- },
525
- "500": {
526
- "description": "Other errors",
527
- "content": {
528
- "application/json": {
529
- "schema": {
530
- "$ref": "#/components/schemas/ErrorResp"
531
- }
532
- }
533
- }
534
- }
535
- }
536
- }
537
- },
538
- "/v1/designs/limit": {
539
- "get": {
540
- "deprecated": true,
541
- "operationId": "getLimit",
542
- "summary": "getLimit",
543
- "description": "Gets designs number limit from database per organization",
544
- "tags": [
545
- "design-builder"
546
- ],
547
- "responses": {
548
- "200": {
549
- "description": "Success - limit loaded with success.",
550
- "content": {
551
- "application/json": {
552
- "schema": {
553
- "type": "number"
554
- }
555
- }
556
- }
557
- },
558
- "500": {
559
- "description": "Other errors",
560
- "content": {
561
- "application/json": {
562
- "schema": {
563
- "$ref": "#/components/schemas/ErrorResp"
564
- }
565
- }
566
- }
567
- }
568
- }
569
- }
570
- },
571
- "/v1/brands": {
572
- "get": {
573
- "deprecated": true,
574
- "operationId": "getBrands",
575
- "summary": "getBrands",
576
- "description": "Scan all brands linked to a organization, based in orgId attribute from JWT auth token",
577
- "tags": [
578
- "design-builder"
579
- ],
580
- "responses": {
581
- "200": {
582
- "description": "Success - brands loaded with success. Empty array if org has no designs.",
583
- "content": {
584
- "application/json": {
585
- "schema": {
586
- "type": "array",
587
- "items": {
588
- "$ref": "#/components/schemas/GetBrandsRes"
589
- }
590
- }
591
- }
592
- }
593
- },
594
- "500": {
595
- "description": "Other errors",
596
- "content": {
597
- "application/json": {
598
- "schema": {
599
- "$ref": "#/components/schemas/ErrorResp"
600
- }
601
- }
602
- }
603
- }
604
- }
605
- }
606
- },
607
- "/v1/designs/consumer/{application}/{consumerId}": {
608
- "get": {
609
- "operationId": "getConsumerDesign",
610
- "summary": "getConsumerDesign",
611
- "description": "Search for a especific design owned by user organization",
612
- "tags": [
613
- "design-builder"
614
- ],
615
- "parameters": [
616
- {
617
- "in": "path",
618
- "name": "consumerId",
619
- "schema": {
620
- "type": "string"
621
- },
622
- "required": true,
623
- "description": "Id of the design",
624
- "example": "4a062990-a6a3-11eb-9828-4f3da7d4935a"
625
- },
626
- {
627
- "in": "path",
628
- "name": "application",
629
- "schema": {
630
- "type": "string"
631
- },
632
- "required": true,
633
- "description": "Type of application that uses the design",
634
- "example": "journey"
635
- }
636
- ],
637
- "responses": {
638
- "200": {
639
- "description": "Success - design loaded with success.",
640
- "content": {
641
- "application/json": {
642
- "schema": {
643
- "$ref": "#/components/schemas/GetDesignRes"
644
- }
645
- }
646
- }
647
- },
648
- "400": {
649
- "description": "Validation Errors",
650
- "content": {
651
- "application/json": {
652
- "schema": {
653
- "$ref": "#/components/schemas/ErrorResp"
654
- }
655
- }
656
- }
657
- },
658
- "401": {
659
- "description": "Authentication Errors",
660
- "content": {
661
- "application/json": {
662
- "schema": {
663
- "$ref": "#/components/schemas/ErrorResp"
664
- }
665
- }
666
- }
667
- },
668
- "404": {
669
- "description": "No design found"
670
- },
671
- "500": {
672
- "description": "Other errors",
673
- "content": {
674
- "application/json": {
675
- "schema": {
676
- "$ref": "#/components/schemas/ErrorResp"
677
- }
678
- }
679
- }
680
- }
681
- }
682
- }
683
- },
684
- "/v1/designs/addConsumer/{application}/{designId}": {
685
- "put": {
686
- "operationId": "addConsumer",
687
- "summary": "addConsumer",
688
- "description": "Add a consumer that uses a specific design",
689
- "tags": [
690
- "design-builder"
691
- ],
692
- "parameters": [
693
- {
694
- "in": "path",
695
- "name": "designId",
696
- "schema": {
697
- "type": "string"
698
- },
699
- "required": true,
700
- "description": "Id of the design",
701
- "example": "4a062990-a6a3-11eb-9828-4f3da7d4935a"
702
- },
703
- {
704
- "in": "path",
705
- "name": "application",
706
- "schema": {
707
- "type": "string"
708
- },
709
- "required": true,
710
- "description": "Type of application that uses the design",
711
- "example": "journey"
712
- }
713
- ],
714
- "requestBody": {
715
- "description": "widget id payload",
716
- "required": true,
717
- "content": {
718
- "application/json": {
719
- "schema": {
720
- "$ref": "#/components/schemas/AddConsumerReq"
721
- }
722
- }
723
- }
724
- },
725
- "responses": {
726
- "204": {
727
- "description": "Success - design updated with success."
728
- },
729
- "400": {
730
- "description": "Validation Errors",
731
- "content": {
732
- "application/json": {
733
- "schema": {
734
- "$ref": "#/components/schemas/ErrorResp"
735
- }
736
- }
737
- }
738
- },
739
- "401": {
740
- "description": "Authentication Errors",
741
- "content": {
742
- "application/json": {
743
- "schema": {
744
- "$ref": "#/components/schemas/ErrorResp"
745
- }
746
- }
747
- }
748
- },
749
- "404": {
750
- "description": "No design found"
751
- },
752
- "500": {
753
- "description": "Other errors",
754
- "content": {
755
- "application/json": {
756
- "schema": {
757
- "$ref": "#/components/schemas/ErrorResp"
758
- }
759
- }
760
- }
761
- }
762
- }
763
- }
764
- },
765
- "/v1/designs/removeConsumer/{application}/{designId}": {
766
- "put": {
767
- "operationId": "removeConsumer",
768
- "summary": "removeConsumer",
769
- "description": "Remove a consumer that uses a specific design",
770
- "tags": [
771
- "design-builder"
772
- ],
773
- "parameters": [
774
- {
775
- "in": "path",
776
- "name": "designId",
777
- "schema": {
778
- "type": "string"
779
- },
780
- "required": true,
781
- "description": "Id of the design",
782
- "example": "4a062990-a6a3-11eb-9828-4f3da7d4935a"
783
- },
784
- {
785
- "in": "path",
786
- "name": "application",
787
- "schema": {
788
- "type": "string"
789
- },
790
- "required": true,
791
- "description": "Type of application that uses the design",
792
- "example": "journey"
793
- }
794
- ],
795
- "requestBody": {
796
- "description": "widget id payload",
797
- "required": true,
798
- "content": {
799
- "application/json": {
800
- "schema": {
801
- "$ref": "#/components/schemas/AddConsumerReq"
802
- }
803
- }
804
- }
805
- },
806
- "responses": {
807
- "204": {
808
- "description": "Success - design updated with success."
809
- },
810
- "400": {
811
- "description": "Validation Errors",
812
- "content": {
813
- "application/json": {
814
- "schema": {
815
- "$ref": "#/components/schemas/ErrorResp"
816
- }
817
- }
818
- }
819
- },
820
- "401": {
821
- "description": "Authentication Errors",
822
- "content": {
823
- "application/json": {
824
- "schema": {
825
- "$ref": "#/components/schemas/ErrorResp"
826
- }
827
- }
828
- }
829
- },
830
- "404": {
831
- "description": "No design found"
832
- },
833
- "500": {
834
- "description": "Other errors",
835
- "content": {
836
- "application/json": {
837
- "schema": {
838
- "$ref": "#/components/schemas/ErrorResp"
839
- }
840
- }
841
- }
842
- }
843
- }
844
- }
845
- }
846
- },
847
- "components": {
848
- "securitySchemes": {
849
- "custom_authorizer": {
850
- "type": "http",
851
- "scheme": "bearer",
852
- "bearerFormat": "JWT"
853
- }
854
- },
855
- "schemas": {
856
- "UploadFileReq": {
857
- "type": "object",
858
- "properties": {
859
- "file_type": {
860
- "type": "string",
861
- "enum": [
862
- "LOGO",
863
- "FONT"
864
- ]
865
- },
866
- "file_data": {
867
- "type": "string",
868
- "format": "base64"
869
- },
870
- "display_name": {
871
- "type": "string"
872
- },
873
- "file_name": {
874
- "type": "string"
875
- }
876
- },
877
- "required": [
878
- "file_type",
879
- "file_name",
880
- "file_data"
881
- ]
882
- },
883
- "UploadFileRes": {
884
- "type": "object",
885
- "allOf": [
886
- {
887
- "$ref": "#/components/schemas/FileData"
888
- }
889
- ]
890
- },
891
- "GetFilesRes": {
892
- "type": "array",
893
- "items": {
894
- "allOf": [
895
- {
896
- "$ref": "#/components/schemas/FileData"
897
- }
898
- ]
899
- }
900
- },
901
- "GetAllDesignsRes": {
902
- "type": "object",
903
- "properties": {
904
- "designs": {
905
- "type": "array",
906
- "items": {
907
- "allOf": [
908
- {
909
- "$ref": "#/components/schemas/ItemMetada"
910
- },
911
- {
912
- "$ref": "#/components/schemas/DesignItem"
913
- },
914
- {
915
- "$ref": "#/components/schemas/Custom_Style"
916
- },
917
- {
918
- "$ref": "#/components/schemas/Journey"
919
- }
920
- ]
921
- }
922
- }
923
- }
924
- },
925
- "GetBrandsRes": {
926
- "type": "object",
927
- "properties": {
928
- "brands": {
929
- "type": "array",
930
- "items": {
931
- "allOf": [
932
- {
933
- "$ref": "#/components/schemas/BrandItem"
934
- }
935
- ]
936
- }
937
- }
938
- }
939
- },
940
- "AddDesignReq": {
941
- "type": "object",
942
- "properties": {
943
- "design": {
944
- "allOf": [
945
- {
946
- "$ref": "#/components/schemas/DesignItem"
947
- },
948
- {
949
- "$ref": "#/components/schemas/Custom_Style"
950
- },
951
- {
952
- "$ref": "#/components/schemas/Journey"
953
- }
954
- ]
955
- }
956
- },
957
- "required": [
958
- "design"
959
- ]
960
- },
961
- "AddDesignRes": {
962
- "type": "object",
963
- "properties": {
964
- "design": {
965
- "allOf": [
966
- {
967
- "$ref": "#/components/schemas/ItemMetada"
968
- },
969
- {
970
- "$ref": "#/components/schemas/DesignItem"
971
- },
972
- {
973
- "$ref": "#/components/schemas/Custom_Style"
974
- },
975
- {
976
- "$ref": "#/components/schemas/Journey"
977
- }
978
- ]
979
- }
980
- }
981
- },
982
- "GetDesignRes": {
983
- "type": "object",
984
- "properties": {
985
- "design": {
986
- "allOf": [
987
- {
988
- "$ref": "#/components/schemas/ItemMetada"
989
- },
990
- {
991
- "$ref": "#/components/schemas/DesignItem"
992
- },
993
- {
994
- "$ref": "#/components/schemas/Custom_Style"
995
- },
996
- {
997
- "$ref": "#/components/schemas/Journey"
998
- }
999
- ]
1000
- }
1001
- }
1002
- },
1003
- "UpdateDesignReq": {
1004
- "type": "object",
1005
- "properties": {
1006
- "design": {
1007
- "allOf": [
1008
- {
1009
- "$ref": "#/components/schemas/DesignItem"
1010
- },
1011
- {
1012
- "$ref": "#/components/schemas/Custom_Style"
1013
- },
1014
- {
1015
- "$ref": "#/components/schemas/Journey"
1016
- }
1017
- ]
1018
- }
1019
- },
1020
- "required": [
1021
- "design"
1022
- ]
1023
- },
1024
- "ItemMetada": {
1025
- "type": "object",
1026
- "properties": {
1027
- "id": {
1028
- "type": "string"
1029
- },
1030
- "created_at": {
1031
- "type": "string",
1032
- "description": "Creation date and time",
1033
- "example": "2021-01-30T08:30:00Z"
1034
- },
1035
- "created_by": {
1036
- "type": "string"
1037
- },
1038
- "edited": {
1039
- "type": "boolean"
1040
- },
1041
- "last_modified_at": {
1042
- "type": "string"
1043
- }
1044
- }
1045
- },
1046
- "AddConsumerReq": {
1047
- "type": "object",
1048
- "properties": {
1049
- "consumer_id": {
1050
- "type": "string"
1051
- },
1052
- "consumer_name": {
1053
- "type": "string"
1054
- },
1055
- "should_delete": {
1056
- "type": "string"
1057
- }
1058
- },
1059
- "required": [
1060
- "consumer_id",
1061
- "consumer_name"
1062
- ]
1063
- },
1064
- "DesignItem": {
1065
- "type": "object",
1066
- "properties": {
1067
- "brand_id": {
1068
- "type": "string"
1069
- },
1070
- "brand_name": {
1071
- "type": "string"
1072
- },
1073
- "user": {
1074
- "type": "object",
1075
- "properties": {
1076
- "emailaddress": {
1077
- "type": "string"
1078
- },
1079
- "fullname": {
1080
- "type": "string"
1081
- },
1082
- "name": {
1083
- "type": "string"
1084
- },
1085
- "userid": {
1086
- "type": "string"
1087
- }
1088
- }
1089
- },
1090
- "style_name": {
1091
- "type": "string"
1092
- },
1093
- "style": {
1094
- "type": "object",
1095
- "properties": {
1096
- "logo": {
1097
- "type": "object",
1098
- "$ref": "#/components/schemas/LogoData"
1099
- },
1100
- "palette": {
1101
- "type": "object",
1102
- "$ref": "#/components/schemas/PaletteData"
1103
- },
1104
- "typography": {
1105
- "type": "object",
1106
- "$ref": "#/components/schemas/TypographyData"
1107
- },
1108
- "shape": {
1109
- "type": "object",
1110
- "$ref": "#/components/schemas/ShapeData"
1111
- },
1112
- "consumer": {
1113
- "type": "object",
1114
- "$ref": "#/components/schemas/ConsumerData"
1115
- }
1116
- },
1117
- "required": [
1118
- "palette",
1119
- "typography",
1120
- "consumer"
1121
- ]
1122
- },
1123
- "is_default": {
1124
- "type": "boolean"
1125
- }
1126
- },
1127
- "required": [
1128
- "style_name",
1129
- "status",
1130
- "edited",
1131
- "style"
1132
- ]
1133
- },
1134
- "BrandItem": {
1135
- "type": "object",
1136
- "properties": {
1137
- "id": {
1138
- "type": "string"
1139
- },
1140
- "name": {
1141
- "type": "string"
1142
- },
1143
- "created_by": {
1144
- "type": "string"
1145
- },
1146
- "created_date": {
1147
- "type": "string"
1148
- },
1149
- "main_brand": {
1150
- "type": "string"
1151
- },
1152
- "organization_id": {
1153
- "type": "string"
1154
- },
1155
- "updated_date": {
1156
- "type": "string"
1157
- },
1158
- "updated_by": {
1159
- "type": "string"
1160
- },
1161
- "status": {
1162
- "type": "string"
1163
- }
1164
- },
1165
- "required": [
1166
- "id",
1167
- "name"
1168
- ]
1169
- },
1170
- "Custom_Style": {
1171
- "type": "object",
1172
- "properties": {
1173
- "custom_theme": {
1174
- "type": "string"
1175
- },
1176
- "use_custom_theme": {
1177
- "type": "boolean"
1178
- }
1179
- }
1180
- },
1181
- "Journey": {
1182
- "type": "object",
1183
- "properties": {
1184
- "design_tokens": {
1185
- "type": "object",
1186
- "properties": {
1187
- "coupon": {
1188
- "type": "string"
1189
- },
1190
- "cashback": {
1191
- "type": "string"
1192
- },
1193
- "custom_css": {
1194
- "type": "string"
1195
- }
1196
- }
1197
- }
1198
- }
1199
- },
1200
- "ConsumerData": {
1201
- "type": "object",
1202
- "properties": {
1203
- "widgets": {
1204
- "type": "array",
1205
- "items": {
1206
- "anyOf": [
1207
- {
1208
- "$ref": "#/components/schemas/WidgetData"
1209
- }
1210
- ]
1211
- }
1212
- },
1213
- "customer_portals": {
1214
- "type": "array",
1215
- "items": {
1216
- "anyOf": [
1217
- {
1218
- "$ref": "#/components/schemas/CustomerPortalData"
1219
- }
1220
- ]
1221
- }
1222
- }
1223
- },
1224
- "required": [
1225
- "widgets",
1226
- "customer_portals"
1227
- ]
1228
- },
1229
- "WidgetData": {
1230
- "allOf": [
1231
- {
1232
- "$ref": "#/components/schemas/WidgetPortalData"
1233
- }
1234
- ]
1235
- },
1236
- "CustomerPortalData": {
1237
- "allOf": [
1238
- {
1239
- "$ref": "#/components/schemas/WidgetPortalData"
1240
- }
1241
- ]
1242
- },
1243
- "LogoData": {
1244
- "type": "object",
1245
- "properties": {
1246
- "main": {
1247
- "type": "object",
1248
- "$ref": "#/components/schemas/FileData"
1249
- }
1250
- }
1251
- },
1252
- "PaletteData": {
1253
- "type": "object",
1254
- "properties": {
1255
- "primary": {
1256
- "type": "string"
1257
- },
1258
- "secondary": {
1259
- "type": "string"
1260
- },
1261
- "error": {
1262
- "type": "string"
1263
- },
1264
- "background": {
1265
- "type": "string"
1266
- },
1267
- "paper": {
1268
- "type": "string"
1269
- },
1270
- "navbar": {
1271
- "type": "string"
1272
- },
1273
- "portal_login_background": {
1274
- "type": "string"
1275
- }
1276
- },
1277
- "required": [
1278
- "primary",
1279
- "secondary",
1280
- "error",
1281
- "background",
1282
- "paper",
1283
- "navbar"
1284
- ]
1285
- },
1286
- "TypographyData": {
1287
- "type": "object",
1288
- "properties": {
1289
- "font": {
1290
- "type": "object",
1291
- "$ref": "#/components/schemas/FontData"
1292
- },
1293
- "primary": {
1294
- "type": "string"
1295
- },
1296
- "secondary": {
1297
- "type": "string"
1298
- }
1299
- },
1300
- "required": [
1301
- "font",
1302
- "primary",
1303
- "secondary"
1304
- ]
1305
- },
1306
- "ShapeData": {
1307
- "type": "object",
1308
- "properties": {
1309
- "border_radius": {
1310
- "type": "number"
1311
- }
1312
- }
1313
- },
1314
- "FontData": {
1315
- "type": "object",
1316
- "properties": {
1317
- "font_id": {
1318
- "type": "string"
1319
- },
1320
- "font_name": {
1321
- "type": "string"
1322
- },
1323
- "font_family": {
1324
- "type": "string"
1325
- },
1326
- "font_weight_regular": {
1327
- "type": "string"
1328
- },
1329
- "font_weight_medium": {
1330
- "type": "string"
1331
- },
1332
- "font_weight_bold": {
1333
- "type": "string"
1334
- },
1335
- "urls": {
1336
- "type": "array",
1337
- "items": {
1338
- "anyOf": [
1339
- {
1340
- "$ref": "#/components/schemas/FontResponseUrl"
1341
- }
1342
- ]
1343
- }
1344
- }
1345
- },
1346
- "required": [
1347
- "font_id",
1348
- "font_name",
1349
- "urls"
1350
- ]
1351
- },
1352
- "FontResponseUrl": {
1353
- "type": "object",
1354
- "properties": {
1355
- "type": {
1356
- "type": "string",
1357
- "enum": [
1358
- "WOFF2",
1359
- "WOFF",
1360
- "TTF",
1361
- "EOT"
1362
- ]
1363
- },
1364
- "url": {
1365
- "type": "string"
1366
- }
1367
- }
1368
- },
1369
- "WidgetPortalData": {
1370
- "type": "object",
1371
- "properties": {
1372
- "id": {
1373
- "type": "string"
1374
- },
1375
- "name": {
1376
- "type": "string"
1377
- }
1378
- },
1379
- "required": [
1380
- "id",
1381
- "name"
1382
- ]
1383
- },
1384
- "ErrorResp": {
1385
- "type": "object",
1386
- "properties": {
1387
- "message": {
1388
- "type": "string"
1389
- }
1390
- }
1391
- },
1392
- "FileData": {
1393
- "type": "object",
1394
- "properties": {
1395
- "name": {
1396
- "type": "string"
1397
- },
1398
- "display_name": {
1399
- "type": "string"
1400
- },
1401
- "file_type": {
1402
- "type": "string",
1403
- "enum": [
1404
- "LOGO",
1405
- "FONT"
1406
- ]
1407
- },
1408
- "s3_object_key": {
1409
- "type": "string"
1410
- },
1411
- "url": {
1412
- "type": "string"
1413
- }
1414
- },
1415
- "required": [
1416
- "name",
1417
- "s3_object_key",
1418
- "url"
1419
- ]
1420
- }
1421
- }
1422
- }
1423
- }