@wix/auto_sdk_events_forms 1.0.30 → 1.0.31

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/{internal/cjs/src/events-v1-form-forms.universal.d.ts → events-v1-form-forms.universal-Dmp4nCQH.d.mts} +294 -499
  2. package/build/{cjs/src/events-v1-form-forms.universal.d.ts → events-v1-form-forms.universal-Dmp4nCQH.d.ts} +294 -499
  3. package/build/index.d.mts +84 -0
  4. package/build/index.d.ts +84 -0
  5. package/build/index.js +1512 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1435 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{es/src/events-v1-form-forms.universal.d.ts → events-v1-form-forms.universal-Dmp4nCQH.d.mts} +294 -499
  10. package/build/{es/src/events-v1-form-forms.universal.d.ts → internal/events-v1-form-forms.universal-Dmp4nCQH.d.ts} +294 -499
  11. package/build/internal/index.d.mts +84 -0
  12. package/build/internal/index.d.ts +84 -0
  13. package/build/internal/index.js +1512 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1435 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +652 -0
  18. package/build/internal/meta.d.ts +652 -0
  19. package/build/internal/meta.js +800 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +767 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +652 -0
  24. package/build/meta.d.ts +652 -0
  25. package/build/meta.js +800 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +767 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  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/events-v1-form-forms.context.d.ts +0 -17
  40. package/build/cjs/src/events-v1-form-forms.context.js +0 -67
  41. package/build/cjs/src/events-v1-form-forms.context.js.map +0 -1
  42. package/build/cjs/src/events-v1-form-forms.http.d.ts +0 -22
  43. package/build/cjs/src/events-v1-form-forms.http.js +0 -653
  44. package/build/cjs/src/events-v1-form-forms.http.js.map +0 -1
  45. package/build/cjs/src/events-v1-form-forms.meta.d.ts +0 -35
  46. package/build/cjs/src/events-v1-form-forms.meta.js +0 -161
  47. package/build/cjs/src/events-v1-form-forms.meta.js.map +0 -1
  48. package/build/cjs/src/events-v1-form-forms.public.d.ts +0 -72
  49. package/build/cjs/src/events-v1-form-forms.public.js +0 -202
  50. package/build/cjs/src/events-v1-form-forms.public.js.map +0 -1
  51. package/build/cjs/src/events-v1-form-forms.types.d.ts +0 -3075
  52. package/build/cjs/src/events-v1-form-forms.types.js +0 -488
  53. package/build/cjs/src/events-v1-form-forms.types.js.map +0 -1
  54. package/build/cjs/src/events-v1-form-forms.universal.js +0 -871
  55. package/build/cjs/src/events-v1-form-forms.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/events-v1-form-forms.context.d.ts +0 -17
  67. package/build/es/src/events-v1-form-forms.context.js +0 -17
  68. package/build/es/src/events-v1-form-forms.context.js.map +0 -1
  69. package/build/es/src/events-v1-form-forms.http.d.ts +0 -22
  70. package/build/es/src/events-v1-form-forms.http.js +0 -643
  71. package/build/es/src/events-v1-form-forms.http.js.map +0 -1
  72. package/build/es/src/events-v1-form-forms.meta.d.ts +0 -35
  73. package/build/es/src/events-v1-form-forms.meta.js +0 -128
  74. package/build/es/src/events-v1-form-forms.meta.js.map +0 -1
  75. package/build/es/src/events-v1-form-forms.public.d.ts +0 -72
  76. package/build/es/src/events-v1-form-forms.public.js +0 -145
  77. package/build/es/src/events-v1-form-forms.public.js.map +0 -1
  78. package/build/es/src/events-v1-form-forms.types.d.ts +0 -3075
  79. package/build/es/src/events-v1-form-forms.types.js +0 -485
  80. package/build/es/src/events-v1-form-forms.types.js.map +0 -1
  81. package/build/es/src/events-v1-form-forms.universal.js +0 -837
  82. package/build/es/src/events-v1-form-forms.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/events-v1-form-forms.context.d.ts +0 -17
  93. package/build/internal/cjs/src/events-v1-form-forms.context.js +0 -67
  94. package/build/internal/cjs/src/events-v1-form-forms.context.js.map +0 -1
  95. package/build/internal/cjs/src/events-v1-form-forms.http.d.ts +0 -22
  96. package/build/internal/cjs/src/events-v1-form-forms.http.js +0 -653
  97. package/build/internal/cjs/src/events-v1-form-forms.http.js.map +0 -1
  98. package/build/internal/cjs/src/events-v1-form-forms.meta.d.ts +0 -35
  99. package/build/internal/cjs/src/events-v1-form-forms.meta.js +0 -161
  100. package/build/internal/cjs/src/events-v1-form-forms.meta.js.map +0 -1
  101. package/build/internal/cjs/src/events-v1-form-forms.public.d.ts +0 -72
  102. package/build/internal/cjs/src/events-v1-form-forms.public.js +0 -202
  103. package/build/internal/cjs/src/events-v1-form-forms.public.js.map +0 -1
  104. package/build/internal/cjs/src/events-v1-form-forms.types.d.ts +0 -3075
  105. package/build/internal/cjs/src/events-v1-form-forms.types.js +0 -488
  106. package/build/internal/cjs/src/events-v1-form-forms.types.js.map +0 -1
  107. package/build/internal/cjs/src/events-v1-form-forms.universal.js +0 -871
  108. package/build/internal/cjs/src/events-v1-form-forms.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/events-v1-form-forms.context.d.ts +0 -17
  119. package/build/internal/es/src/events-v1-form-forms.context.js +0 -17
  120. package/build/internal/es/src/events-v1-form-forms.context.js.map +0 -1
  121. package/build/internal/es/src/events-v1-form-forms.http.d.ts +0 -22
  122. package/build/internal/es/src/events-v1-form-forms.http.js +0 -643
  123. package/build/internal/es/src/events-v1-form-forms.http.js.map +0 -1
  124. package/build/internal/es/src/events-v1-form-forms.meta.d.ts +0 -35
  125. package/build/internal/es/src/events-v1-form-forms.meta.js +0 -128
  126. package/build/internal/es/src/events-v1-form-forms.meta.js.map +0 -1
  127. package/build/internal/es/src/events-v1-form-forms.public.d.ts +0 -72
  128. package/build/internal/es/src/events-v1-form-forms.public.js +0 -145
  129. package/build/internal/es/src/events-v1-form-forms.public.js.map +0 -1
  130. package/build/internal/es/src/events-v1-form-forms.types.d.ts +0 -3075
  131. package/build/internal/es/src/events-v1-form-forms.types.js +0 -485
  132. package/build/internal/es/src/events-v1-form-forms.types.js.map +0 -1
  133. package/build/internal/es/src/events-v1-form-forms.universal.js +0 -837
  134. package/build/internal/es/src/events-v1-form-forms.universal.js.map +0 -1
@@ -1,3075 +0,0 @@
1
- /**
2
- * The form defines which elements are displayed to a site visitor during the registration process (RSVP or checkout).
3
- * It also contains customizable messages and labels.
4
- *
5
- *
6
- * A form is an ordered list of controls (blocks), which accept guest information into a field input.
7
- *
8
- * Each control contains one or more nested inputs. For example, `Name` control has two inputs:
9
- * - First Name
10
- * - Last Name
11
- *
12
- * By default, name and email controls are always required and are pinned to the top of the form.
13
- */
14
- export interface Form {
15
- /** Nested fields as an ordered list. */
16
- controls?: InputControl[];
17
- /**
18
- * Set of defined form messages displayed in the UI before, during, and after a registration flow.
19
- * Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
20
- */
21
- messages?: FormMessages;
22
- }
23
- /**
24
- * A block of nested fields.
25
- * Used to aggregate similar inputs like First Name and Last Name.
26
- */
27
- export interface InputControl {
28
- /** Field control type. */
29
- type?: InputControlTypeWithLiterals;
30
- /** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
31
- system?: boolean;
32
- /**
33
- * Deprecated: Use `id` or `_id`.
34
- * @deprecated
35
- */
36
- name?: string;
37
- /** Child inputs. */
38
- inputs?: Input[];
39
- /**
40
- * *Deprecated:** Use `controls.inputs.label`.
41
- * @deprecated
42
- */
43
- label?: string;
44
- /** Field controls are sorted by this value in ascending order. */
45
- orderIndex?: number;
46
- /** Unique control ID. */
47
- id?: string;
48
- /**
49
- * Whether the input control is deleted.
50
- * @readonly
51
- */
52
- deleted?: boolean | null;
53
- }
54
- export declare enum InputControlType {
55
- /** Single text value field. */
56
- INPUT = "INPUT",
57
- /** Single text value field with multiple lines. */
58
- TEXTAREA = "TEXTAREA",
59
- /** Single-choice field with predefined values. */
60
- DROPDOWN = "DROPDOWN",
61
- /** Single-choice field with predefined values. */
62
- RADIO = "RADIO",
63
- /** Multiple-choice field with predefined values. */
64
- CHECKBOX = "CHECKBOX",
65
- /** Fields for entering first and last names. */
66
- NAME = "NAME",
67
- /** Fields for additional guests and their respective names. */
68
- GUEST_CONTROL = "GUEST_CONTROL",
69
- /** Single-line address field. */
70
- ADDRESS_SHORT = "ADDRESS_SHORT",
71
- /** Full address field with multiple lines. */
72
- ADDRESS_FULL = "ADDRESS_FULL",
73
- /** Fields for entering year, month, and day. */
74
- DATE = "DATE"
75
- }
76
- /** @enumType */
77
- export type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
78
- /** Child inputs. */
79
- export interface Input {
80
- /** Field name. */
81
- name?: string;
82
- /**
83
- * *Deprecated:** Use `controls.inputs.type.TEXT_ARRAY`.
84
- * @deprecated
85
- */
86
- array?: boolean;
87
- /** Main field label. */
88
- label?: string;
89
- /** Additional labels for multi-valued fields such as address. */
90
- additionalLabels?: Record<string, string>;
91
- /** Predefined choice options for fields, such as dropdown. */
92
- options?: string[];
93
- /** Whether field is mandatory. */
94
- mandatory?: boolean;
95
- /** Maximum number of accepted characters (relevant for text fields). */
96
- maxLength?: number;
97
- /**
98
- * Type which determines field format.
99
- * Used to validate submitted response.
100
- */
101
- type?: ValueTypeWithLiterals;
102
- /**
103
- * The maximum number of accepted values for array input.
104
- *
105
- * **Note:** Only applicable for `TEXT_ARRAY` input fields.
106
- */
107
- maxSize?: number | null;
108
- /**
109
- * Default option initially selected when an input has multiple choices.
110
- *
111
- * Defaults to first (0th) option, if not configured.
112
- * Currently only applicable for `type.dropdown`.
113
- */
114
- defaultOptionSelection?: OptionSelection;
115
- /**
116
- * Additional labels for multi-valued fields, such as address.
117
- * @readonly
118
- */
119
- labels?: Label[];
120
- }
121
- export declare enum ValueType {
122
- TEXT = "TEXT",
123
- NUMBER = "NUMBER",
124
- TEXT_ARRAY = "TEXT_ARRAY",
125
- DATE_TIME = "DATE_TIME",
126
- ADDRESS = "ADDRESS"
127
- }
128
- /** @enumType */
129
- export type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
130
- /**
131
- * Describes initially selected option when an input has multiple choices.
132
- * Defaults to first (0th) option if not configured.
133
- */
134
- export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
135
- /**
136
- * 0-based index from predefined `controls.inputs.options` which is initial selection.
137
- * @max 199
138
- */
139
- optionIndex?: number;
140
- /**
141
- * Placeholder hint describing expected choices, such as "Please select".
142
- * Considered an empty choice.
143
- * @maxLength 200
144
- */
145
- placeholderText?: string;
146
- }
147
- /** @oneof */
148
- export interface OptionSelectionSelectedOptionOneOf {
149
- /**
150
- * 0-based index from predefined `controls.inputs.options` which is initial selection.
151
- * @max 199
152
- */
153
- optionIndex?: number;
154
- /**
155
- * Placeholder hint describing expected choices, such as "Please select".
156
- * Considered an empty choice.
157
- * @maxLength 200
158
- */
159
- placeholderText?: string;
160
- }
161
- export interface Label {
162
- /** Field name. */
163
- name?: string;
164
- /** Field label. */
165
- label?: string;
166
- }
167
- /**
168
- * Defines form messages shown in UI before, during, and after registration flow.
169
- * It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
170
- */
171
- export interface FormMessages {
172
- /** RSVP form ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/rsvp-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/introduction)) messages. */
173
- rsvp?: RsvpFormMessages;
174
- /** Checkout form messages. */
175
- checkout?: CheckoutFormMessages;
176
- /** Messages shown when event registration is closed. */
177
- registrationClosed?: RegistrationClosedMessages;
178
- /** Messages shown when event tickets are unavailable. */
179
- ticketsUnavailable?: TicketsUnavailableMessages;
180
- }
181
- export interface RsvpFormMessages {
182
- /** Label text indicating RSVP's `status` is `"YES"`. */
183
- rsvpYesOption?: string;
184
- /** Label text indicating RSVP's `status` is `"NO"`. */
185
- rsvpNoOption?: string;
186
- /** Messages displayed when an RSVP's `status` is set to `"YES"`. */
187
- positiveMessages?: Positive;
188
- /** Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). */
189
- waitlistMessages?: Positive;
190
- /** Messages displayed when an RSVP's `status` is set to `"NO"`. */
191
- negativeMessages?: Negative;
192
- /** "Submit form" call-to-action label text. */
193
- submitActionLabel?: string;
194
- }
195
- /** Confirmation messages shown after registration. */
196
- export interface PositiveResponseConfirmation {
197
- /** Confirmation message title. */
198
- title?: string;
199
- /** Confirmation message text. */
200
- message?: string;
201
- /** "Add to calendar" call-to-action label text. */
202
- addToCalendarActionLabel?: string;
203
- /** "Share event" call-to-action label text. */
204
- shareActionLabel?: string;
205
- }
206
- /** Confirmation messages shown after registration. */
207
- export interface NegativeResponseConfirmation {
208
- /** Confirmation message title. */
209
- title?: string;
210
- /** "Share event" call-to-action label text. */
211
- shareActionLabel?: string;
212
- }
213
- /** Set of messages shown during registration when RSVP response is positive. */
214
- export interface Positive {
215
- /** Main form title for positive response. */
216
- title?: string;
217
- /** Confirmation messages shown after registration. */
218
- confirmation?: PositiveResponseConfirmation;
219
- }
220
- /** A set of messages shown during registration with negative response */
221
- export interface Negative {
222
- /** Main form title for negative response. */
223
- title?: string;
224
- /** Confirmation messages shown after registration. */
225
- confirmation?: NegativeResponseConfirmation;
226
- }
227
- export interface CheckoutFormMessages {
228
- /** Main form title for response. */
229
- title?: string;
230
- /** Submit form call-to-action label text. */
231
- submitActionLabel?: string;
232
- /** Confirmation messages shown after checkout. */
233
- confirmation?: ResponseConfirmation;
234
- }
235
- /** Confirmation messages shown after checkout. */
236
- export interface ResponseConfirmation {
237
- /** Confirmation message title. */
238
- title?: string;
239
- /** Confirmation message text. */
240
- message?: string;
241
- /** "Download tickets" call-to-action label text. */
242
- downloadTicketsLabel?: string;
243
- /** "Add to calendar" call-to-action label text. */
244
- addToCalendarLabel?: string;
245
- /** "Share event" call-to-action label text. */
246
- shareEventLabel?: string;
247
- }
248
- export interface RegistrationClosedMessages {
249
- /** Message shown when event registration is closed. */
250
- message?: string;
251
- /** "Explore other events" call-to-action label text. */
252
- exploreEventsActionLabel?: string;
253
- }
254
- export interface TicketsUnavailableMessages {
255
- /** Message shown when event tickets are unavailable. */
256
- message?: string;
257
- /** "Explore other events" call-to-action label text. */
258
- exploreEventsActionLabel?: string;
259
- }
260
- export interface FormInputControlAdded {
261
- /** Event ID. */
262
- eventId?: string;
263
- /** Input control. */
264
- inputControl?: InputControl;
265
- }
266
- export interface FormInputControlUpdated {
267
- /** Event ID. */
268
- eventId?: string;
269
- /** Input control. */
270
- updatedInputControl?: InputControl;
271
- }
272
- export interface FormInputControlDeleted {
273
- /** Event ID. */
274
- eventId?: string;
275
- /** Input control. */
276
- deletedInputControl?: InputControl;
277
- }
278
- export interface GetFormRequest {
279
- /**
280
- * Event ID to which the form belongs.
281
- * @format GUID
282
- */
283
- eventId: string;
284
- }
285
- export declare enum RequestedFields {
286
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
287
- /** Include soft deleted input controls in the response. */
288
- DELETED = "DELETED"
289
- }
290
- /** @enumType */
291
- export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DELETED';
292
- export interface GetFormResponse {
293
- /**
294
- * Currently published event form.
295
- * Published form is visible to site visitors.
296
- */
297
- form?: Form;
298
- /**
299
- * Draft event form.
300
- * Not available to visitors unless published.
301
- */
302
- draftForm?: Form;
303
- }
304
- export interface AddControlRequest extends AddControlRequestControlOneOf {
305
- /** Phone number input control. */
306
- phone?: PhoneControl;
307
- /** Single-line or full address input control. */
308
- address?: AddressControl;
309
- /** Day, month, year date input control. */
310
- date?: DateControl;
311
- /** Additional guests input control. */
312
- additionalGuests?: AdditionalGuestsControl;
313
- /** Single-choice dropdown style input control. */
314
- dropdown?: DropdownControl;
315
- /** Multiple-choice checkbox style input control. */
316
- checkbox?: CheckboxControl;
317
- /** Free-form text input control. */
318
- text?: TextControl;
319
- /** Single-choice radio button style input control. */
320
- radioButton?: RadioButtonControl;
321
- /**
322
- * Event ID to which the form belongs.
323
- * @format GUID
324
- */
325
- eventId: string;
326
- }
327
- /** @oneof */
328
- export interface AddControlRequestControlOneOf {
329
- /** Phone number input control. */
330
- phone?: PhoneControl;
331
- /** Single-line or full address input control. */
332
- address?: AddressControl;
333
- /** Day, month, year date input control. */
334
- date?: DateControl;
335
- /** Additional guests input control. */
336
- additionalGuests?: AdditionalGuestsControl;
337
- /** Single-choice dropdown style input control. */
338
- dropdown?: DropdownControl;
339
- /** Multiple-choice checkbox style input control. */
340
- checkbox?: CheckboxControl;
341
- /** Free-form text input control. */
342
- text?: TextControl;
343
- /** Single-choice radio button style input control. */
344
- radioButton?: RadioButtonControl;
345
- }
346
- export interface PhoneControl {
347
- /**
348
- * Phone input label.
349
- * @maxLength 100
350
- */
351
- label?: string;
352
- /** Whether the phone input is required. */
353
- mandatory?: boolean;
354
- }
355
- export interface AddressControl {
356
- /** Address control labels for each input. */
357
- labels?: AddressControlLabels;
358
- /** Whether an address is multi-line (consisting of multiple fields such as country, city, postal code). When `false`, address is single-line. */
359
- full?: boolean;
360
- /** Whether the address input is required. */
361
- mandatory?: boolean;
362
- }
363
- export interface AddressControlLabels {
364
- /**
365
- * Single-line address input label.
366
- * @maxLength 100
367
- */
368
- addressLine?: string;
369
- /**
370
- * Country input label.
371
- * @maxLength 100
372
- */
373
- country?: string;
374
- /**
375
- * Subdivision input label.
376
- * @maxLength 100
377
- */
378
- subdivision?: string;
379
- /**
380
- * City input label.
381
- * @maxLength 100
382
- */
383
- city?: string;
384
- /**
385
- * Postal code input label.
386
- * @maxLength 100
387
- */
388
- postalCode?: string;
389
- /**
390
- * Street address input label.
391
- * @maxLength 100
392
- */
393
- streetAddress?: string;
394
- }
395
- export interface DateControl {
396
- /**
397
- * Input control label.
398
- * @maxLength 100
399
- */
400
- label?: string;
401
- /** Whether the date input is required. */
402
- mandatory?: boolean;
403
- }
404
- export interface AdditionalGuestsControl {
405
- /** Additional guests control labels for each input. */
406
- labels?: Labels;
407
- /** Whether the individual guest names are required. */
408
- namesMandatory?: boolean;
409
- /**
410
- * Maximum number of additional guests.
411
- * @min 1
412
- * @max 10
413
- */
414
- maxGuests?: number;
415
- }
416
- export interface Labels {
417
- /**
418
- * Input label for a single guest.
419
- * @maxLength 200
420
- */
421
- single?: string;
422
- /**
423
- * Input label for multiple guests.
424
- * @maxLength 200
425
- */
426
- multiple?: string;
427
- }
428
- export interface DropdownControl {
429
- /**
430
- * Input control label.
431
- * @maxLength 200
432
- */
433
- label?: string;
434
- /**
435
- * Predefined options guests can choose from.
436
- * @minSize 2
437
- * @maxSize 200
438
- * @maxLength 200
439
- */
440
- options?: string[];
441
- /** Whether a choice is required. */
442
- mandatory?: boolean;
443
- /**
444
- * Default option initially selected when an input has multiple choices.
445
- *
446
- * Defaults to first (0th) option, if not configured.
447
- */
448
- defaultOptionSelection?: OptionSelection;
449
- }
450
- export interface RadioButtonControl {
451
- /**
452
- * Input control label.
453
- * @maxLength 200
454
- */
455
- label?: string;
456
- /**
457
- * Predefined options guests can choose from.
458
- * @minSize 2
459
- * @maxSize 200
460
- * @maxLength 200
461
- */
462
- options?: string[];
463
- }
464
- export interface CheckboxControl {
465
- /**
466
- * Input control label.
467
- * @maxLength 200
468
- */
469
- label?: string;
470
- /** Whether at least one checkbox is required. */
471
- mandatory?: boolean;
472
- /**
473
- * Predefined options guests can choose from.
474
- * @minSize 1
475
- * @maxSize 200
476
- * @maxLength 200
477
- */
478
- options?: string[];
479
- }
480
- export interface TextControl {
481
- /**
482
- * Input control label.
483
- * @maxLength 200
484
- */
485
- label?: string;
486
- /** Whether a text input is required. */
487
- mandatory?: boolean;
488
- /**
489
- * Maximum number of characters allowed.
490
- * @max 1000
491
- */
492
- maxLength?: number;
493
- /** Whether the input control should allow multiple lines in text. */
494
- multiLine?: boolean;
495
- /** Whether the input control should be displayed as a comment. */
496
- comment?: boolean;
497
- }
498
- export interface AddControlResponse {
499
- /** Generated unique input control ID. */
500
- id?: string;
501
- /** Modified draft event form. */
502
- form?: Form;
503
- }
504
- export interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
505
- /** Phone number input control. */
506
- phone?: PhoneControl;
507
- /** Single-line or full address input control. */
508
- address?: AddressControl;
509
- /** Day, month, year date input control. */
510
- date?: DateControl;
511
- /** Additional guests input control. */
512
- additionalGuests?: AdditionalGuestsControl;
513
- /** Single-choice dropdown style input control. */
514
- dropdown?: DropdownControl;
515
- /** Multiple-choice checkbox style input control. */
516
- checkbox?: CheckboxControl;
517
- /** Free-form text input control. */
518
- text?: TextControl;
519
- /** Main guest name input control. */
520
- name?: NameControl;
521
- /** Main guest email input control. */
522
- email?: EmailControl;
523
- /** Single-choice radio style input control. */
524
- radioButton?: RadioButtonControl;
525
- /**
526
- * Event ID to which the form belongs.
527
- * @format GUID
528
- */
529
- eventId: string;
530
- /** Unique input control ID. */
531
- id: string;
532
- /** Index used to sort input controls in ascending order. */
533
- orderIndex?: number;
534
- }
535
- /** @oneof */
536
- export interface UpdateControlRequestControlOneOf {
537
- /** Phone number input control. */
538
- phone?: PhoneControl;
539
- /** Single-line or full address input control. */
540
- address?: AddressControl;
541
- /** Day, month, year date input control. */
542
- date?: DateControl;
543
- /** Additional guests input control. */
544
- additionalGuests?: AdditionalGuestsControl;
545
- /** Single-choice dropdown style input control. */
546
- dropdown?: DropdownControl;
547
- /** Multiple-choice checkbox style input control. */
548
- checkbox?: CheckboxControl;
549
- /** Free-form text input control. */
550
- text?: TextControl;
551
- /** Main guest name input control. */
552
- name?: NameControl;
553
- /** Main guest email input control. */
554
- email?: EmailControl;
555
- /** Single-choice radio style input control. */
556
- radioButton?: RadioButtonControl;
557
- }
558
- export interface NameControl {
559
- /** Name control labels of each input. */
560
- labels?: NameControlLabels;
561
- }
562
- export interface NameControlLabels {
563
- /**
564
- * First name input label.
565
- * @maxLength 100
566
- */
567
- firstName?: string;
568
- /**
569
- * Last name input label .
570
- * @maxLength 100
571
- */
572
- lastName?: string;
573
- }
574
- export interface EmailControl {
575
- /**
576
- * Email input label.
577
- * @maxLength 100
578
- */
579
- label?: string;
580
- }
581
- export interface UpdateControlResponse {
582
- /** Modified draft event form. */
583
- form?: Form;
584
- }
585
- export interface DeleteControlRequest {
586
- /**
587
- * Event ID to which the form belongs.
588
- * @format GUID
589
- */
590
- eventId: string;
591
- /**
592
- * Unique input control ID.
593
- * @maxLength 100
594
- */
595
- id: string;
596
- }
597
- export interface DeleteControlResponse {
598
- /** Modified draft event form */
599
- form?: Form;
600
- }
601
- export interface UpdateMessagesRequest {
602
- /**
603
- * Event ID to which the form belongs.
604
- * @format GUID
605
- */
606
- eventId: string;
607
- /**
608
- * Set of field paths, specifying which parts of this resource to update.
609
- * When fields are empty, request is interpreted as full update.
610
- * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
611
- */
612
- fields?: string[];
613
- /** Set of configured form messages to update. */
614
- messages?: FormMessages;
615
- }
616
- export interface UpdateMessagesResponse {
617
- /** Modified draft event form. */
618
- form?: Form;
619
- }
620
- export interface PublishDraftRequest {
621
- /**
622
- * Event ID to which the form belongs.
623
- * @format GUID
624
- */
625
- eventId: string;
626
- }
627
- export interface PublishDraftResponse {
628
- /** Published event form. */
629
- form?: Form;
630
- }
631
- export interface EventUpdated {
632
- /** Event update timestamp in ISO UTC format. */
633
- timestamp?: Date | null;
634
- /**
635
- * Event ID.
636
- * @format GUID
637
- */
638
- eventId?: string;
639
- /** Event location. */
640
- location?: Location;
641
- /** Event schedule configuration. */
642
- scheduleConfig?: ScheduleConfig;
643
- /** Event title. */
644
- title?: string;
645
- /**
646
- * Whether schedule configuration was updated.
647
- * @deprecated
648
- */
649
- scheduleConfigUpdated?: boolean;
650
- /** Updated event */
651
- event?: Event;
652
- }
653
- export interface Location {
654
- /**
655
- * Location name.
656
- * @maxLength 50
657
- */
658
- name?: string | null;
659
- /** Location map coordinates. */
660
- coordinates?: MapCoordinates;
661
- /**
662
- * Single line address representation.
663
- * @maxLength 300
664
- */
665
- address?: string | null;
666
- /** Location type. */
667
- type?: LocationTypeWithLiterals;
668
- /**
669
- * Full address derived from formatted single line `address`.
670
- * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
671
- * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
672
- *
673
- * Migration notes:
674
- * - `full_address.formatted_address` is equivalent to `address`.
675
- * - `full_address.geocode` is equivalent to `coordinates`.
676
- */
677
- fullAddress?: Address;
678
- /**
679
- * Defines event location as TBD (To Be Determined).
680
- * When event location is not yet defined, `name` is displayed instead of location address.
681
- * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
682
- */
683
- tbd?: boolean | null;
684
- }
685
- export interface MapCoordinates {
686
- /**
687
- * Latitude.
688
- * @min -90
689
- * @max 90
690
- */
691
- lat?: number;
692
- /**
693
- * Longitude.
694
- * @min -180
695
- * @max 180
696
- */
697
- lng?: number;
698
- }
699
- export declare enum LocationType {
700
- VENUE = "VENUE",
701
- ONLINE = "ONLINE"
702
- }
703
- /** @enumType */
704
- export type LocationTypeWithLiterals = LocationType | 'VENUE' | 'ONLINE';
705
- /** Physical address */
706
- export interface Address extends AddressStreetOneOf {
707
- /** a break down of the street to number and street name */
708
- streetAddress?: StreetAddress;
709
- /** Main address line (usually street and number) as free text */
710
- addressLine?: string | null;
711
- /**
712
- * country code
713
- * @format COUNTRY
714
- */
715
- country?: string | null;
716
- /** subdivision (usually state or region) code according to ISO 3166-2 */
717
- subdivision?: string | null;
718
- /** city name */
719
- city?: string | null;
720
- /** zip/postal code */
721
- postalCode?: string | null;
722
- /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
723
- addressLine2?: string | null;
724
- /** A string containing the human-readable address of this location */
725
- formattedAddress?: string | null;
726
- /** Free text for human-to-human textual orientation aid purposes */
727
- hint?: string | null;
728
- /** coordinates of the physical address */
729
- geocode?: AddressLocation;
730
- /** country full-name */
731
- countryFullname?: string | null;
732
- /**
733
- * multi-level subdivisions from top to bottom
734
- * @maxSize 6
735
- */
736
- subdivisions?: Subdivision[];
737
- }
738
- /** @oneof */
739
- export interface AddressStreetOneOf {
740
- /** a break down of the street to number and street name */
741
- streetAddress?: StreetAddress;
742
- /** Main address line (usually street and number) as free text */
743
- addressLine?: string | null;
744
- }
745
- export interface StreetAddress {
746
- /** street number */
747
- number?: string;
748
- /** street name */
749
- name?: string;
750
- }
751
- export interface AddressLocation {
752
- /**
753
- * address latitude coordinates
754
- * @min -90
755
- * @max 90
756
- */
757
- latitude?: number | null;
758
- /**
759
- * address longitude coordinates
760
- * @min -180
761
- * @max 180
762
- */
763
- longitude?: number | null;
764
- }
765
- export interface Subdivision {
766
- /** subdivision short code */
767
- code?: string;
768
- /** subdivision full-name */
769
- name?: string;
770
- }
771
- export declare enum SubdivisionType {
772
- UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
773
- /** State */
774
- ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
775
- /** County */
776
- ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
777
- /** City/town */
778
- ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
779
- /** Neighborhood/quarter */
780
- ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
781
- /** Street/block */
782
- ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
783
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
784
- COUNTRY = "COUNTRY"
785
- }
786
- /** @enumType */
787
- export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
788
- export interface ScheduleConfig {
789
- /**
790
- * Defines event as TBD (To Be Determined) schedule.
791
- * When event time is not yet defined, TBD message is displayed instead of event start and end times.
792
- * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
793
- */
794
- scheduleTbd?: boolean;
795
- /**
796
- * TBD message.
797
- * @maxLength 100
798
- */
799
- scheduleTbdMessage?: string | null;
800
- /** Event start timestamp. */
801
- startDate?: Date | null;
802
- /** Event end timestamp. */
803
- endDate?: Date | null;
804
- /**
805
- * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
806
- * @maxLength 100
807
- */
808
- timeZoneId?: string | null;
809
- /** Whether end date is hidden in the formatted schedule. */
810
- endDateHidden?: boolean;
811
- /** Whether time zone is displayed in formatted schedule. */
812
- showTimeZone?: boolean;
813
- /** Event recurrences. */
814
- recurrences?: Recurrences;
815
- }
816
- export interface Recurrences {
817
- /**
818
- * Event occurrences.
819
- * @maxSize 1000
820
- */
821
- occurrences?: Occurrence[];
822
- /**
823
- * Recurring event category ID.
824
- * @readonly
825
- */
826
- categoryId?: string | null;
827
- /**
828
- * Recurrence status.
829
- * @readonly
830
- */
831
- status?: StatusWithLiterals;
832
- }
833
- export interface Occurrence {
834
- /** Event start timestamp. */
835
- startDate?: Date | null;
836
- /** Event end timestamp. */
837
- endDate?: Date | null;
838
- /**
839
- * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
840
- * @maxLength 100
841
- */
842
- timeZoneId?: string | null;
843
- /** Whether time zone is displayed in formatted schedule. */
844
- showTimeZone?: boolean;
845
- }
846
- export declare enum Status {
847
- /** Event occurs only once. */
848
- ONE_TIME = "ONE_TIME",
849
- /** Event is recurring. */
850
- RECURRING = "RECURRING",
851
- /** Marks the next upcoming occurrence of the recurring event. */
852
- RECURRING_NEXT = "RECURRING_NEXT",
853
- /** Marks the most recent ended occurrence of the recurring event. */
854
- RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
855
- /** Marks the most recent canceled occurrence of the recurring event. */
856
- RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
857
- }
858
- /** @enumType */
859
- export type StatusWithLiterals = Status | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
860
- export interface Event {
861
- /**
862
- * Event ID.
863
- * @format GUID
864
- * @readonly
865
- */
866
- id?: string;
867
- /** Event location. */
868
- location?: Location;
869
- /** Event scheduling. */
870
- scheduling?: Scheduling;
871
- /** Event title. */
872
- title?: string;
873
- /** Event description. */
874
- description?: string;
875
- /** Rich-text content that are displayed in a site's "About Event" section (HTML). */
876
- about?: string;
877
- /** Main event image. */
878
- mainImage?: Image;
879
- /** Event slug URL (generated from event title). */
880
- slug?: string;
881
- /** ISO 639-1 language code of the event (used in content translations). */
882
- language?: string;
883
- /** Event creation timestamp. */
884
- created?: Date | null;
885
- /** Event modified timestamp. */
886
- modified?: Date | null;
887
- /** Event status. */
888
- status?: EventStatusWithLiterals;
889
- /** RSVP or ticketing registration details. */
890
- registration?: Registration;
891
- /** "Add to calendar" URLs. */
892
- calendarLinks?: CalendarLinks;
893
- /** Event page URL components. */
894
- eventPageUrl?: SiteUrl;
895
- /** Event registration form. */
896
- form?: Form;
897
- /** Event dashboard summary of RSVP / ticket sales. */
898
- dashboard?: Dashboard;
899
- /** Instance ID of the site where event is hosted. */
900
- instanceId?: string;
901
- /** Guest list configuration. */
902
- guestListConfig?: GuestListConfig;
903
- /**
904
- * Event creator user ID.
905
- * @maxLength 36
906
- */
907
- userId?: string;
908
- /** Event discussion feed. For internal use. */
909
- feed?: Feed;
910
- /** Online conferencing details. */
911
- onlineConferencing?: OnlineConferencing;
912
- /** SEO settings. */
913
- seoSettings?: SeoSettings;
914
- /** Assigned contacts label key. */
915
- assignedContactsLabel?: string | null;
916
- /** Agenda details. */
917
- agenda?: Agenda;
918
- /** Categories this event is assigned to. */
919
- categories?: Category[];
920
- /** Visual settings for event. */
921
- eventDisplaySettings?: EventDisplaySettings;
922
- /** Rich content that are displayed in a site's "About Event" section. Successor to `about` field. */
923
- longDescription?: RichContent;
924
- /**
925
- * Event publish timestamp.
926
- * @readonly
927
- */
928
- publishedDate?: Date | null;
929
- }
930
- export interface Scheduling {
931
- /** Schedule configuration. */
932
- config?: ScheduleConfig;
933
- /** Formatted schedule representation. */
934
- formatted?: string;
935
- /** Formatted start date of the event (empty for TBD schedules). */
936
- startDateFormatted?: string;
937
- /** Formatted start time of the event (empty for TBD schedules). */
938
- startTimeFormatted?: string;
939
- /** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
940
- endDateFormatted?: string;
941
- /** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
942
- endTimeFormatted?: string;
943
- }
944
- export interface Image {
945
- /**
946
- * WixMedia image ID.
947
- * @minLength 1
948
- * @maxLength 200
949
- */
950
- id?: string | null;
951
- /** Image URL. */
952
- url?: string;
953
- /** Original image height. */
954
- height?: number | null;
955
- /** Original image width. */
956
- width?: number | null;
957
- /** Image alt text. Optional. */
958
- altText?: string | null;
959
- }
960
- export declare enum EventStatus {
961
- /** Event is public and scheduled to start */
962
- SCHEDULED = "SCHEDULED",
963
- /** Event has started */
964
- STARTED = "STARTED",
965
- /** Event has ended */
966
- ENDED = "ENDED",
967
- /** Event was canceled */
968
- CANCELED = "CANCELED"
969
- }
970
- /** @enumType */
971
- export type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
972
- export interface Registration {
973
- /** Event type. */
974
- type?: EventTypeWithLiterals;
975
- /** Event registration status. */
976
- status?: RegistrationStatusWithLiterals;
977
- /** RSVP collection details. */
978
- rsvpCollection?: RsvpCollection;
979
- /** Ticketing details. */
980
- ticketing?: Ticketing;
981
- /** External registration details. */
982
- external?: ExternalEvent;
983
- /** Types of users allowed to register. */
984
- restrictedTo?: VisitorTypeWithLiterals;
985
- /** Initial event type which was set when creating an event. */
986
- initialType?: EventTypeWithLiterals;
987
- }
988
- export declare enum EventType {
989
- /** Type not available for this request fieldset */
990
- NA_EVENT_TYPE = "NA_EVENT_TYPE",
991
- /** Registration via RSVP */
992
- RSVP = "RSVP",
993
- /** Registration via ticket purchase */
994
- TICKETS = "TICKETS",
995
- /** External registration */
996
- EXTERNAL = "EXTERNAL",
997
- /** Registration not available */
998
- NO_REGISTRATION = "NO_REGISTRATION"
999
- }
1000
- /** @enumType */
1001
- export type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
1002
- export declare enum RegistrationStatus {
1003
- /** Registration status is not applicable */
1004
- NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
1005
- /** Registration to event is closed */
1006
- CLOSED = "CLOSED",
1007
- /** Registration to event is closed manually */
1008
- CLOSED_MANUALLY = "CLOSED_MANUALLY",
1009
- /** Registration is open via RSVP */
1010
- OPEN_RSVP = "OPEN_RSVP",
1011
- /** Registration to event waitlist is open via RSVP */
1012
- OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
1013
- /** Registration is open via ticket purchase */
1014
- OPEN_TICKETS = "OPEN_TICKETS",
1015
- /** Registration is open via external URL */
1016
- OPEN_EXTERNAL = "OPEN_EXTERNAL",
1017
- /** Registration will be open via RSVP */
1018
- SCHEDULED_RSVP = "SCHEDULED_RSVP"
1019
- }
1020
- /** @enumType */
1021
- export type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
1022
- export interface RsvpCollection {
1023
- /** RSVP collection configuration. */
1024
- config?: RsvpCollectionConfig;
1025
- }
1026
- export interface RsvpCollectionConfig {
1027
- /** Defines the supported RSVP statuses. */
1028
- rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
1029
- /**
1030
- * Total guest limit available to register to the event.
1031
- * Additional guests per RSVP are counted towards total guests.
1032
- */
1033
- limit?: number | null;
1034
- /** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
1035
- waitlist?: boolean;
1036
- /** Registration start timestamp. */
1037
- startDate?: Date | null;
1038
- /** Registration end timestamp. */
1039
- endDate?: Date | null;
1040
- }
1041
- export declare enum RsvpStatusOptions {
1042
- /** Only YES RSVP status is available for RSVP registration */
1043
- YES_ONLY = "YES_ONLY",
1044
- /** YES and NO RSVP status options are available for the registration */
1045
- YES_AND_NO = "YES_AND_NO"
1046
- }
1047
- /** @enumType */
1048
- export type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
1049
- export interface Ticketing {
1050
- /**
1051
- * Deprecated.
1052
- * @deprecated
1053
- */
1054
- lowestPrice?: string | null;
1055
- /**
1056
- * Deprecated.
1057
- * @deprecated
1058
- */
1059
- highestPrice?: string | null;
1060
- /** Currency used in event transactions. */
1061
- currency?: string | null;
1062
- /** Ticketing configuration. */
1063
- config?: TicketingConfig;
1064
- /**
1065
- * Price of lowest priced ticket.
1066
- * @readonly
1067
- */
1068
- lowestTicketPrice?: Money;
1069
- /**
1070
- * Price of highest priced ticket.
1071
- * @readonly
1072
- */
1073
- highestTicketPrice?: Money;
1074
- /**
1075
- * Formatted price of lowest priced ticket.
1076
- * @readonly
1077
- */
1078
- lowestTicketPriceFormatted?: string | null;
1079
- /**
1080
- * Formatted price of highest priced ticket.
1081
- * @readonly
1082
- */
1083
- highestTicketPriceFormatted?: string | null;
1084
- /**
1085
- * Whether all tickets are sold for this event.
1086
- * @readonly
1087
- */
1088
- soldOut?: boolean | null;
1089
- }
1090
- export interface TicketingConfig {
1091
- /** Whether the form must be filled out separately for each ticket. */
1092
- guestAssignedTickets?: boolean;
1093
- /** Tax configuration. */
1094
- taxConfig?: TaxConfig;
1095
- /**
1096
- * Limit of tickets that can be purchased per order, default 20.
1097
- * @max 50
1098
- */
1099
- ticketLimitPerOrder?: number;
1100
- /**
1101
- * Duration for which the tickets being bought are reserved.
1102
- * @min 5
1103
- * @max 30
1104
- */
1105
- reservationDurationInMinutes?: number | null;
1106
- }
1107
- export interface TaxConfig {
1108
- /** Tax application settings. */
1109
- type?: TaxTypeWithLiterals;
1110
- /**
1111
- * Tax name.
1112
- * @minLength 1
1113
- * @maxLength 10
1114
- */
1115
- name?: string | null;
1116
- /**
1117
- * Tax rate (e.g.,`21.55`).
1118
- * @decimalValue options { gte:0.001, lte:100, maxScale:3 }
1119
- */
1120
- rate?: string | null;
1121
- /** Applies taxes for donations, default true. */
1122
- appliesToDonations?: boolean | null;
1123
- }
1124
- export declare enum TaxType {
1125
- /** Tax is included in the ticket price. */
1126
- INCLUDED = "INCLUDED",
1127
- /** Tax is added to the order at the checkout. */
1128
- ADDED = "ADDED",
1129
- /** Tax is added to the final total at the checkout. */
1130
- ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
1131
- }
1132
- /** @enumType */
1133
- export type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
1134
- export interface Money {
1135
- /**
1136
- * *Deprecated:** Use `value` instead.
1137
- * @format DECIMAL_VALUE
1138
- * @deprecated
1139
- */
1140
- amount?: string;
1141
- /**
1142
- * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1143
- * @format CURRENCY
1144
- */
1145
- currency?: string;
1146
- /**
1147
- * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
1148
- * @format DECIMAL_VALUE
1149
- */
1150
- value?: string | null;
1151
- }
1152
- export interface ExternalEvent {
1153
- /** External event registration URL. */
1154
- registration?: string;
1155
- }
1156
- export declare enum VisitorType {
1157
- /** Site visitor (including member) */
1158
- VISITOR = "VISITOR",
1159
- /** Site member */
1160
- MEMBER = "MEMBER",
1161
- /** Site visitor or member */
1162
- VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
1163
- }
1164
- /** @enumType */
1165
- export type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
1166
- export interface CalendarLinks {
1167
- /** "Add to Google calendar" URL. */
1168
- google?: string;
1169
- /** "Download ICS calendar file" URL. */
1170
- ics?: string;
1171
- }
1172
- /** Site URL components */
1173
- export interface SiteUrl {
1174
- /**
1175
- * Base URL. For premium sites, this will be the domain.
1176
- * For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
1177
- */
1178
- base?: string;
1179
- /** The path to that page - e.g `/my-events/weekly-meetup-2` */
1180
- path?: string;
1181
- }
1182
- export interface Dashboard {
1183
- /** Guest RSVP summary. */
1184
- rsvpSummary?: RsvpSummary;
1185
- /**
1186
- * Summary of revenue and tickets sold.
1187
- * (Archived orders are not included).
1188
- */
1189
- ticketingSummary?: TicketingSummary;
1190
- }
1191
- export interface RsvpSummary {
1192
- /** Total number of RSVPs. */
1193
- total?: number;
1194
- /** Number of RSVPs with status `YES`. */
1195
- yes?: number;
1196
- /** Number of RSVPs with status `NO`. */
1197
- no?: number;
1198
- /** Number of RSVPs in waitlist. */
1199
- waitlist?: number;
1200
- }
1201
- export interface TicketingSummary {
1202
- /** Number of tickets sold. */
1203
- tickets?: number;
1204
- /**
1205
- * Total revenue, excluding fees.
1206
- * (taxes and payment provider fees are not deducted.)
1207
- */
1208
- revenue?: Money;
1209
- /** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */
1210
- currencyLocked?: boolean;
1211
- /** Number of orders placed. */
1212
- orders?: number;
1213
- /** Total balance of confirmed transactions. */
1214
- totalSales?: Money;
1215
- }
1216
- export interface GuestListConfig {
1217
- /** Whether members can see other members attending the event (defaults to true). */
1218
- publicGuestList?: boolean;
1219
- }
1220
- export interface Feed {
1221
- /** Event discussion feed token. */
1222
- token?: string;
1223
- }
1224
- export interface OnlineConferencing {
1225
- config?: OnlineConferencingConfig;
1226
- session?: OnlineConferencingSession;
1227
- }
1228
- export interface OnlineConferencingConfig {
1229
- /**
1230
- * Whether online conferencing is enabled (not supported for TBD schedules).
1231
- * When enabled, links to join conferencing are generated and provided to guests.
1232
- */
1233
- enabled?: boolean;
1234
- /**
1235
- * Conferencing provider ID.
1236
- * @format GUID
1237
- */
1238
- providerId?: string | null;
1239
- /** Conference type */
1240
- conferenceType?: ConferenceTypeWithLiterals;
1241
- }
1242
- export declare enum ConferenceType {
1243
- /** Everyone in the meeting can publish and subscribe video and audio. */
1244
- MEETING = "MEETING",
1245
- /** Guests can only subscribe to video and audio. */
1246
- WEBINAR = "WEBINAR"
1247
- }
1248
- /** @enumType */
1249
- export type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
1250
- export interface OnlineConferencingSession {
1251
- /**
1252
- * Link for event host to start the online conference session.
1253
- * @readonly
1254
- */
1255
- hostLink?: string;
1256
- /**
1257
- * Link for guests to join the online conference session.
1258
- * @readonly
1259
- */
1260
- guestLink?: string;
1261
- /**
1262
- * The password required to join online conferencing session (when relevant).
1263
- * @readonly
1264
- */
1265
- password?: string | null;
1266
- /**
1267
- * Indicates that session was created successfully on providers side.
1268
- * @readonly
1269
- */
1270
- sessionCreated?: boolean | null;
1271
- /**
1272
- * Unique session id
1273
- * @readonly
1274
- */
1275
- sessionId?: string | null;
1276
- }
1277
- export interface SeoSettings {
1278
- /**
1279
- * URL slug
1280
- * @maxLength 130
1281
- */
1282
- slug?: string;
1283
- /** Advanced SEO data */
1284
- advancedSeoData?: SeoSchema;
1285
- /**
1286
- * Hidden from SEO Site Map
1287
- * @readonly
1288
- */
1289
- hidden?: boolean | null;
1290
- }
1291
- /**
1292
- * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
1293
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
1294
- * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
1295
- */
1296
- export interface SeoSchema {
1297
- /** SEO tag information. */
1298
- tags?: Tag[];
1299
- /** SEO general settings. */
1300
- settings?: Settings;
1301
- }
1302
- export interface Keyword {
1303
- /** Keyword value. */
1304
- term?: string;
1305
- /** Whether the keyword is the main focus keyword. */
1306
- isMain?: boolean;
1307
- /**
1308
- * The source that added the keyword terms to the SEO settings.
1309
- * @maxLength 1000
1310
- */
1311
- origin?: string | null;
1312
- }
1313
- export interface Tag {
1314
- /**
1315
- * SEO tag type.
1316
- *
1317
- *
1318
- * Supported values: `title`, `meta`, `script`, `link`.
1319
- */
1320
- type?: string;
1321
- /**
1322
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
1323
- * For example: `{"name": "description", "content": "the description itself"}`.
1324
- */
1325
- props?: Record<string, any> | null;
1326
- /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
1327
- meta?: Record<string, any> | null;
1328
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
1329
- children?: string;
1330
- /** Whether the tag is a custom tag. */
1331
- custom?: boolean;
1332
- /** Whether the tag is disabled. */
1333
- disabled?: boolean;
1334
- }
1335
- export interface Settings {
1336
- /**
1337
- * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
1338
- *
1339
- *
1340
- * Default: `false` (Auto Redirect is enabled.)
1341
- */
1342
- preventAutoRedirect?: boolean;
1343
- /**
1344
- * User-selected keyword terms for a specific page.
1345
- * @maxSize 5
1346
- */
1347
- keywords?: Keyword[];
1348
- }
1349
- export interface Agenda {
1350
- /** Whether the schedule is enabled for the event. */
1351
- enabled?: boolean;
1352
- /**
1353
- * Agenda page URL.
1354
- * @readonly
1355
- */
1356
- pageUrl?: SiteUrl;
1357
- }
1358
- export interface Category {
1359
- /**
1360
- * Category ID.
1361
- * @format GUID
1362
- * @readonly
1363
- */
1364
- id?: string;
1365
- /**
1366
- * Category name.
1367
- * @minLength 1
1368
- * @maxLength 30
1369
- */
1370
- name?: string;
1371
- /**
1372
- * Date and time when category was created.
1373
- * @readonly
1374
- */
1375
- createdDate?: Date | null;
1376
- /**
1377
- * The total number of draft and published events assigned to the category.
1378
- * @readonly
1379
- */
1380
- counts?: CategoryCounts;
1381
- /**
1382
- * Category state. Possible values:
1383
- *
1384
- * `MANUAL`: Category is created manually by the user.
1385
- * `AUTO`: Category is created automatically.
1386
- * `RECURRING_EVENT`: Category is created automatically when publishing recurring events.
1387
- * `HIDDEN`: Category can't be seen.
1388
- *
1389
- * Default: `MANUAL`.
1390
- *
1391
- * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
1392
- * @maxSize 3
1393
- */
1394
- states?: StateWithLiterals[];
1395
- }
1396
- export interface CategoryCounts {
1397
- /** Total number of draft events assigned to the category. */
1398
- assignedEventsCount?: number | null;
1399
- /** Total number of published events assigned to the category. Deleted events are excluded. */
1400
- assignedDraftEventsCount?: number | null;
1401
- }
1402
- export declare enum State {
1403
- /** Created manually by the user. */
1404
- MANUAL = "MANUAL",
1405
- /** Created automatically. */
1406
- AUTO = "AUTO",
1407
- /** Created when publishing recurring events. */
1408
- RECURRING_EVENT = "RECURRING_EVENT",
1409
- /** Category is hidden. */
1410
- HIDDEN = "HIDDEN"
1411
- }
1412
- /** @enumType */
1413
- export type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
1414
- export interface EventDisplaySettings {
1415
- /** Whether event details button is hidden. Only available for events with no registration. */
1416
- hideEventDetailsButton?: boolean | null;
1417
- /** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
1418
- hideEventDetailsPage?: boolean | null;
1419
- }
1420
- export interface LabellingSettings {
1421
- }
1422
- export interface RichContent {
1423
- /** Node objects representing a rich content document. */
1424
- nodes?: Node[];
1425
- /** Object metadata. */
1426
- metadata?: Metadata;
1427
- /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
1428
- documentStyle?: DocumentStyle;
1429
- }
1430
- export interface Node extends NodeDataOneOf {
1431
- /** Data for a button node. */
1432
- buttonData?: ButtonData;
1433
- /** Data for a code block node. */
1434
- codeBlockData?: CodeBlockData;
1435
- /** Data for a divider node. */
1436
- dividerData?: DividerData;
1437
- /** Data for a file node. */
1438
- fileData?: FileData;
1439
- /** Data for a gallery node. */
1440
- galleryData?: GalleryData;
1441
- /** Data for a GIF node. */
1442
- gifData?: GIFData;
1443
- /** Data for a heading node. */
1444
- headingData?: HeadingData;
1445
- /** Data for an embedded HTML node. */
1446
- htmlData?: HTMLData;
1447
- /** Data for an image node. */
1448
- imageData?: ImageData;
1449
- /** Data for a link preview node. */
1450
- linkPreviewData?: LinkPreviewData;
1451
- /** @deprecated */
1452
- mapData?: MapData;
1453
- /** Data for a paragraph node. */
1454
- paragraphData?: ParagraphData;
1455
- /** Data for a poll node. */
1456
- pollData?: PollData;
1457
- /** Data for a text node. Used to apply decorations to text. */
1458
- textData?: TextData;
1459
- /** Data for an app embed node. */
1460
- appEmbedData?: AppEmbedData;
1461
- /** Data for a video node. */
1462
- videoData?: VideoData;
1463
- /** Data for an oEmbed node. */
1464
- embedData?: EmbedData;
1465
- /** Data for a collapsible list node. */
1466
- collapsibleListData?: CollapsibleListData;
1467
- /** Data for a table node. */
1468
- tableData?: TableData;
1469
- /** Data for a table cell node. */
1470
- tableCellData?: TableCellData;
1471
- /** Data for a custom external node. */
1472
- externalData?: Record<string, any> | null;
1473
- /** Data for an audio node. */
1474
- audioData?: AudioData;
1475
- /** Data for an ordered list node. */
1476
- orderedListData?: OrderedListData;
1477
- /** Data for a bulleted list node. */
1478
- bulletedListData?: BulletedListData;
1479
- /** Data for a block quote node. */
1480
- blockquoteData?: BlockquoteData;
1481
- /** Data for a caption node. */
1482
- captionData?: CaptionData;
1483
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
1484
- layoutCellData?: LayoutCellData;
1485
- /** 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. */
1486
- type?: NodeTypeWithLiterals;
1487
- /** Node ID. */
1488
- id?: string;
1489
- /** A list of child nodes. */
1490
- nodes?: Node[];
1491
- /** Padding and background color styling for the node. */
1492
- style?: NodeStyle;
1493
- }
1494
- /** @oneof */
1495
- export interface NodeDataOneOf {
1496
- /** Data for a button node. */
1497
- buttonData?: ButtonData;
1498
- /** Data for a code block node. */
1499
- codeBlockData?: CodeBlockData;
1500
- /** Data for a divider node. */
1501
- dividerData?: DividerData;
1502
- /** Data for a file node. */
1503
- fileData?: FileData;
1504
- /** Data for a gallery node. */
1505
- galleryData?: GalleryData;
1506
- /** Data for a GIF node. */
1507
- gifData?: GIFData;
1508
- /** Data for a heading node. */
1509
- headingData?: HeadingData;
1510
- /** Data for an embedded HTML node. */
1511
- htmlData?: HTMLData;
1512
- /** Data for an image node. */
1513
- imageData?: ImageData;
1514
- /** Data for a link preview node. */
1515
- linkPreviewData?: LinkPreviewData;
1516
- /** @deprecated */
1517
- mapData?: MapData;
1518
- /** Data for a paragraph node. */
1519
- paragraphData?: ParagraphData;
1520
- /** Data for a poll node. */
1521
- pollData?: PollData;
1522
- /** Data for a text node. Used to apply decorations to text. */
1523
- textData?: TextData;
1524
- /** Data for an app embed node. */
1525
- appEmbedData?: AppEmbedData;
1526
- /** Data for a video node. */
1527
- videoData?: VideoData;
1528
- /** Data for an oEmbed node. */
1529
- embedData?: EmbedData;
1530
- /** Data for a collapsible list node. */
1531
- collapsibleListData?: CollapsibleListData;
1532
- /** Data for a table node. */
1533
- tableData?: TableData;
1534
- /** Data for a table cell node. */
1535
- tableCellData?: TableCellData;
1536
- /** Data for a custom external node. */
1537
- externalData?: Record<string, any> | null;
1538
- /** Data for an audio node. */
1539
- audioData?: AudioData;
1540
- /** Data for an ordered list node. */
1541
- orderedListData?: OrderedListData;
1542
- /** Data for a bulleted list node. */
1543
- bulletedListData?: BulletedListData;
1544
- /** Data for a block quote node. */
1545
- blockquoteData?: BlockquoteData;
1546
- /** Data for a caption node. */
1547
- captionData?: CaptionData;
1548
- /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
1549
- layoutCellData?: LayoutCellData;
1550
- }
1551
- export declare enum NodeType {
1552
- PARAGRAPH = "PARAGRAPH",
1553
- TEXT = "TEXT",
1554
- HEADING = "HEADING",
1555
- BULLETED_LIST = "BULLETED_LIST",
1556
- ORDERED_LIST = "ORDERED_LIST",
1557
- LIST_ITEM = "LIST_ITEM",
1558
- BLOCKQUOTE = "BLOCKQUOTE",
1559
- CODE_BLOCK = "CODE_BLOCK",
1560
- VIDEO = "VIDEO",
1561
- DIVIDER = "DIVIDER",
1562
- FILE = "FILE",
1563
- GALLERY = "GALLERY",
1564
- GIF = "GIF",
1565
- HTML = "HTML",
1566
- IMAGE = "IMAGE",
1567
- LINK_PREVIEW = "LINK_PREVIEW",
1568
- /** @deprecated */
1569
- MAP = "MAP",
1570
- POLL = "POLL",
1571
- APP_EMBED = "APP_EMBED",
1572
- BUTTON = "BUTTON",
1573
- COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
1574
- TABLE = "TABLE",
1575
- EMBED = "EMBED",
1576
- COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
1577
- COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
1578
- COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
1579
- TABLE_CELL = "TABLE_CELL",
1580
- TABLE_ROW = "TABLE_ROW",
1581
- EXTERNAL = "EXTERNAL",
1582
- AUDIO = "AUDIO",
1583
- CAPTION = "CAPTION",
1584
- LAYOUT = "LAYOUT",
1585
- LAYOUT_CELL = "LAYOUT_CELL"
1586
- }
1587
- /** @enumType */
1588
- export type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
1589
- export interface NodeStyle {
1590
- /** The top padding value in pixels. */
1591
- paddingTop?: string | null;
1592
- /** The bottom padding value in pixels. */
1593
- paddingBottom?: string | null;
1594
- /** The background color as a hexadecimal value. */
1595
- backgroundColor?: string | null;
1596
- }
1597
- export interface ButtonData {
1598
- /** Styling for the button's container. */
1599
- containerData?: PluginContainerData;
1600
- /** The button type. */
1601
- type?: ButtonDataTypeWithLiterals;
1602
- /** Styling for the button. */
1603
- styles?: Styles;
1604
- /** The text to display on the button. */
1605
- text?: string | null;
1606
- /** Button link details. */
1607
- link?: Link;
1608
- }
1609
- export interface Border {
1610
- /**
1611
- * Deprecated: Use `borderWidth` in `styles` instead.
1612
- * @deprecated
1613
- */
1614
- width?: number | null;
1615
- /**
1616
- * Deprecated: Use `borderRadius` in `styles` instead.
1617
- * @deprecated
1618
- */
1619
- radius?: number | null;
1620
- }
1621
- export interface Colors {
1622
- /**
1623
- * Deprecated: Use `textColor` in `styles` instead.
1624
- * @deprecated
1625
- */
1626
- text?: string | null;
1627
- /**
1628
- * Deprecated: Use `borderColor` in `styles` instead.
1629
- * @deprecated
1630
- */
1631
- border?: string | null;
1632
- /**
1633
- * Deprecated: Use `backgroundColor` in `styles` instead.
1634
- * @deprecated
1635
- */
1636
- background?: string | null;
1637
- }
1638
- export interface PluginContainerData {
1639
- /** The width of the node when it's displayed. */
1640
- width?: PluginContainerDataWidth;
1641
- /** The node's alignment within its container. */
1642
- alignment?: PluginContainerDataAlignmentWithLiterals;
1643
- /** Spoiler cover settings for the node. */
1644
- spoiler?: Spoiler;
1645
- /** The height of the node when it's displayed. */
1646
- height?: Height;
1647
- /** 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`. */
1648
- textWrap?: boolean | null;
1649
- }
1650
- export declare enum WidthType {
1651
- /** Width matches the content width */
1652
- CONTENT = "CONTENT",
1653
- /** Small Width */
1654
- SMALL = "SMALL",
1655
- /** Width will match the original asset width */
1656
- ORIGINAL = "ORIGINAL",
1657
- /** coast-to-coast display */
1658
- FULL_WIDTH = "FULL_WIDTH"
1659
- }
1660
- /** @enumType */
1661
- export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
1662
- export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
1663
- /**
1664
- * One of the following predefined width options:
1665
- * `CONTENT`: The width of the container matches the content width.
1666
- * `SMALL`: A small width.
1667
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
1668
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
1669
- */
1670
- size?: WidthTypeWithLiterals;
1671
- /** A custom width value in pixels. */
1672
- custom?: string | null;
1673
- }
1674
- /** @oneof */
1675
- export interface PluginContainerDataWidthDataOneOf {
1676
- /**
1677
- * One of the following predefined width options:
1678
- * `CONTENT`: The width of the container matches the content width.
1679
- * `SMALL`: A small width.
1680
- * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
1681
- * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
1682
- */
1683
- size?: WidthTypeWithLiterals;
1684
- /** A custom width value in pixels. */
1685
- custom?: string | null;
1686
- }
1687
- export declare enum PluginContainerDataAlignment {
1688
- /** Center Alignment */
1689
- CENTER = "CENTER",
1690
- /** Left Alignment */
1691
- LEFT = "LEFT",
1692
- /** Right Alignment */
1693
- RIGHT = "RIGHT"
1694
- }
1695
- /** @enumType */
1696
- export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
1697
- export interface Spoiler {
1698
- /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
1699
- enabled?: boolean | null;
1700
- /** The description displayed on top of the spoiler cover. */
1701
- description?: string | null;
1702
- /** The text for the button used to remove the spoiler cover. */
1703
- buttonText?: string | null;
1704
- }
1705
- export interface Height {
1706
- /** A custom height value in pixels. */
1707
- custom?: string | null;
1708
- }
1709
- export declare enum ButtonDataType {
1710
- /** Regular link button */
1711
- LINK = "LINK",
1712
- /** Triggers custom action that is defined in plugin configuration by the consumer */
1713
- ACTION = "ACTION"
1714
- }
1715
- /** @enumType */
1716
- export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
1717
- export interface Styles {
1718
- /**
1719
- * Deprecated: Use `borderWidth` and `borderRadius` instead.
1720
- * @deprecated
1721
- */
1722
- border?: Border;
1723
- /**
1724
- * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
1725
- * @deprecated
1726
- */
1727
- colors?: Colors;
1728
- /** Border width in pixels. */
1729
- borderWidth?: number | null;
1730
- /**
1731
- * Deprecated: Use `borderWidth` for normal/hover states instead.
1732
- * @deprecated
1733
- */
1734
- borderWidthHover?: number | null;
1735
- /** Border radius in pixels. */
1736
- borderRadius?: number | null;
1737
- /**
1738
- * Border color as a hexadecimal value.
1739
- * @format COLOR_HEX
1740
- */
1741
- borderColor?: string | null;
1742
- /**
1743
- * Border color as a hexadecimal value (hover state).
1744
- * @format COLOR_HEX
1745
- */
1746
- borderColorHover?: string | null;
1747
- /**
1748
- * Text color as a hexadecimal value.
1749
- * @format COLOR_HEX
1750
- */
1751
- textColor?: string | null;
1752
- /**
1753
- * Text color as a hexadecimal value (hover state).
1754
- * @format COLOR_HEX
1755
- */
1756
- textColorHover?: string | null;
1757
- /**
1758
- * Background color as a hexadecimal value.
1759
- * @format COLOR_HEX
1760
- */
1761
- backgroundColor?: string | null;
1762
- /**
1763
- * Background color as a hexadecimal value (hover state).
1764
- * @format COLOR_HEX
1765
- */
1766
- backgroundColorHover?: string | null;
1767
- /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
1768
- buttonSize?: string | null;
1769
- }
1770
- export interface Link extends LinkDataOneOf {
1771
- /** The absolute URL for the linked document. */
1772
- url?: string;
1773
- /** The target node's ID. Used for linking to another node in this object. */
1774
- anchor?: string;
1775
- /**
1776
- * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
1777
- * `SELF` - Default. Opens the linked document in the same frame as the link.
1778
- * `BLANK` - Opens the linked document in a new browser tab or window.
1779
- * `PARENT` - Opens the linked document in the link's parent frame.
1780
- * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
1781
- */
1782
- target?: TargetWithLiterals;
1783
- /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
1784
- rel?: Rel;
1785
- /** A serialized object used for a custom or external link panel. */
1786
- customData?: string | null;
1787
- }
1788
- /** @oneof */
1789
- export interface LinkDataOneOf {
1790
- /** The absolute URL for the linked document. */
1791
- url?: string;
1792
- /** The target node's ID. Used for linking to another node in this object. */
1793
- anchor?: string;
1794
- }
1795
- export declare enum Target {
1796
- /** Opens the linked document in the same frame as it was clicked (this is default) */
1797
- SELF = "SELF",
1798
- /** Opens the linked document in a new window or tab */
1799
- BLANK = "BLANK",
1800
- /** Opens the linked document in the parent frame */
1801
- PARENT = "PARENT",
1802
- /** Opens the linked document in the full body of the window */
1803
- TOP = "TOP"
1804
- }
1805
- /** @enumType */
1806
- export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
1807
- export interface Rel {
1808
- /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
1809
- nofollow?: boolean | null;
1810
- /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
1811
- sponsored?: boolean | null;
1812
- /** 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`. */
1813
- ugc?: boolean | null;
1814
- /** Indicates that this link protect referral information from being passed to the target website. */
1815
- noreferrer?: boolean | null;
1816
- }
1817
- export interface CodeBlockData {
1818
- /** Styling for the code block's text. */
1819
- textStyle?: TextStyle;
1820
- }
1821
- export interface TextStyle {
1822
- /** Text alignment. Defaults to `AUTO`. */
1823
- textAlignment?: TextAlignmentWithLiterals;
1824
- /** 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. */
1825
- lineHeight?: string | null;
1826
- }
1827
- export declare enum TextAlignment {
1828
- /** browser default, eqivalent to `initial` */
1829
- AUTO = "AUTO",
1830
- /** Left align */
1831
- LEFT = "LEFT",
1832
- /** Right align */
1833
- RIGHT = "RIGHT",
1834
- /** Center align */
1835
- CENTER = "CENTER",
1836
- /** 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 */
1837
- JUSTIFY = "JUSTIFY"
1838
- }
1839
- /** @enumType */
1840
- export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
1841
- export interface DividerData {
1842
- /** Styling for the divider's container. */
1843
- containerData?: PluginContainerData;
1844
- /** Divider line style. */
1845
- lineStyle?: LineStyleWithLiterals;
1846
- /** Divider width. */
1847
- width?: WidthWithLiterals;
1848
- /** Divider alignment. */
1849
- alignment?: AlignmentWithLiterals;
1850
- }
1851
- export declare enum LineStyle {
1852
- /** Single Line */
1853
- SINGLE = "SINGLE",
1854
- /** Double Line */
1855
- DOUBLE = "DOUBLE",
1856
- /** Dashed Line */
1857
- DASHED = "DASHED",
1858
- /** Dotted Line */
1859
- DOTTED = "DOTTED"
1860
- }
1861
- /** @enumType */
1862
- export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
1863
- export declare enum Width {
1864
- /** Large line */
1865
- LARGE = "LARGE",
1866
- /** Medium line */
1867
- MEDIUM = "MEDIUM",
1868
- /** Small line */
1869
- SMALL = "SMALL"
1870
- }
1871
- /** @enumType */
1872
- export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
1873
- export declare enum Alignment {
1874
- /** Center alignment */
1875
- CENTER = "CENTER",
1876
- /** Left alignment */
1877
- LEFT = "LEFT",
1878
- /** Right alignment */
1879
- RIGHT = "RIGHT"
1880
- }
1881
- /** @enumType */
1882
- export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
1883
- export interface FileData {
1884
- /** Styling for the file's container. */
1885
- containerData?: PluginContainerData;
1886
- /** The source for the file's data. */
1887
- src?: FileSource;
1888
- /** File name. */
1889
- name?: string | null;
1890
- /** File type. */
1891
- type?: string | null;
1892
- /**
1893
- * Use `sizeInKb` instead.
1894
- * @deprecated
1895
- */
1896
- size?: number | null;
1897
- /** Settings for PDF files. */
1898
- pdfSettings?: PDFSettings;
1899
- /** File MIME type. */
1900
- mimeType?: string | null;
1901
- /** File path. */
1902
- path?: string | null;
1903
- /** File size in KB. */
1904
- sizeInKb?: string | null;
1905
- }
1906
- export declare enum ViewMode {
1907
- /** No PDF view */
1908
- NONE = "NONE",
1909
- /** Full PDF view */
1910
- FULL = "FULL",
1911
- /** Mini PDF view */
1912
- MINI = "MINI"
1913
- }
1914
- /** @enumType */
1915
- export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
1916
- export interface FileSource extends FileSourceDataOneOf {
1917
- /** The absolute URL for the file's source. */
1918
- url?: string | null;
1919
- /**
1920
- * Custom ID. Use `id` instead.
1921
- * @deprecated
1922
- */
1923
- custom?: string | null;
1924
- /** An ID that's resolved to a URL by a resolver function. */
1925
- id?: string | null;
1926
- /** Indicates whether the file's source is private. Defaults to `false`. */
1927
- private?: boolean | null;
1928
- }
1929
- /** @oneof */
1930
- export interface FileSourceDataOneOf {
1931
- /** The absolute URL for the file's source. */
1932
- url?: string | null;
1933
- /**
1934
- * Custom ID. Use `id` instead.
1935
- * @deprecated
1936
- */
1937
- custom?: string | null;
1938
- /** An ID that's resolved to a URL by a resolver function. */
1939
- id?: string | null;
1940
- }
1941
- export interface PDFSettings {
1942
- /**
1943
- * PDF view mode. One of the following:
1944
- * `NONE` : The PDF isn't displayed.
1945
- * `FULL` : A full page view of the PDF is displayed.
1946
- * `MINI` : A mini view of the PDF is displayed.
1947
- */
1948
- viewMode?: ViewModeWithLiterals;
1949
- /** Sets whether the PDF download button is disabled. Defaults to `false`. */
1950
- disableDownload?: boolean | null;
1951
- /** Sets whether the PDF print button is disabled. Defaults to `false`. */
1952
- disablePrint?: boolean | null;
1953
- }
1954
- export interface GalleryData {
1955
- /** Styling for the gallery's container. */
1956
- containerData?: PluginContainerData;
1957
- /** The items in the gallery. */
1958
- items?: Item[];
1959
- /** Options for defining the gallery's appearance. */
1960
- options?: GalleryOptions;
1961
- /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
1962
- disableExpand?: boolean | null;
1963
- /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
1964
- disableDownload?: boolean | null;
1965
- }
1966
- export interface Media {
1967
- /** The source for the media's data. */
1968
- src?: FileSource;
1969
- /** Media width in pixels. */
1970
- width?: number | null;
1971
- /** Media height in pixels. */
1972
- height?: number | null;
1973
- /** Media duration in seconds. Only relevant for audio and video files. */
1974
- duration?: number | null;
1975
- }
1976
- export interface ItemImage {
1977
- /** Image file details. */
1978
- media?: Media;
1979
- /** Link details for images that are links. */
1980
- link?: Link;
1981
- }
1982
- export interface Video {
1983
- /** Video file details. */
1984
- media?: Media;
1985
- /** Video thumbnail file details. */
1986
- thumbnail?: Media;
1987
- }
1988
- export interface Item extends ItemDataOneOf {
1989
- /** An image item. */
1990
- image?: ItemImage;
1991
- /** A video item. */
1992
- video?: Video;
1993
- /** Item title. */
1994
- title?: string | null;
1995
- /** Item's alternative text. */
1996
- altText?: string | null;
1997
- }
1998
- /** @oneof */
1999
- export interface ItemDataOneOf {
2000
- /** An image item. */
2001
- image?: ItemImage;
2002
- /** A video item. */
2003
- video?: Video;
2004
- }
2005
- export interface GalleryOptions {
2006
- /** Gallery layout. */
2007
- layout?: Layout;
2008
- /** Styling for gallery items. */
2009
- item?: ItemStyle;
2010
- /** Styling for gallery thumbnail images. */
2011
- thumbnails?: Thumbnails;
2012
- }
2013
- export declare enum LayoutType {
2014
- /** Collage type */
2015
- COLLAGE = "COLLAGE",
2016
- /** Masonry type */
2017
- MASONRY = "MASONRY",
2018
- /** Grid type */
2019
- GRID = "GRID",
2020
- /** Thumbnail type */
2021
- THUMBNAIL = "THUMBNAIL",
2022
- /** Slider type */
2023
- SLIDER = "SLIDER",
2024
- /** Slideshow type */
2025
- SLIDESHOW = "SLIDESHOW",
2026
- /** Panorama type */
2027
- PANORAMA = "PANORAMA",
2028
- /** Column type */
2029
- COLUMN = "COLUMN",
2030
- /** Magic type */
2031
- MAGIC = "MAGIC",
2032
- /** Fullsize images type */
2033
- FULLSIZE = "FULLSIZE"
2034
- }
2035
- /** @enumType */
2036
- export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
2037
- export declare enum Orientation {
2038
- /** Rows Orientation */
2039
- ROWS = "ROWS",
2040
- /** Columns Orientation */
2041
- COLUMNS = "COLUMNS"
2042
- }
2043
- /** @enumType */
2044
- export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
2045
- export declare enum Crop {
2046
- /** Crop to fill */
2047
- FILL = "FILL",
2048
- /** Crop to fit */
2049
- FIT = "FIT"
2050
- }
2051
- /** @enumType */
2052
- export type CropWithLiterals = Crop | 'FILL' | 'FIT';
2053
- export declare enum ThumbnailsAlignment {
2054
- /** Top alignment */
2055
- TOP = "TOP",
2056
- /** Right alignment */
2057
- RIGHT = "RIGHT",
2058
- /** Bottom alignment */
2059
- BOTTOM = "BOTTOM",
2060
- /** Left alignment */
2061
- LEFT = "LEFT",
2062
- /** No thumbnail */
2063
- NONE = "NONE"
2064
- }
2065
- /** @enumType */
2066
- export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
2067
- export interface Layout {
2068
- /** Gallery layout type. */
2069
- type?: LayoutTypeWithLiterals;
2070
- /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
2071
- horizontalScroll?: boolean | null;
2072
- /** Gallery orientation. */
2073
- orientation?: OrientationWithLiterals;
2074
- /** The number of columns to display on full size screens. */
2075
- numberOfColumns?: number | null;
2076
- /** The number of columns to display on mobile screens. */
2077
- mobileNumberOfColumns?: number | null;
2078
- }
2079
- export interface ItemStyle {
2080
- /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
2081
- targetSize?: number | null;
2082
- /** Item ratio */
2083
- ratio?: number | null;
2084
- /** Sets how item images are cropped. */
2085
- crop?: CropWithLiterals;
2086
- /** The spacing between items in pixels. */
2087
- spacing?: number | null;
2088
- }
2089
- export interface Thumbnails {
2090
- /** Thumbnail alignment. */
2091
- placement?: ThumbnailsAlignmentWithLiterals;
2092
- /** Spacing between thumbnails in pixels. */
2093
- spacing?: number | null;
2094
- }
2095
- export interface GIFData {
2096
- /** Styling for the GIF's container. */
2097
- containerData?: PluginContainerData;
2098
- /** The source of the full size GIF. */
2099
- original?: GIF;
2100
- /** The source of the downsized GIF. */
2101
- downsized?: GIF;
2102
- /** Height in pixels. */
2103
- height?: number;
2104
- /** Width in pixels. */
2105
- width?: number;
2106
- /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
2107
- gifType?: GIFTypeWithLiterals;
2108
- }
2109
- export interface GIF {
2110
- /**
2111
- * GIF format URL.
2112
- * @format WEB_URL
2113
- */
2114
- gif?: string | null;
2115
- /**
2116
- * MP4 format URL.
2117
- * @format WEB_URL
2118
- */
2119
- mp4?: string | null;
2120
- /**
2121
- * Thumbnail URL.
2122
- * @format WEB_URL
2123
- */
2124
- still?: string | null;
2125
- }
2126
- export declare enum GIFType {
2127
- NORMAL = "NORMAL",
2128
- STICKER = "STICKER"
2129
- }
2130
- /** @enumType */
2131
- export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
2132
- export interface HeadingData {
2133
- /** Heading level from 1-6. */
2134
- level?: number;
2135
- /** Styling for the heading text. */
2136
- textStyle?: TextStyle;
2137
- /** Indentation level from 1-4. */
2138
- indentation?: number | null;
2139
- }
2140
- export interface HTMLData extends HTMLDataDataOneOf {
2141
- /** The URL for the HTML code for the node. */
2142
- url?: string;
2143
- /** The HTML code for the node. */
2144
- html?: string;
2145
- /**
2146
- * Whether this is an AdSense element. Use `source` instead.
2147
- * @deprecated
2148
- */
2149
- isAdsense?: boolean | null;
2150
- /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
2151
- containerData?: PluginContainerData;
2152
- /** The type of HTML code. */
2153
- source?: SourceWithLiterals;
2154
- /** If container height is aligned with its content height. Defaults to `true`. */
2155
- autoHeight?: boolean | null;
2156
- }
2157
- /** @oneof */
2158
- export interface HTMLDataDataOneOf {
2159
- /** The URL for the HTML code for the node. */
2160
- url?: string;
2161
- /** The HTML code for the node. */
2162
- html?: string;
2163
- /**
2164
- * Whether this is an AdSense element. Use `source` instead.
2165
- * @deprecated
2166
- */
2167
- isAdsense?: boolean | null;
2168
- }
2169
- export declare enum Source {
2170
- HTML = "HTML",
2171
- ADSENSE = "ADSENSE"
2172
- }
2173
- /** @enumType */
2174
- export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
2175
- export interface ImageData {
2176
- /** Styling for the image's container. */
2177
- containerData?: PluginContainerData;
2178
- /** Image file details. */
2179
- image?: Media;
2180
- /** Link details for images that are links. */
2181
- link?: Link;
2182
- /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
2183
- disableExpand?: boolean | null;
2184
- /** Image's alternative text. */
2185
- altText?: string | null;
2186
- /**
2187
- * Deprecated: use Caption node instead.
2188
- * @deprecated
2189
- */
2190
- caption?: string | null;
2191
- /** Sets whether the image's download button is disabled. Defaults to `false`. */
2192
- disableDownload?: boolean | null;
2193
- /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
2194
- decorative?: boolean | null;
2195
- /** Styling for the image. */
2196
- styles?: ImageDataStyles;
2197
- }
2198
- export interface StylesBorder {
2199
- /** Border width in pixels. */
2200
- width?: number | null;
2201
- /**
2202
- * Border color as a hexadecimal value.
2203
- * @format COLOR_HEX
2204
- */
2205
- color?: string | null;
2206
- /** Border radius in pixels. */
2207
- radius?: number | null;
2208
- }
2209
- export interface ImageDataStyles {
2210
- /** Border attributes. */
2211
- border?: StylesBorder;
2212
- }
2213
- export interface LinkPreviewData {
2214
- /** Styling for the link preview's container. */
2215
- containerData?: PluginContainerData;
2216
- /** Link details. */
2217
- link?: Link;
2218
- /** Preview title. */
2219
- title?: string | null;
2220
- /** Preview thumbnail URL. */
2221
- thumbnailUrl?: string | null;
2222
- /** Preview description. */
2223
- description?: string | null;
2224
- /** The preview content as HTML. */
2225
- html?: string | null;
2226
- /** Styling for the link preview. */
2227
- styles?: LinkPreviewDataStyles;
2228
- }
2229
- export declare enum Position {
2230
- /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
2231
- START = "START",
2232
- /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
2233
- END = "END",
2234
- /** Thumbnail positioned at the top */
2235
- TOP = "TOP",
2236
- /** Thumbnail hidden and not displayed */
2237
- HIDDEN = "HIDDEN"
2238
- }
2239
- /** @enumType */
2240
- export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
2241
- export interface LinkPreviewDataStyles {
2242
- /**
2243
- * Background color as a hexadecimal value.
2244
- * @format COLOR_HEX
2245
- */
2246
- backgroundColor?: string | null;
2247
- /**
2248
- * Title color as a hexadecimal value.
2249
- * @format COLOR_HEX
2250
- */
2251
- titleColor?: string | null;
2252
- /**
2253
- * Subtitle color as a hexadecimal value.
2254
- * @format COLOR_HEX
2255
- */
2256
- subtitleColor?: string | null;
2257
- /**
2258
- * Link color as a hexadecimal value.
2259
- * @format COLOR_HEX
2260
- */
2261
- linkColor?: string | null;
2262
- /** Border width in pixels. */
2263
- borderWidth?: number | null;
2264
- /** Border radius in pixels. */
2265
- borderRadius?: number | null;
2266
- /**
2267
- * Border color as a hexadecimal value.
2268
- * @format COLOR_HEX
2269
- */
2270
- borderColor?: string | null;
2271
- /** Position of thumbnail. Defaults to `START`. */
2272
- thumbnailPosition?: PositionWithLiterals;
2273
- }
2274
- export interface MapData {
2275
- /** Styling for the map's container. */
2276
- containerData?: PluginContainerData;
2277
- /** Map settings. */
2278
- mapSettings?: MapSettings;
2279
- }
2280
- export interface MapSettings {
2281
- /** The address to display on the map. */
2282
- address?: string | null;
2283
- /** Sets whether the map is draggable. */
2284
- draggable?: boolean | null;
2285
- /** Sets whether the location marker is visible. */
2286
- marker?: boolean | null;
2287
- /** Sets whether street view control is enabled. */
2288
- streetViewControl?: boolean | null;
2289
- /** Sets whether zoom control is enabled. */
2290
- zoomControl?: boolean | null;
2291
- /** Location latitude. */
2292
- lat?: number | null;
2293
- /** Location longitude. */
2294
- lng?: number | null;
2295
- /** Location name. */
2296
- locationName?: string | null;
2297
- /** Sets whether view mode control is enabled. */
2298
- viewModeControl?: boolean | null;
2299
- /** Initial zoom value. */
2300
- initialZoom?: number | null;
2301
- /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
2302
- mapType?: MapTypeWithLiterals;
2303
- }
2304
- export declare enum MapType {
2305
- /** Roadmap map type */
2306
- ROADMAP = "ROADMAP",
2307
- /** Satellite map type */
2308
- SATELITE = "SATELITE",
2309
- /** Hybrid map type */
2310
- HYBRID = "HYBRID",
2311
- /** Terrain map type */
2312
- TERRAIN = "TERRAIN"
2313
- }
2314
- /** @enumType */
2315
- export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
2316
- export interface ParagraphData {
2317
- /** Styling for the paragraph text. */
2318
- textStyle?: TextStyle;
2319
- /** Indentation level from 1-4. */
2320
- indentation?: number | null;
2321
- /** Paragraph level */
2322
- level?: number | null;
2323
- }
2324
- export interface PollData {
2325
- /** Styling for the poll's container. */
2326
- containerData?: PluginContainerData;
2327
- /** Poll data. */
2328
- poll?: Poll;
2329
- /** Layout settings for the poll and voting options. */
2330
- layout?: PollDataLayout;
2331
- /** Styling for the poll and voting options. */
2332
- design?: Design;
2333
- }
2334
- export declare enum ViewRole {
2335
- /** Only Poll creator can view the results */
2336
- CREATOR = "CREATOR",
2337
- /** Anyone who voted can see the results */
2338
- VOTERS = "VOTERS",
2339
- /** Anyone can see the results, even if one didn't vote */
2340
- EVERYONE = "EVERYONE"
2341
- }
2342
- /** @enumType */
2343
- export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
2344
- export declare enum VoteRole {
2345
- /** Logged in member */
2346
- SITE_MEMBERS = "SITE_MEMBERS",
2347
- /** Anyone */
2348
- ALL = "ALL"
2349
- }
2350
- /** @enumType */
2351
- export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
2352
- export interface Permissions {
2353
- /** Sets who can view the poll results. */
2354
- view?: ViewRoleWithLiterals;
2355
- /** Sets who can vote. */
2356
- vote?: VoteRoleWithLiterals;
2357
- /** Sets whether one voter can vote multiple times. Defaults to `false`. */
2358
- allowMultipleVotes?: boolean | null;
2359
- }
2360
- export interface Option {
2361
- /** Option ID. */
2362
- id?: string | null;
2363
- /** Option title. */
2364
- title?: string | null;
2365
- /** The image displayed with the option. */
2366
- image?: Media;
2367
- }
2368
- export interface PollSettings {
2369
- /** Permissions settings for voting. */
2370
- permissions?: Permissions;
2371
- /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
2372
- showVoters?: boolean | null;
2373
- /** Sets whether the vote count is displayed. Defaults to `true`. */
2374
- showVotesCount?: boolean | null;
2375
- }
2376
- export declare enum PollLayoutType {
2377
- /** List */
2378
- LIST = "LIST",
2379
- /** Grid */
2380
- GRID = "GRID"
2381
- }
2382
- /** @enumType */
2383
- export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
2384
- export declare enum PollLayoutDirection {
2385
- /** Left-to-right */
2386
- LTR = "LTR",
2387
- /** Right-to-left */
2388
- RTL = "RTL"
2389
- }
2390
- /** @enumType */
2391
- export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
2392
- export interface PollLayout {
2393
- /** The layout for displaying the voting options. */
2394
- type?: PollLayoutTypeWithLiterals;
2395
- /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
2396
- direction?: PollLayoutDirectionWithLiterals;
2397
- /** Sets whether to display the main poll image. Defaults to `false`. */
2398
- enableImage?: boolean | null;
2399
- }
2400
- export interface OptionLayout {
2401
- /** Sets whether to display option images. Defaults to `false`. */
2402
- enableImage?: boolean | null;
2403
- }
2404
- export declare enum BackgroundType {
2405
- /** Color background type */
2406
- COLOR = "COLOR",
2407
- /** Image background type */
2408
- IMAGE = "IMAGE",
2409
- /** Gradiant background type */
2410
- GRADIENT = "GRADIENT"
2411
- }
2412
- /** @enumType */
2413
- export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
2414
- export interface Gradient {
2415
- /** The gradient angle in degrees. */
2416
- angle?: number | null;
2417
- /**
2418
- * The start color as a hexademical value.
2419
- * @format COLOR_HEX
2420
- */
2421
- startColor?: string | null;
2422
- /**
2423
- * The end color as a hexademical value.
2424
- * @format COLOR_HEX
2425
- */
2426
- lastColor?: string | null;
2427
- }
2428
- export interface Background extends BackgroundBackgroundOneOf {
2429
- /**
2430
- * The background color as a hexademical value.
2431
- * @format COLOR_HEX
2432
- */
2433
- color?: string | null;
2434
- /** An image to use for the background. */
2435
- image?: Media;
2436
- /** Details for a gradient background. */
2437
- gradient?: Gradient;
2438
- /** Background type. For each option, include the relevant details. */
2439
- type?: BackgroundTypeWithLiterals;
2440
- }
2441
- /** @oneof */
2442
- export interface BackgroundBackgroundOneOf {
2443
- /**
2444
- * The background color as a hexademical value.
2445
- * @format COLOR_HEX
2446
- */
2447
- color?: string | null;
2448
- /** An image to use for the background. */
2449
- image?: Media;
2450
- /** Details for a gradient background. */
2451
- gradient?: Gradient;
2452
- }
2453
- export interface PollDesign {
2454
- /** Background styling. */
2455
- background?: Background;
2456
- /** Border radius in pixels. */
2457
- borderRadius?: number | null;
2458
- }
2459
- export interface OptionDesign {
2460
- /** Border radius in pixels. */
2461
- borderRadius?: number | null;
2462
- }
2463
- export interface Poll {
2464
- /** Poll ID. */
2465
- id?: string | null;
2466
- /** Poll title. */
2467
- title?: string | null;
2468
- /** Poll creator ID. */
2469
- creatorId?: string | null;
2470
- /** Main poll image. */
2471
- image?: Media;
2472
- /** Voting options. */
2473
- options?: Option[];
2474
- /** The poll's permissions and display settings. */
2475
- settings?: PollSettings;
2476
- }
2477
- export interface PollDataLayout {
2478
- /** Poll layout settings. */
2479
- poll?: PollLayout;
2480
- /** Voting otpions layout settings. */
2481
- options?: OptionLayout;
2482
- }
2483
- export interface Design {
2484
- /** Styling for the poll. */
2485
- poll?: PollDesign;
2486
- /** Styling for voting options. */
2487
- options?: OptionDesign;
2488
- }
2489
- export interface TextData {
2490
- /** The text to apply decorations to. */
2491
- text?: string;
2492
- /** The decorations to apply. */
2493
- decorations?: Decoration[];
2494
- }
2495
- /** Adds appearence changes to text */
2496
- export interface Decoration extends DecorationDataOneOf {
2497
- /** Data for an anchor link decoration. */
2498
- anchorData?: AnchorData;
2499
- /** Data for a color decoration. */
2500
- colorData?: ColorData;
2501
- /** Data for an external link decoration. */
2502
- linkData?: LinkData;
2503
- /** Data for a mention decoration. */
2504
- mentionData?: MentionData;
2505
- /** Data for a font size decoration. */
2506
- fontSizeData?: FontSizeData;
2507
- /** Font weight for a bold decoration. */
2508
- fontWeightValue?: number | null;
2509
- /** Data for an italic decoration. Defaults to `true`. */
2510
- italicData?: boolean | null;
2511
- /** Data for an underline decoration. Defaults to `true`. */
2512
- underlineData?: boolean | null;
2513
- /** Data for a spoiler decoration. */
2514
- spoilerData?: SpoilerData;
2515
- /** Data for a strikethrough decoration. Defaults to `true`. */
2516
- strikethroughData?: boolean | null;
2517
- /** The type of decoration to apply. */
2518
- type?: DecorationTypeWithLiterals;
2519
- }
2520
- /** @oneof */
2521
- export interface DecorationDataOneOf {
2522
- /** Data for an anchor link decoration. */
2523
- anchorData?: AnchorData;
2524
- /** Data for a color decoration. */
2525
- colorData?: ColorData;
2526
- /** Data for an external link decoration. */
2527
- linkData?: LinkData;
2528
- /** Data for a mention decoration. */
2529
- mentionData?: MentionData;
2530
- /** Data for a font size decoration. */
2531
- fontSizeData?: FontSizeData;
2532
- /** Font weight for a bold decoration. */
2533
- fontWeightValue?: number | null;
2534
- /** Data for an italic decoration. Defaults to `true`. */
2535
- italicData?: boolean | null;
2536
- /** Data for an underline decoration. Defaults to `true`. */
2537
- underlineData?: boolean | null;
2538
- /** Data for a spoiler decoration. */
2539
- spoilerData?: SpoilerData;
2540
- /** Data for a strikethrough decoration. Defaults to `true`. */
2541
- strikethroughData?: boolean | null;
2542
- }
2543
- export declare enum DecorationType {
2544
- BOLD = "BOLD",
2545
- ITALIC = "ITALIC",
2546
- UNDERLINE = "UNDERLINE",
2547
- SPOILER = "SPOILER",
2548
- ANCHOR = "ANCHOR",
2549
- MENTION = "MENTION",
2550
- LINK = "LINK",
2551
- COLOR = "COLOR",
2552
- FONT_SIZE = "FONT_SIZE",
2553
- EXTERNAL = "EXTERNAL",
2554
- STRIKETHROUGH = "STRIKETHROUGH"
2555
- }
2556
- /** @enumType */
2557
- export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
2558
- export interface AnchorData {
2559
- /** The target node's ID. */
2560
- anchor?: string;
2561
- }
2562
- export interface ColorData {
2563
- /** The text's background color as a hexadecimal value. */
2564
- background?: string | null;
2565
- /** The text's foreground color as a hexadecimal value. */
2566
- foreground?: string | null;
2567
- }
2568
- export interface LinkData {
2569
- /** Link details. */
2570
- link?: Link;
2571
- }
2572
- export interface MentionData {
2573
- /** The mentioned user's name. */
2574
- name?: string;
2575
- /** The version of the user's name that appears after the `@` character in the mention. */
2576
- slug?: string;
2577
- /** Mentioned user's ID. */
2578
- id?: string | null;
2579
- }
2580
- export interface FontSizeData {
2581
- /** The units used for the font size. */
2582
- unit?: FontTypeWithLiterals;
2583
- /** Font size value. */
2584
- value?: number | null;
2585
- }
2586
- export declare enum FontType {
2587
- PX = "PX",
2588
- EM = "EM"
2589
- }
2590
- /** @enumType */
2591
- export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
2592
- export interface SpoilerData {
2593
- /** Spoiler ID. */
2594
- id?: string | null;
2595
- }
2596
- export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
2597
- /** Data for embedded Wix Bookings content. */
2598
- bookingData?: BookingData;
2599
- /** Data for embedded Wix Events content. */
2600
- eventData?: EventData;
2601
- /** The type of Wix App content being embedded. */
2602
- type?: AppTypeWithLiterals;
2603
- /** The ID of the embedded content. */
2604
- itemId?: string | null;
2605
- /** The name of the embedded content. */
2606
- name?: string | null;
2607
- /**
2608
- * Deprecated: Use `image` instead.
2609
- * @deprecated
2610
- */
2611
- imageSrc?: string | null;
2612
- /** The URL for the embedded content. */
2613
- url?: string | null;
2614
- /** An image for the embedded content. */
2615
- image?: Media;
2616
- }
2617
- /** @oneof */
2618
- export interface AppEmbedDataAppDataOneOf {
2619
- /** Data for embedded Wix Bookings content. */
2620
- bookingData?: BookingData;
2621
- /** Data for embedded Wix Events content. */
2622
- eventData?: EventData;
2623
- }
2624
- export declare enum AppType {
2625
- PRODUCT = "PRODUCT",
2626
- EVENT = "EVENT",
2627
- BOOKING = "BOOKING"
2628
- }
2629
- /** @enumType */
2630
- export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
2631
- export interface BookingData {
2632
- /** Booking duration in minutes. */
2633
- durations?: string | null;
2634
- }
2635
- export interface EventData {
2636
- /** Event schedule. */
2637
- scheduling?: string | null;
2638
- /** Event location. */
2639
- location?: string | null;
2640
- }
2641
- export interface VideoData {
2642
- /** Styling for the video's container. */
2643
- containerData?: PluginContainerData;
2644
- /** Video details. */
2645
- video?: Media;
2646
- /** Video thumbnail details. */
2647
- thumbnail?: Media;
2648
- /** Sets whether the video's download button is disabled. Defaults to `false`. */
2649
- disableDownload?: boolean | null;
2650
- /** Video title. */
2651
- title?: string | null;
2652
- /** Video options. */
2653
- options?: PlaybackOptions;
2654
- }
2655
- export interface PlaybackOptions {
2656
- /** Sets whether the media will automatically start playing. */
2657
- autoPlay?: boolean | null;
2658
- /** Sets whether media's will be looped. */
2659
- playInLoop?: boolean | null;
2660
- /** Sets whether media's controls will be shown. */
2661
- showControls?: boolean | null;
2662
- }
2663
- export interface EmbedData {
2664
- /** Styling for the oEmbed node's container. */
2665
- containerData?: PluginContainerData;
2666
- /** An [oEmbed](https://www.oembed.com) object. */
2667
- oembed?: Oembed;
2668
- /** Origin asset source. */
2669
- src?: string | null;
2670
- }
2671
- export interface Oembed {
2672
- /** The resource type. */
2673
- type?: string | null;
2674
- /** The width of the resource specified in the `url` property in pixels. */
2675
- width?: number | null;
2676
- /** The height of the resource specified in the `url` property in pixels. */
2677
- height?: number | null;
2678
- /** Resource title. */
2679
- title?: string | null;
2680
- /** The source URL for the resource. */
2681
- url?: string | null;
2682
- /** HTML for embedding a video player. The HTML should have no padding or margins. */
2683
- html?: string | null;
2684
- /** The name of the author or owner of the resource. */
2685
- authorName?: string | null;
2686
- /** The URL for the author or owner of the resource. */
2687
- authorUrl?: string | null;
2688
- /** The name of the resource provider. */
2689
- providerName?: string | null;
2690
- /** The URL for the resource provider. */
2691
- providerUrl?: string | null;
2692
- /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
2693
- thumbnailUrl?: string | null;
2694
- /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
2695
- thumbnailWidth?: string | null;
2696
- /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
2697
- thumbnailHeight?: string | null;
2698
- /** The URL for an embedded viedo. */
2699
- videoUrl?: string | null;
2700
- /** The oEmbed version number. This value must be `1.0`. */
2701
- version?: string | null;
2702
- }
2703
- export interface CollapsibleListData {
2704
- /** Styling for the collapsible list's container. */
2705
- containerData?: PluginContainerData;
2706
- /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
2707
- expandOnlyOne?: boolean | null;
2708
- /** Sets which items are expanded when the page loads. */
2709
- initialExpandedItems?: InitialExpandedItemsWithLiterals;
2710
- /** The direction of the text in the list. Either left-to-right or right-to-left. */
2711
- direction?: DirectionWithLiterals;
2712
- /** If `true`, The collapsible item will appear in search results as an FAQ. */
2713
- isQapageData?: boolean | null;
2714
- }
2715
- export declare enum InitialExpandedItems {
2716
- /** First item will be expended initally */
2717
- FIRST = "FIRST",
2718
- /** All items will expended initally */
2719
- ALL = "ALL",
2720
- /** All items collapsed initally */
2721
- NONE = "NONE"
2722
- }
2723
- /** @enumType */
2724
- export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
2725
- export declare enum Direction {
2726
- /** Left-to-right */
2727
- LTR = "LTR",
2728
- /** Right-to-left */
2729
- RTL = "RTL"
2730
- }
2731
- /** @enumType */
2732
- export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
2733
- export interface TableData {
2734
- /** Styling for the table's container. */
2735
- containerData?: PluginContainerData;
2736
- /** The table's dimensions. */
2737
- dimensions?: Dimensions;
2738
- /**
2739
- * Deprecated: Use `rowHeader` and `columnHeader` instead.
2740
- * @deprecated
2741
- */
2742
- header?: boolean | null;
2743
- /** Sets whether the table's first row is a header. Defaults to `false`. */
2744
- rowHeader?: boolean | null;
2745
- /** Sets whether the table's first column is a header. Defaults to `false`. */
2746
- columnHeader?: boolean | null;
2747
- }
2748
- export interface Dimensions {
2749
- /** An array representing relative width of each column in relation to the other columns. */
2750
- colsWidthRatio?: number[];
2751
- /** An array representing the height of each row in pixels. */
2752
- rowsHeight?: number[];
2753
- /** An array representing the minimum width of each column in pixels. */
2754
- colsMinWidth?: number[];
2755
- }
2756
- export interface TableCellData {
2757
- /** Styling for the cell's background color and text alignment. */
2758
- cellStyle?: CellStyle;
2759
- /** The cell's border colors. */
2760
- borderColors?: BorderColors;
2761
- }
2762
- export declare enum VerticalAlignment {
2763
- /** Top alignment */
2764
- TOP = "TOP",
2765
- /** Middle alignment */
2766
- MIDDLE = "MIDDLE",
2767
- /** Bottom alignment */
2768
- BOTTOM = "BOTTOM"
2769
- }
2770
- /** @enumType */
2771
- export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
2772
- export interface CellStyle {
2773
- /** Vertical alignment for the cell's text. */
2774
- verticalAlignment?: VerticalAlignmentWithLiterals;
2775
- /**
2776
- * Cell background color as a hexadecimal value.
2777
- * @format COLOR_HEX
2778
- */
2779
- backgroundColor?: string | null;
2780
- }
2781
- export interface BorderColors {
2782
- /**
2783
- * Left border color as a hexadecimal value.
2784
- * @format COLOR_HEX
2785
- */
2786
- left?: string | null;
2787
- /**
2788
- * Right border color as a hexadecimal value.
2789
- * @format COLOR_HEX
2790
- */
2791
- right?: string | null;
2792
- /**
2793
- * Top border color as a hexadecimal value.
2794
- * @format COLOR_HEX
2795
- */
2796
- top?: string | null;
2797
- /**
2798
- * Bottom border color as a hexadecimal value.
2799
- * @format COLOR_HEX
2800
- */
2801
- bottom?: string | null;
2802
- }
2803
- /**
2804
- * `NullValue` is a singleton enumeration to represent the null value for the
2805
- * `Value` type union.
2806
- *
2807
- * The JSON representation for `NullValue` is JSON `null`.
2808
- */
2809
- export declare enum NullValue {
2810
- /** Null value. */
2811
- NULL_VALUE = "NULL_VALUE"
2812
- }
2813
- /** @enumType */
2814
- export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
2815
- /**
2816
- * `ListValue` is a wrapper around a repeated field of values.
2817
- *
2818
- * The JSON representation for `ListValue` is JSON array.
2819
- */
2820
- export interface ListValue {
2821
- /** Repeated field of dynamically typed values. */
2822
- values?: any[];
2823
- }
2824
- export interface AudioData {
2825
- /** Styling for the audio node's container. */
2826
- containerData?: PluginContainerData;
2827
- /** Audio file details. */
2828
- audio?: Media;
2829
- /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
2830
- disableDownload?: boolean | null;
2831
- /** Cover image. */
2832
- coverImage?: Media;
2833
- /** Track name. */
2834
- name?: string | null;
2835
- /** Author name. */
2836
- authorName?: string | null;
2837
- /** An HTML version of the audio node. */
2838
- html?: string | null;
2839
- }
2840
- export interface OrderedListData {
2841
- /** Indentation level from 0-4. */
2842
- indentation?: number;
2843
- /** Offset level from 0-4. */
2844
- offset?: number | null;
2845
- /** List start number. */
2846
- start?: number | null;
2847
- }
2848
- export interface BulletedListData {
2849
- /** Indentation level from 0-4. */
2850
- indentation?: number;
2851
- /** Offset level from 0-4. */
2852
- offset?: number | null;
2853
- }
2854
- export interface BlockquoteData {
2855
- /** Indentation level from 1-4. */
2856
- indentation?: number;
2857
- }
2858
- export interface CaptionData {
2859
- textStyle?: TextStyle;
2860
- }
2861
- export interface LayoutCellData {
2862
- /** Size of the cell in 12 columns grid. */
2863
- colSpan?: number | null;
2864
- }
2865
- export interface Metadata {
2866
- /** Schema version. */
2867
- version?: number;
2868
- /**
2869
- * When the object was created.
2870
- * @readonly
2871
- * @deprecated
2872
- */
2873
- createdTimestamp?: Date | null;
2874
- /**
2875
- * When the object was most recently updated.
2876
- * @deprecated
2877
- */
2878
- updatedTimestamp?: Date | null;
2879
- /** Object ID. */
2880
- id?: string | null;
2881
- }
2882
- export interface DocumentStyle {
2883
- /** Styling for H1 nodes. */
2884
- headerOne?: TextNodeStyle;
2885
- /** Styling for H2 nodes. */
2886
- headerTwo?: TextNodeStyle;
2887
- /** Styling for H3 nodes. */
2888
- headerThree?: TextNodeStyle;
2889
- /** Styling for H4 nodes. */
2890
- headerFour?: TextNodeStyle;
2891
- /** Styling for H5 nodes. */
2892
- headerFive?: TextNodeStyle;
2893
- /** Styling for H6 nodes. */
2894
- headerSix?: TextNodeStyle;
2895
- /** Styling for paragraph nodes. */
2896
- paragraph?: TextNodeStyle;
2897
- /** Styling for block quote nodes. */
2898
- blockquote?: TextNodeStyle;
2899
- /** Styling for code block nodes. */
2900
- codeBlock?: TextNodeStyle;
2901
- }
2902
- export interface TextNodeStyle {
2903
- /** The decorations to apply to the node. */
2904
- decorations?: Decoration[];
2905
- /** Padding and background color for the node. */
2906
- nodeStyle?: NodeStyle;
2907
- /** Line height for text in the node. */
2908
- lineHeight?: string | null;
2909
- }
2910
- export interface Badge {
2911
- /** Badge type. */
2912
- type?: TypeWithLiterals;
2913
- /**
2914
- * Badge text.
2915
- * @maxLength 50
2916
- */
2917
- text?: string | null;
2918
- }
2919
- export declare enum Type {
2920
- /** Unknown badge type. */
2921
- UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
2922
- /** 1st priority badge type. */
2923
- FIRST_PRIORITY = "FIRST_PRIORITY",
2924
- /** 2nd priority badge type. */
2925
- SECOND_PRIORITY = "SECOND_PRIORITY",
2926
- /** 3rd priority badge type. */
2927
- THIRD_PRIORITY = "THIRD_PRIORITY"
2928
- }
2929
- /** @enumType */
2930
- export type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
2931
- export interface DiscardDraftRequest {
2932
- /**
2933
- * Event ID to which the form belongs.
2934
- * @format GUID
2935
- */
2936
- eventId: string;
2937
- }
2938
- export interface DiscardDraftResponse {
2939
- }
2940
- export interface DomainEvent extends DomainEventBodyOneOf {
2941
- createdEvent?: EntityCreatedEvent;
2942
- updatedEvent?: EntityUpdatedEvent;
2943
- deletedEvent?: EntityDeletedEvent;
2944
- actionEvent?: ActionEvent;
2945
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2946
- id?: string;
2947
- /**
2948
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2949
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2950
- */
2951
- entityFqdn?: string;
2952
- /**
2953
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2954
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2955
- */
2956
- slug?: string;
2957
- /** ID of the entity associated with the event. */
2958
- entityId?: string;
2959
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2960
- eventTime?: Date | null;
2961
- /**
2962
- * Whether the event was triggered as a result of a privacy regulation application
2963
- * (for example, GDPR).
2964
- */
2965
- triggeredByAnonymizeRequest?: boolean | null;
2966
- /** If present, indicates the action that triggered the event. */
2967
- originatedFrom?: string | null;
2968
- /**
2969
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2970
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2971
- */
2972
- entityEventSequence?: string | null;
2973
- }
2974
- /** @oneof */
2975
- export interface DomainEventBodyOneOf {
2976
- createdEvent?: EntityCreatedEvent;
2977
- updatedEvent?: EntityUpdatedEvent;
2978
- deletedEvent?: EntityDeletedEvent;
2979
- actionEvent?: ActionEvent;
2980
- }
2981
- export interface EntityCreatedEvent {
2982
- entityAsJson?: string;
2983
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2984
- restoreInfo?: RestoreInfo;
2985
- }
2986
- export interface RestoreInfo {
2987
- deletedDate?: Date | null;
2988
- }
2989
- export interface EntityUpdatedEvent {
2990
- /**
2991
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2992
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2993
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2994
- */
2995
- currentEntityAsJson?: string;
2996
- }
2997
- export interface EntityDeletedEvent {
2998
- /** Entity that was deleted. */
2999
- deletedEntityAsJson?: string | null;
3000
- }
3001
- export interface ActionEvent {
3002
- bodyAsJson?: string;
3003
- }
3004
- export interface MessageEnvelope {
3005
- /**
3006
- * App instance ID.
3007
- * @format GUID
3008
- */
3009
- instanceId?: string | null;
3010
- /**
3011
- * Event type.
3012
- * @maxLength 150
3013
- */
3014
- eventType?: string;
3015
- /** The identification type and identity data. */
3016
- identity?: IdentificationData;
3017
- /** Stringify payload. */
3018
- data?: string;
3019
- }
3020
- export interface IdentificationData extends IdentificationDataIdOneOf {
3021
- /**
3022
- * ID of a site visitor that has not logged in to the site.
3023
- * @format GUID
3024
- */
3025
- anonymousVisitorId?: string;
3026
- /**
3027
- * ID of a site visitor that has logged in to the site.
3028
- * @format GUID
3029
- */
3030
- memberId?: string;
3031
- /**
3032
- * ID of a Wix user (site owner, contributor, etc.).
3033
- * @format GUID
3034
- */
3035
- wixUserId?: string;
3036
- /**
3037
- * ID of an app.
3038
- * @format GUID
3039
- */
3040
- appId?: string;
3041
- /** @readonly */
3042
- identityType?: WebhookIdentityTypeWithLiterals;
3043
- }
3044
- /** @oneof */
3045
- export interface IdentificationDataIdOneOf {
3046
- /**
3047
- * ID of a site visitor that has not logged in to the site.
3048
- * @format GUID
3049
- */
3050
- anonymousVisitorId?: string;
3051
- /**
3052
- * ID of a site visitor that has logged in to the site.
3053
- * @format GUID
3054
- */
3055
- memberId?: string;
3056
- /**
3057
- * ID of a Wix user (site owner, contributor, etc.).
3058
- * @format GUID
3059
- */
3060
- wixUserId?: string;
3061
- /**
3062
- * ID of an app.
3063
- * @format GUID
3064
- */
3065
- appId?: string;
3066
- }
3067
- export declare enum WebhookIdentityType {
3068
- UNKNOWN = "UNKNOWN",
3069
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3070
- MEMBER = "MEMBER",
3071
- WIX_USER = "WIX_USER",
3072
- APP = "APP"
3073
- }
3074
- /** @enumType */
3075
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';