@epilot/sdk 2.3.7-rc1 → 2.3.7

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 (135) hide show
  1. package/definitions/design.json +257 -4
  2. package/definitions/entity-runtime.json +1 -1
  3. package/definitions/entity.json +4 -354
  4. package/dist/apis/access-token.cjs +6 -6
  5. package/dist/apis/access-token.js +1 -1
  6. package/dist/apis/address-suggestions.cjs +6 -6
  7. package/dist/apis/address-suggestions.js +1 -1
  8. package/dist/apis/address.cjs +6 -6
  9. package/dist/apis/address.js +1 -1
  10. package/dist/apis/ai-agents.cjs +6 -6
  11. package/dist/apis/ai-agents.js +1 -1
  12. package/dist/apis/app.cjs +6 -6
  13. package/dist/apis/app.js +1 -1
  14. package/dist/apis/audit-logs.cjs +6 -6
  15. package/dist/apis/audit-logs.js +1 -1
  16. package/dist/apis/automation.cjs +6 -6
  17. package/dist/apis/automation.js +1 -1
  18. package/dist/apis/billing.cjs +6 -6
  19. package/dist/apis/billing.js +1 -1
  20. package/dist/apis/blueprint-manifest.cjs +6 -6
  21. package/dist/apis/blueprint-manifest.js +1 -1
  22. package/dist/apis/configuration-hub.cjs +6 -6
  23. package/dist/apis/configuration-hub.js +1 -1
  24. package/dist/apis/consent.cjs +6 -6
  25. package/dist/apis/consent.js +1 -1
  26. package/dist/apis/customer-portal.cjs +6 -6
  27. package/dist/apis/customer-portal.js +1 -1
  28. package/dist/apis/dashboard.cjs +6 -6
  29. package/dist/apis/dashboard.js +1 -1
  30. package/dist/apis/data-governance.cjs +6 -6
  31. package/dist/apis/data-governance.js +1 -1
  32. package/dist/apis/deduplication.cjs +6 -6
  33. package/dist/apis/deduplication.js +1 -1
  34. package/dist/apis/design.cjs +6 -6
  35. package/dist/apis/design.d.cts +2 -2
  36. package/dist/apis/design.d.ts +2 -2
  37. package/dist/apis/design.js +1 -1
  38. package/dist/apis/document.cjs +6 -6
  39. package/dist/apis/document.js +1 -1
  40. package/dist/apis/email-settings.cjs +6 -6
  41. package/dist/apis/email-settings.js +1 -1
  42. package/dist/apis/email-template.cjs +6 -6
  43. package/dist/apis/email-template.js +1 -1
  44. package/dist/apis/entity-mapping.cjs +6 -6
  45. package/dist/apis/entity-mapping.js +1 -1
  46. package/dist/apis/entity.cjs +8 -8
  47. package/dist/apis/entity.js +2 -2
  48. package/dist/apis/environments.cjs +6 -6
  49. package/dist/apis/environments.js +1 -1
  50. package/dist/apis/event-catalog.cjs +6 -6
  51. package/dist/apis/event-catalog.js +1 -1
  52. package/dist/apis/file.cjs +6 -6
  53. package/dist/apis/file.js +1 -1
  54. package/dist/apis/iban.cjs +6 -6
  55. package/dist/apis/iban.js +1 -1
  56. package/dist/apis/integration-toolkit.cjs +6 -6
  57. package/dist/apis/integration-toolkit.js +1 -1
  58. package/dist/apis/journey.cjs +6 -6
  59. package/dist/apis/journey.js +1 -1
  60. package/dist/apis/kanban.cjs +6 -6
  61. package/dist/apis/kanban.js +1 -1
  62. package/dist/apis/message.cjs +6 -6
  63. package/dist/apis/message.js +1 -1
  64. package/dist/apis/metering.cjs +6 -6
  65. package/dist/apis/metering.js +1 -1
  66. package/dist/apis/notes.cjs +6 -6
  67. package/dist/apis/notes.js +1 -1
  68. package/dist/apis/notification.cjs +6 -6
  69. package/dist/apis/notification.js +1 -1
  70. package/dist/apis/organization.cjs +6 -6
  71. package/dist/apis/organization.js +1 -1
  72. package/dist/apis/partner-directory.cjs +6 -6
  73. package/dist/apis/partner-directory.js +1 -1
  74. package/dist/apis/permissions.cjs +6 -6
  75. package/dist/apis/permissions.js +1 -1
  76. package/dist/apis/pricing-tier.cjs +6 -6
  77. package/dist/apis/pricing-tier.js +1 -1
  78. package/dist/apis/pricing.cjs +6 -6
  79. package/dist/apis/pricing.js +1 -1
  80. package/dist/apis/purpose.cjs +6 -6
  81. package/dist/apis/purpose.js +1 -1
  82. package/dist/apis/query.cjs +6 -6
  83. package/dist/apis/query.js +1 -1
  84. package/dist/apis/sandbox.cjs +6 -6
  85. package/dist/apis/sandbox.js +1 -1
  86. package/dist/apis/sharing.cjs +6 -6
  87. package/dist/apis/sharing.js +1 -1
  88. package/dist/apis/submission.cjs +6 -6
  89. package/dist/apis/submission.js +1 -1
  90. package/dist/apis/target.cjs +6 -6
  91. package/dist/apis/target.js +1 -1
  92. package/dist/apis/targeting.cjs +6 -6
  93. package/dist/apis/targeting.js +1 -1
  94. package/dist/apis/template-variables.cjs +6 -6
  95. package/dist/apis/template-variables.js +1 -1
  96. package/dist/apis/user.cjs +6 -6
  97. package/dist/apis/user.js +1 -1
  98. package/dist/apis/validation-rules.cjs +6 -6
  99. package/dist/apis/validation-rules.js +1 -1
  100. package/dist/apis/webhooks.cjs +6 -6
  101. package/dist/apis/webhooks.js +1 -1
  102. package/dist/apis/workflow-definition.cjs +6 -6
  103. package/dist/apis/workflow-definition.js +1 -1
  104. package/dist/apis/workflow.cjs +6 -6
  105. package/dist/apis/workflow.js +1 -1
  106. package/dist/bin/cli.js +1 -1
  107. package/dist/chunk-F7W62NKV.js +14 -0
  108. package/dist/{chunk-OU5NVIJW.js → chunk-KY7TIDRJ.js} +3 -3
  109. package/dist/{chunk-FCT6W5UM.cjs → chunk-NOYX4W47.cjs} +3 -3
  110. package/dist/chunk-QA2OYK7N.cjs +14 -0
  111. package/dist/design-DROLIWS3.js +7 -0
  112. package/dist/design-XZKOZLTR.cjs +7 -0
  113. package/dist/design.d-BRre8iLg.d.cts +2346 -0
  114. package/dist/design.d-BRre8iLg.d.ts +2346 -0
  115. package/dist/entity-CK76MXVN.js +7 -0
  116. package/dist/entity-TFMH5VTZ.cjs +7 -0
  117. package/dist/{entity-runtime-LNAZILIN.js → entity-runtime-D4DV5XRM.js} +1 -1
  118. package/dist/entity-runtime-DUJTRYLQ.cjs +5 -0
  119. package/dist/index.cjs +10 -10
  120. package/dist/index.d.cts +1 -1
  121. package/dist/index.d.ts +1 -1
  122. package/dist/index.js +2 -2
  123. package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
  124. package/docs/design.md +665 -341
  125. package/docs/entity.md +39 -965
  126. package/package.json +1 -1
  127. package/dist/chunk-M6Z6ES3I.js +0 -14
  128. package/dist/chunk-UBQCDPW6.cjs +0 -14
  129. package/dist/design-NISDHPFD.cjs +0 -7
  130. package/dist/design-WL4AZIGX.js +0 -7
  131. package/dist/design.d-DTo29S0F.d.cts +0 -960
  132. package/dist/design.d-DTo29S0F.d.ts +0 -960
  133. package/dist/entity-VDUN7SYC.cjs +0 -7
  134. package/dist/entity-WWM2Z7BU.js +0 -7
  135. package/dist/entity-runtime-3J5EDLXP.cjs +0 -5
@@ -1,960 +0,0 @@
1
- import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from design-client */
4
-
5
-
6
- declare namespace Components {
7
- namespace Schemas {
8
- export interface AddConsumerReq {
9
- consumer_id: /**
10
- * Id of the design
11
- * example:
12
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
13
- */
14
- DesignId;
15
- consumer_name: string;
16
- should_delete?: string;
17
- }
18
- export interface AddDesignReq {
19
- design: {
20
- brand_id?: string;
21
- brand_name?: string;
22
- user?: {
23
- emailaddress?: string;
24
- fullname?: string;
25
- name?: string;
26
- userid?: string;
27
- };
28
- style_name: string;
29
- style: {
30
- logo?: LogoData;
31
- palette: PaletteData;
32
- typography: TypographyData;
33
- shape?: ShapeData;
34
- consumer: ConsumerData;
35
- };
36
- is_default?: boolean;
37
- /**
38
- * The manifest IDs associated with this design
39
- */
40
- _manifest?: string[];
41
- custom_theme?: string;
42
- use_custom_theme?: boolean;
43
- design_tokens?: {
44
- coupon?: string;
45
- cashback?: string;
46
- custom_css?: string;
47
- };
48
- };
49
- }
50
- export interface AddDesignRes {
51
- design?: {
52
- id?: string;
53
- /**
54
- * Creation date and time
55
- * example:
56
- * 2021-01-30T08:30:00Z
57
- */
58
- created_at?: string;
59
- created_by?: string;
60
- edited: boolean;
61
- last_modified_at?: string;
62
- brand_id?: string;
63
- brand_name?: string;
64
- user?: {
65
- emailaddress?: string;
66
- fullname?: string;
67
- name?: string;
68
- userid?: string;
69
- };
70
- style_name: string;
71
- style: {
72
- logo?: LogoData;
73
- palette: PaletteData;
74
- typography: TypographyData;
75
- shape?: ShapeData;
76
- consumer: ConsumerData;
77
- };
78
- is_default?: boolean;
79
- /**
80
- * The manifest IDs associated with this design
81
- */
82
- _manifest?: string[];
83
- custom_theme?: string;
84
- use_custom_theme?: boolean;
85
- design_tokens?: {
86
- coupon?: string;
87
- cashback?: string;
88
- custom_css?: string;
89
- };
90
- };
91
- }
92
- /**
93
- * Type of application that uses the design
94
- * example:
95
- * journey
96
- */
97
- export type Application = string;
98
- export interface BrandItem {
99
- id: string;
100
- name: string;
101
- created_by?: string;
102
- created_date?: string;
103
- main_brand?: string;
104
- organization_id?: string;
105
- updated_date?: string;
106
- updated_by?: string;
107
- status?: string;
108
- }
109
- export interface ConsumerData {
110
- widgets: (WidgetData)[];
111
- customer_portals: (CustomerPortalData)[];
112
- }
113
- export interface CustomStyle {
114
- custom_theme?: string;
115
- use_custom_theme?: boolean;
116
- }
117
- export interface CustomerPortalData {
118
- id: string;
119
- name: string;
120
- }
121
- /**
122
- * Id of the design
123
- * example:
124
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
125
- */
126
- export type DesignId = string;
127
- export interface DesignItem {
128
- brand_id?: string;
129
- brand_name?: string;
130
- user?: {
131
- emailaddress?: string;
132
- fullname?: string;
133
- name?: string;
134
- userid?: string;
135
- };
136
- style_name: string;
137
- style: {
138
- logo?: LogoData;
139
- palette: PaletteData;
140
- typography: TypographyData;
141
- shape?: ShapeData;
142
- consumer: ConsumerData;
143
- };
144
- is_default?: boolean;
145
- /**
146
- * The manifest IDs associated with this design
147
- */
148
- _manifest?: string[];
149
- }
150
- export interface DesignParameters {
151
- designId?: /**
152
- * Id of the design
153
- * example:
154
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
155
- */
156
- DesignId;
157
- theme?: /**
158
- * Type of theme to be parsed and returned
159
- * example:
160
- * NEW
161
- */
162
- Theme;
163
- application?: /**
164
- * Type of application that uses the design
165
- * example:
166
- * journey
167
- */
168
- Application;
169
- }
170
- export interface ErrorResp {
171
- message?: string;
172
- error?: {
173
- [key: string]: any;
174
- };
175
- }
176
- export interface FileData {
177
- name: string;
178
- display_name?: string;
179
- file_type?: "LOGO" | "FONT";
180
- s3_object_key: string;
181
- url: string;
182
- }
183
- export interface FontData {
184
- font_id: string;
185
- font_name: string;
186
- font_family?: string;
187
- font_weight_regular?: string;
188
- font_weight_medium?: string;
189
- font_weight_bold?: string;
190
- urls: (FontResponseUrl)[];
191
- }
192
- export interface FontResponseUrl {
193
- type?: "WOFF2" | "WOFF" | "TTF" | "EOT";
194
- url?: string;
195
- }
196
- export interface GetAllDesignsRes {
197
- designs?: {
198
- id?: string;
199
- /**
200
- * Creation date and time
201
- * example:
202
- * 2021-01-30T08:30:00Z
203
- */
204
- created_at?: string;
205
- created_by?: string;
206
- edited: boolean;
207
- last_modified_at?: string;
208
- brand_id?: string;
209
- brand_name?: string;
210
- user?: {
211
- emailaddress?: string;
212
- fullname?: string;
213
- name?: string;
214
- userid?: string;
215
- };
216
- style_name: string;
217
- style: {
218
- logo?: LogoData;
219
- palette: PaletteData;
220
- typography: TypographyData;
221
- shape?: ShapeData;
222
- consumer: ConsumerData;
223
- };
224
- is_default?: boolean;
225
- /**
226
- * The manifest IDs associated with this design
227
- */
228
- _manifest?: string[];
229
- custom_theme?: string;
230
- use_custom_theme?: boolean;
231
- design_tokens?: {
232
- coupon?: string;
233
- cashback?: string;
234
- custom_css?: string;
235
- };
236
- }[];
237
- }
238
- export interface GetBrandsRes {
239
- brands?: {
240
- id: string;
241
- name: string;
242
- created_by?: string;
243
- created_date?: string;
244
- main_brand?: string;
245
- organization_id?: string;
246
- updated_date?: string;
247
- updated_by?: string;
248
- status?: string;
249
- }[];
250
- }
251
- export interface GetDesignRes {
252
- design?: {
253
- id?: string;
254
- /**
255
- * Creation date and time
256
- * example:
257
- * 2021-01-30T08:30:00Z
258
- */
259
- created_at?: string;
260
- created_by?: string;
261
- edited: boolean;
262
- last_modified_at?: string;
263
- brand_id?: string;
264
- brand_name?: string;
265
- user?: {
266
- emailaddress?: string;
267
- fullname?: string;
268
- name?: string;
269
- userid?: string;
270
- };
271
- style_name: string;
272
- style: {
273
- logo?: LogoData;
274
- palette: PaletteData;
275
- typography: TypographyData;
276
- shape?: ShapeData;
277
- consumer: ConsumerData;
278
- };
279
- is_default?: boolean;
280
- /**
281
- * The manifest IDs associated with this design
282
- */
283
- _manifest?: string[];
284
- custom_theme?: string;
285
- use_custom_theme?: boolean;
286
- design_tokens?: {
287
- coupon?: string;
288
- cashback?: string;
289
- custom_css?: string;
290
- };
291
- };
292
- }
293
- export type GetFilesRes = {
294
- name: string;
295
- display_name?: string;
296
- file_type?: "LOGO" | "FONT";
297
- s3_object_key: string;
298
- url: string;
299
- }[];
300
- export interface ItemMetada {
301
- id?: string;
302
- /**
303
- * Creation date and time
304
- * example:
305
- * 2021-01-30T08:30:00Z
306
- */
307
- created_at?: string;
308
- created_by?: string;
309
- edited?: boolean;
310
- last_modified_at?: string;
311
- }
312
- export interface Journey {
313
- design_tokens?: {
314
- coupon?: string;
315
- cashback?: string;
316
- custom_css?: string;
317
- };
318
- }
319
- export interface LogoData {
320
- main?: FileData;
321
- }
322
- export interface PaletteData {
323
- primary: string;
324
- secondary: string;
325
- error: string;
326
- background: string;
327
- paper: string;
328
- navbar: string;
329
- portal_login_background?: string;
330
- }
331
- export interface RemoveConsumerReq {
332
- consumer_id: /**
333
- * Id of the design
334
- * example:
335
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
336
- */
337
- DesignId;
338
- should_delete?: string;
339
- }
340
- export interface ShapeData {
341
- border_radius?: number;
342
- }
343
- /**
344
- * Type of theme to be parsed and returned
345
- * example:
346
- * NEW
347
- */
348
- export type Theme = "NEW" | "OLD";
349
- export interface TypographyData {
350
- font: FontData;
351
- primary: string;
352
- secondary: string;
353
- }
354
- export interface UpdateDesignReq {
355
- design: {
356
- brand_id?: string;
357
- brand_name?: string;
358
- user?: {
359
- emailaddress?: string;
360
- fullname?: string;
361
- name?: string;
362
- userid?: string;
363
- };
364
- style_name: string;
365
- style: {
366
- logo?: LogoData;
367
- palette: PaletteData;
368
- typography: TypographyData;
369
- shape?: ShapeData;
370
- consumer: ConsumerData;
371
- };
372
- is_default?: boolean;
373
- /**
374
- * The manifest IDs associated with this design
375
- */
376
- _manifest?: string[];
377
- custom_theme?: string;
378
- use_custom_theme?: boolean;
379
- design_tokens?: {
380
- coupon?: string;
381
- cashback?: string;
382
- custom_css?: string;
383
- };
384
- };
385
- }
386
- export interface UploadFileReq {
387
- file_type: "LOGO" | "FONT";
388
- file_data: string; // base64
389
- display_name?: string;
390
- file_name: string;
391
- }
392
- export interface UploadFileRes {
393
- name: string;
394
- display_name?: string;
395
- file_type?: "LOGO" | "FONT";
396
- s3_object_key: string;
397
- url: string;
398
- }
399
- export interface WidgetData {
400
- id: string;
401
- name: string;
402
- }
403
- export interface WidgetPortalData {
404
- id: string;
405
- name: string;
406
- }
407
- }
408
- }
409
- declare namespace Paths {
410
- namespace AddConsumer {
411
- namespace Parameters {
412
- export type Application = string;
413
- export type DesignId = /**
414
- * Id of the design
415
- * example:
416
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
417
- */
418
- Components.Schemas.DesignId;
419
- }
420
- export interface PathParameters {
421
- designId: Parameters.DesignId;
422
- application: Parameters.Application;
423
- }
424
- export type RequestBody = Components.Schemas.AddConsumerReq;
425
- namespace Responses {
426
- export interface $204 {
427
- }
428
- export type $400 = Components.Schemas.ErrorResp;
429
- export type $401 = Components.Schemas.ErrorResp;
430
- export interface $404 {
431
- }
432
- export type $500 = Components.Schemas.ErrorResp;
433
- }
434
- }
435
- namespace AddDesign {
436
- export type RequestBody = Components.Schemas.AddDesignReq;
437
- namespace Responses {
438
- export type $201 = Components.Schemas.AddDesignRes;
439
- export type $400 = Components.Schemas.ErrorResp;
440
- export type $401 = Components.Schemas.ErrorResp;
441
- export type $500 = Components.Schemas.ErrorResp;
442
- }
443
- }
444
- namespace DeleteDesign {
445
- namespace Parameters {
446
- export type DesignId = /**
447
- * Id of the design
448
- * example:
449
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
450
- */
451
- Components.Schemas.DesignId;
452
- }
453
- export interface PathParameters {
454
- designId: Parameters.DesignId;
455
- }
456
- namespace Responses {
457
- export interface $204 {
458
- }
459
- export type $400 = Components.Schemas.ErrorResp;
460
- export type $401 = Components.Schemas.ErrorResp;
461
- export interface $404 {
462
- }
463
- export type $500 = Components.Schemas.ErrorResp;
464
- }
465
- }
466
- namespace GetAllDesigns {
467
- namespace Responses {
468
- export type $200 = Components.Schemas.GetAllDesignsRes;
469
- export type $500 = Components.Schemas.ErrorResp;
470
- }
471
- }
472
- namespace GetBrands {
473
- namespace Responses {
474
- export type $200 = Components.Schemas.GetBrandsRes[];
475
- export type $500 = Components.Schemas.ErrorResp;
476
- }
477
- }
478
- namespace GetConsumerDesign {
479
- namespace Parameters {
480
- export type Application = /**
481
- * Type of application that uses the design
482
- * example:
483
- * journey
484
- */
485
- Components.Schemas.Application;
486
- export type ConsumerId = /**
487
- * Id of the design
488
- * example:
489
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
490
- */
491
- Components.Schemas.DesignId;
492
- }
493
- export interface PathParameters {
494
- consumerId: Parameters.ConsumerId;
495
- application: Parameters.Application;
496
- }
497
- namespace Responses {
498
- export type $200 = Components.Schemas.GetDesignRes;
499
- export type $400 = Components.Schemas.ErrorResp;
500
- export type $401 = Components.Schemas.ErrorResp;
501
- export interface $404 {
502
- }
503
- export type $500 = Components.Schemas.ErrorResp;
504
- }
505
- }
506
- namespace GetDesign {
507
- namespace Parameters {
508
- export type DesignId = /**
509
- * Id of the design
510
- * example:
511
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
512
- */
513
- Components.Schemas.DesignId;
514
- }
515
- export interface PathParameters {
516
- designId: Parameters.DesignId;
517
- }
518
- namespace Responses {
519
- export type $200 = Components.Schemas.GetDesignRes;
520
- export type $400 = Components.Schemas.ErrorResp;
521
- export type $401 = Components.Schemas.ErrorResp;
522
- export interface $404 {
523
- }
524
- export type $500 = Components.Schemas.ErrorResp;
525
- }
526
- }
527
- namespace GetFiles {
528
- namespace Parameters {
529
- export type Type = "LOGO" | "FONT";
530
- }
531
- export interface QueryParameters {
532
- type?: Parameters.Type;
533
- }
534
- namespace Responses {
535
- export type $200 = Components.Schemas.GetFilesRes;
536
- export type $400 = Components.Schemas.ErrorResp;
537
- export type $401 = Components.Schemas.ErrorResp;
538
- export type $500 = Components.Schemas.ErrorResp;
539
- }
540
- }
541
- namespace GetLimit {
542
- namespace Responses {
543
- export type $200 = number;
544
- export type $500 = Components.Schemas.ErrorResp;
545
- }
546
- }
547
- namespace GetThemeFromDesign {
548
- namespace Parameters {
549
- export type DesignId = /**
550
- * Id of the design
551
- * example:
552
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
553
- */
554
- Components.Schemas.DesignId;
555
- export type OrgId = string;
556
- export type Theme = /**
557
- * Type of theme to be parsed and returned
558
- * example:
559
- * NEW
560
- */
561
- Components.Schemas.Theme;
562
- }
563
- export interface PathParameters {
564
- designId: Parameters.DesignId;
565
- }
566
- export interface QueryParameters {
567
- orgId?: Parameters.OrgId;
568
- theme: Parameters.Theme;
569
- }
570
- namespace Responses {
571
- export interface $200 {
572
- }
573
- export type $400 = Components.Schemas.ErrorResp;
574
- export type $401 = Components.Schemas.ErrorResp;
575
- export interface $404 {
576
- }
577
- export type $500 = Components.Schemas.ErrorResp;
578
- }
579
- }
580
- namespace RemoveConsumer {
581
- namespace Parameters {
582
- export type Application = string;
583
- export type DesignId = /**
584
- * Id of the design
585
- * example:
586
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
587
- */
588
- Components.Schemas.DesignId;
589
- }
590
- export interface PathParameters {
591
- designId: Parameters.DesignId;
592
- application: Parameters.Application;
593
- }
594
- export type RequestBody = Components.Schemas.RemoveConsumerReq;
595
- namespace Responses {
596
- export interface $204 {
597
- }
598
- export type $400 = Components.Schemas.ErrorResp;
599
- export type $401 = Components.Schemas.ErrorResp;
600
- export interface $404 {
601
- }
602
- export type $500 = Components.Schemas.ErrorResp;
603
- }
604
- }
605
- namespace UpdateDesign {
606
- namespace Parameters {
607
- export type DesignId = /**
608
- * Id of the design
609
- * example:
610
- * 4a062990-a6a3-11eb-9828-4f3da7d4935a
611
- */
612
- Components.Schemas.DesignId;
613
- }
614
- export interface PathParameters {
615
- designId: Parameters.DesignId;
616
- }
617
- export type RequestBody = Components.Schemas.UpdateDesignReq;
618
- namespace Responses {
619
- export interface $204 {
620
- }
621
- export type $400 = Components.Schemas.ErrorResp;
622
- export type $401 = Components.Schemas.ErrorResp;
623
- export interface $404 {
624
- }
625
- export type $500 = Components.Schemas.ErrorResp;
626
- }
627
- }
628
- namespace UploadFile {
629
- export type RequestBody = Components.Schemas.UploadFileReq;
630
- namespace Responses {
631
- export type $201 = Components.Schemas.UploadFileRes;
632
- export type $400 = Components.Schemas.ErrorResp;
633
- export type $401 = Components.Schemas.ErrorResp;
634
- export type $500 = Components.Schemas.ErrorResp;
635
- }
636
- }
637
- }
638
-
639
-
640
- interface OperationMethods {
641
- /**
642
- * getAllDesigns - getAllDesigns
643
- *
644
- * Scan all designs linked to a organization, based in orgId attribute from JWT auth token
645
- */
646
- 'getAllDesigns'(
647
- parameters?: Parameters<UnknownParamsObject> | null,
648
- data?: any,
649
- config?: AxiosRequestConfig
650
- ): OperationResponse<Paths.GetAllDesigns.Responses.$200>
651
- /**
652
- * addDesign - addDesign
653
- *
654
- * Create a brand new design linked to a organization, based in orgId attribute from JWT auth token
655
- */
656
- 'addDesign'(
657
- parameters?: Parameters<UnknownParamsObject> | null,
658
- data?: Paths.AddDesign.RequestBody,
659
- config?: AxiosRequestConfig
660
- ): OperationResponse<Paths.AddDesign.Responses.$201>
661
- /**
662
- * getDesign - getDesign
663
- *
664
- * Search for a especific design owned by user organization
665
- */
666
- 'getDesign'(
667
- parameters?: Parameters<Paths.GetDesign.PathParameters> | null,
668
- data?: any,
669
- config?: AxiosRequestConfig
670
- ): OperationResponse<Paths.GetDesign.Responses.$200>
671
- /**
672
- * updateDesign - updateDesign
673
- *
674
- * Update a especific design owned by user organization
675
- */
676
- 'updateDesign'(
677
- parameters?: Parameters<Paths.UpdateDesign.PathParameters> | null,
678
- data?: Paths.UpdateDesign.RequestBody,
679
- config?: AxiosRequestConfig
680
- ): OperationResponse<Paths.UpdateDesign.Responses.$204>
681
- /**
682
- * deleteDesign - deleteDesign
683
- *
684
- * Search and delete for a especific design owned by user organization
685
- */
686
- 'deleteDesign'(
687
- parameters?: Parameters<Paths.DeleteDesign.PathParameters> | null,
688
- data?: any,
689
- config?: AxiosRequestConfig
690
- ): OperationResponse<Paths.DeleteDesign.Responses.$204>
691
- /**
692
- * getThemeFromDesign - getThemeFromDesign
693
- *
694
- * Search for a especific design owned by user organization and parse them to a new or old theme
695
- */
696
- 'getThemeFromDesign'(
697
- parameters?: Parameters<Paths.GetThemeFromDesign.QueryParameters & Paths.GetThemeFromDesign.PathParameters> | null,
698
- data?: any,
699
- config?: AxiosRequestConfig
700
- ): OperationResponse<Paths.GetThemeFromDesign.Responses.$200>
701
- /**
702
- * getFiles - getFiles
703
- *
704
- * List all files for the user organization bucket
705
- */
706
- 'getFiles'(
707
- parameters?: Parameters<Paths.GetFiles.QueryParameters> | null,
708
- data?: any,
709
- config?: AxiosRequestConfig
710
- ): OperationResponse<Paths.GetFiles.Responses.$200>
711
- /**
712
- * uploadFile - uploadFile
713
- *
714
- * Upload a new file for the user organization bucket
715
- */
716
- 'uploadFile'(
717
- parameters?: Parameters<UnknownParamsObject> | null,
718
- data?: Paths.UploadFile.RequestBody,
719
- config?: AxiosRequestConfig
720
- ): OperationResponse<Paths.UploadFile.Responses.$201>
721
- /**
722
- * getLimit - getLimit
723
- *
724
- * Gets designs number limit from database per organization
725
- */
726
- 'getLimit'(
727
- parameters?: Parameters<UnknownParamsObject> | null,
728
- data?: any,
729
- config?: AxiosRequestConfig
730
- ): OperationResponse<Paths.GetLimit.Responses.$200>
731
- /**
732
- * getBrands - getBrands
733
- *
734
- * Scan all brands linked to a organization, based in orgId attribute from JWT auth token
735
- */
736
- 'getBrands'(
737
- parameters?: Parameters<UnknownParamsObject> | null,
738
- data?: any,
739
- config?: AxiosRequestConfig
740
- ): OperationResponse<Paths.GetBrands.Responses.$200>
741
- /**
742
- * getConsumerDesign - getConsumerDesign
743
- *
744
- * Search for a especific design owned by user organization
745
- */
746
- 'getConsumerDesign'(
747
- parameters?: Parameters<Paths.GetConsumerDesign.PathParameters> | null,
748
- data?: any,
749
- config?: AxiosRequestConfig
750
- ): OperationResponse<Paths.GetConsumerDesign.Responses.$200>
751
- /**
752
- * addConsumer - addConsumer
753
- *
754
- * Add a consumer that uses a specific design
755
- */
756
- 'addConsumer'(
757
- parameters?: Parameters<Paths.AddConsumer.PathParameters> | null,
758
- data?: Paths.AddConsumer.RequestBody,
759
- config?: AxiosRequestConfig
760
- ): OperationResponse<Paths.AddConsumer.Responses.$204>
761
- /**
762
- * removeConsumer - removeConsumer
763
- *
764
- * Remove a consumer that uses a specific design
765
- */
766
- 'removeConsumer'(
767
- parameters?: Parameters<Paths.RemoveConsumer.PathParameters> | null,
768
- data?: Paths.RemoveConsumer.RequestBody,
769
- config?: AxiosRequestConfig
770
- ): OperationResponse<Paths.RemoveConsumer.Responses.$204>
771
- }
772
-
773
- interface PathsDictionary {
774
- ['/v1/designs']: {
775
- /**
776
- * getAllDesigns - getAllDesigns
777
- *
778
- * Scan all designs linked to a organization, based in orgId attribute from JWT auth token
779
- */
780
- 'get'(
781
- parameters?: Parameters<UnknownParamsObject> | null,
782
- data?: any,
783
- config?: AxiosRequestConfig
784
- ): OperationResponse<Paths.GetAllDesigns.Responses.$200>
785
- /**
786
- * addDesign - addDesign
787
- *
788
- * Create a brand new design linked to a organization, based in orgId attribute from JWT auth token
789
- */
790
- 'post'(
791
- parameters?: Parameters<UnknownParamsObject> | null,
792
- data?: Paths.AddDesign.RequestBody,
793
- config?: AxiosRequestConfig
794
- ): OperationResponse<Paths.AddDesign.Responses.$201>
795
- }
796
- ['/v1/designs/{designId}']: {
797
- /**
798
- * getDesign - getDesign
799
- *
800
- * Search for a especific design owned by user organization
801
- */
802
- 'get'(
803
- parameters?: Parameters<Paths.GetDesign.PathParameters> | null,
804
- data?: any,
805
- config?: AxiosRequestConfig
806
- ): OperationResponse<Paths.GetDesign.Responses.$200>
807
- /**
808
- * deleteDesign - deleteDesign
809
- *
810
- * Search and delete for a especific design owned by user organization
811
- */
812
- 'delete'(
813
- parameters?: Parameters<Paths.DeleteDesign.PathParameters> | null,
814
- data?: any,
815
- config?: AxiosRequestConfig
816
- ): OperationResponse<Paths.DeleteDesign.Responses.$204>
817
- /**
818
- * updateDesign - updateDesign
819
- *
820
- * Update a especific design owned by user organization
821
- */
822
- 'put'(
823
- parameters?: Parameters<Paths.UpdateDesign.PathParameters> | null,
824
- data?: Paths.UpdateDesign.RequestBody,
825
- config?: AxiosRequestConfig
826
- ): OperationResponse<Paths.UpdateDesign.Responses.$204>
827
- }
828
- ['/v1/designs/{designId}/parse']: {
829
- /**
830
- * getThemeFromDesign - getThemeFromDesign
831
- *
832
- * Search for a especific design owned by user organization and parse them to a new or old theme
833
- */
834
- 'get'(
835
- parameters?: Parameters<Paths.GetThemeFromDesign.QueryParameters & Paths.GetThemeFromDesign.PathParameters> | null,
836
- data?: any,
837
- config?: AxiosRequestConfig
838
- ): OperationResponse<Paths.GetThemeFromDesign.Responses.$200>
839
- }
840
- ['/v1/designs/files']: {
841
- /**
842
- * uploadFile - uploadFile
843
- *
844
- * Upload a new file for the user organization bucket
845
- */
846
- 'post'(
847
- parameters?: Parameters<UnknownParamsObject> | null,
848
- data?: Paths.UploadFile.RequestBody,
849
- config?: AxiosRequestConfig
850
- ): OperationResponse<Paths.UploadFile.Responses.$201>
851
- /**
852
- * getFiles - getFiles
853
- *
854
- * List all files for the user organization bucket
855
- */
856
- 'get'(
857
- parameters?: Parameters<Paths.GetFiles.QueryParameters> | null,
858
- data?: any,
859
- config?: AxiosRequestConfig
860
- ): OperationResponse<Paths.GetFiles.Responses.$200>
861
- }
862
- ['/v1/designs/limit']: {
863
- /**
864
- * getLimit - getLimit
865
- *
866
- * Gets designs number limit from database per organization
867
- */
868
- 'get'(
869
- parameters?: Parameters<UnknownParamsObject> | null,
870
- data?: any,
871
- config?: AxiosRequestConfig
872
- ): OperationResponse<Paths.GetLimit.Responses.$200>
873
- }
874
- ['/v1/brands']: {
875
- /**
876
- * getBrands - getBrands
877
- *
878
- * Scan all brands linked to a organization, based in orgId attribute from JWT auth token
879
- */
880
- 'get'(
881
- parameters?: Parameters<UnknownParamsObject> | null,
882
- data?: any,
883
- config?: AxiosRequestConfig
884
- ): OperationResponse<Paths.GetBrands.Responses.$200>
885
- }
886
- ['/v1/designs/consumer/{application}/{consumerId}']: {
887
- /**
888
- * getConsumerDesign - getConsumerDesign
889
- *
890
- * Search for a especific design owned by user organization
891
- */
892
- 'get'(
893
- parameters?: Parameters<Paths.GetConsumerDesign.PathParameters> | null,
894
- data?: any,
895
- config?: AxiosRequestConfig
896
- ): OperationResponse<Paths.GetConsumerDesign.Responses.$200>
897
- }
898
- ['/v1/designs/addConsumer/{application}/{designId}']: {
899
- /**
900
- * addConsumer - addConsumer
901
- *
902
- * Add a consumer that uses a specific design
903
- */
904
- 'put'(
905
- parameters?: Parameters<Paths.AddConsumer.PathParameters> | null,
906
- data?: Paths.AddConsumer.RequestBody,
907
- config?: AxiosRequestConfig
908
- ): OperationResponse<Paths.AddConsumer.Responses.$204>
909
- }
910
- ['/v1/designs/removeConsumer/{application}/{designId}']: {
911
- /**
912
- * removeConsumer - removeConsumer
913
- *
914
- * Remove a consumer that uses a specific design
915
- */
916
- 'put'(
917
- parameters?: Parameters<Paths.RemoveConsumer.PathParameters> | null,
918
- data?: Paths.RemoveConsumer.RequestBody,
919
- config?: AxiosRequestConfig
920
- ): OperationResponse<Paths.RemoveConsumer.Responses.$204>
921
- }
922
- }
923
-
924
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
925
-
926
-
927
- type AddConsumerReq = Components.Schemas.AddConsumerReq;
928
- type AddDesignReq = Components.Schemas.AddDesignReq;
929
- type AddDesignRes = Components.Schemas.AddDesignRes;
930
- type Application = Components.Schemas.Application;
931
- type BrandItem = Components.Schemas.BrandItem;
932
- type ConsumerData = Components.Schemas.ConsumerData;
933
- type Custom_Style = Components.Schemas.CustomStyle;
934
- type CustomerPortalData = Components.Schemas.CustomerPortalData;
935
- type DesignId = Components.Schemas.DesignId;
936
- type DesignItem = Components.Schemas.DesignItem;
937
- type DesignParameters = Components.Schemas.DesignParameters;
938
- type ErrorResp = Components.Schemas.ErrorResp;
939
- type FileData = Components.Schemas.FileData;
940
- type FontData = Components.Schemas.FontData;
941
- type FontResponseUrl = Components.Schemas.FontResponseUrl;
942
- type GetAllDesignsRes = Components.Schemas.GetAllDesignsRes;
943
- type GetBrandsRes = Components.Schemas.GetBrandsRes;
944
- type GetDesignRes = Components.Schemas.GetDesignRes;
945
- type GetFilesRes = Components.Schemas.GetFilesRes;
946
- type ItemMetada = Components.Schemas.ItemMetada;
947
- type Journey = Components.Schemas.Journey;
948
- type LogoData = Components.Schemas.LogoData;
949
- type PaletteData = Components.Schemas.PaletteData;
950
- type RemoveConsumerReq = Components.Schemas.RemoveConsumerReq;
951
- type ShapeData = Components.Schemas.ShapeData;
952
- type Theme = Components.Schemas.Theme;
953
- type TypographyData = Components.Schemas.TypographyData;
954
- type UpdateDesignReq = Components.Schemas.UpdateDesignReq;
955
- type UploadFileReq = Components.Schemas.UploadFileReq;
956
- type UploadFileRes = Components.Schemas.UploadFileRes;
957
- type WidgetData = Components.Schemas.WidgetData;
958
- type WidgetPortalData = Components.Schemas.WidgetPortalData;
959
-
960
- export { type AddConsumerReq as A, type BrandItem as B, type Client as C, type DesignId as D, type ErrorResp as E, type FileData as F, type GetAllDesignsRes as G, type ItemMetada as I, type Journey as J, type LogoData as L, type OperationMethods as O, Paths as P, type RemoveConsumerReq as R, type ShapeData as S, type Theme as T, type UpdateDesignReq as U, type WidgetData as W, Components as a, type PathsDictionary as b, type AddDesignReq as c, type AddDesignRes as d, type Application as e, type ConsumerData as f, type Custom_Style as g, type CustomerPortalData as h, type DesignItem as i, type DesignParameters as j, type FontData as k, type FontResponseUrl as l, type GetBrandsRes as m, type GetDesignRes as n, type GetFilesRes as o, type PaletteData as p, type TypographyData as q, type UploadFileReq as r, type UploadFileRes as s, type WidgetPortalData as t };