@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,6 @@
1
- export interface PublishedContent {
1
+ import { bl as QueryPublishedContentRequest$1, bq as QueryPublishedContentResponse$1 } from './multilingual-localization-public-v3-published-content-translation-published-contents.universal-CZFjMeB8.mjs';
2
+
3
+ interface PublishedContent {
2
4
  /**
3
5
  * Published content ID.
4
6
  * @readonly
@@ -33,7 +35,7 @@ export interface PublishedContent {
33
35
  /** Custom field data for the published content object. */
34
36
  extendedFields?: ExtendedFields;
35
37
  }
36
- export interface SchemaKey {
38
+ interface SchemaKey {
37
39
  /**
38
40
  * ID of the app that created the schema.
39
41
  * @format GUID
@@ -54,16 +56,18 @@ export interface SchemaKey {
54
56
  * + `SITE`: A custom schema for a specific site.
55
57
  * @immutable
56
58
  */
57
- scope?: SchemaScope;
59
+ scope?: SchemaScopeWithLiterals;
58
60
  }
59
- export declare enum SchemaScope {
61
+ declare enum SchemaScope {
60
62
  UNKNOWN_SCOPE = "UNKNOWN_SCOPE",
61
63
  /** Global schema for all sites. */
62
64
  GLOBAL = "GLOBAL",
63
65
  /** Custom schema for a specific site. */
64
66
  SITE = "SITE"
65
67
  }
66
- export interface PublishedContentField extends PublishedContentFieldValueOneOf {
68
+ /** @enumType */
69
+ type SchemaScopeWithLiterals = SchemaScope | 'UNKNOWN_SCOPE' | 'GLOBAL' | 'SITE';
70
+ interface PublishedContentField extends PublishedContentFieldValueOneOf {
67
71
  /**
68
72
  * Plain text.
69
73
  * @maxLength 100000
@@ -91,7 +95,7 @@ export interface PublishedContentField extends PublishedContentFieldValueOneOf {
91
95
  sequenceIds?: string[];
92
96
  }
93
97
  /** @oneof */
94
- export interface PublishedContentFieldValueOneOf {
98
+ interface PublishedContentFieldValueOneOf {
95
99
  /**
96
100
  * Plain text.
97
101
  * @maxLength 100000
@@ -106,7 +110,7 @@ export interface PublishedContentFieldValueOneOf {
106
110
  /** Wix Media Manager document. */
107
111
  document?: Document;
108
112
  }
109
- export interface RichContent {
113
+ interface RichContent {
110
114
  /** Node objects representing a rich content document. */
111
115
  nodes?: Node[];
112
116
  /** Object metadata. */
@@ -114,7 +118,7 @@ export interface RichContent {
114
118
  /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
115
119
  documentStyle?: DocumentStyle;
116
120
  }
117
- export interface Node extends NodeDataOneOf {
121
+ interface Node extends NodeDataOneOf {
118
122
  /** Data for a button node. */
119
123
  buttonData?: ButtonData;
120
124
  /** Data for a code block node. */
@@ -170,7 +174,7 @@ export interface Node extends NodeDataOneOf {
170
174
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
171
175
  layoutCellData?: LayoutCellData;
172
176
  /** 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;
177
+ type?: NodeTypeWithLiterals;
174
178
  /** Node ID. */
175
179
  id?: string;
176
180
  /** A list of child nodes. */
@@ -179,7 +183,7 @@ export interface Node extends NodeDataOneOf {
179
183
  style?: NodeStyle;
180
184
  }
181
185
  /** @oneof */
182
- export interface NodeDataOneOf {
186
+ interface NodeDataOneOf {
183
187
  /** Data for a button node. */
184
188
  buttonData?: ButtonData;
185
189
  /** Data for a code block node. */
@@ -235,7 +239,7 @@ export interface NodeDataOneOf {
235
239
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
236
240
  layoutCellData?: LayoutCellData;
237
241
  }
238
- export declare enum NodeType {
242
+ declare enum NodeType {
239
243
  PARAGRAPH = "PARAGRAPH",
240
244
  TEXT = "TEXT",
241
245
  HEADING = "HEADING",
@@ -271,7 +275,9 @@ export declare enum NodeType {
271
275
  LAYOUT = "LAYOUT",
272
276
  LAYOUT_CELL = "LAYOUT_CELL"
273
277
  }
274
- export interface NodeStyle {
278
+ /** @enumType */
279
+ 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';
280
+ interface NodeStyle {
275
281
  /** The top padding value in pixels. */
276
282
  paddingTop?: string | null;
277
283
  /** The bottom padding value in pixels. */
@@ -279,11 +285,11 @@ export interface NodeStyle {
279
285
  /** The background color as a hexadecimal value. */
280
286
  backgroundColor?: string | null;
281
287
  }
282
- export interface ButtonData {
288
+ interface ButtonData {
283
289
  /** Styling for the button's container. */
284
290
  containerData?: PluginContainerData;
285
291
  /** The button type. */
286
- type?: Type;
292
+ type?: TypeWithLiterals;
287
293
  /** Styling for the button. */
288
294
  styles?: Styles;
289
295
  /** The text to display on the button. */
@@ -291,7 +297,7 @@ export interface ButtonData {
291
297
  /** Button link details. */
292
298
  link?: Link;
293
299
  }
294
- export interface Border {
300
+ interface Border {
295
301
  /**
296
302
  * Deprecated: Use `borderWidth` in `styles` instead.
297
303
  * @deprecated
@@ -303,7 +309,7 @@ export interface Border {
303
309
  */
304
310
  radius?: number | null;
305
311
  }
306
- export interface Colors {
312
+ interface Colors {
307
313
  /**
308
314
  * Deprecated: Use `textColor` in `styles` instead.
309
315
  * @deprecated
@@ -320,11 +326,11 @@ export interface Colors {
320
326
  */
321
327
  background?: string | null;
322
328
  }
323
- export interface PluginContainerData {
329
+ interface PluginContainerData {
324
330
  /** The width of the node when it's displayed. */
325
331
  width?: PluginContainerDataWidth;
326
332
  /** The node's alignment within its container. */
327
- alignment?: PluginContainerDataAlignment;
333
+ alignment?: PluginContainerDataAlignmentWithLiterals;
328
334
  /** Spoiler cover settings for the node. */
329
335
  spoiler?: Spoiler;
330
336
  /** The height of the node when it's displayed. */
@@ -332,7 +338,7 @@ export interface PluginContainerData {
332
338
  /** 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
339
  textWrap?: boolean | null;
334
340
  }
335
- export declare enum WidthType {
341
+ declare enum WidthType {
336
342
  /** Width matches the content width */
337
343
  CONTENT = "CONTENT",
338
344
  /** Small Width */
@@ -342,7 +348,9 @@ export declare enum WidthType {
342
348
  /** coast-to-coast display */
343
349
  FULL_WIDTH = "FULL_WIDTH"
344
350
  }
345
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
351
+ /** @enumType */
352
+ type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
353
+ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
346
354
  /**
347
355
  * One of the following predefined width options:
348
356
  * `CONTENT`: The width of the container matches the content width.
@@ -350,12 +358,12 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
350
358
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
351
359
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
352
360
  */
353
- size?: WidthType;
361
+ size?: WidthTypeWithLiterals;
354
362
  /** A custom width value in pixels. */
355
363
  custom?: string | null;
356
364
  }
357
365
  /** @oneof */
358
- export interface PluginContainerDataWidthDataOneOf {
366
+ interface PluginContainerDataWidthDataOneOf {
359
367
  /**
360
368
  * One of the following predefined width options:
361
369
  * `CONTENT`: The width of the container matches the content width.
@@ -363,11 +371,11 @@ export interface PluginContainerDataWidthDataOneOf {
363
371
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
364
372
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
365
373
  */
366
- size?: WidthType;
374
+ size?: WidthTypeWithLiterals;
367
375
  /** A custom width value in pixels. */
368
376
  custom?: string | null;
369
377
  }
370
- export declare enum PluginContainerDataAlignment {
378
+ declare enum PluginContainerDataAlignment {
371
379
  /** Center Alignment */
372
380
  CENTER = "CENTER",
373
381
  /** Left Alignment */
@@ -375,7 +383,9 @@ export declare enum PluginContainerDataAlignment {
375
383
  /** Right Alignment */
376
384
  RIGHT = "RIGHT"
377
385
  }
378
- export interface Spoiler {
386
+ /** @enumType */
387
+ type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
388
+ interface Spoiler {
379
389
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
380
390
  enabled?: boolean | null;
381
391
  /** The description displayed on top of the spoiler cover. */
@@ -383,17 +393,19 @@ export interface Spoiler {
383
393
  /** The text for the button used to remove the spoiler cover. */
384
394
  buttonText?: string | null;
385
395
  }
386
- export interface Height {
396
+ interface Height {
387
397
  /** A custom height value in pixels. */
388
398
  custom?: string | null;
389
399
  }
390
- export declare enum Type {
400
+ declare enum Type {
391
401
  /** Regular link button */
392
402
  LINK = "LINK",
393
403
  /** Triggers custom action that is defined in plugin configuration by the consumer */
394
404
  ACTION = "ACTION"
395
405
  }
396
- export interface Styles {
406
+ /** @enumType */
407
+ type TypeWithLiterals = Type | 'LINK' | 'ACTION';
408
+ interface Styles {
397
409
  /**
398
410
  * Deprecated: Use `borderWidth` and `borderRadius` instead.
399
411
  * @deprecated
@@ -446,7 +458,7 @@ export interface Styles {
446
458
  /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
447
459
  buttonSize?: string | null;
448
460
  }
449
- export interface Link extends LinkDataOneOf {
461
+ interface Link extends LinkDataOneOf {
450
462
  /** The absolute URL for the linked document. */
451
463
  url?: string;
452
464
  /** The target node's ID. Used for linking to another node in this object. */
@@ -458,20 +470,20 @@ export interface Link extends LinkDataOneOf {
458
470
  * `PARENT` - Opens the linked document in the link's parent frame.
459
471
  * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
460
472
  */
461
- target?: Target;
473
+ target?: TargetWithLiterals;
462
474
  /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
463
475
  rel?: Rel;
464
476
  /** A serialized object used for a custom or external link panel. */
465
477
  customData?: string | null;
466
478
  }
467
479
  /** @oneof */
468
- export interface LinkDataOneOf {
480
+ interface LinkDataOneOf {
469
481
  /** The absolute URL for the linked document. */
470
482
  url?: string;
471
483
  /** The target node's ID. Used for linking to another node in this object. */
472
484
  anchor?: string;
473
485
  }
474
- export declare enum Target {
486
+ declare enum Target {
475
487
  /** Opens the linked document in the same frame as it was clicked (this is default) */
476
488
  SELF = "SELF",
477
489
  /** Opens the linked document in a new window or tab */
@@ -481,7 +493,9 @@ export declare enum Target {
481
493
  /** Opens the linked document in the full body of the window */
482
494
  TOP = "TOP"
483
495
  }
484
- export interface Rel {
496
+ /** @enumType */
497
+ type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
498
+ interface Rel {
485
499
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
486
500
  nofollow?: boolean | null;
487
501
  /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
@@ -491,17 +505,17 @@ export interface Rel {
491
505
  /** Indicates that this link protect referral information from being passed to the target website. */
492
506
  noreferrer?: boolean | null;
493
507
  }
494
- export interface CodeBlockData {
508
+ interface CodeBlockData {
495
509
  /** Styling for the code block's text. */
496
510
  textStyle?: TextStyle;
497
511
  }
498
- export interface TextStyle {
512
+ interface TextStyle {
499
513
  /** Text alignment. Defaults to `AUTO`. */
500
- textAlignment?: TextAlignment;
514
+ textAlignment?: TextAlignmentWithLiterals;
501
515
  /** 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
516
  lineHeight?: string | null;
503
517
  }
504
- export declare enum TextAlignment {
518
+ declare enum TextAlignment {
505
519
  /** browser default, eqivalent to `initial` */
506
520
  AUTO = "AUTO",
507
521
  /** Left align */
@@ -513,17 +527,19 @@ export declare enum TextAlignment {
513
527
  /** 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
528
  JUSTIFY = "JUSTIFY"
515
529
  }
516
- export interface DividerData {
530
+ /** @enumType */
531
+ type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
532
+ interface DividerData {
517
533
  /** Styling for the divider's container. */
518
534
  containerData?: PluginContainerData;
519
535
  /** Divider line style. */
520
- lineStyle?: LineStyle;
536
+ lineStyle?: LineStyleWithLiterals;
521
537
  /** Divider width. */
522
- width?: Width;
538
+ width?: WidthWithLiterals;
523
539
  /** Divider alignment. */
524
- alignment?: Alignment;
540
+ alignment?: AlignmentWithLiterals;
525
541
  }
526
- export declare enum LineStyle {
542
+ declare enum LineStyle {
527
543
  /** Single Line */
528
544
  SINGLE = "SINGLE",
529
545
  /** Double Line */
@@ -533,7 +549,9 @@ export declare enum LineStyle {
533
549
  /** Dotted Line */
534
550
  DOTTED = "DOTTED"
535
551
  }
536
- export declare enum Width {
552
+ /** @enumType */
553
+ type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
554
+ declare enum Width {
537
555
  /** Large line */
538
556
  LARGE = "LARGE",
539
557
  /** Medium line */
@@ -541,7 +559,9 @@ export declare enum Width {
541
559
  /** Small line */
542
560
  SMALL = "SMALL"
543
561
  }
544
- export declare enum Alignment {
562
+ /** @enumType */
563
+ type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
564
+ declare enum Alignment {
545
565
  /** Center alignment */
546
566
  CENTER = "CENTER",
547
567
  /** Left alignment */
@@ -549,7 +569,9 @@ export declare enum Alignment {
549
569
  /** Right alignment */
550
570
  RIGHT = "RIGHT"
551
571
  }
552
- export interface FileData {
572
+ /** @enumType */
573
+ type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
574
+ interface FileData {
553
575
  /** Styling for the file's container. */
554
576
  containerData?: PluginContainerData;
555
577
  /** The source for the file's data. */
@@ -572,7 +594,7 @@ export interface FileData {
572
594
  /** File size in KB. */
573
595
  sizeInKb?: string | null;
574
596
  }
575
- export declare enum ViewMode {
597
+ declare enum ViewMode {
576
598
  /** No PDF view */
577
599
  NONE = "NONE",
578
600
  /** Full PDF view */
@@ -580,7 +602,9 @@ export declare enum ViewMode {
580
602
  /** Mini PDF view */
581
603
  MINI = "MINI"
582
604
  }
583
- export interface FileSource extends FileSourceDataOneOf {
605
+ /** @enumType */
606
+ type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
607
+ interface FileSource extends FileSourceDataOneOf {
584
608
  /** The absolute URL for the file's source. */
585
609
  url?: string | null;
586
610
  /**
@@ -594,7 +618,7 @@ export interface FileSource extends FileSourceDataOneOf {
594
618
  private?: boolean | null;
595
619
  }
596
620
  /** @oneof */
597
- export interface FileSourceDataOneOf {
621
+ interface FileSourceDataOneOf {
598
622
  /** The absolute URL for the file's source. */
599
623
  url?: string | null;
600
624
  /**
@@ -605,20 +629,20 @@ export interface FileSourceDataOneOf {
605
629
  /** An ID that's resolved to a URL by a resolver function. */
606
630
  id?: string | null;
607
631
  }
608
- export interface PDFSettings {
632
+ interface PDFSettings {
609
633
  /**
610
634
  * PDF view mode. One of the following:
611
635
  * `NONE` : The PDF isn't displayed.
612
636
  * `FULL` : A full page view of the PDF is displayed.
613
637
  * `MINI` : A mini view of the PDF is displayed.
614
638
  */
615
- viewMode?: ViewMode;
639
+ viewMode?: ViewModeWithLiterals;
616
640
  /** Sets whether the PDF download button is disabled. Defaults to `false`. */
617
641
  disableDownload?: boolean | null;
618
642
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
619
643
  disablePrint?: boolean | null;
620
644
  }
621
- export interface GalleryData {
645
+ interface GalleryData {
622
646
  /** Styling for the gallery's container. */
623
647
  containerData?: PluginContainerData;
624
648
  /** The items in the gallery. */
@@ -630,7 +654,7 @@ export interface GalleryData {
630
654
  /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
631
655
  disableDownload?: boolean | null;
632
656
  }
633
- export interface Media {
657
+ interface Media {
634
658
  /** The source for the media's data. */
635
659
  src?: FileSource;
636
660
  /** Media width in pixels. */
@@ -640,19 +664,19 @@ export interface Media {
640
664
  /** Media duration in seconds. Only relevant for audio and video files. */
641
665
  duration?: number | null;
642
666
  }
643
- export interface ItemImage {
667
+ interface ItemImage {
644
668
  /** Image file details. */
645
669
  media?: Media;
646
670
  /** Link details for images that are links. */
647
671
  link?: Link;
648
672
  }
649
- export interface Video {
673
+ interface Video {
650
674
  /** Video file details. */
651
675
  media?: Media;
652
676
  /** Video thumbnail file details. */
653
677
  thumbnail?: Media;
654
678
  }
655
- export interface Item extends ItemDataOneOf {
679
+ interface Item extends ItemDataOneOf {
656
680
  /** An image item. */
657
681
  image?: ItemImage;
658
682
  /** A video item. */
@@ -663,13 +687,13 @@ export interface Item extends ItemDataOneOf {
663
687
  altText?: string | null;
664
688
  }
665
689
  /** @oneof */
666
- export interface ItemDataOneOf {
690
+ interface ItemDataOneOf {
667
691
  /** An image item. */
668
692
  image?: ItemImage;
669
693
  /** A video item. */
670
694
  video?: Video;
671
695
  }
672
- export interface GalleryOptions {
696
+ interface GalleryOptions {
673
697
  /** Gallery layout. */
674
698
  layout?: Layout;
675
699
  /** Styling for gallery items. */
@@ -677,7 +701,7 @@ export interface GalleryOptions {
677
701
  /** Styling for gallery thumbnail images. */
678
702
  thumbnails?: Thumbnails;
679
703
  }
680
- export declare enum LayoutType {
704
+ declare enum LayoutType {
681
705
  /** Collage type */
682
706
  COLLAGE = "COLLAGE",
683
707
  /** Masonry type */
@@ -699,19 +723,25 @@ export declare enum LayoutType {
699
723
  /** Fullsize images type */
700
724
  FULLSIZE = "FULLSIZE"
701
725
  }
702
- export declare enum Orientation {
726
+ /** @enumType */
727
+ type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
728
+ declare enum Orientation {
703
729
  /** Rows Orientation */
704
730
  ROWS = "ROWS",
705
731
  /** Columns Orientation */
706
732
  COLUMNS = "COLUMNS"
707
733
  }
708
- export declare enum Crop {
734
+ /** @enumType */
735
+ type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
736
+ declare enum Crop {
709
737
  /** Crop to fill */
710
738
  FILL = "FILL",
711
739
  /** Crop to fit */
712
740
  FIT = "FIT"
713
741
  }
714
- export declare enum ThumbnailsAlignment {
742
+ /** @enumType */
743
+ type CropWithLiterals = Crop | 'FILL' | 'FIT';
744
+ declare enum ThumbnailsAlignment {
715
745
  /** Top alignment */
716
746
  TOP = "TOP",
717
747
  /** Right alignment */
@@ -723,35 +753,37 @@ export declare enum ThumbnailsAlignment {
723
753
  /** No thumbnail */
724
754
  NONE = "NONE"
725
755
  }
726
- export interface Layout {
756
+ /** @enumType */
757
+ type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
758
+ interface Layout {
727
759
  /** Gallery layout type. */
728
- type?: LayoutType;
760
+ type?: LayoutTypeWithLiterals;
729
761
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
730
762
  horizontalScroll?: boolean | null;
731
763
  /** Gallery orientation. */
732
- orientation?: Orientation;
764
+ orientation?: OrientationWithLiterals;
733
765
  /** The number of columns to display on full size screens. */
734
766
  numberOfColumns?: number | null;
735
767
  /** The number of columns to display on mobile screens. */
736
768
  mobileNumberOfColumns?: number | null;
737
769
  }
738
- export interface ItemStyle {
770
+ interface ItemStyle {
739
771
  /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
740
772
  targetSize?: number | null;
741
773
  /** Item ratio */
742
774
  ratio?: number | null;
743
775
  /** Sets how item images are cropped. */
744
- crop?: Crop;
776
+ crop?: CropWithLiterals;
745
777
  /** The spacing between items in pixels. */
746
778
  spacing?: number | null;
747
779
  }
748
- export interface Thumbnails {
780
+ interface Thumbnails {
749
781
  /** Thumbnail alignment. */
750
- placement?: ThumbnailsAlignment;
782
+ placement?: ThumbnailsAlignmentWithLiterals;
751
783
  /** Spacing between thumbnails in pixels. */
752
784
  spacing?: number | null;
753
785
  }
754
- export interface GIFData {
786
+ interface GIFData {
755
787
  /** Styling for the GIF's container. */
756
788
  containerData?: PluginContainerData;
757
789
  /** The source of the full size GIF. */
@@ -763,9 +795,9 @@ export interface GIFData {
763
795
  /** Width in pixels. */
764
796
  width?: number;
765
797
  /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
766
- gifType?: GIFType;
798
+ gifType?: GIFTypeWithLiterals;
767
799
  }
768
- export interface GIF {
800
+ interface GIF {
769
801
  /**
770
802
  * GIF format URL.
771
803
  * @format WEB_URL
@@ -782,11 +814,13 @@ export interface GIF {
782
814
  */
783
815
  still?: string | null;
784
816
  }
785
- export declare enum GIFType {
817
+ declare enum GIFType {
786
818
  NORMAL = "NORMAL",
787
819
  STICKER = "STICKER"
788
820
  }
789
- export interface HeadingData {
821
+ /** @enumType */
822
+ type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
823
+ interface HeadingData {
790
824
  /** Heading level from 1-6. */
791
825
  level?: number;
792
826
  /** Styling for the heading text. */
@@ -794,7 +828,7 @@ export interface HeadingData {
794
828
  /** Indentation level from 1-4. */
795
829
  indentation?: number | null;
796
830
  }
797
- export interface HTMLData extends HTMLDataDataOneOf {
831
+ interface HTMLData extends HTMLDataDataOneOf {
798
832
  /** The URL for the HTML code for the node. */
799
833
  url?: string;
800
834
  /** The HTML code for the node. */
@@ -807,12 +841,12 @@ export interface HTMLData extends HTMLDataDataOneOf {
807
841
  /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
808
842
  containerData?: PluginContainerData;
809
843
  /** The type of HTML code. */
810
- source?: Source;
844
+ source?: SourceWithLiterals;
811
845
  /** If container height is aligned with its content height. Defaults to `true`. */
812
846
  autoHeight?: boolean | null;
813
847
  }
814
848
  /** @oneof */
815
- export interface HTMLDataDataOneOf {
849
+ interface HTMLDataDataOneOf {
816
850
  /** The URL for the HTML code for the node. */
817
851
  url?: string;
818
852
  /** The HTML code for the node. */
@@ -823,11 +857,13 @@ export interface HTMLDataDataOneOf {
823
857
  */
824
858
  isAdsense?: boolean | null;
825
859
  }
826
- export declare enum Source {
860
+ declare enum Source {
827
861
  HTML = "HTML",
828
862
  ADSENSE = "ADSENSE"
829
863
  }
830
- export interface ImageData {
864
+ /** @enumType */
865
+ type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
866
+ interface ImageData {
831
867
  /** Styling for the image's container. */
832
868
  containerData?: PluginContainerData;
833
869
  /** Image file details. */
@@ -850,7 +886,7 @@ export interface ImageData {
850
886
  /** Styling for the image. */
851
887
  styles?: ImageDataStyles;
852
888
  }
853
- export interface StylesBorder {
889
+ interface StylesBorder {
854
890
  /** Border width in pixels. */
855
891
  width?: number | null;
856
892
  /**
@@ -861,11 +897,11 @@ export interface StylesBorder {
861
897
  /** Border radius in pixels. */
862
898
  radius?: number | null;
863
899
  }
864
- export interface ImageDataStyles {
900
+ interface ImageDataStyles {
865
901
  /** Border attributes. */
866
902
  border?: StylesBorder;
867
903
  }
868
- export interface LinkPreviewData {
904
+ interface LinkPreviewData {
869
905
  /** Styling for the link preview's container. */
870
906
  containerData?: PluginContainerData;
871
907
  /** Link details. */
@@ -881,7 +917,7 @@ export interface LinkPreviewData {
881
917
  /** Styling for the link preview. */
882
918
  styles?: LinkPreviewDataStyles;
883
919
  }
884
- export declare enum Position {
920
+ declare enum Position {
885
921
  /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
886
922
  START = "START",
887
923
  /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
@@ -891,7 +927,9 @@ export declare enum Position {
891
927
  /** Thumbnail hidden and not displayed */
892
928
  HIDDEN = "HIDDEN"
893
929
  }
894
- export interface LinkPreviewDataStyles {
930
+ /** @enumType */
931
+ type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
932
+ interface LinkPreviewDataStyles {
895
933
  /**
896
934
  * Background color as a hexadecimal value.
897
935
  * @format COLOR_HEX
@@ -922,15 +960,15 @@ export interface LinkPreviewDataStyles {
922
960
  */
923
961
  borderColor?: string | null;
924
962
  /** Position of thumbnail. Defaults to `START`. */
925
- thumbnailPosition?: Position;
963
+ thumbnailPosition?: PositionWithLiterals;
926
964
  }
927
- export interface MapData {
965
+ interface MapData {
928
966
  /** Styling for the map's container. */
929
967
  containerData?: PluginContainerData;
930
968
  /** Map settings. */
931
969
  mapSettings?: MapSettings;
932
970
  }
933
- export interface MapSettings {
971
+ interface MapSettings {
934
972
  /** The address to display on the map. */
935
973
  address?: string | null;
936
974
  /** Sets whether the map is draggable. */
@@ -952,9 +990,9 @@ export interface MapSettings {
952
990
  /** Initial zoom value. */
953
991
  initialZoom?: number | null;
954
992
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
955
- mapType?: MapType;
993
+ mapType?: MapTypeWithLiterals;
956
994
  }
957
- export declare enum MapType {
995
+ declare enum MapType {
958
996
  /** Roadmap map type */
959
997
  ROADMAP = "ROADMAP",
960
998
  /** Satellite map type */
@@ -964,7 +1002,9 @@ export declare enum MapType {
964
1002
  /** Terrain map type */
965
1003
  TERRAIN = "TERRAIN"
966
1004
  }
967
- export interface ParagraphData {
1005
+ /** @enumType */
1006
+ type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
1007
+ interface ParagraphData {
968
1008
  /** Styling for the paragraph text. */
969
1009
  textStyle?: TextStyle;
970
1010
  /** Indentation level from 1-4. */
@@ -972,7 +1012,7 @@ export interface ParagraphData {
972
1012
  /** Paragraph level */
973
1013
  level?: number | null;
974
1014
  }
975
- export interface PollData {
1015
+ interface PollData {
976
1016
  /** Styling for the poll's container. */
977
1017
  containerData?: PluginContainerData;
978
1018
  /** Poll data. */
@@ -982,7 +1022,7 @@ export interface PollData {
982
1022
  /** Styling for the poll and voting options. */
983
1023
  design?: Design;
984
1024
  }
985
- export declare enum ViewRole {
1025
+ declare enum ViewRole {
986
1026
  /** Only Poll creator can view the results */
987
1027
  CREATOR = "CREATOR",
988
1028
  /** Anyone who voted can see the results */
@@ -990,21 +1030,25 @@ export declare enum ViewRole {
990
1030
  /** Anyone can see the results, even if one didn't vote */
991
1031
  EVERYONE = "EVERYONE"
992
1032
  }
993
- export declare enum VoteRole {
1033
+ /** @enumType */
1034
+ type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
1035
+ declare enum VoteRole {
994
1036
  /** Logged in member */
995
1037
  SITE_MEMBERS = "SITE_MEMBERS",
996
1038
  /** Anyone */
997
1039
  ALL = "ALL"
998
1040
  }
999
- export interface Permissions {
1041
+ /** @enumType */
1042
+ type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
1043
+ interface Permissions {
1000
1044
  /** Sets who can view the poll results. */
1001
- view?: ViewRole;
1045
+ view?: ViewRoleWithLiterals;
1002
1046
  /** Sets who can vote. */
1003
- vote?: VoteRole;
1047
+ vote?: VoteRoleWithLiterals;
1004
1048
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1005
1049
  allowMultipleVotes?: boolean | null;
1006
1050
  }
1007
- export interface Option {
1051
+ interface Option {
1008
1052
  /** Option ID. */
1009
1053
  id?: string | null;
1010
1054
  /** Option title. */
@@ -1012,7 +1056,7 @@ export interface Option {
1012
1056
  /** The image displayed with the option. */
1013
1057
  image?: Media;
1014
1058
  }
1015
- export interface Settings {
1059
+ interface Settings {
1016
1060
  /** Permissions settings for voting. */
1017
1061
  permissions?: Permissions;
1018
1062
  /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
@@ -1020,31 +1064,35 @@ export interface Settings {
1020
1064
  /** Sets whether the vote count is displayed. Defaults to `true`. */
1021
1065
  showVotesCount?: boolean | null;
1022
1066
  }
1023
- export declare enum PollLayoutType {
1067
+ declare enum PollLayoutType {
1024
1068
  /** List */
1025
1069
  LIST = "LIST",
1026
1070
  /** Grid */
1027
1071
  GRID = "GRID"
1028
1072
  }
1029
- export declare enum PollLayoutDirection {
1073
+ /** @enumType */
1074
+ type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
1075
+ declare enum PollLayoutDirection {
1030
1076
  /** Left-to-right */
1031
1077
  LTR = "LTR",
1032
1078
  /** Right-to-left */
1033
1079
  RTL = "RTL"
1034
1080
  }
1035
- export interface PollLayout {
1081
+ /** @enumType */
1082
+ type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
1083
+ interface PollLayout {
1036
1084
  /** The layout for displaying the voting options. */
1037
- type?: PollLayoutType;
1085
+ type?: PollLayoutTypeWithLiterals;
1038
1086
  /** 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;
1087
+ direction?: PollLayoutDirectionWithLiterals;
1040
1088
  /** Sets whether to display the main poll image. Defaults to `false`. */
1041
1089
  enableImage?: boolean | null;
1042
1090
  }
1043
- export interface OptionLayout {
1091
+ interface OptionLayout {
1044
1092
  /** Sets whether to display option images. Defaults to `false`. */
1045
1093
  enableImage?: boolean | null;
1046
1094
  }
1047
- export declare enum BackgroundType {
1095
+ declare enum BackgroundType {
1048
1096
  /** Color background type */
1049
1097
  COLOR = "COLOR",
1050
1098
  /** Image background type */
@@ -1052,7 +1100,9 @@ export declare enum BackgroundType {
1052
1100
  /** Gradiant background type */
1053
1101
  GRADIENT = "GRADIENT"
1054
1102
  }
1055
- export interface Gradient {
1103
+ /** @enumType */
1104
+ type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1105
+ interface Gradient {
1056
1106
  /** The gradient angle in degrees. */
1057
1107
  angle?: number | null;
1058
1108
  /**
@@ -1066,7 +1116,7 @@ export interface Gradient {
1066
1116
  */
1067
1117
  lastColor?: string | null;
1068
1118
  }
1069
- export interface Background extends BackgroundBackgroundOneOf {
1119
+ interface Background extends BackgroundBackgroundOneOf {
1070
1120
  /**
1071
1121
  * The background color as a hexademical value.
1072
1122
  * @format COLOR_HEX
@@ -1077,10 +1127,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1077
1127
  /** Details for a gradient background. */
1078
1128
  gradient?: Gradient;
1079
1129
  /** Background type. For each option, include the relevant details. */
1080
- type?: BackgroundType;
1130
+ type?: BackgroundTypeWithLiterals;
1081
1131
  }
1082
1132
  /** @oneof */
1083
- export interface BackgroundBackgroundOneOf {
1133
+ interface BackgroundBackgroundOneOf {
1084
1134
  /**
1085
1135
  * The background color as a hexademical value.
1086
1136
  * @format COLOR_HEX
@@ -1091,17 +1141,17 @@ export interface BackgroundBackgroundOneOf {
1091
1141
  /** Details for a gradient background. */
1092
1142
  gradient?: Gradient;
1093
1143
  }
1094
- export interface PollDesign {
1144
+ interface PollDesign {
1095
1145
  /** Background styling. */
1096
1146
  background?: Background;
1097
1147
  /** Border radius in pixels. */
1098
1148
  borderRadius?: number | null;
1099
1149
  }
1100
- export interface OptionDesign {
1150
+ interface OptionDesign {
1101
1151
  /** Border radius in pixels. */
1102
1152
  borderRadius?: number | null;
1103
1153
  }
1104
- export interface Poll {
1154
+ interface Poll {
1105
1155
  /** Poll ID. */
1106
1156
  id?: string | null;
1107
1157
  /** Poll title. */
@@ -1115,26 +1165,26 @@ export interface Poll {
1115
1165
  /** The poll's permissions and display settings. */
1116
1166
  settings?: Settings;
1117
1167
  }
1118
- export interface PollDataLayout {
1168
+ interface PollDataLayout {
1119
1169
  /** Poll layout settings. */
1120
1170
  poll?: PollLayout;
1121
1171
  /** Voting otpions layout settings. */
1122
1172
  options?: OptionLayout;
1123
1173
  }
1124
- export interface Design {
1174
+ interface Design {
1125
1175
  /** Styling for the poll. */
1126
1176
  poll?: PollDesign;
1127
1177
  /** Styling for voting options. */
1128
1178
  options?: OptionDesign;
1129
1179
  }
1130
- export interface TextData {
1180
+ interface TextData {
1131
1181
  /** The text to apply decorations to. */
1132
1182
  text?: string;
1133
1183
  /** The decorations to apply. */
1134
1184
  decorations?: Decoration[];
1135
1185
  }
1136
1186
  /** Adds appearence changes to text */
1137
- export interface Decoration extends DecorationDataOneOf {
1187
+ interface Decoration extends DecorationDataOneOf {
1138
1188
  /** Data for an anchor link decoration. */
1139
1189
  anchorData?: AnchorData;
1140
1190
  /** Data for a color decoration. */
@@ -1156,10 +1206,10 @@ export interface Decoration extends DecorationDataOneOf {
1156
1206
  /** Data for a strikethrough decoration. Defaults to `true`. */
1157
1207
  strikethroughData?: boolean | null;
1158
1208
  /** The type of decoration to apply. */
1159
- type?: DecorationType;
1209
+ type?: DecorationTypeWithLiterals;
1160
1210
  }
1161
1211
  /** @oneof */
1162
- export interface DecorationDataOneOf {
1212
+ interface DecorationDataOneOf {
1163
1213
  /** Data for an anchor link decoration. */
1164
1214
  anchorData?: AnchorData;
1165
1215
  /** Data for a color decoration. */
@@ -1181,7 +1231,7 @@ export interface DecorationDataOneOf {
1181
1231
  /** Data for a strikethrough decoration. Defaults to `true`. */
1182
1232
  strikethroughData?: boolean | null;
1183
1233
  }
1184
- export declare enum DecorationType {
1234
+ declare enum DecorationType {
1185
1235
  BOLD = "BOLD",
1186
1236
  ITALIC = "ITALIC",
1187
1237
  UNDERLINE = "UNDERLINE",
@@ -1194,21 +1244,23 @@ export declare enum DecorationType {
1194
1244
  EXTERNAL = "EXTERNAL",
1195
1245
  STRIKETHROUGH = "STRIKETHROUGH"
1196
1246
  }
1197
- export interface AnchorData {
1247
+ /** @enumType */
1248
+ type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
1249
+ interface AnchorData {
1198
1250
  /** The target node's ID. */
1199
1251
  anchor?: string;
1200
1252
  }
1201
- export interface ColorData {
1253
+ interface ColorData {
1202
1254
  /** The text's background color as a hexadecimal value. */
1203
1255
  background?: string | null;
1204
1256
  /** The text's foreground color as a hexadecimal value. */
1205
1257
  foreground?: string | null;
1206
1258
  }
1207
- export interface LinkData {
1259
+ interface LinkData {
1208
1260
  /** Link details. */
1209
1261
  link?: Link;
1210
1262
  }
1211
- export interface MentionData {
1263
+ interface MentionData {
1212
1264
  /** The mentioned user's name. */
1213
1265
  name?: string;
1214
1266
  /** The version of the user's name that appears after the `@` character in the mention. */
@@ -1216,27 +1268,29 @@ export interface MentionData {
1216
1268
  /** Mentioned user's ID. */
1217
1269
  id?: string | null;
1218
1270
  }
1219
- export interface FontSizeData {
1271
+ interface FontSizeData {
1220
1272
  /** The units used for the font size. */
1221
- unit?: FontType;
1273
+ unit?: FontTypeWithLiterals;
1222
1274
  /** Font size value. */
1223
1275
  value?: number | null;
1224
1276
  }
1225
- export declare enum FontType {
1277
+ declare enum FontType {
1226
1278
  PX = "PX",
1227
1279
  EM = "EM"
1228
1280
  }
1229
- export interface SpoilerData {
1281
+ /** @enumType */
1282
+ type FontTypeWithLiterals = FontType | 'PX' | 'EM';
1283
+ interface SpoilerData {
1230
1284
  /** Spoiler ID. */
1231
1285
  id?: string | null;
1232
1286
  }
1233
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1287
+ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1234
1288
  /** Data for embedded Wix Bookings content. */
1235
1289
  bookingData?: BookingData;
1236
1290
  /** Data for embedded Wix Events content. */
1237
1291
  eventData?: EventData;
1238
1292
  /** The type of Wix App content being embedded. */
1239
- type?: AppType;
1293
+ type?: AppTypeWithLiterals;
1240
1294
  /** The ID of the embedded content. */
1241
1295
  itemId?: string | null;
1242
1296
  /** The name of the embedded content. */
@@ -1252,28 +1306,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1252
1306
  image?: Media;
1253
1307
  }
1254
1308
  /** @oneof */
1255
- export interface AppEmbedDataAppDataOneOf {
1309
+ interface AppEmbedDataAppDataOneOf {
1256
1310
  /** Data for embedded Wix Bookings content. */
1257
1311
  bookingData?: BookingData;
1258
1312
  /** Data for embedded Wix Events content. */
1259
1313
  eventData?: EventData;
1260
1314
  }
1261
- export declare enum AppType {
1315
+ declare enum AppType {
1262
1316
  PRODUCT = "PRODUCT",
1263
1317
  EVENT = "EVENT",
1264
1318
  BOOKING = "BOOKING"
1265
1319
  }
1266
- export interface BookingData {
1320
+ /** @enumType */
1321
+ type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
1322
+ interface BookingData {
1267
1323
  /** Booking duration in minutes. */
1268
1324
  durations?: string | null;
1269
1325
  }
1270
- export interface EventData {
1326
+ interface EventData {
1271
1327
  /** Event schedule. */
1272
1328
  scheduling?: string | null;
1273
1329
  /** Event location. */
1274
1330
  location?: string | null;
1275
1331
  }
1276
- export interface VideoData {
1332
+ interface VideoData {
1277
1333
  /** Styling for the video's container. */
1278
1334
  containerData?: PluginContainerData;
1279
1335
  /** Video details. */
@@ -1287,7 +1343,7 @@ export interface VideoData {
1287
1343
  /** Video options. */
1288
1344
  options?: PlaybackOptions;
1289
1345
  }
1290
- export interface PlaybackOptions {
1346
+ interface PlaybackOptions {
1291
1347
  /** Sets whether the media will automatically start playing. */
1292
1348
  autoPlay?: boolean | null;
1293
1349
  /** Sets whether media's will be looped. */
@@ -1295,7 +1351,7 @@ export interface PlaybackOptions {
1295
1351
  /** Sets whether media's controls will be shown. */
1296
1352
  showControls?: boolean | null;
1297
1353
  }
1298
- export interface EmbedData {
1354
+ interface EmbedData {
1299
1355
  /** Styling for the oEmbed node's container. */
1300
1356
  containerData?: PluginContainerData;
1301
1357
  /** An [oEmbed](https://www.oembed.com) object. */
@@ -1303,7 +1359,7 @@ export interface EmbedData {
1303
1359
  /** Origin asset source. */
1304
1360
  src?: string | null;
1305
1361
  }
1306
- export interface Oembed {
1362
+ interface Oembed {
1307
1363
  /** The resource type. */
1308
1364
  type?: string | null;
1309
1365
  /** The width of the resource specified in the `url` property in pixels. */
@@ -1335,19 +1391,19 @@ export interface Oembed {
1335
1391
  /** The oEmbed version number. This value must be `1.0`. */
1336
1392
  version?: string | null;
1337
1393
  }
1338
- export interface CollapsibleListData {
1394
+ interface CollapsibleListData {
1339
1395
  /** Styling for the collapsible list's container. */
1340
1396
  containerData?: PluginContainerData;
1341
1397
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1342
1398
  expandOnlyOne?: boolean | null;
1343
1399
  /** Sets which items are expanded when the page loads. */
1344
- initialExpandedItems?: InitialExpandedItems;
1400
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
1345
1401
  /** The direction of the text in the list. Either left-to-right or right-to-left. */
1346
- direction?: Direction;
1402
+ direction?: DirectionWithLiterals;
1347
1403
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
1348
1404
  isQapageData?: boolean | null;
1349
1405
  }
1350
- export declare enum InitialExpandedItems {
1406
+ declare enum InitialExpandedItems {
1351
1407
  /** First item will be expended initally */
1352
1408
  FIRST = "FIRST",
1353
1409
  /** All items will expended initally */
@@ -1355,13 +1411,17 @@ export declare enum InitialExpandedItems {
1355
1411
  /** All items collapsed initally */
1356
1412
  NONE = "NONE"
1357
1413
  }
1358
- export declare enum Direction {
1414
+ /** @enumType */
1415
+ type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
1416
+ declare enum Direction {
1359
1417
  /** Left-to-right */
1360
1418
  LTR = "LTR",
1361
1419
  /** Right-to-left */
1362
1420
  RTL = "RTL"
1363
1421
  }
1364
- export interface TableData {
1422
+ /** @enumType */
1423
+ type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
1424
+ interface TableData {
1365
1425
  /** Styling for the table's container. */
1366
1426
  containerData?: PluginContainerData;
1367
1427
  /** The table's dimensions. */
@@ -1376,7 +1436,7 @@ export interface TableData {
1376
1436
  /** Sets whether the table's first column is a header. Defaults to `false`. */
1377
1437
  columnHeader?: boolean | null;
1378
1438
  }
1379
- export interface Dimensions {
1439
+ interface Dimensions {
1380
1440
  /** An array representing relative width of each column in relation to the other columns. */
1381
1441
  colsWidthRatio?: number[];
1382
1442
  /** An array representing the height of each row in pixels. */
@@ -1384,13 +1444,13 @@ export interface Dimensions {
1384
1444
  /** An array representing the minimum width of each column in pixels. */
1385
1445
  colsMinWidth?: number[];
1386
1446
  }
1387
- export interface TableCellData {
1447
+ interface TableCellData {
1388
1448
  /** Styling for the cell's background color and text alignment. */
1389
1449
  cellStyle?: CellStyle;
1390
1450
  /** The cell's border colors. */
1391
1451
  borderColors?: BorderColors;
1392
1452
  }
1393
- export declare enum VerticalAlignment {
1453
+ declare enum VerticalAlignment {
1394
1454
  /** Top alignment */
1395
1455
  TOP = "TOP",
1396
1456
  /** Middle alignment */
@@ -1398,16 +1458,18 @@ export declare enum VerticalAlignment {
1398
1458
  /** Bottom alignment */
1399
1459
  BOTTOM = "BOTTOM"
1400
1460
  }
1401
- export interface CellStyle {
1461
+ /** @enumType */
1462
+ type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
1463
+ interface CellStyle {
1402
1464
  /** Vertical alignment for the cell's text. */
1403
- verticalAlignment?: VerticalAlignment;
1465
+ verticalAlignment?: VerticalAlignmentWithLiterals;
1404
1466
  /**
1405
1467
  * Cell background color as a hexadecimal value.
1406
1468
  * @format COLOR_HEX
1407
1469
  */
1408
1470
  backgroundColor?: string | null;
1409
1471
  }
1410
- export interface BorderColors {
1472
+ interface BorderColors {
1411
1473
  /**
1412
1474
  * Left border color as a hexadecimal value.
1413
1475
  * @format COLOR_HEX
@@ -1429,26 +1491,7 @@ export interface BorderColors {
1429
1491
  */
1430
1492
  bottom?: string | null;
1431
1493
  }
1432
- /**
1433
- * `NullValue` is a singleton enumeration to represent the null value for the
1434
- * `Value` type union.
1435
- *
1436
- * The JSON representation for `NullValue` is JSON `null`.
1437
- */
1438
- export declare enum NullValue {
1439
- /** Null value. */
1440
- NULL_VALUE = "NULL_VALUE"
1441
- }
1442
- /**
1443
- * `ListValue` is a wrapper around a repeated field of values.
1444
- *
1445
- * The JSON representation for `ListValue` is JSON array.
1446
- */
1447
- export interface ListValue {
1448
- /** Repeated field of dynamically typed values. */
1449
- values?: any[];
1450
- }
1451
- export interface AudioData {
1494
+ interface AudioData {
1452
1495
  /** Styling for the audio node's container. */
1453
1496
  containerData?: PluginContainerData;
1454
1497
  /** Audio file details. */
@@ -1464,7 +1507,7 @@ export interface AudioData {
1464
1507
  /** An HTML version of the audio node. */
1465
1508
  html?: string | null;
1466
1509
  }
1467
- export interface OrderedListData {
1510
+ interface OrderedListData {
1468
1511
  /** Indentation level from 0-4. */
1469
1512
  indentation?: number;
1470
1513
  /** Offset level from 0-4. */
@@ -1472,24 +1515,24 @@ export interface OrderedListData {
1472
1515
  /** List start number. */
1473
1516
  start?: number | null;
1474
1517
  }
1475
- export interface BulletedListData {
1518
+ interface BulletedListData {
1476
1519
  /** Indentation level from 0-4. */
1477
1520
  indentation?: number;
1478
1521
  /** Offset level from 0-4. */
1479
1522
  offset?: number | null;
1480
1523
  }
1481
- export interface BlockquoteData {
1524
+ interface BlockquoteData {
1482
1525
  /** Indentation level from 1-4. */
1483
1526
  indentation?: number;
1484
1527
  }
1485
- export interface CaptionData {
1528
+ interface CaptionData {
1486
1529
  textStyle?: TextStyle;
1487
1530
  }
1488
- export interface LayoutCellData {
1531
+ interface LayoutCellData {
1489
1532
  /** Size of the cell in 12 columns grid. */
1490
1533
  colSpan?: number | null;
1491
1534
  }
1492
- export interface Metadata {
1535
+ interface Metadata {
1493
1536
  /** Schema version. */
1494
1537
  version?: number;
1495
1538
  /**
@@ -1506,7 +1549,7 @@ export interface Metadata {
1506
1549
  /** Object ID. */
1507
1550
  id?: string | null;
1508
1551
  }
1509
- export interface DocumentStyle {
1552
+ interface DocumentStyle {
1510
1553
  /** Styling for H1 nodes. */
1511
1554
  headerOne?: TextNodeStyle;
1512
1555
  /** Styling for H2 nodes. */
@@ -1526,7 +1569,7 @@ export interface DocumentStyle {
1526
1569
  /** Styling for code block nodes. */
1527
1570
  codeBlock?: TextNodeStyle;
1528
1571
  }
1529
- export interface TextNodeStyle {
1572
+ interface TextNodeStyle {
1530
1573
  /** The decorations to apply to the node. */
1531
1574
  decorations?: Decoration[];
1532
1575
  /** Padding and background color for the node. */
@@ -1534,7 +1577,7 @@ export interface TextNodeStyle {
1534
1577
  /** Line height for text in the node. */
1535
1578
  lineHeight?: string | null;
1536
1579
  }
1537
- export interface Image {
1580
+ interface Image {
1538
1581
  /** WixMedia image ID. */
1539
1582
  id?: string;
1540
1583
  /** Image URL. */
@@ -1557,17 +1600,7 @@ export interface Image {
1557
1600
  */
1558
1601
  filename?: string | null;
1559
1602
  }
1560
- export interface FocalPoint {
1561
- /** X-coordinate of the focal point. */
1562
- x?: number;
1563
- /** Y-coordinate of the focal point. */
1564
- y?: number;
1565
- /** crop by height */
1566
- height?: number | null;
1567
- /** crop by width */
1568
- width?: number | null;
1569
- }
1570
- export interface VideoV2 {
1603
+ interface VideoV2 {
1571
1604
  /** WixMedia ID. */
1572
1605
  id?: string;
1573
1606
  /**
@@ -1582,7 +1615,7 @@ export interface VideoV2 {
1582
1615
  */
1583
1616
  filename?: string | null;
1584
1617
  }
1585
- export interface VideoResolution {
1618
+ interface VideoResolution {
1586
1619
  /** Video URL. */
1587
1620
  url?: string;
1588
1621
  /** Video height. */
@@ -1592,7 +1625,7 @@ export interface VideoResolution {
1592
1625
  /** Video format for example, mp4, hls. */
1593
1626
  format?: string;
1594
1627
  }
1595
- export interface Document {
1628
+ interface Document {
1596
1629
  /** WixMedia ID. */
1597
1630
  id?: string;
1598
1631
  /** Document URL. */
@@ -1600,7 +1633,7 @@ export interface Document {
1600
1633
  /** Document filename. */
1601
1634
  filename?: string | null;
1602
1635
  }
1603
- export interface ExtendedFields {
1636
+ interface ExtendedFields {
1604
1637
  /**
1605
1638
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1606
1639
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -1611,22 +1644,11 @@ export interface ExtendedFields {
1611
1644
  */
1612
1645
  namespaces?: Record<string, Record<string, any>>;
1613
1646
  }
1614
- export interface GetPublishedContentRequest {
1615
- /**
1616
- * The ID of the published content
1617
- * @format GUID
1618
- */
1619
- contentId?: string;
1620
- }
1621
- export interface GetPublishedContentResponse {
1622
- /** The published content */
1623
- publishedContent?: PublishedContent;
1624
- }
1625
- export interface QueryPublishedContentRequest {
1647
+ interface QueryPublishedContentRequest {
1626
1648
  /** Query options. Note that some query filters are required. See the API description for a list of required filters. */
1627
1649
  query: CursorQuery;
1628
1650
  }
1629
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1651
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
1630
1652
  /**
1631
1653
  * Cursor paging options.
1632
1654
  *
@@ -1648,7 +1670,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1648
1670
  sort?: Sorting[];
1649
1671
  }
1650
1672
  /** @oneof */
1651
- export interface CursorQueryPagingMethodOneOf {
1673
+ interface CursorQueryPagingMethodOneOf {
1652
1674
  /**
1653
1675
  * Cursor paging options.
1654
1676
  *
@@ -1656,20 +1678,22 @@ export interface CursorQueryPagingMethodOneOf {
1656
1678
  */
1657
1679
  cursorPaging?: CursorPaging;
1658
1680
  }
1659
- export interface Sorting {
1681
+ interface Sorting {
1660
1682
  /**
1661
1683
  * Name of the field to sort by.
1662
1684
  * @maxLength 512
1663
1685
  */
1664
1686
  fieldName?: string;
1665
1687
  /** Sort order. */
1666
- order?: SortOrder;
1688
+ order?: SortOrderWithLiterals;
1667
1689
  }
1668
- export declare enum SortOrder {
1690
+ declare enum SortOrder {
1669
1691
  ASC = "ASC",
1670
1692
  DESC = "DESC"
1671
1693
  }
1672
- export interface CursorPaging {
1694
+ /** @enumType */
1695
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1696
+ interface CursorPaging {
1673
1697
  /**
1674
1698
  * Maximum number of items to return in the results.
1675
1699
  * @max 100
@@ -1684,13 +1708,13 @@ export interface CursorPaging {
1684
1708
  */
1685
1709
  cursor?: string | null;
1686
1710
  }
1687
- export interface QueryPublishedContentResponse {
1711
+ interface QueryPublishedContentResponse {
1688
1712
  /** The published translation content. */
1689
1713
  publishedContent?: PublishedContent[];
1690
1714
  /** Details on the paged set of results returned. */
1691
1715
  pagingMetadata?: CursorPagingMetadata;
1692
1716
  }
1693
- export interface CursorPagingMetadata {
1717
+ interface CursorPagingMetadata {
1694
1718
  /** Number of items returned in current page. */
1695
1719
  count?: number | null;
1696
1720
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -1703,7 +1727,7 @@ export interface CursorPagingMetadata {
1703
1727
  */
1704
1728
  hasNext?: boolean | null;
1705
1729
  }
1706
- export interface Cursors {
1730
+ interface Cursors {
1707
1731
  /**
1708
1732
  * Cursor string pointing to the next page in the list of results.
1709
1733
  * @maxLength 16000
@@ -1715,148 +1739,17 @@ export interface Cursors {
1715
1739
  */
1716
1740
  prev?: string | null;
1717
1741
  }
1718
- export interface DomainEvent extends DomainEventBodyOneOf {
1719
- createdEvent?: EntityCreatedEvent;
1720
- updatedEvent?: EntityUpdatedEvent;
1721
- deletedEvent?: EntityDeletedEvent;
1722
- actionEvent?: ActionEvent;
1723
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1724
- id?: string;
1725
- /**
1726
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1727
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1728
- */
1729
- entityFqdn?: string;
1730
- /**
1731
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
1732
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1733
- */
1734
- slug?: string;
1735
- /** ID of the entity associated with the event. */
1736
- entityId?: string;
1737
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1738
- eventTime?: Date | null;
1739
- /**
1740
- * Whether the event was triggered as a result of a privacy regulation application
1741
- * (for example, GDPR).
1742
- */
1743
- triggeredByAnonymizeRequest?: boolean | null;
1744
- /** If present, indicates the action that triggered the event. */
1745
- originatedFrom?: string | null;
1746
- /**
1747
- * 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.
1748
- * 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.
1749
- */
1750
- entityEventSequence?: string | null;
1751
- }
1752
- /** @oneof */
1753
- export interface DomainEventBodyOneOf {
1754
- createdEvent?: EntityCreatedEvent;
1755
- updatedEvent?: EntityUpdatedEvent;
1756
- deletedEvent?: EntityDeletedEvent;
1757
- actionEvent?: ActionEvent;
1758
- }
1759
- export interface EntityCreatedEvent {
1760
- entityAsJson?: string;
1761
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1762
- restoreInfo?: RestoreInfo;
1763
- }
1764
- export interface RestoreInfo {
1765
- deletedDate?: Date | null;
1766
- }
1767
- export interface EntityUpdatedEvent {
1768
- /**
1769
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1770
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1771
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1772
- */
1773
- currentEntityAsJson?: string;
1774
- }
1775
- export interface EntityDeletedEvent {
1776
- /** Entity that was deleted. */
1777
- deletedEntityAsJson?: string | null;
1778
- }
1779
- export interface ActionEvent {
1780
- bodyAsJson?: string;
1781
- }
1782
- export interface Empty {
1783
- }
1784
- export interface DeletePublishedContentRequest {
1785
- /**
1786
- * The ID of the published content to delete
1787
- * @format GUID
1788
- */
1789
- contentId?: string;
1790
- }
1791
- export interface DeletePublishedContentResponse {
1792
- }
1793
- export interface MessageEnvelope {
1794
- /**
1795
- * App instance ID.
1796
- * @format GUID
1797
- */
1798
- instanceId?: string | null;
1799
- /**
1800
- * Event type.
1801
- * @maxLength 150
1802
- */
1803
- eventType?: string;
1804
- /** The identification type and identity data. */
1805
- identity?: IdentificationData;
1806
- /** Stringify payload. */
1807
- data?: string;
1808
- }
1809
- export interface IdentificationData extends IdentificationDataIdOneOf {
1810
- /**
1811
- * ID of a site visitor that has not logged in to the site.
1812
- * @format GUID
1813
- */
1814
- anonymousVisitorId?: string;
1815
- /**
1816
- * ID of a site visitor that has logged in to the site.
1817
- * @format GUID
1818
- */
1819
- memberId?: string;
1820
- /**
1821
- * ID of a Wix user (site owner, contributor, etc.).
1822
- * @format GUID
1823
- */
1824
- wixUserId?: string;
1825
- /**
1826
- * ID of an app.
1827
- * @format GUID
1828
- */
1829
- appId?: string;
1830
- /** @readonly */
1831
- identityType?: WebhookIdentityType;
1832
- }
1833
- /** @oneof */
1834
- export interface IdentificationDataIdOneOf {
1835
- /**
1836
- * ID of a site visitor that has not logged in to the site.
1837
- * @format GUID
1838
- */
1839
- anonymousVisitorId?: string;
1840
- /**
1841
- * ID of a site visitor that has logged in to the site.
1842
- * @format GUID
1843
- */
1844
- memberId?: string;
1845
- /**
1846
- * ID of a Wix user (site owner, contributor, etc.).
1847
- * @format GUID
1848
- */
1849
- wixUserId?: string;
1850
- /**
1851
- * ID of an app.
1852
- * @format GUID
1853
- */
1854
- appId?: string;
1855
- }
1856
- export declare enum WebhookIdentityType {
1857
- UNKNOWN = "UNKNOWN",
1858
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1859
- MEMBER = "MEMBER",
1860
- WIX_USER = "WIX_USER",
1861
- APP = "APP"
1862
- }
1742
+
1743
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1744
+ getUrl: (context: any) => string;
1745
+ httpMethod: K;
1746
+ path: string;
1747
+ pathParams: M;
1748
+ __requestType: T;
1749
+ __originalRequestType: S;
1750
+ __responseType: Q;
1751
+ __originalResponseType: R;
1752
+ };
1753
+ declare function queryPublishedContent(): __PublicMethodMetaInfo<'GET', {}, QueryPublishedContentRequest$1, QueryPublishedContentRequest, QueryPublishedContentResponse$1, QueryPublishedContentResponse>;
1754
+
1755
+ export { type __PublicMethodMetaInfo, queryPublishedContent };