@wix/auto_sdk_members_members-about 1.0.11 → 1.0.13

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 (134) hide show
  1. package/build/index.d.mts +90 -0
  2. package/build/index.d.ts +90 -0
  3. package/build/index.js +1187 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +1123 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/index.d.mts +90 -0
  8. package/build/internal/index.d.ts +90 -0
  9. package/build/internal/index.js +1187 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +1123 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/{cjs/src/members-about-v2-member-about-members-about.types.d.ts → internal/members-about-v2-member-about-members-about.universal-DfzmZFBy.d.mts} +295 -437
  14. package/build/internal/{cjs/src/members-about-v2-member-about-members-about.types.d.ts → members-about-v2-member-about-members-about.universal-DfzmZFBy.d.ts} +295 -437
  15. package/build/internal/meta.d.mts +1575 -0
  16. package/build/internal/meta.d.ts +1575 -0
  17. package/build/internal/meta.js +624 -0
  18. package/build/internal/meta.js.map +1 -0
  19. package/build/internal/meta.mjs +592 -0
  20. package/build/internal/meta.mjs.map +1 -0
  21. package/build/{es/src/members-about-v2-member-about-members-about.types.d.ts → members-about-v2-member-about-members-about.universal-DfzmZFBy.d.mts} +295 -437
  22. package/build/{internal/es/src/members-about-v2-member-about-members-about.types.d.ts → members-about-v2-member-about-members-about.universal-DfzmZFBy.d.ts} +295 -437
  23. package/build/meta.d.mts +1575 -0
  24. package/build/meta.d.ts +1575 -0
  25. package/build/meta.js +624 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +592 -0
  28. package/build/meta.mjs.map +1 -0
  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/members-about-v2-member-about-members-about.context.d.ts +0 -26
  40. package/build/cjs/src/members-about-v2-member-about-members-about.context.js +0 -61
  41. package/build/cjs/src/members-about-v2-member-about-members-about.context.js.map +0 -1
  42. package/build/cjs/src/members-about-v2-member-about-members-about.http.d.ts +0 -34
  43. package/build/cjs/src/members-about-v2-member-about-members-about.http.js +0 -509
  44. package/build/cjs/src/members-about-v2-member-about-members-about.http.js.map +0 -1
  45. package/build/cjs/src/members-about-v2-member-about-members-about.meta.d.ts +0 -24
  46. package/build/cjs/src/members-about-v2-member-about-members-about.meta.js +0 -142
  47. package/build/cjs/src/members-about-v2-member-about-members-about.meta.js.map +0 -1
  48. package/build/cjs/src/members-about-v2-member-about-members-about.public.d.ts +0 -73
  49. package/build/cjs/src/members-about-v2-member-about-members-about.public.js +0 -200
  50. package/build/cjs/src/members-about-v2-member-about-members-about.public.js.map +0 -1
  51. package/build/cjs/src/members-about-v2-member-about-members-about.types.js +0 -326
  52. package/build/cjs/src/members-about-v2-member-about-members-about.types.js.map +0 -1
  53. package/build/cjs/src/members-about-v2-member-about-members-about.universal.d.ts +0 -2293
  54. package/build/cjs/src/members-about-v2-member-about-members-about.universal.js +0 -630
  55. package/build/cjs/src/members-about-v2-member-about-members-about.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/members-about-v2-member-about-members-about.context.d.ts +0 -26
  67. package/build/es/src/members-about-v2-member-about-members-about.context.js +0 -26
  68. package/build/es/src/members-about-v2-member-about-members-about.context.js.map +0 -1
  69. package/build/es/src/members-about-v2-member-about-members-about.http.d.ts +0 -34
  70. package/build/es/src/members-about-v2-member-about-members-about.http.js +0 -500
  71. package/build/es/src/members-about-v2-member-about-members-about.http.js.map +0 -1
  72. package/build/es/src/members-about-v2-member-about-members-about.meta.d.ts +0 -24
  73. package/build/es/src/members-about-v2-member-about-members-about.meta.js +0 -110
  74. package/build/es/src/members-about-v2-member-about-members-about.meta.js.map +0 -1
  75. package/build/es/src/members-about-v2-member-about-members-about.public.d.ts +0 -73
  76. package/build/es/src/members-about-v2-member-about-members-about.public.js +0 -159
  77. package/build/es/src/members-about-v2-member-about-members-about.public.js.map +0 -1
  78. package/build/es/src/members-about-v2-member-about-members-about.types.js +0 -323
  79. package/build/es/src/members-about-v2-member-about-members-about.types.js.map +0 -1
  80. package/build/es/src/members-about-v2-member-about-members-about.universal.d.ts +0 -2293
  81. package/build/es/src/members-about-v2-member-about-members-about.universal.js +0 -598
  82. package/build/es/src/members-about-v2-member-about-members-about.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/members-about-v2-member-about-members-about.context.d.ts +0 -26
  93. package/build/internal/cjs/src/members-about-v2-member-about-members-about.context.js +0 -61
  94. package/build/internal/cjs/src/members-about-v2-member-about-members-about.context.js.map +0 -1
  95. package/build/internal/cjs/src/members-about-v2-member-about-members-about.http.d.ts +0 -34
  96. package/build/internal/cjs/src/members-about-v2-member-about-members-about.http.js +0 -509
  97. package/build/internal/cjs/src/members-about-v2-member-about-members-about.http.js.map +0 -1
  98. package/build/internal/cjs/src/members-about-v2-member-about-members-about.meta.d.ts +0 -24
  99. package/build/internal/cjs/src/members-about-v2-member-about-members-about.meta.js +0 -142
  100. package/build/internal/cjs/src/members-about-v2-member-about-members-about.meta.js.map +0 -1
  101. package/build/internal/cjs/src/members-about-v2-member-about-members-about.public.d.ts +0 -73
  102. package/build/internal/cjs/src/members-about-v2-member-about-members-about.public.js +0 -200
  103. package/build/internal/cjs/src/members-about-v2-member-about-members-about.public.js.map +0 -1
  104. package/build/internal/cjs/src/members-about-v2-member-about-members-about.types.js +0 -326
  105. package/build/internal/cjs/src/members-about-v2-member-about-members-about.types.js.map +0 -1
  106. package/build/internal/cjs/src/members-about-v2-member-about-members-about.universal.d.ts +0 -2293
  107. package/build/internal/cjs/src/members-about-v2-member-about-members-about.universal.js +0 -630
  108. package/build/internal/cjs/src/members-about-v2-member-about-members-about.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/members-about-v2-member-about-members-about.context.d.ts +0 -26
  119. package/build/internal/es/src/members-about-v2-member-about-members-about.context.js +0 -26
  120. package/build/internal/es/src/members-about-v2-member-about-members-about.context.js.map +0 -1
  121. package/build/internal/es/src/members-about-v2-member-about-members-about.http.d.ts +0 -34
  122. package/build/internal/es/src/members-about-v2-member-about-members-about.http.js +0 -500
  123. package/build/internal/es/src/members-about-v2-member-about-members-about.http.js.map +0 -1
  124. package/build/internal/es/src/members-about-v2-member-about-members-about.meta.d.ts +0 -24
  125. package/build/internal/es/src/members-about-v2-member-about-members-about.meta.js +0 -110
  126. package/build/internal/es/src/members-about-v2-member-about-members-about.meta.js.map +0 -1
  127. package/build/internal/es/src/members-about-v2-member-about-members-about.public.d.ts +0 -73
  128. package/build/internal/es/src/members-about-v2-member-about-members-about.public.js +0 -159
  129. package/build/internal/es/src/members-about-v2-member-about-members-about.public.js.map +0 -1
  130. package/build/internal/es/src/members-about-v2-member-about-members-about.types.js +0 -323
  131. package/build/internal/es/src/members-about-v2-member-about-members-about.types.js.map +0 -1
  132. package/build/internal/es/src/members-about-v2-member-about-members-about.universal.d.ts +0 -2293
  133. package/build/internal/es/src/members-about-v2-member-about-members-about.universal.js +0 -598
  134. package/build/internal/es/src/members-about-v2-member-about-members-about.universal.js.map +0 -1
@@ -1,2293 +0,0 @@
1
- export interface MemberAbout {
2
- /**
3
- * ID of the "About" section content.
4
- * @format GUID
5
- * @readonly
6
- */
7
- _id?: string | null;
8
- /** Revision number, which increments by 1 each time the "About" section content is updated. To prevent conflicting changes, the existing revision must be used when updating an "About" section content. */
9
- revision?: string | null;
10
- /**
11
- * Member ID.
12
- * @format GUID
13
- */
14
- memberId?: string | null;
15
- /** <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.video.divider.giphy.emoji.link" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
16
- content?: RichContent;
17
- }
18
- export interface RichContent {
19
- /** Node objects representing a rich content document. */
20
- nodes?: Node[];
21
- /** Object metadata. */
22
- metadata?: Metadata;
23
- /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
24
- documentStyle?: DocumentStyle;
25
- }
26
- export interface Node extends NodeDataOneOf {
27
- /** Data for a button node. */
28
- buttonData?: ButtonData;
29
- /** Data for a code block node. */
30
- codeBlockData?: CodeBlockData;
31
- /** Data for a divider node. */
32
- dividerData?: DividerData;
33
- /** Data for a file node. */
34
- fileData?: FileData;
35
- /** Data for a gallery node. */
36
- galleryData?: GalleryData;
37
- /** Data for a GIF node. */
38
- gifData?: GIFData;
39
- /** Data for a heading node. */
40
- headingData?: HeadingData;
41
- /** Data for an embedded HTML node. */
42
- htmlData?: HTMLData;
43
- /** Data for an image node. */
44
- imageData?: ImageData;
45
- /** Data for a link preview node. */
46
- linkPreviewData?: LinkPreviewData;
47
- /** @deprecated */
48
- mapData?: MapData;
49
- /** Data for a paragraph node. */
50
- paragraphData?: ParagraphData;
51
- /** Data for a poll node. */
52
- pollData?: PollData;
53
- /** Data for a text node. Used to apply decorations to text. */
54
- textData?: TextData;
55
- /** Data for an app embed node. */
56
- appEmbedData?: AppEmbedData;
57
- /** Data for a video node. */
58
- videoData?: VideoData;
59
- /** Data for an oEmbed node. */
60
- embedData?: EmbedData;
61
- /** Data for a collapsible list node. */
62
- collapsibleListData?: CollapsibleListData;
63
- /** Data for a table node. */
64
- tableData?: TableData;
65
- /** Data for a table cell node. */
66
- tableCellData?: TableCellData;
67
- /** Data for a custom external node. */
68
- externalData?: Record<string, any> | null;
69
- /** Data for an audio node. */
70
- audioData?: AudioData;
71
- /** Data for an ordered list node. */
72
- orderedListData?: OrderedListData;
73
- /** Data for a bulleted list node. */
74
- bulletedListData?: BulletedListData;
75
- /** Data for a block quote node. */
76
- blockquoteData?: BlockquoteData;
77
- /** Data for a caption node. */
78
- captionData?: CaptionData;
79
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
80
- layoutCellData?: LayoutCellData;
81
- /** 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. */
82
- type?: NodeType;
83
- /** Node ID. */
84
- _id?: string;
85
- /** A list of child nodes. */
86
- nodes?: Node[];
87
- /** Padding and background color styling for the node. */
88
- style?: NodeStyle;
89
- }
90
- /** @oneof */
91
- export interface NodeDataOneOf {
92
- /** Data for a button node. */
93
- buttonData?: ButtonData;
94
- /** Data for a code block node. */
95
- codeBlockData?: CodeBlockData;
96
- /** Data for a divider node. */
97
- dividerData?: DividerData;
98
- /** Data for a file node. */
99
- fileData?: FileData;
100
- /** Data for a gallery node. */
101
- galleryData?: GalleryData;
102
- /** Data for a GIF node. */
103
- gifData?: GIFData;
104
- /** Data for a heading node. */
105
- headingData?: HeadingData;
106
- /** Data for an embedded HTML node. */
107
- htmlData?: HTMLData;
108
- /** Data for an image node. */
109
- imageData?: ImageData;
110
- /** Data for a link preview node. */
111
- linkPreviewData?: LinkPreviewData;
112
- /** @deprecated */
113
- mapData?: MapData;
114
- /** Data for a paragraph node. */
115
- paragraphData?: ParagraphData;
116
- /** Data for a poll node. */
117
- pollData?: PollData;
118
- /** Data for a text node. Used to apply decorations to text. */
119
- textData?: TextData;
120
- /** Data for an app embed node. */
121
- appEmbedData?: AppEmbedData;
122
- /** Data for a video node. */
123
- videoData?: VideoData;
124
- /** Data for an oEmbed node. */
125
- embedData?: EmbedData;
126
- /** Data for a collapsible list node. */
127
- collapsibleListData?: CollapsibleListData;
128
- /** Data for a table node. */
129
- tableData?: TableData;
130
- /** Data for a table cell node. */
131
- tableCellData?: TableCellData;
132
- /** Data for a custom external node. */
133
- externalData?: Record<string, any> | null;
134
- /** Data for an audio node. */
135
- audioData?: AudioData;
136
- /** Data for an ordered list node. */
137
- orderedListData?: OrderedListData;
138
- /** Data for a bulleted list node. */
139
- bulletedListData?: BulletedListData;
140
- /** Data for a block quote node. */
141
- blockquoteData?: BlockquoteData;
142
- /** Data for a caption node. */
143
- captionData?: CaptionData;
144
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
145
- layoutCellData?: LayoutCellData;
146
- }
147
- export declare enum NodeType {
148
- PARAGRAPH = "PARAGRAPH",
149
- TEXT = "TEXT",
150
- HEADING = "HEADING",
151
- BULLETED_LIST = "BULLETED_LIST",
152
- ORDERED_LIST = "ORDERED_LIST",
153
- LIST_ITEM = "LIST_ITEM",
154
- BLOCKQUOTE = "BLOCKQUOTE",
155
- CODE_BLOCK = "CODE_BLOCK",
156
- VIDEO = "VIDEO",
157
- DIVIDER = "DIVIDER",
158
- FILE = "FILE",
159
- GALLERY = "GALLERY",
160
- GIF = "GIF",
161
- HTML = "HTML",
162
- IMAGE = "IMAGE",
163
- LINK_PREVIEW = "LINK_PREVIEW",
164
- /** @deprecated */
165
- MAP = "MAP",
166
- POLL = "POLL",
167
- APP_EMBED = "APP_EMBED",
168
- BUTTON = "BUTTON",
169
- COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
170
- TABLE = "TABLE",
171
- EMBED = "EMBED",
172
- COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
173
- COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
174
- COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
175
- TABLE_CELL = "TABLE_CELL",
176
- TABLE_ROW = "TABLE_ROW",
177
- EXTERNAL = "EXTERNAL",
178
- AUDIO = "AUDIO",
179
- CAPTION = "CAPTION",
180
- LAYOUT = "LAYOUT",
181
- LAYOUT_CELL = "LAYOUT_CELL"
182
- }
183
- export interface NodeStyle {
184
- /** The top padding value in pixels. */
185
- paddingTop?: string | null;
186
- /** The bottom padding value in pixels. */
187
- paddingBottom?: string | null;
188
- /** The background color as a hexadecimal value. */
189
- backgroundColor?: string | null;
190
- }
191
- export interface ButtonData {
192
- /** Styling for the button's container. */
193
- containerData?: PluginContainerData;
194
- /** The button type. */
195
- type?: Type;
196
- /** Styling for the button. */
197
- styles?: Styles;
198
- /** The text to display on the button. */
199
- text?: string | null;
200
- /** Button link details. */
201
- link?: Link;
202
- }
203
- export interface Border {
204
- /**
205
- * Deprecated: Use `borderWidth` in `styles` instead.
206
- * @deprecated
207
- */
208
- width?: number | null;
209
- /**
210
- * Deprecated: Use `borderRadius` in `styles` instead.
211
- * @deprecated
212
- */
213
- radius?: number | null;
214
- }
215
- export interface Colors {
216
- /**
217
- * Deprecated: Use `textColor` in `styles` instead.
218
- * @deprecated
219
- */
220
- text?: string | null;
221
- /**
222
- * Deprecated: Use `borderColor` in `styles` instead.
223
- * @deprecated
224
- */
225
- border?: string | null;
226
- /**
227
- * Deprecated: Use `backgroundColor` in `styles` instead.
228
- * @deprecated
229
- */
230
- background?: string | null;
231
- }
232
- export interface PluginContainerData {
233
- /** The width of the node when it's displayed. */
234
- width?: PluginContainerDataWidth;
235
- /** The node's alignment within its container. */
236
- alignment?: PluginContainerDataAlignment;
237
- /** Spoiler cover settings for the node. */
238
- spoiler?: Spoiler;
239
- /** The height of the node when it's displayed. */
240
- height?: Height;
241
- /** 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`. */
242
- textWrap?: boolean | null;
243
- }
244
- export declare enum WidthType {
245
- /** Width matches the content width */
246
- CONTENT = "CONTENT",
247
- /** Small Width */
248
- SMALL = "SMALL",
249
- /** Width will match the original asset width */
250
- ORIGINAL = "ORIGINAL",
251
- /** coast-to-coast display */
252
- FULL_WIDTH = "FULL_WIDTH"
253
- }
254
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
255
- /**
256
- * One of the following predefined width options:
257
- * `CONTENT`: The width of the container matches the content width.
258
- * `SMALL`: A small width.
259
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
260
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
261
- */
262
- size?: WidthType;
263
- /** A custom width value in pixels. */
264
- custom?: string | null;
265
- }
266
- /** @oneof */
267
- export interface PluginContainerDataWidthDataOneOf {
268
- /**
269
- * One of the following predefined width options:
270
- * `CONTENT`: The width of the container matches the content width.
271
- * `SMALL`: A small width.
272
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
273
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
274
- */
275
- size?: WidthType;
276
- /** A custom width value in pixels. */
277
- custom?: string | null;
278
- }
279
- export declare enum PluginContainerDataAlignment {
280
- /** Center Alignment */
281
- CENTER = "CENTER",
282
- /** Left Alignment */
283
- LEFT = "LEFT",
284
- /** Right Alignment */
285
- RIGHT = "RIGHT"
286
- }
287
- export interface Spoiler {
288
- /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
289
- enabled?: boolean | null;
290
- /** The description displayed on top of the spoiler cover. */
291
- description?: string | null;
292
- /** The text for the button used to remove the spoiler cover. */
293
- buttonText?: string | null;
294
- }
295
- export interface Height {
296
- /** A custom height value in pixels. */
297
- custom?: string | null;
298
- }
299
- export declare enum Type {
300
- /** Regular link button */
301
- LINK = "LINK",
302
- /** Triggers custom action that is defined in plugin configuration by the consumer */
303
- ACTION = "ACTION"
304
- }
305
- export interface Styles {
306
- /**
307
- * Deprecated: Use `borderWidth` and `borderRadius` instead.
308
- * @deprecated
309
- */
310
- border?: Border;
311
- /**
312
- * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
313
- * @deprecated
314
- */
315
- colors?: Colors;
316
- /** Border width in pixels. */
317
- borderWidth?: number | null;
318
- /**
319
- * Deprecated: Use `borderWidth` for normal/hover states instead.
320
- * @deprecated
321
- */
322
- borderWidthHover?: number | null;
323
- /** Border radius in pixels. */
324
- borderRadius?: number | null;
325
- /**
326
- * Border color as a hexadecimal value.
327
- * @format COLOR_HEX
328
- */
329
- borderColor?: string | null;
330
- /**
331
- * Border color as a hexadecimal value (hover state).
332
- * @format COLOR_HEX
333
- */
334
- borderColorHover?: string | null;
335
- /**
336
- * Text color as a hexadecimal value.
337
- * @format COLOR_HEX
338
- */
339
- textColor?: string | null;
340
- /**
341
- * Text color as a hexadecimal value (hover state).
342
- * @format COLOR_HEX
343
- */
344
- textColorHover?: string | null;
345
- /**
346
- * Background color as a hexadecimal value.
347
- * @format COLOR_HEX
348
- */
349
- backgroundColor?: string | null;
350
- /**
351
- * Background color as a hexadecimal value (hover state).
352
- * @format COLOR_HEX
353
- */
354
- backgroundColorHover?: string | null;
355
- /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
356
- buttonSize?: string | null;
357
- }
358
- export interface Link extends LinkDataOneOf {
359
- /** The absolute URL for the linked document. */
360
- url?: string;
361
- /** The target node's ID. Used for linking to another node in this object. */
362
- anchor?: string;
363
- /**
364
- * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
365
- * `SELF` - Default. Opens the linked document in the same frame as the link.
366
- * `BLANK` - Opens the linked document in a new browser tab or window.
367
- * `PARENT` - Opens the linked document in the link's parent frame.
368
- * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
369
- */
370
- target?: Target;
371
- /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
372
- rel?: Rel;
373
- /** A serialized object used for a custom or external link panel. */
374
- customData?: string | null;
375
- }
376
- /** @oneof */
377
- export interface LinkDataOneOf {
378
- /** The absolute URL for the linked document. */
379
- url?: string;
380
- /** The target node's ID. Used for linking to another node in this object. */
381
- anchor?: string;
382
- }
383
- export declare enum Target {
384
- /** Opens the linked document in the same frame as it was clicked (this is default) */
385
- SELF = "SELF",
386
- /** Opens the linked document in a new window or tab */
387
- BLANK = "BLANK",
388
- /** Opens the linked document in the parent frame */
389
- PARENT = "PARENT",
390
- /** Opens the linked document in the full body of the window */
391
- TOP = "TOP"
392
- }
393
- export interface Rel {
394
- /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
395
- nofollow?: boolean | null;
396
- /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
397
- sponsored?: boolean | null;
398
- /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
399
- ugc?: boolean | null;
400
- /** Indicates that this link protect referral information from being passed to the target website. */
401
- noreferrer?: boolean | null;
402
- }
403
- export interface CodeBlockData {
404
- /** Styling for the code block's text. */
405
- textStyle?: TextStyle;
406
- }
407
- export interface TextStyle {
408
- /** Text alignment. Defaults to `AUTO`. */
409
- textAlignment?: TextAlignment;
410
- /** 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. */
411
- lineHeight?: string | null;
412
- }
413
- export declare enum TextAlignment {
414
- /** browser default, eqivalent to `initial` */
415
- AUTO = "AUTO",
416
- /** Left align */
417
- LEFT = "LEFT",
418
- /** Right align */
419
- RIGHT = "RIGHT",
420
- /** Center align */
421
- CENTER = "CENTER",
422
- /** 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 */
423
- JUSTIFY = "JUSTIFY"
424
- }
425
- export interface DividerData {
426
- /** Styling for the divider's container. */
427
- containerData?: PluginContainerData;
428
- /** Divider line style. */
429
- lineStyle?: LineStyle;
430
- /** Divider width. */
431
- width?: Width;
432
- /** Divider alignment. */
433
- alignment?: Alignment;
434
- }
435
- export declare enum LineStyle {
436
- /** Single Line */
437
- SINGLE = "SINGLE",
438
- /** Double Line */
439
- DOUBLE = "DOUBLE",
440
- /** Dashed Line */
441
- DASHED = "DASHED",
442
- /** Dotted Line */
443
- DOTTED = "DOTTED"
444
- }
445
- export declare enum Width {
446
- /** Large line */
447
- LARGE = "LARGE",
448
- /** Medium line */
449
- MEDIUM = "MEDIUM",
450
- /** Small line */
451
- SMALL = "SMALL"
452
- }
453
- export declare enum Alignment {
454
- /** Center alignment */
455
- CENTER = "CENTER",
456
- /** Left alignment */
457
- LEFT = "LEFT",
458
- /** Right alignment */
459
- RIGHT = "RIGHT"
460
- }
461
- export interface FileData {
462
- /** Styling for the file's container. */
463
- containerData?: PluginContainerData;
464
- /** The source for the file's data. */
465
- src?: FileSource;
466
- /** File name. */
467
- name?: string | null;
468
- /** File type. */
469
- type?: string | null;
470
- /**
471
- * Use `sizeInKb` instead.
472
- * @deprecated
473
- */
474
- size?: number | null;
475
- /** Settings for PDF files. */
476
- pdfSettings?: PDFSettings;
477
- /** File MIME type. */
478
- mimeType?: string | null;
479
- /** File path. */
480
- path?: string | null;
481
- /** File size in KB. */
482
- sizeInKb?: string | null;
483
- }
484
- export declare enum ViewMode {
485
- /** No PDF view */
486
- NONE = "NONE",
487
- /** Full PDF view */
488
- FULL = "FULL",
489
- /** Mini PDF view */
490
- MINI = "MINI"
491
- }
492
- export interface FileSource extends FileSourceDataOneOf {
493
- /** The absolute URL for the file's source. */
494
- url?: string | null;
495
- /**
496
- * Custom ID. Use `id` instead.
497
- * @deprecated
498
- */
499
- custom?: string | null;
500
- /** An ID that's resolved to a URL by a resolver function. */
501
- _id?: string | null;
502
- /** Indicates whether the file's source is private. Defaults to `false`. */
503
- private?: boolean | null;
504
- }
505
- /** @oneof */
506
- export interface FileSourceDataOneOf {
507
- /** The absolute URL for the file's source. */
508
- url?: string | null;
509
- /**
510
- * Custom ID. Use `id` instead.
511
- * @deprecated
512
- */
513
- custom?: string | null;
514
- /** An ID that's resolved to a URL by a resolver function. */
515
- _id?: string | null;
516
- }
517
- export interface PDFSettings {
518
- /**
519
- * PDF view mode. One of the following:
520
- * `NONE` : The PDF isn't displayed.
521
- * `FULL` : A full page view of the PDF is displayed.
522
- * `MINI` : A mini view of the PDF is displayed.
523
- */
524
- viewMode?: ViewMode;
525
- /** Sets whether the PDF download button is disabled. Defaults to `false`. */
526
- disableDownload?: boolean | null;
527
- /** Sets whether the PDF print button is disabled. Defaults to `false`. */
528
- disablePrint?: boolean | null;
529
- }
530
- export interface GalleryData {
531
- /** Styling for the gallery's container. */
532
- containerData?: PluginContainerData;
533
- /** The items in the gallery. */
534
- items?: Item[];
535
- /** Options for defining the gallery's appearance. */
536
- options?: GalleryOptions;
537
- /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
538
- disableExpand?: boolean | null;
539
- /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
540
- disableDownload?: boolean | null;
541
- }
542
- export interface Media {
543
- /** The source for the media's data. */
544
- src?: FileSource;
545
- /** Media width in pixels. */
546
- width?: number | null;
547
- /** Media height in pixels. */
548
- height?: number | null;
549
- /** Media duration in seconds. Only relevant for audio and video files. */
550
- duration?: number | null;
551
- }
552
- export interface Image {
553
- /** Image file details. */
554
- media?: Media;
555
- /** Link details for images that are links. */
556
- link?: Link;
557
- }
558
- export interface Video {
559
- /** Video file details. */
560
- media?: Media;
561
- /** Video thumbnail file details. */
562
- thumbnail?: Media;
563
- }
564
- export interface Item extends ItemDataOneOf {
565
- /** An image item. */
566
- image?: Image;
567
- /** A video item. */
568
- video?: Video;
569
- /** Item title. */
570
- title?: string | null;
571
- /** Item's alternative text. */
572
- altText?: string | null;
573
- }
574
- /** @oneof */
575
- export interface ItemDataOneOf {
576
- /** An image item. */
577
- image?: Image;
578
- /** A video item. */
579
- video?: Video;
580
- }
581
- export interface GalleryOptions {
582
- /** Gallery layout. */
583
- layout?: Layout;
584
- /** Styling for gallery items. */
585
- item?: ItemStyle;
586
- /** Styling for gallery thumbnail images. */
587
- thumbnails?: Thumbnails;
588
- }
589
- export declare enum LayoutType {
590
- /** Collage type */
591
- COLLAGE = "COLLAGE",
592
- /** Masonry type */
593
- MASONRY = "MASONRY",
594
- /** Grid type */
595
- GRID = "GRID",
596
- /** Thumbnail type */
597
- THUMBNAIL = "THUMBNAIL",
598
- /** Slider type */
599
- SLIDER = "SLIDER",
600
- /** Slideshow type */
601
- SLIDESHOW = "SLIDESHOW",
602
- /** Panorama type */
603
- PANORAMA = "PANORAMA",
604
- /** Column type */
605
- COLUMN = "COLUMN",
606
- /** Magic type */
607
- MAGIC = "MAGIC",
608
- /** Fullsize images type */
609
- FULLSIZE = "FULLSIZE"
610
- }
611
- export declare enum Orientation {
612
- /** Rows Orientation */
613
- ROWS = "ROWS",
614
- /** Columns Orientation */
615
- COLUMNS = "COLUMNS"
616
- }
617
- export declare enum Crop {
618
- /** Crop to fill */
619
- FILL = "FILL",
620
- /** Crop to fit */
621
- FIT = "FIT"
622
- }
623
- export declare enum ThumbnailsAlignment {
624
- /** Top alignment */
625
- TOP = "TOP",
626
- /** Right alignment */
627
- RIGHT = "RIGHT",
628
- /** Bottom alignment */
629
- BOTTOM = "BOTTOM",
630
- /** Left alignment */
631
- LEFT = "LEFT",
632
- /** No thumbnail */
633
- NONE = "NONE"
634
- }
635
- export interface Layout {
636
- /** Gallery layout type. */
637
- type?: LayoutType;
638
- /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
639
- horizontalScroll?: boolean | null;
640
- /** Gallery orientation. */
641
- orientation?: Orientation;
642
- /** The number of columns to display on full size screens. */
643
- numberOfColumns?: number | null;
644
- /** The number of columns to display on mobile screens. */
645
- mobileNumberOfColumns?: number | null;
646
- }
647
- export interface ItemStyle {
648
- /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
649
- targetSize?: number | null;
650
- /** Item ratio */
651
- ratio?: number | null;
652
- /** Sets how item images are cropped. */
653
- crop?: Crop;
654
- /** The spacing between items in pixels. */
655
- spacing?: number | null;
656
- }
657
- export interface Thumbnails {
658
- /** Thumbnail alignment. */
659
- placement?: ThumbnailsAlignment;
660
- /** Spacing between thumbnails in pixels. */
661
- spacing?: number | null;
662
- }
663
- export interface GIFData {
664
- /** Styling for the GIF's container. */
665
- containerData?: PluginContainerData;
666
- /** The source of the full size GIF. */
667
- original?: GIF;
668
- /** The source of the downsized GIF. */
669
- downsized?: GIF;
670
- /** Height in pixels. */
671
- height?: number;
672
- /** Width in pixels. */
673
- width?: number;
674
- /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
675
- gifType?: GIFType;
676
- }
677
- export interface GIF {
678
- /**
679
- * GIF format URL.
680
- * @format WEB_URL
681
- */
682
- gif?: string | null;
683
- /**
684
- * MP4 format URL.
685
- * @format WEB_URL
686
- */
687
- mp4?: string | null;
688
- /**
689
- * Thumbnail URL.
690
- * @format WEB_URL
691
- */
692
- still?: string | null;
693
- }
694
- export declare enum GIFType {
695
- NORMAL = "NORMAL",
696
- STICKER = "STICKER"
697
- }
698
- export interface HeadingData {
699
- /** Heading level from 1-6. */
700
- level?: number;
701
- /** Styling for the heading text. */
702
- textStyle?: TextStyle;
703
- /** Indentation level from 1-4. */
704
- indentation?: number | null;
705
- }
706
- export interface HTMLData extends HTMLDataDataOneOf {
707
- /** The URL for the HTML code for the node. */
708
- url?: string;
709
- /** The HTML code for the node. */
710
- html?: string;
711
- /**
712
- * Whether this is an AdSense element. Use `source` instead.
713
- * @deprecated
714
- */
715
- isAdsense?: boolean | null;
716
- /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
717
- containerData?: PluginContainerData;
718
- /** The type of HTML code. */
719
- source?: Source;
720
- /** If container height is aligned with its content height. Defaults to `true`. */
721
- autoHeight?: boolean | null;
722
- }
723
- /** @oneof */
724
- export interface HTMLDataDataOneOf {
725
- /** The URL for the HTML code for the node. */
726
- url?: string;
727
- /** The HTML code for the node. */
728
- html?: string;
729
- /**
730
- * Whether this is an AdSense element. Use `source` instead.
731
- * @deprecated
732
- */
733
- isAdsense?: boolean | null;
734
- }
735
- export declare enum Source {
736
- HTML = "HTML",
737
- ADSENSE = "ADSENSE"
738
- }
739
- export interface ImageData {
740
- /** Styling for the image's container. */
741
- containerData?: PluginContainerData;
742
- /** Image file details. */
743
- image?: Media;
744
- /** Link details for images that are links. */
745
- link?: Link;
746
- /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
747
- disableExpand?: boolean | null;
748
- /** Image's alternative text. */
749
- altText?: string | null;
750
- /**
751
- * Deprecated: use Caption node instead.
752
- * @deprecated
753
- */
754
- caption?: string | null;
755
- /** Sets whether the image's download button is disabled. Defaults to `false`. */
756
- disableDownload?: boolean | null;
757
- /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
758
- decorative?: boolean | null;
759
- /** Styling for the image. */
760
- styles?: ImageDataStyles;
761
- }
762
- export interface StylesBorder {
763
- /** Border width in pixels. */
764
- width?: number | null;
765
- /**
766
- * Border color as a hexadecimal value.
767
- * @format COLOR_HEX
768
- */
769
- color?: string | null;
770
- /** Border radius in pixels. */
771
- radius?: number | null;
772
- }
773
- export interface ImageDataStyles {
774
- /** Border attributes. */
775
- border?: StylesBorder;
776
- }
777
- export interface LinkPreviewData {
778
- /** Styling for the link preview's container. */
779
- containerData?: PluginContainerData;
780
- /** Link details. */
781
- link?: Link;
782
- /** Preview title. */
783
- title?: string | null;
784
- /** Preview thumbnail URL. */
785
- thumbnailUrl?: string | null;
786
- /** Preview description. */
787
- description?: string | null;
788
- /** The preview content as HTML. */
789
- html?: string | null;
790
- /** Styling for the link preview. */
791
- styles?: LinkPreviewDataStyles;
792
- }
793
- export declare enum Position {
794
- /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
795
- START = "START",
796
- /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
797
- END = "END",
798
- /** Thumbnail positioned at the top */
799
- TOP = "TOP",
800
- /** Thumbnail hidden and not displayed */
801
- HIDDEN = "HIDDEN"
802
- }
803
- export interface LinkPreviewDataStyles {
804
- /**
805
- * Background color as a hexadecimal value.
806
- * @format COLOR_HEX
807
- */
808
- backgroundColor?: string | null;
809
- /**
810
- * Title color as a hexadecimal value.
811
- * @format COLOR_HEX
812
- */
813
- titleColor?: string | null;
814
- /**
815
- * Subtitle color as a hexadecimal value.
816
- * @format COLOR_HEX
817
- */
818
- subtitleColor?: string | null;
819
- /**
820
- * Link color as a hexadecimal value.
821
- * @format COLOR_HEX
822
- */
823
- linkColor?: string | null;
824
- /** Border width in pixels. */
825
- borderWidth?: number | null;
826
- /** Border radius in pixels. */
827
- borderRadius?: number | null;
828
- /**
829
- * Border color as a hexadecimal value.
830
- * @format COLOR_HEX
831
- */
832
- borderColor?: string | null;
833
- /** Position of thumbnail. Defaults to `START`. */
834
- thumbnailPosition?: Position;
835
- }
836
- export interface MapData {
837
- /** Styling for the map's container. */
838
- containerData?: PluginContainerData;
839
- /** Map settings. */
840
- mapSettings?: MapSettings;
841
- }
842
- export interface MapSettings {
843
- /** The address to display on the map. */
844
- address?: string | null;
845
- /** Sets whether the map is draggable. */
846
- draggable?: boolean | null;
847
- /** Sets whether the location marker is visible. */
848
- marker?: boolean | null;
849
- /** Sets whether street view control is enabled. */
850
- streetViewControl?: boolean | null;
851
- /** Sets whether zoom control is enabled. */
852
- zoomControl?: boolean | null;
853
- /** Location latitude. */
854
- lat?: number | null;
855
- /** Location longitude. */
856
- lng?: number | null;
857
- /** Location name. */
858
- locationName?: string | null;
859
- /** Sets whether view mode control is enabled. */
860
- viewModeControl?: boolean | null;
861
- /** Initial zoom value. */
862
- initialZoom?: number | null;
863
- /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
864
- mapType?: MapType;
865
- }
866
- export declare enum MapType {
867
- /** Roadmap map type */
868
- ROADMAP = "ROADMAP",
869
- /** Satellite map type */
870
- SATELITE = "SATELITE",
871
- /** Hybrid map type */
872
- HYBRID = "HYBRID",
873
- /** Terrain map type */
874
- TERRAIN = "TERRAIN"
875
- }
876
- export interface ParagraphData {
877
- /** Styling for the paragraph text. */
878
- textStyle?: TextStyle;
879
- /** Indentation level from 1-4. */
880
- indentation?: number | null;
881
- /** Paragraph level */
882
- level?: number | null;
883
- }
884
- export interface PollData {
885
- /** Styling for the poll's container. */
886
- containerData?: PluginContainerData;
887
- /** Poll data. */
888
- poll?: Poll;
889
- /** Layout settings for the poll and voting options. */
890
- layout?: PollDataLayout;
891
- /** Styling for the poll and voting options. */
892
- design?: Design;
893
- }
894
- export declare enum ViewRole {
895
- /** Only Poll creator can view the results */
896
- CREATOR = "CREATOR",
897
- /** Anyone who voted can see the results */
898
- VOTERS = "VOTERS",
899
- /** Anyone can see the results, even if one didn't vote */
900
- EVERYONE = "EVERYONE"
901
- }
902
- export declare enum VoteRole {
903
- /** Logged in member */
904
- SITE_MEMBERS = "SITE_MEMBERS",
905
- /** Anyone */
906
- ALL = "ALL"
907
- }
908
- export interface Permissions {
909
- /** Sets who can view the poll results. */
910
- view?: ViewRole;
911
- /** Sets who can vote. */
912
- vote?: VoteRole;
913
- /** Sets whether one voter can vote multiple times. Defaults to `false`. */
914
- allowMultipleVotes?: boolean | null;
915
- }
916
- export interface Option {
917
- /** Option ID. */
918
- _id?: string | null;
919
- /** Option title. */
920
- title?: string | null;
921
- /** The image displayed with the option. */
922
- image?: Media;
923
- }
924
- export interface Settings {
925
- /** Permissions settings for voting. */
926
- permissions?: Permissions;
927
- /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
928
- showVoters?: boolean | null;
929
- /** Sets whether the vote count is displayed. Defaults to `true`. */
930
- showVotesCount?: boolean | null;
931
- }
932
- export declare enum PollLayoutType {
933
- /** List */
934
- LIST = "LIST",
935
- /** Grid */
936
- GRID = "GRID"
937
- }
938
- export declare enum PollLayoutDirection {
939
- /** Left-to-right */
940
- LTR = "LTR",
941
- /** Right-to-left */
942
- RTL = "RTL"
943
- }
944
- export interface PollLayout {
945
- /** The layout for displaying the voting options. */
946
- type?: PollLayoutType;
947
- /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
948
- direction?: PollLayoutDirection;
949
- /** Sets whether to display the main poll image. Defaults to `false`. */
950
- enableImage?: boolean | null;
951
- }
952
- export interface OptionLayout {
953
- /** Sets whether to display option images. Defaults to `false`. */
954
- enableImage?: boolean | null;
955
- }
956
- export declare enum BackgroundType {
957
- /** Color background type */
958
- COLOR = "COLOR",
959
- /** Image background type */
960
- IMAGE = "IMAGE",
961
- /** Gradiant background type */
962
- GRADIENT = "GRADIENT"
963
- }
964
- export interface Gradient {
965
- /** The gradient angle in degrees. */
966
- angle?: number | null;
967
- /**
968
- * The start color as a hexademical value.
969
- * @format COLOR_HEX
970
- */
971
- startColor?: string | null;
972
- /**
973
- * The end color as a hexademical value.
974
- * @format COLOR_HEX
975
- */
976
- lastColor?: string | null;
977
- }
978
- export interface Background extends BackgroundBackgroundOneOf {
979
- /**
980
- * The background color as a hexademical value.
981
- * @format COLOR_HEX
982
- */
983
- color?: string | null;
984
- /** An image to use for the background. */
985
- image?: Media;
986
- /** Details for a gradient background. */
987
- gradient?: Gradient;
988
- /** Background type. For each option, include the relevant details. */
989
- type?: BackgroundType;
990
- }
991
- /** @oneof */
992
- export interface BackgroundBackgroundOneOf {
993
- /**
994
- * The background color as a hexademical value.
995
- * @format COLOR_HEX
996
- */
997
- color?: string | null;
998
- /** An image to use for the background. */
999
- image?: Media;
1000
- /** Details for a gradient background. */
1001
- gradient?: Gradient;
1002
- }
1003
- export interface PollDesign {
1004
- /** Background styling. */
1005
- background?: Background;
1006
- /** Border radius in pixels. */
1007
- borderRadius?: number | null;
1008
- }
1009
- export interface OptionDesign {
1010
- /** Border radius in pixels. */
1011
- borderRadius?: number | null;
1012
- }
1013
- export interface Poll {
1014
- /** Poll ID. */
1015
- _id?: string | null;
1016
- /** Poll title. */
1017
- title?: string | null;
1018
- /** Poll creator ID. */
1019
- creatorId?: string | null;
1020
- /** Main poll image. */
1021
- image?: Media;
1022
- /** Voting options. */
1023
- options?: Option[];
1024
- /** The poll's permissions and display settings. */
1025
- settings?: Settings;
1026
- }
1027
- export interface PollDataLayout {
1028
- /** Poll layout settings. */
1029
- poll?: PollLayout;
1030
- /** Voting otpions layout settings. */
1031
- options?: OptionLayout;
1032
- }
1033
- export interface Design {
1034
- /** Styling for the poll. */
1035
- poll?: PollDesign;
1036
- /** Styling for voting options. */
1037
- options?: OptionDesign;
1038
- }
1039
- export interface TextData {
1040
- /** The text to apply decorations to. */
1041
- text?: string;
1042
- /** The decorations to apply. */
1043
- decorations?: Decoration[];
1044
- }
1045
- /** Adds appearence changes to text */
1046
- export interface Decoration extends DecorationDataOneOf {
1047
- /** Data for an anchor link decoration. */
1048
- anchorData?: AnchorData;
1049
- /** Data for a color decoration. */
1050
- colorData?: ColorData;
1051
- /** Data for an external link decoration. */
1052
- linkData?: LinkData;
1053
- /** Data for a mention decoration. */
1054
- mentionData?: MentionData;
1055
- /** Data for a font size decoration. */
1056
- fontSizeData?: FontSizeData;
1057
- /** Font weight for a bold decoration. */
1058
- fontWeightValue?: number | null;
1059
- /** Data for an italic decoration. Defaults to `true`. */
1060
- italicData?: boolean | null;
1061
- /** Data for an underline decoration. Defaults to `true`. */
1062
- underlineData?: boolean | null;
1063
- /** Data for a spoiler decoration. */
1064
- spoilerData?: SpoilerData;
1065
- /** The type of decoration to apply. */
1066
- type?: DecorationType;
1067
- }
1068
- /** @oneof */
1069
- export interface DecorationDataOneOf {
1070
- /** Data for an anchor link decoration. */
1071
- anchorData?: AnchorData;
1072
- /** Data for a color decoration. */
1073
- colorData?: ColorData;
1074
- /** Data for an external link decoration. */
1075
- linkData?: LinkData;
1076
- /** Data for a mention decoration. */
1077
- mentionData?: MentionData;
1078
- /** Data for a font size decoration. */
1079
- fontSizeData?: FontSizeData;
1080
- /** Font weight for a bold decoration. */
1081
- fontWeightValue?: number | null;
1082
- /** Data for an italic decoration. Defaults to `true`. */
1083
- italicData?: boolean | null;
1084
- /** Data for an underline decoration. Defaults to `true`. */
1085
- underlineData?: boolean | null;
1086
- /** Data for a spoiler decoration. */
1087
- spoilerData?: SpoilerData;
1088
- }
1089
- export declare enum DecorationType {
1090
- BOLD = "BOLD",
1091
- ITALIC = "ITALIC",
1092
- UNDERLINE = "UNDERLINE",
1093
- SPOILER = "SPOILER",
1094
- ANCHOR = "ANCHOR",
1095
- MENTION = "MENTION",
1096
- LINK = "LINK",
1097
- COLOR = "COLOR",
1098
- FONT_SIZE = "FONT_SIZE",
1099
- EXTERNAL = "EXTERNAL"
1100
- }
1101
- export interface AnchorData {
1102
- /** The target node's ID. */
1103
- anchor?: string;
1104
- }
1105
- export interface ColorData {
1106
- /** The text's background color as a hexadecimal value. */
1107
- background?: string | null;
1108
- /** The text's foreground color as a hexadecimal value. */
1109
- foreground?: string | null;
1110
- }
1111
- export interface LinkData {
1112
- /** Link details. */
1113
- link?: Link;
1114
- }
1115
- export interface MentionData {
1116
- /** The mentioned user's name. */
1117
- name?: string;
1118
- /** The version of the user's name that appears after the `@` character in the mention. */
1119
- slug?: string;
1120
- /** Mentioned user's ID. */
1121
- _id?: string | null;
1122
- }
1123
- export interface FontSizeData {
1124
- /** The units used for the font size. */
1125
- unit?: FontType;
1126
- /** Font size value. */
1127
- value?: number | null;
1128
- }
1129
- export declare enum FontType {
1130
- PX = "PX",
1131
- EM = "EM"
1132
- }
1133
- export interface SpoilerData {
1134
- /** Spoiler ID. */
1135
- _id?: string | null;
1136
- }
1137
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1138
- /** Data for embedded Wix Bookings content. */
1139
- bookingData?: BookingData;
1140
- /** Data for embedded Wix Events content. */
1141
- eventData?: EventData;
1142
- /** The type of Wix App content being embedded. */
1143
- type?: AppType;
1144
- /** The ID of the embedded content. */
1145
- itemId?: string | null;
1146
- /** The name of the embedded content. */
1147
- name?: string | null;
1148
- /**
1149
- * Deprecated: Use `image` instead.
1150
- * @deprecated
1151
- */
1152
- imageSrc?: string | null;
1153
- /** The URL for the embedded content. */
1154
- url?: string | null;
1155
- /** An image for the embedded content. */
1156
- image?: Media;
1157
- }
1158
- /** @oneof */
1159
- export interface AppEmbedDataAppDataOneOf {
1160
- /** Data for embedded Wix Bookings content. */
1161
- bookingData?: BookingData;
1162
- /** Data for embedded Wix Events content. */
1163
- eventData?: EventData;
1164
- }
1165
- export declare enum AppType {
1166
- PRODUCT = "PRODUCT",
1167
- EVENT = "EVENT",
1168
- BOOKING = "BOOKING"
1169
- }
1170
- export interface BookingData {
1171
- /** Booking duration in minutes. */
1172
- durations?: string | null;
1173
- }
1174
- export interface EventData {
1175
- /** Event schedule. */
1176
- scheduling?: string | null;
1177
- /** Event location. */
1178
- location?: string | null;
1179
- }
1180
- export interface VideoData {
1181
- /** Styling for the video's container. */
1182
- containerData?: PluginContainerData;
1183
- /** Video details. */
1184
- video?: Media;
1185
- /** Video thumbnail details. */
1186
- thumbnail?: Media;
1187
- /** Sets whether the video's download button is disabled. Defaults to `false`. */
1188
- disableDownload?: boolean | null;
1189
- /** Video title. */
1190
- title?: string | null;
1191
- /** Video options. */
1192
- options?: PlaybackOptions;
1193
- }
1194
- export interface PlaybackOptions {
1195
- /** Sets whether the media will automatically start playing. */
1196
- autoPlay?: boolean | null;
1197
- /** Sets whether media's will be looped. */
1198
- playInLoop?: boolean | null;
1199
- /** Sets whether media's controls will be shown. */
1200
- showControls?: boolean | null;
1201
- }
1202
- export interface EmbedData {
1203
- /** Styling for the oEmbed node's container. */
1204
- containerData?: PluginContainerData;
1205
- /** An [oEmbed](https://www.oembed.com) object. */
1206
- oembed?: Oembed;
1207
- /** Origin asset source. */
1208
- src?: string | null;
1209
- }
1210
- export interface Oembed {
1211
- /** The resource type. */
1212
- type?: string | null;
1213
- /** The width of the resource specified in the `url` property in pixels. */
1214
- width?: number | null;
1215
- /** The height of the resource specified in the `url` property in pixels. */
1216
- height?: number | null;
1217
- /** Resource title. */
1218
- title?: string | null;
1219
- /** The source URL for the resource. */
1220
- url?: string | null;
1221
- /** HTML for embedding a video player. The HTML should have no padding or margins. */
1222
- html?: string | null;
1223
- /** The name of the author or owner of the resource. */
1224
- authorName?: string | null;
1225
- /** The URL for the author or owner of the resource. */
1226
- authorUrl?: string | null;
1227
- /** The name of the resource provider. */
1228
- providerName?: string | null;
1229
- /** The URL for the resource provider. */
1230
- providerUrl?: string | null;
1231
- /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
1232
- thumbnailUrl?: string | null;
1233
- /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
1234
- thumbnailWidth?: string | null;
1235
- /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
1236
- thumbnailHeight?: string | null;
1237
- /** The URL for an embedded viedo. */
1238
- videoUrl?: string | null;
1239
- /** The oEmbed version number. This value must be `1.0`. */
1240
- version?: string | null;
1241
- }
1242
- export interface CollapsibleListData {
1243
- /** Styling for the collapsible list's container. */
1244
- containerData?: PluginContainerData;
1245
- /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1246
- expandOnlyOne?: boolean | null;
1247
- /** Sets which items are expanded when the page loads. */
1248
- initialExpandedItems?: InitialExpandedItems;
1249
- /** The direction of the text in the list. Either left-to-right or right-to-left. */
1250
- direction?: Direction;
1251
- /** If `true`, The collapsible item will appear in search results as an FAQ. */
1252
- isQapageData?: boolean | null;
1253
- }
1254
- export declare enum InitialExpandedItems {
1255
- /** First item will be expended initally */
1256
- FIRST = "FIRST",
1257
- /** All items will expended initally */
1258
- ALL = "ALL",
1259
- /** All items collapsed initally */
1260
- NONE = "NONE"
1261
- }
1262
- export declare enum Direction {
1263
- /** Left-to-right */
1264
- LTR = "LTR",
1265
- /** Right-to-left */
1266
- RTL = "RTL"
1267
- }
1268
- export interface TableData {
1269
- /** Styling for the table's container. */
1270
- containerData?: PluginContainerData;
1271
- /** The table's dimensions. */
1272
- dimensions?: Dimensions;
1273
- /**
1274
- * Deprecated: Use `rowHeader` and `columnHeader` instead.
1275
- * @deprecated
1276
- */
1277
- header?: boolean | null;
1278
- /** Sets whether the table's first row is a header. Defaults to `false`. */
1279
- rowHeader?: boolean | null;
1280
- /** Sets whether the table's first column is a header. Defaults to `false`. */
1281
- columnHeader?: boolean | null;
1282
- }
1283
- export interface Dimensions {
1284
- /** An array representing relative width of each column in relation to the other columns. */
1285
- colsWidthRatio?: number[];
1286
- /** An array representing the height of each row in pixels. */
1287
- rowsHeight?: number[];
1288
- /** An array representing the minimum width of each column in pixels. */
1289
- colsMinWidth?: number[];
1290
- }
1291
- export interface TableCellData {
1292
- /** Styling for the cell's background color and text alignment. */
1293
- cellStyle?: CellStyle;
1294
- /** The cell's border colors. */
1295
- borderColors?: BorderColors;
1296
- }
1297
- export declare enum VerticalAlignment {
1298
- /** Top alignment */
1299
- TOP = "TOP",
1300
- /** Middle alignment */
1301
- MIDDLE = "MIDDLE",
1302
- /** Bottom alignment */
1303
- BOTTOM = "BOTTOM"
1304
- }
1305
- export interface CellStyle {
1306
- /** Vertical alignment for the cell's text. */
1307
- verticalAlignment?: VerticalAlignment;
1308
- /**
1309
- * Cell background color as a hexadecimal value.
1310
- * @format COLOR_HEX
1311
- */
1312
- backgroundColor?: string | null;
1313
- }
1314
- export interface BorderColors {
1315
- /**
1316
- * Left border color as a hexadecimal value.
1317
- * @format COLOR_HEX
1318
- */
1319
- left?: string | null;
1320
- /**
1321
- * Right border color as a hexadecimal value.
1322
- * @format COLOR_HEX
1323
- */
1324
- right?: string | null;
1325
- /**
1326
- * Top border color as a hexadecimal value.
1327
- * @format COLOR_HEX
1328
- */
1329
- top?: string | null;
1330
- /**
1331
- * Bottom border color as a hexadecimal value.
1332
- * @format COLOR_HEX
1333
- */
1334
- bottom?: string | null;
1335
- }
1336
- /**
1337
- * `NullValue` is a singleton enumeration to represent the null value for the
1338
- * `Value` type union.
1339
- *
1340
- * The JSON representation for `NullValue` is JSON `null`.
1341
- */
1342
- export declare enum NullValue {
1343
- /** Null value. */
1344
- NULL_VALUE = "NULL_VALUE"
1345
- }
1346
- /**
1347
- * `ListValue` is a wrapper around a repeated field of values.
1348
- *
1349
- * The JSON representation for `ListValue` is JSON array.
1350
- */
1351
- export interface ListValue {
1352
- /** Repeated field of dynamically typed values. */
1353
- values?: any[];
1354
- }
1355
- export interface AudioData {
1356
- /** Styling for the audio node's container. */
1357
- containerData?: PluginContainerData;
1358
- /** Audio file details. */
1359
- audio?: Media;
1360
- /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
1361
- disableDownload?: boolean | null;
1362
- /** Cover image. */
1363
- coverImage?: Media;
1364
- /** Track name. */
1365
- name?: string | null;
1366
- /** Author name. */
1367
- authorName?: string | null;
1368
- /** An HTML version of the audio node. */
1369
- html?: string | null;
1370
- }
1371
- export interface OrderedListData {
1372
- /** Indentation level from 0-4. */
1373
- indentation?: number;
1374
- /** Offset level from 0-4. */
1375
- offset?: number | null;
1376
- /** List start number. */
1377
- start?: number | null;
1378
- }
1379
- export interface BulletedListData {
1380
- /** Indentation level from 0-4. */
1381
- indentation?: number;
1382
- /** Offset level from 0-4. */
1383
- offset?: number | null;
1384
- }
1385
- export interface BlockquoteData {
1386
- /** Indentation level from 1-4. */
1387
- indentation?: number;
1388
- }
1389
- export interface CaptionData {
1390
- textStyle?: TextStyle;
1391
- }
1392
- export interface LayoutCellData {
1393
- /** Size of the cell in 12 columns grid. */
1394
- colSpan?: number | null;
1395
- }
1396
- export interface Metadata {
1397
- /** Schema version. */
1398
- version?: number;
1399
- /**
1400
- * When the object was created.
1401
- * @readonly
1402
- * @deprecated
1403
- */
1404
- createdTimestamp?: Date | null;
1405
- /**
1406
- * When the object was most recently updated.
1407
- * @deprecated
1408
- */
1409
- updatedTimestamp?: Date | null;
1410
- /** Object ID. */
1411
- _id?: string | null;
1412
- }
1413
- export interface DocumentStyle {
1414
- /** Styling for H1 nodes. */
1415
- headerOne?: TextNodeStyle;
1416
- /** Styling for H2 nodes. */
1417
- headerTwo?: TextNodeStyle;
1418
- /** Styling for H3 nodes. */
1419
- headerThree?: TextNodeStyle;
1420
- /** Styling for H4 nodes. */
1421
- headerFour?: TextNodeStyle;
1422
- /** Styling for H5 nodes. */
1423
- headerFive?: TextNodeStyle;
1424
- /** Styling for H6 nodes. */
1425
- headerSix?: TextNodeStyle;
1426
- /** Styling for paragraph nodes. */
1427
- paragraph?: TextNodeStyle;
1428
- /** Styling for block quote nodes. */
1429
- blockquote?: TextNodeStyle;
1430
- /** Styling for code block nodes. */
1431
- codeBlock?: TextNodeStyle;
1432
- }
1433
- export interface TextNodeStyle {
1434
- /** The decorations to apply to the node. */
1435
- decorations?: Decoration[];
1436
- /** Padding and background color for the node. */
1437
- nodeStyle?: NodeStyle;
1438
- /** Line height for text in the node. */
1439
- lineHeight?: string | null;
1440
- }
1441
- export interface CreateMemberAboutRequest {
1442
- /** The "About" section content to create. */
1443
- memberAbout: MemberAbout;
1444
- }
1445
- export interface CreateMemberAboutResponse {
1446
- /** The created "About" section content. */
1447
- memberAbout?: MemberAbout;
1448
- }
1449
- export interface UpdateMemberAboutRequest {
1450
- /** The "About" section content to update. */
1451
- memberAbout: MemberAbout;
1452
- }
1453
- export interface UpdateMemberAboutResponse {
1454
- /** The updated "About" section content. */
1455
- memberAbout?: MemberAbout;
1456
- }
1457
- export interface DeleteMemberAboutRequest {
1458
- /**
1459
- * ID of the "About" section content to delete.
1460
- * @format GUID
1461
- */
1462
- _id: string;
1463
- }
1464
- export interface DeleteMemberAboutResponse {
1465
- }
1466
- export interface GetMemberAboutRequest {
1467
- /**
1468
- * ID of the "About" section content to retrieve.
1469
- * @format GUID
1470
- */
1471
- _id: string;
1472
- }
1473
- export interface GetMemberAboutResponse {
1474
- /** The retrieved "About" section content. */
1475
- memberAbout?: MemberAbout;
1476
- }
1477
- export interface GetMyMemberAboutRequest {
1478
- }
1479
- export interface GetMyMemberAboutResponse {
1480
- /** The "About" section content of the current member. */
1481
- memberAbout?: MemberAbout;
1482
- }
1483
- export interface QueryMemberAboutsRequest {
1484
- /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
1485
- query?: CursorQuery;
1486
- }
1487
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1488
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1489
- cursorPaging?: CursorPaging;
1490
- /**
1491
- * Filter object in the following format:
1492
- * `"filter" : {
1493
- * "fieldName1": "value1",
1494
- * "fieldName2":{"$operator":"value2"}
1495
- * }`
1496
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
1497
- */
1498
- filter?: Record<string, any> | null;
1499
- /**
1500
- * Sort object in the following format:
1501
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1502
- */
1503
- sort?: Sorting[];
1504
- }
1505
- /** @oneof */
1506
- export interface CursorQueryPagingMethodOneOf {
1507
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1508
- cursorPaging?: CursorPaging;
1509
- }
1510
- export interface Sorting {
1511
- /** Name of the field to sort by. */
1512
- fieldName?: string;
1513
- /** Sort order. */
1514
- order?: SortOrder;
1515
- }
1516
- export declare enum SortOrder {
1517
- /** Sort is in ascending order. */
1518
- ASC = "ASC",
1519
- /** Sort is in the descending order. */
1520
- DESC = "DESC"
1521
- }
1522
- export interface CursorPaging {
1523
- /**
1524
- * Number of items to load.
1525
- * @max 100
1526
- */
1527
- limit?: number | null;
1528
- /**
1529
- * Pointer to the next or previous page in the list of results.
1530
- *
1531
- * You can get the relevant cursor token
1532
- * from the `pagingMetadata` object in the previous call's response.
1533
- * Not relevant for the first request.
1534
- */
1535
- cursor?: string | null;
1536
- }
1537
- export interface QueryMemberAboutsResponse {
1538
- /** The retrieved content from the "About" sections. */
1539
- memberAbouts?: MemberAbout[];
1540
- /** Metadata for the paginated results. */
1541
- metadata?: CursorPagingMetadata;
1542
- }
1543
- export interface CursorPagingMetadata {
1544
- /** Number of items returned in current page. */
1545
- count?: number | null;
1546
- /** Cursor strings that point to the next page, previous page, or both. */
1547
- cursors?: Cursors;
1548
- /**
1549
- * Whether there are more pages to retrieve following the current page.
1550
- *
1551
- * + `true`: Another page of results can be retrieved.
1552
- * + `false`: This is the last page.
1553
- */
1554
- hasNext?: boolean | null;
1555
- }
1556
- export interface Cursors {
1557
- /**
1558
- * Cursor string pointing to the next page in the list of results.
1559
- * @maxLength 16000
1560
- */
1561
- next?: string | null;
1562
- /**
1563
- * Cursor pointing to the previous page in the list of results.
1564
- * @maxLength 16000
1565
- */
1566
- prev?: string | null;
1567
- }
1568
- export interface DomainEvent extends DomainEventBodyOneOf {
1569
- createdEvent?: EntityCreatedEvent;
1570
- updatedEvent?: EntityUpdatedEvent;
1571
- deletedEvent?: EntityDeletedEvent;
1572
- actionEvent?: ActionEvent;
1573
- /**
1574
- * Unique event ID.
1575
- * Allows clients to ignore duplicate webhooks.
1576
- */
1577
- _id?: string;
1578
- /**
1579
- * Assumes actions are also always typed to an entity_type
1580
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1581
- */
1582
- entityFqdn?: string;
1583
- /**
1584
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1585
- * This is although the created/updated/deleted notion is duplication of the oneof types
1586
- * Example: created/updated/deleted/started/completed/email_opened
1587
- */
1588
- slug?: string;
1589
- /** ID of the entity associated with the event. */
1590
- entityId?: string;
1591
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1592
- eventTime?: Date | null;
1593
- /**
1594
- * Whether the event was triggered as a result of a privacy regulation application
1595
- * (for example, GDPR).
1596
- */
1597
- triggeredByAnonymizeRequest?: boolean | null;
1598
- /** If present, indicates the action that triggered the event. */
1599
- originatedFrom?: string | null;
1600
- /**
1601
- * A sequence number defining the order of updates to the underlying entity.
1602
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1603
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1604
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1605
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1606
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1607
- */
1608
- entityEventSequence?: string | null;
1609
- }
1610
- /** @oneof */
1611
- export interface DomainEventBodyOneOf {
1612
- createdEvent?: EntityCreatedEvent;
1613
- updatedEvent?: EntityUpdatedEvent;
1614
- deletedEvent?: EntityDeletedEvent;
1615
- actionEvent?: ActionEvent;
1616
- }
1617
- export interface EntityCreatedEvent {
1618
- entity?: string;
1619
- }
1620
- export interface RestoreInfo {
1621
- deletedDate?: Date | null;
1622
- }
1623
- export interface EntityUpdatedEvent {
1624
- /**
1625
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1626
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1627
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1628
- */
1629
- currentEntity?: string;
1630
- }
1631
- export interface EntityDeletedEvent {
1632
- /** Entity that was deleted */
1633
- deletedEntity?: string | null;
1634
- }
1635
- export interface ActionEvent {
1636
- body?: string;
1637
- }
1638
- export interface MessageEnvelope {
1639
- /**
1640
- * App instance ID.
1641
- * @format GUID
1642
- */
1643
- instanceId?: string | null;
1644
- /**
1645
- * Event type.
1646
- * @maxLength 150
1647
- */
1648
- eventType?: string;
1649
- /** The identification type and identity data. */
1650
- identity?: IdentificationData;
1651
- /** Stringify payload. */
1652
- data?: string;
1653
- }
1654
- export interface IdentificationData extends IdentificationDataIdOneOf {
1655
- /**
1656
- * ID of a site visitor that has not logged in to the site.
1657
- * @format GUID
1658
- */
1659
- anonymousVisitorId?: string;
1660
- /**
1661
- * ID of a site visitor that has logged in to the site.
1662
- * @format GUID
1663
- */
1664
- memberId?: string;
1665
- /**
1666
- * ID of a Wix user (site owner, contributor, etc.).
1667
- * @format GUID
1668
- */
1669
- wixUserId?: string;
1670
- /**
1671
- * ID of an app.
1672
- * @format GUID
1673
- */
1674
- appId?: string;
1675
- /** @readonly */
1676
- identityType?: WebhookIdentityType;
1677
- }
1678
- /** @oneof */
1679
- export interface IdentificationDataIdOneOf {
1680
- /**
1681
- * ID of a site visitor that has not logged in to the site.
1682
- * @format GUID
1683
- */
1684
- anonymousVisitorId?: string;
1685
- /**
1686
- * ID of a site visitor that has logged in to the site.
1687
- * @format GUID
1688
- */
1689
- memberId?: string;
1690
- /**
1691
- * ID of a Wix user (site owner, contributor, etc.).
1692
- * @format GUID
1693
- */
1694
- wixUserId?: string;
1695
- /**
1696
- * ID of an app.
1697
- * @format GUID
1698
- */
1699
- appId?: string;
1700
- }
1701
- export declare enum WebhookIdentityType {
1702
- UNKNOWN = "UNKNOWN",
1703
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1704
- MEMBER = "MEMBER",
1705
- WIX_USER = "WIX_USER",
1706
- APP = "APP"
1707
- }
1708
- interface PluginContainerDataWidthNonNullableFields {
1709
- size: WidthType;
1710
- }
1711
- interface PluginContainerDataNonNullableFields {
1712
- width?: PluginContainerDataWidthNonNullableFields;
1713
- alignment: PluginContainerDataAlignment;
1714
- }
1715
- interface LinkNonNullableFields {
1716
- url: string;
1717
- anchor: string;
1718
- target: Target;
1719
- }
1720
- interface ButtonDataNonNullableFields {
1721
- containerData?: PluginContainerDataNonNullableFields;
1722
- type: Type;
1723
- link?: LinkNonNullableFields;
1724
- }
1725
- interface TextStyleNonNullableFields {
1726
- textAlignment: TextAlignment;
1727
- }
1728
- interface CodeBlockDataNonNullableFields {
1729
- textStyle?: TextStyleNonNullableFields;
1730
- }
1731
- interface DividerDataNonNullableFields {
1732
- containerData?: PluginContainerDataNonNullableFields;
1733
- lineStyle: LineStyle;
1734
- width: Width;
1735
- alignment: Alignment;
1736
- }
1737
- interface PDFSettingsNonNullableFields {
1738
- viewMode: ViewMode;
1739
- }
1740
- interface FileDataNonNullableFields {
1741
- containerData?: PluginContainerDataNonNullableFields;
1742
- pdfSettings?: PDFSettingsNonNullableFields;
1743
- }
1744
- interface ImageNonNullableFields {
1745
- link?: LinkNonNullableFields;
1746
- }
1747
- interface ItemNonNullableFields {
1748
- image?: ImageNonNullableFields;
1749
- }
1750
- interface LayoutNonNullableFields {
1751
- type: LayoutType;
1752
- orientation: Orientation;
1753
- }
1754
- interface ItemStyleNonNullableFields {
1755
- crop: Crop;
1756
- }
1757
- interface ThumbnailsNonNullableFields {
1758
- placement: ThumbnailsAlignment;
1759
- }
1760
- interface GalleryOptionsNonNullableFields {
1761
- layout?: LayoutNonNullableFields;
1762
- item?: ItemStyleNonNullableFields;
1763
- thumbnails?: ThumbnailsNonNullableFields;
1764
- }
1765
- interface GalleryDataNonNullableFields {
1766
- containerData?: PluginContainerDataNonNullableFields;
1767
- items: ItemNonNullableFields[];
1768
- options?: GalleryOptionsNonNullableFields;
1769
- }
1770
- interface GIFDataNonNullableFields {
1771
- containerData?: PluginContainerDataNonNullableFields;
1772
- height: number;
1773
- width: number;
1774
- gifType: GIFType;
1775
- }
1776
- interface HeadingDataNonNullableFields {
1777
- level: number;
1778
- textStyle?: TextStyleNonNullableFields;
1779
- }
1780
- interface HTMLDataNonNullableFields {
1781
- url: string;
1782
- html: string;
1783
- containerData?: PluginContainerDataNonNullableFields;
1784
- source: Source;
1785
- }
1786
- interface ImageDataNonNullableFields {
1787
- containerData?: PluginContainerDataNonNullableFields;
1788
- link?: LinkNonNullableFields;
1789
- }
1790
- interface LinkPreviewDataStylesNonNullableFields {
1791
- thumbnailPosition: Position;
1792
- }
1793
- interface LinkPreviewDataNonNullableFields {
1794
- containerData?: PluginContainerDataNonNullableFields;
1795
- link?: LinkNonNullableFields;
1796
- styles?: LinkPreviewDataStylesNonNullableFields;
1797
- }
1798
- interface MapSettingsNonNullableFields {
1799
- mapType: MapType;
1800
- }
1801
- interface MapDataNonNullableFields {
1802
- containerData?: PluginContainerDataNonNullableFields;
1803
- mapSettings?: MapSettingsNonNullableFields;
1804
- }
1805
- interface ParagraphDataNonNullableFields {
1806
- textStyle?: TextStyleNonNullableFields;
1807
- }
1808
- interface PermissionsNonNullableFields {
1809
- view: ViewRole;
1810
- vote: VoteRole;
1811
- }
1812
- interface SettingsNonNullableFields {
1813
- permissions?: PermissionsNonNullableFields;
1814
- }
1815
- interface PollNonNullableFields {
1816
- settings?: SettingsNonNullableFields;
1817
- }
1818
- interface PollLayoutNonNullableFields {
1819
- type: PollLayoutType;
1820
- direction: PollLayoutDirection;
1821
- }
1822
- interface PollDataLayoutNonNullableFields {
1823
- poll?: PollLayoutNonNullableFields;
1824
- }
1825
- interface BackgroundNonNullableFields {
1826
- type: BackgroundType;
1827
- }
1828
- interface PollDesignNonNullableFields {
1829
- background?: BackgroundNonNullableFields;
1830
- }
1831
- interface DesignNonNullableFields {
1832
- poll?: PollDesignNonNullableFields;
1833
- }
1834
- interface PollDataNonNullableFields {
1835
- containerData?: PluginContainerDataNonNullableFields;
1836
- poll?: PollNonNullableFields;
1837
- layout?: PollDataLayoutNonNullableFields;
1838
- design?: DesignNonNullableFields;
1839
- }
1840
- interface AnchorDataNonNullableFields {
1841
- anchor: string;
1842
- }
1843
- interface LinkDataNonNullableFields {
1844
- link?: LinkNonNullableFields;
1845
- }
1846
- interface MentionDataNonNullableFields {
1847
- name: string;
1848
- slug: string;
1849
- }
1850
- interface FontSizeDataNonNullableFields {
1851
- unit: FontType;
1852
- }
1853
- interface DecorationNonNullableFields {
1854
- anchorData?: AnchorDataNonNullableFields;
1855
- linkData?: LinkDataNonNullableFields;
1856
- mentionData?: MentionDataNonNullableFields;
1857
- fontSizeData?: FontSizeDataNonNullableFields;
1858
- type: DecorationType;
1859
- }
1860
- interface TextDataNonNullableFields {
1861
- text: string;
1862
- decorations: DecorationNonNullableFields[];
1863
- }
1864
- interface AppEmbedDataNonNullableFields {
1865
- type: AppType;
1866
- }
1867
- interface VideoDataNonNullableFields {
1868
- containerData?: PluginContainerDataNonNullableFields;
1869
- }
1870
- interface EmbedDataNonNullableFields {
1871
- containerData?: PluginContainerDataNonNullableFields;
1872
- }
1873
- interface CollapsibleListDataNonNullableFields {
1874
- containerData?: PluginContainerDataNonNullableFields;
1875
- initialExpandedItems: InitialExpandedItems;
1876
- direction: Direction;
1877
- }
1878
- interface DimensionsNonNullableFields {
1879
- colsWidthRatio: number[];
1880
- rowsHeight: number[];
1881
- colsMinWidth: number[];
1882
- }
1883
- interface TableDataNonNullableFields {
1884
- containerData?: PluginContainerDataNonNullableFields;
1885
- dimensions?: DimensionsNonNullableFields;
1886
- }
1887
- interface CellStyleNonNullableFields {
1888
- verticalAlignment: VerticalAlignment;
1889
- }
1890
- interface TableCellDataNonNullableFields {
1891
- cellStyle?: CellStyleNonNullableFields;
1892
- }
1893
- interface AudioDataNonNullableFields {
1894
- containerData?: PluginContainerDataNonNullableFields;
1895
- }
1896
- interface OrderedListDataNonNullableFields {
1897
- indentation: number;
1898
- }
1899
- interface BulletedListDataNonNullableFields {
1900
- indentation: number;
1901
- }
1902
- interface BlockquoteDataNonNullableFields {
1903
- indentation: number;
1904
- }
1905
- interface CaptionDataNonNullableFields {
1906
- textStyle?: TextStyleNonNullableFields;
1907
- }
1908
- interface NodeNonNullableFields {
1909
- buttonData?: ButtonDataNonNullableFields;
1910
- codeBlockData?: CodeBlockDataNonNullableFields;
1911
- dividerData?: DividerDataNonNullableFields;
1912
- fileData?: FileDataNonNullableFields;
1913
- galleryData?: GalleryDataNonNullableFields;
1914
- gifData?: GIFDataNonNullableFields;
1915
- headingData?: HeadingDataNonNullableFields;
1916
- htmlData?: HTMLDataNonNullableFields;
1917
- imageData?: ImageDataNonNullableFields;
1918
- linkPreviewData?: LinkPreviewDataNonNullableFields;
1919
- mapData?: MapDataNonNullableFields;
1920
- paragraphData?: ParagraphDataNonNullableFields;
1921
- pollData?: PollDataNonNullableFields;
1922
- textData?: TextDataNonNullableFields;
1923
- appEmbedData?: AppEmbedDataNonNullableFields;
1924
- videoData?: VideoDataNonNullableFields;
1925
- embedData?: EmbedDataNonNullableFields;
1926
- collapsibleListData?: CollapsibleListDataNonNullableFields;
1927
- tableData?: TableDataNonNullableFields;
1928
- tableCellData?: TableCellDataNonNullableFields;
1929
- audioData?: AudioDataNonNullableFields;
1930
- orderedListData?: OrderedListDataNonNullableFields;
1931
- bulletedListData?: BulletedListDataNonNullableFields;
1932
- blockquoteData?: BlockquoteDataNonNullableFields;
1933
- captionData?: CaptionDataNonNullableFields;
1934
- type: NodeType;
1935
- _id: string;
1936
- nodes: NodeNonNullableFields[];
1937
- }
1938
- interface MetadataNonNullableFields {
1939
- version: number;
1940
- }
1941
- interface TextNodeStyleNonNullableFields {
1942
- decorations: DecorationNonNullableFields[];
1943
- }
1944
- interface DocumentStyleNonNullableFields {
1945
- headerOne?: TextNodeStyleNonNullableFields;
1946
- headerTwo?: TextNodeStyleNonNullableFields;
1947
- headerThree?: TextNodeStyleNonNullableFields;
1948
- headerFour?: TextNodeStyleNonNullableFields;
1949
- headerFive?: TextNodeStyleNonNullableFields;
1950
- headerSix?: TextNodeStyleNonNullableFields;
1951
- paragraph?: TextNodeStyleNonNullableFields;
1952
- blockquote?: TextNodeStyleNonNullableFields;
1953
- codeBlock?: TextNodeStyleNonNullableFields;
1954
- }
1955
- interface RichContentNonNullableFields {
1956
- nodes: NodeNonNullableFields[];
1957
- metadata?: MetadataNonNullableFields;
1958
- documentStyle?: DocumentStyleNonNullableFields;
1959
- }
1960
- export interface MemberAboutNonNullableFields {
1961
- content?: RichContentNonNullableFields;
1962
- }
1963
- export interface CreateMemberAboutResponseNonNullableFields {
1964
- memberAbout?: MemberAboutNonNullableFields;
1965
- }
1966
- export interface UpdateMemberAboutResponseNonNullableFields {
1967
- memberAbout?: MemberAboutNonNullableFields;
1968
- }
1969
- export interface GetMemberAboutResponseNonNullableFields {
1970
- memberAbout?: MemberAboutNonNullableFields;
1971
- }
1972
- export interface GetMyMemberAboutResponseNonNullableFields {
1973
- memberAbout?: MemberAboutNonNullableFields;
1974
- }
1975
- export interface QueryMemberAboutsResponseNonNullableFields {
1976
- memberAbouts: MemberAboutNonNullableFields[];
1977
- }
1978
- export interface BaseEventMetadata {
1979
- /**
1980
- * App instance ID.
1981
- * @format GUID
1982
- */
1983
- instanceId?: string | null;
1984
- /**
1985
- * Event type.
1986
- * @maxLength 150
1987
- */
1988
- eventType?: string;
1989
- /** The identification type and identity data. */
1990
- identity?: IdentificationData;
1991
- }
1992
- export interface EventMetadata extends BaseEventMetadata {
1993
- /**
1994
- * Unique event ID.
1995
- * Allows clients to ignore duplicate webhooks.
1996
- */
1997
- _id?: string;
1998
- /**
1999
- * Assumes actions are also always typed to an entity_type
2000
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2001
- */
2002
- entityFqdn?: string;
2003
- /**
2004
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2005
- * This is although the created/updated/deleted notion is duplication of the oneof types
2006
- * Example: created/updated/deleted/started/completed/email_opened
2007
- */
2008
- slug?: string;
2009
- /** ID of the entity associated with the event. */
2010
- entityId?: string;
2011
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2012
- eventTime?: Date | null;
2013
- /**
2014
- * Whether the event was triggered as a result of a privacy regulation application
2015
- * (for example, GDPR).
2016
- */
2017
- triggeredByAnonymizeRequest?: boolean | null;
2018
- /** If present, indicates the action that triggered the event. */
2019
- originatedFrom?: string | null;
2020
- /**
2021
- * A sequence number defining the order of updates to the underlying entity.
2022
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2023
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2024
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2025
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2026
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2027
- */
2028
- entityEventSequence?: string | null;
2029
- }
2030
- export interface MemberAboutCreatedEnvelope {
2031
- entity: MemberAbout;
2032
- metadata: EventMetadata;
2033
- }
2034
- /**
2035
- * Triggered when a member's "About" section content is created.
2036
- * @permissionScope Manage Members
2037
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2038
- * @permissionScope Manage Challenges
2039
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2040
- * @permissionScope Read Members and Contacts - all read permissions
2041
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
2042
- * @permissionScope Read Members
2043
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
2044
- * @permissionScope Manage Members and Contacts - all permissions
2045
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
2046
- * @permissionId MEMBERS.MEMBER_ABOUT_READ
2047
- * @webhook
2048
- * @eventType wix.members.about.v2.member_about_created
2049
- * @serviceIdentifier wix.members.about.v2.MembersAbout
2050
- * @slug created
2051
- * @documentationMaturity preview
2052
- */
2053
- export declare function onMemberAboutCreated(handler: (event: MemberAboutCreatedEnvelope) => void | Promise<void>): void;
2054
- export interface MemberAboutDeletedEnvelope {
2055
- metadata: EventMetadata;
2056
- }
2057
- /**
2058
- * Triggered when a member's "About" section content is deleted.
2059
- * @permissionScope Manage Members
2060
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2061
- * @permissionScope Manage Challenges
2062
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2063
- * @permissionScope Read Members and Contacts - all read permissions
2064
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
2065
- * @permissionScope Read Members
2066
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
2067
- * @permissionScope Manage Members and Contacts - all permissions
2068
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
2069
- * @permissionId MEMBERS.MEMBER_ABOUT_READ
2070
- * @webhook
2071
- * @eventType wix.members.about.v2.member_about_deleted
2072
- * @serviceIdentifier wix.members.about.v2.MembersAbout
2073
- * @slug deleted
2074
- * @documentationMaturity preview
2075
- */
2076
- export declare function onMemberAboutDeleted(handler: (event: MemberAboutDeletedEnvelope) => void | Promise<void>): void;
2077
- export interface MemberAboutUpdatedEnvelope {
2078
- entity: MemberAbout;
2079
- metadata: EventMetadata;
2080
- }
2081
- /**
2082
- * Triggered when a member's "About" section content is updated.
2083
- * @permissionScope Manage Members
2084
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2085
- * @permissionScope Manage Challenges
2086
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2087
- * @permissionScope Read Members and Contacts - all read permissions
2088
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
2089
- * @permissionScope Read Members
2090
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
2091
- * @permissionScope Manage Members and Contacts - all permissions
2092
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
2093
- * @permissionId MEMBERS.MEMBER_ABOUT_READ
2094
- * @webhook
2095
- * @eventType wix.members.about.v2.member_about_updated
2096
- * @serviceIdentifier wix.members.about.v2.MembersAbout
2097
- * @slug updated
2098
- * @documentationMaturity preview
2099
- */
2100
- export declare function onMemberAboutUpdated(handler: (event: MemberAboutUpdatedEnvelope) => void | Promise<void>): void;
2101
- /**
2102
- * Creates the "About" section content for a member.
2103
- * @param memberAbout - The "About" section content to create.
2104
- * @public
2105
- * @documentationMaturity preview
2106
- * @requiredField memberAbout
2107
- * @requiredField memberAbout.content
2108
- * @permissionId MEMBERS.MEMBER_ABOUT_CREATE
2109
- * @permissionScope SCOPE.DC-MEMBERS.MANAGE-ABOUT
2110
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ABOUT
2111
- * @applicableIdentity APP
2112
- * @applicableIdentity MEMBER
2113
- * @returns The created "About" section content.
2114
- * @fqn wix.members.about.v2.MembersAbout.CreateMemberAbout
2115
- */
2116
- export declare function createMemberAbout(memberAbout: MemberAbout): Promise<MemberAbout & MemberAboutNonNullableFields>;
2117
- /**
2118
- * Updates the "About" section content for a member.
2119
- *
2120
- * Each time the "About" section content is updated, `revision` increments by 1. The existing `revision` must be included when updating the "About" section content. This ensures you're working with the latest "About" section and prevents unintended overwrites.
2121
- * @param _id - ID of the "About" section content.
2122
- * @public
2123
- * @documentationMaturity preview
2124
- * @requiredField _id
2125
- * @requiredField memberAbout
2126
- * @requiredField memberAbout.content
2127
- * @requiredField memberAbout.revision
2128
- * @permissionId MEMBERS.MEMBER_ABOUT_UPDATE
2129
- * @permissionScope SCOPE.DC-MEMBERS.MANAGE-ABOUT
2130
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ABOUT
2131
- * @applicableIdentity APP
2132
- * @applicableIdentity MEMBER
2133
- * @returns The updated "About" section content.
2134
- * @fqn wix.members.about.v2.MembersAbout.UpdateMemberAbout
2135
- */
2136
- export declare function updateMemberAbout(_id: string | null, memberAbout: UpdateMemberAbout): Promise<MemberAbout & MemberAboutNonNullableFields>;
2137
- export interface UpdateMemberAbout {
2138
- /**
2139
- * ID of the "About" section content.
2140
- * @format GUID
2141
- * @readonly
2142
- */
2143
- _id?: string | null;
2144
- /** Revision number, which increments by 1 each time the "About" section content is updated. To prevent conflicting changes, the existing revision must be used when updating an "About" section content. */
2145
- revision?: string | null;
2146
- /**
2147
- * Member ID.
2148
- * @format GUID
2149
- */
2150
- memberId?: string | null;
2151
- /** <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.video.divider.giphy.emoji.link" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
2152
- content?: RichContent;
2153
- }
2154
- /**
2155
- * Deletes the "About" section content for a member.
2156
- * @param _id - ID of the "About" section content to delete.
2157
- * @public
2158
- * @documentationMaturity preview
2159
- * @requiredField _id
2160
- * @permissionId MEMBERS.MEMBER_ABOUT_DELETE
2161
- * @permissionScope SCOPE.DC-MEMBERS.MANAGE-ABOUT
2162
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ABOUT
2163
- * @applicableIdentity APP
2164
- * @applicableIdentity MEMBER
2165
- * @fqn wix.members.about.v2.MembersAbout.DeleteMemberAbout
2166
- */
2167
- export declare function deleteMemberAbout(_id: string): Promise<void>;
2168
- /**
2169
- * Retrieves a member's "About" section content.
2170
- * @param _id - ID of the "About" section content to retrieve.
2171
- * @public
2172
- * @documentationMaturity preview
2173
- * @requiredField _id
2174
- * @permissionId MEMBERS.MEMBER_ABOUT_READ
2175
- * @permissionScope Manage Members
2176
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2177
- * @permissionScope Manage Challenges
2178
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2179
- * @permissionScope Read Members and Contacts - all read permissions
2180
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
2181
- * @permissionScope Read Members
2182
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
2183
- * @permissionScope Manage Members and Contacts - all permissions
2184
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
2185
- * @applicableIdentity APP
2186
- * @applicableIdentity VISITOR
2187
- * @returns The retrieved "About" section content.
2188
- * @fqn wix.members.about.v2.MembersAbout.GetMemberAbout
2189
- */
2190
- export declare function getMemberAbout(_id: string): Promise<MemberAbout & MemberAboutNonNullableFields>;
2191
- /**
2192
- * Retrieves the "About" section content of the current member.
2193
- *
2194
- * >**Note:**
2195
- * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
2196
- * @public
2197
- * @documentationMaturity preview
2198
- * @permissionId MEMBERS.MEMBER_ABOUT_READ
2199
- * @permissionScope Manage Members
2200
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2201
- * @permissionScope Manage Challenges
2202
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2203
- * @permissionScope Read Members and Contacts - all read permissions
2204
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
2205
- * @permissionScope Read Members
2206
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
2207
- * @permissionScope Manage Members and Contacts - all permissions
2208
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
2209
- * @applicableIdentity APP
2210
- * @applicableIdentity VISITOR
2211
- * @fqn wix.members.about.v2.MembersAbout.GetMyMemberAbout
2212
- */
2213
- export declare function getMyMemberAbout(): Promise<GetMyMemberAboutResponse & GetMyMemberAboutResponseNonNullableFields>;
2214
- /**
2215
- * Creates a query to retrieve a list of "About" sections.
2216
- *
2217
- * The `queryMemberAbouts()` method builds a query to retrieve a list of "About" sections and returns a [`MemberAboutsQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/members/members-about/member-abouts-query-builder/eq) object.
2218
- *
2219
- * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/members/members-about/member-abouts-query-builder/find) method.
2220
- *
2221
- * You can refine the query by chaining `MemberAboutsQueryBuilder` methods onto the query. `MemberAboutsQueryBuilder` methods enable you to sort, filter, and control the results `queryMemberAbouts()` returns.
2222
- *
2223
- * `queryMemberAbouts()` runs with these `MemberAboutsQueryBuilder` defaults, which you can override:
2224
- *
2225
- * - [`limit(50)`](https://dev.wix.com/docs/sdk/backend-modules/members/members-about/member-abouts-query-builder/limit)
2226
- * @public
2227
- * @documentationMaturity preview
2228
- * @permissionScope Manage Members
2229
- * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-MEMBERS
2230
- * @permissionScope Manage Challenges
2231
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2232
- * @permissionScope Read Members and Contacts - all read permissions
2233
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
2234
- * @permissionScope Read Members
2235
- * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
2236
- * @permissionScope Manage Members and Contacts - all permissions
2237
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
2238
- * @permissionId MEMBERS.MEMBER_ABOUT_READ
2239
- * @applicableIdentity APP
2240
- * @applicableIdentity VISITOR
2241
- * @fqn wix.members.about.v2.MembersAbout.QueryMemberAbouts
2242
- */
2243
- export declare function queryMemberAbouts(): MemberAboutsQueryBuilder;
2244
- interface QueryCursorResult {
2245
- cursors: Cursors;
2246
- hasNext: () => boolean;
2247
- hasPrev: () => boolean;
2248
- length: number;
2249
- pageSize: number;
2250
- }
2251
- export interface MemberAboutsQueryResult extends QueryCursorResult {
2252
- items: MemberAbout[];
2253
- query: MemberAboutsQueryBuilder;
2254
- next: () => Promise<MemberAboutsQueryResult>;
2255
- prev: () => Promise<MemberAboutsQueryResult>;
2256
- }
2257
- export interface MemberAboutsQueryBuilder {
2258
- /** @param propertyName - Property whose value is compared with `value`.
2259
- * @param value - Value to compare against.
2260
- * @documentationMaturity preview
2261
- */
2262
- eq: (propertyName: '_id' | 'memberId', value: any) => MemberAboutsQueryBuilder;
2263
- /** @param propertyName - Property whose value is compared with `value`.
2264
- * @param value - Value to compare against.
2265
- * @documentationMaturity preview
2266
- */
2267
- ne: (propertyName: '_id' | 'memberId', value: any) => MemberAboutsQueryBuilder;
2268
- /** @param propertyName - Property whose value is compared with `string`.
2269
- * @param string - String to compare against. Case-insensitive.
2270
- * @documentationMaturity preview
2271
- */
2272
- startsWith: (propertyName: '_id' | 'memberId', value: string) => MemberAboutsQueryBuilder;
2273
- /** @param propertyName - Property whose value is compared with `values`.
2274
- * @param values - List of values to compare against.
2275
- * @documentationMaturity preview
2276
- */
2277
- hasSome: (propertyName: '_id' | 'memberId', value: any[]) => MemberAboutsQueryBuilder;
2278
- /** @documentationMaturity preview */
2279
- in: (propertyName: '_id' | 'memberId', value: any) => MemberAboutsQueryBuilder;
2280
- /** @documentationMaturity preview */
2281
- exists: (propertyName: '_id' | 'memberId', value: boolean) => MemberAboutsQueryBuilder;
2282
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
2283
- * @documentationMaturity preview
2284
- */
2285
- limit: (limit: number) => MemberAboutsQueryBuilder;
2286
- /** @param cursor - A pointer to specific record
2287
- * @documentationMaturity preview
2288
- */
2289
- skipTo: (cursor: string) => MemberAboutsQueryBuilder;
2290
- /** @documentationMaturity preview */
2291
- find: () => Promise<MemberAboutsQueryResult>;
2292
- }
2293
- export {};