@epilot/sdk 2.3.7 → 2.3.9

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