@wix/auto_sdk_forms_forms 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/forms-v4-form-forms.context.d.ts +22 -0
- package/build/cjs/src/forms-v4-form-forms.context.js +100 -0
- package/build/cjs/src/forms-v4-form-forms.context.js.map +1 -0
- package/build/cjs/src/forms-v4-form-forms.http.d.ts +49 -0
- package/build/cjs/src/forms-v4-form-forms.http.js +38289 -0
- package/build/cjs/src/forms-v4-form-forms.http.js.map +1 -0
- package/build/cjs/src/forms-v4-form-forms.meta.d.ts +48 -0
- package/build/cjs/src/forms-v4-form-forms.meta.js +370 -0
- package/build/cjs/src/forms-v4-form-forms.meta.js.map +1 -0
- package/build/cjs/src/forms-v4-form-forms.public.d.ts +155 -0
- package/build/cjs/src/forms-v4-form-forms.public.js +190 -0
- package/build/cjs/src/forms-v4-form-forms.public.js.map +1 -0
- package/build/cjs/src/forms-v4-form-forms.types.d.ts +4638 -0
- package/build/cjs/src/forms-v4-form-forms.types.js +717 -0
- package/build/cjs/src/forms-v4-form-forms.types.js.map +1 -0
- package/build/cjs/src/forms-v4-form-forms.universal.d.ts +5085 -0
- package/build/cjs/src/forms-v4-form-forms.universal.js +1812 -0
- package/build/cjs/src/forms-v4-form-forms.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/forms-v4-form-forms.context.d.ts +22 -0
- package/build/es/src/forms-v4-form-forms.context.js +22 -0
- package/build/es/src/forms-v4-form-forms.context.js.map +1 -0
- package/build/es/src/forms-v4-form-forms.http.d.ts +49 -0
- package/build/es/src/forms-v4-form-forms.http.js +38268 -0
- package/build/es/src/forms-v4-form-forms.http.js.map +1 -0
- package/build/es/src/forms-v4-form-forms.meta.d.ts +48 -0
- package/build/es/src/forms-v4-form-forms.meta.js +326 -0
- package/build/es/src/forms-v4-form-forms.meta.js.map +1 -0
- package/build/es/src/forms-v4-form-forms.public.d.ts +155 -0
- package/build/es/src/forms-v4-form-forms.public.js +94 -0
- package/build/es/src/forms-v4-form-forms.public.js.map +1 -0
- package/build/es/src/forms-v4-form-forms.types.d.ts +4638 -0
- package/build/es/src/forms-v4-form-forms.types.js +713 -0
- package/build/es/src/forms-v4-form-forms.types.js.map +1 -0
- package/build/es/src/forms-v4-form-forms.universal.d.ts +5085 -0
- package/build/es/src/forms-v4-form-forms.universal.js +1767 -0
- package/build/es/src/forms-v4-form-forms.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/forms-v4-form-forms.context.d.ts +22 -0
- package/build/internal/cjs/src/forms-v4-form-forms.context.js +100 -0
- package/build/internal/cjs/src/forms-v4-form-forms.context.js.map +1 -0
- package/build/internal/cjs/src/forms-v4-form-forms.http.d.ts +49 -0
- package/build/internal/cjs/src/forms-v4-form-forms.http.js +38289 -0
- package/build/internal/cjs/src/forms-v4-form-forms.http.js.map +1 -0
- package/build/internal/cjs/src/forms-v4-form-forms.meta.d.ts +48 -0
- package/build/internal/cjs/src/forms-v4-form-forms.meta.js +370 -0
- package/build/internal/cjs/src/forms-v4-form-forms.meta.js.map +1 -0
- package/build/internal/cjs/src/forms-v4-form-forms.public.d.ts +155 -0
- package/build/internal/cjs/src/forms-v4-form-forms.public.js +190 -0
- package/build/internal/cjs/src/forms-v4-form-forms.public.js.map +1 -0
- package/build/internal/cjs/src/forms-v4-form-forms.types.d.ts +4638 -0
- package/build/internal/cjs/src/forms-v4-form-forms.types.js +717 -0
- package/build/internal/cjs/src/forms-v4-form-forms.types.js.map +1 -0
- package/build/internal/cjs/src/forms-v4-form-forms.universal.d.ts +5085 -0
- package/build/internal/cjs/src/forms-v4-form-forms.universal.js +1812 -0
- package/build/internal/cjs/src/forms-v4-form-forms.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/forms-v4-form-forms.context.d.ts +22 -0
- package/build/internal/es/src/forms-v4-form-forms.context.js +22 -0
- package/build/internal/es/src/forms-v4-form-forms.context.js.map +1 -0
- package/build/internal/es/src/forms-v4-form-forms.http.d.ts +49 -0
- package/build/internal/es/src/forms-v4-form-forms.http.js +38268 -0
- package/build/internal/es/src/forms-v4-form-forms.http.js.map +1 -0
- package/build/internal/es/src/forms-v4-form-forms.meta.d.ts +48 -0
- package/build/internal/es/src/forms-v4-form-forms.meta.js +326 -0
- package/build/internal/es/src/forms-v4-form-forms.meta.js.map +1 -0
- package/build/internal/es/src/forms-v4-form-forms.public.d.ts +155 -0
- package/build/internal/es/src/forms-v4-form-forms.public.js +94 -0
- package/build/internal/es/src/forms-v4-form-forms.public.js.map +1 -0
- package/build/internal/es/src/forms-v4-form-forms.types.d.ts +4638 -0
- package/build/internal/es/src/forms-v4-form-forms.types.js +713 -0
- package/build/internal/es/src/forms-v4-form-forms.types.js.map +1 -0
- package/build/internal/es/src/forms-v4-form-forms.universal.d.ts +5085 -0
- package/build/internal/es/src/forms-v4-form-forms.universal.js +1767 -0
- package/build/internal/es/src/forms-v4-form-forms.universal.js.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +52 -0
|
@@ -0,0 +1,4638 @@
|
|
|
1
|
+
export interface Form {
|
|
2
|
+
/**
|
|
3
|
+
* Form ID.
|
|
4
|
+
* @readonly
|
|
5
|
+
*/
|
|
6
|
+
id?: string | null;
|
|
7
|
+
/**
|
|
8
|
+
* List of form fields that represent input elements.
|
|
9
|
+
* @readonly
|
|
10
|
+
*/
|
|
11
|
+
fieldsV2?: FormFieldV2[];
|
|
12
|
+
/** Defines the layout for form fields in each submission step. */
|
|
13
|
+
steps?: Step[];
|
|
14
|
+
/** Form rules, can be applied to layout and items properties. */
|
|
15
|
+
rules?: FormRule[];
|
|
16
|
+
/**
|
|
17
|
+
* Represents the current state of an item. Each time the item is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.
|
|
18
|
+
* @readonly
|
|
19
|
+
*/
|
|
20
|
+
revision?: string | null;
|
|
21
|
+
/**
|
|
22
|
+
* Date of creation.
|
|
23
|
+
* @readonly
|
|
24
|
+
*/
|
|
25
|
+
createdDate?: Date | null;
|
|
26
|
+
/**
|
|
27
|
+
* Date of last update.
|
|
28
|
+
* @readonly
|
|
29
|
+
*/
|
|
30
|
+
updatedDate?: Date | null;
|
|
31
|
+
/** Properties of the form. */
|
|
32
|
+
properties?: FormProperties;
|
|
33
|
+
/**
|
|
34
|
+
* Fields which were soft deleted.
|
|
35
|
+
* @readonly
|
|
36
|
+
*/
|
|
37
|
+
deletedFields?: FormField[];
|
|
38
|
+
/**
|
|
39
|
+
* List of form fields that represent input elements.
|
|
40
|
+
* @readonly
|
|
41
|
+
*/
|
|
42
|
+
deletedFieldsV2?: FormFieldV2[];
|
|
43
|
+
/** Data extensions ExtendedFields. */
|
|
44
|
+
extendedFields?: ExtendedFields;
|
|
45
|
+
/** Identifies the namespace that the form belongs to. */
|
|
46
|
+
namespace?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Media folder ID.
|
|
49
|
+
* @readonly
|
|
50
|
+
*/
|
|
51
|
+
mediaFolderId?: string | null;
|
|
52
|
+
/** Rules that limit submissions on this form. */
|
|
53
|
+
limitationRule?: LimitationRule;
|
|
54
|
+
/**
|
|
55
|
+
* Spam filter protection level.
|
|
56
|
+
* Default: ADVANCED.
|
|
57
|
+
*/
|
|
58
|
+
spamFilterProtectionLevel?: SpamFilterProtectionLevel;
|
|
59
|
+
/** Required indicator properties. */
|
|
60
|
+
requiredIndicatorProperties?: RequiredIndicatorProperties;
|
|
61
|
+
/** Settings for actions to be taken after form submission. */
|
|
62
|
+
submitSettings?: SubmitSettings;
|
|
63
|
+
/** Settings for field groups */
|
|
64
|
+
fieldGroups?: FieldGroup[];
|
|
65
|
+
/** Message shown when the form is disabled */
|
|
66
|
+
disabledFormMessage?: RichContent;
|
|
67
|
+
/**
|
|
68
|
+
* Identifies if the form is disabled.
|
|
69
|
+
* Default true
|
|
70
|
+
*/
|
|
71
|
+
enabled?: boolean | null;
|
|
72
|
+
}
|
|
73
|
+
export declare enum RequiredIndicator {
|
|
74
|
+
/** Unknown required indicator. */
|
|
75
|
+
UNKNOWN_INDICATOR = "UNKNOWN_INDICATOR",
|
|
76
|
+
/** Asterisk (*). */
|
|
77
|
+
ASTERISK = "ASTERISK",
|
|
78
|
+
/** Text (default: "Required"). */
|
|
79
|
+
TEXT = "TEXT",
|
|
80
|
+
/** None. */
|
|
81
|
+
NONE = "NONE"
|
|
82
|
+
}
|
|
83
|
+
export declare enum RequiredIndicatorPlacement {
|
|
84
|
+
/** Unknown required indicator placement. */
|
|
85
|
+
UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
|
|
86
|
+
/** After field title. */
|
|
87
|
+
AFTER_FIELD_TITLE = "AFTER_FIELD_TITLE",
|
|
88
|
+
/** Before field title. */
|
|
89
|
+
BEFORE_FIELD_TITLE = "BEFORE_FIELD_TITLE"
|
|
90
|
+
}
|
|
91
|
+
export interface FormField {
|
|
92
|
+
/** Item ID. */
|
|
93
|
+
id?: string;
|
|
94
|
+
/** Definition of a target where the value of field belongs. */
|
|
95
|
+
target?: string | null;
|
|
96
|
+
/** Validation of field output value. */
|
|
97
|
+
validation?: Validation;
|
|
98
|
+
/** Mark the field as containing personal information. This will encrypt user data when storing it. */
|
|
99
|
+
pii?: boolean;
|
|
100
|
+
/** Whether the field is hidden. */
|
|
101
|
+
hidden?: boolean;
|
|
102
|
+
/** Field view properties. */
|
|
103
|
+
view?: Record<string, any> | null;
|
|
104
|
+
/** Details identifying field, which is extension of other entity */
|
|
105
|
+
dataExtensionsDetails?: DataExtensionsDetails;
|
|
106
|
+
/**
|
|
107
|
+
* Whether the field is read only.
|
|
108
|
+
* Default: false
|
|
109
|
+
*/
|
|
110
|
+
readOnly?: boolean;
|
|
111
|
+
}
|
|
112
|
+
export interface StringType extends StringTypeFormatOptionsOneOf {
|
|
113
|
+
/** DATE format options */
|
|
114
|
+
dateOptions?: DateTimeConstraints;
|
|
115
|
+
/** DATE_TIME format options */
|
|
116
|
+
dateTimeOptions?: DateTimeConstraints;
|
|
117
|
+
/** TIME format options */
|
|
118
|
+
timeOptions?: DateTimeConstraints;
|
|
119
|
+
/** DATE_OPTIONAL_TIME format options */
|
|
120
|
+
dateOptionalTimeOptions?: DateTimeConstraints;
|
|
121
|
+
/** PHONE format options */
|
|
122
|
+
phoneOptions?: PhoneConstraints;
|
|
123
|
+
/** Minimum length. */
|
|
124
|
+
minLength?: number | null;
|
|
125
|
+
/** Maximum length. */
|
|
126
|
+
maxLength?: number | null;
|
|
127
|
+
/** Pattern for a regular expression match. */
|
|
128
|
+
pattern?: string | null;
|
|
129
|
+
/** Format of a string. */
|
|
130
|
+
format?: FormatEnumFormat;
|
|
131
|
+
/** Custom error messages when validation fails. */
|
|
132
|
+
errorMessages?: StringErrorMessages;
|
|
133
|
+
/** List of allowed values. */
|
|
134
|
+
enum?: string[] | null;
|
|
135
|
+
}
|
|
136
|
+
/** @oneof */
|
|
137
|
+
export interface StringTypeFormatOptionsOneOf {
|
|
138
|
+
/** DATE format options */
|
|
139
|
+
dateOptions?: DateTimeConstraints;
|
|
140
|
+
/** DATE_TIME format options */
|
|
141
|
+
dateTimeOptions?: DateTimeConstraints;
|
|
142
|
+
/** TIME format options */
|
|
143
|
+
timeOptions?: DateTimeConstraints;
|
|
144
|
+
/** DATE_OPTIONAL_TIME format options */
|
|
145
|
+
dateOptionalTimeOptions?: DateTimeConstraints;
|
|
146
|
+
/** PHONE format options */
|
|
147
|
+
phoneOptions?: PhoneConstraints;
|
|
148
|
+
}
|
|
149
|
+
export declare enum FormatEnumFormat {
|
|
150
|
+
UNDEFINED = "UNDEFINED",
|
|
151
|
+
DATE = "DATE",
|
|
152
|
+
TIME = "TIME",
|
|
153
|
+
DATE_TIME = "DATE_TIME",
|
|
154
|
+
EMAIL = "EMAIL",
|
|
155
|
+
URL = "URL",
|
|
156
|
+
UUID = "UUID",
|
|
157
|
+
PHONE = "PHONE",
|
|
158
|
+
URI = "URI",
|
|
159
|
+
HOSTNAME = "HOSTNAME",
|
|
160
|
+
COLOR_HEX = "COLOR_HEX",
|
|
161
|
+
CURRENCY = "CURRENCY",
|
|
162
|
+
LANGUAGE = "LANGUAGE",
|
|
163
|
+
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
164
|
+
}
|
|
165
|
+
export interface StringErrorMessages {
|
|
166
|
+
/** Default error message on invalid validation. */
|
|
167
|
+
default?: string | null;
|
|
168
|
+
}
|
|
169
|
+
export interface DateTimeConstraints {
|
|
170
|
+
/**
|
|
171
|
+
* Support static constrains defined as ISO date/time format, as well as
|
|
172
|
+
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
173
|
+
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
174
|
+
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
175
|
+
*/
|
|
176
|
+
minimum?: string | null;
|
|
177
|
+
/**
|
|
178
|
+
* Support static constrains defined as ISO date/time format, as well as
|
|
179
|
+
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
180
|
+
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
181
|
+
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
182
|
+
*/
|
|
183
|
+
maximum?: string | null;
|
|
184
|
+
}
|
|
185
|
+
export interface PhoneConstraints {
|
|
186
|
+
/** Country codes for phone number that are allowed */
|
|
187
|
+
allowedCountryCodes?: string[];
|
|
188
|
+
}
|
|
189
|
+
export interface NumberType {
|
|
190
|
+
/** Inclusive maximum value. */
|
|
191
|
+
maximum?: number | null;
|
|
192
|
+
/** Inclusive minimum value. */
|
|
193
|
+
minimum?: number | null;
|
|
194
|
+
/** Multiple of value. */
|
|
195
|
+
multipleOf?: number | null;
|
|
196
|
+
/** Custom error message when validation fails. */
|
|
197
|
+
errorMessages?: NumberErrorMessages;
|
|
198
|
+
/** List of allowed values. */
|
|
199
|
+
enum?: number[] | null;
|
|
200
|
+
}
|
|
201
|
+
export interface NumberErrorMessages {
|
|
202
|
+
/** Default error message on invalid validation. */
|
|
203
|
+
default?: string | null;
|
|
204
|
+
}
|
|
205
|
+
export interface IntegerType {
|
|
206
|
+
/** Minimum value. */
|
|
207
|
+
maximum?: number | null;
|
|
208
|
+
/** Maximum value. */
|
|
209
|
+
minimum?: number | null;
|
|
210
|
+
/** Multiple of value. */
|
|
211
|
+
multipleOf?: number | null;
|
|
212
|
+
/** Custom error message when validation fails. */
|
|
213
|
+
errorMessages?: NumberErrorMessages;
|
|
214
|
+
/** List of allowed values. */
|
|
215
|
+
enum?: number[] | null;
|
|
216
|
+
}
|
|
217
|
+
export interface BooleanType {
|
|
218
|
+
/** Custom error message when validation fails. */
|
|
219
|
+
errorMessages?: BooleanErrorMessages;
|
|
220
|
+
/** List of allowed values. */
|
|
221
|
+
enum?: boolean[];
|
|
222
|
+
}
|
|
223
|
+
export interface BooleanErrorMessages {
|
|
224
|
+
/** Default error message on invalid validation. */
|
|
225
|
+
default?: string | null;
|
|
226
|
+
}
|
|
227
|
+
export interface ArrayType {
|
|
228
|
+
/** Maximum amount of array elements. */
|
|
229
|
+
maxItems?: number | null;
|
|
230
|
+
/** Minimum amount of array elements. */
|
|
231
|
+
minItems?: number | null;
|
|
232
|
+
/** Type of items allowed in array. */
|
|
233
|
+
items?: ArrayItems;
|
|
234
|
+
/** Custom error message when validation fails. */
|
|
235
|
+
errorMessages?: ArrayErrorMessages;
|
|
236
|
+
}
|
|
237
|
+
export interface ObjectType {
|
|
238
|
+
/** Description of object properties. */
|
|
239
|
+
properties?: Record<string, PropertiesType>;
|
|
240
|
+
/** Custom error message when validation fails. */
|
|
241
|
+
errorMessages?: ObjectErrorMessages;
|
|
242
|
+
}
|
|
243
|
+
export interface PropertiesType extends PropertiesTypePropertiesTypeOneOf {
|
|
244
|
+
/** String type validation for property. */
|
|
245
|
+
string?: StringType;
|
|
246
|
+
/** Number type validation for property. */
|
|
247
|
+
number?: NumberType;
|
|
248
|
+
/** Boolean type validation for property. */
|
|
249
|
+
boolean?: BooleanType;
|
|
250
|
+
/** Integer type validation for property. */
|
|
251
|
+
integer?: IntegerType;
|
|
252
|
+
/** Array type validation for property. */
|
|
253
|
+
array?: ArrayType;
|
|
254
|
+
/** Whether the property is required. */
|
|
255
|
+
required?: boolean;
|
|
256
|
+
}
|
|
257
|
+
/** @oneof */
|
|
258
|
+
export interface PropertiesTypePropertiesTypeOneOf {
|
|
259
|
+
/** String type validation for property. */
|
|
260
|
+
string?: StringType;
|
|
261
|
+
/** Number type validation for property. */
|
|
262
|
+
number?: NumberType;
|
|
263
|
+
/** Boolean type validation for property. */
|
|
264
|
+
boolean?: BooleanType;
|
|
265
|
+
/** Integer type validation for property. */
|
|
266
|
+
integer?: IntegerType;
|
|
267
|
+
/** Array type validation for property. */
|
|
268
|
+
array?: ArrayType;
|
|
269
|
+
}
|
|
270
|
+
export interface ObjectErrorMessages {
|
|
271
|
+
/** Default error message on invalid validation. */
|
|
272
|
+
default?: string | null;
|
|
273
|
+
}
|
|
274
|
+
export interface ArrayItems extends ArrayItemsItemsOneOf {
|
|
275
|
+
/** String type validation for items. */
|
|
276
|
+
string?: StringType;
|
|
277
|
+
/** Number type validation for items. */
|
|
278
|
+
number?: NumberType;
|
|
279
|
+
/** Boolean type validation for items. */
|
|
280
|
+
boolean?: BooleanType;
|
|
281
|
+
/** Integer type validation for items. */
|
|
282
|
+
integer?: IntegerType;
|
|
283
|
+
/** Object type validation for items */
|
|
284
|
+
object?: ObjectType;
|
|
285
|
+
}
|
|
286
|
+
/** @oneof */
|
|
287
|
+
export interface ArrayItemsItemsOneOf {
|
|
288
|
+
/** String type validation for items. */
|
|
289
|
+
string?: StringType;
|
|
290
|
+
/** Number type validation for items. */
|
|
291
|
+
number?: NumberType;
|
|
292
|
+
/** Boolean type validation for items. */
|
|
293
|
+
boolean?: BooleanType;
|
|
294
|
+
/** Integer type validation for items. */
|
|
295
|
+
integer?: IntegerType;
|
|
296
|
+
/** Object type validation for items */
|
|
297
|
+
object?: ObjectType;
|
|
298
|
+
}
|
|
299
|
+
export interface ArrayErrorMessages {
|
|
300
|
+
/** Default error message on invalid validation. */
|
|
301
|
+
default?: string | null;
|
|
302
|
+
}
|
|
303
|
+
export interface PredefinedValidation extends PredefinedValidationFormatOptionsOneOf {
|
|
304
|
+
/** Payment input field. */
|
|
305
|
+
paymentOptions?: PaymentType;
|
|
306
|
+
/** Multiline address validation. */
|
|
307
|
+
multilineAddressOptions?: MultilineAddressValidation;
|
|
308
|
+
/** Format of predefined validation. */
|
|
309
|
+
format?: ValidationFormat;
|
|
310
|
+
}
|
|
311
|
+
/** @oneof */
|
|
312
|
+
export interface PredefinedValidationFormatOptionsOneOf {
|
|
313
|
+
/** Payment input field. */
|
|
314
|
+
paymentOptions?: PaymentType;
|
|
315
|
+
/** Multiline address validation. */
|
|
316
|
+
multilineAddressOptions?: MultilineAddressValidation;
|
|
317
|
+
}
|
|
318
|
+
export declare enum ValidationFormat {
|
|
319
|
+
UNDEFINED = "UNDEFINED",
|
|
320
|
+
/** File upload validation. */
|
|
321
|
+
WIX_FILE = "WIX_FILE",
|
|
322
|
+
/** Payment validation. */
|
|
323
|
+
PAYMENT = "PAYMENT",
|
|
324
|
+
/** Multiline address. */
|
|
325
|
+
MULTILINE_ADDRESS = "MULTILINE_ADDRESS",
|
|
326
|
+
/** Scheduling validation. */
|
|
327
|
+
SCHEDULING = "SCHEDULING"
|
|
328
|
+
}
|
|
329
|
+
export interface PaymentType {
|
|
330
|
+
/** Field mapped to products. */
|
|
331
|
+
products?: Product[];
|
|
332
|
+
/** Minimum amount of different products. */
|
|
333
|
+
minItems?: number | null;
|
|
334
|
+
/** Maximum amount of different products. */
|
|
335
|
+
maxItems?: number | null;
|
|
336
|
+
}
|
|
337
|
+
export declare enum ProductType {
|
|
338
|
+
/** Unknown product type. */
|
|
339
|
+
UNKNOWN = "UNKNOWN",
|
|
340
|
+
/** Shippable (physical) product. */
|
|
341
|
+
SHIPPABLE = "SHIPPABLE",
|
|
342
|
+
/** Digital product. */
|
|
343
|
+
DIGITAL = "DIGITAL"
|
|
344
|
+
}
|
|
345
|
+
export declare enum PriceType {
|
|
346
|
+
/** Unknown price type. */
|
|
347
|
+
UNKNOWN = "UNKNOWN",
|
|
348
|
+
/** Fixed price. */
|
|
349
|
+
FIXED_PRICE = "FIXED_PRICE",
|
|
350
|
+
/** Dynamic price from price range. */
|
|
351
|
+
DYNAMIC_PRICE = "DYNAMIC_PRICE"
|
|
352
|
+
}
|
|
353
|
+
export interface QuantityLimit {
|
|
354
|
+
/** Minimum quantity. */
|
|
355
|
+
minimum?: number | null;
|
|
356
|
+
/** Maximum quantity. */
|
|
357
|
+
maximum?: number | null;
|
|
358
|
+
}
|
|
359
|
+
export interface FixedPriceOptions {
|
|
360
|
+
/** Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */
|
|
361
|
+
price?: string;
|
|
362
|
+
}
|
|
363
|
+
export interface DynamicPriceOptions {
|
|
364
|
+
/** Minimal price monetary amount. */
|
|
365
|
+
minPrice?: string;
|
|
366
|
+
/** Maximal price monetary amount. */
|
|
367
|
+
maxPrice?: string | null;
|
|
368
|
+
}
|
|
369
|
+
export interface Product extends ProductPriceOptionsOneOf {
|
|
370
|
+
/** Fixed price options. */
|
|
371
|
+
fixedPriceOptions?: FixedPriceOptions;
|
|
372
|
+
/** Dynamic price options. */
|
|
373
|
+
dynamicPriceOptions?: DynamicPriceOptions;
|
|
374
|
+
/**
|
|
375
|
+
* Product ID.
|
|
376
|
+
* @readonly
|
|
377
|
+
*/
|
|
378
|
+
id?: string;
|
|
379
|
+
/** Product type. */
|
|
380
|
+
productType?: ProductType;
|
|
381
|
+
/** Price type. */
|
|
382
|
+
priceType?: PriceType;
|
|
383
|
+
/** Quantity limit. */
|
|
384
|
+
quantityLimit?: QuantityLimit;
|
|
385
|
+
}
|
|
386
|
+
/** @oneof */
|
|
387
|
+
export interface ProductPriceOptionsOneOf {
|
|
388
|
+
/** Fixed price options. */
|
|
389
|
+
fixedPriceOptions?: FixedPriceOptions;
|
|
390
|
+
/** Dynamic price options. */
|
|
391
|
+
dynamicPriceOptions?: DynamicPriceOptions;
|
|
392
|
+
}
|
|
393
|
+
export interface MultilineAddressValidation {
|
|
394
|
+
/** Allowed countries. No countries treated as all. */
|
|
395
|
+
allowedCountries?: string[];
|
|
396
|
+
/** Fields overrides. */
|
|
397
|
+
fields?: FieldsOverrides;
|
|
398
|
+
}
|
|
399
|
+
export interface FieldOverrides {
|
|
400
|
+
/** Whether the field is required. */
|
|
401
|
+
required?: boolean;
|
|
402
|
+
}
|
|
403
|
+
export interface FieldsOverrides {
|
|
404
|
+
/** Subdivision. */
|
|
405
|
+
subdivision?: FieldOverrides;
|
|
406
|
+
/** City. */
|
|
407
|
+
city?: FieldOverrides;
|
|
408
|
+
/** Postal code. */
|
|
409
|
+
postalCode?: FieldOverrides;
|
|
410
|
+
/** Street name. */
|
|
411
|
+
streetName?: FieldOverrides;
|
|
412
|
+
/** Street number. */
|
|
413
|
+
streetNumber?: FieldOverrides;
|
|
414
|
+
/** Address line. */
|
|
415
|
+
addressLine?: FieldOverrides;
|
|
416
|
+
/** Address line 2. */
|
|
417
|
+
addressLine2?: FieldOverrides;
|
|
418
|
+
/** Country. */
|
|
419
|
+
country?: FieldOverrides;
|
|
420
|
+
}
|
|
421
|
+
export interface NestedFormFieldOverrides {
|
|
422
|
+
/** Whether the field is required. Leave blank for no override. */
|
|
423
|
+
required?: boolean | null;
|
|
424
|
+
/** Whether the field is hidden. Leave blank for no override. */
|
|
425
|
+
hidden?: boolean | null;
|
|
426
|
+
}
|
|
427
|
+
export interface Validation extends ValidationValidationOneOf {
|
|
428
|
+
/** Validation of string type. */
|
|
429
|
+
string?: StringType;
|
|
430
|
+
/** Validation of number type. */
|
|
431
|
+
number?: NumberType;
|
|
432
|
+
/** Validation of integer type. */
|
|
433
|
+
integer?: IntegerType;
|
|
434
|
+
/** Validation of boolean type. */
|
|
435
|
+
boolean?: BooleanType;
|
|
436
|
+
/** Validation of array type. */
|
|
437
|
+
array?: ArrayType;
|
|
438
|
+
/** Validation of object type. */
|
|
439
|
+
object?: ObjectType;
|
|
440
|
+
/** Predefined validation of specific format */
|
|
441
|
+
predefined?: PredefinedValidation;
|
|
442
|
+
/** Whether the field is required. */
|
|
443
|
+
required?: boolean;
|
|
444
|
+
}
|
|
445
|
+
/** @oneof */
|
|
446
|
+
export interface ValidationValidationOneOf {
|
|
447
|
+
/** Validation of string type. */
|
|
448
|
+
string?: StringType;
|
|
449
|
+
/** Validation of number type. */
|
|
450
|
+
number?: NumberType;
|
|
451
|
+
/** Validation of integer type. */
|
|
452
|
+
integer?: IntegerType;
|
|
453
|
+
/** Validation of boolean type. */
|
|
454
|
+
boolean?: BooleanType;
|
|
455
|
+
/** Validation of array type. */
|
|
456
|
+
array?: ArrayType;
|
|
457
|
+
/** Validation of object type. */
|
|
458
|
+
object?: ObjectType;
|
|
459
|
+
/** Predefined validation of specific format */
|
|
460
|
+
predefined?: PredefinedValidation;
|
|
461
|
+
}
|
|
462
|
+
export interface DataExtensionsDetails {
|
|
463
|
+
/** FQDNS which can be extended with this field */
|
|
464
|
+
fqdns?: string[];
|
|
465
|
+
}
|
|
466
|
+
export interface NestedFormOverrides {
|
|
467
|
+
/** Field overrides by field ID */
|
|
468
|
+
fieldOverrides?: Record<string, NestedFormFieldOverrides>;
|
|
469
|
+
}
|
|
470
|
+
export interface FormFieldV2 extends FormFieldV2FieldTypeOptionsOneOf {
|
|
471
|
+
/** Field accept input of data */
|
|
472
|
+
inputOptions?: InputField;
|
|
473
|
+
/** Field for displaying information such as header or text paragraph */
|
|
474
|
+
displayOptions?: DisplayField;
|
|
475
|
+
/** Field id. */
|
|
476
|
+
id?: string;
|
|
477
|
+
/**
|
|
478
|
+
* Whether the field is hidden.
|
|
479
|
+
* Default: false
|
|
480
|
+
*/
|
|
481
|
+
hidden?: boolean;
|
|
482
|
+
/**
|
|
483
|
+
* Type of the field
|
|
484
|
+
* @readonly
|
|
485
|
+
*/
|
|
486
|
+
fieldType?: FieldType;
|
|
487
|
+
}
|
|
488
|
+
/** @oneof */
|
|
489
|
+
export interface FormFieldV2FieldTypeOptionsOneOf {
|
|
490
|
+
/** Field accept input of data */
|
|
491
|
+
inputOptions?: InputField;
|
|
492
|
+
/** Field for displaying information such as header or text paragraph */
|
|
493
|
+
displayOptions?: DisplayField;
|
|
494
|
+
}
|
|
495
|
+
export interface InputFieldStringType extends InputFieldStringTypeFormatOptionsOneOf {
|
|
496
|
+
/** DATE format options */
|
|
497
|
+
dateOptions?: StringTypeDateTimeConstraints;
|
|
498
|
+
/** DATE_TIME format options */
|
|
499
|
+
dateTimeOptions?: StringTypeDateTimeConstraints;
|
|
500
|
+
/** TIME format options */
|
|
501
|
+
timeOptions?: StringTypeDateTimeConstraints;
|
|
502
|
+
/** DATE_OPTIONAL_TIME format options */
|
|
503
|
+
dateOptionalTimeOptions?: StringTypeDateTimeConstraints;
|
|
504
|
+
/** PHONE format options */
|
|
505
|
+
phoneOptions?: StringTypePhoneConstraints;
|
|
506
|
+
/** Minimum length. */
|
|
507
|
+
minLength?: number | null;
|
|
508
|
+
/** Maximum length. */
|
|
509
|
+
maxLength?: number | null;
|
|
510
|
+
/** Pattern for a regular expression match. */
|
|
511
|
+
pattern?: string | null;
|
|
512
|
+
/** Format of a string. */
|
|
513
|
+
format?: StringTypeFormatEnumFormat;
|
|
514
|
+
/** Custom error messages when validation fails. */
|
|
515
|
+
errorMessages?: InputFieldStringErrorMessages;
|
|
516
|
+
/** List of allowed values. */
|
|
517
|
+
enum?: string[] | null;
|
|
518
|
+
}
|
|
519
|
+
/** @oneof */
|
|
520
|
+
export interface InputFieldStringTypeFormatOptionsOneOf {
|
|
521
|
+
/** DATE format options */
|
|
522
|
+
dateOptions?: StringTypeDateTimeConstraints;
|
|
523
|
+
/** DATE_TIME format options */
|
|
524
|
+
dateTimeOptions?: StringTypeDateTimeConstraints;
|
|
525
|
+
/** TIME format options */
|
|
526
|
+
timeOptions?: StringTypeDateTimeConstraints;
|
|
527
|
+
/** DATE_OPTIONAL_TIME format options */
|
|
528
|
+
dateOptionalTimeOptions?: StringTypeDateTimeConstraints;
|
|
529
|
+
/** PHONE format options */
|
|
530
|
+
phoneOptions?: StringTypePhoneConstraints;
|
|
531
|
+
}
|
|
532
|
+
export declare enum StringTypeFormatEnumFormat {
|
|
533
|
+
UNDEFINED = "UNDEFINED",
|
|
534
|
+
DATE = "DATE",
|
|
535
|
+
TIME = "TIME",
|
|
536
|
+
DATE_TIME = "DATE_TIME",
|
|
537
|
+
EMAIL = "EMAIL",
|
|
538
|
+
URL = "URL",
|
|
539
|
+
UUID = "UUID",
|
|
540
|
+
PHONE = "PHONE",
|
|
541
|
+
URI = "URI",
|
|
542
|
+
HOSTNAME = "HOSTNAME",
|
|
543
|
+
COLOR_HEX = "COLOR_HEX",
|
|
544
|
+
CURRENCY = "CURRENCY",
|
|
545
|
+
LANGUAGE = "LANGUAGE",
|
|
546
|
+
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
547
|
+
}
|
|
548
|
+
export interface InputFieldStringErrorMessages {
|
|
549
|
+
/** Default error message on invalid validation. */
|
|
550
|
+
default?: string | null;
|
|
551
|
+
}
|
|
552
|
+
export interface StringTypeDateTimeConstraints {
|
|
553
|
+
/**
|
|
554
|
+
* Support static constrains defined as ISO date/time format, as well as
|
|
555
|
+
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
556
|
+
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
557
|
+
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
558
|
+
*/
|
|
559
|
+
minimum?: string | null;
|
|
560
|
+
/**
|
|
561
|
+
* Support static constrains defined as ISO date/time format, as well as
|
|
562
|
+
* dynamic calculations can be performed using special keywords such as "$now" to represent the current date and time.
|
|
563
|
+
* The dynamic calculation supports expressions like "$now+2d" (2 days in the future), "$now-1h" (1 hour in the past), etc.
|
|
564
|
+
* The regex pattern for dynamic calculations is: \$now([+-]\d{1,2})([yMdmh])
|
|
565
|
+
*/
|
|
566
|
+
maximum?: string | null;
|
|
567
|
+
}
|
|
568
|
+
export interface StringTypePhoneConstraints {
|
|
569
|
+
/** Country codes for phone number that are allowed */
|
|
570
|
+
allowedCountryCodes?: string[];
|
|
571
|
+
}
|
|
572
|
+
export declare enum StringComponentType {
|
|
573
|
+
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
574
|
+
TEXT_INPUT = "TEXT_INPUT",
|
|
575
|
+
RADIO_GROUP = "RADIO_GROUP",
|
|
576
|
+
DROPDOWN = "DROPDOWN",
|
|
577
|
+
DATE_TIME = "DATE_TIME",
|
|
578
|
+
PHONE_INPUT = "PHONE_INPUT",
|
|
579
|
+
DATE_INPUT = "DATE_INPUT",
|
|
580
|
+
TIME_INPUT = "TIME_INPUT",
|
|
581
|
+
DATE_PICKER = "DATE_PICKER"
|
|
582
|
+
}
|
|
583
|
+
export interface TextInput {
|
|
584
|
+
/** Label of the field */
|
|
585
|
+
label?: string | null;
|
|
586
|
+
/** Description of the field */
|
|
587
|
+
description?: RichContent;
|
|
588
|
+
/** Placeholder for the value input */
|
|
589
|
+
placeholder?: string | null;
|
|
590
|
+
/**
|
|
591
|
+
* Flag identifying to hide or not label
|
|
592
|
+
* Default: true
|
|
593
|
+
*/
|
|
594
|
+
showLabel?: boolean | null;
|
|
595
|
+
/** Default value for the text input */
|
|
596
|
+
default?: string | null;
|
|
597
|
+
}
|
|
598
|
+
export interface RichContent {
|
|
599
|
+
/** Node objects representing a rich content document. */
|
|
600
|
+
nodes?: Node[];
|
|
601
|
+
/** Object metadata. */
|
|
602
|
+
metadata?: Metadata;
|
|
603
|
+
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
604
|
+
documentStyle?: DocumentStyle;
|
|
605
|
+
}
|
|
606
|
+
export interface Node extends NodeDataOneOf {
|
|
607
|
+
/** Data for a button node. */
|
|
608
|
+
buttonData?: ButtonData;
|
|
609
|
+
/** Data for a code block node. */
|
|
610
|
+
codeBlockData?: CodeBlockData;
|
|
611
|
+
/** Data for a divider node. */
|
|
612
|
+
dividerData?: DividerData;
|
|
613
|
+
/** Data for a file node. */
|
|
614
|
+
fileData?: FileData;
|
|
615
|
+
/** Data for a gallery node. */
|
|
616
|
+
galleryData?: GalleryData;
|
|
617
|
+
/** Data for a GIF node. */
|
|
618
|
+
gifData?: GIFData;
|
|
619
|
+
/** Data for a heading node. */
|
|
620
|
+
headingData?: HeadingData;
|
|
621
|
+
/** Data for an embedded HTML node. */
|
|
622
|
+
htmlData?: HTMLData;
|
|
623
|
+
/** Data for an image node. */
|
|
624
|
+
imageData?: ImageData;
|
|
625
|
+
/** Data for a link preview node. */
|
|
626
|
+
linkPreviewData?: LinkPreviewData;
|
|
627
|
+
/** @deprecated */
|
|
628
|
+
mapData?: MapData;
|
|
629
|
+
/** Data for a paragraph node. */
|
|
630
|
+
paragraphData?: ParagraphData;
|
|
631
|
+
/** Data for a poll node. */
|
|
632
|
+
pollData?: PollData;
|
|
633
|
+
/** Data for a text node. Used to apply decorations to text. */
|
|
634
|
+
textData?: TextData;
|
|
635
|
+
/** Data for an app embed node. */
|
|
636
|
+
appEmbedData?: AppEmbedData;
|
|
637
|
+
/** Data for a video node. */
|
|
638
|
+
videoData?: VideoData;
|
|
639
|
+
/** Data for an oEmbed node. */
|
|
640
|
+
embedData?: EmbedData;
|
|
641
|
+
/** Data for a collapsible list node. */
|
|
642
|
+
collapsibleListData?: CollapsibleListData;
|
|
643
|
+
/** Data for a table node. */
|
|
644
|
+
tableData?: TableData;
|
|
645
|
+
/** Data for a table cell node. */
|
|
646
|
+
tableCellData?: TableCellData;
|
|
647
|
+
/** Data for a custom external node. */
|
|
648
|
+
externalData?: Record<string, any> | null;
|
|
649
|
+
/** Data for an audio node. */
|
|
650
|
+
audioData?: AudioData;
|
|
651
|
+
/** Data for an ordered list node. */
|
|
652
|
+
orderedListData?: OrderedListData;
|
|
653
|
+
/** Data for a bulleted list node. */
|
|
654
|
+
bulletedListData?: BulletedListData;
|
|
655
|
+
/** Data for a block quote node. */
|
|
656
|
+
blockquoteData?: BlockquoteData;
|
|
657
|
+
/** Data for a caption node. */
|
|
658
|
+
captionData?: CaptionData;
|
|
659
|
+
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
660
|
+
layoutCellData?: LayoutCellData;
|
|
661
|
+
/** 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. */
|
|
662
|
+
type?: NodeType;
|
|
663
|
+
/** Node ID. */
|
|
664
|
+
id?: string;
|
|
665
|
+
/** A list of child nodes. */
|
|
666
|
+
nodes?: Node[];
|
|
667
|
+
/** Padding and background color styling for the node. */
|
|
668
|
+
style?: NodeStyle;
|
|
669
|
+
}
|
|
670
|
+
/** @oneof */
|
|
671
|
+
export interface NodeDataOneOf {
|
|
672
|
+
/** Data for a button node. */
|
|
673
|
+
buttonData?: ButtonData;
|
|
674
|
+
/** Data for a code block node. */
|
|
675
|
+
codeBlockData?: CodeBlockData;
|
|
676
|
+
/** Data for a divider node. */
|
|
677
|
+
dividerData?: DividerData;
|
|
678
|
+
/** Data for a file node. */
|
|
679
|
+
fileData?: FileData;
|
|
680
|
+
/** Data for a gallery node. */
|
|
681
|
+
galleryData?: GalleryData;
|
|
682
|
+
/** Data for a GIF node. */
|
|
683
|
+
gifData?: GIFData;
|
|
684
|
+
/** Data for a heading node. */
|
|
685
|
+
headingData?: HeadingData;
|
|
686
|
+
/** Data for an embedded HTML node. */
|
|
687
|
+
htmlData?: HTMLData;
|
|
688
|
+
/** Data for an image node. */
|
|
689
|
+
imageData?: ImageData;
|
|
690
|
+
/** Data for a link preview node. */
|
|
691
|
+
linkPreviewData?: LinkPreviewData;
|
|
692
|
+
/** @deprecated */
|
|
693
|
+
mapData?: MapData;
|
|
694
|
+
/** Data for a paragraph node. */
|
|
695
|
+
paragraphData?: ParagraphData;
|
|
696
|
+
/** Data for a poll node. */
|
|
697
|
+
pollData?: PollData;
|
|
698
|
+
/** Data for a text node. Used to apply decorations to text. */
|
|
699
|
+
textData?: TextData;
|
|
700
|
+
/** Data for an app embed node. */
|
|
701
|
+
appEmbedData?: AppEmbedData;
|
|
702
|
+
/** Data for a video node. */
|
|
703
|
+
videoData?: VideoData;
|
|
704
|
+
/** Data for an oEmbed node. */
|
|
705
|
+
embedData?: EmbedData;
|
|
706
|
+
/** Data for a collapsible list node. */
|
|
707
|
+
collapsibleListData?: CollapsibleListData;
|
|
708
|
+
/** Data for a table node. */
|
|
709
|
+
tableData?: TableData;
|
|
710
|
+
/** Data for a table cell node. */
|
|
711
|
+
tableCellData?: TableCellData;
|
|
712
|
+
/** Data for a custom external node. */
|
|
713
|
+
externalData?: Record<string, any> | null;
|
|
714
|
+
/** Data for an audio node. */
|
|
715
|
+
audioData?: AudioData;
|
|
716
|
+
/** Data for an ordered list node. */
|
|
717
|
+
orderedListData?: OrderedListData;
|
|
718
|
+
/** Data for a bulleted list node. */
|
|
719
|
+
bulletedListData?: BulletedListData;
|
|
720
|
+
/** Data for a block quote node. */
|
|
721
|
+
blockquoteData?: BlockquoteData;
|
|
722
|
+
/** Data for a caption node. */
|
|
723
|
+
captionData?: CaptionData;
|
|
724
|
+
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
725
|
+
layoutCellData?: LayoutCellData;
|
|
726
|
+
}
|
|
727
|
+
export declare enum NodeType {
|
|
728
|
+
PARAGRAPH = "PARAGRAPH",
|
|
729
|
+
TEXT = "TEXT",
|
|
730
|
+
HEADING = "HEADING",
|
|
731
|
+
BULLETED_LIST = "BULLETED_LIST",
|
|
732
|
+
ORDERED_LIST = "ORDERED_LIST",
|
|
733
|
+
LIST_ITEM = "LIST_ITEM",
|
|
734
|
+
BLOCKQUOTE = "BLOCKQUOTE",
|
|
735
|
+
CODE_BLOCK = "CODE_BLOCK",
|
|
736
|
+
VIDEO = "VIDEO",
|
|
737
|
+
DIVIDER = "DIVIDER",
|
|
738
|
+
FILE = "FILE",
|
|
739
|
+
GALLERY = "GALLERY",
|
|
740
|
+
GIF = "GIF",
|
|
741
|
+
HTML = "HTML",
|
|
742
|
+
IMAGE = "IMAGE",
|
|
743
|
+
LINK_PREVIEW = "LINK_PREVIEW",
|
|
744
|
+
/** @deprecated */
|
|
745
|
+
MAP = "MAP",
|
|
746
|
+
POLL = "POLL",
|
|
747
|
+
APP_EMBED = "APP_EMBED",
|
|
748
|
+
BUTTON = "BUTTON",
|
|
749
|
+
COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
|
|
750
|
+
TABLE = "TABLE",
|
|
751
|
+
EMBED = "EMBED",
|
|
752
|
+
COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
|
|
753
|
+
COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
|
|
754
|
+
COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
|
|
755
|
+
TABLE_CELL = "TABLE_CELL",
|
|
756
|
+
TABLE_ROW = "TABLE_ROW",
|
|
757
|
+
EXTERNAL = "EXTERNAL",
|
|
758
|
+
AUDIO = "AUDIO",
|
|
759
|
+
CAPTION = "CAPTION",
|
|
760
|
+
LAYOUT = "LAYOUT",
|
|
761
|
+
LAYOUT_CELL = "LAYOUT_CELL"
|
|
762
|
+
}
|
|
763
|
+
export interface NodeStyle {
|
|
764
|
+
/** The top padding value in pixels. */
|
|
765
|
+
paddingTop?: string | null;
|
|
766
|
+
/** The bottom padding value in pixels. */
|
|
767
|
+
paddingBottom?: string | null;
|
|
768
|
+
/** The background color as a hexadecimal value. */
|
|
769
|
+
backgroundColor?: string | null;
|
|
770
|
+
}
|
|
771
|
+
export interface ButtonData {
|
|
772
|
+
/** Styling for the button's container. */
|
|
773
|
+
containerData?: PluginContainerData;
|
|
774
|
+
/** The button type. */
|
|
775
|
+
type?: ButtonDataType;
|
|
776
|
+
/** Styling for the button. */
|
|
777
|
+
styles?: Styles;
|
|
778
|
+
/** The text to display on the button. */
|
|
779
|
+
text?: string | null;
|
|
780
|
+
/** Button link details. */
|
|
781
|
+
link?: Link;
|
|
782
|
+
}
|
|
783
|
+
export interface Border {
|
|
784
|
+
/** Border width in pixels. */
|
|
785
|
+
width?: number | null;
|
|
786
|
+
/** Border radius in pixels. */
|
|
787
|
+
radius?: number | null;
|
|
788
|
+
}
|
|
789
|
+
export interface Colors {
|
|
790
|
+
/** The text color as a hexadecimal value. */
|
|
791
|
+
text?: string | null;
|
|
792
|
+
/** The border color as a hexadecimal value. */
|
|
793
|
+
border?: string | null;
|
|
794
|
+
/** The background color as a hexadecimal value. */
|
|
795
|
+
background?: string | null;
|
|
796
|
+
}
|
|
797
|
+
export interface PluginContainerData {
|
|
798
|
+
/** The width of the node when it's displayed. */
|
|
799
|
+
width?: PluginContainerDataWidth;
|
|
800
|
+
/** The node's alignment within its container. */
|
|
801
|
+
alignment?: PluginContainerDataAlignment;
|
|
802
|
+
/** Spoiler cover settings for the node. */
|
|
803
|
+
spoiler?: Spoiler;
|
|
804
|
+
/** The height of the node when it's displayed. */
|
|
805
|
+
height?: Height;
|
|
806
|
+
/** 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`. */
|
|
807
|
+
textWrap?: boolean | null;
|
|
808
|
+
}
|
|
809
|
+
export declare enum WidthType {
|
|
810
|
+
/** Width matches the content width */
|
|
811
|
+
CONTENT = "CONTENT",
|
|
812
|
+
/** Small Width */
|
|
813
|
+
SMALL = "SMALL",
|
|
814
|
+
/** Width will match the original asset width */
|
|
815
|
+
ORIGINAL = "ORIGINAL",
|
|
816
|
+
/** coast-to-coast display */
|
|
817
|
+
FULL_WIDTH = "FULL_WIDTH"
|
|
818
|
+
}
|
|
819
|
+
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
820
|
+
/**
|
|
821
|
+
* One of the following predefined width options:
|
|
822
|
+
* `CONTENT`: The width of the container matches the content width.
|
|
823
|
+
* `SMALL`: A small width.
|
|
824
|
+
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
825
|
+
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
826
|
+
*/
|
|
827
|
+
size?: WidthType;
|
|
828
|
+
/** A custom width value in pixels. */
|
|
829
|
+
custom?: string | null;
|
|
830
|
+
}
|
|
831
|
+
/** @oneof */
|
|
832
|
+
export interface PluginContainerDataWidthDataOneOf {
|
|
833
|
+
/**
|
|
834
|
+
* One of the following predefined width options:
|
|
835
|
+
* `CONTENT`: The width of the container matches the content width.
|
|
836
|
+
* `SMALL`: A small width.
|
|
837
|
+
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
838
|
+
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
839
|
+
*/
|
|
840
|
+
size?: WidthType;
|
|
841
|
+
/** A custom width value in pixels. */
|
|
842
|
+
custom?: string | null;
|
|
843
|
+
}
|
|
844
|
+
export declare enum PluginContainerDataAlignment {
|
|
845
|
+
/** Center Alignment */
|
|
846
|
+
CENTER = "CENTER",
|
|
847
|
+
/** Left Alignment */
|
|
848
|
+
LEFT = "LEFT",
|
|
849
|
+
/** Right Alignment */
|
|
850
|
+
RIGHT = "RIGHT"
|
|
851
|
+
}
|
|
852
|
+
export interface Spoiler {
|
|
853
|
+
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
854
|
+
enabled?: boolean | null;
|
|
855
|
+
/** The description displayed on top of the spoiler cover. */
|
|
856
|
+
description?: string | null;
|
|
857
|
+
/** The text for the button used to remove the spoiler cover. */
|
|
858
|
+
buttonText?: string | null;
|
|
859
|
+
}
|
|
860
|
+
export interface Height {
|
|
861
|
+
/** A custom height value in pixels. */
|
|
862
|
+
custom?: string | null;
|
|
863
|
+
}
|
|
864
|
+
export declare enum ButtonDataType {
|
|
865
|
+
/** Regular link button */
|
|
866
|
+
LINK = "LINK",
|
|
867
|
+
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
868
|
+
ACTION = "ACTION"
|
|
869
|
+
}
|
|
870
|
+
export interface Styles {
|
|
871
|
+
/** Border attributes. */
|
|
872
|
+
border?: Border;
|
|
873
|
+
/** Color attributes. */
|
|
874
|
+
colors?: Colors;
|
|
875
|
+
}
|
|
876
|
+
export interface Link extends LinkDataOneOf {
|
|
877
|
+
/** The absolute URL for the linked document. */
|
|
878
|
+
url?: string;
|
|
879
|
+
/** The target node's ID. Used for linking to another node in this object. */
|
|
880
|
+
anchor?: string;
|
|
881
|
+
/**
|
|
882
|
+
* he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
|
|
883
|
+
* `SELF` - Default. Opens the linked document in the same frame as the link.
|
|
884
|
+
* `BLANK` - Opens the linked document in a new browser tab or window.
|
|
885
|
+
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
886
|
+
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
887
|
+
*/
|
|
888
|
+
target?: LinkTarget;
|
|
889
|
+
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
890
|
+
rel?: Rel;
|
|
891
|
+
/** A serialized object used for a custom or external link panel. */
|
|
892
|
+
customData?: string | null;
|
|
893
|
+
}
|
|
894
|
+
/** @oneof */
|
|
895
|
+
export interface LinkDataOneOf {
|
|
896
|
+
/** The absolute URL for the linked document. */
|
|
897
|
+
url?: string;
|
|
898
|
+
/** The target node's ID. Used for linking to another node in this object. */
|
|
899
|
+
anchor?: string;
|
|
900
|
+
}
|
|
901
|
+
export declare enum LinkTarget {
|
|
902
|
+
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
903
|
+
SELF = "SELF",
|
|
904
|
+
/** Opens the linked document in a new window or tab */
|
|
905
|
+
BLANK = "BLANK",
|
|
906
|
+
/** Opens the linked document in the parent frame */
|
|
907
|
+
PARENT = "PARENT",
|
|
908
|
+
/** Opens the linked document in the full body of the window */
|
|
909
|
+
TOP = "TOP"
|
|
910
|
+
}
|
|
911
|
+
export interface Rel {
|
|
912
|
+
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
913
|
+
nofollow?: boolean | null;
|
|
914
|
+
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
915
|
+
sponsored?: boolean | null;
|
|
916
|
+
/** 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`. */
|
|
917
|
+
ugc?: boolean | null;
|
|
918
|
+
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
919
|
+
noreferrer?: boolean | null;
|
|
920
|
+
}
|
|
921
|
+
export interface CodeBlockData {
|
|
922
|
+
/** Styling for the code block's text. */
|
|
923
|
+
textStyle?: TextStyle;
|
|
924
|
+
}
|
|
925
|
+
export interface TextStyle {
|
|
926
|
+
/** Text alignment. Defaults to `AUTO`. */
|
|
927
|
+
textAlignment?: TextAlignment;
|
|
928
|
+
/** 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. */
|
|
929
|
+
lineHeight?: string | null;
|
|
930
|
+
}
|
|
931
|
+
export declare enum TextAlignment {
|
|
932
|
+
/** browser default, eqivalent to `initial` */
|
|
933
|
+
AUTO = "AUTO",
|
|
934
|
+
/** Left align */
|
|
935
|
+
LEFT = "LEFT",
|
|
936
|
+
/** Right align */
|
|
937
|
+
RIGHT = "RIGHT",
|
|
938
|
+
/** Center align */
|
|
939
|
+
CENTER = "CENTER",
|
|
940
|
+
/** 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 */
|
|
941
|
+
JUSTIFY = "JUSTIFY"
|
|
942
|
+
}
|
|
943
|
+
export interface DividerData {
|
|
944
|
+
/** Styling for the divider's container. */
|
|
945
|
+
containerData?: PluginContainerData;
|
|
946
|
+
/** Divider line style. */
|
|
947
|
+
lineStyle?: LineStyle;
|
|
948
|
+
/** Divider width. */
|
|
949
|
+
width?: Width;
|
|
950
|
+
/** Divider alignment. */
|
|
951
|
+
alignment?: Alignment;
|
|
952
|
+
}
|
|
953
|
+
export declare enum LineStyle {
|
|
954
|
+
/** Single Line */
|
|
955
|
+
SINGLE = "SINGLE",
|
|
956
|
+
/** Double Line */
|
|
957
|
+
DOUBLE = "DOUBLE",
|
|
958
|
+
/** Dashed Line */
|
|
959
|
+
DASHED = "DASHED",
|
|
960
|
+
/** Dotted Line */
|
|
961
|
+
DOTTED = "DOTTED"
|
|
962
|
+
}
|
|
963
|
+
export declare enum Width {
|
|
964
|
+
/** Large line */
|
|
965
|
+
LARGE = "LARGE",
|
|
966
|
+
/** Medium line */
|
|
967
|
+
MEDIUM = "MEDIUM",
|
|
968
|
+
/** Small line */
|
|
969
|
+
SMALL = "SMALL"
|
|
970
|
+
}
|
|
971
|
+
export declare enum Alignment {
|
|
972
|
+
/** Center alignment */
|
|
973
|
+
CENTER = "CENTER",
|
|
974
|
+
/** Left alignment */
|
|
975
|
+
LEFT = "LEFT",
|
|
976
|
+
/** Right alignment */
|
|
977
|
+
RIGHT = "RIGHT"
|
|
978
|
+
}
|
|
979
|
+
export interface FileData {
|
|
980
|
+
/** Styling for the file's container. */
|
|
981
|
+
containerData?: PluginContainerData;
|
|
982
|
+
/** The source for the file's data. */
|
|
983
|
+
src?: FileSource;
|
|
984
|
+
/** File name. */
|
|
985
|
+
name?: string | null;
|
|
986
|
+
/** File type. */
|
|
987
|
+
type?: string | null;
|
|
988
|
+
/**
|
|
989
|
+
* Use `sizeInKb` instead.
|
|
990
|
+
* @deprecated
|
|
991
|
+
*/
|
|
992
|
+
size?: number | null;
|
|
993
|
+
/** Settings for PDF files. */
|
|
994
|
+
pdfSettings?: PDFSettings;
|
|
995
|
+
/** File MIME type. */
|
|
996
|
+
mimeType?: string | null;
|
|
997
|
+
/** File path. */
|
|
998
|
+
path?: string | null;
|
|
999
|
+
/** File size in KB. */
|
|
1000
|
+
sizeInKb?: string | null;
|
|
1001
|
+
}
|
|
1002
|
+
export declare enum ViewMode {
|
|
1003
|
+
/** No PDF view */
|
|
1004
|
+
NONE = "NONE",
|
|
1005
|
+
/** Full PDF view */
|
|
1006
|
+
FULL = "FULL",
|
|
1007
|
+
/** Mini PDF view */
|
|
1008
|
+
MINI = "MINI"
|
|
1009
|
+
}
|
|
1010
|
+
export interface FileSource extends FileSourceDataOneOf {
|
|
1011
|
+
/** The absolute URL for the file's source. */
|
|
1012
|
+
url?: string | null;
|
|
1013
|
+
/**
|
|
1014
|
+
* Custom ID. Use `id` instead.
|
|
1015
|
+
* @deprecated
|
|
1016
|
+
*/
|
|
1017
|
+
custom?: string | null;
|
|
1018
|
+
/** An ID that's resolved to a URL by a resolver function. */
|
|
1019
|
+
id?: string | null;
|
|
1020
|
+
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
1021
|
+
private?: boolean | null;
|
|
1022
|
+
}
|
|
1023
|
+
/** @oneof */
|
|
1024
|
+
export interface FileSourceDataOneOf {
|
|
1025
|
+
/** The absolute URL for the file's source. */
|
|
1026
|
+
url?: string | null;
|
|
1027
|
+
/**
|
|
1028
|
+
* Custom ID. Use `id` instead.
|
|
1029
|
+
* @deprecated
|
|
1030
|
+
*/
|
|
1031
|
+
custom?: string | null;
|
|
1032
|
+
/** An ID that's resolved to a URL by a resolver function. */
|
|
1033
|
+
id?: string | null;
|
|
1034
|
+
}
|
|
1035
|
+
export interface PDFSettings {
|
|
1036
|
+
/**
|
|
1037
|
+
* PDF view mode. One of the following:
|
|
1038
|
+
* `NONE` : The PDF isn't displayed.
|
|
1039
|
+
* `FULL` : A full page view of the PDF is displayed.
|
|
1040
|
+
* `MINI` : A mini view of the PDF is displayed.
|
|
1041
|
+
*/
|
|
1042
|
+
viewMode?: ViewMode;
|
|
1043
|
+
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
1044
|
+
disableDownload?: boolean | null;
|
|
1045
|
+
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1046
|
+
disablePrint?: boolean | null;
|
|
1047
|
+
}
|
|
1048
|
+
export interface GalleryData {
|
|
1049
|
+
/** Styling for the gallery's container. */
|
|
1050
|
+
containerData?: PluginContainerData;
|
|
1051
|
+
/** The items in the gallery. */
|
|
1052
|
+
items?: Item[];
|
|
1053
|
+
/** Options for defining the gallery's appearance. */
|
|
1054
|
+
options?: GalleryOptions;
|
|
1055
|
+
/** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
|
|
1056
|
+
disableExpand?: boolean | null;
|
|
1057
|
+
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1058
|
+
disableDownload?: boolean | null;
|
|
1059
|
+
}
|
|
1060
|
+
export interface Media {
|
|
1061
|
+
/** The source for the media's data. */
|
|
1062
|
+
src?: FileSource;
|
|
1063
|
+
/** Media width in pixels. */
|
|
1064
|
+
width?: number | null;
|
|
1065
|
+
/** Media height in pixels. */
|
|
1066
|
+
height?: number | null;
|
|
1067
|
+
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1068
|
+
duration?: number | null;
|
|
1069
|
+
}
|
|
1070
|
+
export interface ItemImage {
|
|
1071
|
+
/** Image file details. */
|
|
1072
|
+
media?: Media;
|
|
1073
|
+
/** Link details for images that are links. */
|
|
1074
|
+
link?: Link;
|
|
1075
|
+
}
|
|
1076
|
+
export interface Video {
|
|
1077
|
+
/** Video file details. */
|
|
1078
|
+
media?: Media;
|
|
1079
|
+
/** Video thumbnail file details. */
|
|
1080
|
+
thumbnail?: Media;
|
|
1081
|
+
}
|
|
1082
|
+
export interface Item extends ItemDataOneOf {
|
|
1083
|
+
/** An image item. */
|
|
1084
|
+
image?: ItemImage;
|
|
1085
|
+
/** A video item. */
|
|
1086
|
+
video?: Video;
|
|
1087
|
+
/** Item title. */
|
|
1088
|
+
title?: string | null;
|
|
1089
|
+
/** Item's alternative text. */
|
|
1090
|
+
altText?: string | null;
|
|
1091
|
+
}
|
|
1092
|
+
/** @oneof */
|
|
1093
|
+
export interface ItemDataOneOf {
|
|
1094
|
+
/** An image item. */
|
|
1095
|
+
image?: ItemImage;
|
|
1096
|
+
/** A video item. */
|
|
1097
|
+
video?: Video;
|
|
1098
|
+
}
|
|
1099
|
+
export interface GalleryOptions {
|
|
1100
|
+
/** Gallery layout. */
|
|
1101
|
+
layout?: Layout;
|
|
1102
|
+
/** Styling for gallery items. */
|
|
1103
|
+
item?: ItemStyle;
|
|
1104
|
+
/** Styling for gallery thumbnail images. */
|
|
1105
|
+
thumbnails?: Thumbnails;
|
|
1106
|
+
}
|
|
1107
|
+
export declare enum LayoutType {
|
|
1108
|
+
/** Collage type */
|
|
1109
|
+
COLLAGE = "COLLAGE",
|
|
1110
|
+
/** Masonry type */
|
|
1111
|
+
MASONRY = "MASONRY",
|
|
1112
|
+
/** Grid type */
|
|
1113
|
+
GRID = "GRID",
|
|
1114
|
+
/** Thumbnail type */
|
|
1115
|
+
THUMBNAIL = "THUMBNAIL",
|
|
1116
|
+
/** Slider type */
|
|
1117
|
+
SLIDER = "SLIDER",
|
|
1118
|
+
/** Slideshow type */
|
|
1119
|
+
SLIDESHOW = "SLIDESHOW",
|
|
1120
|
+
/** Panorama type */
|
|
1121
|
+
PANORAMA = "PANORAMA",
|
|
1122
|
+
/** Column type */
|
|
1123
|
+
COLUMN = "COLUMN",
|
|
1124
|
+
/** Magic type */
|
|
1125
|
+
MAGIC = "MAGIC",
|
|
1126
|
+
/** Fullsize images type */
|
|
1127
|
+
FULLSIZE = "FULLSIZE"
|
|
1128
|
+
}
|
|
1129
|
+
export declare enum Orientation {
|
|
1130
|
+
/** Rows Orientation */
|
|
1131
|
+
ROWS = "ROWS",
|
|
1132
|
+
/** Columns Orientation */
|
|
1133
|
+
COLUMNS = "COLUMNS"
|
|
1134
|
+
}
|
|
1135
|
+
export declare enum Crop {
|
|
1136
|
+
/** Crop to fill */
|
|
1137
|
+
FILL = "FILL",
|
|
1138
|
+
/** Crop to fit */
|
|
1139
|
+
FIT = "FIT"
|
|
1140
|
+
}
|
|
1141
|
+
export declare enum ThumbnailsAlignment {
|
|
1142
|
+
/** Top alignment */
|
|
1143
|
+
TOP = "TOP",
|
|
1144
|
+
/** Right alignment */
|
|
1145
|
+
RIGHT = "RIGHT",
|
|
1146
|
+
/** Bottom alignment */
|
|
1147
|
+
BOTTOM = "BOTTOM",
|
|
1148
|
+
/** Left alignment */
|
|
1149
|
+
LEFT = "LEFT",
|
|
1150
|
+
/** No thumbnail */
|
|
1151
|
+
NONE = "NONE"
|
|
1152
|
+
}
|
|
1153
|
+
export interface Layout {
|
|
1154
|
+
/** Gallery layout type. */
|
|
1155
|
+
type?: LayoutType;
|
|
1156
|
+
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
1157
|
+
horizontalScroll?: boolean | null;
|
|
1158
|
+
/** Gallery orientation. */
|
|
1159
|
+
orientation?: Orientation;
|
|
1160
|
+
/** The number of columns to display on full size screens. */
|
|
1161
|
+
numberOfColumns?: number | null;
|
|
1162
|
+
/** The number of columns to display on mobile screens. */
|
|
1163
|
+
mobileNumberOfColumns?: number | null;
|
|
1164
|
+
}
|
|
1165
|
+
export interface ItemStyle {
|
|
1166
|
+
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
1167
|
+
targetSize?: number | null;
|
|
1168
|
+
/** Item ratio */
|
|
1169
|
+
ratio?: number | null;
|
|
1170
|
+
/** Sets how item images are cropped. */
|
|
1171
|
+
crop?: Crop;
|
|
1172
|
+
/** The spacing between items in pixels. */
|
|
1173
|
+
spacing?: number | null;
|
|
1174
|
+
}
|
|
1175
|
+
export interface Thumbnails {
|
|
1176
|
+
/** Thumbnail alignment. */
|
|
1177
|
+
placement?: ThumbnailsAlignment;
|
|
1178
|
+
/** Spacing between thumbnails in pixels. */
|
|
1179
|
+
spacing?: number | null;
|
|
1180
|
+
}
|
|
1181
|
+
export interface GIFData {
|
|
1182
|
+
/** Styling for the GIF's container. */
|
|
1183
|
+
containerData?: PluginContainerData;
|
|
1184
|
+
/** The source of the full size GIF. */
|
|
1185
|
+
original?: GIF;
|
|
1186
|
+
/** The source of the downsized GIF. */
|
|
1187
|
+
downsized?: GIF;
|
|
1188
|
+
/** Height in pixels. */
|
|
1189
|
+
height?: number;
|
|
1190
|
+
/** Width in pixels. */
|
|
1191
|
+
width?: number;
|
|
1192
|
+
/** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
|
|
1193
|
+
gifType?: GIFType;
|
|
1194
|
+
}
|
|
1195
|
+
export interface GIF {
|
|
1196
|
+
/** GIF format URL. */
|
|
1197
|
+
gif?: string | null;
|
|
1198
|
+
/** MP4 format URL. */
|
|
1199
|
+
mp4?: string | null;
|
|
1200
|
+
/** Thumbnail URL. */
|
|
1201
|
+
still?: string | null;
|
|
1202
|
+
}
|
|
1203
|
+
export declare enum GIFType {
|
|
1204
|
+
GIF = "GIF",
|
|
1205
|
+
STICKER = "STICKER"
|
|
1206
|
+
}
|
|
1207
|
+
export interface HeadingData {
|
|
1208
|
+
/** Heading level from 1-6. */
|
|
1209
|
+
level?: number;
|
|
1210
|
+
/** Styling for the heading text. */
|
|
1211
|
+
textStyle?: TextStyle;
|
|
1212
|
+
/** Indentation level from 1-4. */
|
|
1213
|
+
indentation?: number | null;
|
|
1214
|
+
}
|
|
1215
|
+
export interface HTMLData extends HTMLDataDataOneOf {
|
|
1216
|
+
/** The URL for the HTML code for the node. */
|
|
1217
|
+
url?: string;
|
|
1218
|
+
/** The HTML code for the node. */
|
|
1219
|
+
html?: string;
|
|
1220
|
+
/**
|
|
1221
|
+
* Whether this is an AdSense element. Use `source` instead.
|
|
1222
|
+
* @deprecated
|
|
1223
|
+
*/
|
|
1224
|
+
isAdsense?: boolean | null;
|
|
1225
|
+
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
1226
|
+
containerData?: PluginContainerData;
|
|
1227
|
+
/** The type of HTML code. */
|
|
1228
|
+
source?: Source;
|
|
1229
|
+
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
1230
|
+
autoHeight?: boolean | null;
|
|
1231
|
+
}
|
|
1232
|
+
/** @oneof */
|
|
1233
|
+
export interface HTMLDataDataOneOf {
|
|
1234
|
+
/** The URL for the HTML code for the node. */
|
|
1235
|
+
url?: string;
|
|
1236
|
+
/** The HTML code for the node. */
|
|
1237
|
+
html?: string;
|
|
1238
|
+
/**
|
|
1239
|
+
* Whether this is an AdSense element. Use `source` instead.
|
|
1240
|
+
* @deprecated
|
|
1241
|
+
*/
|
|
1242
|
+
isAdsense?: boolean | null;
|
|
1243
|
+
}
|
|
1244
|
+
export declare enum Source {
|
|
1245
|
+
HTML = "HTML",
|
|
1246
|
+
ADSENSE = "ADSENSE"
|
|
1247
|
+
}
|
|
1248
|
+
export interface ImageData {
|
|
1249
|
+
/** Styling for the image's container. */
|
|
1250
|
+
containerData?: PluginContainerData;
|
|
1251
|
+
/** Image file details. */
|
|
1252
|
+
image?: Media;
|
|
1253
|
+
/** Link details for images that are links. */
|
|
1254
|
+
link?: Link;
|
|
1255
|
+
/** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
|
|
1256
|
+
disableExpand?: boolean | null;
|
|
1257
|
+
/** Image's alternative text. */
|
|
1258
|
+
altText?: string | null;
|
|
1259
|
+
/**
|
|
1260
|
+
* Deprecated: use Caption node instead.
|
|
1261
|
+
* @deprecated
|
|
1262
|
+
*/
|
|
1263
|
+
caption?: string | null;
|
|
1264
|
+
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
1265
|
+
disableDownload?: boolean | null;
|
|
1266
|
+
}
|
|
1267
|
+
export interface LinkPreviewData {
|
|
1268
|
+
/** Styling for the link preview's container. */
|
|
1269
|
+
containerData?: PluginContainerData;
|
|
1270
|
+
/** Link details. */
|
|
1271
|
+
link?: Link;
|
|
1272
|
+
/** Preview title. */
|
|
1273
|
+
title?: string | null;
|
|
1274
|
+
/** Preview thumbnail URL. */
|
|
1275
|
+
thumbnailUrl?: string | null;
|
|
1276
|
+
/** Preview description. */
|
|
1277
|
+
description?: string | null;
|
|
1278
|
+
/** The preview content as HTML. */
|
|
1279
|
+
html?: string | null;
|
|
1280
|
+
}
|
|
1281
|
+
export interface MapData {
|
|
1282
|
+
/** Styling for the map's container. */
|
|
1283
|
+
containerData?: PluginContainerData;
|
|
1284
|
+
/** Map settings. */
|
|
1285
|
+
mapSettings?: MapSettings;
|
|
1286
|
+
}
|
|
1287
|
+
export interface MapSettings {
|
|
1288
|
+
/** The address to display on the map. */
|
|
1289
|
+
address?: string | null;
|
|
1290
|
+
/** Sets whether the map is draggable. */
|
|
1291
|
+
draggable?: boolean | null;
|
|
1292
|
+
/** Sets whether the location marker is visible. */
|
|
1293
|
+
marker?: boolean | null;
|
|
1294
|
+
/** Sets whether street view control is enabled. */
|
|
1295
|
+
streetViewControl?: boolean | null;
|
|
1296
|
+
/** Sets whether zoom control is enabled. */
|
|
1297
|
+
zoomControl?: boolean | null;
|
|
1298
|
+
/** Location latitude. */
|
|
1299
|
+
lat?: number | null;
|
|
1300
|
+
/** Location longitude. */
|
|
1301
|
+
lng?: number | null;
|
|
1302
|
+
/** Location name. */
|
|
1303
|
+
locationName?: string | null;
|
|
1304
|
+
/** Sets whether view mode control is enabled. */
|
|
1305
|
+
viewModeControl?: boolean | null;
|
|
1306
|
+
/** Initial zoom value. */
|
|
1307
|
+
initialZoom?: number | null;
|
|
1308
|
+
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1309
|
+
mapType?: MapType;
|
|
1310
|
+
}
|
|
1311
|
+
export declare enum MapType {
|
|
1312
|
+
/** Roadmap map type */
|
|
1313
|
+
ROADMAP = "ROADMAP",
|
|
1314
|
+
/** Satellite map type */
|
|
1315
|
+
SATELITE = "SATELITE",
|
|
1316
|
+
/** Hybrid map type */
|
|
1317
|
+
HYBRID = "HYBRID",
|
|
1318
|
+
/** Terrain map type */
|
|
1319
|
+
TERRAIN = "TERRAIN"
|
|
1320
|
+
}
|
|
1321
|
+
export interface ParagraphData {
|
|
1322
|
+
/** Styling for the paragraph text. */
|
|
1323
|
+
textStyle?: TextStyle;
|
|
1324
|
+
/** Indentation level from 1-4. */
|
|
1325
|
+
indentation?: number | null;
|
|
1326
|
+
/** Paragraph level */
|
|
1327
|
+
level?: number | null;
|
|
1328
|
+
}
|
|
1329
|
+
export interface PollData {
|
|
1330
|
+
/** Styling for the poll's container. */
|
|
1331
|
+
containerData?: PluginContainerData;
|
|
1332
|
+
/** Poll data. */
|
|
1333
|
+
poll?: Poll;
|
|
1334
|
+
/** Layout settings for the poll and voting options. */
|
|
1335
|
+
layout?: PollDataLayout;
|
|
1336
|
+
/** Styling for the poll and voting options. */
|
|
1337
|
+
design?: Design;
|
|
1338
|
+
}
|
|
1339
|
+
export declare enum ViewRole {
|
|
1340
|
+
/** Only Poll creator can view the results */
|
|
1341
|
+
CREATOR = "CREATOR",
|
|
1342
|
+
/** Anyone who voted can see the results */
|
|
1343
|
+
VOTERS = "VOTERS",
|
|
1344
|
+
/** Anyone can see the results, even if one didn't vote */
|
|
1345
|
+
EVERYONE = "EVERYONE"
|
|
1346
|
+
}
|
|
1347
|
+
export declare enum VoteRole {
|
|
1348
|
+
/** Logged in member */
|
|
1349
|
+
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1350
|
+
/** Anyone */
|
|
1351
|
+
ALL = "ALL"
|
|
1352
|
+
}
|
|
1353
|
+
export interface Permissions {
|
|
1354
|
+
/** Sets who can view the poll results. */
|
|
1355
|
+
view?: ViewRole;
|
|
1356
|
+
/** Sets who can vote. */
|
|
1357
|
+
vote?: VoteRole;
|
|
1358
|
+
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1359
|
+
allowMultipleVotes?: boolean | null;
|
|
1360
|
+
}
|
|
1361
|
+
export interface PollOption {
|
|
1362
|
+
/** Option ID. */
|
|
1363
|
+
id?: string | null;
|
|
1364
|
+
/** Option title. */
|
|
1365
|
+
title?: string | null;
|
|
1366
|
+
/** The image displayed with the option. */
|
|
1367
|
+
image?: Media;
|
|
1368
|
+
}
|
|
1369
|
+
export interface Settings {
|
|
1370
|
+
/** Permissions settings for voting. */
|
|
1371
|
+
permissions?: Permissions;
|
|
1372
|
+
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
1373
|
+
showVoters?: boolean | null;
|
|
1374
|
+
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
1375
|
+
showVotesCount?: boolean | null;
|
|
1376
|
+
}
|
|
1377
|
+
export declare enum PollLayoutType {
|
|
1378
|
+
/** List */
|
|
1379
|
+
LIST = "LIST",
|
|
1380
|
+
/** Grid */
|
|
1381
|
+
GRID = "GRID"
|
|
1382
|
+
}
|
|
1383
|
+
export declare enum PollLayoutDirection {
|
|
1384
|
+
/** Left-to-right */
|
|
1385
|
+
LTR = "LTR",
|
|
1386
|
+
/** Right-to-left */
|
|
1387
|
+
RTL = "RTL"
|
|
1388
|
+
}
|
|
1389
|
+
export interface PollLayout {
|
|
1390
|
+
/** The layout for displaying the voting options. */
|
|
1391
|
+
type?: PollLayoutType;
|
|
1392
|
+
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
1393
|
+
direction?: PollLayoutDirection;
|
|
1394
|
+
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1395
|
+
enableImage?: boolean | null;
|
|
1396
|
+
}
|
|
1397
|
+
export interface OptionLayout {
|
|
1398
|
+
/** Sets whether to display option images. Defaults to `false`. */
|
|
1399
|
+
enableImage?: boolean | null;
|
|
1400
|
+
}
|
|
1401
|
+
export declare enum BackgroundType {
|
|
1402
|
+
/** Color background type */
|
|
1403
|
+
COLOR = "COLOR",
|
|
1404
|
+
/** Image background type */
|
|
1405
|
+
IMAGE = "IMAGE",
|
|
1406
|
+
/** Gradiant background type */
|
|
1407
|
+
GRADIENT = "GRADIENT"
|
|
1408
|
+
}
|
|
1409
|
+
export interface Gradient {
|
|
1410
|
+
/** The gradient angle in degrees. */
|
|
1411
|
+
angle?: number | null;
|
|
1412
|
+
/** The start color as a hexademical value. */
|
|
1413
|
+
startColor?: string | null;
|
|
1414
|
+
/** The end color as a hexademical value. */
|
|
1415
|
+
lastColor?: string | null;
|
|
1416
|
+
}
|
|
1417
|
+
export interface Background extends BackgroundBackgroundOneOf {
|
|
1418
|
+
/** The background color as a hexademical value. */
|
|
1419
|
+
color?: string | null;
|
|
1420
|
+
/** An image to use for the background. */
|
|
1421
|
+
image?: Media;
|
|
1422
|
+
/** Details for a gradient background. */
|
|
1423
|
+
gradient?: Gradient;
|
|
1424
|
+
/** Background type. For each option, include the relevant details. */
|
|
1425
|
+
type?: BackgroundType;
|
|
1426
|
+
}
|
|
1427
|
+
/** @oneof */
|
|
1428
|
+
export interface BackgroundBackgroundOneOf {
|
|
1429
|
+
/** The background color as a hexademical value. */
|
|
1430
|
+
color?: string | null;
|
|
1431
|
+
/** An image to use for the background. */
|
|
1432
|
+
image?: Media;
|
|
1433
|
+
/** Details for a gradient background. */
|
|
1434
|
+
gradient?: Gradient;
|
|
1435
|
+
}
|
|
1436
|
+
export interface PollDesign {
|
|
1437
|
+
/** Background styling. */
|
|
1438
|
+
background?: Background;
|
|
1439
|
+
/** Border radius in pixels. */
|
|
1440
|
+
borderRadius?: number | null;
|
|
1441
|
+
}
|
|
1442
|
+
export interface OptionDesign {
|
|
1443
|
+
/** Border radius in pixels. */
|
|
1444
|
+
borderRadius?: number | null;
|
|
1445
|
+
}
|
|
1446
|
+
export interface Poll {
|
|
1447
|
+
/** Poll ID. */
|
|
1448
|
+
id?: string | null;
|
|
1449
|
+
/** Poll title. */
|
|
1450
|
+
title?: string | null;
|
|
1451
|
+
/** Poll creator ID. */
|
|
1452
|
+
creatorId?: string | null;
|
|
1453
|
+
/** Main poll image. */
|
|
1454
|
+
image?: Media;
|
|
1455
|
+
/** Voting options. */
|
|
1456
|
+
options?: PollOption[];
|
|
1457
|
+
/** The poll's permissions and display settings. */
|
|
1458
|
+
settings?: Settings;
|
|
1459
|
+
}
|
|
1460
|
+
export interface PollDataLayout {
|
|
1461
|
+
/** Poll layout settings. */
|
|
1462
|
+
poll?: PollLayout;
|
|
1463
|
+
/** Voting otpions layout settings. */
|
|
1464
|
+
options?: OptionLayout;
|
|
1465
|
+
}
|
|
1466
|
+
export interface Design {
|
|
1467
|
+
/** Styling for the poll. */
|
|
1468
|
+
poll?: PollDesign;
|
|
1469
|
+
/** Styling for voting options. */
|
|
1470
|
+
options?: OptionDesign;
|
|
1471
|
+
}
|
|
1472
|
+
export interface TextData {
|
|
1473
|
+
/** The text to apply decorations to. */
|
|
1474
|
+
text?: string;
|
|
1475
|
+
/** The decorations to apply. */
|
|
1476
|
+
decorations?: Decoration[];
|
|
1477
|
+
}
|
|
1478
|
+
/** Adds appearence changes to text */
|
|
1479
|
+
export interface Decoration extends DecorationDataOneOf {
|
|
1480
|
+
/** Data for an anchor link decoration. */
|
|
1481
|
+
anchorData?: AnchorData;
|
|
1482
|
+
/** Data for a color decoration. */
|
|
1483
|
+
colorData?: ColorData;
|
|
1484
|
+
/** Data for an external link decoration. */
|
|
1485
|
+
linkData?: LinkData;
|
|
1486
|
+
/** Data for a mention decoration. */
|
|
1487
|
+
mentionData?: MentionData;
|
|
1488
|
+
/** Data for a font size decoration. */
|
|
1489
|
+
fontSizeData?: FontSizeData;
|
|
1490
|
+
/** Font weight for a bold decoration. */
|
|
1491
|
+
fontWeightValue?: number | null;
|
|
1492
|
+
/** Data for an italic decoration. Defaults to `true`. */
|
|
1493
|
+
italicData?: boolean | null;
|
|
1494
|
+
/** Data for an underline decoration. Defaults to `true`. */
|
|
1495
|
+
underlineData?: boolean | null;
|
|
1496
|
+
/** Data for a spoiler decoration. */
|
|
1497
|
+
spoilerData?: SpoilerData;
|
|
1498
|
+
/** The type of decoration to apply. */
|
|
1499
|
+
type?: DecorationType;
|
|
1500
|
+
}
|
|
1501
|
+
/** @oneof */
|
|
1502
|
+
export interface DecorationDataOneOf {
|
|
1503
|
+
/** Data for an anchor link decoration. */
|
|
1504
|
+
anchorData?: AnchorData;
|
|
1505
|
+
/** Data for a color decoration. */
|
|
1506
|
+
colorData?: ColorData;
|
|
1507
|
+
/** Data for an external link decoration. */
|
|
1508
|
+
linkData?: LinkData;
|
|
1509
|
+
/** Data for a mention decoration. */
|
|
1510
|
+
mentionData?: MentionData;
|
|
1511
|
+
/** Data for a font size decoration. */
|
|
1512
|
+
fontSizeData?: FontSizeData;
|
|
1513
|
+
/** Font weight for a bold decoration. */
|
|
1514
|
+
fontWeightValue?: number | null;
|
|
1515
|
+
/** Data for an italic decoration. Defaults to `true`. */
|
|
1516
|
+
italicData?: boolean | null;
|
|
1517
|
+
/** Data for an underline decoration. Defaults to `true`. */
|
|
1518
|
+
underlineData?: boolean | null;
|
|
1519
|
+
/** Data for a spoiler decoration. */
|
|
1520
|
+
spoilerData?: SpoilerData;
|
|
1521
|
+
}
|
|
1522
|
+
export declare enum DecorationType {
|
|
1523
|
+
BOLD = "BOLD",
|
|
1524
|
+
ITALIC = "ITALIC",
|
|
1525
|
+
UNDERLINE = "UNDERLINE",
|
|
1526
|
+
SPOILER = "SPOILER",
|
|
1527
|
+
ANCHOR = "ANCHOR",
|
|
1528
|
+
MENTION = "MENTION",
|
|
1529
|
+
LINK = "LINK",
|
|
1530
|
+
COLOR = "COLOR",
|
|
1531
|
+
FONT_SIZE = "FONT_SIZE",
|
|
1532
|
+
EXTERNAL = "EXTERNAL"
|
|
1533
|
+
}
|
|
1534
|
+
export interface AnchorData {
|
|
1535
|
+
/** The target node's ID. */
|
|
1536
|
+
anchor?: string;
|
|
1537
|
+
}
|
|
1538
|
+
export interface ColorData {
|
|
1539
|
+
/** The text's background color as a hexadecimal value. */
|
|
1540
|
+
background?: string | null;
|
|
1541
|
+
/** The text's foreground color as a hexadecimal value. */
|
|
1542
|
+
foreground?: string | null;
|
|
1543
|
+
}
|
|
1544
|
+
export interface LinkData {
|
|
1545
|
+
/** Link details. */
|
|
1546
|
+
link?: Link;
|
|
1547
|
+
}
|
|
1548
|
+
export interface MentionData {
|
|
1549
|
+
/** The mentioned user's name. */
|
|
1550
|
+
name?: string;
|
|
1551
|
+
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
1552
|
+
slug?: string;
|
|
1553
|
+
/** Mentioned user's ID. */
|
|
1554
|
+
id?: string | null;
|
|
1555
|
+
}
|
|
1556
|
+
export interface FontSizeData {
|
|
1557
|
+
/** The units used for the font size. */
|
|
1558
|
+
unit?: FontType;
|
|
1559
|
+
/** Font size value. */
|
|
1560
|
+
value?: number | null;
|
|
1561
|
+
}
|
|
1562
|
+
export declare enum FontType {
|
|
1563
|
+
PX = "PX",
|
|
1564
|
+
EM = "EM"
|
|
1565
|
+
}
|
|
1566
|
+
export interface SpoilerData {
|
|
1567
|
+
/** Spoiler ID. */
|
|
1568
|
+
id?: string | null;
|
|
1569
|
+
}
|
|
1570
|
+
export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1571
|
+
/** Data for embedded Wix Bookings content. */
|
|
1572
|
+
bookingData?: BookingData;
|
|
1573
|
+
/** Data for embedded Wix Events content. */
|
|
1574
|
+
eventData?: EventData;
|
|
1575
|
+
/** The type of Wix App content being embedded. */
|
|
1576
|
+
type?: AppType;
|
|
1577
|
+
/** The ID of the embedded content. */
|
|
1578
|
+
itemId?: string | null;
|
|
1579
|
+
/** The name of the embedded content. */
|
|
1580
|
+
name?: string | null;
|
|
1581
|
+
/**
|
|
1582
|
+
* Deprecated: Use `image` instead.
|
|
1583
|
+
* @deprecated
|
|
1584
|
+
*/
|
|
1585
|
+
imageSrc?: string | null;
|
|
1586
|
+
/** The URL for the embedded content. */
|
|
1587
|
+
url?: string | null;
|
|
1588
|
+
/** An image for the embedded content. */
|
|
1589
|
+
image?: Media;
|
|
1590
|
+
}
|
|
1591
|
+
/** @oneof */
|
|
1592
|
+
export interface AppEmbedDataAppDataOneOf {
|
|
1593
|
+
/** Data for embedded Wix Bookings content. */
|
|
1594
|
+
bookingData?: BookingData;
|
|
1595
|
+
/** Data for embedded Wix Events content. */
|
|
1596
|
+
eventData?: EventData;
|
|
1597
|
+
}
|
|
1598
|
+
export declare enum AppType {
|
|
1599
|
+
PRODUCT = "PRODUCT",
|
|
1600
|
+
EVENT = "EVENT",
|
|
1601
|
+
BOOKING = "BOOKING"
|
|
1602
|
+
}
|
|
1603
|
+
export interface BookingData {
|
|
1604
|
+
/** Booking duration in minutes. */
|
|
1605
|
+
durations?: string | null;
|
|
1606
|
+
}
|
|
1607
|
+
export interface EventData {
|
|
1608
|
+
/** Event schedule. */
|
|
1609
|
+
scheduling?: string | null;
|
|
1610
|
+
/** Event location. */
|
|
1611
|
+
location?: string | null;
|
|
1612
|
+
}
|
|
1613
|
+
export interface VideoData {
|
|
1614
|
+
/** Styling for the video's container. */
|
|
1615
|
+
containerData?: PluginContainerData;
|
|
1616
|
+
/** Video details. */
|
|
1617
|
+
video?: Media;
|
|
1618
|
+
/** Video thumbnail details. */
|
|
1619
|
+
thumbnail?: Media;
|
|
1620
|
+
/** Sets whether the video's download button is disabled. Defaults to `false`. */
|
|
1621
|
+
disableDownload?: boolean | null;
|
|
1622
|
+
/** Video title. */
|
|
1623
|
+
title?: string | null;
|
|
1624
|
+
/** Video options. */
|
|
1625
|
+
options?: PlaybackOptions;
|
|
1626
|
+
}
|
|
1627
|
+
export interface PlaybackOptions {
|
|
1628
|
+
/** Sets whether the media will automatically start playing. */
|
|
1629
|
+
autoPlay?: boolean | null;
|
|
1630
|
+
/** Sets whether media's will be looped. */
|
|
1631
|
+
playInLoop?: boolean | null;
|
|
1632
|
+
/** Sets whether media's controls will be shown. */
|
|
1633
|
+
showControls?: boolean | null;
|
|
1634
|
+
}
|
|
1635
|
+
export interface EmbedData {
|
|
1636
|
+
/** Styling for the oEmbed node's container. */
|
|
1637
|
+
containerData?: PluginContainerData;
|
|
1638
|
+
/** An [oEmbed](https://www.oembed.com) object. */
|
|
1639
|
+
oembed?: Oembed;
|
|
1640
|
+
/** Origin asset source. */
|
|
1641
|
+
src?: string | null;
|
|
1642
|
+
}
|
|
1643
|
+
export interface Oembed {
|
|
1644
|
+
/** The resource type. */
|
|
1645
|
+
type?: string | null;
|
|
1646
|
+
/** The width of the resource specified in the `url` property in pixels. */
|
|
1647
|
+
width?: number | null;
|
|
1648
|
+
/** The height of the resource specified in the `url` property in pixels. */
|
|
1649
|
+
height?: number | null;
|
|
1650
|
+
/** Resource title. */
|
|
1651
|
+
title?: string | null;
|
|
1652
|
+
/** The source URL for the resource. */
|
|
1653
|
+
url?: string | null;
|
|
1654
|
+
/** HTML for embedding a video player. The HTML should have no padding or margins. */
|
|
1655
|
+
html?: string | null;
|
|
1656
|
+
/** The name of the author or owner of the resource. */
|
|
1657
|
+
authorName?: string | null;
|
|
1658
|
+
/** The URL for the author or owner of the resource. */
|
|
1659
|
+
authorUrl?: string | null;
|
|
1660
|
+
/** The name of the resource provider. */
|
|
1661
|
+
providerName?: string | null;
|
|
1662
|
+
/** The URL for the resource provider. */
|
|
1663
|
+
providerUrl?: string | null;
|
|
1664
|
+
/** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
|
|
1665
|
+
thumbnailUrl?: string | null;
|
|
1666
|
+
/** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
|
|
1667
|
+
thumbnailWidth?: string | null;
|
|
1668
|
+
/** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
|
|
1669
|
+
thumbnailHeight?: string | null;
|
|
1670
|
+
/** The URL for an embedded viedo. */
|
|
1671
|
+
videoUrl?: string | null;
|
|
1672
|
+
/** The oEmbed version number. This value must be `1.0`. */
|
|
1673
|
+
version?: string | null;
|
|
1674
|
+
}
|
|
1675
|
+
export interface CollapsibleListData {
|
|
1676
|
+
/** Styling for the collapsible list's container. */
|
|
1677
|
+
containerData?: PluginContainerData;
|
|
1678
|
+
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
1679
|
+
expandOnlyOne?: boolean | null;
|
|
1680
|
+
/** Sets which items are expanded when the page loads. */
|
|
1681
|
+
initialExpandedItems?: InitialExpandedItems;
|
|
1682
|
+
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
1683
|
+
direction?: Direction;
|
|
1684
|
+
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1685
|
+
isQapageData?: boolean | null;
|
|
1686
|
+
}
|
|
1687
|
+
export declare enum InitialExpandedItems {
|
|
1688
|
+
/** First item will be expended initally */
|
|
1689
|
+
FIRST = "FIRST",
|
|
1690
|
+
/** All items will expended initally */
|
|
1691
|
+
ALL = "ALL",
|
|
1692
|
+
/** All items collapsed initally */
|
|
1693
|
+
NONE = "NONE"
|
|
1694
|
+
}
|
|
1695
|
+
export declare enum Direction {
|
|
1696
|
+
/** Left-to-right */
|
|
1697
|
+
LTR = "LTR",
|
|
1698
|
+
/** Right-to-left */
|
|
1699
|
+
RTL = "RTL"
|
|
1700
|
+
}
|
|
1701
|
+
export interface TableData {
|
|
1702
|
+
/** Styling for the table's container. */
|
|
1703
|
+
containerData?: PluginContainerData;
|
|
1704
|
+
/** The table's dimensions. */
|
|
1705
|
+
dimensions?: Dimensions;
|
|
1706
|
+
/**
|
|
1707
|
+
* Deprecated: Use `rowHeader` and `columnHeader` instead.
|
|
1708
|
+
* @deprecated
|
|
1709
|
+
*/
|
|
1710
|
+
header?: boolean | null;
|
|
1711
|
+
/** Sets whether the table's first row is a header. Defaults to `false`. */
|
|
1712
|
+
rowHeader?: boolean | null;
|
|
1713
|
+
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
1714
|
+
columnHeader?: boolean | null;
|
|
1715
|
+
}
|
|
1716
|
+
export interface Dimensions {
|
|
1717
|
+
/** An array representing relative width of each column in relation to the other columns. */
|
|
1718
|
+
colsWidthRatio?: number[];
|
|
1719
|
+
/** An array representing the height of each row in pixels. */
|
|
1720
|
+
rowsHeight?: number[];
|
|
1721
|
+
/** An array representing the minimum width of each column in pixels. */
|
|
1722
|
+
colsMinWidth?: number[];
|
|
1723
|
+
}
|
|
1724
|
+
export interface TableCellData {
|
|
1725
|
+
/** Styling for the cell's background color and text alignment. */
|
|
1726
|
+
cellStyle?: CellStyle;
|
|
1727
|
+
/** The cell's border colors. */
|
|
1728
|
+
borderColors?: BorderColors;
|
|
1729
|
+
}
|
|
1730
|
+
export declare enum VerticalAlignment {
|
|
1731
|
+
/** Top alignment */
|
|
1732
|
+
TOP = "TOP",
|
|
1733
|
+
/** Middle alignment */
|
|
1734
|
+
MIDDLE = "MIDDLE",
|
|
1735
|
+
/** Bottom alignment */
|
|
1736
|
+
BOTTOM = "BOTTOM"
|
|
1737
|
+
}
|
|
1738
|
+
export interface CellStyle {
|
|
1739
|
+
/** Vertical alignment for the cell's text. */
|
|
1740
|
+
verticalAlignment?: VerticalAlignment;
|
|
1741
|
+
/** Cell background color as a hexadecimal value. */
|
|
1742
|
+
backgroundColor?: string | null;
|
|
1743
|
+
}
|
|
1744
|
+
export interface BorderColors {
|
|
1745
|
+
/** Left border color as a hexadecimal value. */
|
|
1746
|
+
left?: string | null;
|
|
1747
|
+
/** Right border color as a hexadecimal value. */
|
|
1748
|
+
right?: string | null;
|
|
1749
|
+
/** Top border color as a hexadecimal value. */
|
|
1750
|
+
top?: string | null;
|
|
1751
|
+
/** Bottom border color as a hexadecimal value. */
|
|
1752
|
+
bottom?: string | null;
|
|
1753
|
+
}
|
|
1754
|
+
/**
|
|
1755
|
+
* `NullValue` is a singleton enumeration to represent the null value for the
|
|
1756
|
+
* `Value` type union.
|
|
1757
|
+
*
|
|
1758
|
+
* The JSON representation for `NullValue` is JSON `null`.
|
|
1759
|
+
*/
|
|
1760
|
+
export declare enum NullValue {
|
|
1761
|
+
/** Null value. */
|
|
1762
|
+
NULL_VALUE = "NULL_VALUE"
|
|
1763
|
+
}
|
|
1764
|
+
/**
|
|
1765
|
+
* `ListValue` is a wrapper around a repeated field of values.
|
|
1766
|
+
*
|
|
1767
|
+
* The JSON representation for `ListValue` is JSON array.
|
|
1768
|
+
*/
|
|
1769
|
+
export interface ListValue {
|
|
1770
|
+
/** Repeated field of dynamically typed values. */
|
|
1771
|
+
values?: any[];
|
|
1772
|
+
}
|
|
1773
|
+
export interface AudioData {
|
|
1774
|
+
/** Styling for the audio node's container. */
|
|
1775
|
+
containerData?: PluginContainerData;
|
|
1776
|
+
/** Audio file details. */
|
|
1777
|
+
audio?: Media;
|
|
1778
|
+
/** Sets whether the audio node's download button is disabled. Defaults to `false`. */
|
|
1779
|
+
disableDownload?: boolean | null;
|
|
1780
|
+
/** Cover image. */
|
|
1781
|
+
coverImage?: Media;
|
|
1782
|
+
/** Track name. */
|
|
1783
|
+
name?: string | null;
|
|
1784
|
+
/** Author name. */
|
|
1785
|
+
authorName?: string | null;
|
|
1786
|
+
/** An HTML version of the audio node. */
|
|
1787
|
+
html?: string | null;
|
|
1788
|
+
}
|
|
1789
|
+
export interface OrderedListData {
|
|
1790
|
+
/** Indentation level from 0-4. */
|
|
1791
|
+
indentation?: number;
|
|
1792
|
+
/** Offset level from 0-4. */
|
|
1793
|
+
offset?: number | null;
|
|
1794
|
+
/** List start number. */
|
|
1795
|
+
start?: number | null;
|
|
1796
|
+
}
|
|
1797
|
+
export interface BulletedListData {
|
|
1798
|
+
/** Indentation level from 0-4. */
|
|
1799
|
+
indentation?: number;
|
|
1800
|
+
/** Offset level from 0-4. */
|
|
1801
|
+
offset?: number | null;
|
|
1802
|
+
}
|
|
1803
|
+
export interface BlockquoteData {
|
|
1804
|
+
/** Indentation level from 1-4. */
|
|
1805
|
+
indentation?: number;
|
|
1806
|
+
}
|
|
1807
|
+
export interface CaptionData {
|
|
1808
|
+
textStyle?: TextStyle;
|
|
1809
|
+
}
|
|
1810
|
+
export interface LayoutCellData {
|
|
1811
|
+
/** Size of the cell in 12 columns grid. */
|
|
1812
|
+
colSpan?: number | null;
|
|
1813
|
+
}
|
|
1814
|
+
export interface Metadata {
|
|
1815
|
+
/** Schema version. */
|
|
1816
|
+
version?: number;
|
|
1817
|
+
/**
|
|
1818
|
+
* When the object was created.
|
|
1819
|
+
* @readonly
|
|
1820
|
+
* @deprecated
|
|
1821
|
+
*/
|
|
1822
|
+
createdTimestamp?: Date | null;
|
|
1823
|
+
/**
|
|
1824
|
+
* When the object was most recently updated.
|
|
1825
|
+
* @deprecated
|
|
1826
|
+
*/
|
|
1827
|
+
updatedTimestamp?: Date | null;
|
|
1828
|
+
/** Object ID. */
|
|
1829
|
+
id?: string | null;
|
|
1830
|
+
}
|
|
1831
|
+
export interface DocumentStyle {
|
|
1832
|
+
/** Styling for H1 nodes. */
|
|
1833
|
+
headerOne?: TextNodeStyle;
|
|
1834
|
+
/** Styling for H2 nodes. */
|
|
1835
|
+
headerTwo?: TextNodeStyle;
|
|
1836
|
+
/** Styling for H3 nodes. */
|
|
1837
|
+
headerThree?: TextNodeStyle;
|
|
1838
|
+
/** Styling for H4 nodes. */
|
|
1839
|
+
headerFour?: TextNodeStyle;
|
|
1840
|
+
/** Styling for H5 nodes. */
|
|
1841
|
+
headerFive?: TextNodeStyle;
|
|
1842
|
+
/** Styling for H6 nodes. */
|
|
1843
|
+
headerSix?: TextNodeStyle;
|
|
1844
|
+
/** Styling for paragraph nodes. */
|
|
1845
|
+
paragraph?: TextNodeStyle;
|
|
1846
|
+
/** Styling for block quote nodes. */
|
|
1847
|
+
blockquote?: TextNodeStyle;
|
|
1848
|
+
/** Styling for code block nodes. */
|
|
1849
|
+
codeBlock?: TextNodeStyle;
|
|
1850
|
+
}
|
|
1851
|
+
export interface TextNodeStyle {
|
|
1852
|
+
/** The decorations to apply to the node. */
|
|
1853
|
+
decorations?: Decoration[];
|
|
1854
|
+
/** Padding and background color for the node. */
|
|
1855
|
+
nodeStyle?: NodeStyle;
|
|
1856
|
+
/** Line height for text in the node. */
|
|
1857
|
+
lineHeight?: string | null;
|
|
1858
|
+
}
|
|
1859
|
+
export interface RadioGroup {
|
|
1860
|
+
/** Label of the field */
|
|
1861
|
+
label?: string | null;
|
|
1862
|
+
/** Description of the field */
|
|
1863
|
+
description?: RichContent;
|
|
1864
|
+
/**
|
|
1865
|
+
* Flag identifying to show option allowing input custom value
|
|
1866
|
+
* List of options to select from
|
|
1867
|
+
*/
|
|
1868
|
+
options?: RadioGroupOption[];
|
|
1869
|
+
/**
|
|
1870
|
+
* Flag identifying to hide or not label
|
|
1871
|
+
* Default: true
|
|
1872
|
+
*/
|
|
1873
|
+
showLabel?: boolean | null;
|
|
1874
|
+
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
1875
|
+
customOption?: RadioGroupCustomOption;
|
|
1876
|
+
/**
|
|
1877
|
+
* Specifies the number of columns used to display the selections within the component.
|
|
1878
|
+
* Default: ONE
|
|
1879
|
+
*/
|
|
1880
|
+
numberOfColumns?: NumberOfColumns;
|
|
1881
|
+
}
|
|
1882
|
+
export interface RadioGroupOption {
|
|
1883
|
+
/** Selectable option label */
|
|
1884
|
+
label?: string | null;
|
|
1885
|
+
/** Selectable option value, which is saved to DB. */
|
|
1886
|
+
value?: string | null;
|
|
1887
|
+
/** Flag identifying that option should be selected by default */
|
|
1888
|
+
default?: boolean;
|
|
1889
|
+
/** Option id. Used as binding for translations */
|
|
1890
|
+
id?: string;
|
|
1891
|
+
}
|
|
1892
|
+
export interface RadioGroupCustomOption {
|
|
1893
|
+
/** Label of custom option input */
|
|
1894
|
+
label?: string | null;
|
|
1895
|
+
/** Placeholder of custom option input */
|
|
1896
|
+
placeholder?: string | null;
|
|
1897
|
+
}
|
|
1898
|
+
export declare enum NumberOfColumns {
|
|
1899
|
+
/** Undefined number of columns. */
|
|
1900
|
+
UNKNOWN = "UNKNOWN",
|
|
1901
|
+
/** Zero columns. */
|
|
1902
|
+
ZERO = "ZERO",
|
|
1903
|
+
/** One column. */
|
|
1904
|
+
ONE = "ONE",
|
|
1905
|
+
/** Two columns. */
|
|
1906
|
+
TWO = "TWO",
|
|
1907
|
+
/** Three columns. */
|
|
1908
|
+
THREE = "THREE"
|
|
1909
|
+
}
|
|
1910
|
+
export interface Dropdown {
|
|
1911
|
+
/** Label of the field */
|
|
1912
|
+
label?: string | null;
|
|
1913
|
+
/** Description of the field */
|
|
1914
|
+
description?: RichContent;
|
|
1915
|
+
/** List of options to select from */
|
|
1916
|
+
options?: DropdownOption[];
|
|
1917
|
+
/**
|
|
1918
|
+
* Flag identifying to hide or not label
|
|
1919
|
+
* Default: true
|
|
1920
|
+
*/
|
|
1921
|
+
showLabel?: boolean | null;
|
|
1922
|
+
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
1923
|
+
customOption?: DropdownCustomOption;
|
|
1924
|
+
/** Placeholder of dropdown input */
|
|
1925
|
+
placeholder?: string | null;
|
|
1926
|
+
}
|
|
1927
|
+
export interface DropdownOption {
|
|
1928
|
+
/** Selectable option label */
|
|
1929
|
+
label?: string | null;
|
|
1930
|
+
/** Selectable option value, which is saved to DB. */
|
|
1931
|
+
value?: string | null;
|
|
1932
|
+
/** Flag identifying that option should be selected by default */
|
|
1933
|
+
default?: boolean;
|
|
1934
|
+
/** Option id. Used as binding for translations */
|
|
1935
|
+
id?: string;
|
|
1936
|
+
}
|
|
1937
|
+
export interface DropdownCustomOption {
|
|
1938
|
+
/** Label of custom option input */
|
|
1939
|
+
label?: string | null;
|
|
1940
|
+
/** Placeholder of custom option input */
|
|
1941
|
+
placeholder?: string | null;
|
|
1942
|
+
}
|
|
1943
|
+
export interface DateTimeInput {
|
|
1944
|
+
/** Label of the field. Displayed text for the date/time input. */
|
|
1945
|
+
label?: string | null;
|
|
1946
|
+
/** Description of the field. Additional information about the date/time input. */
|
|
1947
|
+
description?: RichContent;
|
|
1948
|
+
/**
|
|
1949
|
+
* Flag identifying whether to show or hide the label.
|
|
1950
|
+
* Default: true
|
|
1951
|
+
*/
|
|
1952
|
+
showLabel?: boolean | null;
|
|
1953
|
+
/**
|
|
1954
|
+
* Flag identifying whether to show or hide the placeholder.
|
|
1955
|
+
* Default: true
|
|
1956
|
+
*/
|
|
1957
|
+
showPlaceholder?: boolean | null;
|
|
1958
|
+
/**
|
|
1959
|
+
* Flag indicating whether to use the 24-hour time format.
|
|
1960
|
+
* Default: false.
|
|
1961
|
+
*/
|
|
1962
|
+
use24HourFormat?: boolean;
|
|
1963
|
+
/** Default value for the date time input. */
|
|
1964
|
+
default?: string | null;
|
|
1965
|
+
}
|
|
1966
|
+
export interface PhoneInput {
|
|
1967
|
+
/** Label of the field */
|
|
1968
|
+
label?: string | null;
|
|
1969
|
+
/** Description of the field */
|
|
1970
|
+
description?: RichContent;
|
|
1971
|
+
/** Placeholder for the value input */
|
|
1972
|
+
placeholder?: string | null;
|
|
1973
|
+
/**
|
|
1974
|
+
* Flag identifying to show label or not
|
|
1975
|
+
* Default: true
|
|
1976
|
+
*/
|
|
1977
|
+
showLabel?: boolean | null;
|
|
1978
|
+
/** Default value of the country code */
|
|
1979
|
+
defaultCountryCode?: string | null;
|
|
1980
|
+
/**
|
|
1981
|
+
* Flag identifying to show country flag or not
|
|
1982
|
+
* Default: false
|
|
1983
|
+
*/
|
|
1984
|
+
showCountryFlag?: boolean;
|
|
1985
|
+
}
|
|
1986
|
+
export interface DateInput {
|
|
1987
|
+
/** Label of the field. Displayed text for the date/time input. */
|
|
1988
|
+
label?: string | null;
|
|
1989
|
+
/** Description of the field. Additional information about the date/time input. */
|
|
1990
|
+
description?: RichContent;
|
|
1991
|
+
/**
|
|
1992
|
+
* Flag identifying whether to show or hide the label.
|
|
1993
|
+
* Default: true
|
|
1994
|
+
*/
|
|
1995
|
+
showLabel?: boolean | null;
|
|
1996
|
+
/**
|
|
1997
|
+
* Flag identifying whether to show or hide the placeholder.
|
|
1998
|
+
* Default: true
|
|
1999
|
+
*/
|
|
2000
|
+
showPlaceholder?: boolean | null;
|
|
2001
|
+
/** Default value for the date input. */
|
|
2002
|
+
default?: string | null;
|
|
2003
|
+
}
|
|
2004
|
+
export interface TimeInput {
|
|
2005
|
+
/** Label of the field. Displayed text for the date/time input. */
|
|
2006
|
+
label?: string | null;
|
|
2007
|
+
/** Description of the field. Additional information about the date/time input. */
|
|
2008
|
+
description?: RichContent;
|
|
2009
|
+
/**
|
|
2010
|
+
* Flag identifying whether to show or hide the label.
|
|
2011
|
+
* Default: true
|
|
2012
|
+
*/
|
|
2013
|
+
showLabel?: boolean | null;
|
|
2014
|
+
/**
|
|
2015
|
+
* Flag identifying whether to show or hide the placeholder.
|
|
2016
|
+
* Default: true
|
|
2017
|
+
*/
|
|
2018
|
+
showPlaceholder?: boolean | null;
|
|
2019
|
+
/**
|
|
2020
|
+
* Flag indicating whether to use the 24-hour time format.
|
|
2021
|
+
* Default: false.
|
|
2022
|
+
*/
|
|
2023
|
+
use24HourFormat?: boolean;
|
|
2024
|
+
/** Default value for the time input. */
|
|
2025
|
+
default?: string | null;
|
|
2026
|
+
}
|
|
2027
|
+
export interface DatePicker {
|
|
2028
|
+
/** Label of the field. Displayed text for the date/time input. */
|
|
2029
|
+
label?: string | null;
|
|
2030
|
+
/** Description of the field. Additional information about the date/time input. */
|
|
2031
|
+
description?: RichContent;
|
|
2032
|
+
/**
|
|
2033
|
+
* Flag identifying whether to show or hide the label.
|
|
2034
|
+
* Default: true
|
|
2035
|
+
*/
|
|
2036
|
+
showLabel?: boolean | null;
|
|
2037
|
+
/** Placeholder of date picker input */
|
|
2038
|
+
placeholder?: string | null;
|
|
2039
|
+
/** First day of the week displayed on date picker. */
|
|
2040
|
+
firstDayOfWeek?: FirstDayOfWeek;
|
|
2041
|
+
/** Default value for the date picker. */
|
|
2042
|
+
default?: string | null;
|
|
2043
|
+
}
|
|
2044
|
+
export declare enum FirstDayOfWeek {
|
|
2045
|
+
/** First day of the week is Monday. */
|
|
2046
|
+
MONDAY = "MONDAY",
|
|
2047
|
+
/** First day of the week is Sunday. */
|
|
2048
|
+
SUNDAY = "SUNDAY"
|
|
2049
|
+
}
|
|
2050
|
+
export interface InputFieldNumberType {
|
|
2051
|
+
/** Inclusive maximum value. */
|
|
2052
|
+
maximum?: number | null;
|
|
2053
|
+
/** Inclusive minimum value. */
|
|
2054
|
+
minimum?: number | null;
|
|
2055
|
+
/** Multiple of value. */
|
|
2056
|
+
multipleOf?: number | null;
|
|
2057
|
+
/** Custom error message when validation fails. */
|
|
2058
|
+
errorMessages?: InputFieldNumberErrorMessages;
|
|
2059
|
+
/** List of allowed values. */
|
|
2060
|
+
enum?: number[] | null;
|
|
2061
|
+
}
|
|
2062
|
+
export interface InputFieldNumberErrorMessages {
|
|
2063
|
+
/** Default error message on invalid validation. */
|
|
2064
|
+
default?: string | null;
|
|
2065
|
+
}
|
|
2066
|
+
export declare enum NumberComponentType {
|
|
2067
|
+
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
2068
|
+
NUMBER_INPUT = "NUMBER_INPUT",
|
|
2069
|
+
RATING_INPUT = "RATING_INPUT"
|
|
2070
|
+
}
|
|
2071
|
+
export interface NumberInput {
|
|
2072
|
+
/** Label of the field */
|
|
2073
|
+
label?: string | null;
|
|
2074
|
+
/** Description of the field */
|
|
2075
|
+
description?: RichContent;
|
|
2076
|
+
/** Placeholder for the value input */
|
|
2077
|
+
placeholder?: string | null;
|
|
2078
|
+
/**
|
|
2079
|
+
* Flag identifying to hide or not label
|
|
2080
|
+
* Default: true
|
|
2081
|
+
*/
|
|
2082
|
+
showLabel?: boolean | null;
|
|
2083
|
+
/** Default value for the number input */
|
|
2084
|
+
default?: number | null;
|
|
2085
|
+
}
|
|
2086
|
+
export interface RatingInput {
|
|
2087
|
+
/** Label of the field */
|
|
2088
|
+
label?: string | null;
|
|
2089
|
+
/** Description of the field */
|
|
2090
|
+
description?: RichContent;
|
|
2091
|
+
/**
|
|
2092
|
+
* Flag identifying to hide label or not
|
|
2093
|
+
* Default: true
|
|
2094
|
+
*/
|
|
2095
|
+
showLabel?: boolean | null;
|
|
2096
|
+
/** Default rating */
|
|
2097
|
+
defaultValue?: number | null;
|
|
2098
|
+
}
|
|
2099
|
+
export interface InputFieldBooleanType {
|
|
2100
|
+
/** Custom error message when validation fails. */
|
|
2101
|
+
errorMessages?: InputFieldBooleanErrorMessages;
|
|
2102
|
+
/** List of allowed values. */
|
|
2103
|
+
enum?: boolean[];
|
|
2104
|
+
}
|
|
2105
|
+
export interface InputFieldBooleanErrorMessages {
|
|
2106
|
+
/** Default error message on invalid validation. */
|
|
2107
|
+
default?: string | null;
|
|
2108
|
+
}
|
|
2109
|
+
export declare enum BooleanComponentType {
|
|
2110
|
+
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
2111
|
+
CHECKBOX = "CHECKBOX"
|
|
2112
|
+
}
|
|
2113
|
+
export interface Checkbox {
|
|
2114
|
+
/** Label of the field */
|
|
2115
|
+
label?: RichContent;
|
|
2116
|
+
/**
|
|
2117
|
+
* Flag identifying if checked by default
|
|
2118
|
+
* Default: false
|
|
2119
|
+
*/
|
|
2120
|
+
checked?: boolean;
|
|
2121
|
+
}
|
|
2122
|
+
export interface InputFieldArrayType {
|
|
2123
|
+
/** Maximum amount of array elements. */
|
|
2124
|
+
maxItems?: number | null;
|
|
2125
|
+
/** Minimum amount of array elements. */
|
|
2126
|
+
minItems?: number | null;
|
|
2127
|
+
/** Type of items allowed in array. */
|
|
2128
|
+
items?: ArrayTypeArrayItems;
|
|
2129
|
+
/** Custom error message when validation fails. */
|
|
2130
|
+
errorMessages?: InputFieldArrayErrorMessages;
|
|
2131
|
+
}
|
|
2132
|
+
export declare enum ItemType {
|
|
2133
|
+
UNKNOWN_ITEM_TYPE = "UNKNOWN_ITEM_TYPE",
|
|
2134
|
+
STRING = "STRING",
|
|
2135
|
+
NUMBER = "NUMBER",
|
|
2136
|
+
BOOLEAN = "BOOLEAN",
|
|
2137
|
+
INTEGER = "INTEGER",
|
|
2138
|
+
OBJECT = "OBJECT"
|
|
2139
|
+
}
|
|
2140
|
+
export interface InputFieldIntegerType {
|
|
2141
|
+
/** Maximum value. */
|
|
2142
|
+
maximum?: number | null;
|
|
2143
|
+
/** Minimum value. */
|
|
2144
|
+
minimum?: number | null;
|
|
2145
|
+
/** Multiple of value. */
|
|
2146
|
+
multipleOf?: number | null;
|
|
2147
|
+
/** Custom error message when validation fails. */
|
|
2148
|
+
errorMessages?: InputFieldNumberErrorMessages;
|
|
2149
|
+
/** List of allowed values. */
|
|
2150
|
+
enum?: number[] | null;
|
|
2151
|
+
}
|
|
2152
|
+
export interface InputFieldObjectType {
|
|
2153
|
+
/** Description of object properties. */
|
|
2154
|
+
properties?: Record<string, ObjectTypePropertiesType>;
|
|
2155
|
+
/** Custom error message when validation fails. */
|
|
2156
|
+
errorMessages?: InputFieldObjectErrorMessages;
|
|
2157
|
+
}
|
|
2158
|
+
export declare enum PropertiesTypeEnum {
|
|
2159
|
+
UNKNOWN = "UNKNOWN",
|
|
2160
|
+
STRING = "STRING",
|
|
2161
|
+
NUMBER = "NUMBER",
|
|
2162
|
+
BOOLEAN = "BOOLEAN",
|
|
2163
|
+
INTEGER = "INTEGER",
|
|
2164
|
+
ARRAY = "ARRAY"
|
|
2165
|
+
}
|
|
2166
|
+
export interface ObjectTypePropertiesType extends ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
|
|
2167
|
+
/** String type validation for property. */
|
|
2168
|
+
stringOptions?: InputFieldStringType;
|
|
2169
|
+
/** Number type validation for property. */
|
|
2170
|
+
numberOptions?: InputFieldNumberType;
|
|
2171
|
+
/** Boolean type validation for property. */
|
|
2172
|
+
booleanOptions?: InputFieldBooleanType;
|
|
2173
|
+
/** Integer type validation for property. */
|
|
2174
|
+
integerOptions?: InputFieldIntegerType;
|
|
2175
|
+
/** Array type validation for property. */
|
|
2176
|
+
arrayOptions?: InputFieldArrayType;
|
|
2177
|
+
/**
|
|
2178
|
+
* Type of object properties
|
|
2179
|
+
* @readonly
|
|
2180
|
+
*/
|
|
2181
|
+
propertiesType?: PropertiesTypeEnum;
|
|
2182
|
+
/** Whether the property is required. */
|
|
2183
|
+
required?: boolean;
|
|
2184
|
+
}
|
|
2185
|
+
/** @oneof */
|
|
2186
|
+
export interface ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {
|
|
2187
|
+
/** String type validation for property. */
|
|
2188
|
+
stringOptions?: InputFieldStringType;
|
|
2189
|
+
/** Number type validation for property. */
|
|
2190
|
+
numberOptions?: InputFieldNumberType;
|
|
2191
|
+
/** Boolean type validation for property. */
|
|
2192
|
+
booleanOptions?: InputFieldBooleanType;
|
|
2193
|
+
/** Integer type validation for property. */
|
|
2194
|
+
integerOptions?: InputFieldIntegerType;
|
|
2195
|
+
/** Array type validation for property. */
|
|
2196
|
+
arrayOptions?: InputFieldArrayType;
|
|
2197
|
+
}
|
|
2198
|
+
export interface InputFieldObjectErrorMessages {
|
|
2199
|
+
/** Default error message on invalid validation. */
|
|
2200
|
+
default?: string | null;
|
|
2201
|
+
}
|
|
2202
|
+
export interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
2203
|
+
/** String type validation for items. */
|
|
2204
|
+
stringOptions?: InputFieldStringType;
|
|
2205
|
+
/** Number type validation for items. */
|
|
2206
|
+
numberOptions?: InputFieldNumberType;
|
|
2207
|
+
/** Boolean type validation for items. */
|
|
2208
|
+
booleanOptions?: InputFieldBooleanType;
|
|
2209
|
+
/** Integer type validation for items. */
|
|
2210
|
+
integerOptions?: InputFieldIntegerType;
|
|
2211
|
+
/** Object type validation for items */
|
|
2212
|
+
objectOptions?: InputFieldObjectType;
|
|
2213
|
+
/**
|
|
2214
|
+
* Type of array items
|
|
2215
|
+
* @readonly
|
|
2216
|
+
*/
|
|
2217
|
+
itemType?: ItemType;
|
|
2218
|
+
}
|
|
2219
|
+
/** @oneof */
|
|
2220
|
+
export interface ArrayTypeArrayItemsItemTypeOptionsOneOf {
|
|
2221
|
+
/** String type validation for items. */
|
|
2222
|
+
stringOptions?: InputFieldStringType;
|
|
2223
|
+
/** Number type validation for items. */
|
|
2224
|
+
numberOptions?: InputFieldNumberType;
|
|
2225
|
+
/** Boolean type validation for items. */
|
|
2226
|
+
booleanOptions?: InputFieldBooleanType;
|
|
2227
|
+
/** Integer type validation for items. */
|
|
2228
|
+
integerOptions?: InputFieldIntegerType;
|
|
2229
|
+
/** Object type validation for items */
|
|
2230
|
+
objectOptions?: InputFieldObjectType;
|
|
2231
|
+
}
|
|
2232
|
+
export interface InputFieldArrayErrorMessages {
|
|
2233
|
+
/** Default error message on invalid validation. */
|
|
2234
|
+
default?: string | null;
|
|
2235
|
+
}
|
|
2236
|
+
export declare enum ComponentType {
|
|
2237
|
+
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
2238
|
+
CHECKBOX_GROUP = "CHECKBOX_GROUP",
|
|
2239
|
+
TAGS = "TAGS"
|
|
2240
|
+
}
|
|
2241
|
+
export interface CheckboxGroup {
|
|
2242
|
+
/** Label of the field */
|
|
2243
|
+
label?: string | null;
|
|
2244
|
+
/** Description of the field */
|
|
2245
|
+
description?: RichContent;
|
|
2246
|
+
/** List of options to select from */
|
|
2247
|
+
options?: Option[];
|
|
2248
|
+
/**
|
|
2249
|
+
* Flag identifying to hide or not label
|
|
2250
|
+
* Default: true
|
|
2251
|
+
*/
|
|
2252
|
+
showLabel?: boolean | null;
|
|
2253
|
+
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
2254
|
+
customOption?: CustomOption;
|
|
2255
|
+
/**
|
|
2256
|
+
* Specifies the number of columns used to display the selections within the component.
|
|
2257
|
+
* Default: ONE
|
|
2258
|
+
*/
|
|
2259
|
+
numberOfColumns?: NumberOfColumns;
|
|
2260
|
+
}
|
|
2261
|
+
export interface MediaItem extends MediaItemMediaOneOf {
|
|
2262
|
+
/** WixMedia image. */
|
|
2263
|
+
image?: Image;
|
|
2264
|
+
}
|
|
2265
|
+
/** @oneof */
|
|
2266
|
+
export interface MediaItemMediaOneOf {
|
|
2267
|
+
/** WixMedia image. */
|
|
2268
|
+
image?: Image;
|
|
2269
|
+
}
|
|
2270
|
+
export interface Image {
|
|
2271
|
+
/** WixMedia image ID. */
|
|
2272
|
+
id?: string;
|
|
2273
|
+
/** Image URL. */
|
|
2274
|
+
url?: string;
|
|
2275
|
+
/**
|
|
2276
|
+
* Original image height.
|
|
2277
|
+
* @readonly
|
|
2278
|
+
*/
|
|
2279
|
+
height?: number;
|
|
2280
|
+
/**
|
|
2281
|
+
* Original image width.
|
|
2282
|
+
* @readonly
|
|
2283
|
+
*/
|
|
2284
|
+
width?: number;
|
|
2285
|
+
/** Image alt text. */
|
|
2286
|
+
altText?: string | null;
|
|
2287
|
+
/**
|
|
2288
|
+
* Image filename.
|
|
2289
|
+
* @readonly
|
|
2290
|
+
*/
|
|
2291
|
+
filename?: string | null;
|
|
2292
|
+
}
|
|
2293
|
+
export interface Option {
|
|
2294
|
+
/** Selectable option label */
|
|
2295
|
+
label?: string | null;
|
|
2296
|
+
/** Selectable option value, which is saved to DB. */
|
|
2297
|
+
value?: any;
|
|
2298
|
+
/** Flag identifying that option should be selected by default */
|
|
2299
|
+
default?: boolean;
|
|
2300
|
+
/** Option id. Used as binding for translations */
|
|
2301
|
+
id?: string;
|
|
2302
|
+
/** Media item. Media, associated with option, like image. */
|
|
2303
|
+
media?: MediaItem;
|
|
2304
|
+
}
|
|
2305
|
+
export interface CustomOption {
|
|
2306
|
+
/** Label of custom option input */
|
|
2307
|
+
label?: string | null;
|
|
2308
|
+
/** Placeholder of custom option input */
|
|
2309
|
+
placeholder?: string | null;
|
|
2310
|
+
}
|
|
2311
|
+
export interface Tags {
|
|
2312
|
+
/** Label of the field */
|
|
2313
|
+
label?: string | null;
|
|
2314
|
+
/** Description of the field */
|
|
2315
|
+
description?: RichContent;
|
|
2316
|
+
/** List of options to select from */
|
|
2317
|
+
options?: TagsOption[];
|
|
2318
|
+
/**
|
|
2319
|
+
* Flag identifying to hide or not label
|
|
2320
|
+
* Default: true
|
|
2321
|
+
*/
|
|
2322
|
+
showLabel?: boolean | null;
|
|
2323
|
+
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
2324
|
+
customOption?: CommonCustomOption;
|
|
2325
|
+
/**
|
|
2326
|
+
* Specifies the number of columns used to display the selections within the component.
|
|
2327
|
+
* Default: ONE
|
|
2328
|
+
*/
|
|
2329
|
+
numberOfColumns?: NumberOfColumns;
|
|
2330
|
+
}
|
|
2331
|
+
export interface TagsOption {
|
|
2332
|
+
/** Selectable option label */
|
|
2333
|
+
label?: string | null;
|
|
2334
|
+
/** Selectable option value, which is saved to DB. */
|
|
2335
|
+
value?: any;
|
|
2336
|
+
/** Flag identifying that option should be selected by default */
|
|
2337
|
+
default?: boolean;
|
|
2338
|
+
/** Option id. Used as binding for translations */
|
|
2339
|
+
id?: string;
|
|
2340
|
+
/** Media item. Media, associated with option, like image. */
|
|
2341
|
+
media?: MediaItem;
|
|
2342
|
+
}
|
|
2343
|
+
export interface CommonCustomOption {
|
|
2344
|
+
/** Label of custom option input */
|
|
2345
|
+
label?: string | null;
|
|
2346
|
+
/** Placeholder of custom option input */
|
|
2347
|
+
placeholder?: string | null;
|
|
2348
|
+
}
|
|
2349
|
+
export declare enum WixFileComponentType {
|
|
2350
|
+
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
2351
|
+
FILE_UPLOAD = "FILE_UPLOAD",
|
|
2352
|
+
SIGNATURE = "SIGNATURE"
|
|
2353
|
+
}
|
|
2354
|
+
export interface FileUpload {
|
|
2355
|
+
/** Selectable option label */
|
|
2356
|
+
label?: string | null;
|
|
2357
|
+
/** Description of the field */
|
|
2358
|
+
description?: RichContent;
|
|
2359
|
+
/**
|
|
2360
|
+
* Flag identifying to hide or not label
|
|
2361
|
+
* Default: true
|
|
2362
|
+
*/
|
|
2363
|
+
showLabel?: boolean | null;
|
|
2364
|
+
/** Text on upload button */
|
|
2365
|
+
buttonText?: string | null;
|
|
2366
|
+
/** Amount of files allowed to upload */
|
|
2367
|
+
fileLimit?: number;
|
|
2368
|
+
/** Supported file formats for upload */
|
|
2369
|
+
uploadFileFormats?: UploadFileFormat[];
|
|
2370
|
+
/** Custom text which appears when file is uploaded, if missing file name will be shown */
|
|
2371
|
+
explanationText?: string | null;
|
|
2372
|
+
}
|
|
2373
|
+
export declare enum UploadFileFormat {
|
|
2374
|
+
/** Undefined upload file format. */
|
|
2375
|
+
UNDEFINED = "UNDEFINED",
|
|
2376
|
+
/** Video files. */
|
|
2377
|
+
VIDEO = "VIDEO",
|
|
2378
|
+
/** Image files. */
|
|
2379
|
+
IMAGE = "IMAGE",
|
|
2380
|
+
/** Audio files. */
|
|
2381
|
+
AUDIO = "AUDIO",
|
|
2382
|
+
/** Document files. */
|
|
2383
|
+
DOCUMENT = "DOCUMENT",
|
|
2384
|
+
/** Archive files. */
|
|
2385
|
+
ARCHIVE = "ARCHIVE"
|
|
2386
|
+
}
|
|
2387
|
+
export interface Signature {
|
|
2388
|
+
/** Selectable option label */
|
|
2389
|
+
label?: string | null;
|
|
2390
|
+
/**
|
|
2391
|
+
* Flag identifying to hide label or not
|
|
2392
|
+
* Default: true
|
|
2393
|
+
*/
|
|
2394
|
+
showLabel?: boolean | null;
|
|
2395
|
+
/** Description of the field */
|
|
2396
|
+
description?: RichContent;
|
|
2397
|
+
/** Is image upload enabled */
|
|
2398
|
+
imageUploadEnabled?: boolean;
|
|
2399
|
+
}
|
|
2400
|
+
export declare enum PaymentComponentType {
|
|
2401
|
+
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
2402
|
+
CHECKBOX_GROUP = "CHECKBOX_GROUP",
|
|
2403
|
+
DONATION_INPUT = "DONATION_INPUT",
|
|
2404
|
+
PAYMENT_INPUT = "PAYMENT_INPUT",
|
|
2405
|
+
FIXED_PAYMENT = "FIXED_PAYMENT"
|
|
2406
|
+
}
|
|
2407
|
+
export interface ProductCheckboxGroup {
|
|
2408
|
+
/** Label of the field. */
|
|
2409
|
+
label?: string | null;
|
|
2410
|
+
/** Description of the field. */
|
|
2411
|
+
description?: RichContent;
|
|
2412
|
+
/** List of options to select from. */
|
|
2413
|
+
options?: ProductCheckboxGroupOption[];
|
|
2414
|
+
/**
|
|
2415
|
+
* Flag identifying to hide or not label
|
|
2416
|
+
* Default: true
|
|
2417
|
+
*/
|
|
2418
|
+
showLabel?: boolean | null;
|
|
2419
|
+
/**
|
|
2420
|
+
* Defines how an image should be resized to fit within its option.
|
|
2421
|
+
* Default: COVER
|
|
2422
|
+
*/
|
|
2423
|
+
imageFit?: ImageFit;
|
|
2424
|
+
}
|
|
2425
|
+
export interface ProductCheckboxGroupOption {
|
|
2426
|
+
/** Selectable option label. */
|
|
2427
|
+
label?: string | null;
|
|
2428
|
+
/** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
|
|
2429
|
+
value?: any;
|
|
2430
|
+
/** Option id. Used as binding for translations. */
|
|
2431
|
+
id?: string;
|
|
2432
|
+
/** Media item. Media, associated with option, like image. */
|
|
2433
|
+
media?: MediaItem;
|
|
2434
|
+
/** Flag identifying that option should be selected by default */
|
|
2435
|
+
default?: boolean;
|
|
2436
|
+
}
|
|
2437
|
+
export declare enum ImageFit {
|
|
2438
|
+
UNKNOWN_IMAGE_FIT = "UNKNOWN_IMAGE_FIT",
|
|
2439
|
+
/** Image is scaled to maintain its aspect ratio while filling the element's entire content box. Portions of the image may be clipped if the aspect ratios do not match. */
|
|
2440
|
+
COVER = "COVER",
|
|
2441
|
+
/** Image is resized to fill the element's content box. Aspect ratio may not be preserved. */
|
|
2442
|
+
CONTAIN = "CONTAIN"
|
|
2443
|
+
}
|
|
2444
|
+
export interface DonationInput {
|
|
2445
|
+
/** Label of the field. */
|
|
2446
|
+
label?: string | null;
|
|
2447
|
+
/** Description of the field. */
|
|
2448
|
+
description?: RichContent;
|
|
2449
|
+
/** List of options to select from. */
|
|
2450
|
+
options?: DonationInputOption[];
|
|
2451
|
+
/** Option which can be specified by UoU, enabled when this object is specified. */
|
|
2452
|
+
customOption?: CommonCustomOption;
|
|
2453
|
+
/**
|
|
2454
|
+
* Specifies the number of columns used to display the selections within the component.
|
|
2455
|
+
* Default: ONE
|
|
2456
|
+
*/
|
|
2457
|
+
numberOfColumns?: NumberOfColumns;
|
|
2458
|
+
/**
|
|
2459
|
+
* Flag identifying to hide or not label
|
|
2460
|
+
* Default: true
|
|
2461
|
+
*/
|
|
2462
|
+
showLabel?: boolean | null;
|
|
2463
|
+
}
|
|
2464
|
+
export interface DonationInputOption {
|
|
2465
|
+
/** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */
|
|
2466
|
+
value?: string;
|
|
2467
|
+
/** Flag identifying that option should be selected by default */
|
|
2468
|
+
default?: boolean;
|
|
2469
|
+
}
|
|
2470
|
+
export interface PaymentInput {
|
|
2471
|
+
/** Label of the field. */
|
|
2472
|
+
label?: string | null;
|
|
2473
|
+
/** Description of the field. */
|
|
2474
|
+
description?: RichContent;
|
|
2475
|
+
/**
|
|
2476
|
+
* Flag identifying to hide or not label
|
|
2477
|
+
* Default: true
|
|
2478
|
+
*/
|
|
2479
|
+
showLabel?: boolean | null;
|
|
2480
|
+
/** Placeholder of custom option input */
|
|
2481
|
+
placeholder?: string | null;
|
|
2482
|
+
/** Default value for the payment input */
|
|
2483
|
+
default?: number | null;
|
|
2484
|
+
}
|
|
2485
|
+
export interface FixedPayment {
|
|
2486
|
+
/** Label of the field. */
|
|
2487
|
+
label?: string | null;
|
|
2488
|
+
/** Description of the field. */
|
|
2489
|
+
description?: RichContent;
|
|
2490
|
+
/**
|
|
2491
|
+
* Flag identifying to hide or not label
|
|
2492
|
+
* Default: true
|
|
2493
|
+
*/
|
|
2494
|
+
showLabel?: boolean | null;
|
|
2495
|
+
}
|
|
2496
|
+
export declare enum SchedulingComponentType {
|
|
2497
|
+
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
2498
|
+
APPOINTMENT = "APPOINTMENT"
|
|
2499
|
+
}
|
|
2500
|
+
export interface Appointment extends AppointmentFormatInfoOneOf {
|
|
2501
|
+
/** In person options for the appointment */
|
|
2502
|
+
inPersonOptions?: InPersonOptions;
|
|
2503
|
+
/** Online video conference options for the appointment */
|
|
2504
|
+
videoConferenceOptions?: VideoConferenceOptions;
|
|
2505
|
+
/** Phone options for the appointment */
|
|
2506
|
+
phoneOptions?: PhoneOptions;
|
|
2507
|
+
/** Label of the field */
|
|
2508
|
+
label?: string | null;
|
|
2509
|
+
/** Name of the appointment */
|
|
2510
|
+
name?: string | null;
|
|
2511
|
+
/** Duration of the appointment in minutes */
|
|
2512
|
+
durationInMinutes?: number | null;
|
|
2513
|
+
/** Indicates whether manual approval is required for the appointment */
|
|
2514
|
+
manualApprovalRequired?: boolean | null;
|
|
2515
|
+
/** ID of the staff members providing the appointment */
|
|
2516
|
+
staffIds?: string[] | null;
|
|
2517
|
+
/** The format of the appointment */
|
|
2518
|
+
format?: Format;
|
|
2519
|
+
}
|
|
2520
|
+
/** @oneof */
|
|
2521
|
+
export interface AppointmentFormatInfoOneOf {
|
|
2522
|
+
/** In person options for the appointment */
|
|
2523
|
+
inPersonOptions?: InPersonOptions;
|
|
2524
|
+
/** Online video conference options for the appointment */
|
|
2525
|
+
videoConferenceOptions?: VideoConferenceOptions;
|
|
2526
|
+
/** Phone options for the appointment */
|
|
2527
|
+
phoneOptions?: PhoneOptions;
|
|
2528
|
+
}
|
|
2529
|
+
export interface Location extends LocationLocationInfoOneOf {
|
|
2530
|
+
/** Custom address details */
|
|
2531
|
+
customAddress?: string | null;
|
|
2532
|
+
/** ID of a business location */
|
|
2533
|
+
businessLocationId?: string | null;
|
|
2534
|
+
}
|
|
2535
|
+
/** @oneof */
|
|
2536
|
+
export interface LocationLocationInfoOneOf {
|
|
2537
|
+
/** Custom address details */
|
|
2538
|
+
customAddress?: string | null;
|
|
2539
|
+
/** ID of a business location */
|
|
2540
|
+
businessLocationId?: string | null;
|
|
2541
|
+
}
|
|
2542
|
+
export declare enum Format {
|
|
2543
|
+
UNKNOWN_FORMAT_TYPE = "UNKNOWN_FORMAT_TYPE",
|
|
2544
|
+
IN_PERSON = "IN_PERSON",
|
|
2545
|
+
VIDEO_CONFERENCE = "VIDEO_CONFERENCE",
|
|
2546
|
+
PHONE = "PHONE"
|
|
2547
|
+
}
|
|
2548
|
+
export interface InPersonOptions {
|
|
2549
|
+
/** The locations details */
|
|
2550
|
+
locations?: Location[];
|
|
2551
|
+
}
|
|
2552
|
+
export interface VideoConferenceOptions {
|
|
2553
|
+
/** Description or instructions for the online video conference */
|
|
2554
|
+
description?: string | null;
|
|
2555
|
+
}
|
|
2556
|
+
export interface PhoneOptions {
|
|
2557
|
+
/** Description or instructions for the phone appointment */
|
|
2558
|
+
description?: string | null;
|
|
2559
|
+
}
|
|
2560
|
+
export declare enum MultilineAddressComponentType {
|
|
2561
|
+
UNKNOWN_COMPONENT_TYPE = "UNKNOWN_COMPONENT_TYPE",
|
|
2562
|
+
MULTILINE_ADDRESS = "MULTILINE_ADDRESS"
|
|
2563
|
+
}
|
|
2564
|
+
export interface MultilineAddress {
|
|
2565
|
+
/** Label of the field. */
|
|
2566
|
+
label?: string | null;
|
|
2567
|
+
/** Description of the field. */
|
|
2568
|
+
description?: RichContent;
|
|
2569
|
+
/** Show country flags. */
|
|
2570
|
+
showCountryFlags?: boolean;
|
|
2571
|
+
/** Default country configuration. */
|
|
2572
|
+
defaultCountryConfig?: DefaultCountryConfig;
|
|
2573
|
+
/** Fields settings. */
|
|
2574
|
+
fieldSettings?: FieldsSettings;
|
|
2575
|
+
/** Autocomplete enabled for address line field. */
|
|
2576
|
+
autocompleteEnabled?: boolean;
|
|
2577
|
+
}
|
|
2578
|
+
export declare enum Type {
|
|
2579
|
+
/** Unknown default country config type. */
|
|
2580
|
+
UNKNOWN_DEFAULT_COUNTRY = "UNKNOWN_DEFAULT_COUNTRY",
|
|
2581
|
+
/** Country is determined by customer's IP address. */
|
|
2582
|
+
BY_IP = "BY_IP",
|
|
2583
|
+
/** Pre-selected default country. */
|
|
2584
|
+
COUNTRY = "COUNTRY"
|
|
2585
|
+
}
|
|
2586
|
+
export interface AddressLine2 {
|
|
2587
|
+
/** Show address line 2 field. */
|
|
2588
|
+
show?: boolean;
|
|
2589
|
+
}
|
|
2590
|
+
export interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {
|
|
2591
|
+
/** Country. */
|
|
2592
|
+
countryOptions?: string;
|
|
2593
|
+
/** Default country type. */
|
|
2594
|
+
type?: Type;
|
|
2595
|
+
}
|
|
2596
|
+
/** @oneof */
|
|
2597
|
+
export interface DefaultCountryConfigOptionsOneOf {
|
|
2598
|
+
/** Country. */
|
|
2599
|
+
countryOptions?: string;
|
|
2600
|
+
}
|
|
2601
|
+
export interface FieldsSettings {
|
|
2602
|
+
/** Address line 2. */
|
|
2603
|
+
addressLine2?: AddressLine2;
|
|
2604
|
+
}
|
|
2605
|
+
export declare enum InputType {
|
|
2606
|
+
UNKNOWN_INPUT_TYPE = "UNKNOWN_INPUT_TYPE",
|
|
2607
|
+
STRING = "STRING",
|
|
2608
|
+
NUMBER = "NUMBER",
|
|
2609
|
+
BOOLEAN = "BOOLEAN",
|
|
2610
|
+
ARRAY = "ARRAY",
|
|
2611
|
+
OBJECT = "OBJECT",
|
|
2612
|
+
WIX_FILE = "WIX_FILE",
|
|
2613
|
+
PAYMENT = "PAYMENT",
|
|
2614
|
+
MULTILINE_ADDRESS = "MULTILINE_ADDRESS",
|
|
2615
|
+
SCHEDULING = "SCHEDULING"
|
|
2616
|
+
}
|
|
2617
|
+
export interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfoOneOf {
|
|
2618
|
+
/** Email info. */
|
|
2619
|
+
emailInfo?: EmailInfo;
|
|
2620
|
+
/** Phone info. */
|
|
2621
|
+
phoneInfo?: PhoneInfo;
|
|
2622
|
+
/** Address info. */
|
|
2623
|
+
addressInfo?: AddressInfo;
|
|
2624
|
+
/** Custom field info. */
|
|
2625
|
+
customFieldInfo?: CustomFieldInfo;
|
|
2626
|
+
/** Subscription info */
|
|
2627
|
+
subscriptionInfo?: SubscriptionInfo;
|
|
2628
|
+
/** Field mapped to contacts. */
|
|
2629
|
+
contactField?: ContactField;
|
|
2630
|
+
}
|
|
2631
|
+
/** @oneof */
|
|
2632
|
+
export interface FormFieldContactInfoAdditionalInfoOneOf {
|
|
2633
|
+
/** Email info. */
|
|
2634
|
+
emailInfo?: EmailInfo;
|
|
2635
|
+
/** Phone info. */
|
|
2636
|
+
phoneInfo?: PhoneInfo;
|
|
2637
|
+
/** Address info. */
|
|
2638
|
+
addressInfo?: AddressInfo;
|
|
2639
|
+
/** Custom field info. */
|
|
2640
|
+
customFieldInfo?: CustomFieldInfo;
|
|
2641
|
+
/** Subscription info */
|
|
2642
|
+
subscriptionInfo?: SubscriptionInfo;
|
|
2643
|
+
}
|
|
2644
|
+
export declare enum EmailInfoTag {
|
|
2645
|
+
UNTAGGED = "UNTAGGED",
|
|
2646
|
+
MAIN = "MAIN"
|
|
2647
|
+
}
|
|
2648
|
+
export declare enum PhoneInfoTag {
|
|
2649
|
+
UNTAGGED = "UNTAGGED",
|
|
2650
|
+
MAIN = "MAIN"
|
|
2651
|
+
}
|
|
2652
|
+
export declare enum Tag {
|
|
2653
|
+
UNTAGGED = "UNTAGGED",
|
|
2654
|
+
HOME = "HOME"
|
|
2655
|
+
}
|
|
2656
|
+
export declare enum OptInLevel {
|
|
2657
|
+
UNKNOWN = "UNKNOWN",
|
|
2658
|
+
SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
|
|
2659
|
+
DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
|
|
2660
|
+
}
|
|
2661
|
+
export declare enum ContactField {
|
|
2662
|
+
UNDEFINED = "UNDEFINED",
|
|
2663
|
+
FIRST_NAME = "FIRST_NAME",
|
|
2664
|
+
LAST_NAME = "LAST_NAME",
|
|
2665
|
+
COMPANY = "COMPANY",
|
|
2666
|
+
POSITION = "POSITION",
|
|
2667
|
+
EMAIL = "EMAIL",
|
|
2668
|
+
PHONE = "PHONE",
|
|
2669
|
+
ADDRESS = "ADDRESS",
|
|
2670
|
+
BIRTHDATE = "BIRTHDATE",
|
|
2671
|
+
CUSTOM_FIELD = "CUSTOM_FIELD",
|
|
2672
|
+
SUBSCRIPTION = "SUBSCRIPTION",
|
|
2673
|
+
VAT_ID = "VAT_ID"
|
|
2674
|
+
}
|
|
2675
|
+
export interface EmailInfo {
|
|
2676
|
+
/** Email tag. */
|
|
2677
|
+
tag?: EmailInfoTag;
|
|
2678
|
+
}
|
|
2679
|
+
export interface PhoneInfo {
|
|
2680
|
+
/** Phone tag. */
|
|
2681
|
+
tag?: PhoneInfoTag;
|
|
2682
|
+
}
|
|
2683
|
+
export interface AddressInfo {
|
|
2684
|
+
/** Address tag. */
|
|
2685
|
+
tag?: Tag;
|
|
2686
|
+
}
|
|
2687
|
+
export interface CustomFieldInfo {
|
|
2688
|
+
/** Custom field key. */
|
|
2689
|
+
key?: string;
|
|
2690
|
+
}
|
|
2691
|
+
export interface SubscriptionInfo {
|
|
2692
|
+
/**
|
|
2693
|
+
* Subscription consent opt in level, either single or double confirmation.
|
|
2694
|
+
* Default: SINGLE_CONFIRMATION
|
|
2695
|
+
*/
|
|
2696
|
+
optInLevel?: OptInLevel;
|
|
2697
|
+
}
|
|
2698
|
+
export interface _String extends _StringComponentTypeOptionsOneOf {
|
|
2699
|
+
/** Text input field */
|
|
2700
|
+
textInputOptions?: TextInput;
|
|
2701
|
+
/** Selection field as radio group */
|
|
2702
|
+
radioGroupOptions?: RadioGroup;
|
|
2703
|
+
/** Selection field as drop down */
|
|
2704
|
+
dropdownOptions?: Dropdown;
|
|
2705
|
+
/** Field for selecting date and/or time */
|
|
2706
|
+
dateTimeOptions?: DateTimeInput;
|
|
2707
|
+
/** Phone input field */
|
|
2708
|
+
phoneInputOptions?: PhoneInput;
|
|
2709
|
+
/** Dropdown based component for selecting date */
|
|
2710
|
+
dateInputOptions?: DateInput;
|
|
2711
|
+
/** Field for selecting time */
|
|
2712
|
+
timeInputOptions?: TimeInput;
|
|
2713
|
+
/** Calendar type component for selecting date */
|
|
2714
|
+
datePickerOptions?: DatePicker;
|
|
2715
|
+
/** Validation of field output value. */
|
|
2716
|
+
validation?: InputFieldStringType;
|
|
2717
|
+
/**
|
|
2718
|
+
* Component type of the string input field
|
|
2719
|
+
* @readonly
|
|
2720
|
+
*/
|
|
2721
|
+
componentType?: StringComponentType;
|
|
2722
|
+
}
|
|
2723
|
+
/** @oneof */
|
|
2724
|
+
export interface _StringComponentTypeOptionsOneOf {
|
|
2725
|
+
/** Text input field */
|
|
2726
|
+
textInputOptions?: TextInput;
|
|
2727
|
+
/** Selection field as radio group */
|
|
2728
|
+
radioGroupOptions?: RadioGroup;
|
|
2729
|
+
/** Selection field as drop down */
|
|
2730
|
+
dropdownOptions?: Dropdown;
|
|
2731
|
+
/** Field for selecting date and/or time */
|
|
2732
|
+
dateTimeOptions?: DateTimeInput;
|
|
2733
|
+
/** Phone input field */
|
|
2734
|
+
phoneInputOptions?: PhoneInput;
|
|
2735
|
+
/** Dropdown based component for selecting date */
|
|
2736
|
+
dateInputOptions?: DateInput;
|
|
2737
|
+
/** Field for selecting time */
|
|
2738
|
+
timeInputOptions?: TimeInput;
|
|
2739
|
+
/** Calendar type component for selecting date */
|
|
2740
|
+
datePickerOptions?: DatePicker;
|
|
2741
|
+
}
|
|
2742
|
+
export interface _Number extends _NumberComponentTypeOptionsOneOf {
|
|
2743
|
+
/** Number value input field */
|
|
2744
|
+
numberInputOptions?: NumberInput;
|
|
2745
|
+
/** Rating value input field */
|
|
2746
|
+
ratingInputOptions?: RatingInput;
|
|
2747
|
+
/** Validation of field output value. */
|
|
2748
|
+
validation?: InputFieldNumberType;
|
|
2749
|
+
/**
|
|
2750
|
+
* Component type of the number input field
|
|
2751
|
+
* @readonly
|
|
2752
|
+
*/
|
|
2753
|
+
componentType?: NumberComponentType;
|
|
2754
|
+
}
|
|
2755
|
+
/** @oneof */
|
|
2756
|
+
export interface _NumberComponentTypeOptionsOneOf {
|
|
2757
|
+
/** Number value input field */
|
|
2758
|
+
numberInputOptions?: NumberInput;
|
|
2759
|
+
/** Rating value input field */
|
|
2760
|
+
ratingInputOptions?: RatingInput;
|
|
2761
|
+
}
|
|
2762
|
+
export interface _Boolean extends _BooleanComponentTypeOptionsOneOf {
|
|
2763
|
+
/** Checkbox input field */
|
|
2764
|
+
checkboxOptions?: Checkbox;
|
|
2765
|
+
/** Validation of field output value. */
|
|
2766
|
+
validation?: InputFieldBooleanType;
|
|
2767
|
+
/**
|
|
2768
|
+
* Component type of the boolean input field
|
|
2769
|
+
* @readonly
|
|
2770
|
+
*/
|
|
2771
|
+
componentType?: BooleanComponentType;
|
|
2772
|
+
}
|
|
2773
|
+
/** @oneof */
|
|
2774
|
+
export interface _BooleanComponentTypeOptionsOneOf {
|
|
2775
|
+
/** Checkbox input field */
|
|
2776
|
+
checkboxOptions?: Checkbox;
|
|
2777
|
+
}
|
|
2778
|
+
export interface _Array extends _ArrayComponentTypeOptionsOneOf {
|
|
2779
|
+
/** Checkbox group input field */
|
|
2780
|
+
checkboxGroupOptions?: CheckboxGroup;
|
|
2781
|
+
/** Tags input field */
|
|
2782
|
+
tagsOptions?: Tags;
|
|
2783
|
+
/** Validation of array type. */
|
|
2784
|
+
validation?: InputFieldArrayType;
|
|
2785
|
+
/**
|
|
2786
|
+
* Component type of the array input field
|
|
2787
|
+
* @readonly
|
|
2788
|
+
*/
|
|
2789
|
+
componentType?: ComponentType;
|
|
2790
|
+
}
|
|
2791
|
+
/** @oneof */
|
|
2792
|
+
export interface _ArrayComponentTypeOptionsOneOf {
|
|
2793
|
+
/** Checkbox group input field */
|
|
2794
|
+
checkboxGroupOptions?: CheckboxGroup;
|
|
2795
|
+
/** Tags input field */
|
|
2796
|
+
tagsOptions?: Tags;
|
|
2797
|
+
}
|
|
2798
|
+
export interface _Object extends _ObjectValidationOneOf {
|
|
2799
|
+
/** Validation of object type. */
|
|
2800
|
+
object?: InputFieldObjectType;
|
|
2801
|
+
}
|
|
2802
|
+
/** @oneof */
|
|
2803
|
+
export interface _ObjectValidationOneOf {
|
|
2804
|
+
/** Validation of object type. */
|
|
2805
|
+
object?: InputFieldObjectType;
|
|
2806
|
+
}
|
|
2807
|
+
export interface WixFile extends WixFileComponentTypeOptionsOneOf {
|
|
2808
|
+
/** File upload input field */
|
|
2809
|
+
fileUploadOptions?: FileUpload;
|
|
2810
|
+
/** Signature input field */
|
|
2811
|
+
signatureOptions?: Signature;
|
|
2812
|
+
/**
|
|
2813
|
+
* Component type of the array input field
|
|
2814
|
+
* @readonly
|
|
2815
|
+
*/
|
|
2816
|
+
componentType?: WixFileComponentType;
|
|
2817
|
+
}
|
|
2818
|
+
/** @oneof */
|
|
2819
|
+
export interface WixFileComponentTypeOptionsOneOf {
|
|
2820
|
+
/** File upload input field */
|
|
2821
|
+
fileUploadOptions?: FileUpload;
|
|
2822
|
+
/** Signature input field */
|
|
2823
|
+
signatureOptions?: Signature;
|
|
2824
|
+
}
|
|
2825
|
+
export interface Payment extends PaymentComponentTypeOptionsOneOf {
|
|
2826
|
+
/** Checkbox group input field. */
|
|
2827
|
+
checkboxGroupOptions?: ProductCheckboxGroup;
|
|
2828
|
+
/** Donation input field. */
|
|
2829
|
+
donationInputOptions?: DonationInput;
|
|
2830
|
+
/** Payment input field. */
|
|
2831
|
+
paymentInputOptions?: PaymentInput;
|
|
2832
|
+
/** Fixed payment field. */
|
|
2833
|
+
fixedPaymentOptions?: FixedPayment;
|
|
2834
|
+
/**
|
|
2835
|
+
* Component type of the payment input field.
|
|
2836
|
+
* @readonly
|
|
2837
|
+
*/
|
|
2838
|
+
componentType?: PaymentComponentType;
|
|
2839
|
+
/** Validation of payment type. */
|
|
2840
|
+
validation?: PaymentType;
|
|
2841
|
+
}
|
|
2842
|
+
/** @oneof */
|
|
2843
|
+
export interface PaymentComponentTypeOptionsOneOf {
|
|
2844
|
+
/** Checkbox group input field. */
|
|
2845
|
+
checkboxGroupOptions?: ProductCheckboxGroup;
|
|
2846
|
+
/** Donation input field. */
|
|
2847
|
+
donationInputOptions?: DonationInput;
|
|
2848
|
+
/** Payment input field. */
|
|
2849
|
+
paymentInputOptions?: PaymentInput;
|
|
2850
|
+
/** Fixed payment field. */
|
|
2851
|
+
fixedPaymentOptions?: FixedPayment;
|
|
2852
|
+
}
|
|
2853
|
+
export interface InputFieldMultilineAddress extends InputFieldMultilineAddressComponentTypeOptionsOneOf {
|
|
2854
|
+
/** Multiline address input field. */
|
|
2855
|
+
multilineAddressOptions?: MultilineAddress;
|
|
2856
|
+
/**
|
|
2857
|
+
* Component type of the multiline address field.
|
|
2858
|
+
* @readonly
|
|
2859
|
+
*/
|
|
2860
|
+
componentType?: MultilineAddressComponentType;
|
|
2861
|
+
/** Validation of multiline address field output value. */
|
|
2862
|
+
validation?: MultilineAddressValidation;
|
|
2863
|
+
}
|
|
2864
|
+
/** @oneof */
|
|
2865
|
+
export interface InputFieldMultilineAddressComponentTypeOptionsOneOf {
|
|
2866
|
+
/** Multiline address input field. */
|
|
2867
|
+
multilineAddressOptions?: MultilineAddress;
|
|
2868
|
+
}
|
|
2869
|
+
export interface Scheduling extends SchedulingComponentTypeOptionsOneOf {
|
|
2870
|
+
/** Appointment input field */
|
|
2871
|
+
appointmentOptions?: Appointment;
|
|
2872
|
+
/**
|
|
2873
|
+
* Component type of the scheduling input field
|
|
2874
|
+
* @readonly
|
|
2875
|
+
*/
|
|
2876
|
+
componentType?: SchedulingComponentType;
|
|
2877
|
+
}
|
|
2878
|
+
/** @oneof */
|
|
2879
|
+
export interface SchedulingComponentTypeOptionsOneOf {
|
|
2880
|
+
/** Appointment input field */
|
|
2881
|
+
appointmentOptions?: Appointment;
|
|
2882
|
+
}
|
|
2883
|
+
export declare enum FieldType {
|
|
2884
|
+
UNKNOWN = "UNKNOWN",
|
|
2885
|
+
INPUT = "INPUT",
|
|
2886
|
+
DISPLAY = "DISPLAY"
|
|
2887
|
+
}
|
|
2888
|
+
export interface InputField extends InputFieldInputTypeOptionsOneOf {
|
|
2889
|
+
/** Input return string as value */
|
|
2890
|
+
stringOptions?: _String;
|
|
2891
|
+
/** Input return number as value */
|
|
2892
|
+
numberOptions?: _Number;
|
|
2893
|
+
/** Input return boolean as value */
|
|
2894
|
+
booleanOptions?: _Boolean;
|
|
2895
|
+
/** Input return array as value */
|
|
2896
|
+
arrayOptions?: _Array;
|
|
2897
|
+
/** Input return object as value */
|
|
2898
|
+
objectOptions?: _Object;
|
|
2899
|
+
/** Input return "Wix file" as value */
|
|
2900
|
+
wixFileOptions?: WixFile;
|
|
2901
|
+
/** Input returns selected products as value. */
|
|
2902
|
+
paymentOptions?: Payment;
|
|
2903
|
+
/** Input returns multiline address as value. */
|
|
2904
|
+
multilineAddressOptions?: InputFieldMultilineAddress;
|
|
2905
|
+
/** Input returns scheduling as value. */
|
|
2906
|
+
schedulingOptions?: Scheduling;
|
|
2907
|
+
/** Definition of a target where the value of field belongs. */
|
|
2908
|
+
target?: string | null;
|
|
2909
|
+
/**
|
|
2910
|
+
* Mark the field as containing personal information. This will encrypt user data when storing it.
|
|
2911
|
+
* Default: false
|
|
2912
|
+
*/
|
|
2913
|
+
pii?: boolean;
|
|
2914
|
+
/**
|
|
2915
|
+
* Whether the field is required.
|
|
2916
|
+
* Default: false
|
|
2917
|
+
*/
|
|
2918
|
+
required?: boolean;
|
|
2919
|
+
/**
|
|
2920
|
+
* Type of the input field
|
|
2921
|
+
* @readonly
|
|
2922
|
+
*/
|
|
2923
|
+
inputType?: InputType;
|
|
2924
|
+
/** Mapping to contacts, telling to what contact property field input value should be saved. */
|
|
2925
|
+
contactMapping?: FormFieldContactInfo;
|
|
2926
|
+
/**
|
|
2927
|
+
* Whether the field is read only.
|
|
2928
|
+
* Default: false
|
|
2929
|
+
*/
|
|
2930
|
+
readOnly?: boolean;
|
|
2931
|
+
}
|
|
2932
|
+
/** @oneof */
|
|
2933
|
+
export interface InputFieldInputTypeOptionsOneOf {
|
|
2934
|
+
/** Input return string as value */
|
|
2935
|
+
stringOptions?: _String;
|
|
2936
|
+
/** Input return number as value */
|
|
2937
|
+
numberOptions?: _Number;
|
|
2938
|
+
/** Input return boolean as value */
|
|
2939
|
+
booleanOptions?: _Boolean;
|
|
2940
|
+
/** Input return array as value */
|
|
2941
|
+
arrayOptions?: _Array;
|
|
2942
|
+
/** Input return object as value */
|
|
2943
|
+
objectOptions?: _Object;
|
|
2944
|
+
/** Input return "Wix file" as value */
|
|
2945
|
+
wixFileOptions?: WixFile;
|
|
2946
|
+
/** Input returns selected products as value. */
|
|
2947
|
+
paymentOptions?: Payment;
|
|
2948
|
+
/** Input returns multiline address as value. */
|
|
2949
|
+
multilineAddressOptions?: InputFieldMultilineAddress;
|
|
2950
|
+
/** Input returns scheduling as value. */
|
|
2951
|
+
schedulingOptions?: Scheduling;
|
|
2952
|
+
}
|
|
2953
|
+
/** Copy of the entity existing in form template project, needed to hide translations. */
|
|
2954
|
+
export interface DisplayField extends DisplayFieldDisplayFieldTypeOptionsOneOf {
|
|
2955
|
+
/** Component displaying rich content */
|
|
2956
|
+
richContentOptions?: RichContentOptions;
|
|
2957
|
+
/** Page navigation component resolving as navigation or submit buttons */
|
|
2958
|
+
pageNavigationOptions?: PageNavigationOptions;
|
|
2959
|
+
/** Type of the display field */
|
|
2960
|
+
displayFieldType?: DisplayFieldType;
|
|
2961
|
+
}
|
|
2962
|
+
/** @oneof */
|
|
2963
|
+
export interface DisplayFieldDisplayFieldTypeOptionsOneOf {
|
|
2964
|
+
/** Component displaying rich content */
|
|
2965
|
+
richContentOptions?: RichContentOptions;
|
|
2966
|
+
/** Page navigation component resolving as navigation or submit buttons */
|
|
2967
|
+
pageNavigationOptions?: PageNavigationOptions;
|
|
2968
|
+
}
|
|
2969
|
+
export declare enum DisplayFieldType {
|
|
2970
|
+
UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
|
|
2971
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
2972
|
+
PAGE_NAVIGATION = "PAGE_NAVIGATION"
|
|
2973
|
+
}
|
|
2974
|
+
export interface RichContentOptions {
|
|
2975
|
+
/** Content of the header */
|
|
2976
|
+
richContent?: RichContent;
|
|
2977
|
+
}
|
|
2978
|
+
export interface PageNavigationOptions {
|
|
2979
|
+
/** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */
|
|
2980
|
+
nextPageText?: string | null;
|
|
2981
|
+
/** When button is not on last page it behaves as switch between pages page, text of label to go to previous page. */
|
|
2982
|
+
previousPageText?: string | null;
|
|
2983
|
+
/** Text on the button when button is submitting a form */
|
|
2984
|
+
submitText?: string | null;
|
|
2985
|
+
}
|
|
2986
|
+
export interface Step {
|
|
2987
|
+
/** Step ID. */
|
|
2988
|
+
id?: string;
|
|
2989
|
+
/** Name of the step. */
|
|
2990
|
+
name?: string | null;
|
|
2991
|
+
/** Is step hidden */
|
|
2992
|
+
hidden?: boolean;
|
|
2993
|
+
/** Form step properties */
|
|
2994
|
+
layout?: FormLayout;
|
|
2995
|
+
}
|
|
2996
|
+
export interface FormLayout {
|
|
2997
|
+
/** Layout for large break point. */
|
|
2998
|
+
large?: BreakPoint;
|
|
2999
|
+
/** Layout for medium break point. */
|
|
3000
|
+
medium?: BreakPoint;
|
|
3001
|
+
/** Layout for small break point. */
|
|
3002
|
+
small?: BreakPoint;
|
|
3003
|
+
}
|
|
3004
|
+
export interface BreakPoint {
|
|
3005
|
+
/** Description of layouts for items. */
|
|
3006
|
+
items?: ItemLayout[];
|
|
3007
|
+
/** Amount of columns of layout grid. */
|
|
3008
|
+
columns?: number | null;
|
|
3009
|
+
/** Row height of layout grid. */
|
|
3010
|
+
rowHeight?: number | null;
|
|
3011
|
+
/** Description of elements margins. */
|
|
3012
|
+
margin?: Margin;
|
|
3013
|
+
/** Description of elements paddings. */
|
|
3014
|
+
padding?: Margin;
|
|
3015
|
+
/** Sections of the layout, which allow manage fields */
|
|
3016
|
+
sections?: Section[];
|
|
3017
|
+
}
|
|
3018
|
+
export interface ItemLayout extends ItemLayoutItemOneOf {
|
|
3019
|
+
/** Form field reference id. */
|
|
3020
|
+
fieldId?: string;
|
|
3021
|
+
/** Group info, defining that this item is a group of multiple fields */
|
|
3022
|
+
group?: Group;
|
|
3023
|
+
/** Horizontal coordinate in the grid. */
|
|
3024
|
+
row?: number | null;
|
|
3025
|
+
/** Vertical coordinate in the grid. */
|
|
3026
|
+
column?: number | null;
|
|
3027
|
+
/** Height. */
|
|
3028
|
+
width?: number | null;
|
|
3029
|
+
/** Width. */
|
|
3030
|
+
height?: number | null;
|
|
3031
|
+
}
|
|
3032
|
+
/** @oneof */
|
|
3033
|
+
export interface ItemLayoutItemOneOf {
|
|
3034
|
+
/** Form field reference id. */
|
|
3035
|
+
fieldId?: string;
|
|
3036
|
+
/** Group info, defining that this item is a group of multiple fields */
|
|
3037
|
+
group?: Group;
|
|
3038
|
+
}
|
|
3039
|
+
export interface Group {
|
|
3040
|
+
/** Field group reference id. */
|
|
3041
|
+
groupId?: string;
|
|
3042
|
+
/** Description of layouts for items. */
|
|
3043
|
+
items?: ItemLayout[];
|
|
3044
|
+
}
|
|
3045
|
+
export interface Margin {
|
|
3046
|
+
/** Horizontal value. */
|
|
3047
|
+
horizontal?: number | null;
|
|
3048
|
+
/** Vertical value. */
|
|
3049
|
+
vertical?: number | null;
|
|
3050
|
+
}
|
|
3051
|
+
export interface Section {
|
|
3052
|
+
/** Id of the section */
|
|
3053
|
+
id?: string;
|
|
3054
|
+
/** Horizontal coordinate in the grid. */
|
|
3055
|
+
row?: number | null;
|
|
3056
|
+
/**
|
|
3057
|
+
* A list of field identifiers that are permitted to be placed within a section.
|
|
3058
|
+
* The section will only accept fields with IDs specified in this list.
|
|
3059
|
+
* If the section encounters the $new key within the list,
|
|
3060
|
+
* it allows the inclusion of fields not explicitly listed,
|
|
3061
|
+
* enabling dynamic addition of new fields.
|
|
3062
|
+
*/
|
|
3063
|
+
allowedFieldIds?: string[];
|
|
3064
|
+
}
|
|
3065
|
+
export interface FormRule {
|
|
3066
|
+
/** Id of the rule */
|
|
3067
|
+
id?: string;
|
|
3068
|
+
/** Rule on which item properties or layouts will be changed. */
|
|
3069
|
+
condition?: Record<string, any> | null;
|
|
3070
|
+
/**
|
|
3071
|
+
* Form items with defined properties that will be
|
|
3072
|
+
* changed when given condition is resolved to true.
|
|
3073
|
+
*/
|
|
3074
|
+
overrides?: FormOverride[];
|
|
3075
|
+
/** Name of the rule */
|
|
3076
|
+
name?: string | null;
|
|
3077
|
+
}
|
|
3078
|
+
export declare enum OverrideEntityType {
|
|
3079
|
+
UNKNOWN = "UNKNOWN",
|
|
3080
|
+
FIELD = "FIELD"
|
|
3081
|
+
}
|
|
3082
|
+
export interface FormOverride {
|
|
3083
|
+
/** Override entity type. */
|
|
3084
|
+
entityType?: OverrideEntityType;
|
|
3085
|
+
/** Overridden entity id. Either fieldId, or "{fieldIdWithNestedForm}/{nestedFormFieldId}" */
|
|
3086
|
+
entityId?: string | null;
|
|
3087
|
+
/** Form entity properties path with new value, that will be changed on condition. */
|
|
3088
|
+
valueChanges?: Record<string, any>;
|
|
3089
|
+
}
|
|
3090
|
+
export interface FormProperties {
|
|
3091
|
+
/** Form name. */
|
|
3092
|
+
name?: string | null;
|
|
3093
|
+
/**
|
|
3094
|
+
* Identifies if the form is disabled.
|
|
3095
|
+
* @deprecated Identifies if the form is disabled.
|
|
3096
|
+
* @replacedBy wix.forms.v4.Form.enabled
|
|
3097
|
+
* @targetRemovalDate 2026-01-06
|
|
3098
|
+
*/
|
|
3099
|
+
disabled?: boolean;
|
|
3100
|
+
}
|
|
3101
|
+
export declare enum Kind {
|
|
3102
|
+
/** Return forms specific to tenant, excluding template based forms. */
|
|
3103
|
+
REGULAR = "REGULAR",
|
|
3104
|
+
/** Return forms based on common templates, with applied user overrides if they exist. */
|
|
3105
|
+
EXTENSION = "EXTENSION"
|
|
3106
|
+
}
|
|
3107
|
+
export interface PostSubmissionTriggers {
|
|
3108
|
+
/** Upserts a contact from the submission data. */
|
|
3109
|
+
upsertContact?: UpsertContact;
|
|
3110
|
+
}
|
|
3111
|
+
export interface UpsertContact {
|
|
3112
|
+
/** Fields mapping (target field mapped to corresponding contact field). */
|
|
3113
|
+
fieldsMapping?: Record<string, FormFieldContactInfo>;
|
|
3114
|
+
/**
|
|
3115
|
+
* List of contact label keys.
|
|
3116
|
+
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
3117
|
+
* help categorize contacts.
|
|
3118
|
+
*/
|
|
3119
|
+
labels?: string[];
|
|
3120
|
+
}
|
|
3121
|
+
export interface ExtendedFields {
|
|
3122
|
+
/**
|
|
3123
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
3124
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
3125
|
+
*
|
|
3126
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
3127
|
+
*
|
|
3128
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
3129
|
+
*/
|
|
3130
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
3131
|
+
}
|
|
3132
|
+
export interface NestedForm {
|
|
3133
|
+
/** Targets which have this form. */
|
|
3134
|
+
targets?: string[];
|
|
3135
|
+
/** Nested form. */
|
|
3136
|
+
form?: Form;
|
|
3137
|
+
}
|
|
3138
|
+
export interface LimitationRule {
|
|
3139
|
+
/** Limitation by submission count, disables form when a set amount of submissions is reached. */
|
|
3140
|
+
maxAllowedSubmissions?: number | null;
|
|
3141
|
+
/** Limitation by submission date, disables form when a set date and time is reached. */
|
|
3142
|
+
dateTimeDeadline?: Date | null;
|
|
3143
|
+
}
|
|
3144
|
+
export declare enum SpamFilterProtectionLevel {
|
|
3145
|
+
/** Unknown spam filter protection level. */
|
|
3146
|
+
UNKNOWN = "UNKNOWN",
|
|
3147
|
+
/** Spam filter is not used. Form is open for spam submissions. */
|
|
3148
|
+
NONE = "NONE",
|
|
3149
|
+
/** Spam filter operates in basic mode. Form is open to high risk of spam submissions. */
|
|
3150
|
+
BASIC = "BASIC",
|
|
3151
|
+
/** Spam filter operates in advanced mode. Form is open to low risk of spam submissions. */
|
|
3152
|
+
ADVANCED = "ADVANCED"
|
|
3153
|
+
}
|
|
3154
|
+
export interface RequiredIndicatorProperties {
|
|
3155
|
+
/** Required indicator. */
|
|
3156
|
+
requiredIndicator?: RequiredIndicator;
|
|
3157
|
+
/** Required indicator placement. */
|
|
3158
|
+
requiredIndicatorPlacement?: RequiredIndicatorPlacement;
|
|
3159
|
+
}
|
|
3160
|
+
export interface SubmitSettings extends SubmitSettingsSubmitSuccessActionOptionsOneOf {
|
|
3161
|
+
/** Options for showing a thank you message after submission. */
|
|
3162
|
+
thankYouMessageOptions?: ThankYouMessageOptions;
|
|
3163
|
+
/** Options for redirecting to a URL after submission. */
|
|
3164
|
+
redirectOptions?: RedirectOptions;
|
|
3165
|
+
/** Action that is triggered after a successful form submission. */
|
|
3166
|
+
submitSuccessAction?: SubmitSuccessAction;
|
|
3167
|
+
}
|
|
3168
|
+
/** @oneof */
|
|
3169
|
+
export interface SubmitSettingsSubmitSuccessActionOptionsOneOf {
|
|
3170
|
+
/** Options for showing a thank you message after submission. */
|
|
3171
|
+
thankYouMessageOptions?: ThankYouMessageOptions;
|
|
3172
|
+
/** Options for redirecting to a URL after submission. */
|
|
3173
|
+
redirectOptions?: RedirectOptions;
|
|
3174
|
+
}
|
|
3175
|
+
export declare enum Target {
|
|
3176
|
+
/** Unknown target. */
|
|
3177
|
+
UNKNOWN_TARGET = "UNKNOWN_TARGET",
|
|
3178
|
+
/** Open in the same browser tab. */
|
|
3179
|
+
SELF = "SELF",
|
|
3180
|
+
/** Open in a new browser tab. */
|
|
3181
|
+
BLANK = "BLANK"
|
|
3182
|
+
}
|
|
3183
|
+
export declare enum SubmitSuccessAction {
|
|
3184
|
+
/** Unknown submit success action. */
|
|
3185
|
+
UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
|
|
3186
|
+
/** No action will be taken after submission. */
|
|
3187
|
+
NO_ACTION = "NO_ACTION",
|
|
3188
|
+
/** A thank you message will be shown after submission. */
|
|
3189
|
+
THANK_YOU_MESSAGE = "THANK_YOU_MESSAGE",
|
|
3190
|
+
/** The user will be redirected to a URL after submission. */
|
|
3191
|
+
REDIRECT = "REDIRECT"
|
|
3192
|
+
}
|
|
3193
|
+
export interface ThankYouMessageOptions {
|
|
3194
|
+
/** Duration in seconds after which the message should disappear. If 0, the message will stay forever. */
|
|
3195
|
+
durationInSeconds?: number | null;
|
|
3196
|
+
/** The message shown after form submission. */
|
|
3197
|
+
richContent?: RichContent;
|
|
3198
|
+
}
|
|
3199
|
+
export interface RedirectOptions {
|
|
3200
|
+
/** The URL to which the user should be redirected after a successful form submission. */
|
|
3201
|
+
redirectUrl?: string | null;
|
|
3202
|
+
/** How the URL should be opened. */
|
|
3203
|
+
target?: Target;
|
|
3204
|
+
}
|
|
3205
|
+
export interface FieldGroup {
|
|
3206
|
+
/** Id of group, on layout */
|
|
3207
|
+
id?: string;
|
|
3208
|
+
/** Label of group */
|
|
3209
|
+
label?: string | null;
|
|
3210
|
+
}
|
|
3211
|
+
export interface PiiFieldsUpdated {
|
|
3212
|
+
/** Collection of fields which are marked as PII */
|
|
3213
|
+
piiFields?: string[];
|
|
3214
|
+
/** Collection of fields which are non PII */
|
|
3215
|
+
nonPiiFields?: string[];
|
|
3216
|
+
}
|
|
3217
|
+
export interface SubmissionKeysPermanentlyDeleted {
|
|
3218
|
+
/** Keys which should be deleted */
|
|
3219
|
+
keys?: string[] | null;
|
|
3220
|
+
}
|
|
3221
|
+
export interface CreateFormRequest {
|
|
3222
|
+
/** Form to be created. */
|
|
3223
|
+
form: Form;
|
|
3224
|
+
}
|
|
3225
|
+
export interface CreateFormResponse {
|
|
3226
|
+
/** The created form. */
|
|
3227
|
+
form?: Form;
|
|
3228
|
+
}
|
|
3229
|
+
export interface TargetBasedErrorDetails {
|
|
3230
|
+
/** Targets which are related to the error. */
|
|
3231
|
+
targets?: string[];
|
|
3232
|
+
}
|
|
3233
|
+
export interface FieldIdBasedErrorDetails {
|
|
3234
|
+
/** Field ids which are related to the error. */
|
|
3235
|
+
ids?: string[];
|
|
3236
|
+
}
|
|
3237
|
+
export interface StepIdBasedErrorDetails {
|
|
3238
|
+
/** Step ids which are related to the error. */
|
|
3239
|
+
ids?: string[];
|
|
3240
|
+
}
|
|
3241
|
+
export interface RuleIdBasedErrorDetails {
|
|
3242
|
+
/** Rule ids which are related to the error. */
|
|
3243
|
+
ids?: string[];
|
|
3244
|
+
}
|
|
3245
|
+
export interface NonExistingNestedFormsErrorDetails {
|
|
3246
|
+
/** Non existing nested form ids by target */
|
|
3247
|
+
targetToNestedFormId?: Record<string, string>;
|
|
3248
|
+
}
|
|
3249
|
+
export interface NestedFormFieldsMissingErrorDetails {
|
|
3250
|
+
/** Missing nested template field ids by target. */
|
|
3251
|
+
targetToNestedFormFieldIds?: Record<string, FieldIdBasedErrorDetails>;
|
|
3252
|
+
}
|
|
3253
|
+
export interface FormFieldV2ApiValidationErrorDetails {
|
|
3254
|
+
/** Field ids which are related to the error. */
|
|
3255
|
+
ids?: string[];
|
|
3256
|
+
/** Violations which are related to the error. */
|
|
3257
|
+
violations?: string[];
|
|
3258
|
+
}
|
|
3259
|
+
export interface ProductIdBasedErrorDetails {
|
|
3260
|
+
/** Product ids which are related to the error. */
|
|
3261
|
+
ids?: string[];
|
|
3262
|
+
}
|
|
3263
|
+
export interface BulkCreateFormRequest {
|
|
3264
|
+
/** Forms to be created. */
|
|
3265
|
+
forms?: Form[];
|
|
3266
|
+
/** When set, items will be returned on successful create */
|
|
3267
|
+
returnEntity?: boolean;
|
|
3268
|
+
}
|
|
3269
|
+
export interface BulkCreateFormResponse {
|
|
3270
|
+
/** Created forms with metadata */
|
|
3271
|
+
results?: BulkFormResult[];
|
|
3272
|
+
/** Metadata of request */
|
|
3273
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
3274
|
+
}
|
|
3275
|
+
export interface BulkFormResult {
|
|
3276
|
+
/** Created form metadata */
|
|
3277
|
+
itemMetadata?: ItemMetadata;
|
|
3278
|
+
/** Created form */
|
|
3279
|
+
item?: Form;
|
|
3280
|
+
}
|
|
3281
|
+
export interface ItemMetadata {
|
|
3282
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
3283
|
+
id?: string | null;
|
|
3284
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3285
|
+
originalIndex?: number;
|
|
3286
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
3287
|
+
success?: boolean;
|
|
3288
|
+
/** Details about the error in case of failure. */
|
|
3289
|
+
error?: ApplicationError;
|
|
3290
|
+
}
|
|
3291
|
+
export interface ApplicationError {
|
|
3292
|
+
/** Error code. */
|
|
3293
|
+
code?: string;
|
|
3294
|
+
/** Description of the error. */
|
|
3295
|
+
description?: string;
|
|
3296
|
+
/** Data related to the error. */
|
|
3297
|
+
data?: Record<string, any> | null;
|
|
3298
|
+
}
|
|
3299
|
+
export interface BulkActionMetadata {
|
|
3300
|
+
/** Number of items that were successfully processed. */
|
|
3301
|
+
totalSuccesses?: number;
|
|
3302
|
+
/** Number of items that couldn't be processed. */
|
|
3303
|
+
totalFailures?: number;
|
|
3304
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
3305
|
+
undetailedFailures?: number;
|
|
3306
|
+
}
|
|
3307
|
+
export interface CloneFormRequest {
|
|
3308
|
+
/** Id of the form to clone. */
|
|
3309
|
+
formId: string;
|
|
3310
|
+
}
|
|
3311
|
+
export interface CloneFormResponse {
|
|
3312
|
+
/** The cloned form. */
|
|
3313
|
+
form?: Form;
|
|
3314
|
+
}
|
|
3315
|
+
export interface CloneFormFromTemplateRequest {
|
|
3316
|
+
/** Namespace of the vertical owning template */
|
|
3317
|
+
namespace?: string;
|
|
3318
|
+
/** Template id which can be copied */
|
|
3319
|
+
templateId?: string;
|
|
3320
|
+
/**
|
|
3321
|
+
* When true, will try to create form with same id as template
|
|
3322
|
+
* Will fail if entity with such Id already exists
|
|
3323
|
+
*/
|
|
3324
|
+
useTemplateId?: boolean;
|
|
3325
|
+
}
|
|
3326
|
+
export interface CloneFormFromTemplateResponse {
|
|
3327
|
+
/** The cloned form. */
|
|
3328
|
+
form?: Form;
|
|
3329
|
+
}
|
|
3330
|
+
export interface GetFormRequest {
|
|
3331
|
+
/** Id of the form to retrieve. */
|
|
3332
|
+
formId: string;
|
|
3333
|
+
/**
|
|
3334
|
+
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3335
|
+
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3336
|
+
* only the form’s base fields are returned.
|
|
3337
|
+
*/
|
|
3338
|
+
fieldsets?: Fieldset[];
|
|
3339
|
+
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
3340
|
+
additionalMetadata?: Record<string, any> | null;
|
|
3341
|
+
}
|
|
3342
|
+
export declare enum Fieldset {
|
|
3343
|
+
UNKNOWN = "UNKNOWN",
|
|
3344
|
+
/** Includes nested forms when present. */
|
|
3345
|
+
NESTED_FORMS = "NESTED_FORMS"
|
|
3346
|
+
}
|
|
3347
|
+
export interface GetFormResponse {
|
|
3348
|
+
/** The retrieved form. */
|
|
3349
|
+
form?: Form;
|
|
3350
|
+
}
|
|
3351
|
+
export interface UpdateFormRequest {
|
|
3352
|
+
/** Form to be updated, may be partial. */
|
|
3353
|
+
form: Form;
|
|
3354
|
+
}
|
|
3355
|
+
export interface UpdateFormResponse {
|
|
3356
|
+
/** The updated form. */
|
|
3357
|
+
form?: Form;
|
|
3358
|
+
}
|
|
3359
|
+
export interface RemoveFormFromTrashBinRequest {
|
|
3360
|
+
/** Id of the form to delete. */
|
|
3361
|
+
formId: string;
|
|
3362
|
+
}
|
|
3363
|
+
export interface RemoveFormFromTrashBinResponse {
|
|
3364
|
+
}
|
|
3365
|
+
export interface DeleteFormRequest {
|
|
3366
|
+
/** Id of the form to delete. */
|
|
3367
|
+
formId: string;
|
|
3368
|
+
/**
|
|
3369
|
+
* Delete form bypassing trash-bin.
|
|
3370
|
+
* Default: false
|
|
3371
|
+
*/
|
|
3372
|
+
permanent?: boolean;
|
|
3373
|
+
}
|
|
3374
|
+
export interface DeleteFormResponse {
|
|
3375
|
+
}
|
|
3376
|
+
export interface RestoreFromTrashBinRequest {
|
|
3377
|
+
/** Id of the form to restore. */
|
|
3378
|
+
formId: string;
|
|
3379
|
+
}
|
|
3380
|
+
export interface RestoreFromTrashBinResponse {
|
|
3381
|
+
/** The restored form. */
|
|
3382
|
+
form?: Form;
|
|
3383
|
+
}
|
|
3384
|
+
export interface QueryFormsRequest {
|
|
3385
|
+
/** WQL expression, namespace equality filter is required. */
|
|
3386
|
+
query: CursorQuery;
|
|
3387
|
+
/**
|
|
3388
|
+
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3389
|
+
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3390
|
+
* only the form’s base fields are returned.
|
|
3391
|
+
*/
|
|
3392
|
+
fieldsets?: Fieldset[];
|
|
3393
|
+
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
3394
|
+
additionalMetadata?: Record<string, any> | null;
|
|
3395
|
+
}
|
|
3396
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
3397
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
3398
|
+
cursorPaging?: CursorPaging;
|
|
3399
|
+
/**
|
|
3400
|
+
* Filter object in the following format:
|
|
3401
|
+
* `"filter" : {
|
|
3402
|
+
* "fieldName1": "value1",
|
|
3403
|
+
* "fieldName2":{"$operator":"value2"}
|
|
3404
|
+
* }`
|
|
3405
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
3406
|
+
*/
|
|
3407
|
+
filter?: Record<string, any> | null;
|
|
3408
|
+
/**
|
|
3409
|
+
* Sort object in the following format:
|
|
3410
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
3411
|
+
*/
|
|
3412
|
+
sort?: Sorting[];
|
|
3413
|
+
}
|
|
3414
|
+
/** @oneof */
|
|
3415
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
3416
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
3417
|
+
cursorPaging?: CursorPaging;
|
|
3418
|
+
}
|
|
3419
|
+
export interface Sorting {
|
|
3420
|
+
/** Name of the field to sort by. */
|
|
3421
|
+
fieldName?: string;
|
|
3422
|
+
/** Sort order. */
|
|
3423
|
+
order?: SortOrder;
|
|
3424
|
+
}
|
|
3425
|
+
export declare enum SortOrder {
|
|
3426
|
+
ASC = "ASC",
|
|
3427
|
+
DESC = "DESC"
|
|
3428
|
+
}
|
|
3429
|
+
export interface CursorPaging {
|
|
3430
|
+
/** Number of items to load. */
|
|
3431
|
+
limit?: number | null;
|
|
3432
|
+
/**
|
|
3433
|
+
* Pointer to the next or previous page in the list of results.
|
|
3434
|
+
*
|
|
3435
|
+
* You can get the relevant cursor token
|
|
3436
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
3437
|
+
* Not relevant for the first request.
|
|
3438
|
+
*/
|
|
3439
|
+
cursor?: string | null;
|
|
3440
|
+
}
|
|
3441
|
+
export interface QueryFormsResponse {
|
|
3442
|
+
/** The retrieved forms */
|
|
3443
|
+
forms?: Form[];
|
|
3444
|
+
/** Details on the paged set of results returned. */
|
|
3445
|
+
metadata?: CursorPagingMetadata;
|
|
3446
|
+
}
|
|
3447
|
+
export interface CursorPagingMetadata {
|
|
3448
|
+
/** Number of items returned in the response. */
|
|
3449
|
+
count?: number | null;
|
|
3450
|
+
/** Offset that was requested. */
|
|
3451
|
+
cursors?: Cursors;
|
|
3452
|
+
/**
|
|
3453
|
+
* Indicates if there are more results after the current page.
|
|
3454
|
+
* If `true`, another page of results can be retrieved.
|
|
3455
|
+
* If `false`, this is the last page.
|
|
3456
|
+
*/
|
|
3457
|
+
hasNext?: boolean | null;
|
|
3458
|
+
}
|
|
3459
|
+
export interface Cursors {
|
|
3460
|
+
/** Cursor pointing to next page in the list of results. */
|
|
3461
|
+
next?: string | null;
|
|
3462
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
3463
|
+
prev?: string | null;
|
|
3464
|
+
}
|
|
3465
|
+
export interface CountFormsRequest {
|
|
3466
|
+
/** Namespace name. */
|
|
3467
|
+
namespace: string;
|
|
3468
|
+
/** Fieldsets. */
|
|
3469
|
+
fieldsets?: CountFormsFieldset[];
|
|
3470
|
+
}
|
|
3471
|
+
export declare enum CountFormsFieldset {
|
|
3472
|
+
UNKNOWN = "UNKNOWN",
|
|
3473
|
+
/** Include deleted forms count. */
|
|
3474
|
+
DELETED = "DELETED"
|
|
3475
|
+
}
|
|
3476
|
+
export interface CountFormsResponse {
|
|
3477
|
+
/** Total forms count. Includes active and disabled forms. Does not include deleted forms. */
|
|
3478
|
+
totalCount?: number;
|
|
3479
|
+
/** Active forms count. Only includes non-disabled forms if FT CountFormsActiveCountExcludeDisabled is true, otherwise behaves like total_count. */
|
|
3480
|
+
activeCount?: number;
|
|
3481
|
+
/** Disabled forms count. */
|
|
3482
|
+
disabledCount?: number;
|
|
3483
|
+
/** Deleted forms count. Counted only if specifically requested using a fieldset. */
|
|
3484
|
+
deletedCount?: number | null;
|
|
3485
|
+
}
|
|
3486
|
+
export interface ListTemplateExtensionsRequest {
|
|
3487
|
+
/** Namespace name. */
|
|
3488
|
+
namespace?: string;
|
|
3489
|
+
/** Identifies if the form is disabled. */
|
|
3490
|
+
disabled?: boolean | null;
|
|
3491
|
+
/**
|
|
3492
|
+
* Ordering options.
|
|
3493
|
+
*
|
|
3494
|
+
* - `UPDATED_DATE_DESC`: Ordered by `updatedDate` in descending order.
|
|
3495
|
+
* - `UPDATED_DATE_ASC`: Ordered by `updatedDate` in ascending order.
|
|
3496
|
+
* - `CREATED_DATE_ASC`: Ordered by `createdDate` in ascending order.
|
|
3497
|
+
* - `CREATED_DATE_DESC`: Ordered by `createdDate` in descending order.
|
|
3498
|
+
* - `NAME_ASC`: Ordered by `properties.name` in ascending order.
|
|
3499
|
+
* - `NAME_DESC`: Ordered by `properties.name` in descending order.
|
|
3500
|
+
*
|
|
3501
|
+
* Default: `UPDATED_DATE_DESC`
|
|
3502
|
+
*/
|
|
3503
|
+
order?: ListFormsOrder;
|
|
3504
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or `order`. */
|
|
3505
|
+
paging?: CursorPaging;
|
|
3506
|
+
/**
|
|
3507
|
+
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3508
|
+
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3509
|
+
* only the form’s base fields are returned.
|
|
3510
|
+
*/
|
|
3511
|
+
fieldsets?: Fieldset[];
|
|
3512
|
+
/** Form ids. */
|
|
3513
|
+
formIds?: string[];
|
|
3514
|
+
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
3515
|
+
additionalMetadata?: Record<string, any> | null;
|
|
3516
|
+
/** Filter by name */
|
|
3517
|
+
nameFilter?: NameFilter;
|
|
3518
|
+
/** List of templates id, which extensions expected */
|
|
3519
|
+
templateIds?: string[];
|
|
3520
|
+
}
|
|
3521
|
+
export declare enum ListFormsOrder {
|
|
3522
|
+
/** Sorting by updated date descending. The default value. */
|
|
3523
|
+
UPDATED_DATE_DESC = "UPDATED_DATE_DESC",
|
|
3524
|
+
/** Sorting by updated date ascending. */
|
|
3525
|
+
UPDATED_DATE_ASC = "UPDATED_DATE_ASC",
|
|
3526
|
+
/** Sorting by created date ascending. */
|
|
3527
|
+
CREATED_DATE_ASC = "CREATED_DATE_ASC",
|
|
3528
|
+
/** Sorting by created date descending. */
|
|
3529
|
+
CREATED_DATE_DESC = "CREATED_DATE_DESC",
|
|
3530
|
+
/** Sorting by name ascending. */
|
|
3531
|
+
NAME_ASC = "NAME_ASC",
|
|
3532
|
+
/** Sorting by name descending. */
|
|
3533
|
+
NAME_DESC = "NAME_DESC"
|
|
3534
|
+
}
|
|
3535
|
+
export interface NameFilter {
|
|
3536
|
+
/** Type of filter */
|
|
3537
|
+
filterType?: FilterType;
|
|
3538
|
+
/** Expected name */
|
|
3539
|
+
name?: string;
|
|
3540
|
+
}
|
|
3541
|
+
export declare enum FilterType {
|
|
3542
|
+
EXACT_MATCH = "EXACT_MATCH",
|
|
3543
|
+
STARTS_WITH = "STARTS_WITH"
|
|
3544
|
+
}
|
|
3545
|
+
export interface ListTemplateExtensionsResponse {
|
|
3546
|
+
/** The retrieved forms. */
|
|
3547
|
+
forms?: Form[];
|
|
3548
|
+
/** Details on the paged set of results returned. */
|
|
3549
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
3550
|
+
}
|
|
3551
|
+
export interface ListFormsRequest {
|
|
3552
|
+
/** Namespace name. */
|
|
3553
|
+
namespace: string;
|
|
3554
|
+
/**
|
|
3555
|
+
* Identifies if the form is disabled.
|
|
3556
|
+
* @deprecated Identifies if the form is disabled.
|
|
3557
|
+
* @replacedBy wix.forms.v4.ListFormsRequest.enabled
|
|
3558
|
+
* @targetRemovalDate 2026-01-06
|
|
3559
|
+
*/
|
|
3560
|
+
disabled?: boolean | null;
|
|
3561
|
+
/**
|
|
3562
|
+
* Ordering options.
|
|
3563
|
+
*
|
|
3564
|
+
* - `UPDATED_DATE_DESC`: Ordered by `updatedDate` in descending order.
|
|
3565
|
+
* - `UPDATED_DATE_ASC`: Ordered by `updatedDate` in ascending order.
|
|
3566
|
+
* - `CREATED_DATE_ASC`: Ordered by `createdDate` in ascending order.
|
|
3567
|
+
* - `CREATED_DATE_DESC`: Ordered by `createdDate` in descending order.
|
|
3568
|
+
* - `NAME_ASC`: Ordered by `properties.name` in ascending order.
|
|
3569
|
+
* - `NAME_DESC`: Ordered by `properties.name` in descending order.
|
|
3570
|
+
*
|
|
3571
|
+
* Default: `UPDATED_DATE_DESC`
|
|
3572
|
+
*/
|
|
3573
|
+
order?: ListFormsRequestListFormsOrder;
|
|
3574
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or `order`. */
|
|
3575
|
+
paging?: CursorPaging;
|
|
3576
|
+
/**
|
|
3577
|
+
* List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in
|
|
3578
|
+
* the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3579
|
+
* only the form’s base fields are returned.
|
|
3580
|
+
*/
|
|
3581
|
+
fieldsets?: Fieldset[];
|
|
3582
|
+
/** Form ids. */
|
|
3583
|
+
formIds?: string[];
|
|
3584
|
+
/** Identifies if the form is a payment form */
|
|
3585
|
+
paymentForm?: boolean | null;
|
|
3586
|
+
/** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */
|
|
3587
|
+
additionalMetadata?: Record<string, any> | null;
|
|
3588
|
+
/** Filter by name */
|
|
3589
|
+
nameFilter?: NameFilter;
|
|
3590
|
+
/**
|
|
3591
|
+
* Identifies if the form is enabled.
|
|
3592
|
+
* Default: true
|
|
3593
|
+
*/
|
|
3594
|
+
enabled?: boolean | null;
|
|
3595
|
+
}
|
|
3596
|
+
export declare enum ListFormsRequestListFormsOrder {
|
|
3597
|
+
/** Sorting by updated date descending. The default value. */
|
|
3598
|
+
UPDATED_DATE_DESC = "UPDATED_DATE_DESC",
|
|
3599
|
+
/** Sorting by updated date ascending. */
|
|
3600
|
+
UPDATED_DATE_ASC = "UPDATED_DATE_ASC",
|
|
3601
|
+
/** Sorting by created date ascendingd. */
|
|
3602
|
+
CREATED_DATE_ASC = "CREATED_DATE_ASC",
|
|
3603
|
+
/** Sorting by created date descending. */
|
|
3604
|
+
CREATED_DATE_DESC = "CREATED_DATE_DESC",
|
|
3605
|
+
/** Sorting by name ascending. */
|
|
3606
|
+
NAME_ASC = "NAME_ASC",
|
|
3607
|
+
/** Sorting by name descending. */
|
|
3608
|
+
NAME_DESC = "NAME_DESC"
|
|
3609
|
+
}
|
|
3610
|
+
export interface ListFormsResponse {
|
|
3611
|
+
/** The retrieved forms. */
|
|
3612
|
+
forms?: Form[];
|
|
3613
|
+
/** Details on the paged set of results returned. */
|
|
3614
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
3615
|
+
}
|
|
3616
|
+
export interface GetDeletedFormRequest {
|
|
3617
|
+
/** Id of the Form to retrieve */
|
|
3618
|
+
formId: string;
|
|
3619
|
+
}
|
|
3620
|
+
export interface GetDeletedFormResponse {
|
|
3621
|
+
/** The retrieved Form */
|
|
3622
|
+
form?: Form;
|
|
3623
|
+
}
|
|
3624
|
+
export interface QueryDeletedFormsRequest {
|
|
3625
|
+
/** WQL expression, namespace equality filter is required. */
|
|
3626
|
+
query: CursorQuery;
|
|
3627
|
+
}
|
|
3628
|
+
export interface QueryDeletedFormsResponse {
|
|
3629
|
+
/** The retrieved Forms */
|
|
3630
|
+
forms?: Form[];
|
|
3631
|
+
/** Details on the paged set of results returned. */
|
|
3632
|
+
metadata?: CursorPagingMetadata;
|
|
3633
|
+
}
|
|
3634
|
+
export interface ListDeletedFormsRequest {
|
|
3635
|
+
/** Namespace name. */
|
|
3636
|
+
namespace: string;
|
|
3637
|
+
/** Identifies if the form is disabled. */
|
|
3638
|
+
disabled?: boolean | null;
|
|
3639
|
+
/** Form ids. */
|
|
3640
|
+
formIds?: string[];
|
|
3641
|
+
/**
|
|
3642
|
+
* Ordering options.
|
|
3643
|
+
*
|
|
3644
|
+
* - `UPDATED_DATE_ASC`: Ordered by `updatedDate` in ascending order.
|
|
3645
|
+
* - `UPDATED_DATE_DESC`: Ordered by `updatedDate` in descending order.
|
|
3646
|
+
* - `NAME_ASC`: Ordered by `properties.name` in ascending order.
|
|
3647
|
+
* - `NAME_DESC`: Ordered by `properties.name` in descending order.
|
|
3648
|
+
*
|
|
3649
|
+
* Default: `UPDATED_DATE_DESC`
|
|
3650
|
+
*/
|
|
3651
|
+
order?: ListDeletedFormsOrder;
|
|
3652
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not filter or `order`. */
|
|
3653
|
+
paging?: CursorPaging;
|
|
3654
|
+
/** Identifies if the form is a payment form */
|
|
3655
|
+
paymentForm?: boolean | null;
|
|
3656
|
+
}
|
|
3657
|
+
export declare enum ListDeletedFormsOrder {
|
|
3658
|
+
/** Sorting by updated date descending. The default value. */
|
|
3659
|
+
UPDATED_DATE_DESC = "UPDATED_DATE_DESC",
|
|
3660
|
+
/** Sorting by updated date ascending. */
|
|
3661
|
+
UPDATED_DATE_ASC = "UPDATED_DATE_ASC",
|
|
3662
|
+
/** Sorting by name descending. */
|
|
3663
|
+
NAME_DESC = "NAME_DESC",
|
|
3664
|
+
/** Sorting by name ascending. */
|
|
3665
|
+
NAME_ASC = "NAME_ASC"
|
|
3666
|
+
}
|
|
3667
|
+
export interface ListDeletedFormsResponse {
|
|
3668
|
+
/** The retrieved forms. */
|
|
3669
|
+
forms?: Form[];
|
|
3670
|
+
/** Details on the paged set of results returned. */
|
|
3671
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
3672
|
+
}
|
|
3673
|
+
export interface BulkRemoveDeletedFieldRequest {
|
|
3674
|
+
/** Id of the form to delete. */
|
|
3675
|
+
formId: string;
|
|
3676
|
+
/** Ids of the deleted fields to remove. */
|
|
3677
|
+
fieldsIds?: string[];
|
|
3678
|
+
}
|
|
3679
|
+
export interface BulkRemoveDeletedFieldResponse {
|
|
3680
|
+
/** Form with the deleted fields. */
|
|
3681
|
+
form?: Form;
|
|
3682
|
+
}
|
|
3683
|
+
export interface UpdateExtendedFieldsRequest {
|
|
3684
|
+
/** ID of the entity to update. */
|
|
3685
|
+
id: string;
|
|
3686
|
+
/** Identifier for the app whose extended fields are being updated. */
|
|
3687
|
+
namespace: string;
|
|
3688
|
+
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
3689
|
+
namespaceData: Record<string, any> | null;
|
|
3690
|
+
}
|
|
3691
|
+
export interface UpdateExtendedFieldsResponse {
|
|
3692
|
+
/** namespace that was updated */
|
|
3693
|
+
namespace?: string;
|
|
3694
|
+
/** only data from UpdateExtendedFieldsRequest namespace_data */
|
|
3695
|
+
namespaceData?: Record<string, any> | null;
|
|
3696
|
+
}
|
|
3697
|
+
export interface ListFormsProvidersConfigsRequest {
|
|
3698
|
+
}
|
|
3699
|
+
export interface ListFormsProvidersConfigsResponse {
|
|
3700
|
+
/** List of configs set by form providers */
|
|
3701
|
+
configs?: FormsSchemaProvidersConfig[];
|
|
3702
|
+
}
|
|
3703
|
+
export interface FormsSchemaProvidersConfig {
|
|
3704
|
+
/** Namespace which can be used to create form */
|
|
3705
|
+
namespace?: string;
|
|
3706
|
+
/** Id of app which provides this config. */
|
|
3707
|
+
appId?: string;
|
|
3708
|
+
/** Restrictions associated with this namespace. */
|
|
3709
|
+
restrictions?: FormProviderRestrictions;
|
|
3710
|
+
}
|
|
3711
|
+
export interface FormProviderRestrictions {
|
|
3712
|
+
/** Maximum amount of forms allowed per namespace. */
|
|
3713
|
+
maxFormsAmount?: number;
|
|
3714
|
+
/** Maximum amount of fields allowed per form. */
|
|
3715
|
+
maxFieldsAmount?: number;
|
|
3716
|
+
/** Maximum amount of deleted forms allowed per namespace. */
|
|
3717
|
+
maxDeletedFormsAmount?: number | null;
|
|
3718
|
+
}
|
|
3719
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3720
|
+
createdEvent?: EntityCreatedEvent;
|
|
3721
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3722
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3723
|
+
actionEvent?: ActionEvent;
|
|
3724
|
+
/**
|
|
3725
|
+
* Unique event ID.
|
|
3726
|
+
* Allows clients to ignore duplicate webhooks.
|
|
3727
|
+
*/
|
|
3728
|
+
id?: string;
|
|
3729
|
+
/**
|
|
3730
|
+
* Assumes actions are also always typed to an entity_type
|
|
3731
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
3732
|
+
*/
|
|
3733
|
+
entityFqdn?: string;
|
|
3734
|
+
/**
|
|
3735
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
3736
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
3737
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
3738
|
+
*/
|
|
3739
|
+
slug?: string;
|
|
3740
|
+
/** ID of the entity associated with the event. */
|
|
3741
|
+
entityId?: string;
|
|
3742
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
3743
|
+
eventTime?: Date | null;
|
|
3744
|
+
/**
|
|
3745
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3746
|
+
* (for example, GDPR).
|
|
3747
|
+
*/
|
|
3748
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3749
|
+
/** If present, indicates the action that triggered the event. */
|
|
3750
|
+
originatedFrom?: string | null;
|
|
3751
|
+
/**
|
|
3752
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
3753
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
3754
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3755
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3756
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3757
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3758
|
+
*/
|
|
3759
|
+
entityEventSequence?: string | null;
|
|
3760
|
+
}
|
|
3761
|
+
/** @oneof */
|
|
3762
|
+
export interface DomainEventBodyOneOf {
|
|
3763
|
+
createdEvent?: EntityCreatedEvent;
|
|
3764
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3765
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3766
|
+
actionEvent?: ActionEvent;
|
|
3767
|
+
}
|
|
3768
|
+
export interface EntityCreatedEvent {
|
|
3769
|
+
entityAsJson?: string;
|
|
3770
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
3771
|
+
restoreInfo?: RestoreInfo;
|
|
3772
|
+
}
|
|
3773
|
+
export interface RestoreInfo {
|
|
3774
|
+
deletedDate?: Date | null;
|
|
3775
|
+
}
|
|
3776
|
+
export interface EntityUpdatedEvent {
|
|
3777
|
+
/**
|
|
3778
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3779
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3780
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3781
|
+
*/
|
|
3782
|
+
currentEntityAsJson?: string;
|
|
3783
|
+
}
|
|
3784
|
+
export interface EntityDeletedEvent {
|
|
3785
|
+
/** Entity that was deleted */
|
|
3786
|
+
deletedEntityAsJson?: string | null;
|
|
3787
|
+
}
|
|
3788
|
+
export interface ActionEvent {
|
|
3789
|
+
bodyAsJson?: string;
|
|
3790
|
+
}
|
|
3791
|
+
export interface Empty {
|
|
3792
|
+
}
|
|
3793
|
+
export interface GetFormSummaryRequest {
|
|
3794
|
+
/** Id of the form to retrieve. */
|
|
3795
|
+
formId: string;
|
|
3796
|
+
}
|
|
3797
|
+
export interface GetFormSummaryResponse {
|
|
3798
|
+
/** The retrieved form field summary. */
|
|
3799
|
+
formSummary?: FormSummary;
|
|
3800
|
+
}
|
|
3801
|
+
export interface FormSummary {
|
|
3802
|
+
/** Form ID. */
|
|
3803
|
+
id?: string;
|
|
3804
|
+
/** Summarized form fields. */
|
|
3805
|
+
fields?: Field[];
|
|
3806
|
+
}
|
|
3807
|
+
export declare enum FieldInputType {
|
|
3808
|
+
UNKNOWN_INPUT_TYPE = "UNKNOWN_INPUT_TYPE",
|
|
3809
|
+
STRING = "STRING",
|
|
3810
|
+
NUMBER = "NUMBER",
|
|
3811
|
+
RATING = "RATING",
|
|
3812
|
+
BOOLEAN = "BOOLEAN",
|
|
3813
|
+
ARRAY = "ARRAY",
|
|
3814
|
+
OBJECT = "OBJECT",
|
|
3815
|
+
WIX_FILE = "WIX_FILE",
|
|
3816
|
+
SIGNATURE = "SIGNATURE",
|
|
3817
|
+
PAYMENT = "PAYMENT",
|
|
3818
|
+
MULTILINE_ADDRESS = "MULTILINE_ADDRESS",
|
|
3819
|
+
DATE = "DATE",
|
|
3820
|
+
TIME = "TIME",
|
|
3821
|
+
DATE_TIME = "DATE_TIME",
|
|
3822
|
+
EMAIL = "EMAIL",
|
|
3823
|
+
URL = "URL",
|
|
3824
|
+
UUID = "UUID",
|
|
3825
|
+
PHONE = "PHONE",
|
|
3826
|
+
URI = "URI",
|
|
3827
|
+
HOSTNAME = "HOSTNAME",
|
|
3828
|
+
COLOR_HEX = "COLOR_HEX",
|
|
3829
|
+
CURRENCY = "CURRENCY",
|
|
3830
|
+
LANGUAGE = "LANGUAGE",
|
|
3831
|
+
DATE_OPTIONAL_TIME = "DATE_OPTIONAL_TIME"
|
|
3832
|
+
}
|
|
3833
|
+
export interface FieldOption {
|
|
3834
|
+
/** Selectable option label */
|
|
3835
|
+
label?: string | null;
|
|
3836
|
+
/** Selectable option value, which is saved to DB. */
|
|
3837
|
+
value?: string | null;
|
|
3838
|
+
}
|
|
3839
|
+
export interface Field {
|
|
3840
|
+
/** Definition of a target where the value of field belongs. */
|
|
3841
|
+
target?: string | null;
|
|
3842
|
+
/** Label of the field */
|
|
3843
|
+
label?: string | null;
|
|
3844
|
+
/** Input type of the field */
|
|
3845
|
+
type?: FieldInputType;
|
|
3846
|
+
/** List of options to select from */
|
|
3847
|
+
options?: FieldOption[];
|
|
3848
|
+
/**
|
|
3849
|
+
* Flag indicating whether field is deleted.
|
|
3850
|
+
* Default: false.
|
|
3851
|
+
*/
|
|
3852
|
+
deleted?: boolean;
|
|
3853
|
+
/** Id of the field. */
|
|
3854
|
+
id?: string;
|
|
3855
|
+
}
|
|
3856
|
+
export interface MessageEnvelope {
|
|
3857
|
+
/** App instance ID. */
|
|
3858
|
+
instanceId?: string | null;
|
|
3859
|
+
/** Event type. */
|
|
3860
|
+
eventType?: string;
|
|
3861
|
+
/** The identification type and identity data. */
|
|
3862
|
+
identity?: IdentificationData;
|
|
3863
|
+
/** Stringify payload. */
|
|
3864
|
+
data?: string;
|
|
3865
|
+
}
|
|
3866
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3867
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
3868
|
+
anonymousVisitorId?: string;
|
|
3869
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
3870
|
+
memberId?: string;
|
|
3871
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
3872
|
+
wixUserId?: string;
|
|
3873
|
+
/** ID of an app. */
|
|
3874
|
+
appId?: string;
|
|
3875
|
+
/** @readonly */
|
|
3876
|
+
identityType?: WebhookIdentityType;
|
|
3877
|
+
}
|
|
3878
|
+
/** @oneof */
|
|
3879
|
+
export interface IdentificationDataIdOneOf {
|
|
3880
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
3881
|
+
anonymousVisitorId?: string;
|
|
3882
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
3883
|
+
memberId?: string;
|
|
3884
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
3885
|
+
wixUserId?: string;
|
|
3886
|
+
/** ID of an app. */
|
|
3887
|
+
appId?: string;
|
|
3888
|
+
}
|
|
3889
|
+
export declare enum WebhookIdentityType {
|
|
3890
|
+
UNKNOWN = "UNKNOWN",
|
|
3891
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3892
|
+
MEMBER = "MEMBER",
|
|
3893
|
+
WIX_USER = "WIX_USER",
|
|
3894
|
+
APP = "APP"
|
|
3895
|
+
}
|
|
3896
|
+
interface PhoneConstraintsNonNullableFields {
|
|
3897
|
+
allowedCountryCodes: string[];
|
|
3898
|
+
}
|
|
3899
|
+
interface StringTypeNonNullableFields {
|
|
3900
|
+
phoneOptions?: PhoneConstraintsNonNullableFields;
|
|
3901
|
+
format: FormatEnumFormat;
|
|
3902
|
+
}
|
|
3903
|
+
interface BooleanTypeNonNullableFields {
|
|
3904
|
+
enum: boolean[];
|
|
3905
|
+
}
|
|
3906
|
+
interface ArrayItemsNonNullableFields {
|
|
3907
|
+
string?: StringTypeNonNullableFields;
|
|
3908
|
+
boolean?: BooleanTypeNonNullableFields;
|
|
3909
|
+
}
|
|
3910
|
+
interface ArrayTypeNonNullableFields {
|
|
3911
|
+
items?: ArrayItemsNonNullableFields;
|
|
3912
|
+
}
|
|
3913
|
+
interface FixedPriceOptionsNonNullableFields {
|
|
3914
|
+
price: string;
|
|
3915
|
+
}
|
|
3916
|
+
interface DynamicPriceOptionsNonNullableFields {
|
|
3917
|
+
minPrice: string;
|
|
3918
|
+
}
|
|
3919
|
+
interface ProductNonNullableFields {
|
|
3920
|
+
fixedPriceOptions?: FixedPriceOptionsNonNullableFields;
|
|
3921
|
+
dynamicPriceOptions?: DynamicPriceOptionsNonNullableFields;
|
|
3922
|
+
id: string;
|
|
3923
|
+
productType: ProductType;
|
|
3924
|
+
priceType: PriceType;
|
|
3925
|
+
}
|
|
3926
|
+
interface PaymentTypeNonNullableFields {
|
|
3927
|
+
products: ProductNonNullableFields[];
|
|
3928
|
+
}
|
|
3929
|
+
interface FieldOverridesNonNullableFields {
|
|
3930
|
+
required: boolean;
|
|
3931
|
+
}
|
|
3932
|
+
interface FieldsOverridesNonNullableFields {
|
|
3933
|
+
subdivision?: FieldOverridesNonNullableFields;
|
|
3934
|
+
city?: FieldOverridesNonNullableFields;
|
|
3935
|
+
postalCode?: FieldOverridesNonNullableFields;
|
|
3936
|
+
streetName?: FieldOverridesNonNullableFields;
|
|
3937
|
+
streetNumber?: FieldOverridesNonNullableFields;
|
|
3938
|
+
addressLine?: FieldOverridesNonNullableFields;
|
|
3939
|
+
addressLine2?: FieldOverridesNonNullableFields;
|
|
3940
|
+
country?: FieldOverridesNonNullableFields;
|
|
3941
|
+
}
|
|
3942
|
+
interface MultilineAddressValidationNonNullableFields {
|
|
3943
|
+
allowedCountries: string[];
|
|
3944
|
+
fields?: FieldsOverridesNonNullableFields;
|
|
3945
|
+
}
|
|
3946
|
+
interface PredefinedValidationNonNullableFields {
|
|
3947
|
+
paymentOptions?: PaymentTypeNonNullableFields;
|
|
3948
|
+
multilineAddressOptions?: MultilineAddressValidationNonNullableFields;
|
|
3949
|
+
format: ValidationFormat;
|
|
3950
|
+
}
|
|
3951
|
+
interface ValidationNonNullableFields {
|
|
3952
|
+
string?: StringTypeNonNullableFields;
|
|
3953
|
+
boolean?: BooleanTypeNonNullableFields;
|
|
3954
|
+
array?: ArrayTypeNonNullableFields;
|
|
3955
|
+
predefined?: PredefinedValidationNonNullableFields;
|
|
3956
|
+
required: boolean;
|
|
3957
|
+
}
|
|
3958
|
+
interface DataExtensionsDetailsNonNullableFields {
|
|
3959
|
+
fqdns: string[];
|
|
3960
|
+
}
|
|
3961
|
+
interface FormFieldNonNullableFields {
|
|
3962
|
+
id: string;
|
|
3963
|
+
validation?: ValidationNonNullableFields;
|
|
3964
|
+
pii: boolean;
|
|
3965
|
+
hidden: boolean;
|
|
3966
|
+
dataExtensionsDetails?: DataExtensionsDetailsNonNullableFields;
|
|
3967
|
+
readOnly: boolean;
|
|
3968
|
+
}
|
|
3969
|
+
interface PluginContainerDataWidthNonNullableFields {
|
|
3970
|
+
size: WidthType;
|
|
3971
|
+
}
|
|
3972
|
+
interface PluginContainerDataNonNullableFields {
|
|
3973
|
+
width?: PluginContainerDataWidthNonNullableFields;
|
|
3974
|
+
alignment: PluginContainerDataAlignment;
|
|
3975
|
+
}
|
|
3976
|
+
interface LinkNonNullableFields {
|
|
3977
|
+
url: string;
|
|
3978
|
+
anchor: string;
|
|
3979
|
+
target: LinkTarget;
|
|
3980
|
+
}
|
|
3981
|
+
interface ButtonDataNonNullableFields {
|
|
3982
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
3983
|
+
type: ButtonDataType;
|
|
3984
|
+
link?: LinkNonNullableFields;
|
|
3985
|
+
}
|
|
3986
|
+
interface TextStyleNonNullableFields {
|
|
3987
|
+
textAlignment: TextAlignment;
|
|
3988
|
+
}
|
|
3989
|
+
interface CodeBlockDataNonNullableFields {
|
|
3990
|
+
textStyle?: TextStyleNonNullableFields;
|
|
3991
|
+
}
|
|
3992
|
+
interface DividerDataNonNullableFields {
|
|
3993
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
3994
|
+
lineStyle: LineStyle;
|
|
3995
|
+
width: Width;
|
|
3996
|
+
alignment: Alignment;
|
|
3997
|
+
}
|
|
3998
|
+
interface PDFSettingsNonNullableFields {
|
|
3999
|
+
viewMode: ViewMode;
|
|
4000
|
+
}
|
|
4001
|
+
interface FileDataNonNullableFields {
|
|
4002
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4003
|
+
pdfSettings?: PDFSettingsNonNullableFields;
|
|
4004
|
+
}
|
|
4005
|
+
interface ItemImageNonNullableFields {
|
|
4006
|
+
link?: LinkNonNullableFields;
|
|
4007
|
+
}
|
|
4008
|
+
interface ItemNonNullableFields {
|
|
4009
|
+
image?: ItemImageNonNullableFields;
|
|
4010
|
+
}
|
|
4011
|
+
interface LayoutNonNullableFields {
|
|
4012
|
+
type: LayoutType;
|
|
4013
|
+
orientation: Orientation;
|
|
4014
|
+
}
|
|
4015
|
+
interface ItemStyleNonNullableFields {
|
|
4016
|
+
crop: Crop;
|
|
4017
|
+
}
|
|
4018
|
+
interface ThumbnailsNonNullableFields {
|
|
4019
|
+
placement: ThumbnailsAlignment;
|
|
4020
|
+
}
|
|
4021
|
+
interface GalleryOptionsNonNullableFields {
|
|
4022
|
+
layout?: LayoutNonNullableFields;
|
|
4023
|
+
item?: ItemStyleNonNullableFields;
|
|
4024
|
+
thumbnails?: ThumbnailsNonNullableFields;
|
|
4025
|
+
}
|
|
4026
|
+
interface GalleryDataNonNullableFields {
|
|
4027
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4028
|
+
items: ItemNonNullableFields[];
|
|
4029
|
+
options?: GalleryOptionsNonNullableFields;
|
|
4030
|
+
}
|
|
4031
|
+
interface GIFDataNonNullableFields {
|
|
4032
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4033
|
+
height: number;
|
|
4034
|
+
width: number;
|
|
4035
|
+
gifType: GIFType;
|
|
4036
|
+
}
|
|
4037
|
+
interface HeadingDataNonNullableFields {
|
|
4038
|
+
level: number;
|
|
4039
|
+
textStyle?: TextStyleNonNullableFields;
|
|
4040
|
+
}
|
|
4041
|
+
interface HTMLDataNonNullableFields {
|
|
4042
|
+
url: string;
|
|
4043
|
+
html: string;
|
|
4044
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4045
|
+
source: Source;
|
|
4046
|
+
}
|
|
4047
|
+
interface ImageDataNonNullableFields {
|
|
4048
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4049
|
+
link?: LinkNonNullableFields;
|
|
4050
|
+
}
|
|
4051
|
+
interface LinkPreviewDataNonNullableFields {
|
|
4052
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4053
|
+
link?: LinkNonNullableFields;
|
|
4054
|
+
}
|
|
4055
|
+
interface MapSettingsNonNullableFields {
|
|
4056
|
+
mapType: MapType;
|
|
4057
|
+
}
|
|
4058
|
+
interface MapDataNonNullableFields {
|
|
4059
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4060
|
+
mapSettings?: MapSettingsNonNullableFields;
|
|
4061
|
+
}
|
|
4062
|
+
interface ParagraphDataNonNullableFields {
|
|
4063
|
+
textStyle?: TextStyleNonNullableFields;
|
|
4064
|
+
}
|
|
4065
|
+
interface PermissionsNonNullableFields {
|
|
4066
|
+
view: ViewRole;
|
|
4067
|
+
vote: VoteRole;
|
|
4068
|
+
}
|
|
4069
|
+
interface SettingsNonNullableFields {
|
|
4070
|
+
permissions?: PermissionsNonNullableFields;
|
|
4071
|
+
}
|
|
4072
|
+
interface PollNonNullableFields {
|
|
4073
|
+
settings?: SettingsNonNullableFields;
|
|
4074
|
+
}
|
|
4075
|
+
interface PollLayoutNonNullableFields {
|
|
4076
|
+
type: PollLayoutType;
|
|
4077
|
+
direction: PollLayoutDirection;
|
|
4078
|
+
}
|
|
4079
|
+
interface PollDataLayoutNonNullableFields {
|
|
4080
|
+
poll?: PollLayoutNonNullableFields;
|
|
4081
|
+
}
|
|
4082
|
+
interface BackgroundNonNullableFields {
|
|
4083
|
+
type: BackgroundType;
|
|
4084
|
+
}
|
|
4085
|
+
interface PollDesignNonNullableFields {
|
|
4086
|
+
background?: BackgroundNonNullableFields;
|
|
4087
|
+
}
|
|
4088
|
+
interface DesignNonNullableFields {
|
|
4089
|
+
poll?: PollDesignNonNullableFields;
|
|
4090
|
+
}
|
|
4091
|
+
interface PollDataNonNullableFields {
|
|
4092
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4093
|
+
poll?: PollNonNullableFields;
|
|
4094
|
+
layout?: PollDataLayoutNonNullableFields;
|
|
4095
|
+
design?: DesignNonNullableFields;
|
|
4096
|
+
}
|
|
4097
|
+
interface AnchorDataNonNullableFields {
|
|
4098
|
+
anchor: string;
|
|
4099
|
+
}
|
|
4100
|
+
interface LinkDataNonNullableFields {
|
|
4101
|
+
link?: LinkNonNullableFields;
|
|
4102
|
+
}
|
|
4103
|
+
interface MentionDataNonNullableFields {
|
|
4104
|
+
name: string;
|
|
4105
|
+
slug: string;
|
|
4106
|
+
}
|
|
4107
|
+
interface FontSizeDataNonNullableFields {
|
|
4108
|
+
unit: FontType;
|
|
4109
|
+
}
|
|
4110
|
+
interface DecorationNonNullableFields {
|
|
4111
|
+
anchorData?: AnchorDataNonNullableFields;
|
|
4112
|
+
linkData?: LinkDataNonNullableFields;
|
|
4113
|
+
mentionData?: MentionDataNonNullableFields;
|
|
4114
|
+
fontSizeData?: FontSizeDataNonNullableFields;
|
|
4115
|
+
type: DecorationType;
|
|
4116
|
+
}
|
|
4117
|
+
interface TextDataNonNullableFields {
|
|
4118
|
+
text: string;
|
|
4119
|
+
decorations: DecorationNonNullableFields[];
|
|
4120
|
+
}
|
|
4121
|
+
interface AppEmbedDataNonNullableFields {
|
|
4122
|
+
type: AppType;
|
|
4123
|
+
}
|
|
4124
|
+
interface VideoDataNonNullableFields {
|
|
4125
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4126
|
+
}
|
|
4127
|
+
interface EmbedDataNonNullableFields {
|
|
4128
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4129
|
+
}
|
|
4130
|
+
interface CollapsibleListDataNonNullableFields {
|
|
4131
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4132
|
+
initialExpandedItems: InitialExpandedItems;
|
|
4133
|
+
direction: Direction;
|
|
4134
|
+
}
|
|
4135
|
+
interface DimensionsNonNullableFields {
|
|
4136
|
+
colsWidthRatio: number[];
|
|
4137
|
+
rowsHeight: number[];
|
|
4138
|
+
colsMinWidth: number[];
|
|
4139
|
+
}
|
|
4140
|
+
interface TableDataNonNullableFields {
|
|
4141
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4142
|
+
dimensions?: DimensionsNonNullableFields;
|
|
4143
|
+
}
|
|
4144
|
+
interface CellStyleNonNullableFields {
|
|
4145
|
+
verticalAlignment: VerticalAlignment;
|
|
4146
|
+
}
|
|
4147
|
+
interface TableCellDataNonNullableFields {
|
|
4148
|
+
cellStyle?: CellStyleNonNullableFields;
|
|
4149
|
+
}
|
|
4150
|
+
interface AudioDataNonNullableFields {
|
|
4151
|
+
containerData?: PluginContainerDataNonNullableFields;
|
|
4152
|
+
}
|
|
4153
|
+
interface OrderedListDataNonNullableFields {
|
|
4154
|
+
indentation: number;
|
|
4155
|
+
}
|
|
4156
|
+
interface BulletedListDataNonNullableFields {
|
|
4157
|
+
indentation: number;
|
|
4158
|
+
}
|
|
4159
|
+
interface BlockquoteDataNonNullableFields {
|
|
4160
|
+
indentation: number;
|
|
4161
|
+
}
|
|
4162
|
+
interface CaptionDataNonNullableFields {
|
|
4163
|
+
textStyle?: TextStyleNonNullableFields;
|
|
4164
|
+
}
|
|
4165
|
+
interface NodeNonNullableFields {
|
|
4166
|
+
buttonData?: ButtonDataNonNullableFields;
|
|
4167
|
+
codeBlockData?: CodeBlockDataNonNullableFields;
|
|
4168
|
+
dividerData?: DividerDataNonNullableFields;
|
|
4169
|
+
fileData?: FileDataNonNullableFields;
|
|
4170
|
+
galleryData?: GalleryDataNonNullableFields;
|
|
4171
|
+
gifData?: GIFDataNonNullableFields;
|
|
4172
|
+
headingData?: HeadingDataNonNullableFields;
|
|
4173
|
+
htmlData?: HTMLDataNonNullableFields;
|
|
4174
|
+
imageData?: ImageDataNonNullableFields;
|
|
4175
|
+
linkPreviewData?: LinkPreviewDataNonNullableFields;
|
|
4176
|
+
mapData?: MapDataNonNullableFields;
|
|
4177
|
+
paragraphData?: ParagraphDataNonNullableFields;
|
|
4178
|
+
pollData?: PollDataNonNullableFields;
|
|
4179
|
+
textData?: TextDataNonNullableFields;
|
|
4180
|
+
appEmbedData?: AppEmbedDataNonNullableFields;
|
|
4181
|
+
videoData?: VideoDataNonNullableFields;
|
|
4182
|
+
embedData?: EmbedDataNonNullableFields;
|
|
4183
|
+
collapsibleListData?: CollapsibleListDataNonNullableFields;
|
|
4184
|
+
tableData?: TableDataNonNullableFields;
|
|
4185
|
+
tableCellData?: TableCellDataNonNullableFields;
|
|
4186
|
+
audioData?: AudioDataNonNullableFields;
|
|
4187
|
+
orderedListData?: OrderedListDataNonNullableFields;
|
|
4188
|
+
bulletedListData?: BulletedListDataNonNullableFields;
|
|
4189
|
+
blockquoteData?: BlockquoteDataNonNullableFields;
|
|
4190
|
+
captionData?: CaptionDataNonNullableFields;
|
|
4191
|
+
type: NodeType;
|
|
4192
|
+
id: string;
|
|
4193
|
+
nodes: NodeNonNullableFields[];
|
|
4194
|
+
}
|
|
4195
|
+
interface MetadataNonNullableFields {
|
|
4196
|
+
version: number;
|
|
4197
|
+
}
|
|
4198
|
+
interface TextNodeStyleNonNullableFields {
|
|
4199
|
+
decorations: DecorationNonNullableFields[];
|
|
4200
|
+
}
|
|
4201
|
+
interface DocumentStyleNonNullableFields {
|
|
4202
|
+
headerOne?: TextNodeStyleNonNullableFields;
|
|
4203
|
+
headerTwo?: TextNodeStyleNonNullableFields;
|
|
4204
|
+
headerThree?: TextNodeStyleNonNullableFields;
|
|
4205
|
+
headerFour?: TextNodeStyleNonNullableFields;
|
|
4206
|
+
headerFive?: TextNodeStyleNonNullableFields;
|
|
4207
|
+
headerSix?: TextNodeStyleNonNullableFields;
|
|
4208
|
+
paragraph?: TextNodeStyleNonNullableFields;
|
|
4209
|
+
blockquote?: TextNodeStyleNonNullableFields;
|
|
4210
|
+
codeBlock?: TextNodeStyleNonNullableFields;
|
|
4211
|
+
}
|
|
4212
|
+
interface RichContentNonNullableFields {
|
|
4213
|
+
nodes: NodeNonNullableFields[];
|
|
4214
|
+
metadata?: MetadataNonNullableFields;
|
|
4215
|
+
documentStyle?: DocumentStyleNonNullableFields;
|
|
4216
|
+
}
|
|
4217
|
+
interface TextInputNonNullableFields {
|
|
4218
|
+
description?: RichContentNonNullableFields;
|
|
4219
|
+
}
|
|
4220
|
+
interface RadioGroupOptionNonNullableFields {
|
|
4221
|
+
default: boolean;
|
|
4222
|
+
id: string;
|
|
4223
|
+
}
|
|
4224
|
+
interface RadioGroupNonNullableFields {
|
|
4225
|
+
description?: RichContentNonNullableFields;
|
|
4226
|
+
options: RadioGroupOptionNonNullableFields[];
|
|
4227
|
+
numberOfColumns: NumberOfColumns;
|
|
4228
|
+
}
|
|
4229
|
+
interface DropdownOptionNonNullableFields {
|
|
4230
|
+
default: boolean;
|
|
4231
|
+
id: string;
|
|
4232
|
+
}
|
|
4233
|
+
interface DropdownNonNullableFields {
|
|
4234
|
+
description?: RichContentNonNullableFields;
|
|
4235
|
+
options: DropdownOptionNonNullableFields[];
|
|
4236
|
+
}
|
|
4237
|
+
interface DateTimeInputNonNullableFields {
|
|
4238
|
+
description?: RichContentNonNullableFields;
|
|
4239
|
+
use24HourFormat: boolean;
|
|
4240
|
+
}
|
|
4241
|
+
interface PhoneInputNonNullableFields {
|
|
4242
|
+
description?: RichContentNonNullableFields;
|
|
4243
|
+
showCountryFlag: boolean;
|
|
4244
|
+
}
|
|
4245
|
+
interface DateInputNonNullableFields {
|
|
4246
|
+
description?: RichContentNonNullableFields;
|
|
4247
|
+
}
|
|
4248
|
+
interface TimeInputNonNullableFields {
|
|
4249
|
+
description?: RichContentNonNullableFields;
|
|
4250
|
+
use24HourFormat: boolean;
|
|
4251
|
+
}
|
|
4252
|
+
interface DatePickerNonNullableFields {
|
|
4253
|
+
description?: RichContentNonNullableFields;
|
|
4254
|
+
firstDayOfWeek: FirstDayOfWeek;
|
|
4255
|
+
}
|
|
4256
|
+
interface StringTypePhoneConstraintsNonNullableFields {
|
|
4257
|
+
allowedCountryCodes: string[];
|
|
4258
|
+
}
|
|
4259
|
+
interface InputFieldStringTypeNonNullableFields {
|
|
4260
|
+
phoneOptions?: StringTypePhoneConstraintsNonNullableFields;
|
|
4261
|
+
format: StringTypeFormatEnumFormat;
|
|
4262
|
+
}
|
|
4263
|
+
interface _StringNonNullableFields {
|
|
4264
|
+
textInputOptions?: TextInputNonNullableFields;
|
|
4265
|
+
radioGroupOptions?: RadioGroupNonNullableFields;
|
|
4266
|
+
dropdownOptions?: DropdownNonNullableFields;
|
|
4267
|
+
dateTimeOptions?: DateTimeInputNonNullableFields;
|
|
4268
|
+
phoneInputOptions?: PhoneInputNonNullableFields;
|
|
4269
|
+
dateInputOptions?: DateInputNonNullableFields;
|
|
4270
|
+
timeInputOptions?: TimeInputNonNullableFields;
|
|
4271
|
+
datePickerOptions?: DatePickerNonNullableFields;
|
|
4272
|
+
validation?: InputFieldStringTypeNonNullableFields;
|
|
4273
|
+
componentType: StringComponentType;
|
|
4274
|
+
}
|
|
4275
|
+
interface NumberInputNonNullableFields {
|
|
4276
|
+
description?: RichContentNonNullableFields;
|
|
4277
|
+
}
|
|
4278
|
+
interface RatingInputNonNullableFields {
|
|
4279
|
+
description?: RichContentNonNullableFields;
|
|
4280
|
+
}
|
|
4281
|
+
interface _NumberNonNullableFields {
|
|
4282
|
+
numberInputOptions?: NumberInputNonNullableFields;
|
|
4283
|
+
ratingInputOptions?: RatingInputNonNullableFields;
|
|
4284
|
+
componentType: NumberComponentType;
|
|
4285
|
+
}
|
|
4286
|
+
interface CheckboxNonNullableFields {
|
|
4287
|
+
label?: RichContentNonNullableFields;
|
|
4288
|
+
checked: boolean;
|
|
4289
|
+
}
|
|
4290
|
+
interface InputFieldBooleanTypeNonNullableFields {
|
|
4291
|
+
enum: boolean[];
|
|
4292
|
+
}
|
|
4293
|
+
interface _BooleanNonNullableFields {
|
|
4294
|
+
checkboxOptions?: CheckboxNonNullableFields;
|
|
4295
|
+
validation?: InputFieldBooleanTypeNonNullableFields;
|
|
4296
|
+
componentType: BooleanComponentType;
|
|
4297
|
+
}
|
|
4298
|
+
interface ImageNonNullableFields {
|
|
4299
|
+
id: string;
|
|
4300
|
+
url: string;
|
|
4301
|
+
height: number;
|
|
4302
|
+
width: number;
|
|
4303
|
+
}
|
|
4304
|
+
interface MediaItemNonNullableFields {
|
|
4305
|
+
image?: ImageNonNullableFields;
|
|
4306
|
+
}
|
|
4307
|
+
interface OptionNonNullableFields {
|
|
4308
|
+
default: boolean;
|
|
4309
|
+
id: string;
|
|
4310
|
+
media?: MediaItemNonNullableFields;
|
|
4311
|
+
}
|
|
4312
|
+
interface CheckboxGroupNonNullableFields {
|
|
4313
|
+
description?: RichContentNonNullableFields;
|
|
4314
|
+
options: OptionNonNullableFields[];
|
|
4315
|
+
numberOfColumns: NumberOfColumns;
|
|
4316
|
+
}
|
|
4317
|
+
interface TagsOptionNonNullableFields {
|
|
4318
|
+
default: boolean;
|
|
4319
|
+
id: string;
|
|
4320
|
+
media?: MediaItemNonNullableFields;
|
|
4321
|
+
}
|
|
4322
|
+
interface TagsNonNullableFields {
|
|
4323
|
+
description?: RichContentNonNullableFields;
|
|
4324
|
+
options: TagsOptionNonNullableFields[];
|
|
4325
|
+
numberOfColumns: NumberOfColumns;
|
|
4326
|
+
}
|
|
4327
|
+
interface ArrayTypeArrayItemsNonNullableFields {
|
|
4328
|
+
stringOptions?: InputFieldStringTypeNonNullableFields;
|
|
4329
|
+
booleanOptions?: InputFieldBooleanTypeNonNullableFields;
|
|
4330
|
+
itemType: ItemType;
|
|
4331
|
+
}
|
|
4332
|
+
interface InputFieldArrayTypeNonNullableFields {
|
|
4333
|
+
items?: ArrayTypeArrayItemsNonNullableFields;
|
|
4334
|
+
}
|
|
4335
|
+
interface _ArrayNonNullableFields {
|
|
4336
|
+
checkboxGroupOptions?: CheckboxGroupNonNullableFields;
|
|
4337
|
+
tagsOptions?: TagsNonNullableFields;
|
|
4338
|
+
validation?: InputFieldArrayTypeNonNullableFields;
|
|
4339
|
+
componentType: ComponentType;
|
|
4340
|
+
}
|
|
4341
|
+
interface FileUploadNonNullableFields {
|
|
4342
|
+
description?: RichContentNonNullableFields;
|
|
4343
|
+
fileLimit: number;
|
|
4344
|
+
uploadFileFormats: UploadFileFormat[];
|
|
4345
|
+
}
|
|
4346
|
+
interface SignatureNonNullableFields {
|
|
4347
|
+
description?: RichContentNonNullableFields;
|
|
4348
|
+
imageUploadEnabled: boolean;
|
|
4349
|
+
}
|
|
4350
|
+
interface WixFileNonNullableFields {
|
|
4351
|
+
fileUploadOptions?: FileUploadNonNullableFields;
|
|
4352
|
+
signatureOptions?: SignatureNonNullableFields;
|
|
4353
|
+
componentType: WixFileComponentType;
|
|
4354
|
+
}
|
|
4355
|
+
interface ProductCheckboxGroupOptionNonNullableFields {
|
|
4356
|
+
id: string;
|
|
4357
|
+
media?: MediaItemNonNullableFields;
|
|
4358
|
+
default: boolean;
|
|
4359
|
+
}
|
|
4360
|
+
interface ProductCheckboxGroupNonNullableFields {
|
|
4361
|
+
description?: RichContentNonNullableFields;
|
|
4362
|
+
options: ProductCheckboxGroupOptionNonNullableFields[];
|
|
4363
|
+
imageFit: ImageFit;
|
|
4364
|
+
}
|
|
4365
|
+
interface DonationInputOptionNonNullableFields {
|
|
4366
|
+
value: string;
|
|
4367
|
+
default: boolean;
|
|
4368
|
+
}
|
|
4369
|
+
interface DonationInputNonNullableFields {
|
|
4370
|
+
description?: RichContentNonNullableFields;
|
|
4371
|
+
options: DonationInputOptionNonNullableFields[];
|
|
4372
|
+
numberOfColumns: NumberOfColumns;
|
|
4373
|
+
}
|
|
4374
|
+
interface PaymentInputNonNullableFields {
|
|
4375
|
+
description?: RichContentNonNullableFields;
|
|
4376
|
+
}
|
|
4377
|
+
interface FixedPaymentNonNullableFields {
|
|
4378
|
+
description?: RichContentNonNullableFields;
|
|
4379
|
+
}
|
|
4380
|
+
interface PaymentNonNullableFields {
|
|
4381
|
+
checkboxGroupOptions?: ProductCheckboxGroupNonNullableFields;
|
|
4382
|
+
donationInputOptions?: DonationInputNonNullableFields;
|
|
4383
|
+
paymentInputOptions?: PaymentInputNonNullableFields;
|
|
4384
|
+
fixedPaymentOptions?: FixedPaymentNonNullableFields;
|
|
4385
|
+
componentType: PaymentComponentType;
|
|
4386
|
+
validation?: PaymentTypeNonNullableFields;
|
|
4387
|
+
}
|
|
4388
|
+
interface DefaultCountryConfigNonNullableFields {
|
|
4389
|
+
countryOptions: string;
|
|
4390
|
+
type: Type;
|
|
4391
|
+
}
|
|
4392
|
+
interface AddressLine2NonNullableFields {
|
|
4393
|
+
show: boolean;
|
|
4394
|
+
}
|
|
4395
|
+
interface FieldsSettingsNonNullableFields {
|
|
4396
|
+
addressLine2?: AddressLine2NonNullableFields;
|
|
4397
|
+
}
|
|
4398
|
+
interface MultilineAddressNonNullableFields {
|
|
4399
|
+
description?: RichContentNonNullableFields;
|
|
4400
|
+
showCountryFlags: boolean;
|
|
4401
|
+
defaultCountryConfig?: DefaultCountryConfigNonNullableFields;
|
|
4402
|
+
fieldSettings?: FieldsSettingsNonNullableFields;
|
|
4403
|
+
autocompleteEnabled: boolean;
|
|
4404
|
+
}
|
|
4405
|
+
interface InputFieldMultilineAddressNonNullableFields {
|
|
4406
|
+
multilineAddressOptions?: MultilineAddressNonNullableFields;
|
|
4407
|
+
componentType: MultilineAddressComponentType;
|
|
4408
|
+
validation?: MultilineAddressValidationNonNullableFields;
|
|
4409
|
+
}
|
|
4410
|
+
interface AppointmentNonNullableFields {
|
|
4411
|
+
format: Format;
|
|
4412
|
+
}
|
|
4413
|
+
interface SchedulingNonNullableFields {
|
|
4414
|
+
appointmentOptions?: AppointmentNonNullableFields;
|
|
4415
|
+
componentType: SchedulingComponentType;
|
|
4416
|
+
}
|
|
4417
|
+
interface EmailInfoNonNullableFields {
|
|
4418
|
+
tag: EmailInfoTag;
|
|
4419
|
+
}
|
|
4420
|
+
interface PhoneInfoNonNullableFields {
|
|
4421
|
+
tag: PhoneInfoTag;
|
|
4422
|
+
}
|
|
4423
|
+
interface AddressInfoNonNullableFields {
|
|
4424
|
+
tag: Tag;
|
|
4425
|
+
}
|
|
4426
|
+
interface CustomFieldInfoNonNullableFields {
|
|
4427
|
+
key: string;
|
|
4428
|
+
}
|
|
4429
|
+
interface SubscriptionInfoNonNullableFields {
|
|
4430
|
+
optInLevel: OptInLevel;
|
|
4431
|
+
}
|
|
4432
|
+
interface FormFieldContactInfoNonNullableFields {
|
|
4433
|
+
emailInfo?: EmailInfoNonNullableFields;
|
|
4434
|
+
phoneInfo?: PhoneInfoNonNullableFields;
|
|
4435
|
+
addressInfo?: AddressInfoNonNullableFields;
|
|
4436
|
+
customFieldInfo?: CustomFieldInfoNonNullableFields;
|
|
4437
|
+
subscriptionInfo?: SubscriptionInfoNonNullableFields;
|
|
4438
|
+
contactField: ContactField;
|
|
4439
|
+
}
|
|
4440
|
+
interface InputFieldNonNullableFields {
|
|
4441
|
+
stringOptions?: _StringNonNullableFields;
|
|
4442
|
+
numberOptions?: _NumberNonNullableFields;
|
|
4443
|
+
booleanOptions?: _BooleanNonNullableFields;
|
|
4444
|
+
arrayOptions?: _ArrayNonNullableFields;
|
|
4445
|
+
wixFileOptions?: WixFileNonNullableFields;
|
|
4446
|
+
paymentOptions?: PaymentNonNullableFields;
|
|
4447
|
+
multilineAddressOptions?: InputFieldMultilineAddressNonNullableFields;
|
|
4448
|
+
schedulingOptions?: SchedulingNonNullableFields;
|
|
4449
|
+
pii: boolean;
|
|
4450
|
+
required: boolean;
|
|
4451
|
+
inputType: InputType;
|
|
4452
|
+
contactMapping?: FormFieldContactInfoNonNullableFields;
|
|
4453
|
+
readOnly: boolean;
|
|
4454
|
+
}
|
|
4455
|
+
interface RichContentOptionsNonNullableFields {
|
|
4456
|
+
richContent?: RichContentNonNullableFields;
|
|
4457
|
+
}
|
|
4458
|
+
interface DisplayFieldNonNullableFields {
|
|
4459
|
+
richContentOptions?: RichContentOptionsNonNullableFields;
|
|
4460
|
+
displayFieldType: DisplayFieldType;
|
|
4461
|
+
}
|
|
4462
|
+
interface FormFieldV2NonNullableFields {
|
|
4463
|
+
inputOptions?: InputFieldNonNullableFields;
|
|
4464
|
+
displayOptions?: DisplayFieldNonNullableFields;
|
|
4465
|
+
id: string;
|
|
4466
|
+
hidden: boolean;
|
|
4467
|
+
fieldType: FieldType;
|
|
4468
|
+
}
|
|
4469
|
+
interface GroupNonNullableFields {
|
|
4470
|
+
groupId: string;
|
|
4471
|
+
items: ItemLayoutNonNullableFields[];
|
|
4472
|
+
}
|
|
4473
|
+
interface ItemLayoutNonNullableFields {
|
|
4474
|
+
fieldId: string;
|
|
4475
|
+
group?: GroupNonNullableFields;
|
|
4476
|
+
}
|
|
4477
|
+
interface SectionNonNullableFields {
|
|
4478
|
+
id: string;
|
|
4479
|
+
allowedFieldIds: string[];
|
|
4480
|
+
}
|
|
4481
|
+
interface BreakPointNonNullableFields {
|
|
4482
|
+
items: ItemLayoutNonNullableFields[];
|
|
4483
|
+
sections: SectionNonNullableFields[];
|
|
4484
|
+
}
|
|
4485
|
+
interface FormLayoutNonNullableFields {
|
|
4486
|
+
large?: BreakPointNonNullableFields;
|
|
4487
|
+
medium?: BreakPointNonNullableFields;
|
|
4488
|
+
small?: BreakPointNonNullableFields;
|
|
4489
|
+
}
|
|
4490
|
+
interface StepNonNullableFields {
|
|
4491
|
+
id: string;
|
|
4492
|
+
hidden: boolean;
|
|
4493
|
+
layout?: FormLayoutNonNullableFields;
|
|
4494
|
+
}
|
|
4495
|
+
interface FormOverrideNonNullableFields {
|
|
4496
|
+
entityType: OverrideEntityType;
|
|
4497
|
+
}
|
|
4498
|
+
interface FormRuleNonNullableFields {
|
|
4499
|
+
id: string;
|
|
4500
|
+
overrides: FormOverrideNonNullableFields[];
|
|
4501
|
+
}
|
|
4502
|
+
interface FormPropertiesNonNullableFields {
|
|
4503
|
+
disabled: boolean;
|
|
4504
|
+
}
|
|
4505
|
+
interface UpsertContactNonNullableFields {
|
|
4506
|
+
labels: string[];
|
|
4507
|
+
}
|
|
4508
|
+
interface PostSubmissionTriggersNonNullableFields {
|
|
4509
|
+
upsertContact?: UpsertContactNonNullableFields;
|
|
4510
|
+
}
|
|
4511
|
+
interface NestedFormNonNullableFields {
|
|
4512
|
+
targets: string[];
|
|
4513
|
+
form?: FormNonNullableFields;
|
|
4514
|
+
}
|
|
4515
|
+
interface RequiredIndicatorPropertiesNonNullableFields {
|
|
4516
|
+
requiredIndicator: RequiredIndicator;
|
|
4517
|
+
requiredIndicatorPlacement: RequiredIndicatorPlacement;
|
|
4518
|
+
}
|
|
4519
|
+
interface ThankYouMessageOptionsNonNullableFields {
|
|
4520
|
+
richContent?: RichContentNonNullableFields;
|
|
4521
|
+
}
|
|
4522
|
+
interface RedirectOptionsNonNullableFields {
|
|
4523
|
+
target: Target;
|
|
4524
|
+
}
|
|
4525
|
+
interface SubmitSettingsNonNullableFields {
|
|
4526
|
+
thankYouMessageOptions?: ThankYouMessageOptionsNonNullableFields;
|
|
4527
|
+
redirectOptions?: RedirectOptionsNonNullableFields;
|
|
4528
|
+
submitSuccessAction: SubmitSuccessAction;
|
|
4529
|
+
}
|
|
4530
|
+
interface FieldGroupNonNullableFields {
|
|
4531
|
+
id: string;
|
|
4532
|
+
}
|
|
4533
|
+
interface FormNonNullableFields {
|
|
4534
|
+
fields: FormFieldNonNullableFields[];
|
|
4535
|
+
fieldsV2: FormFieldV2NonNullableFields[];
|
|
4536
|
+
steps: StepNonNullableFields[];
|
|
4537
|
+
rules: FormRuleNonNullableFields[];
|
|
4538
|
+
properties?: FormPropertiesNonNullableFields;
|
|
4539
|
+
deletedFields: FormFieldNonNullableFields[];
|
|
4540
|
+
deletedFieldsV2: FormFieldV2NonNullableFields[];
|
|
4541
|
+
kind: Kind;
|
|
4542
|
+
postSubmissionTriggers?: PostSubmissionTriggersNonNullableFields;
|
|
4543
|
+
namespace: string;
|
|
4544
|
+
nestedForms: NestedFormNonNullableFields[];
|
|
4545
|
+
spamFilterProtectionLevel: SpamFilterProtectionLevel;
|
|
4546
|
+
requiredIndicatorProperties?: RequiredIndicatorPropertiesNonNullableFields;
|
|
4547
|
+
submitSettings?: SubmitSettingsNonNullableFields;
|
|
4548
|
+
fieldGroups: FieldGroupNonNullableFields[];
|
|
4549
|
+
disabledFormMessage?: RichContentNonNullableFields;
|
|
4550
|
+
}
|
|
4551
|
+
export interface CreateFormResponseNonNullableFields {
|
|
4552
|
+
form?: FormNonNullableFields;
|
|
4553
|
+
}
|
|
4554
|
+
interface ApplicationErrorNonNullableFields {
|
|
4555
|
+
code: string;
|
|
4556
|
+
description: string;
|
|
4557
|
+
}
|
|
4558
|
+
interface ItemMetadataNonNullableFields {
|
|
4559
|
+
originalIndex: number;
|
|
4560
|
+
success: boolean;
|
|
4561
|
+
error?: ApplicationErrorNonNullableFields;
|
|
4562
|
+
}
|
|
4563
|
+
interface BulkFormResultNonNullableFields {
|
|
4564
|
+
itemMetadata?: ItemMetadataNonNullableFields;
|
|
4565
|
+
item?: FormNonNullableFields;
|
|
4566
|
+
}
|
|
4567
|
+
interface BulkActionMetadataNonNullableFields {
|
|
4568
|
+
totalSuccesses: number;
|
|
4569
|
+
totalFailures: number;
|
|
4570
|
+
undetailedFailures: number;
|
|
4571
|
+
}
|
|
4572
|
+
export interface BulkCreateFormResponseNonNullableFields {
|
|
4573
|
+
results: BulkFormResultNonNullableFields[];
|
|
4574
|
+
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
4575
|
+
}
|
|
4576
|
+
export interface CloneFormResponseNonNullableFields {
|
|
4577
|
+
form?: FormNonNullableFields;
|
|
4578
|
+
}
|
|
4579
|
+
export interface GetFormResponseNonNullableFields {
|
|
4580
|
+
form?: FormNonNullableFields;
|
|
4581
|
+
}
|
|
4582
|
+
export interface UpdateFormResponseNonNullableFields {
|
|
4583
|
+
form?: FormNonNullableFields;
|
|
4584
|
+
}
|
|
4585
|
+
export interface RestoreFromTrashBinResponseNonNullableFields {
|
|
4586
|
+
form?: FormNonNullableFields;
|
|
4587
|
+
}
|
|
4588
|
+
export interface QueryFormsResponseNonNullableFields {
|
|
4589
|
+
forms: FormNonNullableFields[];
|
|
4590
|
+
}
|
|
4591
|
+
export interface CountFormsResponseNonNullableFields {
|
|
4592
|
+
totalCount: number;
|
|
4593
|
+
activeCount: number;
|
|
4594
|
+
disabledCount: number;
|
|
4595
|
+
}
|
|
4596
|
+
export interface ListFormsResponseNonNullableFields {
|
|
4597
|
+
forms: FormNonNullableFields[];
|
|
4598
|
+
}
|
|
4599
|
+
export interface GetDeletedFormResponseNonNullableFields {
|
|
4600
|
+
form?: FormNonNullableFields;
|
|
4601
|
+
}
|
|
4602
|
+
export interface QueryDeletedFormsResponseNonNullableFields {
|
|
4603
|
+
forms: FormNonNullableFields[];
|
|
4604
|
+
}
|
|
4605
|
+
export interface ListDeletedFormsResponseNonNullableFields {
|
|
4606
|
+
forms: FormNonNullableFields[];
|
|
4607
|
+
}
|
|
4608
|
+
export interface BulkRemoveDeletedFieldResponseNonNullableFields {
|
|
4609
|
+
form?: FormNonNullableFields;
|
|
4610
|
+
}
|
|
4611
|
+
export interface UpdateExtendedFieldsResponseNonNullableFields {
|
|
4612
|
+
namespace: string;
|
|
4613
|
+
}
|
|
4614
|
+
interface FormProviderRestrictionsNonNullableFields {
|
|
4615
|
+
maxFormsAmount: number;
|
|
4616
|
+
maxFieldsAmount: number;
|
|
4617
|
+
}
|
|
4618
|
+
interface FormsSchemaProvidersConfigNonNullableFields {
|
|
4619
|
+
namespace: string;
|
|
4620
|
+
appId: string;
|
|
4621
|
+
restrictions?: FormProviderRestrictionsNonNullableFields;
|
|
4622
|
+
}
|
|
4623
|
+
export interface ListFormsProvidersConfigsResponseNonNullableFields {
|
|
4624
|
+
configs: FormsSchemaProvidersConfigNonNullableFields[];
|
|
4625
|
+
}
|
|
4626
|
+
interface FieldNonNullableFields {
|
|
4627
|
+
type: FieldInputType;
|
|
4628
|
+
deleted: boolean;
|
|
4629
|
+
id: string;
|
|
4630
|
+
}
|
|
4631
|
+
interface FormSummaryNonNullableFields {
|
|
4632
|
+
id: string;
|
|
4633
|
+
fields: FieldNonNullableFields[];
|
|
4634
|
+
}
|
|
4635
|
+
export interface GetFormSummaryResponseNonNullableFields {
|
|
4636
|
+
formSummary?: FormSummaryNonNullableFields;
|
|
4637
|
+
}
|
|
4638
|
+
export {};
|