@wix/auto_sdk_papyrus_templates 1.0.0

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 (52) hide show
  1. package/build/cjs/index.d.ts +38 -0
  2. package/build/cjs/index.js +620 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1102 -0
  5. package/build/cjs/index.typings.js +511 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +908 -0
  8. package/build/cjs/meta.js +374 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/schemas.d.ts +260 -0
  11. package/build/cjs/schemas.js +386 -0
  12. package/build/cjs/schemas.js.map +1 -0
  13. package/build/es/index.d.mts +38 -0
  14. package/build/es/index.mjs +586 -0
  15. package/build/es/index.mjs.map +1 -0
  16. package/build/es/index.typings.d.mts +1102 -0
  17. package/build/es/index.typings.mjs +478 -0
  18. package/build/es/index.typings.mjs.map +1 -0
  19. package/build/es/meta.d.mts +908 -0
  20. package/build/es/meta.mjs +340 -0
  21. package/build/es/meta.mjs.map +1 -0
  22. package/build/es/package.json +3 -0
  23. package/build/es/schemas.d.mts +260 -0
  24. package/build/es/schemas.mjs +344 -0
  25. package/build/es/schemas.mjs.map +1 -0
  26. package/build/internal/cjs/index.d.ts +38 -0
  27. package/build/internal/cjs/index.js +620 -0
  28. package/build/internal/cjs/index.js.map +1 -0
  29. package/build/internal/cjs/index.typings.d.ts +1102 -0
  30. package/build/internal/cjs/index.typings.js +511 -0
  31. package/build/internal/cjs/index.typings.js.map +1 -0
  32. package/build/internal/cjs/meta.d.ts +908 -0
  33. package/build/internal/cjs/meta.js +374 -0
  34. package/build/internal/cjs/meta.js.map +1 -0
  35. package/build/internal/cjs/schemas.d.ts +260 -0
  36. package/build/internal/cjs/schemas.js +386 -0
  37. package/build/internal/cjs/schemas.js.map +1 -0
  38. package/build/internal/es/index.d.mts +38 -0
  39. package/build/internal/es/index.mjs +586 -0
  40. package/build/internal/es/index.mjs.map +1 -0
  41. package/build/internal/es/index.typings.d.mts +1102 -0
  42. package/build/internal/es/index.typings.mjs +478 -0
  43. package/build/internal/es/index.typings.mjs.map +1 -0
  44. package/build/internal/es/meta.d.mts +908 -0
  45. package/build/internal/es/meta.mjs +340 -0
  46. package/build/internal/es/meta.mjs.map +1 -0
  47. package/build/internal/es/schemas.d.mts +260 -0
  48. package/build/internal/es/schemas.mjs +344 -0
  49. package/build/internal/es/schemas.mjs.map +1 -0
  50. package/meta/package.json +3 -0
  51. package/package.json +61 -0
  52. package/schemas/package.json +3 -0
@@ -0,0 +1,908 @@
1
+ import { UpsertTemplateSettingsRequest as UpsertTemplateSettingsRequest$1, UpsertTemplateSettingsResponse as UpsertTemplateSettingsResponse$1, QueryTemplateSettingsRequest as QueryTemplateSettingsRequest$1, QueryTemplateSettingsResponse as QueryTemplateSettingsResponse$1, ResolveTemplateSettingsRequest as ResolveTemplateSettingsRequest$1, ResolveTemplateSettingsResponse as ResolveTemplateSettingsResponse$1 } from './index.typings.js';
2
+ import '@wix/sdk-types';
3
+
4
+ interface TemplateSettings {
5
+ /**
6
+ * Auto generated ID.
7
+ * @format GUID
8
+ * @readonly
9
+ */
10
+ id?: string | null;
11
+ /**
12
+ * Wix app definition ID.
13
+ * @minLength 1
14
+ * @maxLength 20
15
+ */
16
+ appSlug?: string | null;
17
+ /**
18
+ * The type of the template.
19
+ * @minLength 1
20
+ * @maxLength 20
21
+ */
22
+ templateType?: string | null;
23
+ /**
24
+ * The id of the template.
25
+ * @minLength 1
26
+ * @maxLength 20
27
+ */
28
+ templateId?: string | null;
29
+ /**
30
+ * Template settings external ID. For example ticket definition ID.
31
+ * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
32
+ * @minLength 1
33
+ * @maxLength 100
34
+ */
35
+ externalId?: string | null;
36
+ /**
37
+ * Date settings were created.
38
+ * @readonly
39
+ */
40
+ createdDate?: Date | null;
41
+ /**
42
+ * Date settings were updated.
43
+ * @readonly
44
+ */
45
+ updatedDate?: Date | null;
46
+ /** @maxSize 10 */
47
+ settingGroups?: SettingsGroup[];
48
+ /** Paper size */
49
+ paperSize?: PaperSizeWithLiterals;
50
+ pageOverflow?: PageOverflowWithLiterals;
51
+ }
52
+ interface TextSetting {
53
+ /**
54
+ * Font family class name
55
+ * @maxLength 20
56
+ */
57
+ fontFamily?: string | null;
58
+ /**
59
+ * Font style class names
60
+ * @maxSize 10
61
+ * @maxLength 20
62
+ */
63
+ fontStyle?: string[];
64
+ /**
65
+ * Text alignment class name
66
+ * @maxLength 20
67
+ */
68
+ textAlignment?: string | null;
69
+ /**
70
+ * Text color hex code
71
+ * @minLength 7
72
+ * @maxLength 7
73
+ */
74
+ textColor?: string | null;
75
+ /**
76
+ * Font size
77
+ * @min 1
78
+ */
79
+ fontSize?: number | null;
80
+ /** Text content setting */
81
+ textContent?: TextContent[];
82
+ }
83
+ interface TextContent {
84
+ /**
85
+ * @minLength 3
86
+ * @maxLength 50
87
+ */
88
+ id?: string;
89
+ /** @maxLength 500 */
90
+ value?: string | null;
91
+ visible?: boolean;
92
+ }
93
+ interface ImageSetting {
94
+ /** Wix media Image */
95
+ image?: Image;
96
+ /** Image resizing mode */
97
+ resize?: ResizeOptionWithLiterals;
98
+ }
99
+ interface Image {
100
+ /** WixMedia image ID. */
101
+ id?: string;
102
+ /** Image URL. */
103
+ url?: string;
104
+ /**
105
+ * Original image height.
106
+ * @readonly
107
+ */
108
+ height?: number;
109
+ /**
110
+ * Original image width.
111
+ * @readonly
112
+ */
113
+ width?: number;
114
+ /** Image alt text. */
115
+ altText?: string | null;
116
+ /**
117
+ * Image filename.
118
+ * @readonly
119
+ */
120
+ filename?: string | null;
121
+ }
122
+ interface FocalPoint {
123
+ /** X-coordinate of the focal point. */
124
+ x?: number;
125
+ /** Y-coordinate of the focal point. */
126
+ y?: number;
127
+ /** crop by height */
128
+ height?: number | null;
129
+ /** crop by width */
130
+ width?: number | null;
131
+ }
132
+ declare enum ResizeOption {
133
+ /** Automatically resizes full image to fit image field */
134
+ FIT = "FIT",
135
+ /** Enables user to manually crop image to fit image field */
136
+ CROP = "CROP"
137
+ }
138
+ /** @enumType */
139
+ type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
140
+ interface SelectSetting {
141
+ /** Selected value */
142
+ value?: string | null;
143
+ /**
144
+ * Color hex code
145
+ * @minLength 7
146
+ * @maxLength 7
147
+ */
148
+ primaryColor?: string | null;
149
+ /**
150
+ * Color hex code
151
+ * @minLength 7
152
+ * @maxLength 7
153
+ */
154
+ secondaryColor?: string | null;
155
+ /** Size */
156
+ size?: number | null;
157
+ }
158
+ interface BackgroundSetting {
159
+ /**
160
+ * Color of the background hex code
161
+ * @minLength 7
162
+ * @maxLength 9
163
+ */
164
+ color?: string | null;
165
+ /** Wix media Image */
166
+ image?: Image;
167
+ }
168
+ interface SettingsGroup {
169
+ /**
170
+ * Id of the control group
171
+ * @minLength 5
172
+ * @maxLength 50
173
+ */
174
+ groupId?: string;
175
+ /**
176
+ * Display settings.
177
+ * @maxSize 20
178
+ */
179
+ display?: Record<string, boolean>;
180
+ /**
181
+ * Texts settings.
182
+ * @maxSize 20
183
+ */
184
+ texts?: Record<string, TextSetting>;
185
+ /**
186
+ * Images settings.
187
+ * @maxSize 10
188
+ */
189
+ images?: Record<string, ImageSetting>;
190
+ /**
191
+ * Select option settings.
192
+ * @maxSize 20
193
+ */
194
+ selects?: Record<string, SelectSetting>;
195
+ /**
196
+ * Backgrounds settings.
197
+ * @maxSize 20
198
+ */
199
+ backgrounds?: Record<string, BackgroundSetting>;
200
+ }
201
+ declare enum PaperSize {
202
+ A4_PORTRAIT = "A4_PORTRAIT",
203
+ A4_LANDSCAPE = "A4_LANDSCAPE"
204
+ }
205
+ /** @enumType */
206
+ type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
207
+ declare enum PageOverflow {
208
+ CONTENT_HIDDEN = "CONTENT_HIDDEN",
209
+ CONTENT_BREAK = "CONTENT_BREAK"
210
+ }
211
+ /** @enumType */
212
+ type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
213
+ interface CreateTemplateSettingsRequest {
214
+ /** Settings to be created. */
215
+ settings?: TemplateSettings;
216
+ }
217
+ interface CreateTemplateSettingsResponse {
218
+ /** Created settings. */
219
+ settings?: TemplateSettings;
220
+ }
221
+ interface BulkCreateTemplateSettingsRequest {
222
+ /**
223
+ * Settings to be created.
224
+ * @minSize 1
225
+ * @maxSize 100
226
+ */
227
+ settings?: TemplateSettings[];
228
+ }
229
+ interface BulkCreateTemplateSettingsResponse {
230
+ /** Created settings */
231
+ settings?: TemplateSettings[];
232
+ }
233
+ interface UpsertTemplateSettingsRequest {
234
+ /** Settings to be upserted. */
235
+ settings?: TemplateSettings;
236
+ }
237
+ interface UpsertTemplateSettingsResponse {
238
+ /** Upserted settings. */
239
+ settings?: TemplateSettings;
240
+ }
241
+ interface GetTemplateSettingsRequest {
242
+ /**
243
+ * Settings ID.
244
+ * @format GUID
245
+ */
246
+ templateSettingsId?: string;
247
+ }
248
+ interface GetTemplateSettingsResponse {
249
+ /** Retrieved settings. */
250
+ settings?: TemplateSettings;
251
+ }
252
+ interface UpdateTemplateSettingsRequest {
253
+ /** Template Settings to be updated. */
254
+ settings?: TemplateSettings;
255
+ }
256
+ interface UpdateTemplateSettingsResponse {
257
+ /** Updated settings. */
258
+ settings?: TemplateSettings;
259
+ }
260
+ interface DeleteTemplateSettingsRequest {
261
+ /**
262
+ * Settings ID.
263
+ * @format GUID
264
+ */
265
+ templateSettingsId?: string;
266
+ }
267
+ interface DeleteTemplateSettingsResponse {
268
+ /** Deleted settings. */
269
+ settings?: TemplateSettings;
270
+ }
271
+ interface QueryTemplateSettingsRequest {
272
+ /** Generic query object. */
273
+ query: QueryV2;
274
+ }
275
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
276
+ /** Paging options to limit and offset the number of items. */
277
+ paging?: Paging;
278
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
279
+ cursorPaging?: CursorPaging;
280
+ /**
281
+ * Filter object.
282
+ *
283
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
284
+ */
285
+ filter?: Record<string, any> | null;
286
+ /**
287
+ * Sort object.
288
+ *
289
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
290
+ */
291
+ sort?: Sorting[];
292
+ /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
293
+ fields?: string[];
294
+ /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
295
+ fieldsets?: string[];
296
+ }
297
+ /** @oneof */
298
+ interface QueryV2PagingMethodOneOf {
299
+ /** Paging options to limit and offset the number of items. */
300
+ paging?: Paging;
301
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
302
+ cursorPaging?: CursorPaging;
303
+ }
304
+ interface Sorting {
305
+ /**
306
+ * Name of the field to sort by.
307
+ * @maxLength 512
308
+ */
309
+ fieldName?: string;
310
+ /** Sort order. */
311
+ order?: SortOrderWithLiterals;
312
+ }
313
+ declare enum SortOrder {
314
+ ASC = "ASC",
315
+ DESC = "DESC"
316
+ }
317
+ /** @enumType */
318
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
319
+ interface Paging {
320
+ /** Number of items to load. */
321
+ limit?: number | null;
322
+ /** Number of items to skip in the current sort order. */
323
+ offset?: number | null;
324
+ }
325
+ interface CursorPaging {
326
+ /**
327
+ * Maximum number of items to return in the results.
328
+ * @max 100
329
+ */
330
+ limit?: number | null;
331
+ /**
332
+ * Pointer to the next or previous page in the list of results.
333
+ *
334
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
335
+ * Not relevant for the first request.
336
+ * @maxLength 16000
337
+ */
338
+ cursor?: string | null;
339
+ }
340
+ interface QueryTemplateSettingsResponse {
341
+ /** Template settings results. */
342
+ settings?: TemplateSettings[];
343
+ /** Query result's metadata. */
344
+ metadata?: PagingMetadataV2;
345
+ }
346
+ interface PagingMetadataV2 {
347
+ /** Number of items returned in the response. */
348
+ count?: number | null;
349
+ /** Offset that was requested. */
350
+ offset?: number | null;
351
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
352
+ total?: number | null;
353
+ /** Flag that indicates the server failed to calculate the `total` field. */
354
+ tooManyToCount?: boolean | null;
355
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
356
+ cursors?: Cursors;
357
+ }
358
+ interface Cursors {
359
+ /**
360
+ * Cursor string pointing to the next page in the list of results.
361
+ * @maxLength 16000
362
+ */
363
+ next?: string | null;
364
+ /**
365
+ * Cursor pointing to the previous page in the list of results.
366
+ * @maxLength 16000
367
+ */
368
+ prev?: string | null;
369
+ }
370
+ interface ResolveTemplateSettingsRequest {
371
+ /**
372
+ * The id of the settings.
373
+ * @format GUID
374
+ */
375
+ templateSettingsId?: string | null;
376
+ /**
377
+ * External ID.
378
+ * @maxLength 100
379
+ */
380
+ templateSettingsExternalId?: string | null;
381
+ /**
382
+ * The type of the template. Used to resolve default settings.
383
+ * @minLength 1
384
+ * @maxLength 20
385
+ */
386
+ templateType: string | null;
387
+ /**
388
+ * Wix app slug.
389
+ * @minLength 1
390
+ * @maxLength 20
391
+ */
392
+ appSlug: string | null;
393
+ /**
394
+ * The id of template.
395
+ * @minLength 1
396
+ * @maxLength 20
397
+ */
398
+ templateId?: string | null;
399
+ }
400
+ interface ResolveTemplateSettingsResponse {
401
+ /** Retrieved settings. */
402
+ settings?: TemplateSettings;
403
+ }
404
+ interface GetTemplateControlsRequest {
405
+ }
406
+ interface GetTemplateControlsResponse {
407
+ templateControls?: TemplateControls;
408
+ }
409
+ interface TemplateControls {
410
+ /**
411
+ * The name of the template
412
+ * @maxLength 50
413
+ */
414
+ templateName?: string;
415
+ /**
416
+ * The controls groups configuration
417
+ * @minSize 1
418
+ * @maxSize 10
419
+ */
420
+ controlGroups?: ControlGroup[];
421
+ }
422
+ /** Represents control groups on the left side of the UI */
423
+ interface ControlGroup {
424
+ /**
425
+ * @minLength 3
426
+ * @maxLength 50
427
+ */
428
+ groupId?: string;
429
+ /**
430
+ * @minLength 3
431
+ * @maxLength 50
432
+ */
433
+ icon?: string;
434
+ /**
435
+ * @minLength 3
436
+ * @maxLength 100
437
+ */
438
+ labelKey?: string;
439
+ /**
440
+ * @minLength 3
441
+ * @maxLength 100
442
+ */
443
+ titleKey?: string;
444
+ /**
445
+ * @minLength 3
446
+ * @maxLength 100
447
+ */
448
+ descriptionKey?: string;
449
+ /** @maxLength 100 */
450
+ linkKey?: string | null;
451
+ /** @maxLength 50 */
452
+ linkUrl?: string | null;
453
+ /** @maxLength 100 */
454
+ tooltipKey?: string | null;
455
+ /**
456
+ * Display controls
457
+ * @maxSize 20
458
+ */
459
+ display?: DisplayControl[];
460
+ /**
461
+ * Text controls
462
+ * @maxSize 20
463
+ */
464
+ texts?: TextControl[];
465
+ /**
466
+ * Image controls
467
+ * @maxSize 10
468
+ */
469
+ images?: ImageControl[];
470
+ /**
471
+ * Select controls
472
+ * @maxSize 20
473
+ */
474
+ selects?: SelectControl[];
475
+ /**
476
+ * Background controls
477
+ * @maxSize 20
478
+ */
479
+ backgrounds?: BackgroundControl[];
480
+ }
481
+ interface DisplayControl {
482
+ /**
483
+ * The id of the setting
484
+ * @maxLength 50
485
+ */
486
+ id?: string;
487
+ /**
488
+ * Optional label key for translations
489
+ * @maxLength 100
490
+ */
491
+ labelKey?: string | null;
492
+ /** Default setting for this control */
493
+ default?: boolean;
494
+ }
495
+ interface TextControl {
496
+ /**
497
+ * The id of the setting
498
+ * @maxLength 50
499
+ */
500
+ id?: string;
501
+ /**
502
+ * Optional label key for translations
503
+ * @maxLength 100
504
+ */
505
+ labelKey?: string | null;
506
+ /** Default setting for this control */
507
+ default?: TextSetting;
508
+ /**
509
+ * Text properties
510
+ * @maxSize 5
511
+ */
512
+ textProperties?: TextPropertyControl[];
513
+ /** @maxSize 10 */
514
+ textContent?: TextContentControl[];
515
+ }
516
+ interface TextPropertyControl {
517
+ /**
518
+ * One of "fontFamily", "fontStyle", "fontSize", "textAlignment"
519
+ * @maxLength 15
520
+ */
521
+ type?: string;
522
+ /**
523
+ * Optional label key for translations
524
+ * @maxLength 100
525
+ */
526
+ labelKey?: string | null;
527
+ /**
528
+ * List of possible options. Used for "fontFamily", "fontStyle", "textAlignment"
529
+ * @maxSize 50
530
+ */
531
+ options?: ValueOption[];
532
+ /** Optional range of the value. Used for "fontSize" */
533
+ range?: Range;
534
+ }
535
+ interface ValueOption {
536
+ /**
537
+ * The label key for translations
538
+ * @maxLength 100
539
+ */
540
+ labelKey?: string;
541
+ /**
542
+ * The value
543
+ * @maxLength 20
544
+ */
545
+ value?: string;
546
+ }
547
+ interface Range {
548
+ /** Minimum value. */
549
+ min?: number | null;
550
+ /** Maximum value. */
551
+ max?: number | null;
552
+ }
553
+ interface TextContentControl {
554
+ /**
555
+ * @minLength 3
556
+ * @maxLength 50
557
+ */
558
+ id?: string;
559
+ /**
560
+ * @minLength 3
561
+ * @maxLength 100
562
+ */
563
+ labelKey?: string | null;
564
+ /** @max 1000 */
565
+ maxLength?: number | null;
566
+ }
567
+ interface ImageControl {
568
+ /**
569
+ * The id of the setting
570
+ * @maxLength 50
571
+ */
572
+ id?: string;
573
+ /**
574
+ * Optional label key for translations
575
+ * @maxLength 100
576
+ */
577
+ labelKey?: string | null;
578
+ /** Default setting for this control */
579
+ default?: ImageSetting;
580
+ /**
581
+ * Optional description key for translations
582
+ * @maxLength 100
583
+ */
584
+ descriptionKey?: string | null;
585
+ /** Enable logo builder support */
586
+ showLogoBuilder?: boolean;
587
+ }
588
+ interface SelectControl {
589
+ /**
590
+ * The id of the setting
591
+ * @maxLength 50
592
+ */
593
+ id?: string;
594
+ /**
595
+ * Optional label key for translations
596
+ * @maxLength 100
597
+ */
598
+ labelKey?: string | null;
599
+ /** Default setting for this control */
600
+ default?: SelectSetting;
601
+ /**
602
+ * List of possible options
603
+ * @minSize 1
604
+ * @maxSize 20
605
+ */
606
+ options?: ValueOption[];
607
+ /** Allows to use primary colour setting from template designer */
608
+ showPrimaryColorPicker?: boolean;
609
+ /** Allows to use secondary colour setting from template designer */
610
+ showSecondaryColorPicker?: boolean;
611
+ /** Allows to use size setting from template designer. */
612
+ showSize?: boolean;
613
+ /** Optional range of the size value. */
614
+ sizeRange?: Range;
615
+ }
616
+ interface BackgroundControl {
617
+ /**
618
+ * The id of the setting
619
+ * @maxLength 50
620
+ */
621
+ id?: string;
622
+ /**
623
+ * Optional label key for translations
624
+ * @maxLength 100
625
+ */
626
+ labelKey?: string | null;
627
+ /** Default setting for this control */
628
+ default?: BackgroundSetting;
629
+ /** Allows to use colour setting from template designer */
630
+ showColorPicker?: boolean;
631
+ /** Allows to use image setting from template designer */
632
+ showImagePicker?: boolean;
633
+ /** Enables background opacity control */
634
+ opacityEnabled?: boolean | null;
635
+ /** Enables background image opacity control */
636
+ imageOpacityEnabled?: boolean | null;
637
+ /**
638
+ * Default media manager folder with background images
639
+ * @maxLength 256
640
+ */
641
+ mediaRootFolder?: string | null;
642
+ }
643
+ interface GetTemplateRegistryRequest {
644
+ }
645
+ interface GetTemplateRegistryResponse {
646
+ templateRegistry?: TemplateRegistry;
647
+ }
648
+ interface TemplateRegistry {
649
+ /**
650
+ * Templates.
651
+ * @minSize 1
652
+ * @maxSize 1000
653
+ */
654
+ templates?: WixAppTemplate[];
655
+ }
656
+ /** Defines a template and it's styles. */
657
+ interface WixAppTemplate {
658
+ /** Wix App Id */
659
+ wixAppId?: string;
660
+ /** App Slug */
661
+ appSlug?: string;
662
+ /**
663
+ * Template type.
664
+ * @minLength 1
665
+ * @maxLength 20
666
+ */
667
+ templateType?: string;
668
+ /**
669
+ * Templates
670
+ * @minSize 1
671
+ * @maxSize 1000
672
+ */
673
+ templates?: TemplateStyle[];
674
+ /**
675
+ * Short artifact name (key from template-statics-config.json.erb)
676
+ * @minLength 3
677
+ * @maxLength 64
678
+ * @format SYSTEM_SLUG
679
+ */
680
+ templateArtifactName?: string | null;
681
+ /**
682
+ * Local path
683
+ * @minLength 1
684
+ * @maxLength 200
685
+ * @readonly
686
+ */
687
+ localPath?: string | null;
688
+ /**
689
+ * Statics URL
690
+ * @minLength 1
691
+ * @maxLength 200
692
+ * @readonly
693
+ */
694
+ staticsUrl?: string | null;
695
+ }
696
+ /**
697
+ * Defines a template style.
698
+ *
699
+ * Path to TemplateControls json file:
700
+ * papyrus-templates-lib/
701
+ * src/
702
+ * templates/
703
+ * {app_slug}/
704
+ * {template_type}/
705
+ * {id}/
706
+ * controls.json
707
+ */
708
+ interface TemplateStyle {
709
+ /**
710
+ * The id of the template.
711
+ * @minLength 1
712
+ * @maxLength 20
713
+ */
714
+ id?: string;
715
+ /**
716
+ * Determines which template should be used if user did not choose it yet.
717
+ * Only single template per wix_app_id can be default.
718
+ */
719
+ default?: boolean;
720
+ /** Determines if template cannot be selected for a new entity. */
721
+ inactive?: boolean;
722
+ /** Paper size */
723
+ paperSize?: PaperSizeWithLiterals;
724
+ pageOverflow?: PageOverflowWithLiterals;
725
+ }
726
+ interface DomainEvent extends DomainEventBodyOneOf {
727
+ createdEvent?: EntityCreatedEvent;
728
+ updatedEvent?: EntityUpdatedEvent;
729
+ deletedEvent?: EntityDeletedEvent;
730
+ actionEvent?: ActionEvent;
731
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
732
+ id?: string;
733
+ /**
734
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
735
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
736
+ */
737
+ entityFqdn?: string;
738
+ /**
739
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
740
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
741
+ */
742
+ slug?: string;
743
+ /** ID of the entity associated with the event. */
744
+ entityId?: string;
745
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
746
+ eventTime?: Date | null;
747
+ /**
748
+ * Whether the event was triggered as a result of a privacy regulation application
749
+ * (for example, GDPR).
750
+ */
751
+ triggeredByAnonymizeRequest?: boolean | null;
752
+ /** If present, indicates the action that triggered the event. */
753
+ originatedFrom?: string | null;
754
+ /**
755
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
756
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
757
+ */
758
+ entityEventSequence?: string | null;
759
+ }
760
+ /** @oneof */
761
+ interface DomainEventBodyOneOf {
762
+ createdEvent?: EntityCreatedEvent;
763
+ updatedEvent?: EntityUpdatedEvent;
764
+ deletedEvent?: EntityDeletedEvent;
765
+ actionEvent?: ActionEvent;
766
+ }
767
+ interface EntityCreatedEvent {
768
+ entityAsJson?: string;
769
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
770
+ restoreInfo?: RestoreInfo;
771
+ }
772
+ interface RestoreInfo {
773
+ deletedDate?: Date | null;
774
+ }
775
+ interface EntityUpdatedEvent {
776
+ /**
777
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
778
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
779
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
780
+ */
781
+ currentEntityAsJson?: string;
782
+ }
783
+ interface EntityDeletedEvent {
784
+ /** Entity that was deleted. */
785
+ deletedEntityAsJson?: string | null;
786
+ }
787
+ interface ActionEvent {
788
+ bodyAsJson?: string;
789
+ }
790
+ interface MessageEnvelope {
791
+ /**
792
+ * App instance ID.
793
+ * @format GUID
794
+ */
795
+ instanceId?: string | null;
796
+ /**
797
+ * Event type.
798
+ * @maxLength 150
799
+ */
800
+ eventType?: string;
801
+ /** The identification type and identity data. */
802
+ identity?: IdentificationData;
803
+ /** Stringify payload. */
804
+ data?: string;
805
+ /** Details related to the account */
806
+ accountInfo?: AccountInfo;
807
+ }
808
+ interface IdentificationData extends IdentificationDataIdOneOf {
809
+ /**
810
+ * ID of a site visitor that has not logged in to the site.
811
+ * @format GUID
812
+ */
813
+ anonymousVisitorId?: string;
814
+ /**
815
+ * ID of a site visitor that has logged in to the site.
816
+ * @format GUID
817
+ */
818
+ memberId?: string;
819
+ /**
820
+ * ID of a Wix user (site owner, contributor, etc.).
821
+ * @format GUID
822
+ */
823
+ wixUserId?: string;
824
+ /**
825
+ * ID of an app.
826
+ * @format GUID
827
+ */
828
+ appId?: string;
829
+ /** @readonly */
830
+ identityType?: WebhookIdentityTypeWithLiterals;
831
+ }
832
+ /** @oneof */
833
+ interface IdentificationDataIdOneOf {
834
+ /**
835
+ * ID of a site visitor that has not logged in to the site.
836
+ * @format GUID
837
+ */
838
+ anonymousVisitorId?: string;
839
+ /**
840
+ * ID of a site visitor that has logged in to the site.
841
+ * @format GUID
842
+ */
843
+ memberId?: string;
844
+ /**
845
+ * ID of a Wix user (site owner, contributor, etc.).
846
+ * @format GUID
847
+ */
848
+ wixUserId?: string;
849
+ /**
850
+ * ID of an app.
851
+ * @format GUID
852
+ */
853
+ appId?: string;
854
+ }
855
+ declare enum WebhookIdentityType {
856
+ UNKNOWN = "UNKNOWN",
857
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
858
+ MEMBER = "MEMBER",
859
+ WIX_USER = "WIX_USER",
860
+ APP = "APP"
861
+ }
862
+ /** @enumType */
863
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
864
+ interface AccountInfo {
865
+ /**
866
+ * ID of the Wix account associated with the event.
867
+ * @format GUID
868
+ */
869
+ accountId?: string | null;
870
+ /**
871
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
872
+ * @format GUID
873
+ */
874
+ parentAccountId?: string | null;
875
+ /**
876
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
877
+ * @format GUID
878
+ */
879
+ siteId?: string | null;
880
+ }
881
+ /** @docsIgnore */
882
+ type UpsertTemplateSettingsApplicationErrors = {
883
+ code?: 'INVALID_TEMPLATE_SETTINGS';
884
+ description?: string;
885
+ data?: Record<string, any>;
886
+ };
887
+ /** @docsIgnore */
888
+ type ResolveTemplateSettingsApplicationErrors = {
889
+ code?: 'TEMPLATE_NOT_FOUND';
890
+ description?: string;
891
+ data?: Record<string, any>;
892
+ };
893
+
894
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
895
+ getUrl: (context: any) => string;
896
+ httpMethod: K;
897
+ path: string;
898
+ pathParams: M;
899
+ __requestType: T;
900
+ __originalRequestType: S;
901
+ __responseType: Q;
902
+ __originalResponseType: R;
903
+ };
904
+ declare function upsertTemplateSettings(): __PublicMethodMetaInfo<'POST', {}, UpsertTemplateSettingsRequest$1, UpsertTemplateSettingsRequest, UpsertTemplateSettingsResponse$1, UpsertTemplateSettingsResponse>;
905
+ declare function queryTemplateSettings(): __PublicMethodMetaInfo<'POST', {}, QueryTemplateSettingsRequest$1, QueryTemplateSettingsRequest, QueryTemplateSettingsResponse$1, QueryTemplateSettingsResponse>;
906
+ declare function resolveTemplateSettings(): __PublicMethodMetaInfo<'GET', {}, ResolveTemplateSettingsRequest$1, ResolveTemplateSettingsRequest, ResolveTemplateSettingsResponse$1, ResolveTemplateSettingsResponse>;
907
+
908
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type BackgroundControl as BackgroundControlOriginal, type BackgroundSetting as BackgroundSettingOriginal, type BulkCreateTemplateSettingsRequest as BulkCreateTemplateSettingsRequestOriginal, type BulkCreateTemplateSettingsResponse as BulkCreateTemplateSettingsResponseOriginal, type ControlGroup as ControlGroupOriginal, type CreateTemplateSettingsRequest as CreateTemplateSettingsRequestOriginal, type CreateTemplateSettingsResponse as CreateTemplateSettingsResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DeleteTemplateSettingsRequest as DeleteTemplateSettingsRequestOriginal, type DeleteTemplateSettingsResponse as DeleteTemplateSettingsResponseOriginal, type DisplayControl as DisplayControlOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FocalPoint as FocalPointOriginal, type GetTemplateControlsRequest as GetTemplateControlsRequestOriginal, type GetTemplateControlsResponse as GetTemplateControlsResponseOriginal, type GetTemplateRegistryRequest as GetTemplateRegistryRequestOriginal, type GetTemplateRegistryResponse as GetTemplateRegistryResponseOriginal, type GetTemplateSettingsRequest as GetTemplateSettingsRequestOriginal, type GetTemplateSettingsResponse as GetTemplateSettingsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ImageControl as ImageControlOriginal, type Image as ImageOriginal, type ImageSetting as ImageSettingOriginal, type MessageEnvelope as MessageEnvelopeOriginal, PageOverflow as PageOverflowOriginal, type PageOverflowWithLiterals as PageOverflowWithLiteralsOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, PaperSize as PaperSizeOriginal, type PaperSizeWithLiterals as PaperSizeWithLiteralsOriginal, type QueryTemplateSettingsRequest as QueryTemplateSettingsRequestOriginal, type QueryTemplateSettingsResponse as QueryTemplateSettingsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type Range as RangeOriginal, ResizeOption as ResizeOptionOriginal, type ResizeOptionWithLiterals as ResizeOptionWithLiteralsOriginal, type ResolveTemplateSettingsApplicationErrors as ResolveTemplateSettingsApplicationErrorsOriginal, type ResolveTemplateSettingsRequest as ResolveTemplateSettingsRequestOriginal, type ResolveTemplateSettingsResponse as ResolveTemplateSettingsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type SelectControl as SelectControlOriginal, type SelectSetting as SelectSettingOriginal, type SettingsGroup as SettingsGroupOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type TemplateControls as TemplateControlsOriginal, type TemplateRegistry as TemplateRegistryOriginal, type TemplateSettings as TemplateSettingsOriginal, type TemplateStyle as TemplateStyleOriginal, type TextContentControl as TextContentControlOriginal, type TextContent as TextContentOriginal, type TextControl as TextControlOriginal, type TextPropertyControl as TextPropertyControlOriginal, type TextSetting as TextSettingOriginal, type UpdateTemplateSettingsRequest as UpdateTemplateSettingsRequestOriginal, type UpdateTemplateSettingsResponse as UpdateTemplateSettingsResponseOriginal, type UpsertTemplateSettingsApplicationErrors as UpsertTemplateSettingsApplicationErrorsOriginal, type UpsertTemplateSettingsRequest as UpsertTemplateSettingsRequestOriginal, type UpsertTemplateSettingsResponse as UpsertTemplateSettingsResponseOriginal, type ValueOption as ValueOptionOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixAppTemplate as WixAppTemplateOriginal, type __PublicMethodMetaInfo, queryTemplateSettings, resolveTemplateSettings, upsertTemplateSettings };