@wix/auto_sdk_multilingual_translation-published-contents 1.0.20 → 1.0.22

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 (130) hide show
  1. package/build/index.d.mts +49 -0
  2. package/build/index.d.ts +49 -0
  3. package/build/index.js +850 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +790 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/index.d.mts +49 -0
  8. package/build/internal/index.d.ts +49 -0
  9. package/build/internal/index.js +850 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +790 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/{cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts → internal/meta.d.mts} +250 -357
  14. package/build/{es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts → internal/meta.d.ts} +250 -357
  15. package/build/internal/meta.js +239 -0
  16. package/build/internal/meta.js.map +1 -0
  17. package/build/internal/meta.mjs +212 -0
  18. package/build/internal/meta.mjs.map +1 -0
  19. package/build/internal/{cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts → multilingual-localization-public-v3-published-content-translation-published-contents.universal-CZFjMeB8.d.mts} +278 -265
  20. package/build/{cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts → internal/multilingual-localization-public-v3-published-content-translation-published-contents.universal-CZFjMeB8.d.ts} +278 -265
  21. package/build/{internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts → meta.d.mts} +250 -357
  22. package/build/{internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.d.ts → meta.d.ts} +250 -357
  23. package/build/meta.js +239 -0
  24. package/build/meta.js.map +1 -0
  25. package/build/meta.mjs +212 -0
  26. package/build/meta.mjs.map +1 -0
  27. package/build/{internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts → multilingual-localization-public-v3-published-content-translation-published-contents.universal-CZFjMeB8.d.mts} +278 -265
  28. package/build/{es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.d.ts → multilingual-localization-public-v3-published-content-translation-published-contents.universal-CZFjMeB8.d.ts} +278 -265
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.d.ts +0 -21
  40. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +0 -57
  41. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +0 -1
  42. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +0 -24
  43. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +0 -208
  44. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +0 -1
  45. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +0 -13
  46. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +0 -47
  47. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +0 -1
  48. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +0 -35
  49. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +0 -258
  50. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +0 -1
  51. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +0 -333
  52. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +0 -1
  53. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +0 -450
  54. package/build/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.d.ts +0 -21
  66. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +0 -21
  67. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +0 -1
  68. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +0 -24
  69. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +0 -204
  70. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +0 -1
  71. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +0 -13
  72. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +0 -20
  73. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +0 -1
  74. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +0 -35
  75. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +0 -221
  76. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +0 -1
  77. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +0 -330
  78. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +0 -1
  79. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +0 -423
  80. package/build/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.d.ts +0 -21
  91. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +0 -57
  92. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +0 -1
  93. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +0 -24
  94. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +0 -208
  95. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +0 -1
  96. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +0 -13
  97. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +0 -47
  98. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +0 -1
  99. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +0 -35
  100. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +0 -258
  101. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +0 -1
  102. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +0 -333
  103. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +0 -1
  104. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +0 -450
  105. package/build/internal/cjs/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.d.ts +0 -21
  116. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js +0 -21
  117. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.context.js.map +0 -1
  118. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.d.ts +0 -24
  119. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js +0 -204
  120. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.http.js.map +0 -1
  121. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.d.ts +0 -13
  122. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js +0 -20
  123. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.meta.js.map +0 -1
  124. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.d.ts +0 -35
  125. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js +0 -221
  126. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.public.js.map +0 -1
  127. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js +0 -330
  128. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.types.js.map +0 -1
  129. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js +0 -423
  130. package/build/internal/es/src/multilingual-localization-public-v3-published-content-translation-published-contents.universal.js.map +0 -1
@@ -1,4 +1,4 @@
1
- export interface PublishedContent {
1
+ interface PublishedContent {
2
2
  /**
3
3
  * Published content ID.
4
4
  * @readonly
@@ -33,7 +33,7 @@ export interface PublishedContent {
33
33
  /** Custom field data for the published content object. */
34
34
  extendedFields?: ExtendedFields;
35
35
  }
36
- export interface SchemaKey {
36
+ interface SchemaKey {
37
37
  /**
38
38
  * ID of the app that created the schema.
39
39
  * @format GUID
@@ -54,16 +54,18 @@ export interface SchemaKey {
54
54
  * + `SITE`: A custom schema for a specific site.
55
55
  * @immutable
56
56
  */
57
- scope?: SchemaScope;
57
+ scope?: SchemaScopeWithLiterals;
58
58
  }
59
- export declare enum SchemaScope {
59
+ declare enum SchemaScope {
60
60
  UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
61
61
  /** Global schema for all sites. */
62
62
  GLOBAL = "GLOBAL",
63
63
  /** Custom schema for a specific site. */
64
64
  SITE = "SITE"
65
65
  }
66
- export interface PublishedContentField extends PublishedContentFieldValueOneOf {
66
+ /** @enumType */
67
+ type SchemaScopeWithLiterals = SchemaScope | 'UNKNOWN_SCOPE' | 'GLOBAL' | 'SITE';
68
+ interface PublishedContentField extends PublishedContentFieldValueOneOf {
67
69
  /**
68
70
  * Plain text.
69
71
  * @maxLength 100000
@@ -91,7 +93,7 @@ export interface PublishedContentField extends PublishedContentFieldValueOneOf {
91
93
  sequenceIds?: string[];
92
94
  }
93
95
  /** @oneof */
94
- export interface PublishedContentFieldValueOneOf {
96
+ interface PublishedContentFieldValueOneOf {
95
97
  /**
96
98
  * Plain text.
97
99
  * @maxLength 100000
@@ -106,7 +108,7 @@ export interface PublishedContentFieldValueOneOf {
106
108
  /** Wix Media Manager document. */
107
109
  document?: string;
108
110
  }
109
- export interface RichContent {
111
+ interface RichContent {
110
112
  /** Node objects representing a rich content document. */
111
113
  nodes?: Node[];
112
114
  /** Object metadata. */
@@ -114,7 +116,7 @@ export interface RichContent {
114
116
  /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
115
117
  documentStyle?: DocumentStyle;
116
118
  }
117
- export interface Node extends NodeDataOneOf {
119
+ interface Node extends NodeDataOneOf {
118
120
  /** Data for a button node. */
119
121
  buttonData?: ButtonData;
120
122
  /** Data for a code block node. */
@@ -170,7 +172,7 @@ export interface Node extends NodeDataOneOf {
170
172
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
171
173
  layoutCellData?: LayoutCellData;
172
174
  /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
173
- type?: NodeType;
175
+ type?: NodeTypeWithLiterals;
174
176
  /** Node ID. */
175
177
  id?: string;
176
178
  /** A list of child nodes. */
@@ -179,7 +181,7 @@ export interface Node extends NodeDataOneOf {
179
181
  style?: NodeStyle;
180
182
  }
181
183
  /** @oneof */
182
- export interface NodeDataOneOf {
184
+ interface NodeDataOneOf {
183
185
  /** Data for a button node. */
184
186
  buttonData?: ButtonData;
185
187
  /** Data for a code block node. */
@@ -235,7 +237,7 @@ export interface NodeDataOneOf {
235
237
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
236
238
  layoutCellData?: LayoutCellData;
237
239
  }
238
- export declare enum NodeType {
240
+ declare enum NodeType {
239
241
  PARAGRAPH = "PARAGRAPH",
240
242
  TEXT = "TEXT",
241
243
  HEADING = "HEADING",
@@ -271,7 +273,9 @@ export declare enum NodeType {
271
273
  LAYOUT = "LAYOUT",
272
274
  LAYOUT_CELL = "LAYOUT_CELL"
273
275
  }
274
- export interface NodeStyle {
276
+ /** @enumType */
277
+ type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
278
+ interface NodeStyle {
275
279
  /** The top padding value in pixels. */
276
280
  paddingTop?: string | null;
277
281
  /** The bottom padding value in pixels. */
@@ -279,11 +283,11 @@ export interface NodeStyle {
279
283
  /** The background color as a hexadecimal value. */
280
284
  backgroundColor?: string | null;
281
285
  }
282
- export interface ButtonData {
286
+ interface ButtonData {
283
287
  /** Styling for the button's container. */
284
288
  containerData?: PluginContainerData;
285
289
  /** The button type. */
286
- type?: Type;
290
+ type?: TypeWithLiterals;
287
291
  /** Styling for the button. */
288
292
  styles?: Styles;
289
293
  /** The text to display on the button. */
@@ -291,7 +295,7 @@ export interface ButtonData {
291
295
  /** Button link details. */
292
296
  link?: Link;
293
297
  }
294
- export interface Border {
298
+ interface Border {
295
299
  /**
296
300
  * Deprecated: Use `borderWidth` in `styles` instead.
297
301
  * @deprecated
@@ -303,7 +307,7 @@ export interface Border {
303
307
  */
304
308
  radius?: number | null;
305
309
  }
306
- export interface Colors {
310
+ interface Colors {
307
311
  /**
308
312
  * Deprecated: Use `textColor` in `styles` instead.
309
313
  * @deprecated
@@ -320,11 +324,11 @@ export interface Colors {
320
324
  */
321
325
  background?: string | null;
322
326
  }
323
- export interface PluginContainerData {
327
+ interface PluginContainerData {
324
328
  /** The width of the node when it's displayed. */
325
329
  width?: PluginContainerDataWidth;
326
330
  /** The node's alignment within its container. */
327
- alignment?: PluginContainerDataAlignment;
331
+ alignment?: PluginContainerDataAlignmentWithLiterals;
328
332
  /** Spoiler cover settings for the node. */
329
333
  spoiler?: Spoiler;
330
334
  /** The height of the node when it's displayed. */
@@ -332,7 +336,7 @@ export interface PluginContainerData {
332
336
  /** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
333
337
  textWrap?: boolean | null;
334
338
  }
335
- export declare enum WidthType {
339
+ declare enum WidthType {
336
340
  /** Width matches the content width */
337
341
  CONTENT = "CONTENT",
338
342
  /** Small Width */
@@ -342,7 +346,9 @@ export declare enum WidthType {
342
346
  /** coast-to-coast display */
343
347
  FULL_WIDTH = "FULL_WIDTH"
344
348
  }
345
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
349
+ /** @enumType */
350
+ type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
351
+ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
346
352
  /**
347
353
  * One of the following predefined width options:
348
354
  * `CONTENT`: The width of the container matches the content width.
@@ -350,12 +356,12 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
350
356
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
351
357
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
352
358
  */
353
- size?: WidthType;
359
+ size?: WidthTypeWithLiterals;
354
360
  /** A custom width value in pixels. */
355
361
  custom?: string | null;
356
362
  }
357
363
  /** @oneof */
358
- export interface PluginContainerDataWidthDataOneOf {
364
+ interface PluginContainerDataWidthDataOneOf {
359
365
  /**
360
366
  * One of the following predefined width options:
361
367
  * `CONTENT`: The width of the container matches the content width.
@@ -363,11 +369,11 @@ export interface PluginContainerDataWidthDataOneOf {
363
369
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
364
370
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
365
371
  */
366
- size?: WidthType;
372
+ size?: WidthTypeWithLiterals;
367
373
  /** A custom width value in pixels. */
368
374
  custom?: string | null;
369
375
  }
370
- export declare enum PluginContainerDataAlignment {
376
+ declare enum PluginContainerDataAlignment {
371
377
  /** Center Alignment */
372
378
  CENTER = "CENTER",
373
379
  /** Left Alignment */
@@ -375,7 +381,9 @@ export declare enum PluginContainerDataAlignment {
375
381
  /** Right Alignment */
376
382
  RIGHT = "RIGHT"
377
383
  }
378
- export interface Spoiler {
384
+ /** @enumType */
385
+ type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
386
+ interface Spoiler {
379
387
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
380
388
  enabled?: boolean | null;
381
389
  /** The description displayed on top of the spoiler cover. */
@@ -383,17 +391,19 @@ export interface Spoiler {
383
391
  /** The text for the button used to remove the spoiler cover. */
384
392
  buttonText?: string | null;
385
393
  }
386
- export interface Height {
394
+ interface Height {
387
395
  /** A custom height value in pixels. */
388
396
  custom?: string | null;
389
397
  }
390
- export declare enum Type {
398
+ declare enum Type {
391
399
  /** Regular link button */
392
400
  LINK = "LINK",
393
401
  /** Triggers custom action that is defined in plugin configuration by the consumer */
394
402
  ACTION = "ACTION"
395
403
  }
396
- export interface Styles {
404
+ /** @enumType */
405
+ type TypeWithLiterals = Type | 'LINK' | 'ACTION';
406
+ interface Styles {
397
407
  /**
398
408
  * Deprecated: Use `borderWidth` and `borderRadius` instead.
399
409
  * @deprecated
@@ -446,7 +456,7 @@ export interface Styles {
446
456
  /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
447
457
  buttonSize?: string | null;
448
458
  }
449
- export interface Link extends LinkDataOneOf {
459
+ interface Link extends LinkDataOneOf {
450
460
  /** The absolute URL for the linked document. */
451
461
  url?: string;
452
462
  /** The target node's ID. Used for linking to another node in this object. */
@@ -458,20 +468,20 @@ export interface Link extends LinkDataOneOf {
458
468
  * `PARENT` - Opens the linked document in the link's parent frame.
459
469
  * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
460
470
  */
461
- target?: Target;
471
+ target?: TargetWithLiterals;
462
472
  /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
463
473
  rel?: Rel;
464
474
  /** A serialized object used for a custom or external link panel. */
465
475
  customData?: string | null;
466
476
  }
467
477
  /** @oneof */
468
- export interface LinkDataOneOf {
478
+ interface LinkDataOneOf {
469
479
  /** The absolute URL for the linked document. */
470
480
  url?: string;
471
481
  /** The target node's ID. Used for linking to another node in this object. */
472
482
  anchor?: string;
473
483
  }
474
- export declare enum Target {
484
+ declare enum Target {
475
485
  /** Opens the linked document in the same frame as it was clicked (this is default) */
476
486
  SELF = "SELF",
477
487
  /** Opens the linked document in a new window or tab */
@@ -481,7 +491,9 @@ export declare enum Target {
481
491
  /** Opens the linked document in the full body of the window */
482
492
  TOP = "TOP"
483
493
  }
484
- export interface Rel {
494
+ /** @enumType */
495
+ type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
496
+ interface Rel {
485
497
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
486
498
  nofollow?: boolean | null;
487
499
  /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
@@ -491,17 +503,17 @@ export interface Rel {
491
503
  /** Indicates that this link protect referral information from being passed to the target website. */
492
504
  noreferrer?: boolean | null;
493
505
  }
494
- export interface CodeBlockData {
506
+ interface CodeBlockData {
495
507
  /** Styling for the code block's text. */
496
508
  textStyle?: TextStyle;
497
509
  }
498
- export interface TextStyle {
510
+ interface TextStyle {
499
511
  /** Text alignment. Defaults to `AUTO`. */
500
- textAlignment?: TextAlignment;
512
+ textAlignment?: TextAlignmentWithLiterals;
501
513
  /** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
502
514
  lineHeight?: string | null;
503
515
  }
504
- export declare enum TextAlignment {
516
+ declare enum TextAlignment {
505
517
  /** browser default, eqivalent to `initial` */
506
518
  AUTO = "AUTO",
507
519
  /** Left align */
@@ -513,17 +525,19 @@ export declare enum TextAlignment {
513
525
  /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
514
526
  JUSTIFY = "JUSTIFY"
515
527
  }
516
- export interface DividerData {
528
+ /** @enumType */
529
+ type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
530
+ interface DividerData {
517
531
  /** Styling for the divider's container. */
518
532
  containerData?: PluginContainerData;
519
533
  /** Divider line style. */
520
- lineStyle?: LineStyle;
534
+ lineStyle?: LineStyleWithLiterals;
521
535
  /** Divider width. */
522
- width?: Width;
536
+ width?: WidthWithLiterals;
523
537
  /** Divider alignment. */
524
- alignment?: Alignment;
538
+ alignment?: AlignmentWithLiterals;
525
539
  }
526
- export declare enum LineStyle {
540
+ declare enum LineStyle {
527
541
  /** Single Line */
528
542
  SINGLE = "SINGLE",
529
543
  /** Double Line */
@@ -533,7 +547,9 @@ export declare enum LineStyle {
533
547
  /** Dotted Line */
534
548
  DOTTED = "DOTTED"
535
549
  }
536
- export declare enum Width {
550
+ /** @enumType */
551
+ type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
552
+ declare enum Width {
537
553
  /** Large line */
538
554
  LARGE = "LARGE",
539
555
  /** Medium line */
@@ -541,7 +557,9 @@ export declare enum Width {
541
557
  /** Small line */
542
558
  SMALL = "SMALL"
543
559
  }
544
- export declare enum Alignment {
560
+ /** @enumType */
561
+ type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
562
+ declare enum Alignment {
545
563
  /** Center alignment */
546
564
  CENTER = "CENTER",
547
565
  /** Left alignment */
@@ -549,7 +567,9 @@ export declare enum Alignment {
549
567
  /** Right alignment */
550
568
  RIGHT = "RIGHT"
551
569
  }
552
- export interface FileData {
570
+ /** @enumType */
571
+ type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
572
+ interface FileData {
553
573
  /** Styling for the file's container. */
554
574
  containerData?: PluginContainerData;
555
575
  /** The source for the file's data. */
@@ -572,7 +592,7 @@ export interface FileData {
572
592
  /** File size in KB. */
573
593
  sizeInKb?: string | null;
574
594
  }
575
- export declare enum ViewMode {
595
+ declare enum ViewMode {
576
596
  /** No PDF view */
577
597
  NONE = "NONE",
578
598
  /** Full PDF view */
@@ -580,7 +600,9 @@ export declare enum ViewMode {
580
600
  /** Mini PDF view */
581
601
  MINI = "MINI"
582
602
  }
583
- export interface FileSource extends FileSourceDataOneOf {
603
+ /** @enumType */
604
+ type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
605
+ interface FileSource extends FileSourceDataOneOf {
584
606
  /** The absolute URL for the file's source. */
585
607
  url?: string | null;
586
608
  /**
@@ -594,7 +616,7 @@ export interface FileSource extends FileSourceDataOneOf {
594
616
  private?: boolean | null;
595
617
  }
596
618
  /** @oneof */
597
- export interface FileSourceDataOneOf {
619
+ interface FileSourceDataOneOf {
598
620
  /** The absolute URL for the file's source. */
599
621
  url?: string | null;
600
622
  /**
@@ -605,20 +627,20 @@ export interface FileSourceDataOneOf {
605
627
  /** An ID that's resolved to a URL by a resolver function. */
606
628
  id?: string | null;
607
629
  }
608
- export interface PDFSettings {
630
+ interface PDFSettings {
609
631
  /**
610
632
  * PDF view mode. One of the following:
611
633
  * `NONE` : The PDF isn't displayed.
612
634
  * `FULL` : A full page view of the PDF is displayed.
613
635
  * `MINI` : A mini view of the PDF is displayed.
614
636
  */
615
- viewMode?: ViewMode;
637
+ viewMode?: ViewModeWithLiterals;
616
638
  /** Sets whether the PDF download button is disabled. Defaults to `false`. */
617
639
  disableDownload?: boolean | null;
618
640
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
619
641
  disablePrint?: boolean | null;
620
642
  }
621
- export interface GalleryData {
643
+ interface GalleryData {
622
644
  /** Styling for the gallery's container. */
623
645
  containerData?: PluginContainerData;
624
646
  /** The items in the gallery. */
@@ -630,7 +652,7 @@ export interface GalleryData {
630
652
  /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
631
653
  disableDownload?: boolean | null;
632
654
  }
633
- export interface Media {
655
+ interface Media {
634
656
  /** The source for the media's data. */
635
657
  src?: FileSource;
636
658
  /** Media width in pixels. */
@@ -640,19 +662,19 @@ export interface Media {
640
662
  /** Media duration in seconds. Only relevant for audio and video files. */
641
663
  duration?: number | null;
642
664
  }
643
- export interface Image {
665
+ interface Image {
644
666
  /** Image file details. */
645
667
  media?: Media;
646
668
  /** Link details for images that are links. */
647
669
  link?: Link;
648
670
  }
649
- export interface Video {
671
+ interface Video {
650
672
  /** Video file details. */
651
673
  media?: Media;
652
674
  /** Video thumbnail file details. */
653
675
  thumbnail?: Media;
654
676
  }
655
- export interface Item extends ItemDataOneOf {
677
+ interface Item extends ItemDataOneOf {
656
678
  /** An image item. */
657
679
  image?: Image;
658
680
  /** A video item. */
@@ -663,13 +685,13 @@ export interface Item extends ItemDataOneOf {
663
685
  altText?: string | null;
664
686
  }
665
687
  /** @oneof */
666
- export interface ItemDataOneOf {
688
+ interface ItemDataOneOf {
667
689
  /** An image item. */
668
690
  image?: Image;
669
691
  /** A video item. */
670
692
  video?: Video;
671
693
  }
672
- export interface GalleryOptions {
694
+ interface GalleryOptions {
673
695
  /** Gallery layout. */
674
696
  layout?: Layout;
675
697
  /** Styling for gallery items. */
@@ -677,7 +699,7 @@ export interface GalleryOptions {
677
699
  /** Styling for gallery thumbnail images. */
678
700
  thumbnails?: Thumbnails;
679
701
  }
680
- export declare enum LayoutType {
702
+ declare enum LayoutType {
681
703
  /** Collage type */
682
704
  COLLAGE = "COLLAGE",
683
705
  /** Masonry type */
@@ -699,19 +721,25 @@ export declare enum LayoutType {
699
721
  /** Fullsize images type */
700
722
  FULLSIZE = "FULLSIZE"
701
723
  }
702
- export declare enum Orientation {
724
+ /** @enumType */
725
+ type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
726
+ declare enum Orientation {
703
727
  /** Rows Orientation */
704
728
  ROWS = "ROWS",
705
729
  /** Columns Orientation */
706
730
  COLUMNS = "COLUMNS"
707
731
  }
708
- export declare enum Crop {
732
+ /** @enumType */
733
+ type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
734
+ declare enum Crop {
709
735
  /** Crop to fill */
710
736
  FILL = "FILL",
711
737
  /** Crop to fit */
712
738
  FIT = "FIT"
713
739
  }
714
- export declare enum ThumbnailsAlignment {
740
+ /** @enumType */
741
+ type CropWithLiterals = Crop | 'FILL' | 'FIT';
742
+ declare enum ThumbnailsAlignment {
715
743
  /** Top alignment */
716
744
  TOP = "TOP",
717
745
  /** Right alignment */
@@ -723,35 +751,37 @@ export declare enum ThumbnailsAlignment {
723
751
  /** No thumbnail */
724
752
  NONE = "NONE"
725
753
  }
726
- export interface Layout {
754
+ /** @enumType */
755
+ type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
756
+ interface Layout {
727
757
  /** Gallery layout type. */
728
- type?: LayoutType;
758
+ type?: LayoutTypeWithLiterals;
729
759
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
730
760
  horizontalScroll?: boolean | null;
731
761
  /** Gallery orientation. */
732
- orientation?: Orientation;
762
+ orientation?: OrientationWithLiterals;
733
763
  /** The number of columns to display on full size screens. */
734
764
  numberOfColumns?: number | null;
735
765
  /** The number of columns to display on mobile screens. */
736
766
  mobileNumberOfColumns?: number | null;
737
767
  }
738
- export interface ItemStyle {
768
+ interface ItemStyle {
739
769
  /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
740
770
  targetSize?: number | null;
741
771
  /** Item ratio */
742
772
  ratio?: number | null;
743
773
  /** Sets how item images are cropped. */
744
- crop?: Crop;
774
+ crop?: CropWithLiterals;
745
775
  /** The spacing between items in pixels. */
746
776
  spacing?: number | null;
747
777
  }
748
- export interface Thumbnails {
778
+ interface Thumbnails {
749
779
  /** Thumbnail alignment. */
750
- placement?: ThumbnailsAlignment;
780
+ placement?: ThumbnailsAlignmentWithLiterals;
751
781
  /** Spacing between thumbnails in pixels. */
752
782
  spacing?: number | null;
753
783
  }
754
- export interface GIFData {
784
+ interface GIFData {
755
785
  /** Styling for the GIF's container. */
756
786
  containerData?: PluginContainerData;
757
787
  /** The source of the full size GIF. */
@@ -763,9 +793,9 @@ export interface GIFData {
763
793
  /** Width in pixels. */
764
794
  width?: number;
765
795
  /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
766
- gifType?: GIFType;
796
+ gifType?: GIFTypeWithLiterals;
767
797
  }
768
- export interface GIF {
798
+ interface GIF {
769
799
  /**
770
800
  * GIF format URL.
771
801
  * @format WEB_URL
@@ -782,11 +812,13 @@ export interface GIF {
782
812
  */
783
813
  still?: string | null;
784
814
  }
785
- export declare enum GIFType {
815
+ declare enum GIFType {
786
816
  NORMAL = "NORMAL",
787
817
  STICKER = "STICKER"
788
818
  }
789
- export interface HeadingData {
819
+ /** @enumType */
820
+ type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
821
+ interface HeadingData {
790
822
  /** Heading level from 1-6. */
791
823
  level?: number;
792
824
  /** Styling for the heading text. */
@@ -794,7 +826,7 @@ export interface HeadingData {
794
826
  /** Indentation level from 1-4. */
795
827
  indentation?: number | null;
796
828
  }
797
- export interface HTMLData extends HTMLDataDataOneOf {
829
+ interface HTMLData extends HTMLDataDataOneOf {
798
830
  /** The URL for the HTML code for the node. */
799
831
  url?: string;
800
832
  /** The HTML code for the node. */
@@ -807,12 +839,12 @@ export interface HTMLData extends HTMLDataDataOneOf {
807
839
  /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
808
840
  containerData?: PluginContainerData;
809
841
  /** The type of HTML code. */
810
- source?: Source;
842
+ source?: SourceWithLiterals;
811
843
  /** If container height is aligned with its content height. Defaults to `true`. */
812
844
  autoHeight?: boolean | null;
813
845
  }
814
846
  /** @oneof */
815
- export interface HTMLDataDataOneOf {
847
+ interface HTMLDataDataOneOf {
816
848
  /** The URL for the HTML code for the node. */
817
849
  url?: string;
818
850
  /** The HTML code for the node. */
@@ -823,11 +855,13 @@ export interface HTMLDataDataOneOf {
823
855
  */
824
856
  isAdsense?: boolean | null;
825
857
  }
826
- export declare enum Source {
858
+ declare enum Source {
827
859
  HTML = "HTML",
828
860
  ADSENSE = "ADSENSE"
829
861
  }
830
- export interface ImageData {
862
+ /** @enumType */
863
+ type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
864
+ interface ImageData {
831
865
  /** Styling for the image's container. */
832
866
  containerData?: PluginContainerData;
833
867
  /** Image file details. */
@@ -850,7 +884,7 @@ export interface ImageData {
850
884
  /** Styling for the image. */
851
885
  styles?: ImageDataStyles;
852
886
  }
853
- export interface StylesBorder {
887
+ interface StylesBorder {
854
888
  /** Border width in pixels. */
855
889
  width?: number | null;
856
890
  /**
@@ -861,11 +895,11 @@ export interface StylesBorder {
861
895
  /** Border radius in pixels. */
862
896
  radius?: number | null;
863
897
  }
864
- export interface ImageDataStyles {
898
+ interface ImageDataStyles {
865
899
  /** Border attributes. */
866
900
  border?: StylesBorder;
867
901
  }
868
- export interface LinkPreviewData {
902
+ interface LinkPreviewData {
869
903
  /** Styling for the link preview's container. */
870
904
  containerData?: PluginContainerData;
871
905
  /** Link details. */
@@ -881,7 +915,7 @@ export interface LinkPreviewData {
881
915
  /** Styling for the link preview. */
882
916
  styles?: LinkPreviewDataStyles;
883
917
  }
884
- export declare enum Position {
918
+ declare enum Position {
885
919
  /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
886
920
  START = "START",
887
921
  /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
@@ -891,7 +925,9 @@ export declare enum Position {
891
925
  /** Thumbnail hidden and not displayed */
892
926
  HIDDEN = "HIDDEN"
893
927
  }
894
- export interface LinkPreviewDataStyles {
928
+ /** @enumType */
929
+ type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
930
+ interface LinkPreviewDataStyles {
895
931
  /**
896
932
  * Background color as a hexadecimal value.
897
933
  * @format COLOR_HEX
@@ -922,15 +958,15 @@ export interface LinkPreviewDataStyles {
922
958
  */
923
959
  borderColor?: string | null;
924
960
  /** Position of thumbnail. Defaults to `START`. */
925
- thumbnailPosition?: Position;
961
+ thumbnailPosition?: PositionWithLiterals;
926
962
  }
927
- export interface MapData {
963
+ interface MapData {
928
964
  /** Styling for the map's container. */
929
965
  containerData?: PluginContainerData;
930
966
  /** Map settings. */
931
967
  mapSettings?: MapSettings;
932
968
  }
933
- export interface MapSettings {
969
+ interface MapSettings {
934
970
  /** The address to display on the map. */
935
971
  address?: string | null;
936
972
  /** Sets whether the map is draggable. */
@@ -952,9 +988,9 @@ export interface MapSettings {
952
988
  /** Initial zoom value. */
953
989
  initialZoom?: number | null;
954
990
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
955
- mapType?: MapType;
991
+ mapType?: MapTypeWithLiterals;
956
992
  }
957
- export declare enum MapType {
993
+ declare enum MapType {
958
994
  /** Roadmap map type */
959
995
  ROADMAP = "ROADMAP",
960
996
  /** Satellite map type */
@@ -964,7 +1000,9 @@ export declare enum MapType {
964
1000
  /** Terrain map type */
965
1001
  TERRAIN = "TERRAIN"
966
1002
  }
967
- export interface ParagraphData {
1003
+ /** @enumType */
1004
+ type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
1005
+ interface ParagraphData {
968
1006
  /** Styling for the paragraph text. */
969
1007
  textStyle?: TextStyle;
970
1008
  /** Indentation level from 1-4. */
@@ -972,7 +1010,7 @@ export interface ParagraphData {
972
1010
  /** Paragraph level */
973
1011
  level?: number | null;
974
1012
  }
975
- export interface PollData {
1013
+ interface PollData {
976
1014
  /** Styling for the poll's container. */
977
1015
  containerData?: PluginContainerData;
978
1016
  /** Poll data. */
@@ -982,7 +1020,7 @@ export interface PollData {
982
1020
  /** Styling for the poll and voting options. */
983
1021
  design?: Design;
984
1022
  }
985
- export declare enum ViewRole {
1023
+ declare enum ViewRole {
986
1024
  /** Only Poll creator can view the results */
987
1025
  CREATOR = "CREATOR",
988
1026
  /** Anyone who voted can see the results */
@@ -990,21 +1028,25 @@ export declare enum ViewRole {
990
1028
  /** Anyone can see the results, even if one didn't vote */
991
1029
  EVERYONE = "EVERYONE"
992
1030
  }
993
- export declare enum VoteRole {
1031
+ /** @enumType */
1032
+ type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
1033
+ declare enum VoteRole {
994
1034
  /** Logged in member */
995
1035
  SITE_MEMBERS = "SITE_MEMBERS",
996
1036
  /** Anyone */
997
1037
  ALL = "ALL"
998
1038
  }
999
- export interface Permissions {
1039
+ /** @enumType */
1040
+ type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
1041
+ interface Permissions {
1000
1042
  /** Sets who can view the poll results. */
1001
- view?: ViewRole;
1043
+ view?: ViewRoleWithLiterals;
1002
1044
  /** Sets who can vote. */
1003
- vote?: VoteRole;
1045
+ vote?: VoteRoleWithLiterals;
1004
1046
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1005
1047
  allowMultipleVotes?: boolean | null;
1006
1048
  }
1007
- export interface Option {
1049
+ interface Option {
1008
1050
  /** Option ID. */
1009
1051
  id?: string | null;
1010
1052
  /** Option title. */
@@ -1012,7 +1054,7 @@ export interface Option {
1012
1054
  /** The image displayed with the option. */
1013
1055
  image?: Media;
1014
1056
  }
1015
- export interface Settings {
1057
+ interface Settings {
1016
1058
  /** Permissions settings for voting. */
1017
1059
  permissions?: Permissions;
1018
1060
  /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
@@ -1020,31 +1062,35 @@ export interface Settings {
1020
1062
  /** Sets whether the vote count is displayed. Defaults to `true`. */
1021
1063
  showVotesCount?: boolean | null;
1022
1064
  }
1023
- export declare enum PollLayoutType {
1065
+ declare enum PollLayoutType {
1024
1066
  /** List */
1025
1067
  LIST = "LIST",
1026
1068
  /** Grid */
1027
1069
  GRID = "GRID"
1028
1070
  }
1029
- export declare enum PollLayoutDirection {
1071
+ /** @enumType */
1072
+ type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
1073
+ declare enum PollLayoutDirection {
1030
1074
  /** Left-to-right */
1031
1075
  LTR = "LTR",
1032
1076
  /** Right-to-left */
1033
1077
  RTL = "RTL"
1034
1078
  }
1035
- export interface PollLayout {
1079
+ /** @enumType */
1080
+ type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
1081
+ interface PollLayout {
1036
1082
  /** The layout for displaying the voting options. */
1037
- type?: PollLayoutType;
1083
+ type?: PollLayoutTypeWithLiterals;
1038
1084
  /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1039
- direction?: PollLayoutDirection;
1085
+ direction?: PollLayoutDirectionWithLiterals;
1040
1086
  /** Sets whether to display the main poll image. Defaults to `false`. */
1041
1087
  enableImage?: boolean | null;
1042
1088
  }
1043
- export interface OptionLayout {
1089
+ interface OptionLayout {
1044
1090
  /** Sets whether to display option images. Defaults to `false`. */
1045
1091
  enableImage?: boolean | null;
1046
1092
  }
1047
- export declare enum BackgroundType {
1093
+ declare enum BackgroundType {
1048
1094
  /** Color background type */
1049
1095
  COLOR = "COLOR",
1050
1096
  /** Image background type */
@@ -1052,7 +1098,9 @@ export declare enum BackgroundType {
1052
1098
  /** Gradiant background type */
1053
1099
  GRADIENT = "GRADIENT"
1054
1100
  }
1055
- export interface Gradient {
1101
+ /** @enumType */
1102
+ type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1103
+ interface Gradient {
1056
1104
  /** The gradient angle in degrees. */
1057
1105
  angle?: number | null;
1058
1106
  /**
@@ -1066,7 +1114,7 @@ export interface Gradient {
1066
1114
  */
1067
1115
  lastColor?: string | null;
1068
1116
  }
1069
- export interface Background extends BackgroundBackgroundOneOf {
1117
+ interface Background extends BackgroundBackgroundOneOf {
1070
1118
  /**
1071
1119
  * The background color as a hexademical value.
1072
1120
  * @format COLOR_HEX
@@ -1077,10 +1125,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1077
1125
  /** Details for a gradient background. */
1078
1126
  gradient?: Gradient;
1079
1127
  /** Background type. For each option, include the relevant details. */
1080
- type?: BackgroundType;
1128
+ type?: BackgroundTypeWithLiterals;
1081
1129
  }
1082
1130
  /** @oneof */
1083
- export interface BackgroundBackgroundOneOf {
1131
+ interface BackgroundBackgroundOneOf {
1084
1132
  /**
1085
1133
  * The background color as a hexademical value.
1086
1134
  * @format COLOR_HEX
@@ -1091,17 +1139,17 @@ export interface BackgroundBackgroundOneOf {
1091
1139
  /** Details for a gradient background. */
1092
1140
  gradient?: Gradient;
1093
1141
  }
1094
- export interface PollDesign {
1142
+ interface PollDesign {
1095
1143
  /** Background styling. */
1096
1144
  background?: Background;
1097
1145
  /** Border radius in pixels. */
1098
1146
  borderRadius?: number | null;
1099
1147
  }
1100
- export interface OptionDesign {
1148
+ interface OptionDesign {
1101
1149
  /** Border radius in pixels. */
1102
1150
  borderRadius?: number | null;
1103
1151
  }
1104
- export interface Poll {
1152
+ interface Poll {
1105
1153
  /** Poll ID. */
1106
1154
  id?: string | null;
1107
1155
  /** Poll title. */
@@ -1115,26 +1163,26 @@ export interface Poll {
1115
1163
  /** The poll's permissions and display settings. */
1116
1164
  settings?: Settings;
1117
1165
  }
1118
- export interface PollDataLayout {
1166
+ interface PollDataLayout {
1119
1167
  /** Poll layout settings. */
1120
1168
  poll?: PollLayout;
1121
1169
  /** Voting otpions layout settings. */
1122
1170
  options?: OptionLayout;
1123
1171
  }
1124
- export interface Design {
1172
+ interface Design {
1125
1173
  /** Styling for the poll. */
1126
1174
  poll?: PollDesign;
1127
1175
  /** Styling for voting options. */
1128
1176
  options?: OptionDesign;
1129
1177
  }
1130
- export interface TextData {
1178
+ interface TextData {
1131
1179
  /** The text to apply decorations to. */
1132
1180
  text?: string;
1133
1181
  /** The decorations to apply. */
1134
1182
  decorations?: Decoration[];
1135
1183
  }
1136
1184
  /** Adds appearence changes to text */
1137
- export interface Decoration extends DecorationDataOneOf {
1185
+ interface Decoration extends DecorationDataOneOf {
1138
1186
  /** Data for an anchor link decoration. */
1139
1187
  anchorData?: AnchorData;
1140
1188
  /** Data for a color decoration. */
@@ -1156,10 +1204,10 @@ export interface Decoration extends DecorationDataOneOf {
1156
1204
  /** Data for a strikethrough decoration. Defaults to `true`. */
1157
1205
  strikethroughData?: boolean | null;
1158
1206
  /** The type of decoration to apply. */
1159
- type?: DecorationType;
1207
+ type?: DecorationTypeWithLiterals;
1160
1208
  }
1161
1209
  /** @oneof */
1162
- export interface DecorationDataOneOf {
1210
+ interface DecorationDataOneOf {
1163
1211
  /** Data for an anchor link decoration. */
1164
1212
  anchorData?: AnchorData;
1165
1213
  /** Data for a color decoration. */
@@ -1181,7 +1229,7 @@ export interface DecorationDataOneOf {
1181
1229
  /** Data for a strikethrough decoration. Defaults to `true`. */
1182
1230
  strikethroughData?: boolean | null;
1183
1231
  }
1184
- export declare enum DecorationType {
1232
+ declare enum DecorationType {
1185
1233
  BOLD = "BOLD",
1186
1234
  ITALIC = "ITALIC",
1187
1235
  UNDERLINE = "UNDERLINE",
@@ -1194,21 +1242,23 @@ export declare enum DecorationType {
1194
1242
  EXTERNAL = "EXTERNAL",
1195
1243
  STRIKETHROUGH = "STRIKETHROUGH"
1196
1244
  }
1197
- export interface AnchorData {
1245
+ /** @enumType */
1246
+ type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
1247
+ interface AnchorData {
1198
1248
  /** The target node's ID. */
1199
1249
  anchor?: string;
1200
1250
  }
1201
- export interface ColorData {
1251
+ interface ColorData {
1202
1252
  /** The text's background color as a hexadecimal value. */
1203
1253
  background?: string | null;
1204
1254
  /** The text's foreground color as a hexadecimal value. */
1205
1255
  foreground?: string | null;
1206
1256
  }
1207
- export interface LinkData {
1257
+ interface LinkData {
1208
1258
  /** Link details. */
1209
1259
  link?: Link;
1210
1260
  }
1211
- export interface MentionData {
1261
+ interface MentionData {
1212
1262
  /** The mentioned user's name. */
1213
1263
  name?: string;
1214
1264
  /** The version of the user's name that appears after the `@` character in the mention. */
@@ -1216,27 +1266,29 @@ export interface MentionData {
1216
1266
  /** Mentioned user's ID. */
1217
1267
  id?: string | null;
1218
1268
  }
1219
- export interface FontSizeData {
1269
+ interface FontSizeData {
1220
1270
  /** The units used for the font size. */
1221
- unit?: FontType;
1271
+ unit?: FontTypeWithLiterals;
1222
1272
  /** Font size value. */
1223
1273
  value?: number | null;
1224
1274
  }
1225
- export declare enum FontType {
1275
+ declare enum FontType {
1226
1276
  PX = "PX",
1227
1277
  EM = "EM"
1228
1278
  }
1229
- export interface SpoilerData {
1279
+ /** @enumType */
1280
+ type FontTypeWithLiterals = FontType | 'PX' | 'EM';
1281
+ interface SpoilerData {
1230
1282
  /** Spoiler ID. */
1231
1283
  id?: string | null;
1232
1284
  }
1233
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1285
+ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1234
1286
  /** Data for embedded Wix Bookings content. */
1235
1287
  bookingData?: BookingData;
1236
1288
  /** Data for embedded Wix Events content. */
1237
1289
  eventData?: EventData;
1238
1290
  /** The type of Wix App content being embedded. */
1239
- type?: AppType;
1291
+ type?: AppTypeWithLiterals;
1240
1292
  /** The ID of the embedded content. */
1241
1293
  itemId?: string | null;
1242
1294
  /** The name of the embedded content. */
@@ -1252,28 +1304,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1252
1304
  image?: Media;
1253
1305
  }
1254
1306
  /** @oneof */
1255
- export interface AppEmbedDataAppDataOneOf {
1307
+ interface AppEmbedDataAppDataOneOf {
1256
1308
  /** Data for embedded Wix Bookings content. */
1257
1309
  bookingData?: BookingData;
1258
1310
  /** Data for embedded Wix Events content. */
1259
1311
  eventData?: EventData;
1260
1312
  }
1261
- export declare enum AppType {
1313
+ declare enum AppType {
1262
1314
  PRODUCT = "PRODUCT",
1263
1315
  EVENT = "EVENT",
1264
1316
  BOOKING = "BOOKING"
1265
1317
  }
1266
- export interface BookingData {
1318
+ /** @enumType */
1319
+ type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
1320
+ interface BookingData {
1267
1321
  /** Booking duration in minutes. */
1268
1322
  durations?: string | null;
1269
1323
  }
1270
- export interface EventData {
1324
+ interface EventData {
1271
1325
  /** Event schedule. */
1272
1326
  scheduling?: string | null;
1273
1327
  /** Event location. */
1274
1328
  location?: string | null;
1275
1329
  }
1276
- export interface VideoData {
1330
+ interface VideoData {
1277
1331
  /** Styling for the video's container. */
1278
1332
  containerData?: PluginContainerData;
1279
1333
  /** Video details. */
@@ -1287,7 +1341,7 @@ export interface VideoData {
1287
1341
  /** Video options. */
1288
1342
  options?: PlaybackOptions;
1289
1343
  }
1290
- export interface PlaybackOptions {
1344
+ interface PlaybackOptions {
1291
1345
  /** Sets whether the media will automatically start playing. */
1292
1346
  autoPlay?: boolean | null;
1293
1347
  /** Sets whether media's will be looped. */
@@ -1295,7 +1349,7 @@ export interface PlaybackOptions {
1295
1349
  /** Sets whether media's controls will be shown. */
1296
1350
  showControls?: boolean | null;
1297
1351
  }
1298
- export interface EmbedData {
1352
+ interface EmbedData {
1299
1353
  /** Styling for the oEmbed node's container. */
1300
1354
  containerData?: PluginContainerData;
1301
1355
  /** An [oEmbed](https://www.oembed.com) object. */
@@ -1303,7 +1357,7 @@ export interface EmbedData {
1303
1357
  /** Origin asset source. */
1304
1358
  src?: string | null;
1305
1359
  }
1306
- export interface Oembed {
1360
+ interface Oembed {
1307
1361
  /** The resource type. */
1308
1362
  type?: string | null;
1309
1363
  /** The width of the resource specified in the `url` property in pixels. */
@@ -1335,19 +1389,19 @@ export interface Oembed {
1335
1389
  /** The oEmbed version number. This value must be `1.0`. */
1336
1390
  version?: string | null;
1337
1391
  }
1338
- export interface CollapsibleListData {
1392
+ interface CollapsibleListData {
1339
1393
  /** Styling for the collapsible list's container. */
1340
1394
  containerData?: PluginContainerData;
1341
1395
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1342
1396
  expandOnlyOne?: boolean | null;
1343
1397
  /** Sets which items are expanded when the page loads. */
1344
- initialExpandedItems?: InitialExpandedItems;
1398
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
1345
1399
  /** The direction of the text in the list. Either left-to-right or right-to-left. */
1346
- direction?: Direction;
1400
+ direction?: DirectionWithLiterals;
1347
1401
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
1348
1402
  isQapageData?: boolean | null;
1349
1403
  }
1350
- export declare enum InitialExpandedItems {
1404
+ declare enum InitialExpandedItems {
1351
1405
  /** First item will be expended initally */
1352
1406
  FIRST = "FIRST",
1353
1407
  /** All items will expended initally */
@@ -1355,13 +1409,17 @@ export declare enum InitialExpandedItems {
1355
1409
  /** All items collapsed initally */
1356
1410
  NONE = "NONE"
1357
1411
  }
1358
- export declare enum Direction {
1412
+ /** @enumType */
1413
+ type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
1414
+ declare enum Direction {
1359
1415
  /** Left-to-right */
1360
1416
  LTR = "LTR",
1361
1417
  /** Right-to-left */
1362
1418
  RTL = "RTL"
1363
1419
  }
1364
- export interface TableData {
1420
+ /** @enumType */
1421
+ type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
1422
+ interface TableData {
1365
1423
  /** Styling for the table's container. */
1366
1424
  containerData?: PluginContainerData;
1367
1425
  /** The table's dimensions. */
@@ -1376,7 +1434,7 @@ export interface TableData {
1376
1434
  /** Sets whether the table's first column is a header. Defaults to `false`. */
1377
1435
  columnHeader?: boolean | null;
1378
1436
  }
1379
- export interface Dimensions {
1437
+ interface Dimensions {
1380
1438
  /** An array representing relative width of each column in relation to the other columns. */
1381
1439
  colsWidthRatio?: number[];
1382
1440
  /** An array representing the height of each row in pixels. */
@@ -1384,13 +1442,13 @@ export interface Dimensions {
1384
1442
  /** An array representing the minimum width of each column in pixels. */
1385
1443
  colsMinWidth?: number[];
1386
1444
  }
1387
- export interface TableCellData {
1445
+ interface TableCellData {
1388
1446
  /** Styling for the cell's background color and text alignment. */
1389
1447
  cellStyle?: CellStyle;
1390
1448
  /** The cell's border colors. */
1391
1449
  borderColors?: BorderColors;
1392
1450
  }
1393
- export declare enum VerticalAlignment {
1451
+ declare enum VerticalAlignment {
1394
1452
  /** Top alignment */
1395
1453
  TOP = "TOP",
1396
1454
  /** Middle alignment */
@@ -1398,16 +1456,18 @@ export declare enum VerticalAlignment {
1398
1456
  /** Bottom alignment */
1399
1457
  BOTTOM = "BOTTOM"
1400
1458
  }
1401
- export interface CellStyle {
1459
+ /** @enumType */
1460
+ type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
1461
+ interface CellStyle {
1402
1462
  /** Vertical alignment for the cell's text. */
1403
- verticalAlignment?: VerticalAlignment;
1463
+ verticalAlignment?: VerticalAlignmentWithLiterals;
1404
1464
  /**
1405
1465
  * Cell background color as a hexadecimal value.
1406
1466
  * @format COLOR_HEX
1407
1467
  */
1408
1468
  backgroundColor?: string | null;
1409
1469
  }
1410
- export interface BorderColors {
1470
+ interface BorderColors {
1411
1471
  /**
1412
1472
  * Left border color as a hexadecimal value.
1413
1473
  * @format COLOR_HEX
@@ -1435,7 +1495,7 @@ export interface BorderColors {
1435
1495
  *
1436
1496
  * The JSON representation for `NullValue` is JSON `null`.
1437
1497
  */
1438
- export declare enum NullValue {
1498
+ declare enum NullValue {
1439
1499
  /** Null value. */
1440
1500
  NULL_VALUE = "NULL_VALUE"
1441
1501
  }
@@ -1444,11 +1504,11 @@ export declare enum NullValue {
1444
1504
  *
1445
1505
  * The JSON representation for `ListValue` is JSON array.
1446
1506
  */
1447
- export interface ListValue {
1507
+ interface ListValue {
1448
1508
  /** Repeated field of dynamically typed values. */
1449
1509
  values?: any[];
1450
1510
  }
1451
- export interface AudioData {
1511
+ interface AudioData {
1452
1512
  /** Styling for the audio node's container. */
1453
1513
  containerData?: PluginContainerData;
1454
1514
  /** Audio file details. */
@@ -1464,7 +1524,7 @@ export interface AudioData {
1464
1524
  /** An HTML version of the audio node. */
1465
1525
  html?: string | null;
1466
1526
  }
1467
- export interface OrderedListData {
1527
+ interface OrderedListData {
1468
1528
  /** Indentation level from 0-4. */
1469
1529
  indentation?: number;
1470
1530
  /** Offset level from 0-4. */
@@ -1472,24 +1532,24 @@ export interface OrderedListData {
1472
1532
  /** List start number. */
1473
1533
  start?: number | null;
1474
1534
  }
1475
- export interface BulletedListData {
1535
+ interface BulletedListData {
1476
1536
  /** Indentation level from 0-4. */
1477
1537
  indentation?: number;
1478
1538
  /** Offset level from 0-4. */
1479
1539
  offset?: number | null;
1480
1540
  }
1481
- export interface BlockquoteData {
1541
+ interface BlockquoteData {
1482
1542
  /** Indentation level from 1-4. */
1483
1543
  indentation?: number;
1484
1544
  }
1485
- export interface CaptionData {
1545
+ interface CaptionData {
1486
1546
  textStyle?: TextStyle;
1487
1547
  }
1488
- export interface LayoutCellData {
1548
+ interface LayoutCellData {
1489
1549
  /** Size of the cell in 12 columns grid. */
1490
1550
  colSpan?: number | null;
1491
1551
  }
1492
- export interface Metadata {
1552
+ interface Metadata {
1493
1553
  /** Schema version. */
1494
1554
  version?: number;
1495
1555
  /**
@@ -1506,7 +1566,7 @@ export interface Metadata {
1506
1566
  /** Object ID. */
1507
1567
  _id?: string | null;
1508
1568
  }
1509
- export interface DocumentStyle {
1569
+ interface DocumentStyle {
1510
1570
  /** Styling for H1 nodes. */
1511
1571
  headerOne?: TextNodeStyle;
1512
1572
  /** Styling for H2 nodes. */
@@ -1526,7 +1586,7 @@ export interface DocumentStyle {
1526
1586
  /** Styling for code block nodes. */
1527
1587
  codeBlock?: TextNodeStyle;
1528
1588
  }
1529
- export interface TextNodeStyle {
1589
+ interface TextNodeStyle {
1530
1590
  /** The decorations to apply to the node. */
1531
1591
  decorations?: Decoration[];
1532
1592
  /** Padding and background color for the node. */
@@ -1534,7 +1594,7 @@ export interface TextNodeStyle {
1534
1594
  /** Line height for text in the node. */
1535
1595
  lineHeight?: string | null;
1536
1596
  }
1537
- export interface FocalPoint {
1597
+ interface FocalPoint {
1538
1598
  /** X-coordinate of the focal point. */
1539
1599
  x?: number;
1540
1600
  /** Y-coordinate of the focal point. */
@@ -1544,7 +1604,7 @@ export interface FocalPoint {
1544
1604
  /** crop by width */
1545
1605
  width?: number | null;
1546
1606
  }
1547
- export interface VideoResolution {
1607
+ interface VideoResolution {
1548
1608
  /** Video URL. */
1549
1609
  url?: string;
1550
1610
  /** Video height. */
@@ -1554,7 +1614,7 @@ export interface VideoResolution {
1554
1614
  /** Video format for example, mp4, hls. */
1555
1615
  format?: string;
1556
1616
  }
1557
- export interface ExtendedFields {
1617
+ interface ExtendedFields {
1558
1618
  /**
1559
1619
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1560
1620
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -1565,22 +1625,22 @@ export interface ExtendedFields {
1565
1625
  */
1566
1626
  namespaces?: Record<string, Record<string, any>>;
1567
1627
  }
1568
- export interface GetPublishedContentRequest {
1628
+ interface GetPublishedContentRequest {
1569
1629
  /**
1570
1630
  * The ID of the published content
1571
1631
  * @format GUID
1572
1632
  */
1573
1633
  contentId?: string;
1574
1634
  }
1575
- export interface GetPublishedContentResponse {
1635
+ interface GetPublishedContentResponse {
1576
1636
  /** The published content */
1577
1637
  publishedContent?: PublishedContent;
1578
1638
  }
1579
- export interface QueryPublishedContentRequest {
1639
+ interface QueryPublishedContentRequest {
1580
1640
  /** Query options. Note that some query filters are required. See the API description for a list of required filters. */
1581
1641
  query: CursorQuery;
1582
1642
  }
1583
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1643
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
1584
1644
  /**
1585
1645
  * Cursor paging options.
1586
1646
  *
@@ -1602,7 +1662,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1602
1662
  sort?: Sorting[];
1603
1663
  }
1604
1664
  /** @oneof */
1605
- export interface CursorQueryPagingMethodOneOf {
1665
+ interface CursorQueryPagingMethodOneOf {
1606
1666
  /**
1607
1667
  * Cursor paging options.
1608
1668
  *
@@ -1610,20 +1670,22 @@ export interface CursorQueryPagingMethodOneOf {
1610
1670
  */
1611
1671
  cursorPaging?: CursorPaging;
1612
1672
  }
1613
- export interface Sorting {
1673
+ interface Sorting {
1614
1674
  /**
1615
1675
  * Name of the field to sort by.
1616
1676
  * @maxLength 512
1617
1677
  */
1618
1678
  fieldName?: string;
1619
1679
  /** Sort order. */
1620
- order?: SortOrder;
1680
+ order?: SortOrderWithLiterals;
1621
1681
  }
1622
- export declare enum SortOrder {
1682
+ declare enum SortOrder {
1623
1683
  ASC = "ASC",
1624
1684
  DESC = "DESC"
1625
1685
  }
1626
- export interface CursorPaging {
1686
+ /** @enumType */
1687
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1688
+ interface CursorPaging {
1627
1689
  /**
1628
1690
  * Maximum number of items to return in the results.
1629
1691
  * @max 100
@@ -1638,13 +1700,13 @@ export interface CursorPaging {
1638
1700
  */
1639
1701
  cursor?: string | null;
1640
1702
  }
1641
- export interface QueryPublishedContentResponse {
1703
+ interface QueryPublishedContentResponse {
1642
1704
  /** The published translation content. */
1643
1705
  publishedContent?: PublishedContent[];
1644
1706
  /** Details on the paged set of results returned. */
1645
1707
  pagingMetadata?: CursorPagingMetadata;
1646
1708
  }
1647
- export interface CursorPagingMetadata {
1709
+ interface CursorPagingMetadata {
1648
1710
  /** Number of items returned in current page. */
1649
1711
  count?: number | null;
1650
1712
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -1657,7 +1719,7 @@ export interface CursorPagingMetadata {
1657
1719
  */
1658
1720
  hasNext?: boolean | null;
1659
1721
  }
1660
- export interface Cursors {
1722
+ interface Cursors {
1661
1723
  /**
1662
1724
  * Cursor string pointing to the next page in the list of results.
1663
1725
  * @maxLength 16000
@@ -1669,7 +1731,7 @@ export interface Cursors {
1669
1731
  */
1670
1732
  prev?: string | null;
1671
1733
  }
1672
- export interface DomainEvent extends DomainEventBodyOneOf {
1734
+ interface DomainEvent extends DomainEventBodyOneOf {
1673
1735
  createdEvent?: EntityCreatedEvent;
1674
1736
  updatedEvent?: EntityUpdatedEvent;
1675
1737
  deletedEvent?: EntityDeletedEvent;
@@ -1704,19 +1766,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1704
1766
  entityEventSequence?: string | null;
1705
1767
  }
1706
1768
  /** @oneof */
1707
- export interface DomainEventBodyOneOf {
1769
+ interface DomainEventBodyOneOf {
1708
1770
  createdEvent?: EntityCreatedEvent;
1709
1771
  updatedEvent?: EntityUpdatedEvent;
1710
1772
  deletedEvent?: EntityDeletedEvent;
1711
1773
  actionEvent?: ActionEvent;
1712
1774
  }
1713
- export interface EntityCreatedEvent {
1775
+ interface EntityCreatedEvent {
1714
1776
  entity?: string;
1715
1777
  }
1716
- export interface RestoreInfo {
1778
+ interface RestoreInfo {
1717
1779
  deletedDate?: Date | null;
1718
1780
  }
1719
- export interface EntityUpdatedEvent {
1781
+ interface EntityUpdatedEvent {
1720
1782
  /**
1721
1783
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1722
1784
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -1724,25 +1786,25 @@ export interface EntityUpdatedEvent {
1724
1786
  */
1725
1787
  currentEntity?: string;
1726
1788
  }
1727
- export interface EntityDeletedEvent {
1789
+ interface EntityDeletedEvent {
1728
1790
  /** Entity that was deleted. */
1729
1791
  deletedEntity?: string | null;
1730
1792
  }
1731
- export interface ActionEvent {
1793
+ interface ActionEvent {
1732
1794
  body?: string;
1733
1795
  }
1734
- export interface Empty {
1796
+ interface Empty {
1735
1797
  }
1736
- export interface DeletePublishedContentRequest {
1798
+ interface DeletePublishedContentRequest {
1737
1799
  /**
1738
1800
  * The ID of the published content to delete
1739
1801
  * @format GUID
1740
1802
  */
1741
1803
  contentId?: string;
1742
1804
  }
1743
- export interface DeletePublishedContentResponse {
1805
+ interface DeletePublishedContentResponse {
1744
1806
  }
1745
- export interface MessageEnvelope {
1807
+ interface MessageEnvelope {
1746
1808
  /**
1747
1809
  * App instance ID.
1748
1810
  * @format GUID
@@ -1758,7 +1820,7 @@ export interface MessageEnvelope {
1758
1820
  /** Stringify payload. */
1759
1821
  data?: string;
1760
1822
  }
1761
- export interface IdentificationData extends IdentificationDataIdOneOf {
1823
+ interface IdentificationData extends IdentificationDataIdOneOf {
1762
1824
  /**
1763
1825
  * ID of a site visitor that has not logged in to the site.
1764
1826
  * @format GUID
@@ -1780,10 +1842,10 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1780
1842
  */
1781
1843
  appId?: string;
1782
1844
  /** @readonly */
1783
- identityType?: WebhookIdentityType;
1845
+ identityType?: WebhookIdentityTypeWithLiterals;
1784
1846
  }
1785
1847
  /** @oneof */
1786
- export interface IdentificationDataIdOneOf {
1848
+ interface IdentificationDataIdOneOf {
1787
1849
  /**
1788
1850
  * ID of a site visitor that has not logged in to the site.
1789
1851
  * @format GUID
@@ -1805,14 +1867,16 @@ export interface IdentificationDataIdOneOf {
1805
1867
  */
1806
1868
  appId?: string;
1807
1869
  }
1808
- export declare enum WebhookIdentityType {
1870
+ declare enum WebhookIdentityType {
1809
1871
  UNKNOWN = "UNKNOWN",
1810
1872
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1811
1873
  MEMBER = "MEMBER",
1812
1874
  WIX_USER = "WIX_USER",
1813
1875
  APP = "APP"
1814
1876
  }
1815
- export interface BaseEventMetadata {
1877
+ /** @enumType */
1878
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1879
+ interface BaseEventMetadata {
1816
1880
  /**
1817
1881
  * App instance ID.
1818
1882
  * @format GUID
@@ -1826,7 +1890,7 @@ export interface BaseEventMetadata {
1826
1890
  /** The identification type and identity data. */
1827
1891
  identity?: IdentificationData;
1828
1892
  }
1829
- export interface EventMetadata extends BaseEventMetadata {
1893
+ interface EventMetadata extends BaseEventMetadata {
1830
1894
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1831
1895
  _id?: string;
1832
1896
  /**
@@ -1856,86 +1920,18 @@ export interface EventMetadata extends BaseEventMetadata {
1856
1920
  */
1857
1921
  entityEventSequence?: string | null;
1858
1922
  }
1859
- export interface PublishedContentCreatedEnvelope {
1923
+ interface PublishedContentCreatedEnvelope {
1860
1924
  entity: PublishedContent;
1861
1925
  metadata: EventMetadata;
1862
1926
  }
1863
- /**
1864
- * Triggered when published content is created.
1865
- * @permissionScope Wix Multilingual - Translation API
1866
- * @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
1867
- * @permissionScope Wix Multilingual - Translation Content + Published Content Read
1868
- * @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
1869
- * @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
1870
- * @webhook
1871
- * @eventType wix.multilingual.localization_public.v3.published_content_created
1872
- * @slug created
1873
- */
1874
- export declare function onPublishedContentCreated(handler: (event: PublishedContentCreatedEnvelope) => void | Promise<void>): void;
1875
- export interface PublishedContentDeletedEnvelope {
1927
+ interface PublishedContentDeletedEnvelope {
1876
1928
  entity: PublishedContent;
1877
1929
  metadata: EventMetadata;
1878
1930
  }
1879
- /**
1880
- * Triggered when published content is deleted.
1881
- * @permissionScope Wix Multilingual - Translation API
1882
- * @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
1883
- * @permissionScope Wix Multilingual - Translation Content + Published Content Read
1884
- * @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
1885
- * @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
1886
- * @webhook
1887
- * @eventType wix.multilingual.localization_public.v3.published_content_deleted
1888
- * @slug deleted
1889
- */
1890
- export declare function onPublishedContentDeleted(handler: (event: PublishedContentDeletedEnvelope) => void | Promise<void>): void;
1891
- export interface PublishedContentUpdatedEnvelope {
1931
+ interface PublishedContentUpdatedEnvelope {
1892
1932
  entity: PublishedContent;
1893
1933
  metadata: EventMetadata;
1894
1934
  }
1895
- /**
1896
- * Triggered when published content is updated.
1897
- * @permissionScope Wix Multilingual - Translation API
1898
- * @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
1899
- * @permissionScope Wix Multilingual - Translation Content + Published Content Read
1900
- * @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
1901
- * @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
1902
- * @webhook
1903
- * @eventType wix.multilingual.localization_public.v3.published_content_updated
1904
- * @slug updated
1905
- */
1906
- export declare function onPublishedContentUpdated(handler: (event: PublishedContentUpdatedEnvelope) => void | Promise<void>): void;
1907
- /**
1908
- * Creates a query to retrieve a list of translation content items.
1909
- *
1910
- * The `queryPublishedContent()` function builds a query to retrieve a list of translation content items and returns a `PublishedContentQueryBuilder` object.
1911
- *
1912
- * The returned object contains the query definition, which is used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-builder/find) function.
1913
- *
1914
- * You can refine the query by chaining `PublishedContentQueryBuilder` functions onto the query. `PublishedContentQueryBuilder` functions enable you to filter, sort, and control the results that `queryPublishedContent()` returns.
1915
- *
1916
- * `queryPublishedContent()` runs with the following `PublishedContentQueryBuilder` defaults which you can override:
1917
- *
1918
- * + [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-builder/limit)
1919
- * + [`ascending('_id')`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-builder/ascending)
1920
- *
1921
- * The following query filter fields are required:
1922
- *
1923
- * + `schemaKey.appId`
1924
- * + `schemaKey.entityType`
1925
- * + `schemaKey.scope`
1926
- *
1927
- * The following `PublishedContentQueryBuilder` functions are supported for `queryPublishedContent()`. For a full description of the operations object, see the object returned for the [`items`](https://dev.wix.com/docs/sdk/backend-modules/multilingual/translation/translation-published-content/published-content-query-result/items) property in `PublishedContentQueryResult`.
1928
- * @public
1929
- * @permissionScope Wix Multilingual - Translation API
1930
- * @permissionScopeId SCOPE.MULTILINGUAL.MANAGE_TRANSLATIONS
1931
- * @permissionScope Wix Multilingual - Translation Content + Published Content Read
1932
- * @permissionScopeId SCOPE.DC-MULTILINGUAL.READ_TRANSLATION_CONTENT
1933
- * @permissionId WIX_MULTILINGUAL.READ_PUBLISHED_TRANSLATIONS
1934
- * @applicableIdentity APP
1935
- * @applicableIdentity VISITOR
1936
- * @fqn com.wixpress.localizationpublic.v3.TranslationPublishedContent.QueryPublishedContent
1937
- */
1938
- export declare function queryPublishedContent(): PublishedContentQueryBuilder;
1939
1935
  interface QueryCursorResult {
1940
1936
  cursors: Cursors;
1941
1937
  hasNext: () => boolean;
@@ -1943,13 +1939,13 @@ interface QueryCursorResult {
1943
1939
  length: number;
1944
1940
  pageSize: number;
1945
1941
  }
1946
- export interface PublishedContentQueryResult extends QueryCursorResult {
1942
+ interface PublishedContentQueryResult extends QueryCursorResult {
1947
1943
  items: PublishedContent[];
1948
1944
  query: PublishedContentQueryBuilder;
1949
1945
  next: () => Promise<PublishedContentQueryResult>;
1950
1946
  prev: () => Promise<PublishedContentQueryResult>;
1951
1947
  }
1952
- export interface PublishedContentQueryBuilder {
1948
+ interface PublishedContentQueryBuilder {
1953
1949
  /** @param propertyName - Property whose value is compared with `value`.
1954
1950
  * @param value - Value to compare against.
1955
1951
  */
@@ -1958,6 +1954,22 @@ export interface PublishedContentQueryBuilder {
1958
1954
  * @param value - Value to compare against.
1959
1955
  */
1960
1956
  ne: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'schemaKey.scope' | 'entityId' | 'locale' | 'parentEntityId', value: any) => PublishedContentQueryBuilder;
1957
+ /** @param propertyName - Property whose value is compared with `value`.
1958
+ * @param value - Value to compare against.
1959
+ */
1960
+ ge: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'entityId' | 'locale' | 'parentEntityId', value: any) => PublishedContentQueryBuilder;
1961
+ /** @param propertyName - Property whose value is compared with `value`.
1962
+ * @param value - Value to compare against.
1963
+ */
1964
+ gt: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'entityId' | 'locale' | 'parentEntityId', value: any) => PublishedContentQueryBuilder;
1965
+ /** @param propertyName - Property whose value is compared with `value`.
1966
+ * @param value - Value to compare against.
1967
+ */
1968
+ le: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'entityId' | 'locale' | 'parentEntityId', value: any) => PublishedContentQueryBuilder;
1969
+ /** @param propertyName - Property whose value is compared with `value`.
1970
+ * @param value - Value to compare against.
1971
+ */
1972
+ lt: (propertyName: '_id' | 'schemaKey.appId' | 'schemaKey.entityType' | 'entityId' | 'locale' | 'parentEntityId', value: any) => PublishedContentQueryBuilder;
1961
1973
  /** @param propertyName - Property whose value is compared with `string`.
1962
1974
  * @param string - String to compare against. Case-insensitive.
1963
1975
  */
@@ -1978,4 +1990,5 @@ export interface PublishedContentQueryBuilder {
1978
1990
  skipTo: (cursor: string) => PublishedContentQueryBuilder;
1979
1991
  find: () => Promise<PublishedContentQueryResult>;
1980
1992
  }
1981
- export {};
1993
+
1994
+ export { type Styles as $, Alignment as A, BackgroundType as B, Crop as C, DecorationType as D, type NodeDataOneOf as E, FontType as F, GIFType as G, type NodeStyle as H, InitialExpandedItems as I, type ButtonData as J, type Border as K, LineStyle as L, MapType as M, NodeType as N, Orientation as O, type PublishedContentQueryBuilder as P, type Colors as Q, type RichContent as R, SchemaScope as S, Type as T, type PluginContainerData as U, ViewMode as V, WidthType as W, type PluginContainerDataWidth as X, type PluginContainerDataWidthDataOneOf as Y, type Spoiler as Z, type Height as _, type PublishedContentCreatedEnvelope as a, type Oembed as a$, type Link as a0, type LinkDataOneOf as a1, type Rel as a2, type CodeBlockData as a3, type TextStyle as a4, type DividerData as a5, type FileData as a6, type FileSource as a7, type FileSourceDataOneOf as a8, type PDFSettings as a9, type Settings as aA, type PollLayout as aB, type OptionLayout as aC, type Gradient as aD, type Background as aE, type BackgroundBackgroundOneOf as aF, type PollDesign as aG, type OptionDesign as aH, type Poll as aI, type PollDataLayout as aJ, type Design as aK, type TextData as aL, type Decoration as aM, type DecorationDataOneOf as aN, type AnchorData as aO, type ColorData as aP, type LinkData as aQ, type MentionData as aR, type FontSizeData as aS, type SpoilerData as aT, type AppEmbedData as aU, type AppEmbedDataAppDataOneOf as aV, type BookingData as aW, type EventData as aX, type VideoData as aY, type PlaybackOptions as aZ, type EmbedData as a_, type GalleryData as aa, type Media as ab, type Image as ac, type Video as ad, type Item as ae, type ItemDataOneOf as af, type GalleryOptions as ag, type Layout as ah, type ItemStyle as ai, type Thumbnails as aj, type GIFData as ak, type GIF as al, type HeadingData as am, type HTMLData as an, type HTMLDataDataOneOf as ao, type ImageData as ap, type StylesBorder as aq, type ImageDataStyles as ar, type LinkPreviewData as as, type LinkPreviewDataStyles as at, type MapData as au, type MapSettings as av, type ParagraphData as aw, type PollData as ax, type Permissions as ay, type Option as az, type PublishedContentDeletedEnvelope as b, type CollapsibleListData as b0, type TableData as b1, type Dimensions as b2, type TableCellData as b3, type CellStyle as b4, type BorderColors as b5, type ListValue as b6, type AudioData as b7, type OrderedListData as b8, type BulletedListData as b9, type Empty as bA, type DeletePublishedContentRequest as bB, type DeletePublishedContentResponse as bC, type MessageEnvelope as bD, type IdentificationData as bE, type IdentificationDataIdOneOf as bF, type BaseEventMetadata as bG, type EventMetadata as bH, type PublishedContentQueryResult as bI, type BlockquoteData as ba, type CaptionData as bb, type LayoutCellData as bc, type Metadata as bd, type DocumentStyle as be, type TextNodeStyle as bf, type FocalPoint as bg, type VideoResolution as bh, type ExtendedFields as bi, type GetPublishedContentRequest as bj, type GetPublishedContentResponse as bk, type QueryPublishedContentRequest as bl, type CursorQuery as bm, type CursorQueryPagingMethodOneOf as bn, type Sorting as bo, type CursorPaging as bp, type QueryPublishedContentResponse as bq, type CursorPagingMetadata as br, type Cursors as bs, type DomainEvent as bt, type DomainEventBodyOneOf as bu, type EntityCreatedEvent as bv, type RestoreInfo as bw, type EntityUpdatedEvent as bx, type EntityDeletedEvent as by, type ActionEvent as bz, type PublishedContentUpdatedEnvelope as c, PluginContainerDataAlignment as d, Target as e, TextAlignment as f, Width as g, LayoutType as h, ThumbnailsAlignment as i, Source as j, Position as k, ViewRole as l, VoteRole as m, PollLayoutType as n, PollLayoutDirection as o, AppType as p, Direction as q, VerticalAlignment as r, NullValue as s, SortOrder as t, WebhookIdentityType as u, type PublishedContent as v, type SchemaKey as w, type PublishedContentField as x, type PublishedContentFieldValueOneOf as y, type Node as z };