@epilot/sdk 2.19.3 → 2.19.5

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 (231) hide show
  1. package/definitions/access-token-runtime.json +1 -0
  2. package/definitions/access-token.json +835 -0
  3. package/definitions/address-runtime.json +1 -0
  4. package/definitions/address-suggestions-runtime.json +1 -0
  5. package/definitions/address-suggestions.json +582 -0
  6. package/definitions/address.json +578 -0
  7. package/definitions/ai-agents-runtime.json +1 -0
  8. package/definitions/ai-agents.json +2863 -0
  9. package/definitions/app-runtime.json +1 -0
  10. package/definitions/app.json +5743 -0
  11. package/definitions/audit-logs-runtime.json +1 -0
  12. package/definitions/audit-logs.json +305 -0
  13. package/definitions/automation-runtime.json +1 -0
  14. package/definitions/automation.json +5557 -0
  15. package/definitions/billing-runtime.json +1 -0
  16. package/definitions/billing.json +2386 -0
  17. package/definitions/blueprint-manifest-runtime.json +1 -0
  18. package/definitions/blueprint-manifest.json +7718 -0
  19. package/definitions/calendar-runtime.json +1 -0
  20. package/definitions/calendar.json +2904 -0
  21. package/definitions/configuration-hub-runtime.json +1 -0
  22. package/definitions/configuration-hub.json +2250 -0
  23. package/definitions/consent-runtime.json +1 -0
  24. package/definitions/consent.json +344 -0
  25. package/definitions/customer-portal-runtime.json +1 -0
  26. package/definitions/customer-portal.json +19945 -0
  27. package/definitions/dashboard-runtime.json +1 -0
  28. package/definitions/dashboard.json +1355 -0
  29. package/definitions/data-governance-runtime.json +1 -0
  30. package/definitions/data-governance.json +1126 -0
  31. package/definitions/deduplication-runtime.json +1 -0
  32. package/definitions/deduplication.json +782 -0
  33. package/definitions/design-runtime.json +1 -0
  34. package/definitions/design.json +1827 -0
  35. package/definitions/document-runtime.json +1 -0
  36. package/definitions/document.json +758 -0
  37. package/definitions/email-settings-runtime.json +1 -0
  38. package/definitions/email-settings.json +3736 -0
  39. package/definitions/email-template-runtime.json +1 -0
  40. package/definitions/email-template.json +1441 -0
  41. package/definitions/entity-mapping-runtime.json +1 -0
  42. package/definitions/entity-mapping.json +1642 -0
  43. package/definitions/entity-runtime.json +1 -0
  44. package/definitions/entity.json +11517 -0
  45. package/definitions/environments-runtime.json +1 -0
  46. package/definitions/environments.json +539 -0
  47. package/definitions/event-catalog-runtime.json +1 -0
  48. package/definitions/event-catalog.json +1524 -0
  49. package/definitions/file-runtime.json +1 -0
  50. package/definitions/file.json +3905 -0
  51. package/definitions/iban-runtime.json +1 -0
  52. package/definitions/iban.json +132 -0
  53. package/definitions/integration-toolkit-runtime.json +1 -0
  54. package/definitions/integration-toolkit.json +12769 -0
  55. package/definitions/journey-runtime.json +1 -0
  56. package/definitions/journey.json +2640 -0
  57. package/definitions/kanban-runtime.json +1 -0
  58. package/definitions/kanban.json +1506 -0
  59. package/definitions/message-runtime.json +1 -0
  60. package/definitions/message.json +3667 -0
  61. package/definitions/metering-runtime.json +1 -0
  62. package/definitions/metering.json +3132 -0
  63. package/definitions/notes-runtime.json +1 -0
  64. package/definitions/notes.json +1698 -0
  65. package/definitions/notification-runtime.json +1 -0
  66. package/definitions/notification.json +1439 -0
  67. package/definitions/organization-runtime.json +1 -0
  68. package/definitions/organization.json +1192 -0
  69. package/definitions/partner-directory-runtime.json +1 -0
  70. package/definitions/partner-directory.json +2284 -0
  71. package/definitions/permissions-runtime.json +1 -0
  72. package/definitions/permissions.json +1598 -0
  73. package/definitions/pricing-runtime.json +1 -0
  74. package/definitions/pricing-tier-runtime.json +1 -0
  75. package/definitions/pricing-tier.json +105 -0
  76. package/definitions/pricing.json +11569 -0
  77. package/definitions/purpose-runtime.json +1 -0
  78. package/definitions/purpose.json +524 -0
  79. package/definitions/query-runtime.json +1 -0
  80. package/definitions/query.json +3178 -0
  81. package/definitions/sandbox-runtime.json +1 -0
  82. package/definitions/sandbox.json +453 -0
  83. package/definitions/sharing-runtime.json +1 -0
  84. package/definitions/sharing.json +956 -0
  85. package/definitions/snapshot-runtime.json +1 -0
  86. package/definitions/snapshot.json +1103 -0
  87. package/definitions/submission-runtime.json +1 -0
  88. package/definitions/submission.json +313 -0
  89. package/definitions/targeting-runtime.json +1 -0
  90. package/definitions/targeting.json +2222 -0
  91. package/definitions/template-variables-runtime.json +1 -0
  92. package/definitions/template-variables.json +1416 -0
  93. package/definitions/user-runtime.json +1 -0
  94. package/definitions/user.json +3051 -0
  95. package/definitions/validation-rules-runtime.json +1 -0
  96. package/definitions/validation-rules.json +2365 -0
  97. package/definitions/webhooks-runtime.json +1 -0
  98. package/definitions/webhooks.json +1875 -0
  99. package/definitions/workflow-definition-runtime.json +1 -0
  100. package/definitions/workflow-definition.json +3592 -0
  101. package/definitions/workflow-runtime.json +1 -0
  102. package/definitions/workflow.json +4669 -0
  103. package/dist/apis/access-token.cjs +6 -6
  104. package/dist/apis/access-token.js +1 -1
  105. package/dist/apis/address-suggestions.cjs +6 -6
  106. package/dist/apis/address-suggestions.js +1 -1
  107. package/dist/apis/address.cjs +6 -6
  108. package/dist/apis/address.js +1 -1
  109. package/dist/apis/ai-agents.cjs +6 -6
  110. package/dist/apis/ai-agents.js +1 -1
  111. package/dist/apis/app.cjs +6 -6
  112. package/dist/apis/app.js +1 -1
  113. package/dist/apis/audit-logs.cjs +6 -6
  114. package/dist/apis/audit-logs.js +1 -1
  115. package/dist/apis/automation.cjs +6 -6
  116. package/dist/apis/automation.js +1 -1
  117. package/dist/apis/billing.cjs +6 -6
  118. package/dist/apis/billing.js +1 -1
  119. package/dist/apis/blueprint-manifest.cjs +6 -6
  120. package/dist/apis/blueprint-manifest.js +1 -1
  121. package/dist/apis/calendar.cjs +6 -6
  122. package/dist/apis/calendar.js +1 -1
  123. package/dist/apis/configuration-hub.cjs +6 -6
  124. package/dist/apis/configuration-hub.js +1 -1
  125. package/dist/apis/consent.cjs +6 -6
  126. package/dist/apis/consent.js +1 -1
  127. package/dist/apis/customer-portal.cjs +6 -6
  128. package/dist/apis/customer-portal.d.cts +2 -2
  129. package/dist/apis/customer-portal.d.ts +2 -2
  130. package/dist/apis/customer-portal.js +1 -1
  131. package/dist/apis/dashboard.cjs +6 -6
  132. package/dist/apis/dashboard.js +1 -1
  133. package/dist/apis/data-governance.cjs +6 -6
  134. package/dist/apis/data-governance.js +1 -1
  135. package/dist/apis/deduplication.cjs +6 -6
  136. package/dist/apis/deduplication.js +1 -1
  137. package/dist/apis/design.cjs +6 -6
  138. package/dist/apis/design.js +1 -1
  139. package/dist/apis/document.cjs +6 -6
  140. package/dist/apis/document.js +1 -1
  141. package/dist/apis/email-settings.cjs +6 -6
  142. package/dist/apis/email-settings.js +1 -1
  143. package/dist/apis/email-template.cjs +6 -6
  144. package/dist/apis/email-template.js +1 -1
  145. package/dist/apis/entity-mapping.cjs +6 -6
  146. package/dist/apis/entity-mapping.js +1 -1
  147. package/dist/apis/entity.cjs +6 -6
  148. package/dist/apis/entity.js +1 -1
  149. package/dist/apis/environments.cjs +6 -6
  150. package/dist/apis/environments.js +1 -1
  151. package/dist/apis/event-catalog.cjs +6 -6
  152. package/dist/apis/event-catalog.js +1 -1
  153. package/dist/apis/file.cjs +6 -6
  154. package/dist/apis/file.js +1 -1
  155. package/dist/apis/iban.cjs +6 -6
  156. package/dist/apis/iban.js +1 -1
  157. package/dist/apis/integration-toolkit.cjs +6 -6
  158. package/dist/apis/integration-toolkit.js +1 -1
  159. package/dist/apis/journey.cjs +6 -6
  160. package/dist/apis/journey.js +1 -1
  161. package/dist/apis/kanban.cjs +6 -6
  162. package/dist/apis/kanban.js +1 -1
  163. package/dist/apis/message.cjs +6 -6
  164. package/dist/apis/message.js +1 -1
  165. package/dist/apis/metering.cjs +6 -6
  166. package/dist/apis/metering.js +1 -1
  167. package/dist/apis/notes.cjs +6 -6
  168. package/dist/apis/notes.js +1 -1
  169. package/dist/apis/notification.cjs +6 -6
  170. package/dist/apis/notification.js +1 -1
  171. package/dist/apis/organization.cjs +6 -6
  172. package/dist/apis/organization.js +1 -1
  173. package/dist/apis/partner-directory.cjs +6 -6
  174. package/dist/apis/partner-directory.js +1 -1
  175. package/dist/apis/permissions.cjs +6 -6
  176. package/dist/apis/permissions.js +1 -1
  177. package/dist/apis/pricing-tier.cjs +6 -6
  178. package/dist/apis/pricing-tier.js +1 -1
  179. package/dist/apis/pricing.cjs +6 -6
  180. package/dist/apis/pricing.js +1 -1
  181. package/dist/apis/purpose.cjs +6 -6
  182. package/dist/apis/purpose.js +1 -1
  183. package/dist/apis/query.cjs +6 -6
  184. package/dist/apis/query.js +1 -1
  185. package/dist/apis/sandbox.cjs +6 -6
  186. package/dist/apis/sandbox.js +1 -1
  187. package/dist/apis/sharing.cjs +6 -6
  188. package/dist/apis/sharing.js +1 -1
  189. package/dist/apis/snapshot.cjs +6 -6
  190. package/dist/apis/snapshot.js +1 -1
  191. package/dist/apis/submission.cjs +6 -6
  192. package/dist/apis/submission.js +1 -1
  193. package/dist/apis/target.cjs +6 -6
  194. package/dist/apis/target.js +1 -1
  195. package/dist/apis/targeting.cjs +6 -6
  196. package/dist/apis/targeting.d.cts +2 -2
  197. package/dist/apis/targeting.d.ts +2 -2
  198. package/dist/apis/targeting.js +1 -1
  199. package/dist/apis/template-variables.cjs +6 -6
  200. package/dist/apis/template-variables.js +1 -1
  201. package/dist/apis/user.cjs +6 -6
  202. package/dist/apis/user.js +1 -1
  203. package/dist/apis/validation-rules.cjs +6 -6
  204. package/dist/apis/validation-rules.js +1 -1
  205. package/dist/apis/webhooks.cjs +6 -6
  206. package/dist/apis/webhooks.js +1 -1
  207. package/dist/apis/workflow-definition.cjs +6 -6
  208. package/dist/apis/workflow-definition.js +1 -1
  209. package/dist/apis/workflow.cjs +6 -6
  210. package/dist/apis/workflow.js +1 -1
  211. package/dist/{chunk-UC3IKFHD.js → chunk-HWPPR3IM.js} +2 -2
  212. package/dist/{chunk-QWWGJOYR.cjs → chunk-VB6VABGZ.cjs} +2 -2
  213. package/dist/customer-portal-CDFQM72A.js +7 -0
  214. package/dist/customer-portal-MS6WNXAO.cjs +7 -0
  215. package/dist/{customer-portal.d-DTnk0yQf.d.cts → customer-portal.d-DJHJY-vb.d.cts} +51 -8
  216. package/dist/{customer-portal.d-DTnk0yQf.d.ts → customer-portal.d-DJHJY-vb.d.ts} +51 -8
  217. package/dist/index.cjs +8 -8
  218. package/dist/index.d.cts +2 -2
  219. package/dist/index.d.ts +2 -2
  220. package/dist/index.js +1 -1
  221. package/dist/targeting-5U4XGOXY.cjs +7 -0
  222. package/dist/targeting-R3G32HI4.js +7 -0
  223. package/dist/{targeting.d-16SvPyj4.d.cts → targeting.d-KcawmWBB.d.cts} +8 -0
  224. package/dist/{targeting.d-16SvPyj4.d.ts → targeting.d-KcawmWBB.d.ts} +8 -0
  225. package/docs/customer-portal.md +13 -4
  226. package/docs/targeting.md +9 -1
  227. package/package.json +1 -1
  228. package/dist/customer-portal-FCUPDA7V.cjs +0 -7
  229. package/dist/customer-portal-GRWXQYKT.js +0 -7
  230. package/dist/targeting-BTVCLYFW.cjs +0 -7
  231. package/dist/targeting-NWYDE3E7.js +0 -7
@@ -0,0 +1,1827 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "Design Builder API v2",
5
+ "version": "0.0.3"
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.sls.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
+ "$ref": "#/components/schemas/GetAllDesignsRes"
39
+ }
40
+ }
41
+ }
42
+ },
43
+ "500": {
44
+ "description": "Other errors",
45
+ "content": {
46
+ "application/json": {
47
+ "schema": {
48
+ "$ref": "#/components/schemas/ErrorResp"
49
+ }
50
+ }
51
+ }
52
+ }
53
+ }
54
+ },
55
+ "post": {
56
+ "operationId": "addDesign",
57
+ "summary": "addDesign",
58
+ "description": "Create a brand new design linked to a organization, based in orgId attribute from JWT auth token",
59
+ "tags": [
60
+ "design-builder"
61
+ ],
62
+ "requestBody": {
63
+ "description": "Design payload",
64
+ "required": true,
65
+ "content": {
66
+ "application/json": {
67
+ "schema": {
68
+ "$ref": "#/components/schemas/AddDesignReq"
69
+ }
70
+ }
71
+ }
72
+ },
73
+ "responses": {
74
+ "201": {
75
+ "description": "Success - design created with success.",
76
+ "content": {
77
+ "application/json": {
78
+ "schema": {
79
+ "$ref": "#/components/schemas/AddDesignRes"
80
+ }
81
+ }
82
+ }
83
+ },
84
+ "400": {
85
+ "description": "Validation Errors",
86
+ "content": {
87
+ "application/json": {
88
+ "schema": {
89
+ "$ref": "#/components/schemas/ErrorResp"
90
+ }
91
+ }
92
+ }
93
+ },
94
+ "401": {
95
+ "description": "Authentication Errors",
96
+ "content": {
97
+ "application/json": {
98
+ "schema": {
99
+ "$ref": "#/components/schemas/ErrorResp"
100
+ }
101
+ }
102
+ }
103
+ },
104
+ "500": {
105
+ "description": "Other errors",
106
+ "content": {
107
+ "application/json": {
108
+ "schema": {
109
+ "$ref": "#/components/schemas/ErrorResp"
110
+ }
111
+ }
112
+ }
113
+ }
114
+ }
115
+ }
116
+ },
117
+ "/v1/designs/{designId}": {
118
+ "get": {
119
+ "operationId": "getDesign",
120
+ "summary": "getDesign",
121
+ "description": "Search for a especific design owned by user organization",
122
+ "tags": [
123
+ "design-builder"
124
+ ],
125
+ "parameters": [
126
+ {
127
+ "in": "path",
128
+ "name": "designId",
129
+ "required": true,
130
+ "schema": {
131
+ "$ref": "#/components/schemas/DesignId"
132
+ }
133
+ }
134
+ ],
135
+ "responses": {
136
+ "200": {
137
+ "description": "Success - design loaded with success.",
138
+ "content": {
139
+ "application/json": {
140
+ "schema": {
141
+ "$ref": "#/components/schemas/GetDesignRes"
142
+ }
143
+ }
144
+ }
145
+ },
146
+ "400": {
147
+ "description": "Validation Errors",
148
+ "content": {
149
+ "application/json": {
150
+ "schema": {
151
+ "$ref": "#/components/schemas/ErrorResp"
152
+ }
153
+ }
154
+ }
155
+ },
156
+ "401": {
157
+ "description": "Authentication Errors",
158
+ "content": {
159
+ "application/json": {
160
+ "schema": {
161
+ "$ref": "#/components/schemas/ErrorResp"
162
+ }
163
+ }
164
+ }
165
+ },
166
+ "404": {
167
+ "description": "No design found"
168
+ },
169
+ "500": {
170
+ "description": "Other errors",
171
+ "content": {
172
+ "application/json": {
173
+ "schema": {
174
+ "$ref": "#/components/schemas/ErrorResp"
175
+ }
176
+ }
177
+ }
178
+ }
179
+ }
180
+ },
181
+ "delete": {
182
+ "operationId": "deleteDesign",
183
+ "summary": "deleteDesign",
184
+ "description": "Search and delete for a especific design owned by user organization",
185
+ "tags": [
186
+ "design-builder"
187
+ ],
188
+ "parameters": [
189
+ {
190
+ "in": "path",
191
+ "name": "designId",
192
+ "required": true,
193
+ "schema": {
194
+ "$ref": "#/components/schemas/DesignId"
195
+ }
196
+ }
197
+ ],
198
+ "responses": {
199
+ "204": {
200
+ "description": "Success - design deleted with success."
201
+ },
202
+ "400": {
203
+ "description": "Validation Errors",
204
+ "content": {
205
+ "application/json": {
206
+ "schema": {
207
+ "$ref": "#/components/schemas/ErrorResp"
208
+ }
209
+ }
210
+ }
211
+ },
212
+ "401": {
213
+ "description": "Authentication Errors",
214
+ "content": {
215
+ "application/json": {
216
+ "schema": {
217
+ "$ref": "#/components/schemas/ErrorResp"
218
+ }
219
+ }
220
+ }
221
+ },
222
+ "404": {
223
+ "description": "No design found"
224
+ },
225
+ "500": {
226
+ "description": "Other errors",
227
+ "content": {
228
+ "application/json": {
229
+ "schema": {
230
+ "$ref": "#/components/schemas/ErrorResp"
231
+ }
232
+ }
233
+ }
234
+ }
235
+ }
236
+ },
237
+ "put": {
238
+ "operationId": "updateDesign",
239
+ "summary": "updateDesign",
240
+ "description": "Update a especific design owned by user organization",
241
+ "tags": [
242
+ "design-builder"
243
+ ],
244
+ "parameters": [
245
+ {
246
+ "in": "path",
247
+ "name": "designId",
248
+ "required": true,
249
+ "schema": {
250
+ "$ref": "#/components/schemas/DesignId"
251
+ }
252
+ }
253
+ ],
254
+ "requestBody": {
255
+ "description": "Design payload",
256
+ "required": true,
257
+ "content": {
258
+ "application/json": {
259
+ "schema": {
260
+ "$ref": "#/components/schemas/UpdateDesignReq"
261
+ }
262
+ }
263
+ }
264
+ },
265
+ "responses": {
266
+ "204": {
267
+ "description": "Success - design updated with success."
268
+ },
269
+ "400": {
270
+ "description": "Validation Errors",
271
+ "content": {
272
+ "application/json": {
273
+ "schema": {
274
+ "$ref": "#/components/schemas/ErrorResp"
275
+ }
276
+ }
277
+ }
278
+ },
279
+ "401": {
280
+ "description": "Authentication Errors",
281
+ "content": {
282
+ "application/json": {
283
+ "schema": {
284
+ "$ref": "#/components/schemas/ErrorResp"
285
+ }
286
+ }
287
+ }
288
+ },
289
+ "404": {
290
+ "description": "No design found"
291
+ },
292
+ "500": {
293
+ "description": "Other errors",
294
+ "content": {
295
+ "application/json": {
296
+ "schema": {
297
+ "$ref": "#/components/schemas/ErrorResp"
298
+ }
299
+ }
300
+ }
301
+ }
302
+ }
303
+ }
304
+ },
305
+ "/v1/designs/{designId}/duplicate": {
306
+ "post": {
307
+ "operationId": "duplicateDesign",
308
+ "summary": "duplicateDesign",
309
+ "description": "Duplicate an existing design owned by the user organization. The copy carries over the style, custom CSS and name (marked as a copy) but does NOT carry over journey/portal relations, so the new design starts with 0 consumers, exactly like a freshly created design.",
310
+ "tags": [
311
+ "design-builder"
312
+ ],
313
+ "parameters": [
314
+ {
315
+ "in": "path",
316
+ "name": "designId",
317
+ "required": true,
318
+ "schema": {
319
+ "$ref": "#/components/schemas/DesignId"
320
+ }
321
+ }
322
+ ],
323
+ "responses": {
324
+ "201": {
325
+ "description": "Success - design duplicated with success.",
326
+ "content": {
327
+ "application/json": {
328
+ "schema": {
329
+ "$ref": "#/components/schemas/AddDesignRes"
330
+ }
331
+ }
332
+ }
333
+ },
334
+ "400": {
335
+ "description": "Validation Errors",
336
+ "content": {
337
+ "application/json": {
338
+ "schema": {
339
+ "$ref": "#/components/schemas/ErrorResp"
340
+ }
341
+ }
342
+ }
343
+ },
344
+ "401": {
345
+ "description": "Authentication Errors",
346
+ "content": {
347
+ "application/json": {
348
+ "schema": {
349
+ "$ref": "#/components/schemas/ErrorResp"
350
+ }
351
+ }
352
+ }
353
+ },
354
+ "404": {
355
+ "description": "No design found"
356
+ },
357
+ "500": {
358
+ "description": "Other errors",
359
+ "content": {
360
+ "application/json": {
361
+ "schema": {
362
+ "$ref": "#/components/schemas/ErrorResp"
363
+ }
364
+ }
365
+ }
366
+ }
367
+ }
368
+ }
369
+ },
370
+ "/v1/designs/{designId}/parse": {
371
+ "get": {
372
+ "operationId": "getThemeFromDesign",
373
+ "summary": "getThemeFromDesign",
374
+ "description": "Search for a especific design owned by user organization and parse them to a new or old theme",
375
+ "security": [],
376
+ "tags": [
377
+ "design-builder"
378
+ ],
379
+ "parameters": [
380
+ {
381
+ "in": "path",
382
+ "name": "designId",
383
+ "required": true,
384
+ "schema": {
385
+ "$ref": "#/components/schemas/DesignId"
386
+ }
387
+ },
388
+ {
389
+ "in": "query",
390
+ "name": "orgId",
391
+ "required": false,
392
+ "schema": {
393
+ "type": "string"
394
+ },
395
+ "description": "Organization id of the user"
396
+ },
397
+ {
398
+ "in": "query",
399
+ "name": "theme",
400
+ "required": true,
401
+ "schema": {
402
+ "$ref": "#/components/schemas/Theme"
403
+ }
404
+ }
405
+ ],
406
+ "responses": {
407
+ "200": {
408
+ "description": "Success - design parsed with success.",
409
+ "content": {
410
+ "application/json": {
411
+ "schema": {
412
+ "$ref": "#/components/schemas/ParseThemeFromDesignResp"
413
+ }
414
+ }
415
+ }
416
+ },
417
+ "400": {
418
+ "description": "Validation Errors",
419
+ "content": {
420
+ "application/json": {
421
+ "schema": {
422
+ "$ref": "#/components/schemas/ErrorResp"
423
+ }
424
+ }
425
+ }
426
+ },
427
+ "401": {
428
+ "description": "Authentication Errors",
429
+ "content": {
430
+ "application/json": {
431
+ "schema": {
432
+ "$ref": "#/components/schemas/ErrorResp"
433
+ }
434
+ }
435
+ }
436
+ },
437
+ "404": {
438
+ "description": "No design found"
439
+ },
440
+ "500": {
441
+ "description": "Other errors",
442
+ "content": {
443
+ "application/json": {
444
+ "schema": {
445
+ "$ref": "#/components/schemas/ErrorResp"
446
+ }
447
+ }
448
+ }
449
+ }
450
+ }
451
+ }
452
+ },
453
+ "/v1/designs/files": {
454
+ "post": {
455
+ "operationId": "uploadFile",
456
+ "summary": "uploadFile",
457
+ "description": "Upload a new file for the user organization bucket",
458
+ "tags": [
459
+ "design-builder"
460
+ ],
461
+ "requestBody": {
462
+ "description": "Upload file payload",
463
+ "required": true,
464
+ "content": {
465
+ "multipart/form-data": {
466
+ "schema": {
467
+ "$ref": "#/components/schemas/UploadFileReq"
468
+ },
469
+ "encoding": {
470
+ "file_data": {
471
+ "contentType": "image/*, application/x-font-ttf, application/x-font-opentype, application/font-woff, application/font-woff2"
472
+ }
473
+ }
474
+ }
475
+ }
476
+ },
477
+ "responses": {
478
+ "201": {
479
+ "description": "Success - upload with success.",
480
+ "content": {
481
+ "application/json": {
482
+ "schema": {
483
+ "$ref": "#/components/schemas/UploadFileRes"
484
+ }
485
+ }
486
+ }
487
+ },
488
+ "400": {
489
+ "description": "Validation Errors",
490
+ "content": {
491
+ "application/json": {
492
+ "schema": {
493
+ "$ref": "#/components/schemas/ErrorResp"
494
+ }
495
+ }
496
+ }
497
+ },
498
+ "401": {
499
+ "description": "Authentication Errors",
500
+ "content": {
501
+ "application/json": {
502
+ "schema": {
503
+ "$ref": "#/components/schemas/ErrorResp"
504
+ }
505
+ }
506
+ }
507
+ },
508
+ "500": {
509
+ "description": "Other errors",
510
+ "content": {
511
+ "application/json": {
512
+ "schema": {
513
+ "$ref": "#/components/schemas/ErrorResp"
514
+ }
515
+ }
516
+ }
517
+ }
518
+ }
519
+ },
520
+ "get": {
521
+ "operationId": "getFiles",
522
+ "summary": "getFiles",
523
+ "description": "List all files for the user organization bucket",
524
+ "tags": [
525
+ "design-builder"
526
+ ],
527
+ "parameters": [
528
+ {
529
+ "in": "query",
530
+ "name": "type",
531
+ "schema": {
532
+ "type": "string",
533
+ "enum": [
534
+ "LOGO",
535
+ "FONT",
536
+ "IMAGE"
537
+ ]
538
+ },
539
+ "required": false,
540
+ "description": "Type of files to be returned",
541
+ "example": "LOGO"
542
+ }
543
+ ],
544
+ "responses": {
545
+ "200": {
546
+ "description": "Success - files loaded with success.",
547
+ "content": {
548
+ "application/json": {
549
+ "schema": {
550
+ "$ref": "#/components/schemas/GetFilesRes"
551
+ }
552
+ }
553
+ }
554
+ },
555
+ "400": {
556
+ "description": "Validation Errors",
557
+ "content": {
558
+ "application/json": {
559
+ "schema": {
560
+ "$ref": "#/components/schemas/ErrorResp"
561
+ }
562
+ }
563
+ }
564
+ },
565
+ "401": {
566
+ "description": "Authentication Errors",
567
+ "content": {
568
+ "application/json": {
569
+ "schema": {
570
+ "$ref": "#/components/schemas/ErrorResp"
571
+ }
572
+ }
573
+ }
574
+ },
575
+ "500": {
576
+ "description": "Other errors",
577
+ "content": {
578
+ "application/json": {
579
+ "schema": {
580
+ "$ref": "#/components/schemas/ErrorResp"
581
+ }
582
+ }
583
+ }
584
+ }
585
+ }
586
+ }
587
+ },
588
+ "/v1/designs/limit": {
589
+ "get": {
590
+ "deprecated": true,
591
+ "operationId": "getLimit",
592
+ "summary": "getLimit",
593
+ "description": "Gets designs number limit from database per organization",
594
+ "tags": [
595
+ "design-builder"
596
+ ],
597
+ "responses": {
598
+ "200": {
599
+ "description": "Success - limit loaded with success.",
600
+ "content": {
601
+ "application/json": {
602
+ "schema": {
603
+ "type": "number"
604
+ }
605
+ }
606
+ }
607
+ },
608
+ "500": {
609
+ "description": "Other errors",
610
+ "content": {
611
+ "application/json": {
612
+ "schema": {
613
+ "$ref": "#/components/schemas/ErrorResp"
614
+ }
615
+ }
616
+ }
617
+ }
618
+ }
619
+ }
620
+ },
621
+ "/v1/brands": {
622
+ "get": {
623
+ "deprecated": true,
624
+ "operationId": "getBrands",
625
+ "summary": "getBrands",
626
+ "description": "Scan all brands linked to a organization, based in orgId attribute from JWT auth token",
627
+ "tags": [
628
+ "design-builder"
629
+ ],
630
+ "responses": {
631
+ "200": {
632
+ "description": "Success - brands loaded with success. Empty array if org has no designs.",
633
+ "content": {
634
+ "application/json": {
635
+ "schema": {
636
+ "type": "array",
637
+ "items": {
638
+ "$ref": "#/components/schemas/GetBrandsRes"
639
+ }
640
+ }
641
+ }
642
+ }
643
+ },
644
+ "500": {
645
+ "description": "Other errors",
646
+ "content": {
647
+ "application/json": {
648
+ "schema": {
649
+ "$ref": "#/components/schemas/ErrorResp"
650
+ }
651
+ }
652
+ }
653
+ }
654
+ }
655
+ }
656
+ },
657
+ "/v1/designs/consumer/{application}/{consumerId}": {
658
+ "get": {
659
+ "operationId": "getConsumerDesign",
660
+ "summary": "getConsumerDesign",
661
+ "description": "Search for a especific design owned by user organization",
662
+ "tags": [
663
+ "design-builder"
664
+ ],
665
+ "parameters": [
666
+ {
667
+ "in": "path",
668
+ "name": "consumerId",
669
+ "required": true,
670
+ "schema": {
671
+ "$ref": "#/components/schemas/DesignId"
672
+ }
673
+ },
674
+ {
675
+ "in": "path",
676
+ "name": "application",
677
+ "required": true,
678
+ "schema": {
679
+ "$ref": "#/components/schemas/Application"
680
+ }
681
+ }
682
+ ],
683
+ "responses": {
684
+ "200": {
685
+ "description": "Success - design loaded with success.",
686
+ "content": {
687
+ "application/json": {
688
+ "schema": {
689
+ "$ref": "#/components/schemas/GetDesignRes"
690
+ }
691
+ }
692
+ }
693
+ },
694
+ "400": {
695
+ "description": "Validation Errors",
696
+ "content": {
697
+ "application/json": {
698
+ "schema": {
699
+ "$ref": "#/components/schemas/ErrorResp"
700
+ }
701
+ }
702
+ }
703
+ },
704
+ "401": {
705
+ "description": "Authentication Errors",
706
+ "content": {
707
+ "application/json": {
708
+ "schema": {
709
+ "$ref": "#/components/schemas/ErrorResp"
710
+ }
711
+ }
712
+ }
713
+ },
714
+ "404": {
715
+ "description": "No design found"
716
+ },
717
+ "500": {
718
+ "description": "Other errors",
719
+ "content": {
720
+ "application/json": {
721
+ "schema": {
722
+ "$ref": "#/components/schemas/ErrorResp"
723
+ }
724
+ }
725
+ }
726
+ }
727
+ }
728
+ }
729
+ },
730
+ "/v1/designs/addConsumer/{application}/{designId}": {
731
+ "put": {
732
+ "operationId": "addConsumer",
733
+ "summary": "addConsumer",
734
+ "description": "Add a consumer that uses a specific design",
735
+ "tags": [
736
+ "design-builder"
737
+ ],
738
+ "parameters": [
739
+ {
740
+ "in": "path",
741
+ "name": "designId",
742
+ "required": true,
743
+ "schema": {
744
+ "$ref": "#/components/schemas/DesignId"
745
+ }
746
+ },
747
+ {
748
+ "in": "path",
749
+ "name": "application",
750
+ "schema": {
751
+ "type": "string"
752
+ },
753
+ "required": true,
754
+ "description": "Type of application that uses the design",
755
+ "example": "journey"
756
+ }
757
+ ],
758
+ "requestBody": {
759
+ "description": "widget id payload",
760
+ "required": true,
761
+ "content": {
762
+ "application/json": {
763
+ "schema": {
764
+ "$ref": "#/components/schemas/AddConsumerReq"
765
+ }
766
+ }
767
+ }
768
+ },
769
+ "responses": {
770
+ "204": {
771
+ "description": "Success - design updated with success."
772
+ },
773
+ "400": {
774
+ "description": "Validation Errors",
775
+ "content": {
776
+ "application/json": {
777
+ "schema": {
778
+ "$ref": "#/components/schemas/ErrorResp"
779
+ }
780
+ }
781
+ }
782
+ },
783
+ "401": {
784
+ "description": "Authentication Errors",
785
+ "content": {
786
+ "application/json": {
787
+ "schema": {
788
+ "$ref": "#/components/schemas/ErrorResp"
789
+ }
790
+ }
791
+ }
792
+ },
793
+ "404": {
794
+ "description": "No design found"
795
+ },
796
+ "500": {
797
+ "description": "Other errors",
798
+ "content": {
799
+ "application/json": {
800
+ "schema": {
801
+ "$ref": "#/components/schemas/ErrorResp"
802
+ }
803
+ }
804
+ }
805
+ }
806
+ }
807
+ }
808
+ },
809
+ "/v1/designs/removeConsumer/{application}/{designId}": {
810
+ "put": {
811
+ "operationId": "removeConsumer",
812
+ "summary": "removeConsumer",
813
+ "description": "Remove a consumer that uses a specific design",
814
+ "tags": [
815
+ "design-builder"
816
+ ],
817
+ "parameters": [
818
+ {
819
+ "in": "path",
820
+ "name": "designId",
821
+ "required": true,
822
+ "schema": {
823
+ "$ref": "#/components/schemas/DesignId"
824
+ }
825
+ },
826
+ {
827
+ "in": "path",
828
+ "name": "application",
829
+ "schema": {
830
+ "type": "string"
831
+ },
832
+ "required": true,
833
+ "description": "Type of application that uses the design",
834
+ "example": "journey"
835
+ }
836
+ ],
837
+ "requestBody": {
838
+ "description": "widget id payload",
839
+ "required": true,
840
+ "content": {
841
+ "application/json": {
842
+ "schema": {
843
+ "$ref": "#/components/schemas/RemoveConsumerReq"
844
+ }
845
+ }
846
+ }
847
+ },
848
+ "responses": {
849
+ "204": {
850
+ "description": "Success - design updated with success."
851
+ },
852
+ "400": {
853
+ "description": "Validation Errors",
854
+ "content": {
855
+ "application/json": {
856
+ "schema": {
857
+ "$ref": "#/components/schemas/ErrorResp"
858
+ }
859
+ }
860
+ }
861
+ },
862
+ "401": {
863
+ "description": "Authentication Errors",
864
+ "content": {
865
+ "application/json": {
866
+ "schema": {
867
+ "$ref": "#/components/schemas/ErrorResp"
868
+ }
869
+ }
870
+ }
871
+ },
872
+ "404": {
873
+ "description": "No design found"
874
+ },
875
+ "500": {
876
+ "description": "Other errors",
877
+ "content": {
878
+ "application/json": {
879
+ "schema": {
880
+ "$ref": "#/components/schemas/ErrorResp"
881
+ }
882
+ }
883
+ }
884
+ }
885
+ }
886
+ }
887
+ }
888
+ },
889
+ "components": {
890
+ "securitySchemes": {
891
+ "custom_authorizer": {
892
+ "type": "http",
893
+ "scheme": "bearer",
894
+ "bearerFormat": "JWT"
895
+ }
896
+ },
897
+ "schemas": {
898
+ "UploadFileReq": {
899
+ "type": "object",
900
+ "properties": {
901
+ "file_type": {
902
+ "type": "string",
903
+ "enum": [
904
+ "LOGO",
905
+ "FONT",
906
+ "IMAGE"
907
+ ]
908
+ },
909
+ "file_data": {
910
+ "type": "string",
911
+ "format": "base64"
912
+ },
913
+ "display_name": {
914
+ "type": "string"
915
+ },
916
+ "file_name": {
917
+ "type": "string"
918
+ }
919
+ },
920
+ "required": [
921
+ "file_type",
922
+ "file_name",
923
+ "file_data"
924
+ ]
925
+ },
926
+ "UploadFileRes": {
927
+ "type": "object",
928
+ "allOf": [
929
+ {
930
+ "$ref": "#/components/schemas/FileData"
931
+ }
932
+ ]
933
+ },
934
+ "GetFilesRes": {
935
+ "type": "array",
936
+ "items": {
937
+ "allOf": [
938
+ {
939
+ "$ref": "#/components/schemas/FileData"
940
+ }
941
+ ]
942
+ }
943
+ },
944
+ "GetAllDesignsRes": {
945
+ "type": "object",
946
+ "properties": {
947
+ "designs": {
948
+ "type": "array",
949
+ "items": {
950
+ "allOf": [
951
+ {
952
+ "$ref": "#/components/schemas/ItemMetada"
953
+ },
954
+ {
955
+ "$ref": "#/components/schemas/DesignItem"
956
+ },
957
+ {
958
+ "$ref": "#/components/schemas/Custom_Style"
959
+ },
960
+ {
961
+ "$ref": "#/components/schemas/Journey"
962
+ }
963
+ ]
964
+ }
965
+ }
966
+ }
967
+ },
968
+ "GetBrandsRes": {
969
+ "type": "object",
970
+ "properties": {
971
+ "brands": {
972
+ "type": "array",
973
+ "items": {
974
+ "allOf": [
975
+ {
976
+ "$ref": "#/components/schemas/BrandItem"
977
+ }
978
+ ]
979
+ }
980
+ }
981
+ }
982
+ },
983
+ "AddDesignReq": {
984
+ "type": "object",
985
+ "properties": {
986
+ "design": {
987
+ "allOf": [
988
+ {
989
+ "$ref": "#/components/schemas/DesignItem"
990
+ },
991
+ {
992
+ "$ref": "#/components/schemas/Custom_Style"
993
+ },
994
+ {
995
+ "$ref": "#/components/schemas/Journey"
996
+ }
997
+ ]
998
+ }
999
+ },
1000
+ "required": [
1001
+ "design"
1002
+ ]
1003
+ },
1004
+ "AddDesignRes": {
1005
+ "type": "object",
1006
+ "properties": {
1007
+ "design": {
1008
+ "allOf": [
1009
+ {
1010
+ "$ref": "#/components/schemas/ItemMetada"
1011
+ },
1012
+ {
1013
+ "$ref": "#/components/schemas/DesignItem"
1014
+ },
1015
+ {
1016
+ "$ref": "#/components/schemas/Custom_Style"
1017
+ },
1018
+ {
1019
+ "$ref": "#/components/schemas/Journey"
1020
+ }
1021
+ ]
1022
+ }
1023
+ }
1024
+ },
1025
+ "GetDesignRes": {
1026
+ "type": "object",
1027
+ "properties": {
1028
+ "design": {
1029
+ "allOf": [
1030
+ {
1031
+ "$ref": "#/components/schemas/ItemMetada"
1032
+ },
1033
+ {
1034
+ "$ref": "#/components/schemas/DesignItem"
1035
+ },
1036
+ {
1037
+ "$ref": "#/components/schemas/Custom_Style"
1038
+ },
1039
+ {
1040
+ "$ref": "#/components/schemas/Journey"
1041
+ }
1042
+ ]
1043
+ }
1044
+ }
1045
+ },
1046
+ "UpdateDesignReq": {
1047
+ "type": "object",
1048
+ "properties": {
1049
+ "design": {
1050
+ "allOf": [
1051
+ {
1052
+ "$ref": "#/components/schemas/DesignItem"
1053
+ },
1054
+ {
1055
+ "$ref": "#/components/schemas/Custom_Style"
1056
+ },
1057
+ {
1058
+ "$ref": "#/components/schemas/Journey"
1059
+ }
1060
+ ]
1061
+ }
1062
+ },
1063
+ "required": [
1064
+ "design"
1065
+ ]
1066
+ },
1067
+ "ItemMetada": {
1068
+ "type": "object",
1069
+ "properties": {
1070
+ "id": {
1071
+ "type": "string"
1072
+ },
1073
+ "created_at": {
1074
+ "type": "string",
1075
+ "description": "Creation date and time",
1076
+ "example": "2021-01-30T08:30:00Z"
1077
+ },
1078
+ "created_by": {
1079
+ "type": "string"
1080
+ },
1081
+ "edited": {
1082
+ "type": "boolean"
1083
+ },
1084
+ "last_modified_at": {
1085
+ "type": "string"
1086
+ }
1087
+ }
1088
+ },
1089
+ "AddConsumerReq": {
1090
+ "type": "object",
1091
+ "properties": {
1092
+ "consumer_id": {
1093
+ "$ref": "#/components/schemas/DesignId"
1094
+ },
1095
+ "consumer_name": {
1096
+ "type": "string"
1097
+ },
1098
+ "should_delete": {
1099
+ "type": "string"
1100
+ }
1101
+ },
1102
+ "required": [
1103
+ "consumer_id",
1104
+ "consumer_name"
1105
+ ]
1106
+ },
1107
+ "RemoveConsumerReq": {
1108
+ "type": "object",
1109
+ "properties": {
1110
+ "consumer_id": {
1111
+ "$ref": "#/components/schemas/DesignId"
1112
+ },
1113
+ "should_delete": {
1114
+ "type": "string",
1115
+ "deprecated": true
1116
+ }
1117
+ },
1118
+ "required": [
1119
+ "consumer_id"
1120
+ ]
1121
+ },
1122
+ "DesignItem": {
1123
+ "type": "object",
1124
+ "properties": {
1125
+ "brand_id": {
1126
+ "type": "string"
1127
+ },
1128
+ "brand_name": {
1129
+ "type": "string"
1130
+ },
1131
+ "user": {
1132
+ "type": "object",
1133
+ "properties": {
1134
+ "emailaddress": {
1135
+ "type": "string"
1136
+ },
1137
+ "fullname": {
1138
+ "type": "string"
1139
+ },
1140
+ "name": {
1141
+ "type": "string"
1142
+ },
1143
+ "userid": {
1144
+ "type": "string"
1145
+ }
1146
+ }
1147
+ },
1148
+ "style_name": {
1149
+ "type": "string"
1150
+ },
1151
+ "style": {
1152
+ "type": "object",
1153
+ "properties": {
1154
+ "logo": {
1155
+ "type": "object",
1156
+ "$ref": "#/components/schemas/LogoData"
1157
+ },
1158
+ "palette": {
1159
+ "type": "object",
1160
+ "$ref": "#/components/schemas/PaletteData"
1161
+ },
1162
+ "typography": {
1163
+ "type": "object",
1164
+ "$ref": "#/components/schemas/TypographyData"
1165
+ },
1166
+ "shape": {
1167
+ "type": "object",
1168
+ "$ref": "#/components/schemas/ShapeData"
1169
+ },
1170
+ "consumer": {
1171
+ "type": "object",
1172
+ "$ref": "#/components/schemas/ConsumerData"
1173
+ }
1174
+ },
1175
+ "required": [
1176
+ "palette",
1177
+ "typography",
1178
+ "consumer"
1179
+ ]
1180
+ },
1181
+ "is_default": {
1182
+ "type": "boolean"
1183
+ },
1184
+ "_manifest": {
1185
+ "type": "array",
1186
+ "description": "The manifest IDs associated with this design",
1187
+ "items": {
1188
+ "type": "string"
1189
+ }
1190
+ }
1191
+ },
1192
+ "required": [
1193
+ "style_name",
1194
+ "status",
1195
+ "edited",
1196
+ "style"
1197
+ ]
1198
+ },
1199
+ "BrandItem": {
1200
+ "type": "object",
1201
+ "properties": {
1202
+ "id": {
1203
+ "type": "string"
1204
+ },
1205
+ "name": {
1206
+ "type": "string"
1207
+ },
1208
+ "created_by": {
1209
+ "type": "string"
1210
+ },
1211
+ "created_date": {
1212
+ "type": "string"
1213
+ },
1214
+ "main_brand": {
1215
+ "type": "string"
1216
+ },
1217
+ "organization_id": {
1218
+ "type": "string"
1219
+ },
1220
+ "updated_date": {
1221
+ "type": "string"
1222
+ },
1223
+ "updated_by": {
1224
+ "type": "string"
1225
+ },
1226
+ "status": {
1227
+ "type": "string"
1228
+ }
1229
+ },
1230
+ "required": [
1231
+ "id",
1232
+ "name"
1233
+ ]
1234
+ },
1235
+ "Custom_Style": {
1236
+ "type": "object",
1237
+ "properties": {
1238
+ "custom_theme": {
1239
+ "type": "string"
1240
+ },
1241
+ "use_custom_theme": {
1242
+ "type": "boolean"
1243
+ }
1244
+ }
1245
+ },
1246
+ "Journey": {
1247
+ "type": "object",
1248
+ "properties": {
1249
+ "design_tokens": {
1250
+ "type": "object",
1251
+ "description": "Design tokens for journey customization",
1252
+ "properties": {
1253
+ "coupon": {
1254
+ "type": "string"
1255
+ },
1256
+ "cashback": {
1257
+ "type": "string"
1258
+ },
1259
+ "custom_css": {
1260
+ "type": "string"
1261
+ },
1262
+ "accent_color": {
1263
+ "type": "string",
1264
+ "description": "Accent color, defaults to primary"
1265
+ },
1266
+ "outline_color": {
1267
+ "type": "string",
1268
+ "description": "Global outline/focus color"
1269
+ },
1270
+ "divider_color": {
1271
+ "type": "string",
1272
+ "description": "Divider line color"
1273
+ },
1274
+ "link_color": {
1275
+ "type": "string",
1276
+ "description": "Link text color"
1277
+ },
1278
+ "link_hover_color": {
1279
+ "type": "string",
1280
+ "description": "Link hover text color"
1281
+ },
1282
+ "font_size_scale": {
1283
+ "type": "string",
1284
+ "description": "Font size scale factor",
1285
+ "enum": [
1286
+ "xs",
1287
+ "sm",
1288
+ "md",
1289
+ "lg",
1290
+ "xl"
1291
+ ]
1292
+ },
1293
+ "topbar_height": {
1294
+ "type": "number",
1295
+ "description": "Topbar minimum height in pixels"
1296
+ },
1297
+ "topbar_logo_alignment": {
1298
+ "type": "string",
1299
+ "description": "Logo/content alignment in the top bar",
1300
+ "enum": [
1301
+ "flex-start",
1302
+ "center",
1303
+ "flex-end"
1304
+ ]
1305
+ },
1306
+ "logo_size": {
1307
+ "type": "number",
1308
+ "description": "Logo size in pixels"
1309
+ },
1310
+ "input_background": {
1311
+ "type": "string",
1312
+ "description": "Input field background color"
1313
+ },
1314
+ "input_border_color": {
1315
+ "type": "string",
1316
+ "description": "Input field border color"
1317
+ },
1318
+ "input_text_color": {
1319
+ "type": "string",
1320
+ "description": "Input field text color"
1321
+ },
1322
+ "input_label_color": {
1323
+ "type": "string",
1324
+ "description": "Input field label color"
1325
+ },
1326
+ "input_border_radius": {
1327
+ "type": "number",
1328
+ "description": "Input field border radius in pixels"
1329
+ },
1330
+ "input_height": {
1331
+ "type": "number",
1332
+ "description": "Input field height in pixels"
1333
+ },
1334
+ "input_variant": {
1335
+ "type": "string",
1336
+ "description": "Input field variant style",
1337
+ "enum": [
1338
+ "outlined",
1339
+ "filled",
1340
+ "underlined"
1341
+ ]
1342
+ },
1343
+ "button_primary_bg": {
1344
+ "type": "string",
1345
+ "description": "Primary button background color or gradient"
1346
+ },
1347
+ "button_primary_text": {
1348
+ "type": "string",
1349
+ "description": "Primary button text color"
1350
+ },
1351
+ "button_primary_hover_bg": {
1352
+ "type": "string",
1353
+ "description": "Primary button hover background color or gradient"
1354
+ },
1355
+ "button_primary_hover_text": {
1356
+ "type": "string",
1357
+ "description": "Primary button hover text color"
1358
+ },
1359
+ "button_outlined_border": {
1360
+ "type": "string",
1361
+ "description": "Outlined button border color"
1362
+ },
1363
+ "button_outlined_text": {
1364
+ "type": "string",
1365
+ "description": "Outlined button text color"
1366
+ },
1367
+ "button_outlined_hover_bg": {
1368
+ "type": "string",
1369
+ "description": "Outlined button hover background color"
1370
+ },
1371
+ "button_outlined_hover_text": {
1372
+ "type": "string",
1373
+ "description": "Outlined button hover text color"
1374
+ },
1375
+ "button_ghost_bg": {
1376
+ "type": "string",
1377
+ "description": "Ghost button background color"
1378
+ },
1379
+ "button_ghost_text": {
1380
+ "type": "string",
1381
+ "description": "Ghost button text color"
1382
+ },
1383
+ "button_ghost_hover_bg": {
1384
+ "type": "string",
1385
+ "description": "Ghost button hover background color"
1386
+ },
1387
+ "button_ghost_hover_text": {
1388
+ "type": "string",
1389
+ "description": "Ghost button hover text color"
1390
+ },
1391
+ "button_border_radius": {
1392
+ "type": "number",
1393
+ "description": "Button border radius in pixels"
1394
+ },
1395
+ "button_height": {
1396
+ "type": "number",
1397
+ "description": "Button height in pixels"
1398
+ },
1399
+ "card_background": {
1400
+ "type": "string",
1401
+ "description": "Card background color"
1402
+ },
1403
+ "card_border_color": {
1404
+ "type": "string",
1405
+ "description": "Card border color for outlined variant"
1406
+ },
1407
+ "card_variant": {
1408
+ "type": "string",
1409
+ "description": "Card visual variant",
1410
+ "enum": [
1411
+ "shadow",
1412
+ "outlined"
1413
+ ]
1414
+ },
1415
+ "summary_card_background": {
1416
+ "type": "string",
1417
+ "description": "Summary card background color"
1418
+ },
1419
+ "toggle_selected_bg": {
1420
+ "type": "string",
1421
+ "description": "Toggle button selected background color"
1422
+ },
1423
+ "toggle_selected_text": {
1424
+ "type": "string",
1425
+ "description": "Toggle button selected text color"
1426
+ },
1427
+ "toggle_hover_bg": {
1428
+ "type": "string",
1429
+ "description": "Toggle button hover background color"
1430
+ },
1431
+ "toggle_hover_text": {
1432
+ "type": "string",
1433
+ "description": "Toggle button hover text color"
1434
+ },
1435
+ "toggle_border_color": {
1436
+ "type": "string",
1437
+ "description": "Toggle group wrapper border color"
1438
+ },
1439
+ "dropdown_hover_bg": {
1440
+ "type": "string",
1441
+ "description": "Dropdown option hover background color"
1442
+ },
1443
+ "dropdown_hover_text": {
1444
+ "type": "string",
1445
+ "description": "Dropdown option hover text color"
1446
+ },
1447
+ "dropdown_selected_bg": {
1448
+ "type": "string",
1449
+ "description": "Dropdown option selected background color"
1450
+ },
1451
+ "dropdown_selected_text": {
1452
+ "type": "string",
1453
+ "description": "Dropdown option selected text color"
1454
+ },
1455
+ "switch_unchecked_color": {
1456
+ "type": "string",
1457
+ "description": "Switch unchecked thumb color"
1458
+ },
1459
+ "switch_unchecked_bg": {
1460
+ "type": "string",
1461
+ "description": "Switch unchecked track background color"
1462
+ },
1463
+ "switch_border_radius": {
1464
+ "type": "number",
1465
+ "description": "Switch border radius in pixels"
1466
+ },
1467
+ "checkbox_unchecked_color": {
1468
+ "type": "string",
1469
+ "description": "Checkbox unchecked border color"
1470
+ },
1471
+ "checkbox_label_color": {
1472
+ "type": "string",
1473
+ "description": "Checkbox label text color"
1474
+ },
1475
+ "radio_unchecked_color": {
1476
+ "type": "string",
1477
+ "description": "Radio button unchecked border color"
1478
+ },
1479
+ "radio_label_color": {
1480
+ "type": "string",
1481
+ "description": "Radio button label text color"
1482
+ },
1483
+ "datepicker_selected_bg": {
1484
+ "type": "string",
1485
+ "description": "Date picker selected date background color"
1486
+ },
1487
+ "datepicker_selected_color": {
1488
+ "type": "string",
1489
+ "description": "Date picker selected date text color"
1490
+ },
1491
+ "datepicker_border_radius": {
1492
+ "type": "number",
1493
+ "description": "Date picker border radius in pixels"
1494
+ },
1495
+ "chip_background": {
1496
+ "type": "string",
1497
+ "description": "Chip background color"
1498
+ },
1499
+ "chip_hover_background": {
1500
+ "type": "string",
1501
+ "description": "Chip hover background color"
1502
+ },
1503
+ "chip_text_color": {
1504
+ "type": "string",
1505
+ "description": "Chip text color"
1506
+ },
1507
+ "chip_hover_text_color": {
1508
+ "type": "string",
1509
+ "description": "Chip hover text color"
1510
+ }
1511
+ }
1512
+ }
1513
+ }
1514
+ },
1515
+ "ConsumerData": {
1516
+ "type": "object",
1517
+ "properties": {
1518
+ "widgets": {
1519
+ "type": "array",
1520
+ "items": {
1521
+ "anyOf": [
1522
+ {
1523
+ "$ref": "#/components/schemas/WidgetData"
1524
+ }
1525
+ ]
1526
+ }
1527
+ },
1528
+ "customer_portals": {
1529
+ "type": "array",
1530
+ "items": {
1531
+ "anyOf": [
1532
+ {
1533
+ "$ref": "#/components/schemas/CustomerPortalData"
1534
+ }
1535
+ ]
1536
+ }
1537
+ }
1538
+ },
1539
+ "required": [
1540
+ "widgets",
1541
+ "customer_portals"
1542
+ ]
1543
+ },
1544
+ "WidgetData": {
1545
+ "allOf": [
1546
+ {
1547
+ "$ref": "#/components/schemas/WidgetPortalData"
1548
+ }
1549
+ ]
1550
+ },
1551
+ "CustomerPortalData": {
1552
+ "allOf": [
1553
+ {
1554
+ "$ref": "#/components/schemas/WidgetPortalData"
1555
+ }
1556
+ ]
1557
+ },
1558
+ "LogoData": {
1559
+ "type": "object",
1560
+ "properties": {
1561
+ "main": {
1562
+ "type": "object",
1563
+ "$ref": "#/components/schemas/FileData"
1564
+ }
1565
+ }
1566
+ },
1567
+ "PaletteData": {
1568
+ "type": "object",
1569
+ "properties": {
1570
+ "primary": {
1571
+ "type": "string"
1572
+ },
1573
+ "secondary": {
1574
+ "type": "string"
1575
+ },
1576
+ "error": {
1577
+ "type": "string"
1578
+ },
1579
+ "background": {
1580
+ "type": "string"
1581
+ },
1582
+ "paper": {
1583
+ "type": "string"
1584
+ },
1585
+ "navbar": {
1586
+ "type": "string"
1587
+ },
1588
+ "portal_login_background": {
1589
+ "type": "string"
1590
+ }
1591
+ },
1592
+ "required": [
1593
+ "primary",
1594
+ "secondary",
1595
+ "error",
1596
+ "background",
1597
+ "paper",
1598
+ "navbar"
1599
+ ]
1600
+ },
1601
+ "TypographyData": {
1602
+ "type": "object",
1603
+ "properties": {
1604
+ "font": {
1605
+ "type": "object",
1606
+ "$ref": "#/components/schemas/FontData"
1607
+ },
1608
+ "primary": {
1609
+ "type": "string"
1610
+ },
1611
+ "secondary": {
1612
+ "type": "string"
1613
+ }
1614
+ },
1615
+ "required": [
1616
+ "font",
1617
+ "primary",
1618
+ "secondary"
1619
+ ]
1620
+ },
1621
+ "ShapeData": {
1622
+ "type": "object",
1623
+ "properties": {
1624
+ "border_radius": {
1625
+ "type": "number"
1626
+ }
1627
+ }
1628
+ },
1629
+ "FontData": {
1630
+ "type": "object",
1631
+ "properties": {
1632
+ "font_id": {
1633
+ "type": "string"
1634
+ },
1635
+ "font_name": {
1636
+ "type": "string"
1637
+ },
1638
+ "font_family": {
1639
+ "type": "string"
1640
+ },
1641
+ "font_weight_regular": {
1642
+ "type": "string"
1643
+ },
1644
+ "font_weight_medium": {
1645
+ "type": "string"
1646
+ },
1647
+ "font_weight_bold": {
1648
+ "type": "string"
1649
+ },
1650
+ "urls": {
1651
+ "type": "array",
1652
+ "items": {
1653
+ "anyOf": [
1654
+ {
1655
+ "$ref": "#/components/schemas/FontResponseUrl"
1656
+ }
1657
+ ]
1658
+ }
1659
+ }
1660
+ },
1661
+ "required": [
1662
+ "font_id",
1663
+ "font_name",
1664
+ "urls"
1665
+ ]
1666
+ },
1667
+ "FontResponseUrl": {
1668
+ "type": "object",
1669
+ "properties": {
1670
+ "type": {
1671
+ "type": "string",
1672
+ "enum": [
1673
+ "WOFF2",
1674
+ "WOFF",
1675
+ "TTF",
1676
+ "EOT"
1677
+ ]
1678
+ },
1679
+ "url": {
1680
+ "type": "string"
1681
+ }
1682
+ }
1683
+ },
1684
+ "WidgetPortalData": {
1685
+ "type": "object",
1686
+ "properties": {
1687
+ "id": {
1688
+ "type": "string"
1689
+ },
1690
+ "name": {
1691
+ "type": "string"
1692
+ }
1693
+ },
1694
+ "required": [
1695
+ "id",
1696
+ "name"
1697
+ ]
1698
+ },
1699
+ "ErrorResp": {
1700
+ "type": "object",
1701
+ "properties": {
1702
+ "message": {
1703
+ "type": "string"
1704
+ },
1705
+ "error": {
1706
+ "type": "object"
1707
+ }
1708
+ }
1709
+ },
1710
+ "FileData": {
1711
+ "type": "object",
1712
+ "properties": {
1713
+ "name": {
1714
+ "type": "string"
1715
+ },
1716
+ "display_name": {
1717
+ "type": "string"
1718
+ },
1719
+ "file_type": {
1720
+ "type": "string",
1721
+ "enum": [
1722
+ "LOGO",
1723
+ "FONT",
1724
+ "IMAGE"
1725
+ ]
1726
+ },
1727
+ "s3_object_key": {
1728
+ "type": "string"
1729
+ },
1730
+ "url": {
1731
+ "type": "string"
1732
+ },
1733
+ "file_id": {
1734
+ "type": "string",
1735
+ "description": "ID of the source file entity in the epilot file-entity system. Set when the file was picked from the File Manager (rather than uploaded directly to the design-builder bucket). Consumers resolve the live `public_url` via this reference. The org id is derived from the journey's owning org at render time (same convention as journey image blocks), so blueprint cross-org installs work without any extra remapping."
1736
+ }
1737
+ },
1738
+ "required": [
1739
+ "name",
1740
+ "s3_object_key",
1741
+ "url"
1742
+ ]
1743
+ },
1744
+ "DesignId": {
1745
+ "type": "string",
1746
+ "minLength": 36,
1747
+ "maxLength": 36,
1748
+ "description": "Id of the design",
1749
+ "example": "4a062990-a6a3-11eb-9828-4f3da7d4935a"
1750
+ },
1751
+ "Theme": {
1752
+ "type": "string",
1753
+ "enum": [
1754
+ "NEW",
1755
+ "OLD"
1756
+ ],
1757
+ "description": "Type of theme to be parsed and returned",
1758
+ "example": "NEW"
1759
+ },
1760
+ "Application": {
1761
+ "type": "string",
1762
+ "description": "Type of application that uses the design",
1763
+ "example": "journey"
1764
+ },
1765
+ "DesignParameters": {
1766
+ "type": "object",
1767
+ "properties": {
1768
+ "designId": {
1769
+ "$ref": "#/components/schemas/DesignId"
1770
+ },
1771
+ "theme": {
1772
+ "$ref": "#/components/schemas/Theme"
1773
+ },
1774
+ "application": {
1775
+ "$ref": "#/components/schemas/Application"
1776
+ }
1777
+ }
1778
+ },
1779
+ "ParseThemeFromDesignResp": {
1780
+ "type": "object",
1781
+ "properties": {
1782
+ "theme": {
1783
+ "$ref": "#/components/schemas/Theme"
1784
+ },
1785
+ "design": {
1786
+ "type": "object",
1787
+ "properties": {
1788
+ "id": {
1789
+ "type": "string"
1790
+ },
1791
+ "last_modified_at": {
1792
+ "type": "string"
1793
+ },
1794
+ "style_name": {
1795
+ "type": "string"
1796
+ },
1797
+ "style": {
1798
+ "type": "object",
1799
+ "properties": {
1800
+ "logo": {
1801
+ "$ref": "#/components/schemas/LogoData"
1802
+ },
1803
+ "palette": {
1804
+ "$ref": "#/components/schemas/PaletteData"
1805
+ },
1806
+ "typography": {
1807
+ "$ref": "#/components/schemas/TypographyData"
1808
+ }
1809
+ }
1810
+ },
1811
+ "custom_theme": {
1812
+ "type": "string"
1813
+ },
1814
+ "use_custom_theme": {
1815
+ "type": "boolean"
1816
+ },
1817
+ "journey_design_tokens": {
1818
+ "type": "object",
1819
+ "description": "Design tokens for journey customization (renamed from design_tokens)"
1820
+ }
1821
+ }
1822
+ }
1823
+ }
1824
+ }
1825
+ }
1826
+ }
1827
+ }